LocalstackContainer API enhancement

packages/modules/localstack/src/localstack-container.test.ts

@@ -69,4 +69,18 @@ describe("LocalStackContainer", () => {
     await container.stop();
     await awsCliInDockerNetwork.stop();
   });
+
+  it("should use access environment variables and default creds", async () => {
+    const container = await new LocalstackContainer()
+      .withEnvironment({
+        DEFAULT_REGION: "eu-west-3",
+      })
+      .start();
+
+    expect(container.getRegion()).toBe("eu-west-3");
+    expect(container.getAccessKey()).toBe("test");
+    expect(container.getSecretKey()).toBe("test");
+
+    await container.stop();
+  });
 });

packages/modules/localstack/src/localstack-container.ts

@@ -2,6 +2,10 @@ import { AbstractStartedContainer, GenericContainer, log, StartedTestContainer,
 
 export const LOCALSTACK_PORT = 4566;
 
+const DEFAULT_REGION = "us-east-1";
+const DEFAULT_AWS_ACCESS_KEY_ID = "test";
+const DEFAULT_AWS_SECRET_ACCESS_KEY = "test";
+
 export class LocalstackContainer extends GenericContainer {
   constructor(image = "localstack/localstack:2.2.0") {
     super(image);
@@ -50,4 +54,30 @@ export class StartedLocalStackContainer extends AbstractStartedContainer {
   public getConnectionUri(): string {
     return `http://${this.getHost()}:${this.getPort().toString()}`;
   }
+
+  /**
+   * Provides a default region that is preconfigured to communicate with a given simulated service.
+   * @returns A default region
+   */
+  public getRegion(): string {
+    return this.startedTestContainer.getEnvironment()["DEFAULT_REGION"] || DEFAULT_REGION;
+  }
+
+  /**
+   * Provides a default access key that is preconfigured to communicate with a given simulated service.
+   * <a href="https://github.com/localstack/localstack/blob/master/doc/interaction/README.md?plain=1#L32">AWS Access Key</a>
+   * @returns A default access key
+   */
+  public getAccessKey(): string {
+    return this.startedTestContainer.getEnvironment()["AWS_ACCESS_KEY_ID"] || DEFAULT_AWS_ACCESS_KEY_ID;
+  }
+
+  /**
+   * Provides a default secret key that is preconfigured to communicate with a given simulated service.
+   * <a href="https://github.com/localstack/localstack/blob/master/doc/interaction/README.md?plain=1#L32">AWS Secret Key</a>
+   * @returns A default secret key
+   */
+  public getSecretKey(): string {
+    return this.startedTestContainer.getEnvironment()["AWS_SECRET_ACCESS_KEY"] || DEFAULT_AWS_SECRET_ACCESS_KEY;
+  }
 }

packages/testcontainers/src/generic-container/abstract-started-container.ts

@@ -47,6 +47,10 @@ export class AbstractStartedContainer implements StartedTestContainer {
     return this.startedTestContainer.getLabels();
   }
 
+  public getEnvironment(): Record<string, string> {
+    return this.startedTestContainer.getEnvironment();
+  }
+
   public getId(): string {
     return this.startedTestContainer.getId();
   }

packages/testcontainers/src/generic-container/started-generic-container.ts

@@ -109,6 +109,15 @@ export class StartedGenericContainer implements StartedTestContainer {
     return this.inspectResult.Config.Labels;
   }
 
+  public getEnvironment(): Record<string, string> {
+    const environment: Record<string, string> = {};
+    this.inspectResult.Config.Env.forEach((env) => {
+      const kv: string[] = env.split("=");
+      environment[kv[0]] = kv[1];
+    });
+    return environment;
+  }
+
   public getNetworkNames(): string[] {
     return Object.keys(this.getNetworkSettings());
   }

packages/testcontainers/src/test-container.ts

@@ -66,6 +66,7 @@ export interface StartedTestContainer {
   getMappedPort(port: number): number;
   getName(): string;
   getLabels(): Labels;
+  getEnvironment(): Record<string, string>;
   getId(): string;
   getNetworkNames(): string[];
   getNetworkId(networkName: string): string;