@testcontainers/opensearch 11.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 - 2025 Cristian Greco
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,29 @@
+# Testcontainers
+
+[![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=116414510&machine=standardLinux32gb&devcontainer_path=.devcontainer%2Fdevcontainer.json&location=EastUs)
+
+[![Test](https://github.com/testcontainers/testcontainers-node/actions/workflows/checks.yml/badge.svg?branch=main)](https://github.com/testcontainers/testcontainers-node/actions/workflows/checks.yml)
+[![npm version](https://badge.fury.io/js/testcontainers.svg)](https://www.npmjs.com/package/testcontainers)
+[![npm version](https://img.shields.io/npm/dm/testcontainers.svg)](https://www.npmjs.com/package/testcontainers)
+
+![Testcontainers Banner](https://github.com/testcontainers/testcontainers-node/raw/main/docs/site/logo.png)
+
+## [📖 Documentation](https://node.testcontainers.org/)
+
+## License
+
+See [LICENSE](https://github.com/testcontainers/testcontainers-node/blob/main/LICENSE).
+
+## Copyright
+
+Copyright (c) 2018 - 2025 Cristian Greco and other authors.
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for how to contribute to this repo.
+
+See [contributors](https://github.com/testcontainers/testcontainers-node/graphs/contributors/) for all contributors.
+
+---
+
+Join our [Slack workspace](https://slack.testcontainers.org/) | [Testcontainers OSS](https://java.testcontainers.org/) | [Testcontainers Cloud](https://www.testcontainers.cloud/)

package/build/index.d.ts

@@ -0,0 +1 @@
+export { OpenSearchContainer, StartedOpenSearchContainer } from "./opensearch-container";

package/build/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StartedOpenSearchContainer = exports.OpenSearchContainer = void 0;
+var opensearch_container_1 = require("./opensearch-container");
+Object.defineProperty(exports, "OpenSearchContainer", { enumerable: true, get: function () { return opensearch_container_1.OpenSearchContainer; } });
+Object.defineProperty(exports, "StartedOpenSearchContainer", { enumerable: true, get: function () { return opensearch_container_1.StartedOpenSearchContainer; } });
+//# sourceMappingURL=index.js.map

package/build/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;AAAA,+DAAyF;AAAhF,2HAAA,mBAAmB,OAAA;AAAE,kIAAA,0BAA0B,OAAA"}

package/build/opensearch-container.d.ts

@@ -0,0 +1,36 @@
+import { AbstractStartedContainer, GenericContainer, StartedTestContainer } from "testcontainers";
+export declare class OpenSearchContainer extends GenericContainer {
+    private securityEnabled;
+    private password;
+    private readonly username;
+    private readonly defaultWaitStrategy;
+    constructor(image: string);
+    /**
+     * Toggle OpenSearch security plugin on/off.
+     */
+    withSecurityEnabled(enabled: boolean): this;
+    /**
+     * Override the 'admin' password.
+     * Enforces OpenSearch’s requirement of zxcvbn score ≥ 3
+     */
+    withPassword(password: string): this;
+    /**
+     * Start the container, injecting the initial-admin-password env var,
+     * then wrap in our typed StartedOpenSearchContainer.
+     */
+    start(): Promise<StartedOpenSearchContainer>;
+}
+export declare class StartedOpenSearchContainer extends AbstractStartedContainer {
+    readonly startedTestContainer: StartedTestContainer;
+    private readonly username;
+    private readonly password;
+    constructor(startedTestContainer: StartedTestContainer, username: string, password: string);
+    /** Mapped HTTP(S) port */
+    getPort(): number;
+    /** HTTPS endpoint URL */
+    getHttpUrl(): string;
+    /** Admin username (always 'admin' by default) */
+    getUsername(): string;
+    /** Admin password */
+    getPassword(): string;
+}

package/build/opensearch-container.js

@@ -0,0 +1,97 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StartedOpenSearchContainer = exports.OpenSearchContainer = void 0;
+const testcontainers_1 = require("testcontainers");
+const zxcvbn_1 = __importDefault(require("zxcvbn"));
+const OPENSEARCH_HTTP_PORT = 9200;
+const OPENSEARCH_TRANSPORT_PORT = 9300;
+const OPENSEARCH_PERFORMANCE_ANALYZER_PORT = 9600;
+class OpenSearchContainer extends testcontainers_1.GenericContainer {
+    // default to security on, with a strong demo password
+    securityEnabled = true;
+    password = "yourStrong(!)P@ssw0rd";
+    username = "admin";
+    // HTTPS + Basic Auth wait strategy
+    defaultWaitStrategy = testcontainers_1.Wait.forHttp("/", OPENSEARCH_HTTP_PORT)
+        .usingTls()
+        .allowInsecure()
+        .withBasicCredentials(this.username, this.password);
+    constructor(image) {
+        super(image);
+        this.withExposedPorts(OPENSEARCH_HTTP_PORT, OPENSEARCH_TRANSPORT_PORT, OPENSEARCH_PERFORMANCE_ANALYZER_PORT)
+            .withEnvironment({
+            "discovery.type": "single-node",
+            // disable security plugin if requested
+            "plugins.security.disabled": (!this.securityEnabled).toString(),
+        })
+            .withWaitStrategy(this.defaultWaitStrategy)
+            .withStartupTimeout(120_000);
+    }
+    /**
+     * Toggle OpenSearch security plugin on/off.
+     */
+    withSecurityEnabled(enabled) {
+        this.securityEnabled = enabled;
+        this.withEnvironment({
+            "plugins.security.disabled": (!enabled).toString(),
+        });
+        return this;
+    }
+    /**
+     * Override the 'admin' password.
+     * Enforces OpenSearch’s requirement of zxcvbn score ≥ 3
+     */
+    withPassword(password) {
+        const { score } = (0, zxcvbn_1.default)(password);
+        if (score < 3) {
+            throw new Error(`Password "${password}" is too weak (zxcvbn score ${score}). Must score ≥ 3 to meet OpenSearch security requirements.`);
+        }
+        this.password = password;
+        this.defaultWaitStrategy.withBasicCredentials(this.username, this.password);
+        return this;
+    }
+    /**
+     * Start the container, injecting the initial-admin-password env var,
+     * then wrap in our typed StartedOpenSearchContainer.
+     */
+    async start() {
+        this.withEnvironment({
+            OPENSEARCH_INITIAL_ADMIN_PASSWORD: this.password,
+        });
+        const started = await super.start();
+        return new StartedOpenSearchContainer(started, this.username, this.password);
+    }
+}
+exports.OpenSearchContainer = OpenSearchContainer;
+class StartedOpenSearchContainer extends testcontainers_1.AbstractStartedContainer {
+    startedTestContainer;
+    username;
+    password;
+    constructor(startedTestContainer, username, password) {
+        super(startedTestContainer);
+        this.startedTestContainer = startedTestContainer;
+        this.username = username;
+        this.password = password;
+    }
+    /** Mapped HTTP(S) port */
+    getPort() {
+        return this.getMappedPort(OPENSEARCH_HTTP_PORT);
+    }
+    /** HTTPS endpoint URL */
+    getHttpUrl() {
+        return `https://${this.getHost()}:${this.getPort()}`;
+    }
+    /** Admin username (always 'admin' by default) */
+    getUsername() {
+        return this.username;
+    }
+    /** Admin password */
+    getPassword() {
+        return this.password;
+    }
+}
+exports.StartedOpenSearchContainer = StartedOpenSearchContainer;
+//# sourceMappingURL=opensearch-container.js.map

package/build/opensearch-container.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"opensearch-container.js","sourceRoot":"","sources":["../src/opensearch-container.ts"],"names":[],"mappings":";;;;;;AAAA,mDAAwG;AACxG,oDAA4B;AAE5B,MAAM,oBAAoB,GAAG,IAAI,CAAC;AAClC,MAAM,yBAAyB,GAAG,IAAI,CAAC;AACvC,MAAM,oCAAoC,GAAG,IAAI,CAAC;AAElD,MAAa,mBAAoB,SAAQ,iCAAgB;IACvD,sDAAsD;IAC9C,eAAe,GAAG,IAAI,CAAC;IACvB,QAAQ,GAAG,uBAAuB,CAAC;IAC1B,QAAQ,GAAG,OAAO,CAAC;IAEpC,mCAAmC;IAClB,mBAAmB,GAAG,qBAAI,CAAC,OAAO,CAAC,GAAG,EAAE,oBAAoB,CAAC;SAC3E,QAAQ,EAAE;SACV,aAAa,EAAE;SACf,oBAAoB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAEtD,YAAY,KAAa;QACvB,KAAK,CAAC,KAAK,CAAC,CAAC;QAEb,IAAI,CAAC,gBAAgB,CAAC,oBAAoB,EAAE,yBAAyB,EAAE,oCAAoC,CAAC;aACzG,eAAe,CAAC;YACf,gBAAgB,EAAE,aAAa;YAC/B,uCAAuC;YACvC,2BAA2B,EAAE,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC,QAAQ,EAAE;SAChE,CAAC;aACD,gBAAgB,CAAC,IAAI,CAAC,mBAAmB,CAAC;aAC1C,kBAAkB,CAAC,OAAO,CAAC,CAAC;IACjC,CAAC;IAED;;OAEG;IACI,mBAAmB,CAAC,OAAgB;QACzC,IAAI,CAAC,eAAe,GAAG,OAAO,CAAC;QAC/B,IAAI,CAAC,eAAe,CAAC;YACnB,2BAA2B,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,QAAQ,EAAE;SACnD,CAAC,CAAC;QACH,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACI,YAAY,CAAC,QAAgB;QAClC,MAAM,EAAE,KAAK,EAAE,GAAG,IAAA,gBAAM,EAAC,QAAQ,CAAC,CAAC;QACnC,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;YACd,MAAM,IAAI,KAAK,CACb,aAAa,QAAQ,+BAA+B,KAAK,6DAA6D,CACvH,CAAC;QACJ,CAAC;QAED,IAAI,CAAC,QAAQ,GAAG,QAAQ,CAAC;QACzB,IAAI,CAAC,mBAAmB,CAAC,oBAAoB,CAAC,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;QAC5E,OAAO,IAAI,CAAC;IACd,CAAC;IAED;;;OAGG;IACa,KAAK,CAAC,KAAK;QACzB,IAAI,CAAC,eAAe,CAAC;YACnB,iCAAiC,EAAE,IAAI,CAAC,QAAQ;SACjD,CAAC,CAAC;QAEH,MAAM,OAAO,GAAG,MAAM,KAAK,CAAC,KAAK,EAAE,CAAC;QACpC,OAAO,IAAI,0BAA0B,CAAC,OAAO,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,CAAC;IAC/E,CAAC;CACF;AAjED,kDAiEC;AAED,MAAa,0BAA2B,SAAQ,yCAAwB;IAElD;IACD;IACA;IAHnB,YACoB,oBAA0C,EAC3C,QAAgB,EAChB,QAAgB;QAEjC,KAAK,CAAC,oBAAoB,CAAC,CAAC;QAJV,yBAAoB,GAApB,oBAAoB,CAAsB;QAC3C,aAAQ,GAAR,QAAQ,CAAQ;QAChB,aAAQ,GAAR,QAAQ,CAAQ;IAGnC,CAAC;IAED,0BAA0B;IACnB,OAAO;QACZ,OAAO,IAAI,CAAC,aAAa,CAAC,oBAAoB,CAAC,CAAC;IAClD,CAAC;IAED,yBAAyB;IAClB,UAAU;QACf,OAAO,WAAW,IAAI,CAAC,OAAO,EAAE,IAAI,IAAI,CAAC,OAAO,EAAE,EAAE,CAAC;IACvD,CAAC;IAED,iDAAiD;IAC1C,WAAW;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;IAED,qBAAqB;IACd,WAAW;QAChB,OAAO,IAAI,CAAC,QAAQ,CAAC;IACvB,CAAC;CACF;AA5BD,gEA4BC"}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@testcontainers/opensearch",
+  "version": "11.3.0",
+  "license": "MIT",
+  "keywords": [
+    "opensearch",
+    "testing",
+    "docker",
+    "testcontainers"
+  ],
+  "description": "OpenSearch module for Testcontainers",
+  "homepage": "https://github.com/testcontainers/testcontainers-node#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/testcontainers/testcontainers-node.git"
+  },
+  "bugs": {
+    "url": "https://github.com/testcontainers/testcontainers-node/issues"
+  },
+  "main": "build/index.js",
+  "files": [
+    "build"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "prepack": "shx cp ../../../README.md . && shx cp ../../../LICENSE .",
+    "build": "tsc --project tsconfig.build.json"
+  },
+  "devDependencies": {
+    "@opensearch-project/opensearch": "^3.5.1",
+    "@types/zxcvbn": "^4.4.5"
+  },
+  "dependencies": {
+    "testcontainers": "^11.3.0",
+    "zxcvbn": "^4.4.2"
+  }
+}