@backstage/backend-test-utils 1.0.1-next.0 → 1.0.1-next.2

package/dist/database/mysql.cjs.js

@@ -0,0 +1,188 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var crypto = require('crypto');
+var knexFactory = require('knex');
+var uuid = require('uuid');
+var yn = require('yn');
+var types = require('./types.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var knexFactory__default = /*#__PURE__*/_interopDefaultCompat(knexFactory);
+var yn__default = /*#__PURE__*/_interopDefaultCompat(yn);
+
+async function waitForMysqlReady(connection) {
+  const startTime = Date.now();
+  let lastError;
+  let attempts = 0;
+  for (; ; ) {
+    attempts += 1;
+    let knex;
+    try {
+      knex = knexFactory__default.default({
+        client: "mysql2",
+        connection: {
+          // make a copy because the driver mutates this
+          ...connection
+        }
+      });
+      const result = await knex.select(knex.raw("version() AS version"));
+      if (Array.isArray(result) && result[0]?.version) {
+        return;
+      }
+    } catch (e) {
+      lastError = e;
+    } finally {
+      await knex?.destroy();
+    }
+    if (Date.now() - startTime > 3e4) {
+      throw new Error(
+        `Timed out waiting for the database to be ready for connections, ${attempts} attempts, ${lastError ? `last error was ${errors.stringifyError(lastError)}` : "(no errors thrown)"}`
+      );
+    }
+    await new Promise((resolve) => setTimeout(resolve, 100));
+  }
+}
+async function startMysqlContainer(image) {
+  const user = "root";
+  const password = uuid.v4();
+  const { GenericContainer } = await import('testcontainers');
+  const container = await new GenericContainer(image).withExposedPorts(3306).withEnvironment({ MYSQL_ROOT_PASSWORD: password }).withTmpFs({ "/var/lib/mysql": "rw" }).start();
+  const host = container.getHost();
+  const port = container.getMappedPort(3306);
+  const connection = { host, port, user, password };
+  const stopContainer = async () => {
+    await container.stop({ timeout: 1e4 });
+  };
+  await waitForMysqlReady(connection);
+  return { connection, stopContainer };
+}
+function parseMysqlConnectionString(connectionString) {
+  try {
+    const {
+      protocol,
+      username,
+      password,
+      port,
+      hostname,
+      pathname,
+      searchParams
+    } = new URL(connectionString);
+    if (protocol !== "mysql:") {
+      throw new Error(`Unknown protocol ${protocol}`);
+    } else if (!username || !password) {
+      throw new Error(`Missing username/password`);
+    } else if (!pathname.match(/^\/[^/]+$/)) {
+      throw new Error(`Expected single path segment`);
+    }
+    const result = {
+      user: username,
+      password,
+      host: hostname,
+      port: Number(port || 3306),
+      database: decodeURIComponent(pathname.substring(1))
+    };
+    const ssl = searchParams.get("ssl");
+    if (ssl) {
+      result.ssl = ssl;
+    }
+    const debug = searchParams.get("debug");
+    if (debug) {
+      result.debug = yn__default.default(debug);
+    }
+    return result;
+  } catch (e) {
+    throw new Error(`Error while parsing MySQL connection string, ${e}`, e);
+  }
+}
+class MysqlEngine {
+  static async create(properties) {
+    const { connectionStringEnvironmentVariableName, dockerImageName } = properties;
+    if (connectionStringEnvironmentVariableName) {
+      const connectionString = process.env[connectionStringEnvironmentVariableName];
+      if (connectionString) {
+        const connection = parseMysqlConnectionString(connectionString);
+        return new MysqlEngine(
+          properties,
+          connection
+        );
+      }
+    }
+    if (dockerImageName) {
+      const { connection, stopContainer } = await startMysqlContainer(
+        dockerImageName
+      );
+      return new MysqlEngine(properties, connection, stopContainer);
+    }
+    throw new Error(`Test databasee for ${properties.name} not configured`);
+  }
+  #properties;
+  #connection;
+  #knexInstances;
+  #databaseNames;
+  #stopContainer;
+  constructor(properties, connection, stopContainer) {
+    this.#properties = properties;
+    this.#connection = connection;
+    this.#knexInstances = [];
+    this.#databaseNames = [];
+    this.#stopContainer = stopContainer;
+  }
+  async createDatabaseInstance() {
+    const adminConnection = this.#connectAdmin();
+    try {
+      const databaseName = `db${crypto.randomBytes(16).toString("hex")}`;
+      await adminConnection.raw("CREATE DATABASE ??", [databaseName]);
+      this.#databaseNames.push(databaseName);
+      const knexInstance = knexFactory__default.default({
+        client: this.#properties.driver,
+        connection: {
+          ...this.#connection,
+          database: databaseName
+        },
+        ...types.LARGER_POOL_CONFIG
+      });
+      this.#knexInstances.push(knexInstance);
+      return knexInstance;
+    } finally {
+      await adminConnection.destroy();
+    }
+  }
+  async shutdown() {
+    for (const instance of this.#knexInstances) {
+      await instance.destroy();
+    }
+    const adminConnection = this.#connectAdmin();
+    try {
+      for (const databaseName of this.#databaseNames) {
+        await adminConnection.raw("DROP DATABASE ??", [databaseName]);
+      }
+    } finally {
+      await adminConnection.destroy();
+    }
+    await this.#stopContainer?.();
+  }
+  #connectAdmin() {
+    const connection = {
+      ...this.#connection,
+      database: null
+    };
+    return knexFactory__default.default({
+      client: this.#properties.driver,
+      connection,
+      pool: {
+        min: 0,
+        max: 1,
+        acquireTimeoutMillis: 2e4,
+        createTimeoutMillis: 2e4,
+        createRetryIntervalMillis: 1e3
+      }
+    });
+  }
+}
+
+exports.MysqlEngine = MysqlEngine;
+exports.parseMysqlConnectionString = parseMysqlConnectionString;
+exports.startMysqlContainer = startMysqlContainer;
+//# sourceMappingURL=mysql.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"mysql.cjs.js","sources":["../../src/database/mysql.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 { stringifyError } from '@backstage/errors';\nimport { randomBytes } from 'crypto';\nimport knexFactory, { Knex } from 'knex';\nimport { v4 as uuid } from 'uuid';\nimport yn from 'yn';\nimport { Engine, LARGER_POOL_CONFIG, TestDatabaseProperties } from './types';\n\nasync function waitForMysqlReady(\n  connection: Knex.MySqlConnectionConfig,\n): Promise<void> {\n  const startTime = Date.now();\n\n  let lastError: Error | undefined;\n  let attempts = 0;\n  for (;;) {\n    attempts += 1;\n\n    let knex: Knex | undefined;\n    try {\n      knex = knexFactory({\n        client: 'mysql2',\n        connection: {\n          // make a copy because the driver mutates this\n          ...connection,\n        },\n      });\n      const result = await knex.select(knex.raw('version() AS version'));\n      if (Array.isArray(result) && result[0]?.version) {\n        return;\n      }\n    } catch (e) {\n      lastError = e;\n    } finally {\n      await knex?.destroy();\n    }\n\n    if (Date.now() - startTime > 30_000) {\n      throw new Error(\n        `Timed out waiting for the database to be ready for connections, ${attempts} attempts, ${\n          lastError\n            ? `last error was ${stringifyError(lastError)}`\n            : '(no errors thrown)'\n        }`,\n      );\n    }\n\n    await new Promise(resolve => setTimeout(resolve, 100));\n  }\n}\n\nexport async function startMysqlContainer(image: string): Promise<{\n  connection: Knex.MySqlConnectionConfig;\n  stopContainer: () => Promise<void>;\n}> {\n  const user = 'root';\n  const password = uuid();\n\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(3306)\n    .withEnvironment({ MYSQL_ROOT_PASSWORD: password })\n    .withTmpFs({ '/var/lib/mysql': 'rw' })\n    .start();\n\n  const host = container.getHost();\n  const port = container.getMappedPort(3306);\n  const connection = { host, port, user, password };\n  const stopContainer = async () => {\n    await container.stop({ timeout: 10_000 });\n  };\n\n  await waitForMysqlReady(connection);\n\n  return { connection, stopContainer };\n}\n\nexport function parseMysqlConnectionString(\n  connectionString: string,\n): Knex.MySqlConnectionConfig {\n  try {\n    const {\n      protocol,\n      username,\n      password,\n      port,\n      hostname,\n      pathname,\n      searchParams,\n    } = new URL(connectionString);\n\n    if (protocol !== 'mysql:') {\n      throw new Error(`Unknown protocol ${protocol}`);\n    } else if (!username || !password) {\n      throw new Error(`Missing username/password`);\n    } else if (!pathname.match(/^\\/[^/]+$/)) {\n      throw new Error(`Expected single path segment`);\n    }\n\n    const result: Knex.MySqlConnectionConfig = {\n      user: username,\n      password,\n      host: hostname,\n      port: Number(port || 3306),\n      database: decodeURIComponent(pathname.substring(1)),\n    };\n\n    const ssl = searchParams.get('ssl');\n    if (ssl) {\n      result.ssl = ssl;\n    }\n\n    const debug = searchParams.get('debug');\n    if (debug) {\n      result.debug = yn(debug);\n    }\n\n    return result;\n  } catch (e) {\n    throw new Error(`Error while parsing MySQL connection string, ${e}`, e);\n  }\n}\n\nexport class MysqlEngine implements Engine {\n  static async create(\n    properties: TestDatabaseProperties,\n  ): Promise<MysqlEngine> {\n    const { connectionStringEnvironmentVariableName, dockerImageName } =\n      properties;\n\n    if (connectionStringEnvironmentVariableName) {\n      const connectionString =\n        process.env[connectionStringEnvironmentVariableName];\n      if (connectionString) {\n        const connection = parseMysqlConnectionString(connectionString);\n        return new MysqlEngine(\n          properties,\n          connection as Knex.MySqlConnectionConfig,\n        );\n      }\n    }\n\n    if (dockerImageName) {\n      const { connection, stopContainer } = await startMysqlContainer(\n        dockerImageName,\n      );\n      return new MysqlEngine(properties, connection, stopContainer);\n    }\n\n    throw new Error(`Test databasee for ${properties.name} not configured`);\n  }\n\n  readonly #properties: TestDatabaseProperties;\n  readonly #connection: Knex.MySqlConnectionConfig;\n  readonly #knexInstances: Knex[];\n  readonly #databaseNames: string[];\n  readonly #stopContainer?: () => Promise<void>;\n\n  constructor(\n    properties: TestDatabaseProperties,\n    connection: Knex.MySqlConnectionConfig,\n    stopContainer?: () => Promise<void>,\n  ) {\n    this.#properties = properties;\n    this.#connection = connection;\n    this.#knexInstances = [];\n    this.#databaseNames = [];\n    this.#stopContainer = stopContainer;\n  }\n\n  async createDatabaseInstance(): Promise<Knex> {\n    const adminConnection = this.#connectAdmin();\n    try {\n      const databaseName = `db${randomBytes(16).toString('hex')}`;\n\n      await adminConnection.raw('CREATE DATABASE ??', [databaseName]);\n      this.#databaseNames.push(databaseName);\n\n      const knexInstance = knexFactory({\n        client: this.#properties.driver,\n        connection: {\n          ...this.#connection,\n          database: databaseName,\n        },\n        ...LARGER_POOL_CONFIG,\n      });\n      this.#knexInstances.push(knexInstance);\n\n      return knexInstance;\n    } finally {\n      await adminConnection.destroy();\n    }\n  }\n\n  async shutdown(): Promise<void> {\n    for (const instance of this.#knexInstances) {\n      await instance.destroy();\n    }\n\n    const adminConnection = this.#connectAdmin();\n    try {\n      for (const databaseName of this.#databaseNames) {\n        await adminConnection.raw('DROP DATABASE ??', [databaseName]);\n      }\n    } finally {\n      await adminConnection.destroy();\n    }\n\n    await this.#stopContainer?.();\n  }\n\n  #connectAdmin(): Knex {\n    const connection = {\n      ...this.#connection,\n      database: null as unknown as string,\n    };\n    return knexFactory({\n      client: this.#properties.driver,\n      connection,\n      pool: {\n        min: 0,\n        max: 1,\n        acquireTimeoutMillis: 20_000,\n        createTimeoutMillis: 20_000,\n        createRetryIntervalMillis: 1_000,\n      },\n    });\n  }\n}\n"],"names":["knexFactory","stringifyError","uuid","yn","randomBytes","LARGER_POOL_CONFIG"],"mappings":";;;;;;;;;;;;;;AAuBA,eAAe,kBACb,UACe,EAAA;AACf,EAAM,MAAA,SAAA,GAAY,KAAK,GAAI,EAAA,CAAA;AAE3B,EAAI,IAAA,SAAA,CAAA;AACJ,EAAA,IAAI,QAAW,GAAA,CAAA,CAAA;AACf,EAAS,WAAA;AACP,IAAY,QAAA,IAAA,CAAA,CAAA;AAEZ,IAAI,IAAA,IAAA,CAAA;AACJ,IAAI,IAAA;AACF,MAAA,IAAA,GAAOA,4BAAY,CAAA;AAAA,QACjB,MAAQ,EAAA,QAAA;AAAA,QACR,UAAY,EAAA;AAAA;AAAA,UAEV,GAAG,UAAA;AAAA,SACL;AAAA,OACD,CAAA,CAAA;AACD,MAAA,MAAM,SAAS,MAAM,IAAA,CAAK,OAAO,IAAK,CAAA,GAAA,CAAI,sBAAsB,CAAC,CAAA,CAAA;AACjE,MAAA,IAAI,MAAM,OAAQ,CAAA,MAAM,KAAK,MAAO,CAAA,CAAC,GAAG,OAAS,EAAA;AAC/C,QAAA,OAAA;AAAA,OACF;AAAA,aACO,CAAG,EAAA;AACV,MAAY,SAAA,GAAA,CAAA,CAAA;AAAA,KACZ,SAAA;AACA,MAAA,MAAM,MAAM,OAAQ,EAAA,CAAA;AAAA,KACtB;AAEA,IAAA,IAAI,IAAK,CAAA,GAAA,EAAQ,GAAA,SAAA,GAAY,GAAQ,EAAA;AACnC,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gEAAA,EAAmE,QAAQ,CACzE,WAAA,EAAA,SAAA,GACI,kBAAkBC,qBAAe,CAAA,SAAS,CAAC,CAAA,CAAA,GAC3C,oBACN,CAAA,CAAA;AAAA,OACF,CAAA;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,oBAAoB,KAGvC,EAAA;AACD,EAAA,MAAM,IAAO,GAAA,MAAA,CAAA;AACb,EAAA,MAAM,WAAWC,OAAK,EAAA,CAAA;AAGtB,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,CACrB,CAAA,eAAA,CAAgB,EAAE,mBAAqB,EAAA,QAAA,EAAU,CACjD,CAAA,SAAA,CAAU,EAAE,gBAAkB,EAAA,IAAA,EAAM,CAAA,CACpC,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,EAAE,IAAM,EAAA,IAAA,EAAM,MAAM,QAAS,EAAA,CAAA;AAChD,EAAA,MAAM,gBAAgB,YAAY;AAChC,IAAA,MAAM,SAAU,CAAA,IAAA,CAAK,EAAE,OAAA,EAAS,KAAQ,CAAA,CAAA;AAAA,GAC1C,CAAA;AAEA,EAAA,MAAM,kBAAkB,UAAU,CAAA,CAAA;AAElC,EAAO,OAAA,EAAE,YAAY,aAAc,EAAA,CAAA;AACrC,CAAA;AAEO,SAAS,2BACd,gBAC4B,EAAA;AAC5B,EAAI,IAAA;AACF,IAAM,MAAA;AAAA,MACJ,QAAA;AAAA,MACA,QAAA;AAAA,MACA,QAAA;AAAA,MACA,IAAA;AAAA,MACA,QAAA;AAAA,MACA,QAAA;AAAA,MACA,YAAA;AAAA,KACF,GAAI,IAAI,GAAA,CAAI,gBAAgB,CAAA,CAAA;AAE5B,IAAA,IAAI,aAAa,QAAU,EAAA;AACzB,MAAA,MAAM,IAAI,KAAA,CAAM,CAAoB,iBAAA,EAAA,QAAQ,CAAE,CAAA,CAAA,CAAA;AAAA,KACrC,MAAA,IAAA,CAAC,QAAY,IAAA,CAAC,QAAU,EAAA;AACjC,MAAM,MAAA,IAAI,MAAM,CAA2B,yBAAA,CAAA,CAAA,CAAA;AAAA,KAClC,MAAA,IAAA,CAAC,QAAS,CAAA,KAAA,CAAM,WAAW,CAAG,EAAA;AACvC,MAAM,MAAA,IAAI,MAAM,CAA8B,4BAAA,CAAA,CAAA,CAAA;AAAA,KAChD;AAEA,IAAA,MAAM,MAAqC,GAAA;AAAA,MACzC,IAAM,EAAA,QAAA;AAAA,MACN,QAAA;AAAA,MACA,IAAM,EAAA,QAAA;AAAA,MACN,IAAA,EAAM,MAAO,CAAA,IAAA,IAAQ,IAAI,CAAA;AAAA,MACzB,QAAU,EAAA,kBAAA,CAAmB,QAAS,CAAA,SAAA,CAAU,CAAC,CAAC,CAAA;AAAA,KACpD,CAAA;AAEA,IAAM,MAAA,GAAA,GAAM,YAAa,CAAA,GAAA,CAAI,KAAK,CAAA,CAAA;AAClC,IAAA,IAAI,GAAK,EAAA;AACP,MAAA,MAAA,CAAO,GAAM,GAAA,GAAA,CAAA;AAAA,KACf;AAEA,IAAM,MAAA,KAAA,GAAQ,YAAa,CAAA,GAAA,CAAI,OAAO,CAAA,CAAA;AACtC,IAAA,IAAI,KAAO,EAAA;AACT,MAAO,MAAA,CAAA,KAAA,GAAQC,oBAAG,KAAK,CAAA,CAAA;AAAA,KACzB;AAEA,IAAO,OAAA,MAAA,CAAA;AAAA,WACA,CAAG,EAAA;AACV,IAAA,MAAM,IAAI,KAAA,CAAM,CAAgD,6CAAA,EAAA,CAAC,IAAI,CAAC,CAAA,CAAA;AAAA,GACxE;AACF,CAAA;AAEO,MAAM,WAA8B,CAAA;AAAA,EACzC,aAAa,OACX,UACsB,EAAA;AACtB,IAAM,MAAA,EAAE,uCAAyC,EAAA,eAAA,EAC/C,GAAA,UAAA,CAAA;AAEF,IAAA,IAAI,uCAAyC,EAAA;AAC3C,MAAM,MAAA,gBAAA,GACJ,OAAQ,CAAA,GAAA,CAAI,uCAAuC,CAAA,CAAA;AACrD,MAAA,IAAI,gBAAkB,EAAA;AACpB,QAAM,MAAA,UAAA,GAAa,2BAA2B,gBAAgB,CAAA,CAAA;AAC9D,QAAA,OAAO,IAAI,WAAA;AAAA,UACT,UAAA;AAAA,UACA,UAAA;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACF;AAEA,IAAA,IAAI,eAAiB,EAAA;AACnB,MAAA,MAAM,EAAE,UAAA,EAAY,aAAc,EAAA,GAAI,MAAM,mBAAA;AAAA,QAC1C,eAAA;AAAA,OACF,CAAA;AACA,MAAA,OAAO,IAAI,WAAA,CAAY,UAAY,EAAA,UAAA,EAAY,aAAa,CAAA,CAAA;AAAA,KAC9D;AAEA,IAAA,MAAM,IAAI,KAAA,CAAM,CAAsB,mBAAA,EAAA,UAAA,CAAW,IAAI,CAAiB,eAAA,CAAA,CAAA,CAAA;AAAA,GACxE;AAAA,EAES,WAAA,CAAA;AAAA,EACA,WAAA,CAAA;AAAA,EACA,cAAA,CAAA;AAAA,EACA,cAAA,CAAA;AAAA,EACA,cAAA,CAAA;AAAA,EAET,WAAA,CACE,UACA,EAAA,UAAA,EACA,aACA,EAAA;AACA,IAAA,IAAA,CAAK,WAAc,GAAA,UAAA,CAAA;AACnB,IAAA,IAAA,CAAK,WAAc,GAAA,UAAA,CAAA;AACnB,IAAA,IAAA,CAAK,iBAAiB,EAAC,CAAA;AACvB,IAAA,IAAA,CAAK,iBAAiB,EAAC,CAAA;AACvB,IAAA,IAAA,CAAK,cAAiB,GAAA,aAAA,CAAA;AAAA,GACxB;AAAA,EAEA,MAAM,sBAAwC,GAAA;AAC5C,IAAM,MAAA,eAAA,GAAkB,KAAK,aAAc,EAAA,CAAA;AAC3C,IAAI,IAAA;AACF,MAAA,MAAM,eAAe,CAAK,EAAA,EAAAC,kBAAA,CAAY,EAAE,CAAE,CAAA,QAAA,CAAS,KAAK,CAAC,CAAA,CAAA,CAAA;AAEzD,MAAA,MAAM,eAAgB,CAAA,GAAA,CAAI,oBAAsB,EAAA,CAAC,YAAY,CAAC,CAAA,CAAA;AAC9D,MAAK,IAAA,CAAA,cAAA,CAAe,KAAK,YAAY,CAAA,CAAA;AAErC,MAAA,MAAM,eAAeJ,4BAAY,CAAA;AAAA,QAC/B,MAAA,EAAQ,KAAK,WAAY,CAAA,MAAA;AAAA,QACzB,UAAY,EAAA;AAAA,UACV,GAAG,IAAK,CAAA,WAAA;AAAA,UACR,QAAU,EAAA,YAAA;AAAA,SACZ;AAAA,QACA,GAAGK,wBAAA;AAAA,OACJ,CAAA,CAAA;AACD,MAAK,IAAA,CAAA,cAAA,CAAe,KAAK,YAAY,CAAA,CAAA;AAErC,MAAO,OAAA,YAAA,CAAA;AAAA,KACP,SAAA;AACA,MAAA,MAAM,gBAAgB,OAAQ,EAAA,CAAA;AAAA,KAChC;AAAA,GACF;AAAA,EAEA,MAAM,QAA0B,GAAA;AAC9B,IAAW,KAAA,MAAA,QAAA,IAAY,KAAK,cAAgB,EAAA;AAC1C,MAAA,MAAM,SAAS,OAAQ,EAAA,CAAA;AAAA,KACzB;AAEA,IAAM,MAAA,eAAA,GAAkB,KAAK,aAAc,EAAA,CAAA;AAC3C,IAAI,IAAA;AACF,MAAW,KAAA,MAAA,YAAA,IAAgB,KAAK,cAAgB,EAAA;AAC9C,QAAA,MAAM,eAAgB,CAAA,GAAA,CAAI,kBAAoB,EAAA,CAAC,YAAY,CAAC,CAAA,CAAA;AAAA,OAC9D;AAAA,KACA,SAAA;AACA,MAAA,MAAM,gBAAgB,OAAQ,EAAA,CAAA;AAAA,KAChC;AAEA,IAAA,MAAM,KAAK,cAAiB,IAAA,CAAA;AAAA,GAC9B;AAAA,EAEA,aAAsB,GAAA;AACpB,IAAA,MAAM,UAAa,GAAA;AAAA,MACjB,GAAG,IAAK,CAAA,WAAA;AAAA,MACR,QAAU,EAAA,IAAA;AAAA,KACZ,CAAA;AACA,IAAA,OAAOL,4BAAY,CAAA;AAAA,MACjB,MAAA,EAAQ,KAAK,WAAY,CAAA,MAAA;AAAA,MACzB,UAAA;AAAA,MACA,IAAM,EAAA;AAAA,QACJ,GAAK,EAAA,CAAA;AAAA,QACL,GAAK,EAAA,CAAA;AAAA,QACL,oBAAsB,EAAA,GAAA;AAAA,QACtB,mBAAqB,EAAA,GAAA;AAAA,QACrB,yBAA2B,EAAA,GAAA;AAAA,OAC7B;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF;;;;;;"}

