testcontainers 9.2.1 → 9.3.0

package/dist/package.json

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

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

@@ -1,7 +1,7 @@
 import { DockerImageName } from "../../../docker-image-name";
 import Dockerode from "dockerode";
 import { PortWithOptionalBinding } from "../../../port";
-import { BindMount, Environment, ExtraHost, HealthCheck, Labels, TmpFs, Ulimits } from "../../types";
+import { BindMount, Environment, ExtraHost, HealthCheck, Labels, ResourcesQuota, TmpFs, Ulimits } from "../../types";
 export type CreateContainerOptions = {
     imageName: DockerImageName;
     environment: Environment;
@@ -25,5 +25,6 @@ export type CreateContainerOptions = {
     droppedCapabilities?: string[];
     user?: string;
     workingDir?: string;
+    resourcesQuota?: ResourcesQuota;
 };
 export declare const createContainer: (options: CreateContainerOptions) => Promise<Dockerode.Container>;

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

@@ -15,6 +15,7 @@ const docker_client_1 = require("../../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* () {
+    var _a, _b;
     try {
         logger_1.log.info(`Creating container for image: ${options.imageName}`);
         const { dockerode } = yield (0, docker_client_1.dockerClient)();
@@ -42,6 +43,8 @@ const createContainer = (options) => __awaiter(void 0, void 0, void 0, function*
                 Ulimits: getUlimits(options.ulimits),
                 CapAdd: options.addedCapabilities,
                 CapDrop: options.droppedCapabilities,
+                Memory: (_a = options.resourcesQuota) === null || _a === void 0 ? void 0 : _a.memory,
+                NanoCpus: (_b = options.resourcesQuota) === null || _b === void 0 ? void 0 : _b.cpu,
             },
         });
     }

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

@@ -28,6 +28,10 @@ export type Ulimits = {
         soft: number | undefined;
     };
 };
