Port FindingServiceTest To WireMock

Signed-off-by: Sven Strittmatter <sven.strittmatter@iteratec.com>

Author: Weltraumschaf

src/test/java/io/securecodebox/persistence/defectdojo/service/EndpointServiceTest.java

@@ -24,7 +24,7 @@ void search() throws URISyntaxException, IOException {
       get("/api/v2/endpoints/?offset=0&limit=100")
         .willReturn(
           ok()
-            .withBody(readResponseBodyFromFixture("EndpointService_response_fixture.json"))
+            .withBody(readFixtureFile("EndpointService_response_fixture.json"))
         )
     );
 

src/test/java/io/securecodebox/persistence/defectdojo/service/EngagementServiceTest.java

@@ -25,7 +25,7 @@ void search() throws URISyntaxException, IOException {
       get("/api/v2/engagements/?offset=0&limit=100")
         .willReturn(
           ok()
-            .withBody(readResponseBodyFromFixture("EngagementService_response_fixture.json"))
+            .withBody(readFixtureFile("EngagementService_response_fixture.json"))
         )
     );
 

src/test/java/io/securecodebox/persistence/defectdojo/service/FindingServiceTest.java

@@ -4,143 +4,64 @@
 
 package io.securecodebox.persistence.defectdojo.service;
 
-import com.fasterxml.jackson.core.JsonProcessingException;
-import io.securecodebox.persistence.defectdojo.config.Config;
+import io.securecodebox.persistence.defectdojo.model.Finding;
 import org.junit.jupiter.api.Test;
-import org.springframework.http.MediaType;
-import org.springframework.test.web.client.MockRestServiceServer;
 
+import java.io.IOException;
 import java.net.URISyntaxException;
+import java.time.OffsetDateTime;
+import java.util.Collections;
+import java.util.List;
 
