@kiwiproject/kiwi-test-js 0.1.0 → 0.2.0

package/dist/elasticsearch/elastic-search-extension.d.ts

@@ -1,9 +1,30 @@
-declare function startElasticSearchContainer(): Promise<void>;
+/**
+ * Starts an Elastic search container and stores the container information in global.ELASTIC_SEARCH_CONTAINER.
+ *
+ * @param image The image name/version to use for elastic search. Defaults to elasticsearch:8.6.1.
+ */
+declare function startElasticSearchContainer(image?: string): Promise<void>;
+/**
+ * Stops a previously started Elastic search container. Error will be thrown if startElasticSearchContainer was not
+ * previously called.
+ */
 declare function stopElasticSearchContainer(): Promise<void>;
+declare function setElasticSearchUrl(host: string, port: number): void;
+/**
+ * Retrieves the URL for accessing the running Elastic Search container. Error will be thrown if startElasticSearchContainer
+ * was not previously called.
+ */
 declare function getElasticSearchUrl(): string;
+declare function createIndex(indexName: string, indexMapping: unknown, pipelines: Array<unknown>): Promise<void>;
+declare function clearIndex(indexName: string): Promise<void>;
+declare function deleteIndex(indexName: string): Promise<void>;
 export declare const ElasticSearchExtension: {
     startElasticSearchContainer: typeof startElasticSearchContainer;
     stopElasticSearchContainer: typeof stopElasticSearchContainer;
+    setElasticSearchUrl: typeof setElasticSearchUrl;
     getElasticSearchUrl: typeof getElasticSearchUrl;
+    createIndex: typeof createIndex;
+    clearIndex: typeof clearIndex;
+    deleteIndex: typeof deleteIndex;
 };
 export {};

package/dist/elasticsearch/elastic-search-extension.js

@@ -12,26 +12,86 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ElasticSearchExtension = void 0;
 const kiwi_js_1 = require("@kiwiproject/kiwi-js");
 const elasticsearch_1 = require("@testcontainers/elasticsearch");
-function startElasticSearchContainer() {
+const elasticsearch_2 = require("@elastic/elasticsearch");
+/**
+ * Starts an Elastic search container and stores the container information in global.ELASTIC_SEARCH_CONTAINER.
+ *
+ * @param image The image name/version to use for elastic search. Defaults to elasticsearch:8.6.1.
+ */
+function startElasticSearchContainer(image = "elasticsearch:8.6.1") {
     return __awaiter(this, void 0, void 0, function* () {
-        global.ELASTIC_SEARCH_CONTAINER = yield new elasticsearch_1.ElasticsearchContainer("elasticsearch:8.6.1")
+        const container = yield new elasticsearch_1.ElasticsearchContainer(image)
             .withEnvironment({ "xpack.security.enabled": "false" })
             .start();
+        process.env.ELASTIC_SEARCH_EXTENSION_BASE_URI = container.getHttpUrl();
+        // NOTE: This will only work if tests are runInBand (i.e. not in parallel)
+        global.ELASTIC_SEARCH_CONTAINER = container;
     });
 }
+/**
+ * Stops a previously started Elastic search container. Error will be thrown if startElasticSearchContainer was not
+ * previously called.
+ */
 function stopElasticSearchContainer() {
     return __awaiter(this, void 0, void 0, function* () {
-        kiwi_js_1.KiwiPreconditions.checkState(global.ELASTIC_SEARCH_CONTAINER !== undefined, "Elastic Search container has not been previously started");
+        kiwi_js_1.KiwiPreconditions.checkState(global.ELASTIC_SEARCH_CONTAINER !== undefined, "Elastic Search container has not been previously started or is not running in band");
         yield global.ELASTIC_SEARCH_CONTAINER.stop();
         global.ELASTIC_SEARCH_CONTAINER = undefined;
+        delete process.env.ELASTIC_SEARCH_EXTENSION_BASE_URI;
     });
 }
+function setElasticSearchUrl(host, port) {
+    process.env.ELASTIC_SEARCH_EXTENSION_BASE_URI = `http://${host}:${port}`;
+}
+/**
+ * Retrieves the URL for accessing the running Elastic Search container. Error will be thrown if startElasticSearchContainer
+ * was not previously called.
+ */
 function getElasticSearchUrl() {
-    kiwi_js_1.KiwiPreconditions.checkState(global.ELASTIC_SEARCH_CONTAINER !== undefined, "Elastic Search container has not been previously started");
-    return global.ELASTIC_SEARCH_CONTAINER.getHttpUrl();
+    kiwi_js_1.KiwiPreconditions.checkState(process.env.ELASTIC_SEARCH_EXTENSION_BASE_URI !== undefined, "Elastic Search container has not been previously started");
+    return process.env.ELASTIC_SEARCH_EXTENSION_BASE_URI;
+}
+function createIndex(indexName, indexMapping, pipelines) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const client = new elasticsearch_2.Client({ node: getElasticSearchUrl() });
+        yield client.indices.create({
+            index: indexName,
+            mappings: indexMapping,
+        });
+        for (const pipeline of pipelines) {
+            yield client.ingest.putPipeline(pipeline);
+        }
+        yield client.close();
+    });
+}
+function clearIndex(indexName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const client = new elasticsearch_2.Client({ node: getElasticSearchUrl() });
+        yield client.deleteByQuery({
+            index: indexName,
+            query: {
+                match_all: {},
+            },
+            refresh: true,
+        });
+        yield client.close();
+    });
+}
+function deleteIndex(indexName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const client = new elasticsearch_2.Client({ node: getElasticSearchUrl() });
+        yield client.indices.delete({
+            index: indexName,
+        });
+        yield client.close();
+    });
 }
 exports.ElasticSearchExtension = {
     startElasticSearchContainer,
     stopElasticSearchContainer,
+    setElasticSearchUrl,
     getElasticSearchUrl,
+    createIndex,
+    clearIndex,
+    deleteIndex,
 };