package/dist/database/postgres.cjs.js

@@ -0,0 +1,143 @@
+'use strict';
+
+var errors = require('@backstage/errors');
+var crypto = require('crypto');
+var knexFactory = require('knex');
+var pgConnectionString = require('pg-connection-string');
+var uuid = require('uuid');
+var types = require('./types.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var knexFactory__default = /*#__PURE__*/_interopDefaultCompat(knexFactory);
+
+async function waitForPostgresReady(connection) {
+  const startTime = Date.now();
+  let lastError;
+  let attempts = 0;
+  for (; ; ) {
+    attempts += 1;
+    let knex;
+    try {
+      knex = knexFactory__default.default({
+        client: "pg",
+        connection: {
+          // make a copy because the driver mutates this
+          ...connection
+        }
+      });
+      const result = await knex.select(knex.raw("version()"));
+      if (Array.isArray(result) && result[0]?.version) {
+        return;
+      }
+    } catch (e) {
+      lastError = e;
+    } finally {
+      await knex?.destroy();
+    }
+    if (Date.now() - startTime > 3e4) {
+      throw new Error(
+        `Timed out waiting for the database to be ready for connections, ${attempts} attempts, ${lastError ? `last error was ${errors.stringifyError(lastError)}` : "(no errors thrown)"}`
+      );
+    }
+    await new Promise((resolve) => setTimeout(resolve, 100));
+  }
+}
+async function startPostgresContainer(image) {
+  const user = "postgres";
+  const password = uuid.v4();
+  const { GenericContainer } = await import('testcontainers');
+  const container = await new GenericContainer(image).withExposedPorts(5432).withEnvironment({ POSTGRES_PASSWORD: password }).withTmpFs({ "/var/lib/postgresql/data": "rw" }).start();
+  const host = container.getHost();
+  const port = container.getMappedPort(5432);
+  const connection = { host, port, user, password };
+  const stopContainer = async () => {
+    await container.stop({ timeout: 1e4 });
+  };
+  await waitForPostgresReady(connection);
+  return { connection, stopContainer };
+}
+class PostgresEngine {
+  static async create(properties) {
+    const { connectionStringEnvironmentVariableName, dockerImageName } = properties;
+    if (connectionStringEnvironmentVariableName) {
+      const connectionString = process.env[connectionStringEnvironmentVariableName];
+      if (connectionString) {
+        const connection = pgConnectionString.parse(connectionString);
+        return new PostgresEngine(
+          properties,
+          connection
+        );
+      }
+    }
+    if (dockerImageName) {
+      const { connection, stopContainer } = await startPostgresContainer(
+        dockerImageName
+      );
+      return new PostgresEngine(properties, connection, stopContainer);
+    }
+    throw new Error(`Test databasee for ${properties.name} not configured`);
+  }
+  #properties;
+  #connection;
+  #knexInstances;
+  #databaseNames;
+  #stopContainer;
+  constructor(properties, connection, stopContainer) {
+    this.#properties = properties;
+    this.#connection = connection;
+    this.#knexInstances = [];
+    this.#databaseNames = [];
+    this.#stopContainer = stopContainer;
+  }
+  async createDatabaseInstance() {
+    const adminConnection = this.#connectAdmin();
+    try {
+      const databaseName = `db${crypto.randomBytes(16).toString("hex")}`;
+      await adminConnection.raw("CREATE DATABASE ??", [databaseName]);
+      this.#databaseNames.push(databaseName);
+      const knexInstance = knexFactory__default.default({
+        client: this.#properties.driver,
+        connection: {
+          ...this.#connection,
+          database: databaseName
+        },
+        ...types.LARGER_POOL_CONFIG
+      });
+      this.#knexInstances.push(knexInstance);
+      return knexInstance;
+    } finally {
+      await adminConnection.destroy();
+    }
+  }
+  async shutdown() {
+    for (const instance of this.#knexInstances) {
+      await instance.destroy();
+    }
+    const adminConnection = this.#connectAdmin();
+    try {
+      for (const databaseName of this.#databaseNames) {
+        await adminConnection.raw("DROP DATABASE ??", [databaseName]);
+      }
+    } finally {
+      await adminConnection.destroy();
+    }
+    await this.#stopContainer?.();
+  }
+  #connectAdmin() {
+    return knexFactory__default.default({
+      client: this.#properties.driver,
+      connection: {
+        ...this.#connection,
+        database: "postgres"
+      },
+      pool: {
+        acquireTimeoutMillis: 1e4
+      }
+    });
+  }
+}
+
+exports.PostgresEngine = PostgresEngine;
+exports.startPostgresContainer = startPostgresContainer;
+//# sourceMappingURL=postgres.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"postgres.cjs.js","sources":["../../src/database/postgres.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 { stringifyError } from '@backstage/errors';\nimport { randomBytes } from 'crypto';\nimport knexFactory, { Knex } from 'knex';\nimport { parse as parsePgConnectionString } from 'pg-connection-string';\nimport { v4 as uuid } from 'uuid';\nimport { Engine, LARGER_POOL_CONFIG, TestDatabaseProperties } from './types';\n\nasync function waitForPostgresReady(\n  connection: Knex.PgConnectionConfig,\n): Promise<void> {\n  const startTime = Date.now();\n\n  let lastError: Error | undefined;\n  let attempts = 0;\n  for (;;) {\n    attempts += 1;\n\n    let knex: Knex | undefined;\n    try {\n      knex = knexFactory({\n        client: 'pg',\n        connection: {\n          // make a copy because the driver mutates this\n          ...connection,\n        },\n      });\n      const result = await knex.select(knex.raw('version()'));\n      if (Array.isArray(result) && result[0]?.version) {\n        return;\n      }\n    } catch (e) {\n      lastError = e;\n    } finally {\n      await knex?.destroy();\n    }\n\n    if (Date.now() - startTime > 30_000) {\n      throw new Error(\n        `Timed out waiting for the database to be ready for connections, ${attempts} attempts, ${\n          lastError\n            ? `last error was ${stringifyError(lastError)}`\n            : '(no errors thrown)'\n        }`,\n      );\n    }\n\n    await new Promise(resolve => setTimeout(resolve, 100));\n  }\n}\n\nexport async function startPostgresContainer(image: string): Promise<{\n  connection: Knex.PgConnectionConfig;\n  stopContainer: () => Promise<void>;\n}> {\n  const user = 'postgres';\n  const password = uuid();\n\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(5432)\n    .withEnvironment({ POSTGRES_PASSWORD: password })\n    .withTmpFs({ '/var/lib/postgresql/data': 'rw' })\n    .start();\n\n  const host = container.getHost();\n  const port = container.getMappedPort(5432);\n  const connection = { host, port, user, password };\n  const stopContainer = async () => {\n    await container.stop({ timeout: 10_000 });\n  };\n\n  await waitForPostgresReady(connection);\n\n  return { connection, stopContainer };\n}\n\nexport class PostgresEngine implements Engine {\n  static async create(\n    properties: TestDatabaseProperties,\n  ): Promise<PostgresEngine> {\n    const { connectionStringEnvironmentVariableName, dockerImageName } =\n      properties;\n\n    if (connectionStringEnvironmentVariableName) {\n      const connectionString =\n        process.env[connectionStringEnvironmentVariableName];\n      if (connectionString) {\n        const connection = parsePgConnectionString(connectionString);\n        return new PostgresEngine(\n          properties,\n          connection as Knex.PgConnectionConfig,\n        );\n      }\n    }\n\n    if (dockerImageName) {\n      const { connection, stopContainer } = await startPostgresContainer(\n        dockerImageName,\n      );\n      return new PostgresEngine(properties, connection, stopContainer);\n    }\n\n    throw new Error(`Test databasee for ${properties.name} not configured`);\n  }\n\n  readonly #properties: TestDatabaseProperties;\n  readonly #connection: Knex.PgConnectionConfig;\n  readonly #knexInstances: Knex[];\n  readonly #databaseNames: string[];\n  readonly #stopContainer?: () => Promise<void>;\n\n  constructor(\n    properties: TestDatabaseProperties,\n    connection: Knex.PgConnectionConfig,\n    stopContainer?: () => Promise<void>,\n  ) {\n    this.#properties = properties;\n    this.#connection = connection;\n    this.#knexInstances = [];\n    this.#databaseNames = [];\n    this.#stopContainer = stopContainer;\n  }\n\n  async createDatabaseInstance(): Promise<Knex> {\n    const adminConnection = this.#connectAdmin();\n    try {\n      const databaseName = `db${randomBytes(16).toString('hex')}`;\n\n      await adminConnection.raw('CREATE DATABASE ??', [databaseName]);\n      this.#databaseNames.push(databaseName);\n\n      const knexInstance = knexFactory({\n        client: this.#properties.driver,\n        connection: {\n          ...this.#connection,\n          database: databaseName,\n        },\n        ...LARGER_POOL_CONFIG,\n      });\n      this.#knexInstances.push(knexInstance);\n\n      return knexInstance;\n    } finally {\n      await adminConnection.destroy();\n    }\n  }\n\n  async shutdown(): Promise<void> {\n    for (const instance of this.#knexInstances) {\n      await instance.destroy();\n    }\n\n    const adminConnection = this.#connectAdmin();\n    try {\n      for (const databaseName of this.#databaseNames) {\n        await adminConnection.raw('DROP DATABASE ??', [databaseName]);\n      }\n    } finally {\n      await adminConnection.destroy();\n    }\n\n    await this.#stopContainer?.();\n  }\n\n  #connectAdmin(): Knex {\n    return knexFactory({\n      client: this.#properties.driver,\n      connection: {\n        ...this.#connection,\n        database: 'postgres',\n      },\n      pool: {\n        acquireTimeoutMillis: 10000,\n      },\n    });\n  }\n}\n"],"names":["knexFactory","stringifyError","uuid","parsePgConnectionString","randomBytes","LARGER_POOL_CONFIG"],"mappings":";;;;;;;;;;;;;AAuBA,eAAe,qBACb,UACe,EAAA;AACf,EAAM,MAAA,SAAA,GAAY,KAAK,GAAI,EAAA,CAAA;AAE3B,EAAI,IAAA,SAAA,CAAA;AACJ,EAAA,IAAI,QAAW,GAAA,CAAA,CAAA;AACf,EAAS,WAAA;AACP,IAAY,QAAA,IAAA,CAAA,CAAA;AAEZ,IAAI,IAAA,IAAA,CAAA;AACJ,IAAI,IAAA;AACF,MAAA,IAAA,GAAOA,4BAAY,CAAA;AAAA,QACjB,MAAQ,EAAA,IAAA;AAAA,QACR,UAAY,EAAA;AAAA;AAAA,UAEV,GAAG,UAAA;AAAA,SACL;AAAA,OACD,CAAA,CAAA;AACD,MAAA,MAAM,SAAS,MAAM,IAAA,CAAK,OAAO,IAAK,CAAA,GAAA,CAAI,WAAW,CAAC,CAAA,CAAA;AACtD,MAAA,IAAI,MAAM,OAAQ,CAAA,MAAM,KAAK,MAAO,CAAA,CAAC,GAAG,OAAS,EAAA;AAC/C,QAAA,OAAA;AAAA,OACF;AAAA,aACO,CAAG,EAAA;AACV,MAAY,SAAA,GAAA,CAAA,CAAA;AAAA,KACZ,SAAA;AACA,MAAA,MAAM,MAAM,OAAQ,EAAA,CAAA;AAAA,KACtB;AAEA,IAAA,IAAI,IAAK,CAAA,GAAA,EAAQ,GAAA,SAAA,GAAY,GAAQ,EAAA;AACnC,MAAA,MAAM,IAAI,KAAA;AAAA,QACR,CAAA,gEAAA,EAAmE,QAAQ,CACzE,WAAA,EAAA,SAAA,GACI,kBAAkBC,qBAAe,CAAA,SAAS,CAAC,CAAA,CAAA,GAC3C,oBACN,CAAA,CAAA;AAAA,OACF,CAAA;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,uBAAuB,KAG1C,EAAA;AACD,EAAA,MAAM,IAAO,GAAA,UAAA,CAAA;AACb,EAAA,MAAM,WAAWC,OAAK,EAAA,CAAA;AAGtB,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,CACrB,CAAA,eAAA,CAAgB,EAAE,iBAAmB,EAAA,QAAA,EAAU,CAC/C,CAAA,SAAA,CAAU,EAAE,0BAA4B,EAAA,IAAA,EAAM,CAAA,CAC9C,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,EAAE,IAAM,EAAA,IAAA,EAAM,MAAM,QAAS,EAAA,CAAA;AAChD,EAAA,MAAM,gBAAgB,YAAY;AAChC,IAAA,MAAM,SAAU,CAAA,IAAA,CAAK,EAAE,OAAA,EAAS,KAAQ,CAAA,CAAA;AAAA,GAC1C,CAAA;AAEA,EAAA,MAAM,qBAAqB,UAAU,CAAA,CAAA;AAErC,EAAO,OAAA,EAAE,YAAY,aAAc,EAAA,CAAA;AACrC,CAAA;AAEO,MAAM,cAAiC,CAAA;AAAA,EAC5C,aAAa,OACX,UACyB,EAAA;AACzB,IAAM,MAAA,EAAE,uCAAyC,EAAA,eAAA,EAC/C,GAAA,UAAA,CAAA;AAEF,IAAA,IAAI,uCAAyC,EAAA;AAC3C,MAAM,MAAA,gBAAA,GACJ,OAAQ,CAAA,GAAA,CAAI,uCAAuC,CAAA,CAAA;AACrD,MAAA,IAAI,gBAAkB,EAAA;AACpB,QAAM,MAAA,UAAA,GAAaC,yBAAwB,gBAAgB,CAAA,CAAA;AAC3D,QAAA,OAAO,IAAI,cAAA;AAAA,UACT,UAAA;AAAA,UACA,UAAA;AAAA,SACF,CAAA;AAAA,OACF;AAAA,KACF;AAEA,IAAA,IAAI,eAAiB,EAAA;AACnB,MAAA,MAAM,EAAE,UAAA,EAAY,aAAc,EAAA,GAAI,MAAM,sBAAA;AAAA,QAC1C,eAAA;AAAA,OACF,CAAA;AACA,MAAA,OAAO,IAAI,cAAA,CAAe,UAAY,EAAA,UAAA,EAAY,aAAa,CAAA,CAAA;AAAA,KACjE;AAEA,IAAA,MAAM,IAAI,KAAA,CAAM,CAAsB,mBAAA,EAAA,UAAA,CAAW,IAAI,CAAiB,eAAA,CAAA,CAAA,CAAA;AAAA,GACxE;AAAA,EAES,WAAA,CAAA;AAAA,EACA,WAAA,CAAA;AAAA,EACA,cAAA,CAAA;AAAA,EACA,cAAA,CAAA;AAAA,EACA,cAAA,CAAA;AAAA,EAET,WAAA,CACE,UACA,EAAA,UAAA,EACA,aACA,EAAA;AACA,IAAA,IAAA,CAAK,WAAc,GAAA,UAAA,CAAA;AACnB,IAAA,IAAA,CAAK,WAAc,GAAA,UAAA,CAAA;AACnB,IAAA,IAAA,CAAK,iBAAiB,EAAC,CAAA;AACvB,IAAA,IAAA,CAAK,iBAAiB,EAAC,CAAA;AACvB,IAAA,IAAA,CAAK,cAAiB,GAAA,aAAA,CAAA;AAAA,GACxB;AAAA,EAEA,MAAM,sBAAwC,GAAA;AAC5C,IAAM,MAAA,eAAA,GAAkB,KAAK,aAAc,EAAA,CAAA;AAC3C,IAAI,IAAA;AACF,MAAA,MAAM,eAAe,CAAK,EAAA,EAAAC,kBAAA,CAAY,EAAE,CAAE,CAAA,QAAA,CAAS,KAAK,CAAC,CAAA,CAAA,CAAA;AAEzD,MAAA,MAAM,eAAgB,CAAA,GAAA,CAAI,oBAAsB,EAAA,CAAC,YAAY,CAAC,CAAA,CAAA;AAC9D,MAAK,IAAA,CAAA,cAAA,CAAe,KAAK,YAAY,CAAA,CAAA;AAErC,MAAA,MAAM,eAAeJ,4BAAY,CAAA;AAAA,QAC/B,MAAA,EAAQ,KAAK,WAAY,CAAA,MAAA;AAAA,QACzB,UAAY,EAAA;AAAA,UACV,GAAG,IAAK,CAAA,WAAA;AAAA,UACR,QAAU,EAAA,YAAA;AAAA,SACZ;AAAA,QACA,GAAGK,wBAAA;AAAA,OACJ,CAAA,CAAA;AACD,MAAK,IAAA,CAAA,cAAA,CAAe,KAAK,YAAY,CAAA,CAAA;AAErC,MAAO,OAAA,YAAA,CAAA;AAAA,KACP,SAAA;AACA,MAAA,MAAM,gBAAgB,OAAQ,EAAA,CAAA;AAAA,KAChC;AAAA,GACF;AAAA,EAEA,MAAM,QAA0B,GAAA;AAC9B,IAAW,KAAA,MAAA,QAAA,IAAY,KAAK,cAAgB,EAAA;AAC1C,MAAA,MAAM,SAAS,OAAQ,EAAA,CAAA;AAAA,KACzB;AAEA,IAAM,MAAA,eAAA,GAAkB,KAAK,aAAc,EAAA,CAAA;AAC3C,IAAI,IAAA;AACF,MAAW,KAAA,MAAA,YAAA,IAAgB,KAAK,cAAgB,EAAA;AAC9C,QAAA,MAAM,eAAgB,CAAA,GAAA,CAAI,kBAAoB,EAAA,CAAC,YAAY,CAAC,CAAA,CAAA;AAAA,OAC9D;AAAA,KACA,SAAA;AACA,MAAA,MAAM,gBAAgB,OAAQ,EAAA,CAAA;AAAA,KAChC;AAEA,IAAA,MAAM,KAAK,cAAiB,IAAA,CAAA;AAAA,GAC9B;AAAA,EAEA,aAAsB,GAAA;AACpB,IAAA,OAAOL,4BAAY,CAAA;AAAA,MACjB,MAAA,EAAQ,KAAK,WAAY,CAAA,MAAA;AAAA,MACzB,UAAY,EAAA;AAAA,QACV,GAAG,IAAK,CAAA,WAAA;AAAA,QACR,QAAU,EAAA,UAAA;AAAA,OACZ;AAAA,MACA,IAAM,EAAA;AAAA,QACJ,oBAAsB,EAAA,GAAA;AAAA,OACxB;AAAA,KACD,CAAA,CAAA;AAAA,GACH;AACF;;;;;"}

