Possibility to use secrets when downloading remote artifacts

[aleksanderson]

Reason/Context

Initial discussion: https://discord.com/channels/1162356525969449100/1377342093474926713

--

microcs-testcontainer-node has the withSecret() method. The documentation https://github.com/microcks/microcks-testcontainers-node explains how to set this up and use it for the Contract Test use case. However, it is not possible to reference the secret in cases when we need to download remote artifacts, e.g., .withMainRemoteArtifacts() and .withSecondaryRemoteArtifacts()

Use cases:

• Create a mock server using Microcks Testcontainer and inject it with the OpenAPI specification hosted in a remote private repository.

Description

Extend the .withMainRemoteArtifacts() and .withSecondaryRemoteArtifacts() methods to accept the secret created earlier via .withSecret()

There are two options:

Option 1 - A fully backward compatible:

microcksContainer
  .withMainRemoteArtifacts([
    { url: "https://gitlab.com/user/repo/artifact1.yaml", secretName: "gl-secret" },
   "https://github.com/user/repo/artifact2.yaml" 
  ])
  .withSecondaryRemoteArtifacts([
    { url: "https://gitlab.com/user/repo/examples1.yaml", secretName: "gl-secret" },
    "https://github.com/user/repo/examples2.yaml"
  ]);

Option 2 - Breaking change:

microcksContainer
  .withMainRemoteArtifacts([
    { url: "https://gitlab.com/user/repo/artifact1.yaml", secretName: "gl-secret" },
    { url: "https://github.com/user/repo/artifact2.yaml" }
  ])
  .withSecondaryRemoteArtifacts([
    { url: "https://gitlab.com/user/repo/examples1.yaml", secretName: "gl-secret" },
    { url: "https://github.com/user/repo/examples2.yaml" }
  ]);

Implementation ideas

This is an example of a proposed change set (breaking change option): https://github.com/aleksanderson/microcks-testcontainers-node/pull/1/files

[github-actions]

👋 @aleksanderson

Welcome to the Microcks community! 💖

Thanks and congrats 🎉 for opening your first issue here! Be sure to follow the issue template or please update it accordingly.

📢 If you're using Microcks in your organization, please add your company name to this list. 🙏 It really helps the project to gain momentum and credibility. It's a small contribution back to the project with a big impact.

If you need to know why and how to add yourself to the list, please read the blog post "Join the Microcks Adopters list and Empower the vibrant open source Community 🙌"

Hope you have a great time there!

🌟 ~~~~~~~~~ 🌟

📢 If you like Microcks, please ⭐ star ⭐ our repo to support it!

🙏 It really helps the project to gain momentum and credibility. It's a small contribution back to the project with a big impact.

[lbroudoux]

Hi @aleksanderson!

I'd like to integrate this enhancement in the next 0.3.2 version. However, as it's a patch version, I would prefer the non-breaking change option (Option 1 above). Do you think it would be possible to adapt your code and push the PR?