package/dist/minio/minio-extension.d.ts

@@ -1,9 +1,26 @@
-declare function startMinioSearchContainer(accessKey: string, secretKey: string): Promise<void>;
-declare function stopMinioSearchContainer(): Promise<void>;
+/**
+ * Starts a Minio container and stores the container information in global.MINIO_CONTAINER
+ *
+ * @param accessKey The access key configured to connect. Defaults to minioadmin.
+ * @param secretKey The secret key configured to connect. Defaults to keyboard cat.
+ * @param image The image name/version to use for minio. Defaults to minio/minio:RELEASE.2023-08-09T23-30-22Z.
+ */
+declare function startMinioContainer(accessKey?: string, secretKey?: string, image?: string): Promise<void>;
+/**
+ * Stops a previously started Minio container. Error will be thrown if startMinioContainer has not been
+ * previously called.
+ */
+declare function stopMinioContainer(): Promise<void>;
+declare function setMinioPort(port: number): void;
+/**
+ * Retrieves the mapped external port of the started Minio container. Error will be thrown if startMinioContainer was
+ * not previously called.
+ */
 declare function getMinioPort(): number;
 export declare const MinioExtension: {
-    startMinioSearchContainer: typeof startMinioSearchContainer;
-    stopMinioSearchContainer: typeof stopMinioSearchContainer;
+    startMinioContainer: typeof startMinioContainer;
+    stopMinioContainer: typeof stopMinioContainer;
+    setMinioPort: typeof setMinioPort;
     getMinioPort: typeof getMinioPort;
 };
 export {};

package/dist/minio/minio-extension.js

@@ -12,36 +12,57 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MinioExtension = void 0;
 const kiwi_js_1 = require("@kiwiproject/kiwi-js");
 const testcontainers_1 = require("testcontainers");