package/dist/database/sqlite.cjs.js

@@ -0,0 +1,40 @@
+'use strict';
+
+var knexFactory = require('knex');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var knexFactory__default = /*#__PURE__*/_interopDefaultCompat(knexFactory);
+
+class SqliteEngine {
+  static async create(properties) {
+    return new SqliteEngine(properties);
+  }
+  #properties;
+  #instances;
+  constructor(properties) {
+    this.#properties = properties;
+    this.#instances = [];
+  }
+  async createDatabaseInstance() {
+    const instance = knexFactory__default.default({
+      client: this.#properties.driver,
+      connection: ":memory:",
+      useNullAsDefault: true
+    });
+    instance.client.pool.on("createSuccess", (_eventId, resource) => {
+      resource.run("PRAGMA foreign_keys = ON", () => {
+      });
+    });
+    this.#instances.push(instance);
+    return instance;
+  }
+  async shutdown() {
+    for (const instance of this.#instances) {
+      await instance.destroy();
+    }
+  }
+}
+
+exports.SqliteEngine = SqliteEngine;
+//# sourceMappingURL=sqlite.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"sqlite.cjs.js","sources":["../../src/database/sqlite.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 knexFactory, { Knex } from 'knex';\nimport { Engine, TestDatabaseProperties } from './types';\n\nexport class SqliteEngine implements Engine {\n  static async create(\n    properties: TestDatabaseProperties,\n  ): Promise<SqliteEngine> {\n    return new SqliteEngine(properties);\n  }\n\n  readonly #properties: TestDatabaseProperties;\n  readonly #instances: Knex[];\n\n  constructor(properties: TestDatabaseProperties) {\n    this.#properties = properties;\n    this.#instances = [];\n  }\n\n  async createDatabaseInstance(): Promise<Knex> {\n    const instance = knexFactory({\n      client: this.#properties.driver,\n      connection: ':memory:',\n      useNullAsDefault: true,\n    });\n\n    instance.client.pool.on('createSuccess', (_eventId: any, resource: any) => {\n      resource.run('PRAGMA foreign_keys = ON', () => {});\n    });\n\n    this.#instances.push(instance);\n    return instance;\n  }\n\n  async shutdown(): Promise<void> {\n    for (const instance of this.#instances) {\n      await instance.destroy();\n    }\n  }\n}\n"],"names":["knexFactory"],"mappings":";;;;;;;;AAmBO,MAAM,YAA+B,CAAA;AAAA,EAC1C,aAAa,OACX,UACuB,EAAA;AACvB,IAAO,OAAA,IAAI,aAAa,UAAU,CAAA,CAAA;AAAA,GACpC;AAAA,EAES,WAAA,CAAA;AAAA,EACA,UAAA,CAAA;AAAA,EAET,YAAY,UAAoC,EAAA;AAC9C,IAAA,IAAA,CAAK,WAAc,GAAA,UAAA,CAAA;AACnB,IAAA,IAAA,CAAK,aAAa,EAAC,CAAA;AAAA,GACrB;AAAA,EAEA,MAAM,sBAAwC,GAAA;AAC5C,IAAA,MAAM,WAAWA,4BAAY,CAAA;AAAA,MAC3B,MAAA,EAAQ,KAAK,WAAY,CAAA,MAAA;AAAA,MACzB,UAAY,EAAA,UAAA;AAAA,MACZ,gBAAkB,EAAA,IAAA;AAAA,KACnB,CAAA,CAAA;AAED,IAAA,QAAA,CAAS,OAAO,IAAK,CAAA,EAAA,CAAG,eAAiB,EAAA,CAAC,UAAe,QAAkB,KAAA;AACzE,MAAS,QAAA,CAAA,GAAA,CAAI,4BAA4B,MAAM;AAAA,OAAE,CAAA,CAAA;AAAA,KAClD,CAAA,CAAA;AAED,IAAK,IAAA,CAAA,UAAA,CAAW,KAAK,QAAQ,CAAA,CAAA;AAC7B,IAAO,OAAA,QAAA,CAAA;AAAA,GACT;AAAA,EAEA,MAAM,QAA0B,GAAA;AAC9B,IAAW,KAAA,MAAA,QAAA,IAAY,KAAK,UAAY,EAAA;AACtC,MAAA,MAAM,SAAS,OAAQ,EAAA,CAAA;AAAA,KACzB;AAAA,GACF;AACF;;;;"}

