Skip to content

Commit

Permalink
Move examples and tests to json report
Browse files Browse the repository at this point in the history
  • Loading branch information
@Reamer
Reamer committed Aug 28, 2021
1 parent 4c7679a commit 39763e8
Show file tree
Hide file tree
Showing 5 changed files with 66 additions and 37 deletions.
2 changes: 1 addition & 1 deletion examples/single-module-gradle/build.gradle
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ dependencyCheck {

sonarqube {
properties {
property 'sonar.dependencyCheck.xmlReportPath', 'build/reports/dependency-check-report.xml'
property 'sonar.dependencyCheck.jsonReportPath', 'build/reports/dependency-check-report.json'
property 'sonar.dependencyCheck.htmlReportPath', 'build/reports/dependency-check-report.html'
properties["sonar.sources"] += "build.gradle"
}
Expand Down
2 changes: 1 addition & 1 deletion examples/single-module-kotlin-dsl-gradle/build.gradle.kts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ dependencyCheck {

sonarqube {
properties {
property("sonar.dependencyCheck.xmlReportPath", "build/reports/dependency-check-report.xml")
property("sonar.dependencyCheck.jsonReportPath", "build/reports/dependency-check-report.json")
property("sonar.dependencyCheck.htmlReportPath", "build/reports/dependency-check-report.html")
property("sonar.sources", "src,build.gradle.kts")
}
Expand Down
94 changes: 61 additions & 33 deletions ...dency-check-plugin/src/test/java/org/sonar/dependencycheck/DependencyCheckSensorTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -55,8 +55,9 @@ class DependencyCheckSensorTest {
private DependencyCheckSensor sensor;

private File sampleXmlReport;
private File sampleJsonReport;
private File sampleHtmlReport;
private File sampleXMLExceptionReport;
private File sampleJsonExceptionReport;

@BeforeEach
public void init() throws URISyntaxException {
Expand All @@ -68,12 +69,18 @@ public void init() throws URISyntaxException {
final URL sampleXmlResourceURI = getClass().getClassLoader().getResource("reportMultiModuleMavenExample/dependency-check-report.xml");
assertNotNull(sampleXmlResourceURI);
this.sampleXmlReport = Paths.get(sampleXmlResourceURI.toURI()).toFile();

final URL sampleJsonResourceURI = getClass().getClassLoader().getResource("reportMultiModuleMavenExample/dependency-check-report.json");
assertNotNull(sampleJsonResourceURI);
this.sampleJsonReport = Paths.get(sampleJsonResourceURI.toURI()).toFile();

final URL sampleHtmlResourceURI = getClass().getClassLoader().getResource("reportMultiModuleMavenExample/dependency-check-report.html");
assertNotNull(sampleHtmlResourceURI);
this.sampleHtmlReport = Paths.get(sampleHtmlResourceURI.toURI()).toFile();
final URL sampleExceptionResourceURI = getClass().getClassLoader().getResource("reportWithExceptions/dependency-check-report.xml");

final URL sampleExceptionResourceURI = getClass().getClassLoader().getResource("reportWithExceptions/dependency-check-report.json");
assertNotNull(sampleExceptionResourceURI);
this.sampleXMLExceptionReport = Paths.get(sampleExceptionResourceURI.toURI()).toFile();
this.sampleJsonExceptionReport = Paths.get(sampleExceptionResourceURI.toURI()).toFile();
}

@Test
Expand All @@ -88,43 +95,43 @@ void testDescribe() {
verify(descriptor).name("Dependency-Check");
}
@Test
void shouldAnalyse() throws URISyntaxException {
void shouldAnalyse() {
final SensorContextTester context = SensorContextTester.create(new File(""));
// Plugin Configuration
MapSettings settings = new MapSettings();
settings.setProperty(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY, "dependency-check-report.xml");
settings.setProperty(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY, "dependency-check-report.json");
Configuration config = settings.asConfig();
context.setSettings(settings);

when(pathResolver.relativeFile(Mockito.any(File.class), Mockito.eq(config.get(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY).orElse(DependencyCheckConstants.XML_REPORT_PATH_DEFAULT)))).thenReturn(sampleXmlReport);
when(pathResolver.relativeFile(Mockito.any(File.class), Mockito.eq(config.get(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY).orElse(DependencyCheckConstants.JSON_REPORT_PATH_DEFAULT)))).thenReturn(sampleJsonReport);
sensor.execute(context);
assertEquals(45, context.allIssues().size());
}

@Test
void shouldSkipIfReportWasNotFound() throws URISyntaxException {
void shouldSkipIfReportWasNotFound() {
final SensorContextTester context = SensorContextTester.create(new File(""));
// Plugin Configuration
MapSettings settings = new MapSettings();
settings.setProperty(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY, "dependency-check-report.xml");
settings.setProperty(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY, "dependency-check-report.json");
Configuration config = settings.asConfig();
context.setSettings(settings);

when(pathResolver.relativeFile(Mockito.any(File.class), Mockito.eq(config.get(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY).orElse(DependencyCheckConstants.XML_REPORT_PATH_DEFAULT)))).thenReturn(null);
when(pathResolver.relativeFile(Mockito.any(File.class), Mockito.eq(config.get(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY).orElse(DependencyCheckConstants.JSON_REPORT_PATH_DEFAULT)))).thenReturn(null);
sensor.execute(context);
assertEquals(0, context.allIssues().size());
}

@Test
void shouldAddAnIssueForAVulnerability() throws URISyntaxException {
void shouldAddAnIssueForAVulnerability() {
final SensorContextTester context = SensorContextTester.create(new File(""));
// Plugin Configuration
MapSettings settings = new MapSettings();
settings.setProperty(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY, "dependency-check-report.xml");
settings.setProperty(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY, "dependency-check-report.json");
Configuration config = settings.asConfig();
context.setSettings(settings);

when(pathResolver.relativeFile(Mockito.any(File.class), Mockito.eq(config.get(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY).orElse(DependencyCheckConstants.XML_REPORT_PATH_DEFAULT)))).thenReturn(sampleXmlReport);
when(pathResolver.relativeFile(Mockito.any(File.class), Mockito.eq(config.get(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY).orElse(DependencyCheckConstants.JSON_REPORT_PATH_DEFAULT)))).thenReturn(sampleJsonReport);
sensor.execute(context);
assertEquals(45, context.allIssues().size());
for (Issue issue : context.allIssues()) {
Expand All @@ -133,40 +140,40 @@ void shouldAddAnIssueForAVulnerability() throws URISyntaxException {
}

@Test
void shouldPersistTotalMetrics() throws URISyntaxException {
void shouldPersistTotalMetrics() {
final SensorContextTester context = SensorContextTester.create(new File(""));
// Plugin Configuration
MapSettings settings = new MapSettings();
settings.setProperty(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY, "dependency-check-report.xml");
settings.setProperty(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY, "dependency-check-report.json");
Configuration config = settings.asConfig();
context.setSettings(settings);

when(pathResolver.relativeFile(Mockito.any(File.class), Mockito.eq(config.get(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY).orElse(DependencyCheckConstants.XML_REPORT_PATH_DEFAULT)))).thenReturn(sampleXmlReport);
when(pathResolver.relativeFile(Mockito.any(File.class), Mockito.eq(config.get(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY).orElse(DependencyCheckConstants.JSON_REPORT_PATH_DEFAULT)))).thenReturn(sampleJsonReport);
sensor.execute(context);
assertEquals(9, context.measures("projectKey").size());

}

@Test
void shouldPersistMetricsOnReport() throws URISyntaxException {
void shouldPersistMetricsOnReport() {
final SensorContextTester context = SensorContextTester.create(new File(""));
// Plugin Configuration
MapSettings settings = new MapSettings();
settings.setProperty(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY, "dependency-check-report.xml");
settings.setProperty(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY, "dependency-check-report.json");
Configuration config = settings.asConfig();
context.setSettings(settings);

when(pathResolver.relativeFile(Mockito.any(File.class), Mockito.eq(config.get(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY).orElse(DependencyCheckConstants.XML_REPORT_PATH_DEFAULT)))).thenReturn(sampleXmlReport);
when(pathResolver.relativeFile(Mockito.any(File.class), Mockito.eq(config.get(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY).orElse(DependencyCheckConstants.JSON_REPORT_PATH_DEFAULT)))).thenReturn(sampleJsonReport);
sensor.execute(context);
assertNotNull(context.measures("projectKey"));
}

@Test
void shouldPersistHtmlReport() throws URISyntaxException {
void shouldPersistHtmlReport() {
final SensorContextTester context = SensorContextTester.create(new File(""));
// Plugin Configuration
MapSettings settings = new MapSettings();
settings.setProperty(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY, "dependency-check-report.xml");
settings.setProperty(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY, "dependency-check-report.json");
Configuration config = settings.asConfig();
context.setSettings(settings);

Expand All @@ -177,41 +184,41 @@ void shouldPersistHtmlReport() throws URISyntaxException {
}

@Test
void shouldPersistSummarizeIssues() throws URISyntaxException {
void shouldPersistSummarizeIssues() {
final SensorContextTester context = SensorContextTester.create(new File(""));
// Plugin Configuration
MapSettings settings = new MapSettings();
settings.setProperty(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY, "dependency-check-report.xml");
settings.setProperty(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY, "dependency-check-report.json");
settings.setProperty(DependencyCheckConstants.SUMMARIZE_PROPERTY, Boolean.TRUE);
Configuration config = settings.asConfig();
context.setSettings(settings);

when(pathResolver.relativeFile(Mockito.any(File.class), Mockito.eq(config.get(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY).orElse(DependencyCheckConstants.XML_REPORT_PATH_DEFAULT)))).thenReturn(sampleXmlReport);
when(pathResolver.relativeFile(Mockito.any(File.class), Mockito.eq(config.get(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY).orElse(DependencyCheckConstants.JSON_REPORT_PATH_DEFAULT)))).thenReturn(sampleJsonReport);
sensor.execute(context);
assertEquals(7, context.allIssues().size());
}

@Test
void shouldSkipPlugin() throws URISyntaxException {
void shouldSkipPlugin() {
final SensorContextTester context = SensorContextTester.create(new File(""));
// Plugin Configuration
MapSettings settings = new MapSettings();
settings.setProperty(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY, "dependency-check-report.xml");
settings.setProperty(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY, "dependency-check-report.xml");
settings.setProperty(DependencyCheckConstants.SKIP_PROPERTY, Boolean.TRUE);
Configuration config = settings.asConfig();
context.setSettings(settings);

when(pathResolver.relativeFile(Mockito.any(File.class), Mockito.eq(config.get(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY).orElse(DependencyCheckConstants.XML_REPORT_PATH_DEFAULT)))).thenReturn(sampleXmlReport);
when(pathResolver.relativeFile(Mockito.any(File.class), Mockito.eq(config.get(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY).orElse(DependencyCheckConstants.JSON_REPORT_PATH_DEFAULT)))).thenReturn(sampleJsonReport);
sensor.execute(context);
assertEquals(0, context.allIssues().size());
}

@Test
void shouldAddWarningsPlugin() throws URISyntaxException {
void shouldAddWarningsPlugin() {
final SensorContextTester context = SensorContextTester.create(new File(""));
// Plugin Configuration
MapSettings settings = new MapSettings();
settings.setProperty(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY, "dependency-check-report.xml");
settings.setProperty(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY, "dependency-check-report.json");
Configuration config = settings.asConfig();
context.setSettings(settings);

Expand All @@ -220,7 +227,7 @@ void shouldAddWarningsPlugin() throws URISyntaxException {
List<String> analysisWarnings = new ArrayList<>();
sensor = new DependencyCheckSensor(fileSystem, this.pathResolver, analysisWarnings::add);

when(pathResolver.relativeFile(Mockito.any(File.class), Mockito.eq(config.get(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY).orElse(DependencyCheckConstants.XML_REPORT_PATH_DEFAULT)))).thenReturn(sampleXMLExceptionReport);
when(pathResolver.relativeFile(Mockito.any(File.class), Mockito.eq(config.get(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY).orElse(DependencyCheckConstants.JSON_REPORT_PATH_DEFAULT)))).thenReturn(sampleJsonExceptionReport);
sensor.execute(context);
assertTrue(StringUtils.contains(analysisWarnings.get(0), "Dependency-Check - "));
assertTrue(StringUtils.contains(analysisWarnings.get(1),"Dependency-Check - "));
Expand All @@ -229,20 +236,41 @@ void shouldAddWarningsPlugin() throws URISyntaxException {
}

@Test
void shouldAddSecurityHotspots() throws URISyntaxException {
@Deprecated(since = "3.0.0", forRemoval = true)
void shouldAddWarningsWithXMLReportPlugin() {
final SensorContextTester context = SensorContextTester.create(new File(""));
// Plugin Configuration
MapSettings settings = new MapSettings();
settings.setProperty(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY, "dependency-check-report.xml");
Configuration config = settings.asConfig();
context.setSettings(settings);

// Sensor with analysisWarnings
FileSystem fileSystem = mock(FileSystem.class, RETURNS_DEEP_STUBS);
List<String> analysisWarnings = new ArrayList<>();
sensor = new DependencyCheckSensor(fileSystem, this.pathResolver, analysisWarnings::add);

when(pathResolver.relativeFile(Mockito.any(File.class), Mockito.eq(config.get(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY).orElse(DependencyCheckConstants.XML_REPORT_PATH_DEFAULT)))).thenReturn(sampleXmlReport);
sensor.execute(context);
assertTrue(StringUtils.contains(analysisWarnings.get(0), "The XML report is deprecated"));
assertEquals(1, analysisWarnings.size());
}

@Test
void shouldAddSecurityHotspots() {
final SensorContextTester context = SensorContextTester.create(new File(""));
// Plugin Configuration
MapSettings settings = new MapSettings();
settings.setProperty(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY, "dependency-check-report.xml");
settings.setProperty(DependencyCheckConstants.SECURITY_HOTSPOT, Boolean.TRUE);
Configuration config = settings.asConfig();
context.setSettings(settings);

when(pathResolver
.relativeFile(Mockito.any(File.class),
Mockito.eq(config.get(DependencyCheckConstants.XML_REPORT_PATH_PROPERTY)
.orElse(DependencyCheckConstants.XML_REPORT_PATH_DEFAULT))))
.thenReturn(sampleXmlReport);
Mockito.eq(config.get(DependencyCheckConstants.JSON_REPORT_PATH_PROPERTY)
.orElse(DependencyCheckConstants.JSON_REPORT_PATH_DEFAULT))))
.thenReturn(sampleJsonReport);
sensor.execute(context);
assertEquals(45, context.allIssues().size());
for (Issue issue : context.allIssues()) {
Expand Down
4 changes: 2 additions & 2 deletions ...y-check-plugin/src/test/java/org/sonar/dependencycheck/base/DependencyCheckUtilsTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -221,9 +221,9 @@ void testBestDependencyReasonRootConfigurationFileOrder() {
@Test
void testBestDependencyReasonJavaDependency() {
Path path = new File("root").toPath();
InputFile packagLock = new TestInputFileBuilder("moduleKey", "package-lock.json").setContents("123456").setCharset(StandardCharsets.UTF_8).setModuleBaseDir(path).build();
InputFile packageLock = new TestInputFileBuilder("moduleKey", "package-lock.json").setContents("123456").setCharset(StandardCharsets.UTF_8).setModuleBaseDir(path).build();
InputFile subpom = new TestInputFileBuilder("moduleKey", "submodule/pom.xml").setContents("132").setCharset(StandardCharsets.UTF_8).setModuleBaseDir(path).build();
NPMDependencyReason npmReason = new NPMDependencyReason(packagLock);
NPMDependencyReason npmReason = new NPMDependencyReason(packageLock);
MavenDependencyReason submodulepomReason = new MavenDependencyReason(subpom);

// when
Expand Down
1 change: 1 addition & 0 deletions ...heck-plugin/src/test/java/org/sonar/dependencycheck/parser/XMLReportParserHelperTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,7 @@
import org.sonar.dependencycheck.parser.element.Dependency;
import org.sonar.dependencycheck.parser.element.Vulnerability;

@Deprecated(since = "3.0.0", forRemoval = true)
class XMLReportParserHelperTest extends ReportParserTest {

@Override
Expand Down

0 comments on commit 39763e8

Please sign in to comment.