testcontainers 8.1.2 → 8.2.0

package/README.md

@@ -18,14 +18,14 @@ npm i -D testcontainers
 
 The following environment variables are supported:
 
-- `DEBUG=testcontainers` See testcontainers logs
-- `DEBUG=testcontainers:containers` See container logs
-- `DEBUG=testcontainers*` See all logs
+- `DEBUG=testcontainers` Enable testcontainers logs
+- `DEBUG=testcontainers:containers` Enable container logs
+- `DEBUG=testcontainers*` Enable all logs
 - `DOCKER_HOST=tcp://docker:2375` Sets the URL of the docker daemon
-- `DOCKER_TLS_VERIFY=1` When set to anything other than an empty string, enables TLS communication with the docker
+- `DOCKER_TLS_VERIFY=1` When set to `1`, enables TLS communication with the docker
   daemon
-- `DOCKER_CERT_PATH=/some/path` Configures the path to the ca.pem, cert.pem, and key.pem files used for TLS
-  verification. Defaults to ~/.docker
+- `DOCKER_CERT_PATH=/some/path` Configures the path to the `ca.pem`, `cert.pem`, and `key.pem` files used for TLS
+  verification. Defaults to `~/.docker`
 - `TESTCONTAINERS_HOST_OVERRIDE=docker.svc.local` Docker's host on which ports are exposed
 - `TESTCONTAINERS_DOCKER_SOCKET_OVERRIDE=/var/run/docker.sock` Path to Docker's socket. Used by [ryuk](#ryuk) and
   other [auxiliary containers](#auxiliary-containers) that need to perform Docker actions
@@ -547,6 +547,16 @@ const environment = await new DockerComposeEnvironment(composeFilePath, composeF
   .up();
 ```
 
+Specify the [environment file](https://docs.docker.com/compose/environment-variables/#using-the---env-file--option):
+
+```javascript
+const { DockerComposeEnvironment } = require("testcontainers");
+
+const environment = await new DockerComposeEnvironment(composeFilePath, composeFile)
+    .withEnvFile(".env.custom")
+    .up();
+```
+
 Specify [profiles](https://docs.docker.com/compose/profiles/):
 
 ```javascript

package/dist/docker-compose-environment/docker-compose-environment.d.ts

@@ -8,6 +8,7 @@ export declare class DockerComposeEnvironment {
     private projectName;
     private build;
     private recreate;
+    private envFile;
     private profiles;
     private env;
     private waitStrategy;
@@ -15,6 +16,7 @@ export declare class DockerComposeEnvironment {
     constructor(composeFilePath: string, composeFiles: string | string[], uuid?: Uuid);
     withBuild(): this;
     withEnv(key: EnvKey, value: EnvValue): this;
+    withEnvFile(envFile: string): this;
     withProfiles(...profiles: string[]): this;
     withNoRecreate(): this;
     withWaitStrategy(containerName: string, waitStrategy: WaitStrategy): this;

package/dist/docker-compose-environment/docker-compose-environment.js

@@ -30,6 +30,7 @@ class DockerComposeEnvironment {
     constructor(composeFilePath, composeFiles, uuid = new uuid_1.RandomUuid()) {
         this.build = false;
         this.recreate = true;
+        this.envFile = "";
         this.profiles = [];
         this.env = {};
         this.waitStrategy = {};
@@ -46,6 +47,10 @@ class DockerComposeEnvironment {
         this.env[key] = value;
         return this;
     }
+    withEnvFile(envFile) {
+        this.envFile = envFile;
+        return this;
+    }
     withProfiles(...profiles) {
         this.profiles = profiles;
         return this;
@@ -80,6 +85,9 @@ class DockerComposeEnvironment {
                 commandOptions.push("--no-recreate");
             }
             const composeOptions = [];
+            if (this.envFile) {
+                composeOptions.push("--env-file", this.envFile);
+            }
             this.profiles.forEach((profile) => composeOptions.push("--profile", profile));
             yield docker_compose_up_1.dockerComposeUp(Object.assign(Object.assign({}, options), { commandOptions, composeOptions, env: this.env }), services);
             const startedContainers = (yield list_containers_1.listContainers()).filter((container) => container.Labels["com.docker.compose.project"] === this.projectName);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "testcontainers",
   "author": "Cristian Greco",
-  "version": "8.1.2",
+  "version": "8.2.0",
   "main": "dist/index",
   "types": "dist/index",
   "keywords": [