-import static org.junit.jupiter.api.Assertions.assertEquals;
-import static org.junit.jupiter.api.Assertions.assertIterableEquals;
-import static org.springframework.test.web.client.match.MockRestRequestMatchers.requestTo;
-import static org.springframework.test.web.client.response.MockRestResponseCreators.withSuccess;
-
-
-// This test is sufficient for all services (except user profile) as all the code is generic
-// TODO: Add WireMock integration test.
-class FindingServiceTest {
-  private static final String FINDING_RESPONSE = """
-     {
-         "count": 1,
-         "next": null,
-         "previous": null,
-         "results":
-         [
-             {
-               "id": 42,
-               "tags": [],
-               "request_response": {
-                 "req_resp": []
-               },
-               "accepted_risks": [],
-               "push_to_jira": false,
-               "age": 145,
-               "sla_days_remaining": null,
-               "finding_meta": [],
-               "related_fields": null,
-               "jira_creation": null,
-               "jira_change": null,
-               "display_status": "Active, Verified",
-               "finding_groups": [],
-               "title": "Open Port: 9929/TCP",
-               "date": "2021-03-18",
-               "sla_start_date": null,
-               "cwe": 0,
-               "cve": null,
-               "cvssv3": null,
-               "cvssv3_score": null,
-               "url": null,
-               "severity": "Info",
-               "description": "### Host\\n\\n**IP Address:** 198.51.100.0\\n**FQDN:** scanme.nmap.org\\n\\n\\n**Port/Protocol:** 9929/tcp\\n\\n\\n\\n\\n",
-               "mitigation": "N/A",
-               "impact": "No impact provided",
-               "steps_to_reproduce": null,
-               "severity_justification": null,
-               "references": null,
-               "is_template": false,
-               "active": true,
-               "verified": true,
-               "false_p": false,
-               "duplicate": false,
-               "out_of_scope": false,
-               "risk_accepted": false,
-               "under_review": false,
-               "last_status_update": "2021-07-21T12:43:36.628994Z",
-               "under_defect_review": false,
-               "is_mitigated": false,
-               "thread_id": 0,
-               "mitigated": null,
-               "numerical_severity": "S4",
-               "last_reviewed": "2021-07-21T12:43:36.545348Z",
-               "line_number": null,
-               "sourcefilepath": null,
-               "sourcefile": null,
-               "param": null,
-               "payload": null,
-               "hash_code": "8dbaad23d4056f0a97bb8f487795fe392b4124f28d4049d16430e43415f1c219",
-               "line": null,
-               "file_path": null,
-               "component_name": null,
-               "component_version": null,
-               "static_finding": false,
-               "dynamic_finding": true,
-               "created": "2021-07-21T12:43:36.549669Z",
-               "scanner_confidence": null,
-               "unique_id_from_tool": null,
-               "vuln_id_from_tool": null,
-               "sast_source_object": null,
-               "sast_sink_object": null,
-               "sast_source_line": null,
-               "sast_source_file_path": null,
-               "nb_occurences": null,
-               "publish_date": null,
-               "test": 222,
-               "duplicate_finding": null,
-               "review_requested_by": null,
-               "defect_review_requested_by": null,
-               "mitigated_by": null,
-               "reporter": 5,
-               "last_reviewed_by": 5,
-               "sonarqube_issue": null,
-               "endpoints": [
-                 875
-               ],
-               "endpoint_status": [
-                 8640
-               ],
-               "reviewers": [],
-               "notes": [],
-               "files": [],
-               "found_by": [
-                 132
-               ]
-             }
-         ],
-         "prefetch": {}
-     }
-    """;
-
-  private final Config config = new Config("https://defectdojo.example.com", "abc", 42);
-  private final FindingService sut = new FindingService(config);
-  private final MockRestServiceServer server = MockRestServiceServer.createServer(sut.getRestTemplate());
+import static com.github.tomakehurst.wiremock.client.WireMock.*;
+import static org.hamcrest.MatcherAssert.assertThat;
+import static org.hamcrest.Matchers.*;
+import static org.junit.jupiter.api.Assertions.assertAll;
 
+/**
+ * Tests for {@link FindingService}
+ */
+final class FindingServiceTest extends WireMockBaseTestCase {
+  private final FindingService sut = new FindingService(conf());
 
   @Test
-  void deserializeList_shouldResultExactlyOneResult() throws JsonProcessingException {
-    var result = sut.deserializeList(FINDING_RESPONSE);
+  void deserializeList_shouldResultExactlyOneResult() throws IOException {
+    var result = sut.deserializeList(readFixtureFile("FindingService_response_fixture.json"));
 
-    assertEquals(1, result.getCount());
+    assertThat(result.getCount(), is(1));
   }
 
   @Test
-  void search() throws JsonProcessingException, URISyntaxException {
-    final var url = String.format("%s/api/v2/%s/?offset=0&limit=100", config.getUrl(), sut.getUrlPath());
-    server.expect(requestTo(url))
-      .andRespond(withSuccess(FINDING_RESPONSE, MediaType.APPLICATION_JSON));
+  void search() throws URISyntaxException, IOException {
+    stubFor(
+      get("/api/v2/findings/?offset=0&limit=100")
+        .willReturn(
+          ok()
+            .withBody(readFixtureFile("FindingService_response_fixture.json"))
+        )
+    );
+
+    final var result = sut.search();
 
-    assertIterableEquals(sut.deserializeList(FINDING_RESPONSE).getResults(), sut.search());
-    server.verify();
+    assertAll(
+      () -> assertThat(result, hasSize(1)),
+      () -> assertThat(result, containsInAnyOrder(
+        Finding.builder()
+          .id(42)
+          .title("Open Port: 9929/TCP")
+          .description("IP Address: 198.51.100.0 FQDN: scanme.nmap.org Port/Protocol: 9929/tcp")
+          .foundBy(List.of(132L))
+          .severity(Finding.Severity.INFORMATIONAL)
+          .test(222)
+          .mitigation("N/A")
+          .impact("No impact provided")
+          .verified(true)
+          .active(true)
+          .endpoints(List.of(875L))
+          .createdAt(OffsetDateTime.parse("2021-07-21T12:43:36.549669Z"))
+          .acceptedRisks(Collections.emptyList())
+          .build()
+      ))
+    );
   }
 }

src/test/java/io/securecodebox/persistence/defectdojo/service/GroupMemberServiceTest.java

@@ -24,7 +24,7 @@ void search() throws URISyntaxException, IOException {
       get("/api/v2/dojo_group_members/?offset=0&limit=100")
         .willReturn(
           ok()
-            .withBody(readResponseBodyFromFixture("GroupMemberService_response_fixture.json"))
+            .withBody(readFixtureFile("GroupMemberService_response_fixture.json"))
         )
     );
 

src/test/java/io/securecodebox/persistence/defectdojo/service/GroupServiceTest.java

@@ -25,7 +25,7 @@ void search() throws URISyntaxException, IOException {
       get("/api/v2/dojo_groups/?offset=0&limit=100")
         .willReturn(
           ok()
-            .withBody(readResponseBodyFromFixture("GroupService_response_fixture.json"))
+            .withBody(readFixtureFile("GroupService_response_fixture.json"))
         )
     );
 

src/test/java/io/securecodebox/persistence/defectdojo/service/ProductGroupServiceTest.java

@@ -26,7 +26,7 @@ void search() throws URISyntaxException, IOException {
       get("/api/v2/product_groups/?offset=0&limit=100")
         .willReturn(
           ok()
-            .withBody(readResponseBodyFromFixture("ProductGroupService_response_fixture.json"))
+            .withBody(readFixtureFile("ProductGroupService_response_fixture.json"))
         )
     );
 

src/test/java/io/securecodebox/persistence/defectdojo/service/ProductServiceTest.java

@@ -26,7 +26,7 @@ void search() throws URISyntaxException, IOException {
       get("/api/v2/products/?offset=0&limit=100")
         .willReturn(
           ok()
-            .withBody(readResponseBodyFromFixture("ProductService_response_fixture.json"))
+            .withBody(readFixtureFile("ProductService_response_fixture.json"))
         )
     );
 

src/test/java/io/securecodebox/persistence/defectdojo/service/ProductTypeServiceTest.java

@@ -24,7 +24,7 @@ void search() throws URISyntaxException, IOException {
       get("/api/v2/product_types/?offset=0&limit=100")
         .willReturn(
           ok()
-            .withBody(readResponseBodyFromFixture("ProductTypeService_response_fixture.json"))
+            .withBody(readFixtureFile("ProductTypeService_response_fixture.json"))
         )
     );
 

src/test/java/io/securecodebox/persistence/defectdojo/service/TestServiceTest.java

@@ -24,7 +24,7 @@ void search() throws URISyntaxException, IOException {
       get("/api/v2/tests/?offset=0&limit=100")
         .willReturn(
           ok()
-            .withBody(readResponseBodyFromFixture("TestService_response_fixture.json"))
+            .withBody(readFixtureFile("TestService_response_fixture.json"))
         )
     );
 

src/test/java/io/securecodebox/persistence/defectdojo/service/TestTypeServiceTest.java

@@ -24,7 +24,7 @@ void search() throws URISyntaxException, IOException {
       get("/api/v2/test_types/?offset=0&limit=100")
         .willReturn(
           ok()
-            .withBody(readResponseBodyFromFixture("TestTypeService_response_fixture.json"))
+            .withBody(readFixtureFile("TestTypeService_response_fixture.json"))
         )
     );