CLOUD-93453 Image catalog as managed resource in Mock integration tests

Author: Gergely Topolyai

integration-test/it-application.yml

@@ -1,6 +1,9 @@
 mock:
   server:
     address: test.service.consul
+  image:
+    catalog:
+      url: https://test.service.consul:9443/imagecatalog
 
 integrationtest:
     testsuite:

integration-test/src/main/java/com/sequenceiq/it/MockSuiteInitializer.java

@@ -0,0 +1,106 @@
+package com.sequenceiq.it;
+
+import java.util.List;
+
+import javax.inject.Inject;
+import javax.ws.rs.ForbiddenException;
+
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.boot.test.context.ConfigFileApplicationContextInitializer;
+import org.springframework.test.context.ContextConfiguration;
+import org.springframework.test.context.testng.AbstractTestNGSpringContextTests;
+import org.springframework.util.CollectionUtils;
+import org.testng.ITestContext;
+import org.testng.annotations.AfterSuite;
+import org.testng.annotations.BeforeSuite;
+import org.testng.annotations.Optional;
+import org.testng.annotations.Parameters;
+
+import com.sequenceiq.cloudbreak.api.endpoint.v1.ImageCatalogEndpoint;
+import com.sequenceiq.cloudbreak.api.model.imagecatalog.ImageCatalogRequest;
+import com.sequenceiq.cloudbreak.api.model.imagecatalog.ImageCatalogResponse;
+import com.sequenceiq.cloudbreak.client.CloudbreakClient;
+import com.sequenceiq.it.cloudbreak.CloudbreakITContextConstants;
+import com.sequenceiq.it.config.IntegrationTestConfiguration;
+import com.sequenceiq.it.util.CleanupService;
+
+@ContextConfiguration(classes = IntegrationTestConfiguration.class, initializers = ConfigFileApplicationContextInitializer.class)
+public class MockSuiteInitializer extends AbstractTestNGSpringContextTests {
+
+    private static final String MOCK_IMAGE_CATALOG_NAME = "mock-image-catalog-name";
+
+    @Value("${mock.image.catalog.url:https://localhost:9443/imagecatalog}")
+    private String imageCatalogUrl;
+
+    @Value("${integrationtest.testsuite.cleanUpOnFailure}")
+    private boolean cleanUpOnFailure;
+
+    @Value("${integrationtest.cleanup.cleanupBeforeStart}")
+    private boolean cleanUpBeforeStart;
+
+    @Inject
+    private CleanupService cleanUpService;
+
+    @Inject
+    private SuiteContext suiteContext;
+
+    private IntegrationTestContext itContext;
+
+    @BeforeSuite(dependsOnGroups = "suiteInit")
+    public void initContext(ITestContext testContext) throws Exception {
+        // Workaround of https://jira.spring.io/browse/SPR-4072
+        springTestContextBeforeTestClass();
+        springTestContextPrepareTestInstance();
+
+        itContext = suiteContext.getItContext(testContext.getSuite().getName());
+    }
+
+    @BeforeSuite(dependsOnMethods = "initContext")
+    public void initSuiteMap(ITestContext testContext) throws Exception {
+        CloudbreakClient cloudbreakClient = itContext.getContextParam(CloudbreakITContextConstants.CLOUDBREAK_CLIENT, CloudbreakClient.class);
+
+        if (cleanUpBeforeStart && isImageCatalogExists(cloudbreakClient.imageCatalogEndpoint(), MOCK_IMAGE_CATALOG_NAME)) {
+            cleanUpService.deleteImageCatalog(cloudbreakClient, MOCK_IMAGE_CATALOG_NAME);
+        }
+
+        createMockImageCatalog(cloudbreakClient.imageCatalogEndpoint());
+    }
+
+    private boolean isImageCatalogExists(ImageCatalogEndpoint endpoint, String mockImageCatalogName) throws Exception {
+        try {
+            return endpoint.getPublicByName(mockImageCatalogName) != null;
+        } catch (ForbiddenException e) {
+            return false;
+        }
+    }
+
+    private void createMockImageCatalog(ImageCatalogEndpoint endpoint) throws Exception {
+        if (!isImageCatalogExists(endpoint, MOCK_IMAGE_CATALOG_NAME)) {
+            ImageCatalogRequest imageCatalogRequest = new ImageCatalogRequest();
+            imageCatalogRequest.setName(MOCK_IMAGE_CATALOG_NAME);
+            imageCatalogRequest.setUrl(imageCatalogUrl);
+            ImageCatalogResponse imageCatalogResponse = endpoint.postPublic(imageCatalogRequest);
+
+            if (imageCatalogResponse == null) {
+                throw new IllegalArgumentException("ImageCatalog creation failed.");
+            }
+
+            endpoint.putSetDefaultByName(MOCK_IMAGE_CATALOG_NAME);
+        }
+    }
+
+    @AfterSuite(alwaysRun = true)
+    @Parameters("cleanUp")
+    public void cleanUp(@Optional("true") boolean cleanUp) {
+        if (isCleanUpNeeded(cleanUp)) {
+            CloudbreakClient cloudbreakClient = itContext.getContextParam(CloudbreakITContextConstants.CLOUDBREAK_CLIENT, CloudbreakClient.class);
+            cleanUpService.deleteImageCatalog(cloudbreakClient, MOCK_IMAGE_CATALOG_NAME);
+        }
+    }
+
+    private boolean isCleanUpNeeded(boolean cleanUp) {
+        boolean noTestsFailed = CollectionUtils.isEmpty(itContext.getContextParam(CloudbreakITContextConstants.FAILED_TESTS, List.class));
+        return cleanUp && (cleanUpOnFailure || noTestsFailed);
+    }
+
+}

