helpers.repository-tests.ts

// Copyright IBM Corp. 2019,2020. All Rights Reserved.
// Node module: @loopback/repository-tests
// This file is licensed under the MIT License.
// License text available at https://opensource.org/licenses/MIT

import {CrudTestContext} from './types.repository-tests';

/**
 * Obtain CrudTestContext from the Mocha context.
 * @internal
 * @param context - Mocha context as provided to the test function via `this`.
 */
export function getCrudContext(context: Mocha.Context) {
  return context as unknown as CrudTestContext;
}

/**
 * Convert a function accepting context in the first argument into a regular
 * Mocha function.
 * @param fn - A Mocha function (describe/it/before/after callback) accepting
 * `CrudTestContext` as the regular argument.
 */
export function withCrudCtx(
  fn: (context: CrudTestContext) => PromiseLike<unknown> | void,
): Mocha.AsyncFunc | Mocha.Func {
  return function (this: Mocha.Context) {
    return fn.call(this, getCrudContext(this));
  };
}

/**
 * Remove any models created by previous tests from the default DataSource
 * instance (`ctx.dataSource`).
 *
 * Call this method from the first `before` hook of your test suite to avoid
 * conflicts when the same model name is used for different model classes.
 */
export const deleteAllModelsInDefaultDataSource = withCrudCtx(ctx => {
  ctx.dataSource.deleteAllModels();
}) as Mocha.Func;

/**
 * A union type between string and number to use since MongoDB and MySQL use
 * different id types.
 */
export type MixedIdType = string | number;