API: fix bug on remove quickstarters (deleted quickstarter still returned) - master (#703)

* fix bug on remove quickstarters
* verify repo size is untouched

Author: clemensutschig

CHANGELOG.md

@@ -38,6 +38,7 @@
 - Improve authorization of quickstarter endpoint ([#572](https://github.com/opendevstack/ods-provisioning-app/issues/572))
 - Unknown exception (e.g. existing JIRA project) raised in REST create project endpoint / addProject causes removal of existing projects ([#514](https://github.com/opendevstack/ods-provisioning-app/issues/514))
 - Logging in debug level shows too much jwt details ([#486](https://github.com/opendevstack/ods-provisioning-app/issues/486))
+- DELETE_COMPONENTS API stores and returns project with deleted quickstarter([#702](https://github.com/opendevstack/ods-provisioning-app/issues/702))
 
 ## [3.0] - 2020-08-11
 

src/main/java/org/opendevstack/provision/model/OpenProjectData.java

@@ -118,13 +118,28 @@ public List<Map<String, String>> getQuickstarters() {
 
   public List<Map<String, String>> removeQuickstartersFromProject(
       List<Map<String, String>> quickstartersToRemove) {
+    List<Map<String, String>> removedQuickstarters = new ArrayList<Map<String, String>>();
     if (quickstartersToRemove == null) {
-      return this.quickstarters;
+      return removedQuickstarters;
     }
-    for (Map<String, String> quickstarter : quickstartersToRemove) {
-      quickstarters.remove(quickstarter);
+    for (Map<String, String> quickStarterToRemove : quickstartersToRemove) {
+      if (quickStarterToRemove.get(COMPONENT_ID_KEY) == null) {
+        throw new NullPointerException("Cannot delete quickstarter with id null!");
+      }
+      // loop over the currently provisioned quickstarters, and find the
+      // one with similar id - to then remove it.
+      List<Map<String, String>> currentQuickstarters = getQuickstarters();
+      for (int i = 0; i < currentQuickstarters.size(); i++) {
+        Map<String, String> currentQuickstarter = currentQuickstarters.get(i);
+        if (currentQuickstarter
+            .get(COMPONENT_ID_KEY)
+            .equalsIgnoreCase(quickStarterToRemove.get(COMPONENT_ID_KEY))) {
+          quickstarters.remove(i);
+          removedQuickstarters.add(currentQuickstarter);
+        }
+      }
     }
-    return quickstarters;
+    return removedQuickstarters;
   }
 
   @Override

src/test/java/org/opendevstack/provision/controller/E2EProjectAPIControllerTest.java

@@ -685,16 +685,12 @@ public void testQuickstarterProvisionOnNewOpenProjectInclDeleteWholeProject() th
     assertNotNull(createdProjectIncludingQuickstarters.getQuickstarters());
     assertEquals(1, createdProjectIncludingQuickstarters.getQuickstarters().size());
 
-    OpenProjectData toClean = new OpenProjectData();
-    toClean.setProjectKey(createdProjectIncludingQuickstarters.getProjectKey());
-    toClean.setQuickstarters(createdProjectIncludingQuickstarters.getQuickstarters());
-
     mockExecuteAdminJob("ods", "delete-projects", "testp");
 
     // verify project is there ..
     mockMvc
         .perform(
-            get("/api/v2/project/" + toClean.getProjectKey())
+            get("/api/v2/project/" + createdProjectIncludingQuickstarters.getProjectKey())
                 .contentType(MediaType.APPLICATION_JSON)
                 .with(httpBasic(TEST_ADMIN_USERNAME, TEST_VALID_CREDENTIAL))
                 .accept(MediaType.APPLICATION_JSON))
@@ -705,7 +701,7 @@ public void testQuickstarterProvisionOnNewOpenProjectInclDeleteWholeProject() th
     // org.opendevstack.provision.controller.ProjectApiController.deleteProject
     mockMvc
         .perform(
-            delete("/api/v2/project/" + toClean.getProjectKey())
+            delete("/api/v2/project/" + createdProjectIncludingQuickstarters.getProjectKey())
                 .contentType(MediaType.APPLICATION_JSON)
                 .with(httpBasic(TEST_ADMIN_USERNAME, TEST_VALID_CREDENTIAL))
                 .accept(MediaType.APPLICATION_JSON))
@@ -715,7 +711,7 @@ public void testQuickstarterProvisionOnNewOpenProjectInclDeleteWholeProject() th
     // verify project really deleted - and not found
     mockMvc
         .perform(
-            get("/api/v2/project/" + toClean.getProjectKey())
+            get("/api/v2/project/" + createdProjectIncludingQuickstarters.getProjectKey())
                 .contentType(MediaType.APPLICATION_JSON)
                 .with(httpBasic(TEST_ADMIN_USERNAME, TEST_VALID_CREDENTIAL))
                 .accept(MediaType.APPLICATION_JSON))
@@ -735,20 +731,27 @@ public void testQuickstarterProvisionOnNewOpenProjectInclDeleteSingleComponent()
     assertNotNull(createdProjectIncludingQuickstarters.getQuickstarters());
     assertEquals(1, createdProjectIncludingQuickstarters.getQuickstarters().size());
 
-    OpenProjectData toClean = new OpenProjectData();
+    // take the same data as in the request to create the quickstarter
+    OpenProjectData toClean =
+        readTestData("ods-update-project-python-qs-request", OpenProjectData.class);
+
     toClean.setProjectKey(createdProjectIncludingQuickstarters.getProjectKey());
-    toClean.setQuickstarters(createdProjectIncludingQuickstarters.getQuickstarters());
 
     String prefix =
-        createdProjectIncludingQuickstarters.getQuickstarters().get(0).get("component_id");
+        createdProjectIncludingQuickstarters
+            .getQuickstarters()
+            .get(0)
+            .get(OpenProjectData.COMPONENT_ID_KEY);
+
+    int currentRepositorySize = createdProjectIncludingQuickstarters.getRepositories().size();
+    int currentQuickstarterSize = createdProjectIncludingQuickstarters.getQuickstarters().size();
 
-    int currentQuickstarterSize = toClean.getQuickstarters().size();
     e2eLogger.info(
         "4 delete, current Quickstarters: "
             + currentQuickstarterSize
             + " project: "
             + toClean.getProjectKey()
-            + "\n"
+            + "\n to clean: "
             + toClean.getQuickstarters());
 
     mockExecuteDeleteComponentAdminJob(
@@ -772,15 +775,19 @@ public void testQuickstarterProvisionOnNewOpenProjectInclDeleteSingleComponent()
             .andReturn();
 
     e2eLogger.info(
-        "Delete response: " + resultProjectGetResponse.getResponse().getContentAsString());
+        "Delete response (qs): " + resultProjectGetResponse.getResponse().getContentAsString());
 
     OpenProjectData resultProject =
         new ObjectMapper()
             .readValue(
                 resultProjectGetResponse.getResponse().getContentAsString(), OpenProjectData.class);
 
+    // quickstarter size decreased by 1
     assertEquals((currentQuickstarterSize - 1), resultProject.getQuickstarters().size());
+    // repos MUST stay untouched
+    assertEquals(currentRepositorySize, resultProject.getRepositories().size());
 
+    // retrieve the project again
     resultProjectGetResponse =
         mockMvc
             .perform(
@@ -798,6 +805,7 @@ public void testQuickstarterProvisionOnNewOpenProjectInclDeleteSingleComponent()
                 resultProjectGetResponse.getResponse().getContentAsString(), OpenProjectData.class);
 
     assertEquals(toClean.getProjectKey(), resultProject.getProjectKey());
+    // verify old (before cleaning) quickstarters are now -1
     assertEquals((currentQuickstarterSize - 1), resultProject.getQuickstarters().size());
     assertTrue(resultProject.getQuickstarters().isEmpty());
   }
@@ -956,6 +964,8 @@ public OpenProjectData testQuickstarterProvisionOnNewOpenProject(boolean fail) t
 
     List<Map<String, String>> createdQuickstarters = resultProject.getQuickstarters();
 
+    e2eLogger.info("Provisioned quickstarter{}", createdQuickstarters);
+
     assertNotNull(createdQuickstarters);
     assertEquals(1, createdQuickstarters.size());