Function createTesting

src/testing/testing.ts:20–205

(config: ValidatedConfig)

import { getAppScriptUrl, getAppStyleUrl } from './testing-utils';

export const createTesting = async (config: ValidatedConfig): Promise<Testing> => {
  config = setupTestingConfig(config);

  const { createCompiler } = require('../compiler/stencil.js');
  const compiler: Compiler = await createCompiler(config);

  let devServer: DevServer | null;
  let puppeteerBrowser: puppeteer.Browser | null;

  /**
   * Initiate running spec and/or end-to-end tests with Stencil
   * @param opts running options to apply when
   * @returns true if all tests passed. Returns false if any tests failed or an error occurred during the test
   * setup/running process
   */
  const run = async (opts: TestingRunOptions = {}): Promise<boolean> => {
    let doScreenshots = false;
    let passed = false;
    let env: E2EProcessEnv;
    let compilerWatcher: CompilerWatcher | null = null;
    const msg: string[] = [];

    try {
      if (!opts.spec && !opts.e2e) {
        config.logger.error(
          `Testing requires either the --spec or --e2e command line flags, or both. For example, to run unit tests, use the command: stencil test --spec`,
        );
        return false;
      }

      // during E2E tests, we can safely assume that the current environment is a `E2EProcessEnv`
      env = process.env as E2EProcessEnv;

      if (opts.e2e) {
        msg.push('e2e');
        env.__STENCIL_E2E_TESTS__ = 'true';
      }

      if (opts.spec) {
        msg.push('spec');
        env.__STENCIL_SPEC_TESTS__ = 'true';
      }

      config.logger.info(config.logger.magenta(`testing ${msg.join(' and ')} files${config.watch ? ' (watch)' : ''}`));

      doScreenshots = !!(opts.e2e && opts.screenshot);
      if (doScreenshots) {
        env.__STENCIL_SCREENSHOT__ = 'true';
        if (config.testing.screenshotTimeout != null) {
          env.__STENCIL_SCREENSHOT_TIMEOUT_MS__ = config.testing.screenshotTimeout.toString();
        }

        if (opts.updateScreenshot) {
          config.logger.info(config.logger.magenta(`updating master screenshots`));
        } else {
          config.logger.info(config.logger.magenta(`comparing against master screenshots`));
        }
      }