task-test.ts

import type { Config, TestingRunOptions } from '../declarations';
import { IS_NODE_ENV } from '../compiler/sys/environment';

export const taskTest = async (config: Config) => {
  if (!IS_NODE_ENV) {
    config.logger.error(`"test" command is currently only implemented for a NodeJS environment`);
    return config.sys.exit(1);
  }

  try {
    const testingRunOpts: TestingRunOptions = {
      e2e: !!config.flags.e2e,
      screenshot: !!config.flags.screenshot,
      spec: !!config.flags.spec,
      updateScreenshot: !!config.flags.updateScreenshot,
    };

    // always ensure we have jest modules installed
    const ensureModuleIds = ['@types/jest', 'jest', 'jest-cli'];

    if (testingRunOpts.e2e) {
      // if it's an e2e test, also make sure we're got
      // puppeteer modules installed and if browserExecutablePath is provided don't download Chromium use only puppeteer-core instead
      const puppeteer = config.testing.browserExecutablePath ? 'puppeteer-core' : 'puppeteer';

      ensureModuleIds.push('@types/puppeteer', puppeteer);

      if (testingRunOpts.screenshot) {
        // ensure we've got pixelmatch for screenshots
        config.logger.warn(
          config.logger.yellow(
            `EXPERIMENTAL: screenshot visual diff testing is currently under heavy development and has not reached a stable status. However, any assistance testing would be appreciated.`,
          ),
        );
      }
    }

    // ensure we've got the required modules installed
    // jest and puppeteer are quite large, so this
    // is an experiment to lazy install these
    // modules only when you need them
    await config.sys.lazyRequire.ensure(config.logger, config.rootDir, ensureModuleIds);

    // let's test!
    const { createTesting } = await import('@stencil/core/testing');
    const testing = await createTesting(config);
    const passed = await testing.run(testingRunOpts);
    await testing.destroy();

    if (!passed) {
      return config.sys.exit(1);
    }
  } catch (e) {
    config.logger.error(e);
    return config.sys.exit(1);
  }
};