@kiwiproject/kiwi-test-js 0.2.0 → 0.4.0

package/dist/index.d.ts

@@ -2,3 +2,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";
+export { wait } from "./waitForIt/waitForIt";

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MinioExtension = exports.ElasticSearchExtension = exports.PostgresExtension = exports.MongoExtension = void 0;
+exports.wait = 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");
@@ -9,3 +9,5 @@ var elastic_search_extension_1 = require("./elasticsearch/elastic-search-extensi
 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; } });
+var waitForIt_1 = require("./waitForIt/waitForIt");
+Object.defineProperty(exports, "wait", { enumerable: true, get: function () { return waitForIt_1.wait; } });

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

@@ -12,15 +12,25 @@ declare function startMinioContainer(accessKey?: string, secretKey?: string, ima
  */
 declare function stopMinioContainer(): Promise<void>;
 declare function setMinioPort(port: number): void;
+declare function setMinioHost(host: string): 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;
+/**
+ * Retrieves the host of the started Minio container. Error will be thrown if startMinioContainer was
+ * not previously called.
+ *
+ * Note: In most cases this should return localhost.
+ */
+declare function getMinioHost(): string;
 export declare const MinioExtension: {
     startMinioContainer: typeof startMinioContainer;
     stopMinioContainer: typeof stopMinioContainer;
     setMinioPort: typeof setMinioPort;
     getMinioPort: typeof getMinioPort;
+    getMinioHost: typeof getMinioHost;
+    setMinioHost: typeof setMinioHost;
 };
 export {};

package/dist/minio/minio-extension.js

@@ -33,6 +33,7 @@ function startMinioContainer(accessKey = "minioadmin", secretKey = "keyboard cat
             .withCommand(["server", "/data"])
             .start();
         setMinioPort(container.getMappedPort(9000));
+        setMinioHost(container.getHost());
         // NOTE: This will only work if tests are runInBand (i.e. not in parallel)
         global.MINIO_CONTAINER = container;
     });
@@ -47,11 +48,15 @@ function stopMinioContainer() {
         yield global.MINIO_CONTAINER.stop();
         global.MINIO_CONTAINER = undefined;
         delete process.env.MINIO_EXTENSION_PORT;
+        delete process.env.MINIO_EXTENSION_HOST;
     });
 }
 function setMinioPort(port) {
     process.env.MINIO_EXTENSION_PORT = String(port);
 }
+function setMinioHost(host) {
+    process.env.MINIO_EXTENSION_HOST = host;
+}
 /**
  * Retrieves the mapped external port of the started Minio container. Error will be thrown if startMinioContainer was
  * not previously called.
@@ -60,9 +65,21 @@ function getMinioPort() {
     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);
 }
+/**
+ * Retrieves the host of the started Minio container. Error will be thrown if startMinioContainer was
+ * not previously called.
+ *
+ * Note: In most cases this should return localhost.
+ */
+function getMinioHost() {
+    kiwi_js_1.KiwiPreconditions.checkState(process.env.MINIO_EXTENSION_HOST !== undefined, "Minio container has not been previously started");
+    return process.env.MINIO_EXTENSION_HOST;
+}
 exports.MinioExtension = {
     startMinioContainer,
     stopMinioContainer,
     setMinioPort,
     getMinioPort,
+    getMinioHost,
+    setMinioHost,
 };

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

@@ -0,0 +1,26 @@
+/**
+ * Starts a Redis container and stores the container information in global.REDIS_CONTAINER.
+ *
+ * @param image The image name/version to use for redis. Defaults to redis:7.
+ */
+declare function startRedisContainer(image?: string): Promise<void>;
+/**
+ * Stops a previously started Redis container. Error will be thrown if startRedisContainer is not
+ * previously called.
+ */
+declare function stopRedisContainer(): Promise<void>;
+declare function setRedisBaseUrl(host: string, port: number): void;
+/**
+ * Retrieves the base connection URL for accessing the running Redis. Error will be thrown if startRedisContainer
+ * is not previously called.
+ */
+declare function getRedisBaseUrl(): string;
+declare function flushDatabase(): Promise<void>;
+export declare const RedisExtension: {
+    startRedisContainer: typeof startRedisContainer;
+    stopRedisContainer: typeof stopRedisContainer;
+    setRedisBaseUrl: typeof setRedisBaseUrl;
+    getRedisBaseUrl: typeof getRedisBaseUrl;
+    flushDatabase: typeof flushDatabase;
+};
+export {};

package/dist/redis/redis-extension.js

