@kiwiproject/kiwi-test-js 0.1.0 → 0.1.1

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

@@ -1,5 +1,18 @@
-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>;
+/**
+ * Retrieves the URL for accessing the running Elastic Search container. Error will be thrown if startElasticSearchContainer
+ * was not previously called.
+ */
 declare function getElasticSearchUrl(): string;
 export declare const ElasticSearchExtension: {
     startElasticSearchContainer: typeof startElasticSearchContainer;

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

@@ -12,13 +12,22 @@ 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() {
+/**
+ * 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")
+        global.ELASTIC_SEARCH_CONTAINER = yield new elasticsearch_1.ElasticsearchContainer(image)
             .withEnvironment({ "xpack.security.enabled": "false" })
             .start();
     });
 }
+/**
+ * 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");
@@ -26,6 +35,10 @@ function stopElasticSearchContainer() {
         global.ELASTIC_SEARCH_CONTAINER = undefined;
     });
 }
+/**
+ * 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();

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

@@ -1,9 +1,24 @@
-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>;
+/**
+ * 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;
     getMinioPort: typeof getMinioPort;
 };
 export {};

package/dist/minio/minio-extension.js

@@ -12,36 +12,49 @@ 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')
+        global.MINIO_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();
     });
 }
-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");
         yield global.MINIO_CONTAINER.stop();
         global.MINIO_CONTAINER = undefined;
     });
 }
+/**
+ * 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);
 }
 exports.MinioExtension = {
-    startMinioSearchContainer,
-    stopMinioSearchContainer,
+    startMinioContainer,
+    stopMinioContainer,
     getMinioPort,
 };

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

@@ -1,6 +1,24 @@
-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>;
+/**
+ * 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;
 export declare const MongoExtension: {
     startMongoContainer: typeof startMongoContainer;

package/dist/mongo/mongo-extension.js

@@ -12,13 +12,22 @@ 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() {
+/**
+ * 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")
+        global.MONGO_CONTAINER = yield new testcontainers_1.GenericContainer(image)
             .withExposedPorts(27017)
             .start();
     });
 }
+/**
+ * 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");
@@ -26,12 +35,21 @@ function stopMongoContainer() {
         global.MONGO_CONTAINER = undefined;
     });
 }
+/**
+ * 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}/`;
 }
+/**
+ * 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}`;
 }

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

@@ -1,7 +1,32 @@
-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>;
+/**
+ * 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>;
 export declare const PostgresExtension: {
     startPostgresContainer: typeof startPostgresContainer;

package/dist/postgres/postgres-extension.js

@@ -13,11 +13,20 @@ 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();
+        global.POSTGRES_CONTAINER = yield new postgresql_1.PostgreSqlContainer(image).start();
     });
 }
+/**
+ * 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");
@@ -25,13 +34,29 @@ function stopPostgresContainer() {
         global.POSTGRES_CONTAINER = undefined;
     });
 }
+/**
+ * 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();
 }
+/**
+ * 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({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kiwiproject/kiwi-test-js",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "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",