-function startMinioSearchContainer(accessKey, secretKey) {
+/**
+ * Starts a Minio container and stores the container information in global.MINIO_CONTAINER
+ *
+ * @param accessKey The access key configured to connect. Defaults to minioadmin.
+ * @param secretKey The secret key configured to connect. Defaults to keyboard cat.
+ * @param image The image name/version to use for minio. Defaults to minio/minio:RELEASE.2023-08-09T23-30-22Z.
+ */
+function startMinioContainer(accessKey = "minioadmin", secretKey = "keyboard cat", image = "minio/minio:RELEASE.2023-08-09T23-30-22Z") {
     return __awaiter(this, void 0, void 0, function* () {
-        console.log(accessKey);
-        console.log(secretKey);
-        global.MINIO_CONTAINER = yield new testcontainers_1.GenericContainer('quay.io/minio/minio:latest')
+        const container = yield new testcontainers_1.GenericContainer(image)
             .withEnvironment({
-            MINIO_BROWSER: 'off',
+            MINIO_BROWSER: "off",
             MINIO_ROOT_USER: accessKey,
             MINIO_ROOT_PASSWORD: secretKey,
         })
             .withExposedPorts(9000)
             .withWaitStrategy(testcontainers_1.Wait.forAll([testcontainers_1.Wait.forListeningPorts(), testcontainers_1.Wait.forLogMessage(/1 Online/)]))
-            .withTmpFs({ '/data': 'rw,noexec,nosuid' })
-            .withCommand(['server', '/data'])
+            .withTmpFs({ "/data": "rw,noexec,nosuid" })
+            .withCommand(["server", "/data"])
             .start();
+        setMinioPort(container.getMappedPort(9000));
+        // NOTE: This will only work if tests are runInBand (i.e. not in parallel)
+        global.MINIO_CONTAINER = container;
     });
 }
-function stopMinioSearchContainer() {
+/**
+ * Stops a previously started Minio container. Error will be thrown if startMinioContainer has not been
+ * previously called.
+ */
+function stopMinioContainer() {
     return __awaiter(this, void 0, void 0, function* () {
-        kiwi_js_1.KiwiPreconditions.checkState(global.MINIO_CONTAINER !== undefined, "Minio container has not been previously started");
+        kiwi_js_1.KiwiPreconditions.checkState(global.MINIO_CONTAINER !== undefined, "Minio container has not been previously started or is not running in band");
         yield global.MINIO_CONTAINER.stop();
         global.MINIO_CONTAINER = undefined;
+        delete process.env.MINIO_EXTENSION_PORT;
     });
 }
+function setMinioPort(port) {
+    process.env.MINIO_EXTENSION_PORT = String(port);
+}
+/**
+ * Retrieves the mapped external port of the started Minio container. Error will be thrown if startMinioContainer was
+ * not previously called.
+ */
 function getMinioPort() {
-    kiwi_js_1.KiwiPreconditions.checkState(global.MINIO_CONTAINER !== undefined, "Minio container has not been previously started");
-    return global.MINIO_CONTAINER.getMappedPort(9000);
+    kiwi_js_1.KiwiPreconditions.checkState(process.env.MINIO_EXTENSION_PORT !== undefined, "Minio container has not been previously started");
+    return parseInt(process.env.MINIO_EXTENSION_PORT, 10);
 }
 exports.MinioExtension = {
-    startMinioSearchContainer,
-    stopMinioSearchContainer,
+    startMinioContainer,
+    stopMinioContainer,
+    setMinioPort,
     getMinioPort,
 };

package/dist/mongo/mongo-extension.d.ts

@@ -1,11 +1,33 @@
-declare function startMongoContainer(): Promise<void>;
+/**
+ * Starts a Mongo container and stores the container information in global.MONGO_CONTAINER.
+ *
+ * @param image The image name/version to use for mongo. Defaults to mongo:6.
+ */
+declare function startMongoContainer(image?: string): Promise<void>;
+/**
+ * Stops a previously started Mongo container. Error will be thrown if startMongoContainer is not
+ * previously called.
+ */
 declare function stopMongoContainer(): Promise<void>;
+declare function setMongoBaseUrl(host: string, port: number): void;
+/**
+ * Retrieves the base connection URL for accessing the running Mongo. Error will be thrown if startMongoContainer
+ * is not previously called.
+ */
 declare function getMongoBaseUrl(): string;
+/**
+ * Retrieves the base connection URL plus the given db name for accessing the running Mongo. Error will be thrown if
+ * startMongoContainer is not previously called.
+ * @param dbName The name of the database in mongo to connect.
+ */
 declare function getMongoUriWithDb(dbName: string): string;
+declare function dropDatabase(dbName: string): Promise<void>;
 export declare const MongoExtension: {
     startMongoContainer: typeof startMongoContainer;
     stopMongoContainer: typeof stopMongoContainer;
+    setMongoBaseUrl: typeof setMongoBaseUrl;
     getMongoBaseUrl: typeof getMongoBaseUrl;
     getMongoUriWithDb: typeof getMongoUriWithDb;
+    dropDatabase: typeof dropDatabase;
 };
 export {};

package/dist/mongo/mongo-extension.js

@@ -12,32 +12,67 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MongoExtension = void 0;
 const kiwi_js_1 = require("@kiwiproject/kiwi-js");
 const testcontainers_1 = require("testcontainers");
-function startMongoContainer() {
+const mongodb_1 = require("mongodb");
+/**
+ * Starts a Mongo container and stores the container information in global.MONGO_CONTAINER.
+ *
+ * @param image The image name/version to use for mongo. Defaults to mongo:6.
+ */
+function startMongoContainer(image = "mongo:6") {
     return __awaiter(this, void 0, void 0, function* () {
-        global.MONGO_CONTAINER = yield new testcontainers_1.GenericContainer("mongo")
+        const container = yield new testcontainers_1.GenericContainer(image)
             .withExposedPorts(27017)
             .start();
+        setMongoBaseUrl(container.getHost(), container.getMappedPort(27017));
+        // NOTE: This will only work if tests are runInBand (i.e. not in parallel)
+        global.MONGO_CONTAINER = container;
     });
 }
+/**
+ * Stops a previously started Mongo container. Error will be thrown if startMongoContainer is not
+ * previously called.
+ */
 function stopMongoContainer() {
     return __awaiter(this, void 0, void 0, function* () {
-        kiwi_js_1.KiwiPreconditions.checkState(global.MONGO_CONTAINER !== undefined, "Mongo container has not been previously started");
+        kiwi_js_1.KiwiPreconditions.checkState(global.MONGO_CONTAINER !== undefined, "Mongo container has not been previously started or is not running in band");
         yield global.MONGO_CONTAINER.stop();
         global.MONGO_CONTAINER = undefined;
+        delete process.env.MONGO_EXTENSION_BASE_URI;
     });
 }
+function setMongoBaseUrl(host, port) {
+    process.env.MONGO_EXTENSION_BASE_URI = `mongodb://${host}:${port}/`;
+}
+/**
+ * Retrieves the base connection URL for accessing the running Mongo. Error will be thrown if startMongoContainer
+ * is not previously called.
+ */
 function getMongoBaseUrl() {
-    kiwi_js_1.KiwiPreconditions.checkState(global.MONGO_CONTAINER !== undefined, "Mongo container has not been previously started");
-    const host = global.MONGO_CONTAINER.getHost();
-    const port = global.MONGO_CONTAINER.getMappedPort(27017);
-    return `mongodb://${host}:${port}/`;
+    kiwi_js_1.KiwiPreconditions.checkState(process.env.MONGO_EXTENSION_BASE_URI !== undefined, "Mongo container has not been previously started");
+    return process.env.MONGO_EXTENSION_BASE_URI;
 }
+/**
+ * Retrieves the base connection URL plus the given db name for accessing the running Mongo. Error will be thrown if
+ * startMongoContainer is not previously called.
+ * @param dbName The name of the database in mongo to connect.
+ */
 function getMongoUriWithDb(dbName) {
     return `${getMongoBaseUrl()}${dbName}`;
 }
+function dropDatabase(dbName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const client = new mongodb_1.MongoClient(getMongoBaseUrl());
+        yield client.connect();
+        const db = client.db(dbName);
+        yield db.dropDatabase();
+        yield client.close(true);
+    });
+}
 exports.MongoExtension = {
     startMongoContainer,
     stopMongoContainer,
+    setMongoBaseUrl,
     getMongoBaseUrl,
     getMongoUriWithDb,
+    dropDatabase,
 };

package/dist/postgres/postgres-extension.d.ts

@@ -1,13 +1,42 @@
-declare function startPostgresContainer(): Promise<void>;
+/**
+ * Starts a Postgres container and stores the container information in global.POSTGRES_CONTAINER.
+ *
+ * @param image The image name/version to use for postgres. Defaults to postgres:15.
+ */
+declare function startPostgresContainer(image?: string): Promise<void>;
+/**
+ * Stops a previously started Postgres container. Error will be thrown if startPostgresContainer is not
+ * previously called.
+ */
 declare function stopPostgresContainer(): Promise<void>;
+declare function setPostgresBaseUrl(host: string, port: number, user?: string, password?: string, dbName?: string): void;
+/**
+ * Retrieves the base URL for accessing the running Postgres container. Error will be thrown if
+ * startPostgresContainer is not previously called.
+ */
 declare function getPostgresBaseUrl(): string;
+/**
+ * Retrieves the base URL plus a given database for accessing the running Postgres container. Error will be thrown if
+ * startPostgresContainer is not previously called.
+ *
+ * @param dbName The name of the database to add to the connection string.
+ */
 declare function getPostgresUriWithDb(dbName: string): string;
+/**
+ * Creates a new database with the given name in the running Postgres. Error will be thrown if
+ * startPostgresContainer is not previously called.
+ *
+ * @param dbName The name of the database to create.
+ */
 declare function setupNewDatabase(dbName: string): Promise<void>;
+declare function dropDatabase(dbName: string): Promise<void>;
 export declare const PostgresExtension: {
     startPostgresContainer: typeof startPostgresContainer;
     stopPostgresContainer: typeof stopPostgresContainer;
+    setPostgresBaseUrl: typeof setPostgresBaseUrl;
     getPostgresBaseUrl: typeof getPostgresBaseUrl;
     getPostgresUriWithDb: typeof getPostgresUriWithDb;
     setupNewDatabase: typeof setupNewDatabase;
+    dropDatabase: typeof dropDatabase;
 };
 export {};

package/dist/postgres/postgres-extension.js

@@ -13,25 +13,57 @@ exports.PostgresExtension = void 0;
 const kiwi_js_1 = require("@kiwiproject/kiwi-js");
 const postgresql_1 = require("@testcontainers/postgresql");
 const pg_1 = require("pg");
-function startPostgresContainer() {
+/**
+ * Starts a Postgres container and stores the container information in global.POSTGRES_CONTAINER.
+ *
+ * @param image The image name/version to use for postgres. Defaults to postgres:15.
+ */
+function startPostgresContainer(image = "postgres:15") {
     return __awaiter(this, void 0, void 0, function* () {
-        global.POSTGRES_CONTAINER = yield new postgresql_1.PostgreSqlContainer().start();
+        const container = yield new postgresql_1.PostgreSqlContainer(image).start();
+        process.env.POSTGRES_EXTENSION_BASE_URI = container.getConnectionUri();
+        // NOTE: This will only work if tests are runInBand (i.e. not in parallel)
+        global.POSTGRES_CONTAINER = container;
     });
 }
+/**
+ * Stops a previously started Postgres container. Error will be thrown if startPostgresContainer is not
+ * previously called.
+ */
 function stopPostgresContainer() {
     return __awaiter(this, void 0, void 0, function* () {
-        kiwi_js_1.KiwiPreconditions.checkState(global.POSTGRES_CONTAINER !== undefined, "Postgres container has not been previously started");
+        kiwi_js_1.KiwiPreconditions.checkState(global.POSTGRES_CONTAINER !== undefined, "Postgres container has not been previously started or is not running in band");
         yield global.POSTGRES_CONTAINER.stop();
         global.POSTGRES_CONTAINER = undefined;
+        delete process.env.POSTGRES_EXTENSION_BASE_URI;
     });
 }
+function setPostgresBaseUrl(host, port, user = "test", password = "test", dbName = "test") {
+    process.env.POSTGRES_EXTENSION_BASE_URI = `postgres://${user}:${password}@${host}:${port}/${dbName}`;
+}
+/**
+ * Retrieves the base URL for accessing the running Postgres container. Error will be thrown if
+ * startPostgresContainer is not previously called.
+ */
 function getPostgresBaseUrl() {
-    kiwi_js_1.KiwiPreconditions.checkState(global.POSTGRES_CONTAINER !== undefined, "Postgres container has not been previously started");
-    return global.POSTGRES_CONTAINER.getConnectionUri();
+    kiwi_js_1.KiwiPreconditions.checkState(process.env.POSTGRES_EXTENSION_BASE_URI !== undefined, "Postgres container has not been previously started");
+    return process.env.POSTGRES_EXTENSION_BASE_URI;
 }
+/**
+ * Retrieves the base URL plus a given database for accessing the running Postgres container. Error will be thrown if
+ * startPostgresContainer is not previously called.
+ *
+ * @param dbName The name of the database to add to the connection string.
+ */
 function getPostgresUriWithDb(dbName) {
     return getPostgresBaseUrl().replace(/\/test$/, `/${dbName}`);
 }
+/**
+ * Creates a new database with the given name in the running Postgres. Error will be thrown if
+ * startPostgresContainer is not previously called.
+ *
+ * @param dbName The name of the database to create.
+ */
 function setupNewDatabase(dbName) {
     return __awaiter(this, void 0, void 0, function* () {
         const dbClient = new pg_1.Client({
@@ -42,10 +74,23 @@ function setupNewDatabase(dbName) {
         yield dbClient.end();
     });
 }
+function dropDatabase(dbName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const dbClient = new pg_1.Client({
+            connectionString: getPostgresBaseUrl(),
+        });
+        yield dbClient.connect();
+        yield dbClient.query(`select pg_terminate_backend(pid) from pg_stat_activity where datname = '${dbName}'`);
+        yield dbClient.query(`drop database ${dbName}`);
+        yield dbClient.end();
+    });
+}
 exports.PostgresExtension = {
     startPostgresContainer,
     stopPostgresContainer,
+    setPostgresBaseUrl,
     getPostgresBaseUrl,
     getPostgresUriWithDb,
     setupNewDatabase,
+    dropDatabase,
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kiwiproject/kiwi-test-js",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "kiwi-test-js is a test utility library. Most of these utilities are ports from the Java Kiwi-test library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -22,24 +22,25 @@
     ]
   },
   "dependencies": {
-    "@jest/globals": "29.6.2",
+    "@elastic/elasticsearch": "8.8.1",
+    "@jest/globals": "29.6.4",
     "@kiwiproject/kiwi-js": "0.8.0",
     "@testcontainers/elasticsearch": "10.2.1",
     "@testcontainers/postgresql": "10.2.1",
-    "jest": "29.6.2",
-    "mongodb": "5.7.0",
-    "pg": "8.11.2",
+    "jest": "29.6.4",
+    "mongodb": "5.8.1",
+    "pg": "8.11.3",
     "testcontainers": "10.2.1"
   },
   "devDependencies": {
     "@babel/core": "7.22.10",
     "@babel/preset-env": "7.22.10",
     "@babel/preset-typescript": "7.22.5",
-    "@types/node": "20.5.0",
+    "@types/node": "20.5.4",
     "@types/pg": "8.10.2",
-    "@typescript-eslint/eslint-plugin": "6.4.0",
-    "@typescript-eslint/parser": "6.4.0",
-    "babel-jest": "29.6.2",
+    "@typescript-eslint/eslint-plugin": "6.4.1",
+    "@typescript-eslint/parser": "6.4.1",
+    "babel-jest": "29.6.3",
     "eslint": "8.47.0",
     "prettier": "3.0.2",
     "typescript": "5.1.6"