forked from spotbugs/spotbugs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
AbstractIntegrationTest.java
132 lines (117 loc) · 4.88 KB
/
AbstractIntegrationTest.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
/*
* FindBugs - Find Bugs in Java programs
* Copyright (C) 2003-2008 University of Maryland
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package edu.umd.cs.findbugs;
import static org.junit.Assert.assertTrue;
import java.io.IOException;
import java.io.UncheckedIOException;
import java.nio.file.DirectoryStream;
import java.nio.file.Files;
import java.nio.file.Path;
import java.nio.file.Paths;
import java.util.Arrays;
import java.util.List;
import edu.umd.cs.findbugs.internalAnnotations.SlashedClassName;
import edu.umd.cs.findbugs.test.AnalysisRunner;
import edu.umd.cs.findbugs.test.matcher.BugInstanceMatcherBuilder;
/**
* Abstract class for integration testing. Extend, call {@code performAnalysis("com/company/classname.class")},
* and finally assert the issues found over {@code getBugCollection()} by creating appropriate matchers with {@link BugInstanceMatcherBuilder}
* For example:
*
* <pre>
* <code>
* public class MyIntegrationTest extends AbstractIntegrationTest {
*
* @Test
* public void testIssuesAreFound() {
* performAnalysis("my/company/AnalyzedClass.class");
*
* // There should only be exactly 1 issue of this type
* final BugInstanceMatcher bugTypeMatcher = new BugInstanceMatcherBuilder()
* .bugType("NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE").build();
* assertThat(getBugCollection(), CountMatcher.containsExactly(1, bugTypeMatcher));
*
* final BugInstanceMatcher bugInstanceMatcher = new BugInstanceMatcherBuilder()
* .bugType("NP_NULL_ON_SOME_PATH_FROM_RETURN_VALUE")
* .inClass("AnalyzedClass")
* .atLine(25)
* .build();
* assertThat(getBugCollection(), hasItem(bugInstanceMatcher));
* }
* }
* </code>
* </pre>
*
* @author jmsotuyo
*/
public abstract class AbstractIntegrationTest {
/**
* Build prefix directories to search for classes
*/
private static final List<Path> BUILD_CLASS_SEARCH_PREFIXES = List.of(
// Build path if running command line build
Paths.get("build/classes/java/main"),
Paths.get("build/classes/groovy/main"),
// Build path if running in Eclipse
Paths.get("classesEclipse"));
private BugCollectionBugReporter bugReporter;
private static Path getFindbugsTestCases() {
final Path p = Paths.get(SystemProperties.getProperty("spotbugsTestCases.home", "../spotbugsTestCases"));
assertTrue("'spotbugsTestCases' directory not found", Files.exists(p));
assertTrue(Files.isDirectory(p));
assertTrue(Files.isReadable(p));
return p;
}
private static Path getFindbugsTestCasesFile(final String path) {
final Path root = getFindbugsTestCases();
final Path p = BUILD_CLASS_SEARCH_PREFIXES.stream()
.map(prefix -> root.resolve(prefix).resolve(path))
.filter(Files::exists)
.findFirst()
.orElseThrow(() -> new AssertionError(path + " not found"));
assertTrue(p + " is not readable", Files.isReadable(p));
return p;
}
protected BugCollection getBugCollection() {
return bugReporter.getBugCollection();
}
/**
* Sets up a FB engine to run on the 'spotbugsTestCases' project. It enables
* all the available detectors and reports all the bug categories. Uses a
* low priority threshold.
*/
protected void performAnalysis(@SlashedClassName final String... analyzeMe) {
AnalysisRunner runner = new AnalysisRunner();
final Path lib = getFindbugsTestCases().resolve("lib");
try (DirectoryStream<Path> ds = Files.newDirectoryStream(lib, "*.jar")) {
for (Path jar : ds) {
if (Files.isReadable(jar)) {
runner.addAuxClasspathEntry(jar);
}
}
} catch (IOException e) {
throw new UncheckedIOException(e);
}
// TODO : Unwire this once we move bug samples to a proper sourceset
Path[] paths = Arrays.stream(analyzeMe)
.map(AbstractIntegrationTest::getFindbugsTestCasesFile)
.toArray(Path[]::new);
bugReporter = runner.run(paths);
}
}