@kiwiproject/kiwi-test-js 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Kiwi Project
+
+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,18 @@
+### KiwiTestJS
+[![Build](https://github.com/kiwiproject/kiwi-test-js/workflows/build/badge.svg)](https://github.com/kiwiproject/kiwi-test-js/actions?query=workflow%3Abuild)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=kiwiproject_kiwi-test-js&metric=alert_status)](https://sonarcloud.io/dashboard?id=kiwiproject_kiwi-test-js)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=kiwiproject_kiwi-test-js&metric=coverage)](https://sonarcloud.io/dashboard?id=kiwiproject_kiwi-test-js)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![NPM](https://img.shields.io/npm/v/@kiwiproject/kiwi-test-js)](https://www.npmjs.com/package/@kiwiproject/kiwi-test-js)
+
+kiwi-test-js is a test utility library. Most of these utilities are ports from the Java Kiwi-test library (https://github.com/kiwiproject/kiwi-test).
+
+### TestContainers
+There are a few prebuilt implementations of starting up TestContainers to use in tests. These utilities allow for global
+setup and teardown methods to be created to run containers before all tests and after all tests not just per test file.
+Currently there are 4 implementations:
+
+* PostgresExtension - Spins up and shuts down a Postgres container for use and allows for creating databases
+* MongoExtension - Spins up and shuts down a Mongo container for use
+* ElasticSearchExtension - Spins up and shuts down a Elastic Search container for use
+* MinioExtension - Spins up and shuts down a Minio container for use

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

@@ -0,0 +1,9 @@
+declare function startElasticSearchContainer(): Promise<void>;
+declare function stopElasticSearchContainer(): Promise<void>;
+declare function getElasticSearchUrl(): string;
+export declare const ElasticSearchExtension: {
+    startElasticSearchContainer: typeof startElasticSearchContainer;
+    stopElasticSearchContainer: typeof stopElasticSearchContainer;
+    getElasticSearchUrl: typeof getElasticSearchUrl;
+};
+export {};

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

@@ -0,0 +1,37 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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() {
+    return __awaiter(this, void 0, void 0, function* () {
+        global.ELASTIC_SEARCH_CONTAINER = yield new elasticsearch_1.ElasticsearchContainer("elasticsearch:8.6.1")
+            .withEnvironment({ "xpack.security.enabled": "false" })
+            .start();
+    });
+}
+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");
+        yield global.ELASTIC_SEARCH_CONTAINER.stop();
+        global.ELASTIC_SEARCH_CONTAINER = undefined;
+    });
+}
+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();
+}
+exports.ElasticSearchExtension = {
+    startElasticSearchContainer,
+    stopElasticSearchContainer,
+    getElasticSearchUrl,
+};

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { MongoExtension } from "./mongo/mongo-extension";
+export { PostgresExtension } from "./postgres/postgres-extension";
+export { ElasticSearchExtension } from "./elasticsearch/elastic-search-extension";
+export { MinioExtension } from "./minio/minio-extension";

package/dist/index.js

@@ -0,0 +1,11 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MinioExtension = exports.ElasticSearchExtension = exports.PostgresExtension = exports.MongoExtension = void 0;
+var mongo_extension_1 = require("./mongo/mongo-extension");
+Object.defineProperty(exports, "MongoExtension", { enumerable: true, get: function () { return mongo_extension_1.MongoExtension; } });
+var postgres_extension_1 = require("./postgres/postgres-extension");
+Object.defineProperty(exports, "PostgresExtension", { enumerable: true, get: function () { return postgres_extension_1.PostgresExtension; } });
+var elastic_search_extension_1 = require("./elasticsearch/elastic-search-extension");
+Object.defineProperty(exports, "ElasticSearchExtension", { enumerable: true, get: function () { return elastic_search_extension_1.ElasticSearchExtension; } });
+var minio_extension_1 = require("./minio/minio-extension");
+Object.defineProperty(exports, "MinioExtension", { enumerable: true, get: function () { return minio_extension_1.MinioExtension; } });

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

@@ -0,0 +1,9 @@
+declare function startMinioSearchContainer(accessKey: string, secretKey: string): Promise<void>;
+declare function stopMinioSearchContainer(): Promise<void>;
+declare function getMinioPort(): number;
+export declare const MinioExtension: {
+    startMinioSearchContainer: typeof startMinioSearchContainer;
+    stopMinioSearchContainer: typeof stopMinioSearchContainer;
+    getMinioPort: typeof getMinioPort;
+};
+export {};

package/dist/minio/minio-extension.js

@@ -0,0 +1,47 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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) {
+    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')
+            .withEnvironment({
+            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'])
+            .start();
+    });
+}
+function stopMinioSearchContainer() {
+    return __awaiter(this, void 0, void 0, function* () {
+        kiwi_js_1.KiwiPreconditions.checkState(global.MINIO_CONTAINER !== undefined, "Minio container has not been previously started");
+        yield global.MINIO_CONTAINER.stop();
+        global.MINIO_CONTAINER = undefined;
+    });
+}
+function getMinioPort() {
+    kiwi_js_1.KiwiPreconditions.checkState(global.MINIO_CONTAINER !== undefined, "Minio container has not been previously started");
+    return global.MINIO_CONTAINER.getMappedPort(9000);
+}
+exports.MinioExtension = {
+    startMinioSearchContainer,
+    stopMinioSearchContainer,
+    getMinioPort,
+};

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