+export type ResourcesQuota = {
+    memory?: number;
+    cpu?: number;
+};
 export type HealthCheck = {
     test: ["CMD-SHELL", string] | ["CMD", ...string[]];
     interval?: number;

package/dist/src/generic-container/generic-container.d.ts

@@ -4,7 +4,7 @@ import { PortWithOptionalBinding } from "../port";
 import { PullPolicy } from "../pull-policy";
 import { StartedTestContainer, TestContainer } from "../test-container";
 import { WaitStrategy } from "../wait-strategy";
-import { BindMount, ContentToCopy, Environment, ExtraHost, FileToCopy, HealthCheck, Labels, TmpFs, Ulimits } from "../docker/types";
+import { BindMount, ContentToCopy, Environment, ExtraHost, FileToCopy, HealthCheck, Labels, TmpFs, Ulimits, ResourcesQuota } from "../docker/types";
 import { InspectResult } from "../docker/functions/container/inspect-container";
 import { GenericContainerBuilder } from "./generic-container-builder";
 import { StartedNetwork } from "../network";
@@ -36,6 +36,7 @@ export declare class GenericContainer implements TestContainer {
     protected pullPolicy: PullPolicy;
     protected reuse: boolean;
     protected tarToCopy?: archiver.Archiver;
+    protected resourcesQuota?: ResourcesQuota;
     private extraHosts;
     constructor(image: string);
     protected preStart?(): Promise<void>;
@@ -72,4 +73,5 @@ export declare class GenericContainer implements TestContainer {
     withCopyContentToContainer(contentsToCopy: ContentToCopy[]): this;
     protected getTarToCopy(): archiver.Archiver;
     withWorkingDir(workingDir: string): this;
+    withResourcesQuota({ memory, cpu }: ResourcesQuota): this;
 }

package/dist/src/generic-container/generic-container.js

@@ -98,6 +98,7 @@ class GenericContainer {
                 droppedCapabilities: this.droppedCapabilities,
                 user: this.user,
                 workingDir: this.workingDir,
+                resourcesQuota: this.resourcesQuota,
             };
             if (this.reuse) {
                 const containerHash = (0, hash_1.hash)(JSON.stringify(createContainerOptions));
@@ -299,5 +300,13 @@ class GenericContainer {
         this.workingDir = workingDir;
         return this;
     }
+    withResourcesQuota({ memory, cpu }) {
+        // Memory and CPU units from here: https://docs.docker.com/engine/api/v1.42/#tag/Container/operation/ContainerCreate
+        // see Memory, NanoCpus parameters
+        const ram = memory !== undefined ? memory * Math.pow(1024, 3) : undefined;
+        const cpuQuota = cpu !== undefined ? cpu * Math.pow(10, 9) : undefined;
+        this.resourcesQuota = { memory: ram, cpu: cpuQuota };
+        return this;
+    }
 }
 exports.GenericContainer = GenericContainer;

package/dist/src/index.d.ts

@@ -10,6 +10,7 @@ export { Network, StartedNetwork, StoppedNetwork } from "./network";
 export { Wait } from "./wait";
 export { StartupCheckStrategy, StartupStatus } from "./startup-check-strategy";
 export { PullPolicy, DefaultPullPolicy, AlwaysPullPolicy } from "./pull-policy";
+export { AbstractStartedContainer } from "./modules/abstract-started-container";
 export { PostgreSqlContainer, StartedPostgreSqlContainer } from "./modules/postgresql/postgresql-container";
 export { KafkaContainer, StartedKafkaContainer } from "./modules/kafka/kafka-container";
 export { Neo4jContainer, StartedNeo4jContainer } from "./modules/neo4j/neo4j-container";

package/dist/src/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.StartedMongoDBContainer = exports.MongoDBContainer = exports.StartedNatsContainer = exports.NatsContainer = exports.StartedMySqlContainer = exports.MySqlContainer = exports.StartedElasticsearchContainer = exports.ElasticsearchContainer = exports.StartedArangoContainer = exports.ArangoDBContainer = exports.StartedNeo4jContainer = exports.Neo4jContainer = exports.StartedKafkaContainer = exports.KafkaContainer = exports.StartedPostgreSqlContainer = exports.PostgreSqlContainer = exports.AlwaysPullPolicy = exports.DefaultPullPolicy = exports.StartupCheckStrategy = exports.Wait = exports.StoppedNetwork = exports.StartedNetwork = exports.Network = exports.DownedDockerComposeEnvironment = exports.StoppedDockerComposeEnvironment = exports.StartedDockerComposeEnvironment = exports.DockerComposeEnvironment = exports.TestContainers = exports.GenericContainerBuilder = exports.GenericContainer = void 0;
+exports.StartedMongoDBContainer = exports.MongoDBContainer = exports.StartedNatsContainer = exports.NatsContainer = exports.StartedMySqlContainer = exports.MySqlContainer = exports.StartedElasticsearchContainer = exports.ElasticsearchContainer = exports.StartedArangoContainer = exports.ArangoDBContainer = exports.StartedNeo4jContainer = exports.Neo4jContainer = exports.StartedKafkaContainer = exports.KafkaContainer = exports.StartedPostgreSqlContainer = exports.PostgreSqlContainer = exports.AbstractStartedContainer = exports.AlwaysPullPolicy = exports.DefaultPullPolicy = exports.StartupCheckStrategy = exports.Wait = exports.StoppedNetwork = exports.StartedNetwork = exports.Network = exports.DownedDockerComposeEnvironment = exports.StoppedDockerComposeEnvironment = exports.StartedDockerComposeEnvironment = exports.DockerComposeEnvironment = exports.TestContainers = exports.GenericContainerBuilder = exports.GenericContainer = void 0;
 var generic_container_1 = require("./generic-container/generic-container");
 Object.defineProperty(exports, "GenericContainer", { enumerable: true, get: function () { return generic_container_1.GenericContainer; } });
 var generic_container_builder_1 = require("./generic-container/generic-container-builder");
@@ -26,6 +26,8 @@ Object.defineProperty(exports, "StartupCheckStrategy", { enumerable: true, get:
 var pull_policy_1 = require("./pull-policy");
 Object.defineProperty(exports, "DefaultPullPolicy", { enumerable: true, get: function () { return pull_policy_1.DefaultPullPolicy; } });
 Object.defineProperty(exports, "AlwaysPullPolicy", { enumerable: true, get: function () { return pull_policy_1.AlwaysPullPolicy; } });
+var abstract_started_container_1 = require("./modules/abstract-started-container");
+Object.defineProperty(exports, "AbstractStartedContainer", { enumerable: true, get: function () { return abstract_started_container_1.AbstractStartedContainer; } });
 var postgresql_container_1 = require("./modules/postgresql/postgresql-container");
 Object.defineProperty(exports, "PostgreSqlContainer", { enumerable: true, get: function () { return postgresql_container_1.PostgreSqlContainer; } });
 Object.defineProperty(exports, "StartedPostgreSqlContainer", { enumerable: true, get: function () { return postgresql_container_1.StartedPostgreSqlContainer; } });

package/dist/src/modules/abstract-started-container.d.ts

@@ -2,7 +2,7 @@
 import { RestartOptions, StartedTestContainer, StopOptions, StoppedTestContainer } from "../test-container";
 import { ExecResult, Labels } from "../docker/types";
 import { Readable } from "stream";
-export declare class AbstractStartedContainer {
+export declare class AbstractStartedContainer implements StartedTestContainer {
     protected readonly startedTestContainer: StartedTestContainer;
     constructor(startedTestContainer: StartedTestContainer);
     stop(options?: Partial<StopOptions>): Promise<StoppedTestContainer>;

package/dist/src/test-container.d.ts

@@ -3,7 +3,7 @@ import { PortWithOptionalBinding } from "./port";
 import { PullPolicy } from "./pull-policy";
 import { WaitStrategy } from "./wait-strategy";
 import { Readable } from "stream";
-import { ExecResult, ExtraHost, TmpFs, Labels, Ulimits, BindMount, FileToCopy, ContentToCopy, Environment } from "./docker/types";
+import { ExecResult, ExtraHost, TmpFs, Labels, Ulimits, BindMount, FileToCopy, ContentToCopy, Environment, ResourcesQuota } from "./docker/types";
 import { StartedNetwork } from "./network";
 export interface TestContainer {
     start(): Promise<StartedTestContainer>;
@@ -29,6 +29,7 @@ export interface TestContainer {
     withCopyFilesToContainer(filesToCopy: FileToCopy[]): this;
     withCopyContentToContainer(contentsToCopy: ContentToCopy[]): this;
     withWorkingDir(workingDir: string): this;
+    withResourcesQuota(resourcesQuota: ResourcesQuota): this;
 }
 export interface RestartOptions {
     timeout: number;

package/package.json

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