integration-test/src/main/java/com/sequenceiq/it/util/CleanupService.java

@@ -176,6 +176,11 @@ public boolean deleteRecipe(CloudbreakClient cloudbreakClient, Long recipeId) {
         return true;
     }
 
+    public boolean deleteImageCatalog(CloudbreakClient cloudbreakClient, String name) {
+        cloudbreakClient.imageCatalogEndpoint().deletePublic(name);
+        return true;
+    }
+
     public boolean deleteRdsConfigs(CloudbreakClient cloudbreakClient, String rdsConfigId) {
         if (rdsConfigId != null) {
             cloudbreakClient.rdsConfigEndpoint().delete(Long.valueOf(rdsConfigId));

integration-test/src/main/resources/testsuites/mock/mock-clustercreate-salt-failed.yaml

@@ -9,6 +9,7 @@ tests:
     classes:
       - com.sequenceiq.it.TestSuiteInitializer
       - com.sequenceiq.it.cloudbreak.CloudbreakTestSuiteInitializer
+      - com.sequenceiq.it.MockSuiteInitializer
 
   - name: start ssh server on port 2020
     parameters:

integration-test/src/main/resources/testsuites/mock/mock-clustercreate-salt.yaml

@@ -9,6 +9,7 @@ tests:
     classes:
       - com.sequenceiq.it.TestSuiteInitializer
       - com.sequenceiq.it.cloudbreak.CloudbreakTestSuiteInitializer
+      - com.sequenceiq.it.MockSuiteInitializer
 
   - name: start ssh server on port 2020
     parameters:

integration-test/src/main/resources/testsuites/mock/mock-kerberized-clustercreate-salt.yaml

@@ -9,6 +9,7 @@ tests:
     classes:
       - com.sequenceiq.it.TestSuiteInitializer
       - com.sequenceiq.it.cloudbreak.CloudbreakTestSuiteInitializer
+      - com.sequenceiq.it.MockSuiteInitializer
 
   - name: start ssh server on port 2020
     parameters:

integration-test/src/main/resources/testsuites/mock/mock-scaling-big-salt.yaml

@@ -9,6 +9,7 @@ tests:
     classes:
       - com.sequenceiq.it.TestSuiteInitializer
       - com.sequenceiq.it.cloudbreak.CloudbreakTestSuiteInitializer
+      - com.sequenceiq.it.MockSuiteInitializer
 
   - name: start ssh server on port 2020
     parameters:

integration-test/src/main/resources/testsuites/mock/mock-scaling-salt.yaml

@@ -9,6 +9,7 @@ tests:
     classes:
       - com.sequenceiq.it.TestSuiteInitializer
       - com.sequenceiq.it.cloudbreak.CloudbreakTestSuiteInitializer
+      - com.sequenceiq.it.MockSuiteInitializer
 
   - name: start ssh server on port 2020
     parameters:

integration-test/src/main/resources/testsuites/v2/mock/v2-mock-kerberized-stackcreate-scaling.yaml

@@ -10,6 +10,7 @@ tests:
     classes:
       - com.sequenceiq.it.TestSuiteInitializer
       - com.sequenceiq.it.cloudbreak.CloudbreakTestSuiteInitializer
+      - com.sequenceiq.it.MockSuiteInitializer
 
   - name: start ssh server on port 2020
     parameters:

integration-test/src/main/resources/testsuites/v2/mock/v2-mock-stackcreate-bigscaling.yaml

@@ -10,6 +10,7 @@ tests:
     classes:
       - com.sequenceiq.it.TestSuiteInitializer
       - com.sequenceiq.it.cloudbreak.CloudbreakTestSuiteInitializer
+      - com.sequenceiq.it.MockSuiteInitializer
 
   - name: start ssh server on port 2020
     parameters: