[SELC-7078] Running integration tests with github action, testcontainers and docker-compose

Author: gaetano-miglionico

.github/workflows/integration_tests_ms.yml

@@ -0,0 +1,41 @@
+name: "Integration Tests (user-ms)"
+
+permissions:
+  contents: read
+
+on:
+  pull_request:
+    types: [ opened, synchronize, reopened ]
+    branches:
+      - main
+      - releases/*
+    paths:
+      - "apps/user-ms/**"
+
+jobs:
+  integration_tests_ms:
+    name: 'Integration Tests (user-ms)'
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Set missing library
+        run: |
+          wget http://nz2.archive.ubuntu.com/ubuntu/pool/main/o/openssl/libssl1.1_1.1.1f-1ubuntu2_amd64.deb
+          sudo dpkg -i libssl1.1_1.1.1f-1ubuntu2_amd64.deb
+
+      - name: Setup Maven Action
+        uses: s4u/setup-maven-action@fa2c7e4517ed008b1f73e7e0195a9eecf5582cd4
+        with:
+          checkout-fetch-depth: 0
+          java-version: 17
+          java-distribution: 'temurin'
+          maven-version: '3.9.5'
+          cache-enabled: true
+
+      - uses: s4u/maven-settings-action@60912582505985be4cc55d2b890eb32767f8de5f # pin@v2.8.0
+        with:
+          servers: '[{"id": "selfcare-onboarding", "username": "${{ github.actor }}", "password": "${{ secrets.GITHUB_TOKEN }}"}]'
+
+      - name: Run Integration Tests
+        run: mvn --projects :user-ms --also-make test -Dtest=CucumberSuite -Dsurefire.failIfNoSpecifiedTests=false
+        shell: bash

apps/user-ms/README.md

@@ -100,28 +100,9 @@ To perform local tests of functionalities that involve sending messages to the S
 - SHARED_ACCESS_KEY_NAME
 - EVENTHUB-SC-USERS-SELFCARE-WO-KEY-LC
 
-## Cucumber Tests
+## Cucumber Tests (Integration Tests)
 
-To run the Cucumber tests, first, open the docker-compose.yml file located in the root of user-ms and replace the placeholder REPLACE_WITH_TOKEN with a valid GitHub PAT.
-
-Next, start the docker-compose to run the containers for MongoDB, Azurite, and the mock server.
-
-At this point, launch the user-ms microservice locally with the following environment variables:
-
-```environment variables
-USER-REGISTRY-API-KEY=9fypKNFfVY8jvWHUgABpH23VrChnRzvRpSq5b1ng
-USER_REGISTRY_URL=http://localhost:1080/user-registry-mock/v1
-STORAGE_CONTAINER_TEMPLATES=resources
-STORAGE_CONTAINER_PRODUCT=products
-MONGODB-CONNECTION-STRING=mongodb://localhost:27018
-JWT-PUBLIC-KEY=-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnpt9gVNzDW6FpBk/TwNCqd+URprAD3tfGhYWhq2sAxDAP5u9GxgHybFQ8XGNY3yeb9rp5lxLqAcxOg5j19i0tvjkK/Q7GUezteY8xpEfRLJxglIaux/sM8M82YiHCwAjgQPF+EmIPboER5fLLnvDXyl+FYzcGhwPc8Z8AGlYjv8mgijrffSpbjtd7FF0I6WxIqKFHFhIsfUMezBa7NTMSIrxp5dACCMetrKkggTK3Yq8DP86nWuSdDsjIGLrIQFuMQOALr46cSafvHMFK5B/iIDfFLAek7Kg2tELHXWdcctjdPwsc38EXb3P2Fi70WOcLg9lAx9EDgizVLaG5obCCQIDAQAB-----END PUBLIC KEY-----
-JAVA_TOOL_OPTIONS=-Duser.timezone=GMT -Duser.language=en -Duser.country=US
-BLOB-STORAGE-PRODUCT-CONNECTION-STRING=DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCD9I1QhZT4gRjAAHEDPazjFIwtg==;BlobEndpoint=http://localhost:10000/devstoreaccount1;
-```
-Next, you can proceed to run the Cucumber tests.
-
-To run all the tests, you can open the CucumberSuite file and execute it by pressing the play button, or you can create a JUnit configuration, specifying in the "Build and run" section, under Class, the following:
-it.pagopa.selfcare.user.integration_test.CucumberSuite.
+To run the Cucumber tests locally, execute it.pagopa.selfcare.user.integration_test.CucumberSuite
 
 To run a single test or a specific feature file, open the file and press the play button for the corresponding test (or the file). The first execution will fail; you will then need to modify the configuration by setting the main class to:
-it.pagopa.selfcare.user.integration_test.CucumberSuite.
+it.pagopa.selfcare.user.integration_test.CucumberSuite.

apps/user-ms/docker-compose.yml

@@ -4,15 +4,14 @@ services:
   mongodb:
     image: mongo:latest
     ports:
-      - '27018:27017'
+      - '27017:27017'
     volumes:
       - "./src/test/resources/db:/docker-entrypoint-initdb.d"
     networks:
       - develop-network
 
   azurite:
     image: mcr.microsoft.com/azure-storage/azurite
-    container_name: azurite
     ports:
       - "10000:10000"
     command: "azurite --blobHost 0.0.0.0 --inMemoryPersistence"
@@ -25,16 +24,15 @@ services:
     build:
       context: "../../."
       dockerfile: "apps/user-ms/src/test/resources/Dockerfile-azure-cli"
-    container_name: azure-cli
     depends_on:
       - azurite
     networks:
       - develop-network
     volumes:
       - "./src/test/resources/blobStorageInit/initAzurite.sh:/initAzurite.sh"
+      - "./src/test/resources/blobStorageInit/products.json:/workspace/products.json"
     environment:
       - SELFCARE_INFRA_PRIVATE_ENV=dev
-      - GITHUB_TOKEN=REPLACE_WITH_TOKEN
 
   mockserver:
     image: mockserver/mockserver
@@ -49,22 +47,6 @@ services:
     networks:
       - develop-network
 
-  #user-ms:
-  #  build:
-  #    context: "../../."  # Indica il percorso dove si trova il codice del microservizio
-  #    dockerfile: "apps/user-ms/src/test/resources/Dockerfile-cucumber"   # Puoi includere un Dockerfile per la build del servizio
-  #  ports:
-  #    - '8080:8080'  # Porta del microservizio Quarkus
-  #  environment:
-  #    - USER_REGISTRY_URL=http://localhost:1080/user-registry-mock/v1
-  #    - JWT-PUBLIC-KEY=-----BEGIN PUBLIC KEY-----MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAnpt9gVNzDW6FpBk/TwNCqd+URprAD3tfGhYWhq2sAxDAP5u9GxgHybFQ8XGNY3yeb9rp5lxLqAcxOg5j19i0tvjkK/Q7GUezteY8xpEfRLJxglIaux/sM8M82YiHCwAjgQPF+EmIPboER5fLLnvDXyl+FYzcGhwPc8Z8AGlYjv8mgijrffSpbjtd7FF0I6WxIqKFHFhIsfUMezBa7NTMSIrxp5dACCMetrKkggTK3Yq8DP86nWuSdDsjIGLrIQFuMQOALr46cSafvHMFK5B/iIDfFLAek7Kg2tELHXWdcctjdPwsc38EXb3P2Fi70WOcLg9lAx9EDgizVLaG5obCCQIDAQAB-----END PUBLIC KEY-----
-  #    - MONGODB-CONNECTION-STRING=mongodb://localhost:27017
-  #  networks:
-  #    - develop-network
-  #  depends_on:
-  #    - mongodb  # Dipende da mongodb
-  #    - mockserver  # Dipende anche da mockserver
-
 networks:
   develop-network:
     name: selfcare-develop-network

apps/user-ms/pom.xml

@@ -26,6 +26,7 @@
     <user-sdk.version>0.1.3</user-sdk.version>
     <quarkus-openapi-generator.version>2.4.1</quarkus-openapi-generator.version>
     <quarkus-cucumber-version>1.3.0</quarkus-cucumber-version>
+    <cucumber-sdk.version>0.0.5</cucumber-sdk.version>
   </properties>
   <dependencyManagement>
     <dependencies>
@@ -84,8 +85,9 @@
       <version>1.2.3</version>
     </dependency>
     <dependency>
-      <groupId>io.quarkus</groupId>
-      <artifactId>quarkus-test-mongodb</artifactId>
+      <groupId>org.apache.httpcomponents</groupId>
+      <artifactId>httpclient</artifactId>
+      <version>4.5.14</version>
     </dependency>
     <dependency>
       <groupId>org.projectlombok</groupId>
@@ -190,15 +192,10 @@
       <artifactId>microprofile-metrics-api</artifactId>
       <version>5.1.1</version>
     </dependency>
-    <dependency>
-      <groupId>it.pagopa.selfcare</groupId>
-      <artifactId>user-sdk-event</artifactId>
-      <version>0.0.1</version>
-    </dependency>
     <dependency>
       <groupId>it.pagopa.selfcare</groupId>
       <artifactId>cucumber-sdk</artifactId>
-      <version>0.0.4</version>
+      <version>${cucumber-sdk.version}</version>
       <scope>test</scope>
     </dependency>
     <dependency>
@@ -210,6 +207,7 @@
       <groupId>io.quarkiverse.cucumber</groupId>
       <artifactId>quarkus-cucumber</artifactId>
       <version>${quarkus-cucumber-version}</version>
+      <scope>test</scope>
     </dependency>
   </dependencies>
   <build>
@@ -273,6 +271,31 @@
             </configuration>
           </execution>
         </executions>
+        <configuration>
+          <systemPropertyVariables>
+            <user.language>en</user.language>
+            <user.country>US</user.country>
+            <user.timezone>GMT</user.timezone>
+          </systemPropertyVariables>
+        </configuration>
+      </plugin>
+      <plugin>
+        <artifactId>maven-surefire-plugin</artifactId>
+        <version>${surefire-plugin.version}</version>
+        <executions>
+          <execution>
+            <goals>
+              <goal>test</goal>
+            </goals>
+          </execution>
+        </executions>
+        <configuration>
+          <systemPropertyVariables>
+            <user.language>en</user.language>
+            <user.country>US</user.country>
+            <user.timezone>GMT</user.timezone>
+          </systemPropertyVariables>
+        </configuration>
       </plugin>
     </plugins>
   </build>

apps/user-ms/src/test/java/it/pagopa/selfcare/user/integration_test/CucumberSuite.java

@@ -1,14 +1,15 @@
 package it.pagopa.selfcare.user.integration_test;
 
-import io.cucumber.java.Before;
 import io.quarkiverse.cucumber.CucumberOptions;
 import io.quarkiverse.cucumber.CucumberQuarkusTest;
 import io.restassured.RestAssured;
 import lombok.extern.slf4j.Slf4j;
-import org.eclipse.microprofile.config.ConfigProvider;
 import org.junit.jupiter.api.AfterAll;
 import org.junit.jupiter.api.BeforeAll;
+import org.testcontainers.containers.ComposeContainer;
+import org.testcontainers.containers.wait.strategy.Wait;
 
+import java.io.File;
 import java.io.IOException;
 import java.io.InputStream;
 import java.nio.charset.StandardCharsets;
@@ -24,6 +25,8 @@
         })
 public class CucumberSuite extends CucumberQuarkusTest {
 
+    private static ComposeContainer composeContainer;
+
     public static void main(String[] args) {
         runMain(CucumberSuite.class, args);
     }
@@ -38,18 +41,22 @@ static void setup() throws IOException {
             String publicKey = new Scanner(inputStream, StandardCharsets.UTF_8.name()).useDelimiter("\\A").next();
             System.setProperty("JWT-PUBLIC-KEY", publicKey);
         }
-    }
 
-    @Before
-    public void setupRestAssured() {
-        RestAssured.baseURI = ConfigProvider.getConfig().getValue("rest-assured.base-url", String.class);
-        RestAssured.port = ConfigProvider.getConfig().getValue("cucumber.http.test-port", Integer.class);
+        // By default, quarkus starts the ms on port 8081
+        RestAssured.baseURI = "http://localhost";
+        RestAssured.port = 8081;
+
+        composeContainer = new ComposeContainer(new File("docker-compose.yml")).withLocalCompose(true)
+                .waitingFor("azure-cli", Wait.forLogMessage(".*BLOBSTORAGE INITIALIZED.*\\n", 1));
+        composeContainer.start();
+        Runtime.getRuntime().addShutdownHook(new Thread(composeContainer::stop));
+
+        log.info("\nLANGUAGE: {}\nCOUNTRY: {}\nTIMEZONE: {}\n", System.getProperty("user.language"), System.getProperty("user.country"), System.getProperty("user.timezone"));
     }
 
     @AfterAll
     static void tearDown() {
         log.info("Cucumber tests are finished.");
-        System.exit(0);
     }
 
 }

apps/user-ms/src/test/java/it/pagopa/selfcare/user/service/UserInfoServiceTest.java

@@ -2,9 +2,7 @@
 
 import io.quarkus.mongodb.panache.reactive.ReactivePanacheQuery;
 import io.quarkus.panache.mock.PanacheMock;
-import io.quarkus.test.common.QuarkusTestResource;
 import io.quarkus.test.junit.QuarkusTest;
-import io.quarkus.test.mongodb.MongoTestResource;
 import io.smallrye.mutiny.Uni;
 import it.pagopa.selfcare.user.controller.response.UserInfoResponse;
 import it.pagopa.selfcare.user.entity.UserInfo;
@@ -17,7 +15,6 @@
 import static org.mockito.Mockito.when;
 
 @QuarkusTest
-@QuarkusTestResource(MongoTestResource.class)
 class UserInfoServiceTest {
 
     @Inject

apps/user-ms/src/test/java/it/pagopa/selfcare/user/service/UserInstitutionServiceTest.java

@@ -7,9 +7,7 @@
 import io.quarkus.mongodb.reactive.ReactiveMongoCollection;
 import io.quarkus.panache.mock.PanacheMock;
 import io.quarkus.test.InjectMock;
-import io.quarkus.test.common.QuarkusTestResource;
 import io.quarkus.test.junit.QuarkusTest;
-import io.quarkus.test.mongodb.MongoTestResource;
 import io.smallrye.mutiny.Multi;
 import io.smallrye.mutiny.Uni;
 import io.smallrye.mutiny.helpers.test.AssertSubscriber;
@@ -43,7 +41,6 @@
 import static org.mockito.Mockito.when;
 
 @QuarkusTest
-@QuarkusTestResource(MongoTestResource.class)
 class UserInstitutionServiceTest {
 
     @Inject

apps/user-ms/src/test/java/it/pagopa/selfcare/user/service/UserRegistryServiceTest.java

@@ -1,9 +1,7 @@
 package it.pagopa.selfcare.user.service;
 
 import io.quarkus.test.InjectMock;
-import io.quarkus.test.common.QuarkusTestResource;
 import io.quarkus.test.junit.QuarkusTest;
-import io.quarkus.test.mongodb.MongoTestResource;
 import io.smallrye.mutiny.Multi;
 import io.smallrye.mutiny.Uni;
 import io.smallrye.mutiny.helpers.test.UniAssertSubscriber;
@@ -19,26 +17,19 @@
 import org.junit.jupiter.api.BeforeAll;
 import org.junit.jupiter.api.Test;
 import org.mockito.ArgumentCaptor;
-import org.openapi.quarkus.user_registry_json.model.EmailCertifiableSchema;
-import org.openapi.quarkus.user_registry_json.model.FamilyNameCertifiableSchema;
-import org.openapi.quarkus.user_registry_json.model.MutableUserFieldsDto;
-import org.openapi.quarkus.user_registry_json.model.NameCertifiableSchema;
-import org.openapi.quarkus.user_registry_json.model.SaveUserDto;
-import org.openapi.quarkus.user_registry_json.model.UserId;
-import org.openapi.quarkus.user_registry_json.model.UserResource;
-import org.openapi.quarkus.user_registry_json.model.UserSearchDto;
+import org.openapi.quarkus.user_registry_json.model.*;
 
 import java.util.List;
 import java.util.Map;
 import java.util.UUID;
 
 import static io.smallrye.common.constraint.Assert.assertNotNull;
-import static org.junit.jupiter.api.Assertions.*;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
 import static org.mockito.ArgumentMatchers.*;
 import static org.mockito.Mockito.*;
 
 @QuarkusTest
-@QuarkusTestResource(MongoTestResource.class)
 public class UserRegistryServiceTest {
     @Inject
     UserRegistryService userRegistryService;

apps/user-ms/src/test/java/it/pagopa/selfcare/user/service/UserServiceTest.java

@@ -5,9 +5,7 @@
 import io.quarkus.mongodb.panache.reactive.ReactivePanacheQuery;
 import io.quarkus.panache.mock.PanacheMock;
 import io.quarkus.test.InjectMock;
-import io.quarkus.test.common.QuarkusTestResource;
 import io.quarkus.test.junit.QuarkusTest;
-import io.quarkus.test.mongodb.MongoTestResource;
 import io.smallrye.common.constraint.Assert;
 import io.smallrye.mutiny.Multi;
 import io.smallrye.mutiny.Uni;
@@ -67,7 +65,6 @@
 import static org.mockito.Mockito.*;
 
 @QuarkusTest
-@QuarkusTestResource(MongoTestResource.class)
 class UserServiceTest {
 
     @Inject

apps/user-ms/src/test/resources/application-test.properties

@@ -1,7 +1,14 @@
-# cucumber.publish.enabled=true
-cucumber.http.test-port=8080
-cucumber.http.host=http://localhost
-quarkus.mongodb.connection-string=mongodb://localhost:27018
+# These properties are used to run integration tests
+
+quarkus.mongodb.connection-string=mongodb://localhost:27017
 quarkus.mongodb.database=selcUser
-rest-assured.base-url=http://localhost
-rest-assured.port=8080
+
+mp.jwt.verify.publickey=${JWT-PUBLIC-KEY:test}
+
+quarkus.openapi-generator.user_registry_json.auth.api_key.api-key=9fypKNFfVY8jvWHUgABpH23VrChnRzvRpSq5b1ng
+quarkus.rest-client."org.openapi.quarkus.user_registry_json.api.UserApi".url=http://localhost:1080/user-registry-mock/v1
+
+user-ms.blob-storage.container-templates=resources
+user-ms.blob-storage.container-product=products
+user-ms.blob-storage.connection-string-product=DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCD9I1QhZT4gRjAAHEDPazjFIwtg==;BlobEndpoint=http://localhost:10000/devstoreaccount1;
+user-ms.blob-storage.connection-string-templates=DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCD9I1QhZT4gRjAAHEDPazjFIwtg==;BlobEndpoint=http://localhost:10000/devstoreaccount1;