@backstage/backend-test-utils 1.0.1-next.1 → 1.0.1

package/dist/cache/TestCaches.cjs.js

@@ -0,0 +1,159 @@
+'use strict';
+
+var Keyv = require('keyv');
+var isDockerDisabledForTests = require('../util/isDockerDisabledForTests.cjs.js');
+var memcache = require('./memcache.cjs.js');
+var redis = require('./redis.cjs.js');
+var types = require('./types.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var Keyv__default = /*#__PURE__*/_interopDefaultCompat(Keyv);
+
+class TestCaches {
+  instanceById;
+  supportedIds;
+  static defaultIds;
+  /**
+   * Creates an empty `TestCaches` instance, and sets up Jest to clean up all of
+   * its acquired resources after all tests finish.
+   *
+   * You typically want to create just a single instance like this at the top of
+   * your test file or `describe` block, and then call `init` many times on that
+   * instance inside the individual tests. Spinning up a "physical" cache
+   * instance takes a considerable amount of time, slowing down tests. But
+   * wiping the contents of an instance using `init` is very fast.
+   */
+  static create(options) {
+    const ids = options?.ids;
+    const disableDocker = options?.disableDocker ?? isDockerDisabledForTests.isDockerDisabledForTests();
+    let testCacheIds;
+    if (ids) {
+      testCacheIds = ids;
+    } else if (TestCaches.defaultIds) {
+      testCacheIds = TestCaches.defaultIds;
+    } else {
+      testCacheIds = Object.keys(types.allCaches);
+    }
+    const supportedIds = testCacheIds.filter((id) => {
+      const properties = types.allCaches[id];
+      if (!properties) {
+        return false;
+      }
+      if (properties.connectionStringEnvironmentVariableName && process.env[properties.connectionStringEnvironmentVariableName]) {
+        return true;
+      }
+      if (!properties.dockerImageName) {
+        return true;
+      }
+      if (disableDocker) {
+        return false;
+      }
+      return true;
+    });
+    const caches = new TestCaches(supportedIds);
+    if (supportedIds.length > 0) {
+      afterAll(async () => {
+        await caches.shutdown();
+      });
+    }
+    return caches;
+  }
+  static setDefaults(options) {
+    TestCaches.defaultIds = options.ids;
+  }
+  constructor(supportedIds) {
+    this.instanceById = /* @__PURE__ */ new Map();
+    this.supportedIds = supportedIds;
+  }
+  supports(id) {
+    return this.supportedIds.includes(id);
+  }
+  eachSupportedId() {
+    return this.supportedIds.map((id) => [id]);
+  }
+  /**
+   * Returns a fresh, empty cache for the given driver.
+   *
+   * @param id - The ID of the cache to use, e.g. 'REDIS_7'
+   * @returns Cache connection properties
+   */
+  async init(id) {
+    const properties = types.allCaches[id];
+    if (!properties) {
+      const candidates = Object.keys(types.allCaches).join(", ");
+      throw new Error(
+        `Unknown test cache ${id}, possible values are ${candidates}`
+      );
+    }
+    if (!this.supportedIds.includes(id)) {
+      const candidates = this.supportedIds.join(", ");
+      throw new Error(
+        `Unsupported test cache ${id} for this environment, possible values are ${candidates}`
+      );
+    }
+    let instance = this.instanceById.get(id);
+    if (!instance) {
+      instance = await this.initAny(properties);
+      this.instanceById.set(id, instance);
+    }
+    await instance.keyv.clear();
+    return {
+      store: instance.store,
+      connection: instance.connection,
+      keyv: instance.keyv
+    };
+  }
+  async initAny(properties) {
+    switch (properties.store) {
+      case "memcache":
+        return this.initMemcached(properties);
+      case "redis":
+        return this.initRedis(properties);
+      case "memory":
+        return {
+          store: "memory",
+          connection: "memory",
+          keyv: new Keyv__default.default(),
+          stop: async () => {
+          }
+        };
+      default:
+        throw new Error(`Unknown cache store '${properties.store}'`);
+    }
+  }
+  async initMemcached(properties) {
+    const envVarName = properties.connectionStringEnvironmentVariableName;
+    if (envVarName) {
+      const connectionString = process.env[envVarName];
+      if (connectionString) {
+        return memcache.connectToExternalMemcache(connectionString);
+      }
+    }
+    return await memcache.startMemcachedContainer(properties.dockerImageName);
+  }
+  async initRedis(properties) {
+    const envVarName = properties.connectionStringEnvironmentVariableName;
+    if (envVarName) {
+      const connectionString = process.env[envVarName];
+      if (connectionString) {
+        return redis.connectToExternalRedis(connectionString);
+      }
+    }
+    return await redis.startRedisContainer(properties.dockerImageName);
+  }
+  async shutdown() {
+    const instances = [...this.instanceById.values()];
+    this.instanceById.clear();
+    await Promise.all(
+      instances.map(
+        ({ stop }) => stop().catch((error) => {
+          console.warn(`TestCaches: Failed to stop container`, { error });
+        })
+      )
+    );
+  }
+}
+
+exports.TestCaches = TestCaches;
+//# sourceMappingURL=TestCaches.cjs.js.map

package/dist/cache/TestCaches.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestCaches.cjs.js","sources":["../../src/cache/TestCaches.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport Keyv from 'keyv';\nimport { isDockerDisabledForTests } from '../util/isDockerDisabledForTests';\nimport { connectToExternalMemcache, startMemcachedContainer } from './memcache';\nimport { connectToExternalRedis, startRedisContainer } from './redis';\nimport { Instance, TestCacheId, TestCacheProperties, allCaches } from './types';\n\n/**\n * Encapsulates the creation of ephemeral test cache instances for use inside\n * unit or integration tests.\n *\n * @public\n */\nexport class TestCaches {\n  private readonly instanceById: Map<string, Instance>;\n  private readonly supportedIds: TestCacheId[];\n  private static defaultIds?: TestCacheId[];\n\n  /**\n   * Creates an empty `TestCaches` instance, and sets up Jest to clean up all of\n   * its acquired resources after all tests finish.\n   *\n   * You typically want to create just a single instance like this at the top of\n   * your test file or `describe` block, and then call `init` many times on that\n   * instance inside the individual tests. Spinning up a \"physical\" cache\n   * instance takes a considerable amount of time, slowing down tests. But\n   * wiping the contents of an instance using `init` is very fast.\n   */\n  static create(options?: {\n    ids?: TestCacheId[];\n    disableDocker?: boolean;\n  }): TestCaches {\n    const ids = options?.ids;\n    const disableDocker = options?.disableDocker ?? isDockerDisabledForTests();\n\n    let testCacheIds: TestCacheId[];\n    if (ids) {\n      testCacheIds = ids;\n    } else if (TestCaches.defaultIds) {\n      testCacheIds = TestCaches.defaultIds;\n    } else {\n      testCacheIds = Object.keys(allCaches) as TestCacheId[];\n    }\n\n    const supportedIds = testCacheIds.filter(id => {\n      const properties = allCaches[id];\n      if (!properties) {\n        return false;\n      }\n      // If the caller has set up the env with an explicit connection string,\n      // we'll assume that this target will work\n      if (\n        properties.connectionStringEnvironmentVariableName &&\n        process.env[properties.connectionStringEnvironmentVariableName]\n      ) {\n        return true;\n      }\n      // If the cache doesn't require docker at all, there's nothing to worry\n      // about\n      if (!properties.dockerImageName) {\n        return true;\n      }\n      // If the cache requires docker, but docker is disabled, we will fail.\n      if (disableDocker) {\n        return false;\n      }\n      return true;\n    });\n\n    const caches = new TestCaches(supportedIds);\n\n    if (supportedIds.length > 0) {\n      afterAll(async () => {\n        await caches.shutdown();\n      });\n    }\n\n    return caches;\n  }\n\n  static setDefaults(options: { ids?: TestCacheId[] }) {\n    TestCaches.defaultIds = options.ids;\n  }\n\n  private constructor(supportedIds: TestCacheId[]) {\n    this.instanceById = new Map();\n    this.supportedIds = supportedIds;\n  }\n\n  supports(id: TestCacheId): boolean {\n    return this.supportedIds.includes(id);\n  }\n\n  eachSupportedId(): [TestCacheId][] {\n    return this.supportedIds.map(id => [id]);\n  }\n\n  /**\n   * Returns a fresh, empty cache for the given driver.\n   *\n   * @param id - The ID of the cache to use, e.g. 'REDIS_7'\n   * @returns Cache connection properties\n   */\n  async init(\n    id: TestCacheId,\n  ): Promise<{ store: string; connection: string; keyv: Keyv }> {\n    const properties = allCaches[id];\n    if (!properties) {\n      const candidates = Object.keys(allCaches).join(', ');\n      throw new Error(\n        `Unknown test cache ${id}, possible values are ${candidates}`,\n      );\n    }\n    if (!this.supportedIds.includes(id)) {\n      const candidates = this.supportedIds.join(', ');\n      throw new Error(\n        `Unsupported test cache ${id} for this environment, possible values are ${candidates}`,\n      );\n    }\n\n    // Ensure that a testcontainers instance is up for this ID\n    let instance: Instance | undefined = this.instanceById.get(id);\n    if (!instance) {\n      instance = await this.initAny(properties);\n      this.instanceById.set(id, instance);\n    }\n\n    // Ensure that it's cleared of data from previous tests\n    await instance.keyv.clear();\n\n    return {\n      store: instance.store,\n      connection: instance.connection,\n      keyv: instance.keyv,\n    };\n  }\n\n  private async initAny(properties: TestCacheProperties): Promise<Instance> {\n    switch (properties.store) {\n      case 'memcache':\n        return this.initMemcached(properties);\n      case 'redis':\n        return this.initRedis(properties);\n      case 'memory':\n        return {\n          store: 'memory',\n          connection: 'memory',\n          keyv: new Keyv(),\n          stop: async () => {},\n        };\n      default:\n        throw new Error(`Unknown cache store '${properties.store}'`);\n    }\n  }\n\n  private async initMemcached(\n    properties: TestCacheProperties,\n  ): Promise<Instance> {\n    // Use the connection string if provided\n    const envVarName = properties.connectionStringEnvironmentVariableName;\n    if (envVarName) {\n      const connectionString = process.env[envVarName];\n      if (connectionString) {\n        return connectToExternalMemcache(connectionString);\n      }\n    }\n\n    return await startMemcachedContainer(properties.dockerImageName!);\n  }\n\n  private async initRedis(properties: TestCacheProperties): Promise<Instance> {\n    // Use the connection string if provided\n    const envVarName = properties.connectionStringEnvironmentVariableName;\n    if (envVarName) {\n      const connectionString = process.env[envVarName];\n      if (connectionString) {\n        return connectToExternalRedis(connectionString);\n      }\n    }\n\n    return await startRedisContainer(properties.dockerImageName!);\n  }\n\n  private async shutdown() {\n    const instances = [...this.instanceById.values()];\n    this.instanceById.clear();\n    await Promise.all(\n      instances.map(({ stop }) =>\n        stop().catch(error => {\n          console.warn(`TestCaches: Failed to stop container`, { error });\n        }),\n      ),\n    );\n  }\n}\n"],"names":["isDockerDisabledForTests","allCaches","Keyv","connectToExternalMemcache","startMemcachedContainer","connectToExternalRedis","startRedisContainer"],"mappings":";;;;;;;;;;;;AA4BO,MAAM,UAAW,CAAA;AAAA,EACL,YAAA,CAAA;AAAA,EACA,YAAA,CAAA;AAAA,EACjB,OAAe,UAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAYf,OAAO,OAAO,OAGC,EAAA;AACb,IAAA,MAAM,MAAM,OAAS,EAAA,GAAA,CAAA;AACrB,IAAM,MAAA,aAAA,GAAgB,OAAS,EAAA,aAAA,IAAiBA,iDAAyB,EAAA,CAAA;AAEzE,IAAI,IAAA,YAAA,CAAA;AACJ,IAAA,IAAI,GAAK,EAAA;AACP,MAAe,YAAA,GAAA,GAAA,CAAA;AAAA,KACjB,MAAA,IAAW,WAAW,UAAY,EAAA;AAChC,MAAA,YAAA,GAAe,UAAW,CAAA,UAAA,CAAA;AAAA,KACrB,MAAA;AACL,MAAe,YAAA,GAAA,MAAA,CAAO,KAAKC,eAAS,CAAA,CAAA;AAAA,KACtC;AAEA,IAAM,MAAA,YAAA,GAAe,YAAa,CAAA,MAAA,CAAO,CAAM,EAAA,KAAA;AAC7C,MAAM,MAAA,UAAA,GAAaA,gBAAU,EAAE,CAAA,CAAA;AAC/B,MAAA,IAAI,CAAC,UAAY,EAAA;AACf,QAAO,OAAA,KAAA,CAAA;AAAA,OACT;AAGA,MAAA,IACE,WAAW,uCACX,IAAA,OAAA,CAAQ,GAAI,CAAA,UAAA,CAAW,uCAAuC,CAC9D,EAAA;AACA,QAAO,OAAA,IAAA,CAAA;AAAA,OACT;AAGA,MAAI,IAAA,CAAC,WAAW,eAAiB,EAAA;AAC/B,QAAO,OAAA,IAAA,CAAA;AAAA,OACT;AAEA,MAAA,IAAI,aAAe,EAAA;AACjB,QAAO,OAAA,KAAA,CAAA;AAAA,OACT;AACA,MAAO,OAAA,IAAA,CAAA;AAAA,KACR,CAAA,CAAA;AAED,IAAM,MAAA,MAAA,GAAS,IAAI,UAAA,CAAW,YAAY,CAAA,CAAA;AAE1C,IAAI,IAAA,YAAA,CAAa,SAAS,CAAG,EAAA;AAC3B,MAAA,QAAA,CAAS,YAAY;AACnB,QAAA,MAAM,OAAO,QAAS,EAAA,CAAA;AAAA,OACvB,CAAA,CAAA;AAAA,KACH;AAEA,IAAO,OAAA,MAAA,CAAA;AAAA,GACT;AAAA,EAEA,OAAO,YAAY,OAAkC,EAAA;AACnD,IAAA,UAAA,CAAW,aAAa,OAAQ,CAAA,GAAA,CAAA;AAAA,GAClC;AAAA,EAEQ,YAAY,YAA6B,EAAA;AAC/C,IAAK,IAAA,CAAA,YAAA,uBAAmB,GAAI,EAAA,CAAA;AAC5B,IAAA,IAAA,CAAK,YAAe,GAAA,YAAA,CAAA;AAAA,GACtB;AAAA,EAEA,SAAS,EAA0B,EAAA;AACjC,IAAO,OAAA,IAAA,CAAK,YAAa,CAAA,QAAA,CAAS,EAAE,CAAA,CAAA;AAAA,GACtC;AAAA,EAEA,eAAmC,GAAA;AACjC,IAAA,OAAO,KAAK,YAAa,CAAA,GAAA,CAAI,CAAM,EAAA,KAAA,CAAC,EAAE,CAAC,CAAA,CAAA;AAAA,GACzC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAQA,MAAM,KACJ,EAC4D,EAAA;AAC5D,IAAM,MAAA,UAAA,GAAaA,gBAAU,EAAE,CAAA,CAAA;AAC/B,IAAA,IAAI,CAAC,UAAY,EAAA;AACf,MAAA,MAAM,aAAa,MAAO,CAAA,IAAA,CAAKA,eAAS,CAAA,CAAE,KAAK,IAAI,CAAA,CAAA;AACnD,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,mBAAA,EAAsB,EAAE,CAAA,sBAAA,EAAyB,UAAU,CAAA,CAAA;AAAA,OAC7D,CAAA;AAAA,KACF;AACA,IAAA,IAAI,CAAC,IAAA,CAAK,YAAa,CAAA,QAAA,CAAS,EAAE,CAAG,EAAA;AACnC,MAAA,MAAM,UAAa,GAAA,IAAA,CAAK,YAAa,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AAC9C,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,uBAAA,EAA0B,EAAE,CAAA,2CAAA,EAA8C,UAAU,CAAA,CAAA;AAAA,OACtF,CAAA;AAAA,KACF;AAGA,IAAA,IAAI,QAAiC,GAAA,IAAA,CAAK,YAAa,CAAA,GAAA,CAAI,EAAE,CAAA,CAAA;AAC7D,IAAA,IAAI,CAAC,QAAU,EAAA;AACb,MAAW,QAAA,GAAA,MAAM,IAAK,CAAA,OAAA,CAAQ,UAAU,CAAA,CAAA;AACxC,MAAK,IAAA,CAAA,YAAA,CAAa,GAAI,CAAA,EAAA,EAAI,QAAQ,CAAA,CAAA;AAAA,KACpC;AAGA,IAAM,MAAA,QAAA,CAAS,KAAK,KAAM,EAAA,CAAA;AAE1B,IAAO,OAAA;AAAA,MACL,OAAO,QAAS,CAAA,KAAA;AAAA,MAChB,YAAY,QAAS,CAAA,UAAA;AAAA,MACrB,MAAM,QAAS,CAAA,IAAA;AAAA,KACjB,CAAA;AAAA,GACF;AAAA,EAEA,MAAc,QAAQ,UAAoD,EAAA;AACxE,IAAA,QAAQ,WAAW,KAAO;AAAA,MACxB,KAAK,UAAA;AACH,QAAO,OAAA,IAAA,CAAK,cAAc,UAAU,CAAA,CAAA;AAAA,MACtC,KAAK,OAAA;AACH,QAAO,OAAA,IAAA,CAAK,UAAU,UAAU,CAAA,CAAA;AAAA,MAClC,KAAK,QAAA;AACH,QAAO,OAAA;AAAA,UACL,KAAO,EAAA,QAAA;AAAA,UACP,UAAY,EAAA,QAAA;AAAA,UACZ,IAAA,EAAM,IAAIC,qBAAK,EAAA;AAAA,UACf,MAAM,YAAY;AAAA,WAAC;AAAA,SACrB,CAAA;AAAA,MACF;AACE,QAAA,MAAM,IAAI,KAAA,CAAM,CAAwB,qBAAA,EAAA,UAAA,CAAW,KAAK,CAAG,CAAA,CAAA,CAAA,CAAA;AAAA,KAC/D;AAAA,GACF;AAAA,EAEA,MAAc,cACZ,UACmB,EAAA;AAEnB,IAAA,MAAM,aAAa,UAAW,CAAA,uCAAA,CAAA;AAC9B,IAAA,IAAI,UAAY,EAAA;AACd,MAAM,MAAA,gBAAA,GAAmB,OAAQ,CAAA,GAAA,CAAI,UAAU,CAAA,CAAA;AAC/C,MAAA,IAAI,gBAAkB,EAAA;AACpB,QAAA,OAAOC,mCAA0B,gBAAgB,CAAA,CAAA;AAAA,OACnD;AAAA,KACF;AAEA,IAAO,OAAA,MAAMC,gCAAwB,CAAA,UAAA,CAAW,eAAgB,CAAA,CAAA;AAAA,GAClE;AAAA,EAEA,MAAc,UAAU,UAAoD,EAAA;AAE1E,IAAA,MAAM,aAAa,UAAW,CAAA,uCAAA,CAAA;AAC9B,IAAA,IAAI,UAAY,EAAA;AACd,MAAM,MAAA,gBAAA,GAAmB,OAAQ,CAAA,GAAA,CAAI,UAAU,CAAA,CAAA;AAC/C,MAAA,IAAI,gBAAkB,EAAA;AACpB,QAAA,OAAOC,6BAAuB,gBAAgB,CAAA,CAAA;AAAA,OAChD;AAAA,KACF;AAEA,IAAO,OAAA,MAAMC,yBAAoB,CAAA,UAAA,CAAW,eAAgB,CAAA,CAAA;AAAA,GAC9D;AAAA,EAEA,MAAc,QAAW,GAAA;AACvB,IAAA,MAAM,YAAY,CAAC,GAAG,IAAK,CAAA,YAAA,CAAa,QAAQ,CAAA,CAAA;AAChD,IAAA,IAAA,CAAK,aAAa,KAAM,EAAA,CAAA;AACxB,IAAA,MAAM,OAAQ,CAAA,GAAA;AAAA,MACZ,SAAU,CAAA,GAAA;AAAA,QAAI,CAAC,EAAE,IAAA,OACf,IAAK,EAAA,CAAE,MAAM,CAAS,KAAA,KAAA;AACpB,UAAA,OAAA,CAAQ,IAAK,CAAA,CAAA,oCAAA,CAAA,EAAwC,EAAE,KAAA,EAAO,CAAA,CAAA;AAAA,SAC/D,CAAA;AAAA,OACH;AAAA,KACF,CAAA;AAAA,GACF;AACF;;;;"}

package/dist/cache/memcache.cjs.js

@@ -0,0 +1,62 @@
+'use strict';
+
+var Keyv = require('keyv');
+var KeyvMemcache = require('@keyv/memcache');
+var uuid = require('uuid');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var Keyv__default = /*#__PURE__*/_interopDefaultCompat(Keyv);
+var KeyvMemcache__default = /*#__PURE__*/_interopDefaultCompat(KeyvMemcache);
+
+async function attemptMemcachedConnection(connection) {
+  const startTime = Date.now();
+  for (; ; ) {
+    try {
+      const store = new KeyvMemcache__default.default(connection);
+      const keyv = new Keyv__default.default({ store });
+      const value = uuid.v4();
+      await keyv.set("test", value);
+      if (await keyv.get("test") === value) {
+        return keyv;
+      }
+    } catch (e) {
+      if (Date.now() - startTime > 3e4) {
+        throw new Error(
+          `Timed out waiting for memcached to be ready for connections, ${e}`
+        );
+      }
+    }
+    await new Promise((resolve) => setTimeout(resolve, 100));
+  }
+}
+async function connectToExternalMemcache(connection) {
+  const keyv = await attemptMemcachedConnection(connection);
+  return {
+    store: "memcache",
+    connection,
+    keyv,
+    stop: async () => await keyv.disconnect()
+  };
+}
+async function startMemcachedContainer(image) {
+  const { GenericContainer } = await import('testcontainers');
+  const container = await new GenericContainer(image).withExposedPorts(11211).start();
+  const host = container.getHost();
+  const port = container.getMappedPort(11211);
+  const connection = `${host}:${port}`;
+  const keyv = await attemptMemcachedConnection(connection);
+  return {
+    store: "memcache",
+    connection,
+    keyv,
+    stop: async () => {
+      await keyv.disconnect();
+      await container.stop({ timeout: 1e4 });
+    }
+  };
+}
+
+exports.connectToExternalMemcache = connectToExternalMemcache;
+exports.startMemcachedContainer = startMemcachedContainer;
+//# sourceMappingURL=memcache.cjs.js.map

package/dist/cache/memcache.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"memcache.cjs.js","sources":["../../src/cache/memcache.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport Keyv from 'keyv';\nimport KeyvMemcache from '@keyv/memcache';\nimport { v4 as uuid } from 'uuid';\nimport { Instance } from './types';\n\nasync function attemptMemcachedConnection(connection: string): Promise<Keyv> {\n  const startTime = Date.now();\n\n  for (;;) {\n    try {\n      const store = new KeyvMemcache(connection);\n      const keyv = new Keyv({ store });\n      const value = uuid();\n      await keyv.set('test', value);\n      if ((await keyv.get('test')) === value) {\n        return keyv;\n      }\n    } catch (e) {\n      if (Date.now() - startTime > 30_000) {\n        throw new Error(\n          `Timed out waiting for memcached to be ready for connections, ${e}`,\n        );\n      }\n    }\n\n    await new Promise(resolve => setTimeout(resolve, 100));\n  }\n}\n\nexport async function connectToExternalMemcache(\n  connection: string,\n): Promise<Instance> {\n  const keyv = await attemptMemcachedConnection(connection);\n  return {\n    store: 'memcache',\n    connection,\n    keyv,\n    stop: async () => await keyv.disconnect(),\n  };\n}\n\nexport async function startMemcachedContainer(\n  image: string,\n): Promise<Instance> {\n  // Lazy-load to avoid side-effect of importing testcontainers\n  const { GenericContainer } = await import('testcontainers');\n\n  const container = await new GenericContainer(image)\n    .withExposedPorts(11211)\n    .start();\n\n  const host = container.getHost();\n  const port = container.getMappedPort(11211);\n  const connection = `${host}:${port}`;\n\n  const keyv = await attemptMemcachedConnection(connection);\n\n  return {\n    store: 'memcache',\n    connection,\n    keyv,\n    stop: async () => {\n      await keyv.disconnect();\n      await container.stop({ timeout: 10_000 });\n    },\n  };\n}\n"],"names":["KeyvMemcache","Keyv","uuid"],"mappings":";;;;;;;;;;;AAqBA,eAAe,2BAA2B,UAAmC,EAAA;AAC3E,EAAM,MAAA,SAAA,GAAY,KAAK,GAAI,EAAA,CAAA;AAE3B,EAAS,WAAA;AACP,IAAI,IAAA;AACF,MAAM,MAAA,KAAA,GAAQ,IAAIA,6BAAA,CAAa,UAAU,CAAA,CAAA;AACzC,MAAA,MAAM,IAAO,GAAA,IAAIC,qBAAK,CAAA,EAAE,OAAO,CAAA,CAAA;AAC/B,MAAA,MAAM,QAAQC,OAAK,EAAA,CAAA;AACnB,MAAM,MAAA,IAAA,CAAK,GAAI,CAAA,MAAA,EAAQ,KAAK,CAAA,CAAA;AAC5B,MAAA,IAAK,MAAM,IAAA,CAAK,GAAI,CAAA,MAAM,MAAO,KAAO,EAAA;AACtC,QAAO,OAAA,IAAA,CAAA;AAAA,OACT;AAAA,aACO,CAAG,EAAA;AACV,MAAA,IAAI,IAAK,CAAA,GAAA,EAAQ,GAAA,SAAA,GAAY,GAAQ,EAAA;AACnC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,gEAAgE,CAAC,CAAA,CAAA;AAAA,SACnE,CAAA;AAAA,OACF;AAAA,KACF;AAEA,IAAA,MAAM,IAAI,OAAQ,CAAA,CAAA,OAAA,KAAW,UAAW,CAAA,OAAA,EAAS,GAAG,CAAC,CAAA,CAAA;AAAA,GACvD;AACF,CAAA;AAEA,eAAsB,0BACpB,UACmB,EAAA;AACnB,EAAM,MAAA,IAAA,GAAO,MAAM,0BAAA,CAA2B,UAAU,CAAA,CAAA;AACxD,EAAO,OAAA;AAAA,IACL,KAAO,EAAA,UAAA;AAAA,IACP,UAAA;AAAA,IACA,IAAA;AAAA,IACA,IAAM,EAAA,YAAY,MAAM,IAAA,CAAK,UAAW,EAAA;AAAA,GAC1C,CAAA;AACF,CAAA;AAEA,eAAsB,wBACpB,KACmB,EAAA;AAEnB,EAAA,MAAM,EAAE,gBAAA,EAAqB,GAAA,MAAM,OAAO,gBAAgB,CAAA,CAAA;AAE1D,EAAM,MAAA,SAAA,GAAY,MAAM,IAAI,gBAAA,CAAiB,KAAK,CAC/C,CAAA,gBAAA,CAAiB,KAAK,CAAA,CACtB,KAAM,EAAA,CAAA;AAET,EAAM,MAAA,IAAA,GAAO,UAAU,OAAQ,EAAA,CAAA;AAC/B,EAAM,MAAA,IAAA,GAAO,SAAU,CAAA,aAAA,CAAc,KAAK,CAAA,CAAA;AAC1C,EAAA,MAAM,UAAa,GAAA,CAAA,EAAG,IAAI,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,CAAA;AAElC,EAAM,MAAA,IAAA,GAAO,MAAM,0BAAA,CAA2B,UAAU,CAAA,CAAA;AAExD,EAAO,OAAA;AAAA,IACL,KAAO,EAAA,UAAA;AAAA,IACP,UAAA;AAAA,IACA,IAAA;AAAA,IACA,MAAM,YAAY;AAChB,MAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AACtB,MAAA,MAAM,SAAU,CAAA,IAAA,CAAK,EAAE,OAAA,EAAS,KAAQ,CAAA,CAAA;AAAA,KAC1C;AAAA,GACF,CAAA;AACF;;;;;"}

package/dist/cache/redis.cjs.js

@@ -0,0 +1,62 @@
+'use strict';
+
+var Keyv = require('keyv');
+var KeyvRedis = require('@keyv/redis');
+var uuid = require('uuid');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var Keyv__default = /*#__PURE__*/_interopDefaultCompat(Keyv);
+var KeyvRedis__default = /*#__PURE__*/_interopDefaultCompat(KeyvRedis);
+
+async function attemptRedisConnection(connection) {
+  const startTime = Date.now();
+  for (; ; ) {
+    try {
+      const store = new KeyvRedis__default.default(connection);
+      const keyv = new Keyv__default.default({ store });
+      const value = uuid.v4();
+      await keyv.set("test", value);
+      if (await keyv.get("test") === value) {
+        return keyv;
+      }
+    } catch (e) {
+      if (Date.now() - startTime > 3e4) {
+        throw new Error(
+          `Timed out waiting for redis to be ready for connections, ${e}`
+        );
+      }
+    }
+    await new Promise((resolve) => setTimeout(resolve, 100));
+  }
+}
+async function connectToExternalRedis(connection) {
+  const keyv = await attemptRedisConnection(connection);
+  return {
+    store: "redis",
+    connection,
+    keyv,
+    stop: async () => await keyv.disconnect()
+  };
+}
+async function startRedisContainer(image) {
+  const { GenericContainer } = await import('testcontainers');
+  const container = await new GenericContainer(image).withExposedPorts(6379).start();
+  const host = container.getHost();
+  const port = container.getMappedPort(6379);
+  const connection = `redis://${host}:${port}`;
+  const keyv = await attemptRedisConnection(connection);
+  return {
+    store: "redis",
+    connection,
+    keyv,
+    stop: async () => {
+      await keyv.disconnect();
+      await container.stop({ timeout: 1e4 });
+    }
+  };
+}
+
+exports.connectToExternalRedis = connectToExternalRedis;
+exports.startRedisContainer = startRedisContainer;
+//# sourceMappingURL=redis.cjs.js.map

package/dist/cache/redis.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"redis.cjs.js","sources":["../../src/cache/redis.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport Keyv from 'keyv';\nimport KeyvRedis from '@keyv/redis';\nimport { v4 as uuid } from 'uuid';\nimport { Instance } from './types';\n\nasync function attemptRedisConnection(connection: string): Promise<Keyv> {\n  const startTime = Date.now();\n\n  for (;;) {\n    try {\n      const store = new KeyvRedis(connection);\n      const keyv = new Keyv({ store });\n      const value = uuid();\n      await keyv.set('test', value);\n      if ((await keyv.get('test')) === value) {\n        return keyv;\n      }\n    } catch (e) {\n      if (Date.now() - startTime > 30_000) {\n        throw new Error(\n          `Timed out waiting for redis to be ready for connections, ${e}`,\n        );\n      }\n    }\n\n    await new Promise(resolve => setTimeout(resolve, 100));\n  }\n}\n\nexport async function connectToExternalRedis(\n  connection: string,\n): Promise<Instance> {\n  const keyv = await attemptRedisConnection(connection);\n  return {\n    store: 'redis',\n    connection,\n    keyv,\n    stop: async () => await keyv.disconnect(),\n  };\n}\n\nexport async function startRedisContainer(image: string): Promise<Instance> {\n  // Lazy-load to avoid side-effect of importing testcontainers\n  const { GenericContainer } = await import('testcontainers');\n\n  const container = await new GenericContainer(image)\n    .withExposedPorts(6379)\n    .start();\n\n  const host = container.getHost();\n  const port = container.getMappedPort(6379);\n  const connection = `redis://${host}:${port}`;\n\n  const keyv = await attemptRedisConnection(connection);\n\n  return {\n    store: 'redis',\n    connection,\n    keyv,\n    stop: async () => {\n      await keyv.disconnect();\n      await container.stop({ timeout: 10_000 });\n    },\n  };\n}\n"],"names":["KeyvRedis","Keyv","uuid"],"mappings":";;;;;;;;;;;AAqBA,eAAe,uBAAuB,UAAmC,EAAA;AACvE,EAAM,MAAA,SAAA,GAAY,KAAK,GAAI,EAAA,CAAA;AAE3B,EAAS,WAAA;AACP,IAAI,IAAA;AACF,MAAM,MAAA,KAAA,GAAQ,IAAIA,0BAAA,CAAU,UAAU,CAAA,CAAA;AACtC,MAAA,MAAM,IAAO,GAAA,IAAIC,qBAAK,CAAA,EAAE,OAAO,CAAA,CAAA;AAC/B,MAAA,MAAM,QAAQC,OAAK,EAAA,CAAA;AACnB,MAAM,MAAA,IAAA,CAAK,GAAI,CAAA,MAAA,EAAQ,KAAK,CAAA,CAAA;AAC5B,MAAA,IAAK,MAAM,IAAA,CAAK,GAAI,CAAA,MAAM,MAAO,KAAO,EAAA;AACtC,QAAO,OAAA,IAAA,CAAA;AAAA,OACT;AAAA,aACO,CAAG,EAAA;AACV,MAAA,IAAI,IAAK,CAAA,GAAA,EAAQ,GAAA,SAAA,GAAY,GAAQ,EAAA;AACnC,QAAA,MAAM,IAAI,KAAA;AAAA,UACR,4DAA4D,CAAC,CAAA,CAAA;AAAA,SAC/D,CAAA;AAAA,OACF;AAAA,KACF;AAEA,IAAA,MAAM,IAAI,OAAQ,CAAA,CAAA,OAAA,KAAW,UAAW,CAAA,OAAA,EAAS,GAAG,CAAC,CAAA,CAAA;AAAA,GACvD;AACF,CAAA;AAEA,eAAsB,uBACpB,UACmB,EAAA;AACnB,EAAM,MAAA,IAAA,GAAO,MAAM,sBAAA,CAAuB,UAAU,CAAA,CAAA;AACpD,EAAO,OAAA;AAAA,IACL,KAAO,EAAA,OAAA;AAAA,IACP,UAAA;AAAA,IACA,IAAA;AAAA,IACA,IAAM,EAAA,YAAY,MAAM,IAAA,CAAK,UAAW,EAAA;AAAA,GAC1C,CAAA;AACF,CAAA;AAEA,eAAsB,oBAAoB,KAAkC,EAAA;AAE1E,EAAA,MAAM,EAAE,gBAAA,EAAqB,GAAA,MAAM,OAAO,gBAAgB,CAAA,CAAA;AAE1D,EAAM,MAAA,SAAA,GAAY,MAAM,IAAI,gBAAA,CAAiB,KAAK,CAC/C,CAAA,gBAAA,CAAiB,IAAI,CAAA,CACrB,KAAM,EAAA,CAAA;AAET,EAAM,MAAA,IAAA,GAAO,UAAU,OAAQ,EAAA,CAAA;AAC/B,EAAM,MAAA,IAAA,GAAO,SAAU,CAAA,aAAA,CAAc,IAAI,CAAA,CAAA;AACzC,EAAA,MAAM,UAAa,GAAA,CAAA,QAAA,EAAW,IAAI,CAAA,CAAA,EAAI,IAAI,CAAA,CAAA,CAAA;AAE1C,EAAM,MAAA,IAAA,GAAO,MAAM,sBAAA,CAAuB,UAAU,CAAA,CAAA;AAEpD,EAAO,OAAA;AAAA,IACL,KAAO,EAAA,OAAA;AAAA,IACP,UAAA;AAAA,IACA,IAAA;AAAA,IACA,MAAM,YAAY;AAChB,MAAA,MAAM,KAAK,UAAW,EAAA,CAAA;AACtB,MAAA,MAAM,SAAU,CAAA,IAAA,CAAK,EAAE,OAAA,EAAS,KAAQ,CAAA,CAAA;AAAA,KAC1C;AAAA,GACF,CAAA;AACF;;;;;"}

package/dist/cache/types.cjs.js

@@ -0,0 +1,25 @@
+'use strict';
+
+var getDockerImageForName = require('../util/getDockerImageForName.cjs.js');
+
+const allCaches = Object.freeze({
+  REDIS_7: {
+    name: "Redis 7.x",
+    store: "redis",
+    dockerImageName: getDockerImageForName.getDockerImageForName("redis:7"),
+    connectionStringEnvironmentVariableName: "BACKSTAGE_TEST_CACHE_REDIS7_CONNECTION_STRING"
+  },
+  MEMCACHED_1: {
+    name: "Memcached 1.x",
+    store: "memcache",
+    dockerImageName: getDockerImageForName.getDockerImageForName("memcached:1"),
+    connectionStringEnvironmentVariableName: "BACKSTAGE_TEST_CACHE_MEMCACHED1_CONNECTION_STRING"
+  },
+  MEMORY: {
+    name: "In-memory",
+    store: "memory"
+  }
+});
+
+exports.allCaches = allCaches;
+//# sourceMappingURL=types.cjs.js.map

package/dist/cache/types.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs.js","sources":["../../src/cache/types.ts"],"sourcesContent":["/*\n * Copyright 2024 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport Keyv from 'keyv';\nimport { getDockerImageForName } from '../util/getDockerImageForName';\n\n/**\n * The possible caches to test against.\n *\n * @public\n */\nexport type TestCacheId = 'MEMORY' | 'REDIS_7' | 'MEMCACHED_1';\n\nexport type TestCacheProperties = {\n  name: string;\n  store: string;\n  dockerImageName?: string;\n  connectionStringEnvironmentVariableName?: string;\n};\n\nexport type Instance = {\n  store: string;\n  connection: string;\n  keyv: Keyv;\n  stop: () => Promise<void>;\n};\n\nexport const allCaches: Record<TestCacheId, TestCacheProperties> =\n  Object.freeze({\n    REDIS_7: {\n      name: 'Redis 7.x',\n      store: 'redis',\n      dockerImageName: getDockerImageForName('redis:7'),\n      connectionStringEnvironmentVariableName:\n        'BACKSTAGE_TEST_CACHE_REDIS7_CONNECTION_STRING',\n    },\n    MEMCACHED_1: {\n      name: 'Memcached 1.x',\n      store: 'memcache',\n      dockerImageName: getDockerImageForName('memcached:1'),\n      connectionStringEnvironmentVariableName:\n        'BACKSTAGE_TEST_CACHE_MEMCACHED1_CONNECTION_STRING',\n    },\n    MEMORY: {\n      name: 'In-memory',\n      store: 'memory',\n    },\n  });\n"],"names":["getDockerImageForName"],"mappings":";;;;AAwCa,MAAA,SAAA,GACX,OAAO,MAAO,CAAA;AAAA,EACZ,OAAS,EAAA;AAAA,IACP,IAAM,EAAA,WAAA;AAAA,IACN,KAAO,EAAA,OAAA;AAAA,IACP,eAAA,EAAiBA,4CAAsB,SAAS,CAAA;AAAA,IAChD,uCACE,EAAA,+CAAA;AAAA,GACJ;AAAA,EACA,WAAa,EAAA;AAAA,IACX,IAAM,EAAA,eAAA;AAAA,IACN,KAAO,EAAA,UAAA;AAAA,IACP,eAAA,EAAiBA,4CAAsB,aAAa,CAAA;AAAA,IACpD,uCACE,EAAA,mDAAA;AAAA,GACJ;AAAA,EACA,MAAQ,EAAA;AAAA,IACN,IAAM,EAAA,WAAA;AAAA,IACN,KAAO,EAAA,QAAA;AAAA,GACT;AACF,CAAC;;;;"}

package/dist/database/TestDatabases.cjs.js

@@ -0,0 +1,128 @@
+'use strict';
+
+var isDockerDisabledForTests = require('../util/isDockerDisabledForTests.cjs.js');
+var mysql = require('./mysql.cjs.js');
+var postgres = require('./postgres.cjs.js');
+var sqlite = require('./sqlite.cjs.js');
+var types = require('./types.cjs.js');
+
+class TestDatabases {
+  engineFactoryByDriver = {
+    pg: postgres.PostgresEngine.create,
+    mysql: mysql.MysqlEngine.create,
+    mysql2: mysql.MysqlEngine.create,
+    "better-sqlite3": sqlite.SqliteEngine.create,
+    sqlite3: sqlite.SqliteEngine.create
+  };
+  engineByTestDatabaseId;
+  supportedIds;
+  static defaultIds;
+  /**
+   * Creates an empty `TestDatabases` instance, and sets up Jest to clean up
+   * all of its acquired resources after all tests finish.
+   *
+   * You typically want to create just a single instance like this at the top
+   * of your test file or `describe` block, and then call `init` many times on
+   * that instance inside the individual tests. Spinning up a "physical"
+   * database instance takes a considerable amount of time, slowing down tests.
+   * But initializing a new logical database inside that instance using `init`
+   * is very fast.
+   */
+  static create(options) {
+    const ids = options?.ids;
+    const disableDocker = options?.disableDocker ?? isDockerDisabledForTests.isDockerDisabledForTests();
+    let testDatabaseIds;
+    if (ids) {
+      testDatabaseIds = ids;
+    } else if (TestDatabases.defaultIds) {
+      testDatabaseIds = TestDatabases.defaultIds;
+    } else {
+      testDatabaseIds = Object.keys(types.allDatabases);
+    }
+    const supportedIds = testDatabaseIds.filter((id) => {
+      const properties = types.allDatabases[id];
+      if (!properties) {
+        return false;
+      }
+      if (properties.connectionStringEnvironmentVariableName && process.env[properties.connectionStringEnvironmentVariableName]) {
+        return true;
+      }
+      if (!properties.dockerImageName) {
+        return true;
+      }
+      if (disableDocker) {
+        return false;
+      }
+      return true;
+    });
+    const databases = new TestDatabases(supportedIds);
+    if (supportedIds.length > 0) {
+      afterAll(async () => {
+        await databases.shutdown();
+      });
+    }
+    return databases;
+  }
+  static setDefaults(options) {
+    TestDatabases.defaultIds = options.ids;
+  }
+  constructor(supportedIds) {
+    this.engineByTestDatabaseId = /* @__PURE__ */ new Map();
+    this.supportedIds = supportedIds;
+  }
+  supports(id) {
+    return this.supportedIds.includes(id);
+  }
+  eachSupportedId() {
+    return this.supportedIds.map((id) => [id]);
+  }
+  /**
+   * Returns a fresh, unique, empty logical database on an instance of the
+   * given database ID platform.
+   *
+   * @param id - The ID of the database platform to use, e.g. 'POSTGRES_13'
+   * @returns A `Knex` connection object
+   */
+  async init(id) {
+    const properties = types.allDatabases[id];
+    if (!properties) {
+      const candidates = Object.keys(types.allDatabases).join(", ");
+      throw new Error(
+        `Unknown test database ${id}, possible values are ${candidates}`
+      );
+    }
+    if (!this.supportedIds.includes(id)) {
+      const candidates = this.supportedIds.join(", ");
+      throw new Error(
+        `Unsupported test database ${id} for this environment, possible values are ${candidates}`
+      );
+    }
+    let engine = this.engineByTestDatabaseId.get(id);
+    if (!engine) {
+      const factory = this.engineFactoryByDriver[properties.driver];
+      if (!factory) {
+        throw new Error(`Unknown database driver ${properties.driver}`);
+      }
+      engine = await factory(properties);
+      this.engineByTestDatabaseId.set(id, engine);
+    }
+    return await engine.createDatabaseInstance();
+  }
+  async shutdown() {
+    const engines = [...this.engineByTestDatabaseId.values()];
+    this.engineByTestDatabaseId.clear();
+    for (const engine of engines) {
+      try {
+        await engine.shutdown();
+      } catch (error) {
+        console.warn(`TestDatabases: Failed to shutdown engine`, {
+          engine,
+          error
+        });
+      }
+    }
+  }
+}
+
+exports.TestDatabases = TestDatabases;
+//# sourceMappingURL=TestDatabases.cjs.js.map

package/dist/database/TestDatabases.cjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"TestDatabases.cjs.js","sources":["../../src/database/TestDatabases.ts"],"sourcesContent":["/*\n * Copyright 2021 The Backstage Authors\n *\n * Licensed under the Apache License, Version 2.0 (the \"License\");\n * you may not use this file except in compliance with the License.\n * You may obtain a copy of the License at\n *\n *     http://www.apache.org/licenses/LICENSE-2.0\n *\n * Unless required by applicable law or agreed to in writing, software\n * distributed under the License is distributed on an \"AS IS\" BASIS,\n * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\n * See the License for the specific language governing permissions and\n * limitations under the License.\n */\n\nimport { Knex } from 'knex';\nimport { isDockerDisabledForTests } from '../util/isDockerDisabledForTests';\nimport { MysqlEngine } from './mysql';\nimport { PostgresEngine } from './postgres';\nimport { SqliteEngine } from './sqlite';\nimport {\n  Engine,\n  TestDatabaseId,\n  TestDatabaseProperties,\n  allDatabases,\n} from './types';\n\n/**\n * Encapsulates the creation of ephemeral test database instances for use\n * inside unit or integration tests.\n *\n * @public\n */\nexport class TestDatabases {\n  private readonly engineFactoryByDriver: Record<\n    string,\n    (properties: TestDatabaseProperties) => Promise<Engine>\n  > = {\n    pg: PostgresEngine.create,\n    mysql: MysqlEngine.create,\n    mysql2: MysqlEngine.create,\n    'better-sqlite3': SqliteEngine.create,\n    sqlite3: SqliteEngine.create,\n  };\n  private readonly engineByTestDatabaseId: Map<string, Engine>;\n  private readonly supportedIds: TestDatabaseId[];\n  private static defaultIds?: TestDatabaseId[];\n\n  /**\n   * Creates an empty `TestDatabases` instance, and sets up Jest to clean up\n   * all of its acquired resources after all tests finish.\n   *\n   * You typically want to create just a single instance like this at the top\n   * of your test file or `describe` block, and then call `init` many times on\n   * that instance inside the individual tests. Spinning up a \"physical\"\n   * database instance takes a considerable amount of time, slowing down tests.\n   * But initializing a new logical database inside that instance using `init`\n   * is very fast.\n   */\n  static create(options?: {\n    ids?: TestDatabaseId[];\n    disableDocker?: boolean;\n  }): TestDatabases {\n    const ids = options?.ids;\n    const disableDocker = options?.disableDocker ?? isDockerDisabledForTests();\n\n    let testDatabaseIds: TestDatabaseId[];\n    if (ids) {\n      testDatabaseIds = ids;\n    } else if (TestDatabases.defaultIds) {\n      testDatabaseIds = TestDatabases.defaultIds;\n    } else {\n      testDatabaseIds = Object.keys(allDatabases) as TestDatabaseId[];\n    }\n\n    const supportedIds = testDatabaseIds.filter(id => {\n      const properties = allDatabases[id];\n      if (!properties) {\n        return false;\n      }\n      // If the caller has set up the env with an explicit connection string,\n      // we'll assume that this database will work\n      if (\n        properties.connectionStringEnvironmentVariableName &&\n        process.env[properties.connectionStringEnvironmentVariableName]\n      ) {\n        return true;\n      }\n      // If the database doesn't require docker at all, there's nothing to worry\n      // about\n      if (!properties.dockerImageName) {\n        return true;\n      }\n      // If the database requires docker, but docker is disabled, we will fail.\n      if (disableDocker) {\n        return false;\n      }\n      return true;\n    });\n\n    const databases = new TestDatabases(supportedIds);\n\n    if (supportedIds.length > 0) {\n      afterAll(async () => {\n        await databases.shutdown();\n      });\n    }\n\n    return databases;\n  }\n\n  static setDefaults(options: { ids?: TestDatabaseId[] }) {\n    TestDatabases.defaultIds = options.ids;\n  }\n\n  private constructor(supportedIds: TestDatabaseId[]) {\n    this.engineByTestDatabaseId = new Map();\n    this.supportedIds = supportedIds;\n  }\n\n  supports(id: TestDatabaseId): boolean {\n    return this.supportedIds.includes(id);\n  }\n\n  eachSupportedId(): [TestDatabaseId][] {\n    return this.supportedIds.map(id => [id]);\n  }\n\n  /**\n   * Returns a fresh, unique, empty logical database on an instance of the\n   * given database ID platform.\n   *\n   * @param id - The ID of the database platform to use, e.g. 'POSTGRES_13'\n   * @returns A `Knex` connection object\n   */\n  async init(id: TestDatabaseId): Promise<Knex> {\n    const properties = allDatabases[id];\n    if (!properties) {\n      const candidates = Object.keys(allDatabases).join(', ');\n      throw new Error(\n        `Unknown test database ${id}, possible values are ${candidates}`,\n      );\n    }\n    if (!this.supportedIds.includes(id)) {\n      const candidates = this.supportedIds.join(', ');\n      throw new Error(\n        `Unsupported test database ${id} for this environment, possible values are ${candidates}`,\n      );\n    }\n\n    let engine = this.engineByTestDatabaseId.get(id);\n    if (!engine) {\n      const factory = this.engineFactoryByDriver[properties.driver];\n      if (!factory) {\n        throw new Error(`Unknown database driver ${properties.driver}`);\n      }\n      engine = await factory(properties);\n      this.engineByTestDatabaseId.set(id, engine);\n    }\n\n    return await engine.createDatabaseInstance();\n  }\n\n  private async shutdown() {\n    const engines = [...this.engineByTestDatabaseId.values()];\n    this.engineByTestDatabaseId.clear();\n\n    for (const engine of engines) {\n      try {\n        await engine.shutdown();\n      } catch (error) {\n        console.warn(`TestDatabases: Failed to shutdown engine`, {\n          engine,\n          error,\n        });\n      }\n    }\n  }\n}\n"],"names":["PostgresEngine","MysqlEngine","SqliteEngine","isDockerDisabledForTests","allDatabases"],"mappings":";;;;;;;;AAkCO,MAAM,aAAc,CAAA;AAAA,EACR,qBAGb,GAAA;AAAA,IACF,IAAIA,uBAAe,CAAA,MAAA;AAAA,IACnB,OAAOC,iBAAY,CAAA,MAAA;AAAA,IACnB,QAAQA,iBAAY,CAAA,MAAA;AAAA,IACpB,kBAAkBC,mBAAa,CAAA,MAAA;AAAA,IAC/B,SAASA,mBAAa,CAAA,MAAA;AAAA,GACxB,CAAA;AAAA,EACiB,sBAAA,CAAA;AAAA,EACA,YAAA,CAAA;AAAA,EACjB,OAAe,UAAA,CAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EAaf,OAAO,OAAO,OAGI,EAAA;AAChB,IAAA,MAAM,MAAM,OAAS,EAAA,GAAA,CAAA;AACrB,IAAM,MAAA,aAAA,GAAgB,OAAS,EAAA,aAAA,IAAiBC,iDAAyB,EAAA,CAAA;AAEzE,IAAI,IAAA,eAAA,CAAA;AACJ,IAAA,IAAI,GAAK,EAAA;AACP,MAAkB,eAAA,GAAA,GAAA,CAAA;AAAA,KACpB,MAAA,IAAW,cAAc,UAAY,EAAA;AACnC,MAAA,eAAA,GAAkB,aAAc,CAAA,UAAA,CAAA;AAAA,KAC3B,MAAA;AACL,MAAkB,eAAA,GAAA,MAAA,CAAO,KAAKC,kBAAY,CAAA,CAAA;AAAA,KAC5C;AAEA,IAAM,MAAA,YAAA,GAAe,eAAgB,CAAA,MAAA,CAAO,CAAM,EAAA,KAAA;AAChD,MAAM,MAAA,UAAA,GAAaA,mBAAa,EAAE,CAAA,CAAA;AAClC,MAAA,IAAI,CAAC,UAAY,EAAA;AACf,QAAO,OAAA,KAAA,CAAA;AAAA,OACT;AAGA,MAAA,IACE,WAAW,uCACX,IAAA,OAAA,CAAQ,GAAI,CAAA,UAAA,CAAW,uCAAuC,CAC9D,EAAA;AACA,QAAO,OAAA,IAAA,CAAA;AAAA,OACT;AAGA,MAAI,IAAA,CAAC,WAAW,eAAiB,EAAA;AAC/B,QAAO,OAAA,IAAA,CAAA;AAAA,OACT;AAEA,MAAA,IAAI,aAAe,EAAA;AACjB,QAAO,OAAA,KAAA,CAAA;AAAA,OACT;AACA,MAAO,OAAA,IAAA,CAAA;AAAA,KACR,CAAA,CAAA;AAED,IAAM,MAAA,SAAA,GAAY,IAAI,aAAA,CAAc,YAAY,CAAA,CAAA;AAEhD,IAAI,IAAA,YAAA,CAAa,SAAS,CAAG,EAAA;AAC3B,MAAA,QAAA,CAAS,YAAY;AACnB,QAAA,MAAM,UAAU,QAAS,EAAA,CAAA;AAAA,OAC1B,CAAA,CAAA;AAAA,KACH;AAEA,IAAO,OAAA,SAAA,CAAA;AAAA,GACT;AAAA,EAEA,OAAO,YAAY,OAAqC,EAAA;AACtD,IAAA,aAAA,CAAc,aAAa,OAAQ,CAAA,GAAA,CAAA;AAAA,GACrC;AAAA,EAEQ,YAAY,YAAgC,EAAA;AAClD,IAAK,IAAA,CAAA,sBAAA,uBAA6B,GAAI,EAAA,CAAA;AACtC,IAAA,IAAA,CAAK,YAAe,GAAA,YAAA,CAAA;AAAA,GACtB;AAAA,EAEA,SAAS,EAA6B,EAAA;AACpC,IAAO,OAAA,IAAA,CAAK,YAAa,CAAA,QAAA,CAAS,EAAE,CAAA,CAAA;AAAA,GACtC;AAAA,EAEA,eAAsC,GAAA;AACpC,IAAA,OAAO,KAAK,YAAa,CAAA,GAAA,CAAI,CAAM,EAAA,KAAA,CAAC,EAAE,CAAC,CAAA,CAAA;AAAA,GACzC;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,EASA,MAAM,KAAK,EAAmC,EAAA;AAC5C,IAAM,MAAA,UAAA,GAAaA,mBAAa,EAAE,CAAA,CAAA;AAClC,IAAA,IAAI,CAAC,UAAY,EAAA;AACf,MAAA,MAAM,aAAa,MAAO,CAAA,IAAA,CAAKA,kBAAY,CAAA,CAAE,KAAK,IAAI,CAAA,CAAA;AACtD,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,sBAAA,EAAyB,EAAE,CAAA,sBAAA,EAAyB,UAAU,CAAA,CAAA;AAAA,OAChE,CAAA;AAAA,KACF;AACA,IAAA,IAAI,CAAC,IAAA,CAAK,YAAa,CAAA,QAAA,CAAS,EAAE,CAAG,EAAA;AACnC,MAAA,MAAM,UAAa,GAAA,IAAA,CAAK,YAAa,CAAA,IAAA,CAAK,IAAI,CAAA,CAAA;AAC9C,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,0BAAA,EAA6B,EAAE,CAAA,2CAAA,EAA8C,UAAU,CAAA,CAAA;AAAA,OACzF,CAAA;AAAA,KACF;AAEA,IAAA,IAAI,MAAS,GAAA,IAAA,CAAK,sBAAuB,CAAA,GAAA,CAAI,EAAE,CAAA,CAAA;AAC/C,IAAA,IAAI,CAAC,MAAQ,EAAA;AACX,MAAA,MAAM,OAAU,GAAA,IAAA,CAAK,qBAAsB,CAAA,UAAA,CAAW,MAAM,CAAA,CAAA;AAC5D,MAAA,IAAI,CAAC,OAAS,EAAA;AACZ,QAAA,MAAM,IAAI,KAAA,CAAM,CAA2B,wBAAA,EAAA,UAAA,CAAW,MAAM,CAAE,CAAA,CAAA,CAAA;AAAA,OAChE;AACA,MAAS,MAAA,GAAA,MAAM,QAAQ,UAAU,CAAA,CAAA;AACjC,MAAK,IAAA,CAAA,sBAAA,CAAuB,GAAI,CAAA,EAAA,EAAI,MAAM,CAAA,CAAA;AAAA,KAC5C;AAEA,IAAO,OAAA,MAAM,OAAO,sBAAuB,EAAA,CAAA;AAAA,GAC7C;AAAA,EAEA,MAAc,QAAW,GAAA;AACvB,IAAA,MAAM,UAAU,CAAC,GAAG,IAAK,CAAA,sBAAA,CAAuB,QAAQ,CAAA,CAAA;AACxD,IAAA,IAAA,CAAK,uBAAuB,KAAM,EAAA,CAAA;AAElC,IAAA,KAAA,MAAW,UAAU,OAAS,EAAA;AAC5B,MAAI,IAAA;AACF,QAAA,MAAM,OAAO,QAAS,EAAA,CAAA;AAAA,eACf,KAAO,EAAA;AACd,QAAA,OAAA,CAAQ,KAAK,CAA4C,wCAAA,CAAA,EAAA;AAAA,UACvD,MAAA;AAAA,UACA,KAAA;AAAA,SACD,CAAA,CAAA;AAAA,OACH;AAAA,KACF;AAAA,GACF;AACF;;;;"}