@@ -0,0 +1,68 @@
+"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.RedisExtension = void 0;
+const kiwi_js_1 = require("@kiwiproject/kiwi-js");
+const testcontainers_1 = require("testcontainers");
+const redis_1 = require("redis");
+/**
+ * Starts a Redis container and stores the container information in global.REDIS_CONTAINER.
+ *
+ * @param image The image name/version to use for redis. Defaults to redis:7.
+ */
+function startRedisContainer(image = "redis:7") {
+    return __awaiter(this, void 0, void 0, function* () {
+        const container = yield new testcontainers_1.GenericContainer(image)
+            .withExposedPorts(6379)
+            .start();
+        setRedisBaseUrl(container.getHost(), container.getMappedPort(6379));
+        // NOTE: This will only work if tests are runInBand (i.e. not in parallel)
+        global.REDIS_CONTAINER = container;
+    });
+}
+/**
+ * Stops a previously started Redis container. Error will be thrown if startRedisContainer is not
+ * previously called.
+ */
+function stopRedisContainer() {
+    return __awaiter(this, void 0, void 0, function* () {
+        kiwi_js_1.KiwiPreconditions.checkState(global.REDIS_CONTAINER !== undefined, "Redis container has not been previously started or is not running in band");
+        yield global.REDIS_CONTAINER.stop();
+        global.REDIS_CONTAINER = undefined;
+        delete process.env.REDIS_EXTENSION_BASE_URI;
+    });
+}
+function setRedisBaseUrl(host, port) {
+    process.env.REDIS_EXTENSION_BASE_URI = `redis://${host}:${port}/`;
+}
+/**
+ * Retrieves the base connection URL for accessing the running Redis. Error will be thrown if startRedisContainer
+ * is not previously called.
+ */
+function getRedisBaseUrl() {
+    kiwi_js_1.KiwiPreconditions.checkState(process.env.REDIS_EXTENSION_BASE_URI !== undefined, "Redis container has not been previously started");
+    return process.env.REDIS_EXTENSION_BASE_URI;
+}
+function flushDatabase() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const client = (0, redis_1.createClient)({ url: getRedisBaseUrl() }).on("error", (err) => console.log("Redis error", err));
+        yield client.connect();
+        yield client.flushDb();
+        yield client.quit();
+    });
+}
+exports.RedisExtension = {
+    startRedisContainer,
+    stopRedisContainer,
+    setRedisBaseUrl,
+    getRedisBaseUrl,
+    flushDatabase,
+};

package/dist/waitForIt/waitForIt.d.ts

@@ -0,0 +1,11 @@
+import { Time } from "convert";
+export declare function wait(): WaitFor;
+declare class WaitFor {
+    private timeoutMs;
+    private checkIntervalMs;
+    constructor();
+    atMost(time: number, units: Time): this;
+    checkEvery(time: number, units: Time): this;
+    until(cb: () => boolean): Promise<string>;
+}
+export {};

package/dist/waitForIt/waitForIt.js

@@ -0,0 +1,44 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wait = void 0;
+const convert_1 = __importDefault(require("convert"));
+function wait() {
+    return new WaitFor();
+}
+exports.wait = wait;
+class WaitFor {
+    constructor() {
+        this.timeoutMs = 500;
+        this.checkIntervalMs = 100;
+    }
+    atMost(time, units) {
+        this.timeoutMs = (0, convert_1.default)(time, units).to("ms");
+        return this;
+    }
+    checkEvery(time, units) {
+        this.checkIntervalMs = (0, convert_1.default)(time, units).to("ms");
+        return this;
+    }
+    until(cb) {
+        const totalTries = this.timeoutMs / this.checkIntervalMs;
+        return new Promise((resolve, reject) => {
+            let tries = 1;
+            const loop = () => {
+                if (cb.apply(this)) {
+                    resolve(`Condition met after ${tries} of ${totalTries} tries`);
+                }
+                else if (tries > totalTries) {
+                    reject(new Error(`Condition was not met after ${totalTries} tries`));
+                }
+                else {
+                    tries += 1;
+                    setTimeout(loop, this.checkIntervalMs);
+                }
+            };
+            loop();
+        });
+    }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kiwiproject/kiwi-test-js",
-  "version": "0.2.0",
+  "version": "0.4.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,27 +22,29 @@
     ]
   },
   "dependencies": {
-    "@elastic/elasticsearch": "8.8.1",
-    "@jest/globals": "29.6.4",
+    "@elastic/elasticsearch": "8.10.0",
+    "@jest/globals": "29.7.0",
     "@kiwiproject/kiwi-js": "0.8.0",
-    "@testcontainers/elasticsearch": "10.2.1",
-    "@testcontainers/postgresql": "10.2.1",
-    "jest": "29.6.4",
-    "mongodb": "5.8.1",
+    "@testcontainers/elasticsearch": "10.3.2",
+    "@testcontainers/postgresql": "10.3.2",
+    "convert": "4.14.0",
+    "jest": "29.7.0",
+    "mongodb": "6.3.0",
     "pg": "8.11.3",
-    "testcontainers": "10.2.1"
+    "redis": "4.6.11",
+    "testcontainers": "10.3.2"
   },
   "devDependencies": {
-    "@babel/core": "7.22.10",
-    "@babel/preset-env": "7.22.10",
-    "@babel/preset-typescript": "7.22.5",
-    "@types/node": "20.5.4",
-    "@types/pg": "8.10.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"
+    "@babel/core": "7.23.3",
+    "@babel/preset-env": "7.23.3",
+    "@babel/preset-typescript": "7.23.3",
+    "@types/node": "20.10.0",
+    "@types/pg": "8.10.9",
+    "@typescript-eslint/eslint-plugin": "6.13.1",
+    "@typescript-eslint/parser": "6.13.0",
+    "babel-jest": "29.7.0",
+    "eslint": "8.54.0",
+    "prettier": "3.1.0",
+    "typescript": "5.3.2"
   }
 }