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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
/*
* Copyright © 2018 European Support Limited
*
* 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 a "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.openecomp.sdc.onboarding.pmd;
import static org.openecomp.sdc.onboarding.pmd.PMDHelperUtils.getStateFile;
import static org.openecomp.sdc.onboarding.pmd.PMDHelperUtils.isReportEmpty;
import static org.openecomp.sdc.onboarding.pmd.PMDHelperUtils.readCurrentPMDState;
import static org.openecomp.sdc.onboarding.pmd.PMDHelperUtils.writeCurrentPMDState;
import java.io.File;
import java.io.IOException;
import java.io.UncheckedIOException;
import java.nio.file.Files;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.apache.maven.execution.MavenSession;
import org.apache.maven.plugin.AbstractMojo;
import org.apache.maven.plugin.MojoExecutionException;
import org.apache.maven.plugin.MojoFailureException;
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.plugins.annotations.ResolutionScope;
import org.apache.maven.project.MavenProject;
@Mojo(name = "post-verify-helper", threadSafe = true, defaultPhase = LifecyclePhase.VERIFY,
requiresDependencyResolution = ResolutionScope.NONE)
public class VerifyHelperMojo extends AbstractMojo {
private static final String SKIP_PMD = "skipPMD";
@Parameter(defaultValue = "${project}", readonly = true)
private MavenProject project;
@Parameter(defaultValue = "${project.artifact.groupId}:${project.artifact.artifactId}")
private String moduleCoordinates;
@Parameter(defaultValue = "${session}")
private MavenSession session;
@Parameter
private File pmdTargetLocation;
@Parameter
private File pmdReportFile;
@Parameter
private File pmdStateFile;
@Parameter
private String pmdCurrentStateFilePath;
@Parameter
private String excludePackaging;
@Parameter
private Boolean validatePMDReport = Boolean.FALSE;
@Parameter
private String persistingModuleCoordinates;
@Parameter
private File pmdFailureReportLocation;
@Parameter
private File compiledFilesList;
@Parameter
private File compiledTestFilesList;
private static File pmdCurrentStateFile;
public void execute() throws MojoExecutionException, MojoFailureException {
if (project.getPackaging().equals(excludePackaging)) {
return;
}
init();
warnDataIssuesIfAny();
if (Boolean.FALSE.equals(Boolean.valueOf(project.getProperties().getProperty(SKIP_PMD))) && !isReportEmpty(
pmdReportFile)) {
Map<String, List<Violation>> data = readCurrentPMDState(pmdCurrentStateFile);
Map<String, List<Violation>> cv = readCurrentModulePMDReport();
data.putAll(cv);
boolean error = false;
if (!PMDState.getHistoricState().isEmpty() && !PMDHelperUtils
.evaluateCodeQuality(PMDState.getHistoricState(), cv,
pmdFailureReportLocation, getLog())) {
error = true;
if (validatePMDReport) {
throw new MojoFailureException(
"PMD Failures encountered. Build halted. For details refer " + pmdFailureReportLocation
.getAbsolutePath());
} else {
getLog().error(
"\u001B[31m\u001B[1m Code Quality concerns raised by Quality Management System. For details refer "
+ pmdFailureReportLocation.getAbsolutePath()
+ " and address them before committing this code in Version Control System. \u001B[0m");
}
}
String moduleChecksum = project.getProperties().getProperty("mainChecksum") + ":" + project.getProperties()
.getProperty(
"testChecksum");
data = reinitializeIfNeeded(!error, data);
Map<String, Object> checksumStore = HashMap.class.cast(data);
if (!moduleChecksum.equals(checksumStore.get(moduleCoordinates))) {
checksumStore.put(moduleCoordinates, moduleChecksum);
writeCurrentPMDState(pmdCurrentStateFile, data);
}
}
if (Boolean.FALSE.equals(Boolean.valueOf(project.getProperties().getProperty(SKIP_PMD)))) {
if (isReportEmpty(pmdReportFile)) {
HashMap data = HashMap.class.cast(readCurrentPMDState(pmdCurrentStateFile));
data.put(moduleCoordinates,
project.getProperties().getProperty("mainChecksum") + ":" + project.getProperties().getProperty(
"testChecksum"));
writeCurrentPMDState(pmdCurrentStateFile, data);
}
pmdReportFile.delete();
}
removeProcessFiles();
}
private void removeProcessFiles() {
if (moduleCoordinates.equals(persistingModuleCoordinates) && pmdStateFile.exists()) {
for (File file : pmdStateFile.getParentFile().listFiles()) {
if (file.isFile()) {
file.delete();
}
}
}
if (pmdTargetLocation.exists()) {
pmdTargetLocation.delete();
}
}
private void init() {
if (pmdCurrentStateFile == null) {
setPmdCurrentStateFile(
getStateFile(pmdCurrentStateFilePath.substring(0, pmdCurrentStateFilePath.indexOf('/')), project,
pmdCurrentStateFilePath));
pmdReportFile.getParentFile().mkdirs();
}
}
private static void setPmdCurrentStateFile(File file) {
pmdCurrentStateFile = file;
pmdCurrentStateFile.getParentFile().mkdirs();
}
private Map<String, List<Violation>> readCurrentModulePMDReport() {
try {
PMDState.reset(compiledFilesList, compiledTestFilesList, moduleCoordinates);
if (pmdReportFile.exists()) {
List<String> lines = Files.readAllLines(pmdReportFile.toPath());
lines.remove(0);
for (String line : lines) {
PMDState.addViolation(line, moduleCoordinates);
}
}
} catch (IOException ioe) {
throw new UncheckedIOException(ioe);
}
return PMDState.getState();
}
private void warnDataIssuesIfAny() {
if (PMDState.getHistoricState() != null && PMDState.getHistoricState().isEmpty()) {
getLog().error("PMD Check is skipped. problem while loading data.");
}
}
private Map<String, List<Violation>> reinitializeIfNeeded(boolean required, Map<String, List<Violation>> orig) {
if (required) {
return readCurrentPMDState(pmdCurrentStateFile);
} else {
return orig;
}
}
}
|
