-
-
Notifications
You must be signed in to change notification settings - Fork 1.5k
/
BinaryDistributionIT.java
235 lines (192 loc) · 10 KB
/
BinaryDistributionIT.java
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
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
/*
* BSD-style license; for more info see http://pmd.sourceforge.net/license.html
*/
package net.sourceforge.pmd.it;
import static net.sourceforge.pmd.util.CollectionUtil.listOf;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.Matchers.containsString;
import static org.hamcrest.Matchers.matchesRegex;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
import java.io.File;
import java.io.IOException;
import java.util.Enumeration;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import java.util.regex.Pattern;
import java.util.stream.Collectors;
import java.util.zip.ZipEntry;
import java.util.zip.ZipFile;
import org.junit.jupiter.api.Test;
import net.sourceforge.pmd.PMDVersion;
class BinaryDistributionIT extends AbstractBinaryDistributionTest {
private static final List<String> SUPPORTED_LANGUAGES_CPD = listOf(
"apex", "coco", "cpp", "cs", "dart", "ecmascript",
"fortran", "gherkin", "go", "groovy", "html", "java", "jsp",
"julia",
"kotlin", "lua", "matlab", "modelica", "objectivec", "perl",
"php", "plsql", "pom", "python", "ruby", "scala", "swift",
"tsql", "typescript", "vf", "vm", "wsdl", "xml", "xsl"
);
private static final List<String> SUPPORTED_LANGUAGES_PMD = listOf(
"apex-52", "apex-53", "apex-54", "apex-55",
"apex-56", "apex-57", "apex-58", "apex-59",
"ecmascript-3", "ecmascript-5",
"ecmascript-6", "ecmascript-7", "ecmascript-8",
"ecmascript-9", "ecmascript-ES2015",
"ecmascript-ES2016", "ecmascript-ES2017",
"ecmascript-ES2018", "ecmascript-ES6", "html-4",
"html-5", "java-1.10", "java-1.3", "java-1.4", "java-1.5",
"java-1.6", "java-1.7", "java-1.8", "java-1.9", "java-10",
"java-11", "java-12", "java-13", "java-14", "java-15",
"java-16", "java-17", "java-18", "java-19",
"java-20", "java-20-preview",
"java-21", "java-21-preview",
"java-5", "java-6", "java-7",
"java-8", "java-9", "jsp-2", "jsp-3", "kotlin-1.6",
"kotlin-1.7", "kotlin-1.8", "modelica-3.4", "modelica-3.5",
"plsql-11g", "plsql-12.1", "plsql-12.2",
"plsql-12c_Release_1", "plsql-12c_Release_2",
"plsql-18c", "plsql-19c", "plsql-21c", "pom-4.0.0",
"scala-2.10", "scala-2.11", "scala-2.12", "scala-2.13",
"swift-4.2", "swift-5.0", "swift-5.1", "swift-5.2",
"swift-5.3", "swift-5.4", "swift-5.5", "swift-5.6",
"swift-5.7", "swift-5.9", "vf-52", "vf-53", "vf-54", "vf-55", "vf-56",
"vf-57", "vf-58", "vf-59",
"vm-2.0", "vm-2.1", "vm-2.2", "vm-2.3", "wsdl-1.1",
"wsdl-2.0", "xml-1.0", "xml-1.1", "xsl-1.0", "xsl-2.0",
"xsl-3.0"
);
private final String srcDir = new File(".", "src/test/resources/sample-source/java/").getAbsolutePath();
private static Pattern toListPattern(List<String> items) {
String pattern = items.stream().map(Pattern::quote)
.collect(Collectors.joining(",", ".*Validvalues:", ".*"));
return Pattern.compile(pattern, Pattern.DOTALL);
}
@Test
void testFileExistence() {
assertTrue(getBinaryDistribution().exists());
}
private Set<String> getExpectedFileNames() {
Set<String> result = new HashSet<>();
String basedir = "pmd-bin-" + PMDVersion.VERSION + "/";
result.add(basedir);
result.add(basedir + "LICENSE");
result.add(basedir + "bin/pmd");
result.add(basedir + "bin/pmd.bat");
result.add(basedir + "conf/simplelogger.properties");
result.add(basedir + "lib/pmd-core-" + PMDVersion.VERSION + ".jar");
result.add(basedir + "lib/pmd-java-" + PMDVersion.VERSION + ".jar");
result.add(basedir + "sbom/pmd-" + PMDVersion.VERSION + "-cyclonedx.xml");
result.add(basedir + "sbom/pmd-" + PMDVersion.VERSION + "-cyclonedx.json");
return result;
}
@Test
void testZipFileContent() throws IOException {
Set<String> expectedFileNames = getExpectedFileNames();
ZipFile zip = new ZipFile(getBinaryDistribution());
Enumeration<? extends ZipEntry> entries = zip.entries();
while (entries.hasMoreElements()) {
ZipEntry entry = entries.nextElement();
expectedFileNames.remove(entry.getName());
}
zip.close();
if (!expectedFileNames.isEmpty()) {
fail("Missing files in archive: " + expectedFileNames);
}
}
@Test
void testPmdJavaQuickstart() throws Exception {
ExecutionResult result = PMDExecutor.runPMDRules(createTemporaryReportFile(), tempDir, srcDir, "rulesets/java/quickstart.xml");
result.assertExitCode(4)
.assertStdOut(containsString(""));
}
@Test
void testPmdXmlFormat() throws Exception {
ExecutionResult result = PMDExecutor.runPMDRules(createTemporaryReportFile(), tempDir, srcDir, "src/test/resources/rulesets/sample-ruleset.xml", "xml");
result.assertExitCode(4).assertReport(containsString("JumbledIncrementer.java\">"));
result.assertExitCode(4).assertReport(containsString("<violation beginline=\"8\" endline=\"10\" begincolumn=\"13\" endcolumn=\"14\" rule=\"JumbledIncrementer\""));
}
@Test
void testPmdSample() throws Exception {
ExecutionResult result = PMDExecutor.runPMDRules(createTemporaryReportFile(), tempDir, srcDir, "src/test/resources/rulesets/sample-ruleset.xml");
result.assertExitCode(4).assertReport(containsString("JumbledIncrementer.java:8:"));
}
@Test
void testPmdSampleWithZippedSources() throws Exception {
ExecutionResult result = PMDExecutor.runPMDRules(createTemporaryReportFile(), tempDir, srcDir + "/sample-source-java.zip",
"src/test/resources/rulesets/sample-ruleset.xml");
result.assertExitCode(4).assertReport(containsString("JumbledIncrementer.java:8:"));
}
@Test
void testPmdSampleWithJarredSources() throws Exception {
ExecutionResult result = PMDExecutor.runPMDRules(createTemporaryReportFile(), tempDir, srcDir + "/sample-source-java.jar",
"src/test/resources/rulesets/sample-ruleset.xml");
result.assertExitCode(4).assertReport(containsString("JumbledIncrementer.java:8:"));
}
@Test
void testPmdHelp() throws Exception {
ExecutionResult result = PMDExecutor.runPMD(null, tempDir, "-h");
result.assertExitCode(0);
String output = result.getOutput().replaceAll("\\s+|\r|\n", "");
assertThat(output, matchesRegex(toListPattern(SUPPORTED_LANGUAGES_PMD)));
}
@Test
void testPmdNoArgs() throws Exception {
ExecutionResult result = PMDExecutor.runPMD(null, tempDir); // without any argument, display usage help and error
result.assertExitCode(2).assertStdErr(containsString("Usage: pmd check "));
}
@Test
void logging() throws Exception {
String srcDir = new File(".", "src/test/resources/sample-source/java/").getAbsolutePath();
ExecutionResult result;
result = PMDExecutor.runPMD(createTemporaryReportFile(), tempDir, "-d", srcDir, "-R", "src/test/resources/rulesets/sample-ruleset.xml");
result.assertExitCode(4);
result.assertErrorOutputContains("[main] INFO net.sourceforge.pmd.cli - Log level is at INFO");
// now with debug
result = PMDExecutor.runPMD(createTemporaryReportFile(), tempDir, "-d", srcDir, "-R", "src/test/resources/rulesets/sample-ruleset.xml", "--debug");
result.assertExitCode(4);
result.assertErrorOutputContains("[main] INFO net.sourceforge.pmd.cli - Log level is at TRACE");
}
@Test
void runPMDWithError() throws Exception {
String srcDir = new File(".", "src/test/resources/sample-source/unparsable/").getAbsolutePath();
ExecutionResult result = PMDExecutor.runPMDRules(createTemporaryReportFile(), tempDir, srcDir, "src/test/resources/rulesets/sample-ruleset.xml");
result.assertExitCode(0).assertStdErr(containsString("Run in verbose mode to see a stack-trace."));
}
@Test
void runCPD() throws Exception {
String srcDir = new File(".", "src/test/resources/sample-source-cpd/").getAbsolutePath();
ExecutionResult result;
result = CpdExecutor.runCpd(tempDir); // without any argument, display usage help and error
result.assertExitCode(2).assertStdErr(containsString("Usage: pmd cpd "));
result = CpdExecutor.runCpd(tempDir, "-h");
result.assertExitCode(0);
String output = result.getOutput().replaceAll("\\s+|\r|\n", "");
assertThat(output, matchesRegex(toListPattern(SUPPORTED_LANGUAGES_CPD)));
result = CpdExecutor.runCpd(tempDir, "--minimum-tokens", "10", "--format", "text", "--dir", srcDir);
result.assertExitCode(4)
.assertStdOut(containsString("Found a 10 line (55 tokens) duplication in the following files:"));
result.assertExitCode(4)
.assertStdOut(containsString("Class1.java"));
result.assertExitCode(4)
.assertStdOut(containsString("Class2.java"));
result = CpdExecutor.runCpd(tempDir, "--minimum-tokens", "10", "--format", "xml", "--dir", srcDir);
result.assertExitCode(4)
.assertStdOut(containsString("<duplication lines=\"10\" tokens=\"55\">"));
result.assertExitCode(4)
.assertStdOut(containsString("Class1.java\"/>"));
result.assertExitCode(4)
.assertStdOut(containsString("Class2.java\"/>"));
result = CpdExecutor.runCpd(tempDir, "--minimum-tokens", "1000", "--format", "text", "--dir", srcDir);
result.assertExitCode(0);
}
@Test
void runAstDump() throws Exception {
File jumbledIncrementerSrc = new File(srcDir, "JumbledIncrementer.java");
List<String> args = listOf("--format", "xml", "--language", "java", "--file", jumbledIncrementerSrc.toString());
ExecutionResult result = PMDExecutor.runCommand(tempDir, "ast-dump", args);
result.assertExitCode(0);
}
}