purpleclay / testcontainers-imds

Testcontainers wrapper for the Instance Metadata Mock (imds-mock) tool. Quickly and easily simulate IMDS for localised testing

Hi there 👋

Building tools to make developers' lives easier is my passion

testcontainers-imds's Issues

[Feature]: stay in sync with the latest AEMM mock by publishing custom container

Describe your feature

The amazon-ec2-metadata-mock doesn't publish images with the latest tag. So there is a good change that this library will get out of sync with the latest version.

Your potential solution

By adding a custom Dockerfile to this project and publishing it to the GHCR, a tool such as dependabot can be used to patch the version and raise a PR whenever a new version has been published.

If this PR is then auto-merged, a new container can be published automatically. Switch the reference image within the code to use the GHCR public image instead.

Any additional information?

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[Feature]: expand options to support latest imds-mock features

Describe your feature

Having switched to using the imds-mock tool. The testcontainers library should be updated to support the following features:

• Pretty Printing of JSON responses
• Instance Tags
• Spot Instance Interruption Notice

Your potential solution

Expand the existing options and pass as required into the underlying image.

Any additional information?

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[Feature]: expose the URLs generated on startup as immutable references for use within tests

Describe your feature

When the IMDS container is currently launched, the URLs for both the metadata and token endpoints are auto-generated but not exposed to any test code. Unfortunately, this makes testing a little cumbersome as the URL needs to be provided within tests.

Your potential solution

Expose two methods on the container that returns a copy of the URLs, ensuring they remain immutable within the container itself. This will ensure all utility methods behave as expected.

Any additional information?

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[Feature]: Remove the need to handle an error when launching the container

Describe your feature

Test code could be simplified further by not having to always handle the error that is returned by the underlying testcontainers-go library.

Your potential solution

Add additional methods MustContainer and MustContainerWith that will panic on any failures when launching the underlying container. This will remove the need to handle any errors within the test code, at the expense of a panic being raised.

Any additional information?

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[Feature]: enable toggling of strict IMDSv2 only

Describe your feature

By default, AEMM supports both IMDSv1 and IMDSv2. However, the best practice by AWS mandates the use of IMDSv2. Provide an option to start up the container with IMDSv2 only support

Your potential solution

IMDSv2 can be enforced through the --imdsv2 flag when starting up the container.

Any additional information?

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[Feature]: Simplify assertions by providing constant lookup values for the AEMM mock

Describe your feature

The AEMM container will always return a set of static values. To make these easier to assert against, these values should be exposed by the library as constants.

Your potential solution

Define a list of paths and their respective values if querying the AEMM mock through any tests.

Any additional information?

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[Feature]: expose URL of container after it has launched for easier testing

Describe your feature

After the AEMM container is launched, any test code calling the container must hardcode the URL. Exposing this through the returned container would simplify testing.

Your potential solution

The returned container should wrap the testcontainers.Container interface, exposing an additional URL function.

type AEMMContainer struct {
    testcontainers.Container
    URL string
}

Any additional information?

No response

Code of Conduct

• I agree to follow this project's Code of Conduct

[Feature]: switch to using imds-mock

Describe your feature

Switch to using the PurpleClay imds-mock rather than the existing Amazon EC2 Metadata Mock (AEMM).

Your potential solution

Switch to using the PurpleClay imds-mock rather than the existing Amazon EC2 Metadata Mock (AEMM).

Any additional information?

No response

Code of Conduct

• I agree to follow this project's Code of Conduct