@@ -0,0 +1,11 @@
+declare function startMongoContainer(): Promise<void>;
+declare function stopMongoContainer(): Promise<void>;
+declare function getMongoBaseUrl(): string;
+declare function getMongoUriWithDb(dbName: string): string;
+export declare const MongoExtension: {
+    startMongoContainer: typeof startMongoContainer;
+    stopMongoContainer: typeof stopMongoContainer;
+    getMongoBaseUrl: typeof getMongoBaseUrl;
+    getMongoUriWithDb: typeof getMongoUriWithDb;
+};
+export {};

package/dist/mongo/mongo-extension.js

@@ -0,0 +1,43 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+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() {
+    return __awaiter(this, void 0, void 0, function* () {
+        global.MONGO_CONTAINER = yield new testcontainers_1.GenericContainer("mongo")
+            .withExposedPorts(27017)
+            .start();
+    });
+}
+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");
+        yield global.MONGO_CONTAINER.stop();
+        global.MONGO_CONTAINER = undefined;
+    });
+}
+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}/`;
+}
+function getMongoUriWithDb(dbName) {
+    return `${getMongoBaseUrl()}${dbName}`;
+}
+exports.MongoExtension = {
+    startMongoContainer,
+    stopMongoContainer,
+    getMongoBaseUrl,
+    getMongoUriWithDb,
+};

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

@@ -0,0 +1,13 @@
+declare function startPostgresContainer(): Promise<void>;
+declare function stopPostgresContainer(): Promise<void>;
+declare function getPostgresBaseUrl(): string;
+declare function getPostgresUriWithDb(dbName: string): string;
+declare function setupNewDatabase(dbName: string): Promise<void>;
+export declare const PostgresExtension: {
+    startPostgresContainer: typeof startPostgresContainer;
+    stopPostgresContainer: typeof stopPostgresContainer;
+    getPostgresBaseUrl: typeof getPostgresBaseUrl;
+    getPostgresUriWithDb: typeof getPostgresUriWithDb;
+    setupNewDatabase: typeof setupNewDatabase;
+};
+export {};

package/dist/postgres/postgres-extension.js

@@ -0,0 +1,51 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+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() {
+    return __awaiter(this, void 0, void 0, function* () {
+        global.POSTGRES_CONTAINER = yield new postgresql_1.PostgreSqlContainer().start();
+    });
+}
+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");
+        yield global.POSTGRES_CONTAINER.stop();
+        global.POSTGRES_CONTAINER = undefined;
+    });
+}
+function getPostgresBaseUrl() {
+    kiwi_js_1.KiwiPreconditions.checkState(global.POSTGRES_CONTAINER !== undefined, "Postgres container has not been previously started");
+    return global.POSTGRES_CONTAINER.getConnectionUri();
+}
+function getPostgresUriWithDb(dbName) {
+    return getPostgresBaseUrl().replace(/\/test$/, `/${dbName}`);
+}
+function setupNewDatabase(dbName) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const dbClient = new pg_1.Client({
+            connectionString: getPostgresBaseUrl(),
+        });
+        yield dbClient.connect();
+        yield dbClient.query(`create database ${dbName}`);
+        yield dbClient.end();
+    });
+}
+exports.PostgresExtension = {
+    startPostgresContainer,
+    stopPostgresContainer,
+    getPostgresBaseUrl,
+    getPostgresUriWithDb,
+    setupNewDatabase,
+};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@kiwiproject/kiwi-test-js",
+  "version": "0.1.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",
+  "files": [
+    "/dist"
+  ],
+  "scripts": {
+    "format": "node node_modules/.bin/prettier --ignore-path .gitignore --write \"**/*.+(js|ts|json)\"",
+    "lint": "node node_modules/.bin/eslint --ext .js,.ts .",
+    "test": "node --experimental-vm-modules node_modules/.bin/jest --coverage --collectCoverageFrom=src/**/*.ts"
+  },
+  "jest": {
+    "testPathIgnorePatterns": [
+      "<rootDir>/__tests__/__utils__",
+      "<rootDir>/node_modules/"
+    ],
+    "coveragePathIgnorePatterns": [
+      "src/index.ts"
+    ]
+  },
+  "dependencies": {
+    "@jest/globals": "29.6.2",
+    "@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",
+    "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/pg": "8.10.2",
+    "@typescript-eslint/eslint-plugin": "6.4.0",
+    "@typescript-eslint/parser": "6.4.0",
+    "babel-jest": "29.6.2",
+    "eslint": "8.47.0",
+    "prettier": "3.0.2",
+    "typescript": "5.1.6"
+  }
+}