feat!: Add secrets support when downloading remote artifacts

Author: aleksanderson

README.md

@@ -185,6 +185,20 @@ const testRequest: TestRequest = {
 }
 ```
 
+You may also reference secrets when downloading remote artifacts:
+
+```ts
+microcksContainer
+  .withMainRemoteArtifacts([
+    { url: "https://gitlab.com/user/repo/artifact1.yaml", secretName: "gl-secret" },
+    { url: "https://github.com/user/repo/artifact2.yaml" }
+  ])
+  .withSecondaryRemoteArtifacts([
+    { url: "https://example.com/user/repo/examples.yaml", secretName: "gl-secret" }
+  ]);
+```
+
+
 ### Advanced features with MicrocksContainersEnsemble
 
 The `MicrocksContainer` referenced above supports essential features of Microcks provided by the main Microcks container. The list of supported features is the following:

src/microcks-container.test.ts

@@ -35,7 +35,7 @@ describe("MicrocksContainer", () => {
     const container = await new MicrocksContainer()
       .withSnapshots([path.resolve(resourcesDir, "microcks-repository.json")])
       .withMainArtifacts([path.resolve(resourcesDir, "apipastries-openapi.yaml")])
-      .withMainRemoteArtifacts(["https://raw.githubusercontent.com/microcks/microcks/master/samples/APIPastry-openapi.yaml"])
+      .withMainRemoteArtifacts([{ url: "https://raw.githubusercontent.com/microcks/microcks/master/samples/APIPastry-openapi.yaml"} ])
       .withSecondaryArtifacts([path.resolve(resourcesDir, "apipastries-postman-collection.json")])
       .start();
 

src/microcks-container.ts

@@ -24,8 +24,8 @@ export class MicrocksContainer extends GenericContainer {
   private snapshots: string[] = [];
   private mainArtifacts: string[] = [];
   private secondaryArtifacts: string[] = [];
-  private mainRemoteArtifacts: string[] = [];
-  private secondaryRemoteArtifacts: string[] = [];
+  private mainRemoteArtifacts: RemoteArtifact[] = [];
+  private secondaryRemoteArtifacts: RemoteArtifact[] = [];
   private secrets: Secret[] = [];
 
   constructor(image = "quay.io/microcks/microcks-uber:1.11.0") {
@@ -62,7 +62,7 @@ export class MicrocksContainer extends GenericContainer {
    * @param {[String]} remoteArtifactUrls The urls or remote artifacts (OpenAPI, Postman collection, Protobuf, GraphQL schema, ...)
    * @returns this
    */
-  public withMainRemoteArtifacts(remoteArtifactUrls: string[]): this {
+  public withMainRemoteArtifacts(remoteArtifactUrls: RemoteArtifact[]): this {
     this.mainRemoteArtifacts = this.mainRemoteArtifacts.concat(remoteArtifactUrls);
     return this;
   }
@@ -73,7 +73,7 @@ export class MicrocksContainer extends GenericContainer {
    * @param {[String]} remoteArtifactUrls The furls or remote (OpenAPI, Postman collection, Protobuf, GraphQL schema, ...)
    * @returns this
    */
-  public withSecondaryRemoteArtifacts(remoteArtifactUrls: string[]): this {
+  public withSecondaryRemoteArtifacts(remoteArtifactUrls: RemoteArtifact[]): this {
     this.secondaryRemoteArtifacts = this.secondaryRemoteArtifacts.concat(remoteArtifactUrls);
     return this;
   }
@@ -115,10 +115,12 @@ export class MicrocksContainer extends GenericContainer {
     }
     // Load remote artifacts before local ones.
     for (let i=0; i<this.mainRemoteArtifacts.length; i++) {
-      await startedContainer.downloadAsMainArtifact(this.mainRemoteArtifacts[i]);
+      const {url , secretName} = this.mainRemoteArtifacts[i];
+      await startedContainer.downloadAsMainArtifact(url, secretName);
     }
     for (let i=0; i<this.secondaryRemoteArtifacts.length; i++) {
-      await startedContainer.downloadAsSecondaryArtifact(this.secondaryRemoteArtifacts[i]);
+      const {url , secretName} = this.mainRemoteArtifacts[i];
+      await startedContainer.downloadAsSecondaryArtifact(url, secretName);
     }
     // Import artifacts declared in configuration. 
     for (let i=0; i<this.mainArtifacts.length; i++) {
@@ -287,6 +289,11 @@ export interface DailyInvocationStatistic {
   minuteCount: {string: number};
 }
 
+export interface RemoteArtifact {
+  url: string;
+  secretName?: string;
+}
+
 
 export class StartedMicrocksContainer extends AbstractStartedContainer {
   private readonly httpPort: number;
@@ -439,17 +446,17 @@ export class StartedMicrocksContainer extends AbstractStartedContainer {
    * @param {String} remoteArtifactUrl The URL to remote artifact (OpenAPI, Postman collection, Protobuf, GraphQL schema, ...)
    * @returns Success or error via Promise
    */
-  public async downloadAsMainArtifact(remoteArtifactUrl: string): Promise<void> {
-    return this.downloadArtifact(remoteArtifactUrl, true);
+  public async downloadAsMainArtifact(remoteArtifactUrl: string, secretName?: string): Promise<void> {
+    return this.downloadArtifact(remoteArtifactUrl, true, secretName);
   }
 
   /**
    * Download a remote artifact as a secondary one within the Microcks container.
    * @param {String} remoteArtifactUrl The URL to remote artifact (OpenAPI, Postman collection, Protobuf, GraphQL schema, ...)
    * @returns Success or error via Promise
    */
-  public async downloadAsSecondaryArtifact(remoteArtifactUrl: string): Promise<void> {
-    return this.downloadArtifact(remoteArtifactUrl, false);
+  public async downloadAsSecondaryArtifact(remoteArtifactUrl: string, secretName?: string): Promise<void> {
+    return this.downloadArtifact(remoteArtifactUrl, false, secretName);
   }
 
   /**
@@ -613,11 +620,14 @@ export class StartedMicrocksContainer extends AbstractStartedContainer {
     }
   }
 
-  private async downloadArtifact(remoteArtifactUrl: string, mainArtifact: boolean): Promise<void> {
+  private async downloadArtifact(remoteArtifactUrl: string, mainArtifact: boolean, secretName?: string): Promise<void> {
     let formBody = new URLSearchParams({
       "mainArtifact": String(mainArtifact),
       "url": remoteArtifactUrl
     });
+    if (secretName) {
+      formBody.append("secretName", secretName);
+    }
 
     // Prepare headers with content type and length.
     const headers: Record<string, string> = {

src/microcks-containers-ensemble.ts

@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 import { GenericContainer, StartedNetwork, StartedTestContainer, StopOptions, Wait } from "testcontainers";
-import { MicrocksContainer, Secret, StartedMicrocksContainer } from "./microcks-container";
+import { MicrocksContainer, Secret, StartedMicrocksContainer, RemoteArtifact } from "./microcks-container";
 import { 
   AmazonServiceConnection, GenericConnection, KafkaConnection, 
   MicrocksAsyncMinionContainer, StartedMicrocksAsyncMinionContainer 
@@ -162,21 +162,21 @@ export class MicrocksContainersEnsemble {
   /**
    * Provide urls of remote artifacts that will be imported as primary or main ones within the Microcks container
    * once it will be started and healthy.
-   * @param {[String]} remoteArtifactUrls The urls or remote artifacts (OpenAPI, Postman collection, Protobuf, GraphQL schema, ...)
+   * @param {[RemoteArtifact]} remoteArtifactUrls The urls or remote artifacts (OpenAPI, Postman collection, Protobuf, GraphQL schema, ...)
    * @returns this
    */
-  public withMainRemoteArtifacts(remoteArtifactUrls: string[]): this {
+  public withMainRemoteArtifacts(remoteArtifactUrls: RemoteArtifact[]): this {
     this.microcksContainer.withMainRemoteArtifacts(remoteArtifactUrls);
     return this;
   }
 
   /**
    * Provide urls of remote artifacts that will be imported as secondary ones within the Microcks container
    * once it will be started and healthy.
-   * @param {[String]} remoteArtifactUrls The furls or remote (OpenAPI, Postman collection, Protobuf, GraphQL schema, ...)
+   * @param {[RemoteArtifact]} remoteArtifactUrls The furls or remote (OpenAPI, Postman collection, Protobuf, GraphQL schema, ...)
    * @returns this
    */
-  public withSecondaryRemoteArtifacts(remoteArtifactUrls: string[]): this {
+  public withSecondaryRemoteArtifacts(remoteArtifactUrls: RemoteArtifact[]): this {
     this.microcksContainer.withSecondaryRemoteArtifacts(remoteArtifactUrls);
     return this;
   }