crud-test-suite.ts

// Copyright IBM Corp. 2019. 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 {juggler} from '@loopback/repository';
import debugFactory from 'debug';
import fs from 'fs';
import path from 'path';
import {withCrudCtx} from './helpers.repository-tests';
import {
  CrudFeatures,
  CrudRepositoryCtor,
  CrudTestContext,
  DataSourceOptions,
} from './types.repository-tests';

const debug = debugFactory('loopback:repository-tests');

type SuiteFn = (
  dataSourceOptions: DataSourceOptions,
  repositoryClass: CrudRepositoryCtor,
  features: CrudFeatures,
) => void;

export function crudRepositoryTestSuite(
  dataSourceOptions: DataSourceOptions,
  repositoryClass: CrudRepositoryCtor,
  partialFeatures: Partial<CrudFeatures>,
) {
  const features: CrudFeatures = {
    idType: 'string',
    freeFormProperties: true,
    emptyValue: undefined,
    supportsTransactions: true,
    supportsInclusionResolvers: true,
    hasRevisionToken: false,
    ...partialFeatures,
  };

  describe('CRUD Repository operations', () => {
    before(
      withCrudCtx(function setupContext(ctx: CrudTestContext) {
        ctx.dataSourceOptions = dataSourceOptions;
        ctx.repositoryClass = repositoryClass;
        ctx.features = features;
      }),
    );
    before(
      withCrudCtx(function setupGlobalDataSource(ctx: CrudTestContext) {
        ctx.dataSource = new juggler.DataSource(ctx.dataSourceOptions);
      }),
    );

    let testFiles = [];

    const testRoot = path.resolve(__dirname, 'crud');
    testFiles = fs.readdirSync(testRoot);
    testFiles = testFiles.filter(function(it) {
      return (
        !!require.extensions[path.extname(it).toLowerCase()] &&
        /\.suite\.[^.]+$/.test(it)
      );
    });

    // relations folder tests
    const folders = ['acceptance'];

    for (const folder of folders) {
      const relationsTestRoot = path.resolve(
        __dirname,
        `crud/relations/${folder}`,
      );
      let folderTestFiles = fs.readdirSync(relationsTestRoot);
      folderTestFiles = folderTestFiles.filter(function(it) {
        return (
          !!require.extensions[path.extname(it).toLowerCase()] &&
          /\.acceptance\.[^.]+$/.test(it)
        );
      });
      folderTestFiles.forEach(file => {
        file = `relations/${folder}/` + file;
        testFiles.push(file);
      });
    }

    for (const ix in testFiles) {
      const name = testFiles[ix];
      const fullPath = path.resolve(testRoot, name);
      debug('Loading CRUD test suite %j', fullPath);
      const allExports = require(fullPath);
      for (const key in allExports) {
        const suite: SuiteFn = allExports[key];
        if (typeof suite !== 'function') continue;
        debug(
          'Calling suite function %j with args',
          suite.name,
          dataSourceOptions,
          'class ' + repositoryClass.name,
          partialFeatures,
        );
        suite(dataSourceOptions, repositoryClass, features);
      }
    }
  });
}