feat: #260 Adding withDebugLogLevel() methods

Signed-off-by: Laurent Broudoux <[email protected]>

Author: lbroudoux

README.md

@@ -336,4 +336,18 @@ TestResult testResult = testResultFuture.get();
 assertTrue(testResult.isSuccess());
 ```
 
-In addition, you can use the `getEventMessagesForTestCase()` method to retrieve the events received during the test.
+In addition, you can use the `getEventMessagesForTestCase()` method to retrieve the events received during the test.
+
+### Troubleshooting
+
+You can enable debug logs on the Microcks container by setting the debug log level and then retrieving the logs:
+
+```java
+MicrocksContainer microcks = new MicrocksContainer("[...]"))
+        .withDebugLogLevel()
+        .start();
+microcks.getLogs();
+```
+
+The same `.withDebugLogLevel()` method is available on also `MicrocksContainersEnsemble` for enabling debug logs 
+on all contained Microcks containers.

src/main/java/io/github/microcks/testcontainers/MicrocksAsyncMinionContainer.java

@@ -93,6 +93,16 @@ public MicrocksAsyncMinionContainer(Network network, DockerImageName imageName,
    }
 
 
+   /**
+    * Set the container logging level to DEBUG.
+    * @return self
+    */
+   public MicrocksAsyncMinionContainer withDebugLogLevel() {
+      withEnv("QUARKUS_LOG_CONSOLE_LEVEL", "DEBUG");
+      withEnv("QUARKUS_LOG_CATEGORY__IO_GITHUB_MICROCKS__LEVEL", "DEBUG");
+      return self();
+   }
+
    /**
     * Connect the MicrocksAsyncMinionContainer to a Kafka server to allow Kafka messages mocking.
     * @param connection Connection details to a Kafka broker.

src/main/java/io/github/microcks/testcontainers/MicrocksContainer.java

@@ -111,6 +111,15 @@ public MicrocksContainer(DockerImageName imageName) {
       waitingFor(Wait.forLogMessage(".*Started MicrocksApplication.*", 1));
    }
 
+   /**
+    * Set the container logging level to DEBUG.
+    * @return self
+    */
+   public MicrocksContainer withDebugLogLevel() {
+      withEnv("LOGGING_LEVEL_IO_GITHUB_MICROCKS", "DEBUG");
+      return self();
+   }
+
    /**
     * Provide paths to artifacts that will be imported as primary or main ones within the Microcks container
     * once it will be started and healthy.

src/main/java/io/github/microcks/testcontainers/MicrocksContainersEnsemble.java

@@ -53,9 +53,9 @@ public class MicrocksContainersEnsemble implements Startable {
    private MicrocksAsyncMinionContainer asyncMinion;
    private final MicrocksContainer microcks;
 
-   private final Map<String, String> postmanEnvVars = new HashMap();
-   private final Map<String, String> asyncMinionEnvVars = new HashMap();
-   private final Map<String, String> microcksEnvVars = new HashMap();
+   private final Map<String, String> postmanEnvVars = new HashMap<>();
+   private final Map<String, String> asyncMinionEnvVars = new HashMap<>();
+   private final Map<String, String> microcksEnvVars = new HashMap<>();
 
    /**
     * Build a new MicrocksContainersEnsemble with its base container image name as string. This image must
@@ -100,6 +100,17 @@ public MicrocksContainersEnsemble(Network network, DockerImageName image) {
                   + ":" + MicrocksAsyncMinionContainer.MICROCKS_ASYNC_MINION_HTTP_PORT);
    }
 
+   /**
+    * Enable debug log level on MicrocksContainersEnsemble containers.
+    * @return self
+    */
+   public MicrocksContainersEnsemble withDebugLogLevel() {
+      microcks.withDebugLogLevel();
+      asyncMinionEnvVars.put("QUARKUS_LOG_CONSOLE_LEVEL", "DEBUG");
+      asyncMinionEnvVars.put("QUARKUS_LOG_CATEGORY__IO_GITHUB_MICROCKS__LEVEL", "DEBUG");
+      return this;
+   }
+
    /**
     * Add an environment variable to Postman runtime container.
     * @param key The env var name

src/test/java/io/github/microcks/testcontainers/MicrocksContainerTest.java

@@ -62,6 +62,7 @@ class MicrocksContainerTest {
    void testMockingFunctionality() throws Exception {
       try (
             MicrocksContainer microcks = new MicrocksContainer(IMAGE)
+                  .withDebugLogLevel()
                   .withSnapshots("microcks-repository.json")
                   .withMainArtifacts("apipastries-openapi.yaml", "sub dir/weather-forecast-openapi.yaml")
                   .withMainRemoteArtifacts("https://raw.githubusercontent.com/microcks/microcks/master/samples/APIPastry-openapi.yaml")
@@ -73,6 +74,9 @@ void testMockingFunctionality() throws Exception {
 
          testMockEndpoints(microcks);
          testMicrocksMockingFunctionality(microcks);
+
+         // Check that debug logs are present.
+         assertTrue(microcks.getLogs().contains("DEBUG 1"));
       }
    }
 

src/test/java/io/github/microcks/testcontainers/MicrocksContainersEnsembleTest.java

@@ -156,13 +156,18 @@ void testAsyncFeatureSetup() {
    void testAsyncFeatureMockingFunctionality() throws Exception {
       try (
             MicrocksContainersEnsemble ensemble = new MicrocksContainersEnsemble(IMAGE)
+                  .withDebugLogLevel()
                   .withMainArtifacts("pastry-orders-asyncapi.yml")
                   .withAsyncFeature();
       ) {
          ensemble.start();
          testMicrocksConfigRetrieval(ensemble.getMicrocksContainer().getHttpEndpoint());
 
          testMicrocksAsyncMockingFunctionality(ensemble);
+
+         // Check that debug logs are present.
+         assertTrue(ensemble.getMicrocksContainer().getLogs().contains("DEBUG 1"));
+         assertTrue(ensemble.getAsyncMinionContainer().getLogs().contains("DEBUG ["));
       }
    }