package/dist/database/types.cjs.js

@@ -0,0 +1,68 @@
+'use strict';
+
+var getDockerImageForName = require('../util/getDockerImageForName.cjs.js');
+
+const allDatabases = Object.freeze({
+  POSTGRES_16: {
+    name: "Postgres 16.x",
+    driver: "pg",
+    dockerImageName: getDockerImageForName.getDockerImageForName("postgres:16"),
+    connectionStringEnvironmentVariableName: "BACKSTAGE_TEST_DATABASE_POSTGRES16_CONNECTION_STRING"
+  },
+  POSTGRES_15: {
+    name: "Postgres 15.x",
+    driver: "pg",
+    dockerImageName: getDockerImageForName.getDockerImageForName("postgres:15"),
+    connectionStringEnvironmentVariableName: "BACKSTAGE_TEST_DATABASE_POSTGRES15_CONNECTION_STRING"
+  },
+  POSTGRES_14: {
+    name: "Postgres 14.x",
+    driver: "pg",
+    dockerImageName: getDockerImageForName.getDockerImageForName("postgres:14"),
+    connectionStringEnvironmentVariableName: "BACKSTAGE_TEST_DATABASE_POSTGRES14_CONNECTION_STRING"
+  },
+  POSTGRES_13: {
+    name: "Postgres 13.x",
+    driver: "pg",
+    dockerImageName: getDockerImageForName.getDockerImageForName("postgres:13"),
+    connectionStringEnvironmentVariableName: "BACKSTAGE_TEST_DATABASE_POSTGRES13_CONNECTION_STRING"
+  },
+  POSTGRES_12: {
+    name: "Postgres 12.x",
+    driver: "pg",
+    dockerImageName: getDockerImageForName.getDockerImageForName("postgres:12"),
+    connectionStringEnvironmentVariableName: "BACKSTAGE_TEST_DATABASE_POSTGRES12_CONNECTION_STRING"
+  },
+  POSTGRES_11: {
+    name: "Postgres 11.x",
+    driver: "pg",
+    dockerImageName: getDockerImageForName.getDockerImageForName("postgres:11"),
+    connectionStringEnvironmentVariableName: "BACKSTAGE_TEST_DATABASE_POSTGRES11_CONNECTION_STRING"
+  },
+  POSTGRES_9: {
+    name: "Postgres 9.x",
+    driver: "pg",
+    dockerImageName: getDockerImageForName.getDockerImageForName("postgres:9"),
+    connectionStringEnvironmentVariableName: "BACKSTAGE_TEST_DATABASE_POSTGRES9_CONNECTION_STRING"
+  },
+  MYSQL_8: {
+    name: "MySQL 8.x",
+    driver: "mysql2",
+    dockerImageName: getDockerImageForName.getDockerImageForName("mysql:8"),
+    connectionStringEnvironmentVariableName: "BACKSTAGE_TEST_DATABASE_MYSQL8_CONNECTION_STRING"
+  },
+  SQLITE_3: {
+    name: "SQLite 3.x",
+    driver: "better-sqlite3"
+  }
+});
+const LARGER_POOL_CONFIG = {
+  pool: {
+    min: 0,
+    max: 50
+  }
+};
+
+exports.LARGER_POOL_CONFIG = LARGER_POOL_CONFIG;
+exports.allDatabases = allDatabases;
+//# sourceMappingURL=types.cjs.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"types.cjs.js","sources":["../../src/database/types.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 { getDockerImageForName } from '../util/getDockerImageForName';\n\nexport interface Engine {\n  createDatabaseInstance(): Promise<Knex>;\n  shutdown(): Promise<void>;\n}\n\n/**\n * The possible databases to test against.\n *\n * @public\n */\nexport type TestDatabaseId =\n  | 'POSTGRES_16'\n  | 'POSTGRES_15'\n  | 'POSTGRES_14'\n  | 'POSTGRES_13'\n  | 'POSTGRES_12'\n  | 'POSTGRES_11'\n  | 'POSTGRES_9'\n  | 'MYSQL_8'\n  | 'SQLITE_3';\n\nexport type TestDatabaseProperties = {\n  name: string;\n  driver: string;\n  dockerImageName?: string;\n  connectionStringEnvironmentVariableName?: string;\n};\n\nexport const allDatabases: Record<TestDatabaseId, TestDatabaseProperties> =\n  Object.freeze({\n    POSTGRES_16: {\n      name: 'Postgres 16.x',\n      driver: 'pg',\n      dockerImageName: getDockerImageForName('postgres:16'),\n      connectionStringEnvironmentVariableName:\n        'BACKSTAGE_TEST_DATABASE_POSTGRES16_CONNECTION_STRING',\n    },\n    POSTGRES_15: {\n      name: 'Postgres 15.x',\n      driver: 'pg',\n      dockerImageName: getDockerImageForName('postgres:15'),\n      connectionStringEnvironmentVariableName:\n        'BACKSTAGE_TEST_DATABASE_POSTGRES15_CONNECTION_STRING',\n    },\n    POSTGRES_14: {\n      name: 'Postgres 14.x',\n      driver: 'pg',\n      dockerImageName: getDockerImageForName('postgres:14'),\n      connectionStringEnvironmentVariableName:\n        'BACKSTAGE_TEST_DATABASE_POSTGRES14_CONNECTION_STRING',\n    },\n    POSTGRES_13: {\n      name: 'Postgres 13.x',\n      driver: 'pg',\n      dockerImageName: getDockerImageForName('postgres:13'),\n      connectionStringEnvironmentVariableName:\n        'BACKSTAGE_TEST_DATABASE_POSTGRES13_CONNECTION_STRING',\n    },\n    POSTGRES_12: {\n      name: 'Postgres 12.x',\n      driver: 'pg',\n      dockerImageName: getDockerImageForName('postgres:12'),\n      connectionStringEnvironmentVariableName:\n        'BACKSTAGE_TEST_DATABASE_POSTGRES12_CONNECTION_STRING',\n    },\n    POSTGRES_11: {\n      name: 'Postgres 11.x',\n      driver: 'pg',\n      dockerImageName: getDockerImageForName('postgres:11'),\n      connectionStringEnvironmentVariableName:\n        'BACKSTAGE_TEST_DATABASE_POSTGRES11_CONNECTION_STRING',\n    },\n    POSTGRES_9: {\n      name: 'Postgres 9.x',\n      driver: 'pg',\n      dockerImageName: getDockerImageForName('postgres:9'),\n      connectionStringEnvironmentVariableName:\n        'BACKSTAGE_TEST_DATABASE_POSTGRES9_CONNECTION_STRING',\n    },\n    MYSQL_8: {\n      name: 'MySQL 8.x',\n      driver: 'mysql2',\n      dockerImageName: getDockerImageForName('mysql:8'),\n      connectionStringEnvironmentVariableName:\n        'BACKSTAGE_TEST_DATABASE_MYSQL8_CONNECTION_STRING',\n    },\n    SQLITE_3: {\n      name: 'SQLite 3.x',\n      driver: 'better-sqlite3',\n    },\n  });\n\nexport const LARGER_POOL_CONFIG = {\n  pool: {\n    min: 0,\n    max: 50,\n  },\n};\n"],"names":["getDockerImageForName"],"mappings":";;;;AA+Ca,MAAA,YAAA,GACX,OAAO,MAAO,CAAA;AAAA,EACZ,WAAa,EAAA;AAAA,IACX,IAAM,EAAA,eAAA;AAAA,IACN,MAAQ,EAAA,IAAA;AAAA,IACR,eAAA,EAAiBA,4CAAsB,aAAa,CAAA;AAAA,IACpD,uCACE,EAAA,sDAAA;AAAA,GACJ;AAAA,EACA,WAAa,EAAA;AAAA,IACX,IAAM,EAAA,eAAA;AAAA,IACN,MAAQ,EAAA,IAAA;AAAA,IACR,eAAA,EAAiBA,4CAAsB,aAAa,CAAA;AAAA,IACpD,uCACE,EAAA,sDAAA;AAAA,GACJ;AAAA,EACA,WAAa,EAAA;AAAA,IACX,IAAM,EAAA,eAAA;AAAA,IACN,MAAQ,EAAA,IAAA;AAAA,IACR,eAAA,EAAiBA,4CAAsB,aAAa,CAAA;AAAA,IACpD,uCACE,EAAA,sDAAA;AAAA,GACJ;AAAA,EACA,WAAa,EAAA;AAAA,IACX,IAAM,EAAA,eAAA;AAAA,IACN,MAAQ,EAAA,IAAA;AAAA,IACR,eAAA,EAAiBA,4CAAsB,aAAa,CAAA;AAAA,IACpD,uCACE,EAAA,sDAAA;AAAA,GACJ;AAAA,EACA,WAAa,EAAA;AAAA,IACX,IAAM,EAAA,eAAA;AAAA,IACN,MAAQ,EAAA,IAAA;AAAA,IACR,eAAA,EAAiBA,4CAAsB,aAAa,CAAA;AAAA,IACpD,uCACE,EAAA,sDAAA;AAAA,GACJ;AAAA,EACA,WAAa,EAAA;AAAA,IACX,IAAM,EAAA,eAAA;AAAA,IACN,MAAQ,EAAA,IAAA;AAAA,IACR,eAAA,EAAiBA,4CAAsB,aAAa,CAAA;AAAA,IACpD,uCACE,EAAA,sDAAA;AAAA,GACJ;AAAA,EACA,UAAY,EAAA;AAAA,IACV,IAAM,EAAA,cAAA;AAAA,IACN,MAAQ,EAAA,IAAA;AAAA,IACR,eAAA,EAAiBA,4CAAsB,YAAY,CAAA;AAAA,IACnD,uCACE,EAAA,qDAAA;AAAA,GACJ;AAAA,EACA,OAAS,EAAA;AAAA,IACP,IAAM,EAAA,WAAA;AAAA,IACN,MAAQ,EAAA,QAAA;AAAA,IACR,eAAA,EAAiBA,4CAAsB,SAAS,CAAA;AAAA,IAChD,uCACE,EAAA,kDAAA;AAAA,GACJ;AAAA,EACA,QAAU,EAAA;AAAA,IACR,IAAM,EAAA,YAAA;AAAA,IACN,MAAQ,EAAA,gBAAA;AAAA,GACV;AACF,CAAC,EAAA;AAEI,MAAM,kBAAqB,GAAA;AAAA,EAChC,IAAM,EAAA;AAAA,IACJ,GAAK,EAAA,CAAA;AAAA,IACL,GAAK,EAAA,EAAA;AAAA,GACP;AACF;;;;;"}

