✨ Feature ➾ Allow docker images to be overwritten via environment variable (#1425)

[mweichert]

🌮 Taqueria PR

🪁 Description

There are four plugins currently which use docker images to facilitate their functionality:

• ligo plugin
• archetype plugin
• flextesa plugin
• tezos-client plugin

🪂 Pre-Merge Checklist (Definition of Done)

🚦 Required to merge:

• ⛱️ I have completed this PR template in full and updated the title appropriately
• ⛵ My code builds cleanly, and I have manually tested the changes
• 🏄‍♂️ Another team member has built this branch and done manual testing on the change
• 🏖️ New and existing unit tests pass locally and in CI
• 🔱 The test plan has been implemented and verified by an SDET
• 🦀 Automated tests have been written and added to this PR
• 🐬 I have commented my code, particularly in hard-to-understand areas
• 🤿 Corresponding changes have been made to all documentation
• 🐚 Required changes to the VScE have been made
• 🪸 Required updates to scaffolds have been made
• 🚢 The release checklist has been completed

🛩️ Summary of Changes

Users were looking for the ability to override the docker image being used. This is a common request in CICD, and thus we opted to allow overrides using environment variables. This is not mutually exclusive from adding an option later to allow specifying version #s in the config file, such as the ligo version.

🎢 Test Plan

• I introduced a new function in the SDK called getDockerImage, and added a unit test for it in taqueria-sdk.spec.ts
• For each plugin, I added a test case to assure that each plugin could have a custom image specified using a plugin. To do this, I added a hidden task for each plugin called get-image that our tests can use to verify what image is being used.

🛸 Type of Change

• 🧽 Chore ➾
• 🛠️ Fix ➾
• ✨ Feature ➾
• 👷 Refactor ➾
• 🧪 Pre-Release ➾
• 🚀 Release ➾

[cloudflare-workers-and-pages]

Deploying with    Cloudflare Pages

Latest commit:	41224d3
Status:	✅  Deploy successful!
Preview URL:	https://ac57f531.taqueria.pages.dev
Branch Preview URL:	https://1425-docker-overrides.taqueria.pages.dev

View logs

[github-actions]

Latest Commit	41224d3
Taq Binaries	Linux MacOS Windows
npm Packages	npm i @taqueria/plugin-archetype@0.22.2-1445.41224d34 --registry https://npm.ecadinfra.com npm i @taqueria/plugin-contract-types@0.22.2-1445.41224d34 --registry https://npm.ecadinfra.com npm i @taqueria/plugin-core@0.22.2-1445.41224d34 --registry https://npm.ecadinfra.com npm i @taqueria/plugin-flextesa@0.22.2-1445.41224d34 --registry https://npm.ecadinfra.com npm i @taqueria/plugin-ipfs-pinata@0.22.2-1445.41224d34 --registry https://npm.ecadinfra.com npm i @taqueria/plugin-jest@0.22.2-1445.41224d34 --registry https://npm.ecadinfra.com npm i @taqueria/plugin-ligo@0.22.2-1445.41224d34 --registry https://npm.ecadinfra.com npm i @taqueria/plugin-metadata@0.22.2-1445.41224d34 --registry https://npm.ecadinfra.com npm i @taqueria/plugin-smartpy@0.22.2-1445.41224d34 --registry https://npm.ecadinfra.com npm i @taqueria/plugin-taquito@0.22.2-1445.41224d34 --registry https://npm.ecadinfra.com npm i @taqueria/plugin-tezos-client@0.22.2-1445.41224d34 --registry https://npm.ecadinfra.com npm i @taqueria/protocol@0.22.2-1445.41224d34 --registry https://npm.ecadinfra.com npm i @taqueria/node-sdk@0.22.2-1445.41224d34 --registry https://npm.ecadinfra.com npm i @taqueria/state@0.22.2-1445.41224d34 --registry https://npm.ecadinfra.com npm i @taqueria/toolkit@0.22.2-1445.41224d34 --registry https://npm.ecadinfra.com npm i @0.22.2-1445.41224d34 --registry https://npm.ecadinfra.com
VSCode Extension VSIX	taqueria-vscode-1425-docker-overrides-ubuntu-latest

[ac10n]

One general question?
Why do we enable this through environment variables and not by optional settings in config.json?

[jchenche]

Some e2e tests are failing. Can we address those first?

[mweichert]

One general question? Why do we enable this through environment variables and not by optional settings in config.json?

@AlirezaHaghshenas somehow I missed your comment here. It was thought that this would be easiest for CI/CD setups. However, I don't think this is mutually exclusive from also offering the ability override by config. I think that's a great idea too. But this was just meant to resolve a particular use-case.

[jchenche]

This PR is outdated. Can you merge main in and resolve all conflicts?

[jchenche]

It is easier to reason and reduces cognitive overhead to only assign literals to global constants

[ac10n]

LGTM.

I would personally be happier if we had not created the get-image tasks.

Is there an end-user use-case for those?

[mweichert]

LGTM.

I would personally be happier if we had not created the get-image tasks.

Is there an end-user use-case for those?

It's just to verify what docker image is used by a particular plugin, just in case you need to double check. I believe I made these tasks hidden from the UI.

[jchenche]

LGMT!