testcontainers 9.10.1 → 9.12.0-beta.0

package/dist/package.json

@@ -1,7 +1,7 @@
 {
     "name": "testcontainers",
     "author": "Cristian Greco",
-    "version": "9.10.1",
+    "version": "9.12.0-beta.0",
     "main": "dist/src/index",
     "types": "dist/src/index",
     "keywords": [
@@ -47,6 +47,7 @@
         "dockerode": "^3.3.5",
         "get-port": "^5.1.1",
         "node-fetch": "^2.6.12",
+        "proper-lockfile": "^4.1.2",
         "properties-reader": "^2.2.0",
         "ssh-remote-port-forward": "^1.0.4",
         "tar-fs": "^2.1.1",
@@ -61,6 +62,7 @@
         "@types/node": "^18.16.19",
         "@types/node-fetch": "^2.6.4",
         "@types/pg": "^8.10.2",
+        "@types/proper-lockfile": "^4.1.2",
         "@types/properties-reader": "^2.1.1",
         "@types/selenium-webdriver": "^4.1.15",
         "@types/tar-fs": "^2.0.1",

package/dist/src/docker/client/docker-client-types.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="node" />
+import Dockerode, { DockerOptions } from "dockerode";
+import { HostIps } from "../lookup-host-ips";
+import { SystemInfo } from "../../system-info";
+import { ContainerRuntime } from "../types";
+import { DockerComposeClient } from "../../docker-compose/docker-compose-client";
+export type DockerClient = PartialDockerClient & {
+    sessionId: string;
+};
+export type PartialDockerClient = DockerClientStrategyResult & {
+    dockerode: Dockerode;
+    dockerComposeClient: DockerComposeClient;
+    host: string;
+    containerRuntime: ContainerRuntime;
+    hostIps: HostIps;
+    info: SystemInfo;
+};
+export type DockerClientStrategyResult = {
+    uri: string;
+    dockerOptions: DockerOptions;
+    composeEnvironment: NodeJS.ProcessEnv;
+    allowUserOverrides: boolean;
+};

package/dist/src/docker/client/docker-client-types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/src/docker/client/docker-client.d.ts

@@ -1,18 +1,2 @@
-/// <reference types="node" />
-import Dockerode from "dockerode";
-import { HostIps } from "../lookup-host-ips";
-import { SystemInfo } from "../../system-info";
-import { ContainerRuntime } from "../types";
-export type DockerClient = DockerClientStrategyResult & {
-    host: string;
-    containerRuntime: ContainerRuntime;
-    hostIps: HostIps;
-    info: SystemInfo;
-};
-export type DockerClientStrategyResult = {
-    uri: string;
-    dockerode: Dockerode;
-    composeEnvironment: NodeJS.ProcessEnv;
-    allowUserOverrides: boolean;
-};
+import { DockerClient } from "./docker-client-types";
 export declare function getDockerClient(): Promise<DockerClient>;

package/dist/src/docker/client/docker-client.js

@@ -8,8 +8,12 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getDockerClient = void 0;
+const dockerode_1 = __importDefault(require("dockerode"));
 const logger_1 = require("../../logger");
 const lookup_host_ips_1 = require("../lookup-host-ips");
 const system_info_1 = require("../../system-info");
@@ -21,26 +25,32 @@ const configuration_strategy_1 = require("./strategy/configuration-strategy");
 const unix_socket_strategy_1 = require("./strategy/unix-socket-strategy");
 const npipe_socket_strategy_1 = require("./strategy/npipe-socket-strategy");
 const testcontainers_host_strategy_1 = require("./strategy/testcontainers-host-strategy");
+const uuid_1 = require("../../uuid");
+const file_lock_1 = require("../../file-lock");
+const reaper_1 = require("../../reaper");
+const docker_compose_client_1 = require("../../docker-compose/docker-compose-client");
 let dockerClient;
+const strategies = [
+    new testcontainers_host_strategy_1.TestcontainersHostStrategy(),
+    new configuration_strategy_1.ConfigurationStrategy(),
+    new unix_socket_strategy_1.UnixSocketStrategy(),
+    new rootless_unix_socket_strategy_1.RootlessUnixSocketStrategy(),
+    new npipe_socket_strategy_1.NpipeSocketStrategy(),
+];
 function getDockerClient() {
     return __awaiter(this, void 0, void 0, function* () {
         if (dockerClient) {
             return dockerClient;
         }
-        const strategies = [
-            new testcontainers_host_strategy_1.TestcontainersHostStrategy(),
-            new configuration_strategy_1.ConfigurationStrategy(),
-            new unix_socket_strategy_1.UnixSocketStrategy(),
-            new rootless_unix_socket_strategy_1.RootlessUnixSocketStrategy(),
-            new npipe_socket_strategy_1.NpipeSocketStrategy(),
-        ];
         for (const strategy of strategies) {
             try {
-                const dockerClient = yield tryToCreateDockerClient(strategy);
-                if (dockerClient) {
-                    logDockerClient(strategy.getName(), dockerClient);
-                    return dockerClient;
+                const initialisedDockerClient = yield initialiseStrategy(strategy);
+                if (!initialisedDockerClient) {
+                    continue;
                 }
+                dockerClient = initialisedDockerClient;
+                logDockerClient(strategy.getName(), dockerClient);
+                return dockerClient;
             }
             catch (err) {
                 logger_1.log.warn(`Docker client strategy "${strategy.getName()}" threw: "${err}"`);
@@ -50,30 +60,51 @@ function getDockerClient() {
     });
 }
 exports.getDockerClient = getDockerClient;
+function initialiseStrategy(strategy) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const partialDockerClient = yield tryToCreateDockerClient(strategy);
+        if (!partialDockerClient) {
+            return;
+        }
+        yield (0, file_lock_1.withFileLock)("tc.lock", () => __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            const dockerode = new dockerode_1.default(partialDockerClient.dockerOptions);
+            const containers = yield dockerode.listContainers();
+            const reaperContainer = containers.find((container) => container.Labels["org.testcontainers.ryuk"] === "true");
+            const sessionId = (_a = reaperContainer === null || reaperContainer === void 0 ? void 0 : reaperContainer.Labels["org.testcontainers.session-id"]) !== null && _a !== void 0 ? _a : new uuid_1.RandomUuid().nextUuid();
+            const dockerOptions = Object.assign(Object.assign({}, partialDockerClient.dockerOptions), { headers: Object.assign(Object.assign({}, partialDockerClient.dockerOptions.headers), { "x-tc-sid": sessionId }) });
+            dockerClient = Object.assign(Object.assign({}, partialDockerClient), { sessionId,
+                dockerOptions, dockerode: new dockerode_1.default(dockerOptions) });
+            yield (0, reaper_1.startReaper)(dockerClient, sessionId, reaperContainer);
+            yield (0, reaper_1.registerSessionIdForCleanup)(sessionId);
+        }));
+        return dockerClient;
+    });
+}
 function tryToCreateDockerClient(strategy) {
+    var _a;
     return __awaiter(this, void 0, void 0, function* () {
         if (strategy.init) {
             yield strategy.init();
         }
         if (strategy.isApplicable()) {
-            const { uri, dockerode, composeEnvironment, allowUserOverrides } = yield strategy.getDockerClient();
-            logger_1.log.debug(`Testing Docker client strategy "${strategy.getName()}" with URI "${uri}"...`);
+            const dockerClientStrategyResult = yield strategy.getDockerClient();
+            logger_1.log.debug(`Testing Docker client strategy "${strategy.getName()}" with URI "${dockerClientStrategyResult.uri}"...`);
+            const dockerode = new dockerode_1.default(dockerClientStrategyResult.dockerOptions);
             if (yield isDockerDaemonReachable(dockerode)) {
                 const info = yield (0, system_info_1.getSystemInfo)(dockerode);
-                const containerRuntime = uri.includes("podman.sock") ? "podman" : "docker";
-                const host = yield (0, resolve_host_1.resolveHost)(dockerode, containerRuntime, info.dockerInfo.indexServerAddress, uri, allowUserOverrides);
+                const containerRuntime = dockerClientStrategyResult.uri.includes("podman.sock")
+                    ? "podman"
+                    : "docker";
+                const host = yield (0, resolve_host_1.resolveHost)(dockerode, containerRuntime, info.dockerInfo.indexServerAddress, dockerClientStrategyResult.uri, dockerClientStrategyResult.allowUserOverrides);
                 const hostIps = yield (0, lookup_host_ips_1.lookupHostIps)(host);
-                dockerClient = {
-                    uri,
-                    containerRuntime,
+                const dockerComposeClient = yield (0, docker_compose_client_1.getDockerComposeClient)((_a = info.dockerComposeInfo) === null || _a === void 0 ? void 0 : _a.compatability);
+                return Object.assign(Object.assign({}, dockerClientStrategyResult), { containerRuntime,
                     host,
                     hostIps,
-                    dockerode,
                     info,
-                    composeEnvironment,
-                    allowUserOverrides,
-                };
-                return dockerClient;
+                    dockerode,
+                    dockerComposeClient });
             }
             else {
                 logger_1.log.warn(`Docker client strategy "${strategy.getName()}" does not work`);

package/dist/src/docker/client/strategy/configuration-strategy.d.ts

@@ -1,4 +1,4 @@
-import { DockerClientStrategyResult } from "../docker-client";
+import { DockerClientStrategyResult } from "../docker-client-types";
 import { DockerClientStrategy } from "./docker-client-strategy";
 export declare class ConfigurationStrategy implements DockerClientStrategy {
     private dockerHost;

package/dist/src/docker/client/strategy/configuration-strategy.js

@@ -14,8 +14,6 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConfigurationStrategy = void 0;
 const docker_client_config_1 = require("../docker-client-config");
-const dockerode_1 = __importDefault(require("dockerode"));
-const session_id_1 = require("../../session-id");
 const url_1 = require("url");
 const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
@@ -32,7 +30,7 @@ class ConfigurationStrategy {
     }
     getDockerClient() {
         return __awaiter(this, void 0, void 0, function* () {
-            const dockerOptions = { headers: { "x-tc-sid": session_id_1.sessionId } };
+            const dockerOptions = {};
             const { pathname, hostname, port } = new url_1.URL(this.dockerHost);
             if (hostname !== "") {
                 dockerOptions.host = hostname;
@@ -48,7 +46,7 @@ class ConfigurationStrategy {
             }
             return {
                 uri: this.dockerHost,
-                dockerode: new dockerode_1.default(dockerOptions),
+                dockerOptions,
                 composeEnvironment: {
                     DOCKER_HOST: this.dockerHost,
                     DOCKER_TLS_VERIFY: this.dockerTlsVerify,

package/dist/src/docker/client/strategy/docker-client-strategy.d.ts

@@ -1,4 +1,4 @@
-import { DockerClientStrategyResult } from "../docker-client";
+import { DockerClientStrategyResult } from "../docker-client-types";
 export interface DockerClientStrategy {
     init?(): Promise<void>;
     isApplicable(): boolean;

package/dist/src/docker/client/strategy/npipe-socket-strategy.d.ts

@@ -1,4 +1,4 @@
-import { DockerClientStrategyResult } from "../docker-client";
+import { DockerClientStrategyResult } from "../docker-client-types";
 import { DockerClientStrategy } from "./docker-client-strategy";
 export declare class NpipeSocketStrategy implements DockerClientStrategy {
     getDockerClient(): Promise<DockerClientStrategyResult>;

package/dist/src/docker/client/strategy/npipe-socket-strategy.js

@@ -8,18 +8,14 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.NpipeSocketStrategy = void 0;
-const dockerode_1 = __importDefault(require("dockerode"));
 class NpipeSocketStrategy {
     getDockerClient() {
         return __awaiter(this, void 0, void 0, function* () {
             return {
                 uri: "npipe:////./pipe/docker_engine",
-                dockerode: new dockerode_1.default({ socketPath: "//./pipe/docker_engine" }),
+                dockerOptions: { socketPath: "//./pipe/docker_engine" },
                 composeEnvironment: {},
                 allowUserOverrides: true,
             };

package/dist/src/docker/client/strategy/rootless-unix-socket-strategy.d.ts

@@ -1,5 +1,5 @@
 /// <reference types="node" />
-import { DockerClientStrategyResult } from "../docker-client";
+import { DockerClientStrategyResult } from "../docker-client-types";
 import { DockerClientStrategy } from "./docker-client-strategy";
 export declare class RootlessUnixSocketStrategy implements DockerClientStrategy {
     private readonly platform;

package/dist/src/docker/client/strategy/rootless-unix-socket-strategy.js

@@ -17,7 +17,6 @@ const type_guards_1 = require("../../../type-guards");
 const fs_1 = require("fs");
 const path_1 = __importDefault(require("path"));
 const os_1 = __importDefault(require("os"));
-const dockerode_1 = __importDefault(require("dockerode"));
 class RootlessUnixSocketStrategy {
     constructor(platform = process.platform, env = process.env) {
         this.platform = platform;
@@ -62,7 +61,7 @@ class RootlessUnixSocketStrategy {
         return __awaiter(this, void 0, void 0, function* () {
             return {
                 uri: `unix://${this.socketPath}`,
-                dockerode: new dockerode_1.default({ socketPath: this.socketPath }),
+                dockerOptions: { socketPath: this.socketPath },
                 composeEnvironment: {},
                 allowUserOverrides: true,
             };

package/dist/src/docker/client/strategy/testcontainers-host-strategy.d.ts

@@ -1,4 +1,4 @@
-import { DockerClientStrategyResult } from "../docker-client";
+import { DockerClientStrategyResult } from "../docker-client-types";
 import { DockerClientStrategy } from "./docker-client-strategy";
 export declare class TestcontainersHostStrategy implements DockerClientStrategy {
     private host;

package/dist/src/docker/client/strategy/testcontainers-host-strategy.js

@@ -8,14 +8,9 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.TestcontainersHostStrategy = void 0;
 const docker_client_config_1 = require("../docker-client-config");
-const dockerode_1 = __importDefault(require("dockerode"));
-const session_id_1 = require("../../session-id");
 const url_1 = require("url");
 class TestcontainersHostStrategy {
     init() {
@@ -28,13 +23,13 @@ class TestcontainersHostStrategy {
     }
     getDockerClient() {
         return __awaiter(this, void 0, void 0, function* () {
-            const dockerOptions = { headers: { "x-tc-sid": session_id_1.sessionId } };
+            const dockerOptions = {};
             const { hostname, port } = new url_1.URL(this.host);
             dockerOptions.host = hostname;
             dockerOptions.port = port;
             return {
                 uri: this.host,
-                dockerode: new dockerode_1.default(dockerOptions),
+                dockerOptions,
                 composeEnvironment: {
                     DOCKER_HOST: this.host,
                 },

package/dist/src/docker/client/strategy/unix-socket-strategy.d.ts

@@ -1,4 +1,4 @@
-import { DockerClientStrategyResult } from "../docker-client";
+import { DockerClientStrategyResult } from "../docker-client-types";
 import { DockerClientStrategy } from "./docker-client-strategy";
 export declare class UnixSocketStrategy implements DockerClientStrategy {
     getDockerClient(): Promise<DockerClientStrategyResult>;

package/dist/src/docker/client/strategy/unix-socket-strategy.js

@@ -8,19 +8,15 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.UnixSocketStrategy = void 0;
-const dockerode_1 = __importDefault(require("dockerode"));
 const fs_1 = require("fs");
 class UnixSocketStrategy {
     getDockerClient() {
         return __awaiter(this, void 0, void 0, function* () {
             return {
                 uri: "unix:///var/run/docker.sock",
-                dockerode: new dockerode_1.default({ socketPath: "/var/run/docker.sock" }),
+                dockerOptions: { socketPath: "/var/run/docker.sock" },
                 composeEnvironment: {},
                 allowUserOverrides: true,
             };

package/dist/src/docker/functions/container/create-container.d.ts

@@ -28,4 +28,4 @@ export type CreateContainerOptions = {
     resourcesQuota?: ResourcesQuota;
     sharedMemorySize?: number;
 };
-export declare const createContainer: (options: CreateContainerOptions) => Promise<Dockerode.Container>;
+export declare const createContainer: (sessionId: string, options: CreateContainerOptions) => Promise<Dockerode.Container>;

package/dist/src/docker/functions/container/create-container.js

@@ -14,7 +14,7 @@ const logger_1 = require("../../../logger");
 const docker_client_1 = require("../../client/docker-client");
 const port_1 = require("../../../port");
 const create_labels_1 = require("../create-labels");
-const createContainer = (options) => __awaiter(void 0, void 0, void 0, function* () {
+const createContainer = (sessionId, options) => __awaiter(void 0, void 0, void 0, function* () {
     var _a, _b;
     try {
         logger_1.log.info(`Creating container for image "${options.imageName}"...`);
@@ -27,7 +27,7 @@ const createContainer = (options) => __awaiter(void 0, void 0, void 0, function*
             ExposedPorts: getExposedPorts(options.exposedPorts),
             Cmd: options.command,
             Entrypoint: options.entrypoint,
-            Labels: (0, create_labels_1.createLabels)(options.reusable, options.imageName, options.labels),
+            Labels: (0, create_labels_1.createLabels)(sessionId, options.reusable, options.labels),
             Healthcheck: getHealthCheck(options.healthCheck),
             WorkingDir: options.workingDir,
             HostConfig: {

package/dist/src/docker/functions/create-labels.d.ts

@@ -1,3 +1,2 @@
-import { DockerImageName } from "../../docker-image-name";
 import { Labels } from "../types";
-export declare const createLabels: (reusable: boolean, dockerImageName?: DockerImageName, extraLabels?: Labels) => Labels;
+export declare const createLabels: (sessionId: string, reusable: boolean, extraLabels?: Labels) => Labels;

package/dist/src/docker/functions/create-labels.js

@@ -1,13 +1,12 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createLabels = void 0;
-const session_id_1 = require("../session-id");
 const labels_1 = require("../../labels");
 const package_json_1 = require("../../../package.json");
-const createLabels = (reusable, dockerImageName, extraLabels = {}) => {
+const createLabels = (sessionId, reusable, extraLabels = {}) => {
     const labels = Object.assign(Object.assign({}, extraLabels), { [labels_1.LABEL_TESTCONTAINERS]: "true", [labels_1.LABEL_TESTCONTAINERS_LANG]: "node", [labels_1.LABEL_TESTCONTAINERS_VERSION]: package_json_1.version });
     if (!reusable) {
-        labels[labels_1.LABEL_TESTCONTAINERS_SESSION_ID] = session_id_1.sessionId;
+        labels[labels_1.LABEL_TESTCONTAINERS_SESSION_ID] = sessionId;
     }
     return labels;
 };

package/dist/src/docker/functions/image/build-image.d.ts

@@ -9,5 +9,6 @@ export type BuildImageOptions = {
     pullPolicy: PullPolicy;
     registryConfig: RegistryConfig;
     cache: boolean;
+    deleteOnExit: boolean;
 };
-export declare const buildImage: (options: BuildImageOptions) => Promise<void>;
+export declare const buildImage: (sessionId: string, options: BuildImageOptions) => Promise<void>;

package/dist/src/docker/functions/image/build-image.js

@@ -21,7 +21,7 @@ const create_labels_1 = require("../create-labels");
 const path_1 = __importDefault(require("path"));
 const fs_1 = require("fs");
 const dockerignore_1 = __importDefault(require("@balena/dockerignore"));
-const buildImage = (options) => __awaiter(void 0, void 0, void 0, function* () {
+const buildImage = (sessionId, options) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         logger_1.log.info(`Building image "${options.imageName.toString()}" with context "${options.context}"...`);
         const isDockerIgnored = yield createIsDockerIgnoredFunction(options.context);
@@ -42,7 +42,7 @@ const buildImage = (options) => __awaiter(void 0, void 0, void 0, function* () {
             nocache: !options.cache,
             buildargs: options.buildArgs,
             t: options.imageName.toString(),
-            labels: (0, create_labels_1.createLabels)(false, options.imageName),
+            labels: (0, create_labels_1.createLabels)(sessionId, !options.deleteOnExit),
             registryconfig: options.registryConfig,
             pull: options.pullPolicy.shouldPull() ? "true" : undefined,
         };

package/dist/src/docker/functions/network/create-network.d.ts

@@ -13,4 +13,4 @@ export type CreateNetworkOptions = {
         [key: string]: string;
     };
 };
-export declare const createNetwork: (options: CreateNetworkOptions) => Promise<string>;
+export declare const createNetwork: (sessionId: string, options: CreateNetworkOptions) => Promise<string>;

package/dist/src/docker/functions/network/create-network.js

@@ -13,7 +13,7 @@ exports.createNetwork = void 0;
 const logger_1 = require("../../../logger");
 const docker_client_1 = require("../../client/docker-client");
 const create_labels_1 = require("../create-labels");
-const createNetwork = (options) => __awaiter(void 0, void 0, void 0, function* () {
+const createNetwork = (sessionId, options) => __awaiter(void 0, void 0, void 0, function* () {
     try {
         logger_1.log.info(`Creating network "${options.name}"...`);
         const { dockerode } = yield (0, docker_client_1.getDockerClient)();
@@ -26,7 +26,7 @@ const createNetwork = (options) => __awaiter(void 0, void 0, void 0, function* (
             Ingress: options.ingress,
             EnableIPv6: options.enableIPv6,
             Options: options.options,
-            Labels: Object.assign(Object.assign({}, options.labels), (0, create_labels_1.createLabels)(false)),
+            Labels: Object.assign(Object.assign({}, options.labels), (0, create_labels_1.createLabels)(sessionId, false)),
         });
         logger_1.log.info(`Created network "${options.name}"`);
         return network.id;

package/dist/src/docker/remote-docker-unix-socket-path.d.ts

@@ -3,5 +3,5 @@
 /// <reference types="node" />
 /// <reference types="node" />
 /// <reference types="node" />
-import { DockerClient } from "./client/docker-client";
-export declare const getRemoteDockerUnixSocketPath: (dockerClient: DockerClient, platform?: NodeJS.Platform, env?: NodeJS.ProcessEnv) => string;
+import { PartialDockerClient } from "./client/docker-client-types";
+export declare const getRemoteDockerUnixSocketPath: (dockerClient: PartialDockerClient, platform?: NodeJS.Platform, env?: NodeJS.ProcessEnv) => string;

package/dist/src/docker/types.d.ts

@@ -14,11 +14,14 @@ export type BindMount = {
 export type FileToCopy = {
     source: string;
     target: string;
+    mode?: number;
 };
+export type DirectoryToCopy = FileToCopy;
 export type Content = string | Buffer | Readable;
 export type ContentToCopy = {
     content: Content;
     target: string;
+    mode?: number;
 };
 export type TmpFs = {
     [dir in string]: string;

package/dist/src/docker-compose/docker-compose-client.d.ts

@@ -0,0 +1,9 @@
+import { DockerComposeDownOptions, DockerComposeOptions } from "./docker-compose-options";
+import { DockerComposeCompatibility } from "../system-info";
+export interface DockerComposeClient {
+    up: (options: DockerComposeOptions, services?: Array<string>) => Promise<void>;
+    pull: (options: DockerComposeOptions, services?: Array<string>) => Promise<void>;
+    stop: (options: DockerComposeOptions) => Promise<void>;
+    down: (options: DockerComposeOptions, downOptions: DockerComposeDownOptions) => Promise<void>;
+}
+export declare function getDockerComposeClient(compat?: DockerComposeCompatibility): DockerComposeClient;