feat: #192 Add ability to specify secret on remote artifacts

Signed-off-by: Laurent Broudoux <laurent.broudoux@gmail.com>

Author: lbroudoux

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

@@ -84,8 +84,8 @@ public class MicrocksContainer extends GenericContainer<MicrocksContainer> {
    private Set<String> snapshotsToImport;
    private Set<String> mainArtifactsToImport;
    private Set<String> secondaryArtifactsToImport;
-   private Set<String> mainRemoteArtifactsToImport;
-   private Set<String> secondaryRemoteArtifactsToImport;
+   private Set<RemoteArtifact> mainRemoteArtifactsToImport;
+   private Set<RemoteArtifact> secondaryRemoteArtifactsToImport;
    private Set<Secret> secrets;
 
    /**
@@ -149,7 +149,22 @@ public MicrocksContainer withMainRemoteArtifacts(String... remoteArtifactUrls) {
       if (mainRemoteArtifactsToImport == null) {
          mainRemoteArtifactsToImport = new HashSet<>();
       }
-      mainRemoteArtifactsToImport.addAll(Arrays.stream(remoteArtifactUrls).collect(Collectors.toList()));
+      mainRemoteArtifactsToImport.addAll(Arrays.stream(remoteArtifactUrls)
+            .map(url -> RemoteArtifact.of(url, null)).collect(Collectors.toSet()));
+      return self();
+   }
+
+   /**
+    * Provide remote artifacts (with secret name) that will be imported as primary or main ones within the Microcks
+    * container once it will be started and healthy.
+    * @param remoteArtifacts A set of remote artifacts that will be loaded
+    * @return self
+    */
+   public MicrocksContainer withMainRemoteArtifacts(RemoteArtifact... remoteArtifacts) {
+      if (mainRemoteArtifactsToImport == null) {
+         mainRemoteArtifactsToImport = new HashSet<>();
+      }
+      mainRemoteArtifactsToImport.addAll(Arrays.stream(remoteArtifacts).collect(Collectors.toSet()));
       return self();
    }
 
@@ -163,7 +178,22 @@ public MicrocksContainer withSecondaryRemoteArtifacts(String... remoteArtifactUr
       if (secondaryRemoteArtifactsToImport == null) {
          secondaryRemoteArtifactsToImport = new HashSet<>();
       }
-      secondaryRemoteArtifactsToImport.addAll(Arrays.stream(remoteArtifactUrls).collect(Collectors.toList()));
+      secondaryRemoteArtifactsToImport.addAll(Arrays.stream(remoteArtifactUrls)
+            .map(url -> RemoteArtifact.of(url, null)).collect(Collectors.toSet()));
+      return self();
+   }
+
+   /**
+    * Provide remote artifacts (with secret name)  that will be imported as secondary ones within the Microcks
+    * container once it will be started and healthy.
+    * @param remoteArtifacts A set of remote artifacts that will be loaded
+    * @return self
+    */
+   public MicrocksContainer withSecondaryRemoteArtifacts(RemoteArtifact... remoteArtifacts) {
+      if (secondaryRemoteArtifactsToImport == null) {
+         secondaryRemoteArtifactsToImport = new HashSet<>();
+      }
+      secondaryRemoteArtifactsToImport.addAll(Arrays.stream(remoteArtifacts).collect(Collectors.toSet()));
       return self();
    }
 
@@ -200,12 +230,16 @@ protected void containerIsStarted(InspectContainerResponse containerInfo) {
       if (snapshotsToImport != null && !snapshotsToImport.isEmpty()) {
          snapshotsToImport.forEach(this::importSnapshot);
       }
+      // Load secrets before remote artifacts as they may be needed for authentication.
+      if (secrets != null && !secrets.isEmpty()) {
+         secrets.forEach(this::createSecret);
+      }
       // Load remote artifacts before local ones.
       if (mainRemoteArtifactsToImport != null && !mainRemoteArtifactsToImport.isEmpty()) {
-         mainRemoteArtifactsToImport.forEach((String remoteArtifactUrl) -> this.downloadArtifact(remoteArtifactUrl, true));
+         mainRemoteArtifactsToImport.forEach(remoteArtifact -> this.downloadArtifact(remoteArtifact, true));
       }
       if (secondaryRemoteArtifactsToImport != null && !secondaryRemoteArtifactsToImport.isEmpty()) {
-         secondaryRemoteArtifactsToImport.forEach((String remoteArtifactUrl) -> this.downloadArtifact(remoteArtifactUrl, false));
+         secondaryRemoteArtifactsToImport.forEach(remoteArtifact -> this.downloadArtifact(remoteArtifact, false));
       }
       // Load local ones that may override remote ones.
       if (mainArtifactsToImport != null && !mainArtifactsToImport.isEmpty()) {
@@ -214,10 +248,6 @@ protected void containerIsStarted(InspectContainerResponse containerInfo) {
       if (secondaryArtifactsToImport != null && !secondaryArtifactsToImport.isEmpty()) {
          secondaryArtifactsToImport.forEach((String artifactPath) -> this.importArtifact(artifactPath, false));
       }
-      // Load secrets before remote artifacts as they may be needed for authentication.
-      if (secrets != null && !secrets.isEmpty()) {
-         secrets.forEach(this::createSecret);
-      }
    }
 
    /**
@@ -625,7 +655,7 @@ public static List<UnidirectionalEvent> getEventMessagesForTestCase(String micro
     * @throws ArtifactLoadException If artifact cannot be correctly downloaded in container (probably not found)
     */
    public void downloadAsMainRemoteArtifact(String remoteArtifactUrl) throws ArtifactLoadException {
-      downloadArtifact(remoteArtifactUrl, true);
+      downloadArtifact(new RemoteArtifact(remoteArtifactUrl, null), true);
    }
 
    /**
@@ -634,7 +664,7 @@ public void downloadAsMainRemoteArtifact(String remoteArtifactUrl) throws Artifa
     * @throws ArtifactLoadException If artifact cannot be correctly downloaded in container (probably not found)
     */
    public void downloadAsSecondaryRemoteArtifact(String remoteArtifactUrl) throws ArtifactLoadException {
-      downloadArtifact(remoteArtifactUrl, false);
+      downloadArtifact(new RemoteArtifact(remoteArtifactUrl, null), false);
    }
 
    /**
@@ -803,7 +833,7 @@ private void importArtifact(String artifactPath, boolean mainArtifact) {
       }
    }
 
-   private void downloadArtifact(String remoteArtifactUrl, boolean mainArtifact) throws ArtifactLoadException {
+   private void downloadArtifact(RemoteArtifact remoteArtifact, boolean mainArtifact) throws ArtifactLoadException {
       try {
          // Use the artifact/download endpoint to download the artifact.
          URL url = new URL(getHttpEndpoint() + "/api/artifact/download");
@@ -812,7 +842,11 @@ private void downloadArtifact(String remoteArtifactUrl, boolean mainArtifact) th
          httpConn.setRequestMethod("POST");
          httpConn.setDoOutput(true);
 
-         String requestBody = "mainArtifact=" + mainArtifact + "&url=" + remoteArtifactUrl;
+         String requestBody = "mainArtifact=" + mainArtifact + "&url=" + remoteArtifact.getUrl();
+
+         if (remoteArtifact.getSecretName() != null) {
+            requestBody += "&secretName=" + remoteArtifact.getSecretName();
+         }
 
          // Write the request body to the output stream of the connection
          try (OutputStream os = httpConn.getOutputStream();
@@ -832,8 +866,8 @@ private void downloadArtifact(String remoteArtifactUrl, boolean mainArtifact) th
          // Disconnect Http connection.
          httpConn.disconnect();
       } catch (Exception e) {
-         log.error("Could not load remote artifact: {}", remoteArtifactUrl);
-         throw new ArtifactLoadException("Error while importing remote artifact: " + remoteArtifactUrl, e);
+         log.error("Could not load remote artifact: {}", remoteArtifact.getUrl());
+         throw new ArtifactLoadException("Error while importing remote artifact: " + remoteArtifact.getUrl(), e);
       }
    }
 
@@ -843,7 +877,7 @@ private void importSnapshot(String snapshotPath) {
          resource = MicrocksContainer.class.getClassLoader().getResource(snapshotPath);
          if (resource == null) {
             log.warn("Could not load classpath snapshot: {}", snapshotPath);
-            throw new ArtifactLoadException("Error while importing snasphot: " + snapshotPath);
+            throw new ArtifactLoadException("Error while importing snapshot: " + snapshotPath);
          }
       }
       try {

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

@@ -264,6 +264,17 @@ public MicrocksContainersEnsemble withMainRemoteArtifacts(String... remoteArtifa
       return this;
    }
 
+   /**
+    * Provide remote artifacts that will be imported as primary or main ones within the Microcks container
+    * once it will be started and healthy.
+    * @param remoteArtifacts A set of remote artifacts that will be loaded
+    * @return self
+    */
+   public MicrocksContainersEnsemble withMainRemoteArtifacts(RemoteArtifact... remoteArtifacts) {
+      microcks.withMainRemoteArtifacts(remoteArtifacts);
+      return this;
+   }
+
    /**
     * Provide urls to artifacts that will be imported as secondary ones within the Microcks container
     * once it will be started and healthy.
@@ -275,6 +286,17 @@ public MicrocksContainersEnsemble withSecondaryRemoteArtifacts(String... remoteA
       return this;
    }
 
+   /**
+    * Provide remote artifacts that will be imported as secondary ones within the Microcks container
+    * once it will be started and healthy.
+    * @param remoteArtifactUrl A set of remote artifacts that will be loaded
+    * @return self
+    */
+   public MicrocksContainersEnsemble withSecondaryRemoteArtifacts(RemoteArtifact... remoteArtifactUrl) {
+      microcks.withSecondaryRemoteArtifacts(remoteArtifactUrl);
+      return this;
+   }
+
    /**
     * Provide Secret that should be imported in Microcks after startup.
     * @param secret The description of a secret to access remote Git repository, test endpoint or broker.

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

@@ -0,0 +1,53 @@
+/*
+ * Copyright The Microcks Authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *  http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package io.github.microcks.testcontainers;
+
+/**
+ * Immutable bean representing a remote artifact with its URL and associated secret name.
+ * Because we cannot use record with our Java 8 baseline, we use a simple POJO.
+ * @author laurent
+ */
+public class RemoteArtifact {
+   private final String url;
+   private final String secretName;
+
+   /**
+    * Constructor for RemoteArtifact.
+    * @param url The URL of the remote artifact.
+    * @param secretName The name of the secret to use for accessing the artifact.
+    */
+   public RemoteArtifact(String url, String secretName) {
+      this.url = url;
+      this.secretName = secretName;
+   }
+
+   /**
+    * Build a RemoteArtifact
+    * @param url The URL of the remote artifact.
+    * @param secretName The name of the secret to use for accessing the artifact.
+    * @return A new instance of RemoteArtifact.
+    */
+   public static RemoteArtifact of(String url, String secretName) {
+      return new RemoteArtifact(url, secretName);
+   }
+
+   public String getUrl() {
+      return url;
+   }
+   public String getSecretName() {
+      return secretName;
+   }
+}

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

@@ -161,7 +161,10 @@ public void testContractTestingFunctionalityWithOAuth2() throws Exception {
    public void testSecretCreation() throws Exception {
       try (
             MicrocksContainer microcks = new MicrocksContainer(MICROCKS_IMAGE)
-                  .withSecret(new Secret.Builder().name("my-secret").token("abc-123-xyz").build());
+                  .withSecret(new Secret.Builder().name("my-secret").token("abc-123-xyz").tokenHeader("x-microcks").build())
+                  .withMainRemoteArtifacts(
+                        RemoteArtifact.of("https://raw.githubusercontent.com/microcks/microcks/master/samples/APIPastry-openapi.yaml",
+                              "my-secret"));
       ) {
          microcks.start();
          testMicrocksConfigRetrieval(microcks.getHttpEndpoint());
@@ -174,6 +177,7 @@ public void testSecretCreation() throws Exception {
          assertEquals(1, secrets.jsonPath().getList(".").size());
          assertEquals("my-secret", secrets.jsonPath().get("[0].name"));
          assertEquals("abc-123-xyz", secrets.jsonPath().get("[0].token"));
+         assertEquals("x-microcks", secrets.jsonPath().get("[0].tokenHeader"));
       }
    }