feat!: Add secrets support when downloading remote artifacts (backwords compatible version)

Author: aleksanderson

README.md

@@ -190,11 +190,12 @@ 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" }
+    { url: "https://gitlab.com/user/private_repo/artifact1.yaml", secretName: "gl-secret" },
+    "https://github.com/user/public_repo/artifact2.yaml"
   ])
   .withSecondaryRemoteArtifacts([
-    { url: "https://example.com/user/repo/examples.yaml", secretName: "gl-secret" }
+    { url: "https://gitlab.com/user/private_repo/examples1.yaml", secretName: "gl-secret" },
+    "https://github.com/user/public_repo/examples2.yaml"
   ]);
 ```
 

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([{ url: "https://raw.githubusercontent.com/microcks/microcks/master/samples/APIPastry-openapi.yaml"} ])
+      .withMainRemoteArtifacts(["https://raw.githubusercontent.com/microcks/microcks/master/samples/APIPastry-openapi.yaml"])
       .withSecondaryArtifacts([path.resolve(resourcesDir, "apipastries-postman-collection.json")])
       .start();
 

src/microcks-container.ts

@@ -59,7 +59,7 @@ export class MicrocksContainer extends GenericContainer {
   /**
    * 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 Array of URLs (strings) or objects with {url, secretName} (OpenAPI, Postman collection, Protobuf, GraphQL schema, ...)
    * @returns this
    */
   public withMainRemoteArtifacts(remoteArtifactUrls: RemoteArtifact[]): this {
@@ -70,7 +70,7 @@ export class MicrocksContainer extends GenericContainer {
   /**
    * 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 Array of URLs (strings) or objects with {url, secretName} (OpenAPI, Postman collection, Protobuf, GraphQL schema, ...)
    * @returns this
    */
   public withSecondaryRemoteArtifacts(remoteArtifactUrls: RemoteArtifact[]): this {
@@ -115,14 +115,14 @@ export class MicrocksContainer extends GenericContainer {
     }
     // Load remote artifacts before local ones.
     for (let i=0; i<this.mainRemoteArtifacts.length; i++) {
-      const {url , secretName} = this.mainRemoteArtifacts[i];
+      const { url, secretName } = this.extractArtifactInfo(this.mainRemoteArtifacts[i]);
       await startedContainer.downloadAsMainArtifact(url, secretName);
     }
     for (let i=0; i<this.secondaryRemoteArtifacts.length; i++) {
-      const {url , secretName} = this.mainRemoteArtifacts[i];
+      const { url, secretName } = this.extractArtifactInfo(this.secondaryRemoteArtifacts[i]);
       await startedContainer.downloadAsSecondaryArtifact(url, secretName);
     }
-    // Import artifacts declared in configuration. 
+    // Import artifacts declared in configuration.
     for (let i=0; i<this.mainArtifacts.length; i++) {
       await startedContainer.importAsMainArtifact(this.mainArtifacts[i]);
     }
@@ -135,6 +135,12 @@ export class MicrocksContainer extends GenericContainer {
 
     return startedContainer;
   }
+
+  private extractArtifactInfo(artifact: RemoteArtifact): { url: string; secretName?: string } {
+    return typeof artifact === 'string'
+      ? { url: artifact }
+      : { url: artifact.url, secretName: artifact.secretName };
+  }
 }
 
 export enum OAuth2GrantType {
@@ -289,7 +295,7 @@ export interface DailyInvocationStatistic {
   minuteCount: {string: number};
 }
 
-export interface RemoteArtifact {
+export type RemoteArtifact = string | {
   url: string;
   secretName?: string;
 }
@@ -604,7 +610,6 @@ export class StartedMicrocksContainer extends AbstractStartedContainer {
     return invocationStats.dailyCount;
   }
 
-  
   private async importArtifact(artifactPath: string, mainArtifact: boolean): Promise<void> {
     const isFile = await this.isFile(artifactPath);
     if (!isFile) {