package/dist/filesystem/MockDirectory.cjs.js

@@ -0,0 +1,152 @@
+'use strict';
+
+var os = require('os');
+var backendPluginApi = require('@backstage/backend-plugin-api');
+var fs = require('fs-extra');
+var textextensions = require('textextensions');
+var path = require('path');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var os__default = /*#__PURE__*/_interopDefaultCompat(os);
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+var textextensions__default = /*#__PURE__*/_interopDefaultCompat(textextensions);
+
+const tmpdirMarker = Symbol("os-tmpdir-mock");
+class MockDirectoryImpl {
+  #root;
+  constructor(root) {
+    this.#root = root;
+  }
+  get path() {
+    return this.#root;
+  }
+  resolve(...paths) {
+    return path.resolve(this.#root, ...paths);
+  }
+  setContent(root) {
+    this.remove();
+    return this.addContent(root);
+  }
+  addContent(root) {
+    const entries = this.#transformInput(root);
+    for (const entry of entries) {
+      const fullPath = path.resolve(this.#root, entry.path);
+      if (!backendPluginApi.isChildPath(this.#root, fullPath)) {
+        throw new Error(
+          `Provided path must resolve to a child path of the mock directory, got '${fullPath}'`
+        );
+      }
+      if (entry.type === "dir") {
+        fs__default.default.ensureDirSync(fullPath);
+      } else if (entry.type === "file") {
+        fs__default.default.ensureDirSync(path.dirname(fullPath));
+        fs__default.default.writeFileSync(fullPath, entry.content);
+      } else if (entry.type === "callback") {
+        fs__default.default.ensureDirSync(path.dirname(fullPath));
+        entry.callback({
+          path: fullPath,
+          symlink(target) {
+            fs__default.default.symlinkSync(target, fullPath);
+          }
+        });
+      }
+    }
+  }
+  content(options) {
+    const shouldReadAsText = (typeof options?.shouldReadAsText === "boolean" ? () => options?.shouldReadAsText : options?.shouldReadAsText) ?? ((path$1) => textextensions__default.default.includes(path.extname(path$1).slice(1)));
+    const root = path.resolve(this.#root, options?.path ?? "");
+    if (!backendPluginApi.isChildPath(this.#root, root)) {
+      throw new Error(
+        `Provided path must resolve to a child path of the mock directory, got '${root}'`
+      );
+    }
+    function read(path$1) {
+      if (!fs__default.default.pathExistsSync(path$1)) {
+        return void 0;
+      }
+      const entries = fs__default.default.readdirSync(path$1, { withFileTypes: true });
+      return Object.fromEntries(
+        entries.map((entry) => {
+          const fullPath = path.resolve(path$1, entry.name);
+          if (entry.isDirectory()) {
+            return [entry.name, read(fullPath)];
+          }
+          const content = fs__default.default.readFileSync(fullPath);
+          const relativePosixPath = path.relative(root, fullPath).split(path.win32.sep).join(path.posix.sep);
+          if (shouldReadAsText(relativePosixPath, content)) {
+            return [entry.name, content.toString("utf8")];
+          }
+          return [entry.name, content];
+        })
+      );
+    }
+    return read(root);
+  }
+  clear = () => {
+    this.setContent({});
+  };
+  remove = () => {
+    fs__default.default.rmSync(this.#root, { recursive: true, force: true, maxRetries: 10 });
+  };
+  #transformInput(input) {
+    const entries = [];
+    function traverse(node, path) {
+      if (typeof node === "string") {
+        entries.push({
+          type: "file",
+          path,
+          content: Buffer.from(node, "utf8")
+        });
+      } else if (node instanceof Buffer) {
+        entries.push({ type: "file", path, content: node });
+      } else if (typeof node === "function") {
+        entries.push({ type: "callback", path, callback: node });
+      } else {
+        entries.push({ type: "dir", path });
+        for (const [name, child] of Object.entries(node)) {
+          traverse(child, path ? `${path}/${name}` : name);
+        }
+      }
+    }
+    traverse(input, "");
+    return entries;
+  }
+}
+function createMockDirectory(options) {
+  const tmpDir = process.env.RUNNER_TEMP || os__default.default.tmpdir();
+  const root = fs__default.default.mkdtempSync(path.join(tmpDir, "backstage-tmp-test-dir-"));
+  const mocker = new MockDirectoryImpl(root);
+  const origTmpdir = options?.mockOsTmpDir ? os__default.default.tmpdir : void 0;
+  if (origTmpdir) {
+    if (Object.hasOwn(origTmpdir, tmpdirMarker)) {
+      throw new Error(
+        "Cannot mock os.tmpdir() when it has already been mocked"
+      );
+    }
+    const mock = Object.assign(() => mocker.path, { [tmpdirMarker]: true });
+    os__default.default.tmpdir = mock;
+  }
+  const needsCleanup = !process.env.CI;
+  if (needsCleanup) {
+    process.on("beforeExit", mocker.remove);
+  }
+  try {
+    afterAll(() => {
+      if (origTmpdir) {
+        os__default.default.tmpdir = origTmpdir;
+      }
+      if (needsCleanup) {
+        mocker.remove();
+      }
+    });
+  } catch {
+  }
+  if (options?.content) {
+    mocker.setContent(options.content);
+  }
+  return mocker;
+}
+
+exports.createMockDirectory = createMockDirectory;
+//# sourceMappingURL=MockDirectory.cjs.js.map