1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
|
/*
* Copyright 2017 Huawei Technologies, Ltd. and others.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.onap.integration.versionmanifest;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import java.util.Map.Entry;
import java.util.Properties;
import java.util.Set;
import java.util.TreeSet;
import org.apache.commons.csv.CSVFormat;
import org.apache.commons.csv.CSVRecord;
import org.apache.maven.artifact.Artifact;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.logging.Log;
import org.apache.maven.plugins.annotations.LifecyclePhase;
import org.apache.maven.plugins.annotations.Mojo;
import org.apache.maven.plugins.annotations.Parameter;
import org.apache.maven.project.MavenProject;
@Mojo(name = "version-check", defaultPhase = LifecyclePhase.PROCESS_SOURCES)
public class VersionCheckMojo extends AbstractMojo {
/**
* The Maven Project.
*
* @since 1.0-alpha-1
*/
@Parameter(defaultValue = "${project}", required = true, readonly = true)
protected MavenProject project;
/**
* Location of the file.
*/
@Parameter(property = "manifest", required = true, defaultValue = "/java-manifest.csv")
private String manifest;
public void execute() throws MojoExecutionException {
final Log log = getLog();
final Properties gitProps = new Properties();
try (InputStream in = getClass().getResourceAsStream("/git.properties")) {
gitProps.load(in);
} catch (IOException e) {
log.error(e);
throw new MojoExecutionException(e.getMessage());
}
log.info("Manifest version: " + gitProps.getProperty("git.build.time") + " "
+ gitProps.getProperty("git.commit.id") + " " + gitProps.getProperty("git.remote.origin.url"));
log.info("");
final List<String> groupIdPrefixes = Arrays.asList("org.onap", "org.openecomp", "org.openo");
final Map<String, String> expectedVersions = new HashMap<>();
try (InputStreamReader in = new InputStreamReader(getClass().getResourceAsStream(manifest),
StandardCharsets.ISO_8859_1)) {
Iterable<CSVRecord> records = CSVFormat.DEFAULT.withFirstRecordAsHeader().parse(in);
for (CSVRecord record : records) {
String groupId = record.get("groupId");
String artifactId = record.get("artifactId");
String version = record.get("version");
log.debug("Expected version: " + groupId + ":" + artifactId + ":" + version);
expectedVersions.put(groupId + ":" + artifactId, version);
}
} catch (IOException e) {
log.error(e);
throw new MojoExecutionException(e.getMessage());
}
final Map<String, String> actualVersions = new HashMap<>();
final MavenProject parent = project.getParent();
if (parent != null) {
log.debug("Parent: " + parent);
// don't warn within the same groupId
if (!project.getGroupId().equals(parent.getGroupId())) {
actualVersions.put(parent.getGroupId() + ":" + parent.getArtifactId(), parent.getVersion());
}
} else {
log.debug("No parent");
}
for (Artifact dep : project.getDependencyArtifacts()) {
log.debug("DependencyArtifact: " + dep.toString());
// don't warn within the same groupId
if (!project.getGroupId().equals(dep.getGroupId())) {
actualVersions.put(dep.getGroupId() + ":" + dep.getArtifactId(), dep.getVersion());
}
}
final Set<String> mismatches = new TreeSet<>();
final Set<String> missingArtifacts = new TreeSet<>();
for (Entry<String, String> actualVersionEntry : actualVersions.entrySet()) {
String artifact = actualVersionEntry.getKey();
String actualVersion = actualVersionEntry.getValue();
String expectedVersion = expectedVersions.get(artifact);
if (expectedVersion == null) {
if (groupIdPrefixes.stream().anyMatch(prefix -> artifact.startsWith(prefix))) {
missingArtifacts.add(artifact);
}
} else if (!expectedVersion.equals(actualVersion)) {
mismatches.add(artifact);
}
}
// used for formatting
int[] columnWidths = new int[10];
columnWidths[0] = actualVersions.keySet().stream().mapToInt(s -> ("" + s).length()).max().orElse(1);
columnWidths[1] = actualVersions.values().stream().mapToInt(s -> ("" + s).length()).max().orElse(1);
columnWidths[2] = expectedVersions.values().stream().mapToInt(s -> ("" + s).length()).max().orElse(1);
String format = " %-" + columnWidths[0] + "s" + " %" + columnWidths[1] + "s -> %" + columnWidths[2] + "s";
if (mismatches.isEmpty()) {
log.debug("No version mismatches found");
} else {
log.warn("The following dependencies should be updated to match the version manifest:");
for (String artifact : mismatches) {
String expectedVersion = expectedVersions.get(artifact);
String actualVersion = actualVersions.get(artifact);
if (actualVersion != null && !actualVersion.equals(expectedVersion)) {
log.warn(String.format(format, artifact, actualVersion, expectedVersion));
}
}
log.warn("");
}
if (missingArtifacts.isEmpty()) {
log.debug("No artifacts found missing in the version manifest");
} else {
log.warn("The following dependencies are missing in the version manifest:");
for (String artifact : missingArtifacts) {
String actualVersion = actualVersions.get(artifact);
log.warn(String.format(format, artifact, actualVersion, "?"));
}
log.warn("");
}
}
}
|
