Add withLogConsumer + general logging improvements (#559)

Author: cristianrgreco

docs/configuration.md

@@ -9,6 +9,9 @@ All possible environment variable configurations for Testcontainers are found he
 | DEBUG    | testcontainers*           | Enable all logs            |
 | DEBUG    | testcontainers            | Enable testcontainers logs |
 | DEBUG    | testcontainers:containers | Enable container logs      |
+| DEBUG    | testcontainers:compose    | Enable compose logs        |
+| DEBUG    | testcontainers:build      | Enable build logs          |
+| DEBUG    | testcontainers:pull       | Enable pull logs           |
 | DEBUG    | testcontainers:exec       | Enable container exec logs |
 
 Note that you can enable multiple loggers, e.g: `DEBUG=testcontainers,testcontainers:exec`.

docs/features/containers.md

@@ -410,6 +410,8 @@ const { output, exitCode } = await container.exec(["echo", "hello", "world"]);
 
 ## Streaming logs
 
+Logs can be consumed either from a started container:
+
 ```javascript
 const container = await new GenericContainer("alpine").start();
 
@@ -418,3 +420,15 @@ const container = await new GenericContainer("alpine").start();
   .on("err", line => console.error(line))
   .on("end", () => console.log("Stream closed"));
 ```
+
+Or a consumer can be provided before start. This is useful for example if your container is failing to start:
+
+```javascript
+const container = await new GenericContainer("alpine")
+  .withLogConsumer(stream => {
+    stream.on("data", line => console.log(line));
+    stream.on("err", line => console.error(line));
+    stream.on("end", () => console.log("Stream closed"));
+  })
+  .start();
+```

src/docker-compose-environment/docker-compose-environment.ts

@@ -82,7 +82,7 @@ export class DockerComposeEnvironment {
   }
 
   public async up(services?: Array<string>): Promise<StartedDockerComposeEnvironment> {
-    log.info(`Starting DockerCompose environment: ${this.projectName}`);
+    log.info(`Starting DockerCompose environment "${this.projectName}"...`);
 
     (await ReaperInstance.getInstance()).addProject(this.projectName);
 
@@ -123,7 +123,7 @@ export class DockerComposeEnvironment {
       []
     );
 
-    log.info(`Started the following containers: ${startedContainerNames.join(", ")}`);
+    log.info(`Started containers "${startedContainerNames.join('", "')}"`);
 
     const startedGenericContainers = (
       await Promise.all(
@@ -148,11 +148,8 @@ export class DockerComposeEnvironment {
           }
 
           try {
-            log.info(`Waiting for container ${containerName} to be ready`);
             await waitForContainer(container, waitStrategy, boundPorts);
-            log.info(`Container ${containerName} is ready`);
           } catch (err) {
-            log.error(`Container ${containerName} failed to be ready: ${err}`);
             try {
               await dockerComposeDown(options, { removeVolumes: true, timeout: 0 });
             } catch {
@@ -169,7 +166,7 @@ export class DockerComposeEnvironment {
       return { ...map, [containerName]: startedGenericContainer };
     }, {});
 
-    log.info(`DockerCompose environment started: ${Object.keys(startedGenericContainers).join(", ")}`);
+    log.info(`DockerCompose environment started`);
 
     return new StartedDockerComposeEnvironment(startedGenericContainers, {
       ...options,

src/docker-compose/default-docker-compose-options.ts

@@ -1,7 +1,7 @@
 import { IDockerComposeOptions } from "docker-compose";
 import { DockerComposeOptions } from "./docker-compose-options";
 import { dockerClient } from "../docker/docker-client";
-import { log } from "../logger";
+import { composeLog } from "../logger";
 import { EOL } from "os";
 import { isNotEmptyString } from "../type-guards";
 
@@ -10,6 +10,7 @@ export const defaultDockerComposeOptions = async ({
   ...options
 }: DockerComposeOptions): Promise<Partial<IDockerComposeOptions>> => {
   const { composeEnvironment } = await dockerClient();
+  const log = options.logger ?? composeLog;
 
   return {
     log: false,

src/docker-compose/docker-compose-options.ts

@@ -1,4 +1,5 @@
 import { Environment } from "../docker/types";
+import { Logger } from "../logger";
 
 export type DockerComposeOptions = {
   filePath: string;
@@ -7,4 +8,5 @@ export type DockerComposeOptions = {
   commandOptions?: string[];
   composeOptions?: string[];
   environment?: Environment;
+  logger?: Logger;
 };

src/docker-compose/functions/docker-compose-down.ts

@@ -8,7 +8,7 @@ export const dockerComposeDown = async (
   options: DockerComposeOptions,
   downOptions: DockerComposeDownOptions
 ): Promise<void> => {
-  log.info(`Downing DockerCompose environment`);
+  log.info(`Downing DockerCompose environment...`);
 
   try {
     await down({ ...(await defaultDockerComposeOptions(options)), commandOptions: commandOptions(downOptions) });

src/docker-compose/functions/docker-compose-pull.ts

@@ -1,16 +1,16 @@
-import { log } from "../../logger";
+import { pullLog, log } from "../../logger";
 import { pullAll, pullMany } from "docker-compose";
 import { defaultDockerComposeOptions } from "../default-docker-compose-options";
 import { DockerComposeOptions } from "../docker-compose-options";
 
 export const dockerComposePull = async (options: DockerComposeOptions, services?: Array<string>): Promise<void> => {
   try {
     if (services) {
-      log.info(`Pulling DockerCompose environment images for ${services.join(", ")}`);
-      await pullMany(services, await defaultDockerComposeOptions(options));
+      log.info(`Pulling DockerCompose environment images "${services.join('", "')}"...`);
+      await pullMany(services, await defaultDockerComposeOptions({ ...options, logger: pullLog }));
     } else {
-      log.info(`Pulling DockerCompose environment images`);
-      await pullAll(await defaultDockerComposeOptions(options));
+      log.info(`Pulling DockerCompose environment images...`);
+      await pullAll(await defaultDockerComposeOptions({ ...options, logger: pullLog }));
     }
     log.info(`Pulled DockerCompose environment`);
     // eslint-disable-next-line @typescript-eslint/no-explicit-any

src/docker-compose/functions/docker-compose-stop.ts

@@ -4,7 +4,7 @@ import { defaultDockerComposeOptions } from "../default-docker-compose-options";
 import { DockerComposeOptions } from "../docker-compose-options";
 
 export const dockerComposeStop = async (options: DockerComposeOptions): Promise<void> => {
-  log.info(`Stopping DockerCompose environment`);
+  log.info(`Stopping DockerCompose environment...`);
 
   try {
     await stop(await defaultDockerComposeOptions(options));

src/docker-compose/functions/docker-compose-up.ts

@@ -5,7 +5,7 @@ import { DockerComposeOptions } from "../docker-compose-options";
 import { dockerComposeDown } from "./docker-compose-down";
 
 export const dockerComposeUp = async (options: DockerComposeOptions, services?: Array<string>): Promise<void> => {
-  log.info(`Upping DockerCompose environment`);
+  log.info(`Upping DockerCompose environment...`);
 
   try {
     if (services) {

src/docker/docker-client-config.ts

@@ -12,53 +12,65 @@ export type DockerClientConfig = {
 };
 
 export const getDockerClientConfig = async (env: NodeJS.ProcessEnv = process.env): Promise<DockerClientConfig> => {
-  let dockerHost: string | undefined;
-  let dockerTlsVerify: string | undefined;
-  let dockerCertPath: string | undefined;
+  const dockerClientConfig: DockerClientConfig = {
+    ...(await loadFromFile()),
+    ...loadFromEnv(env),
+  };
+  logDockerClientConfig(dockerClientConfig);
+  return dockerClientConfig;
+};
 
+async function loadFromFile() {
   const file = path.resolve(homedir(), ".testcontainers.properties");
+
+  const dockerClientConfig: DockerClientConfig = {};
+
   if (existsSync(file)) {
-    log.debug("Found .testcontainers.properties file");
+    log.debug(`Found ".testcontainers.properties" file`);
     const string = await readFile(file, { encoding: "utf-8" });
     const properties = propertiesReader("").read(string);
 
     const host = properties.get("docker.host") as string;
     if (host !== null) {
-      dockerHost = host;
+      dockerClientConfig.dockerHost = host;
     }
 
     const tlsVerify = properties.get("docker.tls.verify") as number;
     if (tlsVerify !== null) {
-      dockerTlsVerify = `${tlsVerify}`;
+      dockerClientConfig.dockerTlsVerify = `${tlsVerify}`;
     }
 
     const certPath = properties.get("docker.cert.path") as string;
     if (certPath !== null) {
-      dockerCertPath = certPath;
+      dockerClientConfig.dockerCertPath = certPath;
     }
   }
 
+  return dockerClientConfig;
+}
+
+function loadFromEnv(env: NodeJS.ProcessEnv) {
+  const dockerClientConfig: DockerClientConfig = {};
+
   if (env["DOCKER_HOST"] !== undefined) {
-    dockerHost = env["DOCKER_HOST"];
+    dockerClientConfig.dockerHost = env["DOCKER_HOST"];
   }
   if (env["DOCKER_TLS_VERIFY"] !== undefined) {
-    dockerTlsVerify = env["DOCKER_TLS_VERIFY"];
+    dockerClientConfig.dockerTlsVerify = env["DOCKER_TLS_VERIFY"];
   }
   if (env["DOCKER_CERT_PATH"] !== undefined) {
-    dockerCertPath = env["DOCKER_CERT_PATH"];
+    dockerClientConfig.dockerCertPath = env["DOCKER_CERT_PATH"];
   }
 
-  let logStr = "Loaded properties: ";
-  if (dockerHost !== undefined) {
-    logStr += `dockerHost=${dockerHost}, `;
-  }
-  if (dockerTlsVerify !== undefined) {
-    logStr += `dockerTlsVerify=${dockerTlsVerify}, `;
-  }
-  if (dockerCertPath !== undefined) {
-    logStr += `dockerCertPath=${dockerCertPath}`;
-  }
-  log.debug(logStr);
+  return dockerClientConfig;
+}
 
-  return { dockerHost, dockerTlsVerify, dockerCertPath };
-};
+function logDockerClientConfig(config: DockerClientConfig) {
+  const configurations = Object.entries(config)
+    .filter(([, value]) => value !== undefined)
+    .map(([key, value]) => `${key}: "${value}"`);
+
+  if (configurations.length > 0) {
+    log.debug(`Loaded Docker client configuration, ${configurations.join(", ")}`);
+  }
+}