creevey 0.9.0-beta.20 → 0.9.0-beta.21

package/lib/esm/client/web/main.js.LICENSE.txt

@@ -1,34 +0,0 @@
-/*
-object-assign
-(c) Sindre Sorhus
-@license MIT
-*/
-
-/*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/facebook/regenerator/blob/main/LICENSE */
-
-/** @license React v0.20.2
- * scheduler.production.min.js
- *
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-/** @license React v17.0.2
- * react-dom.production.min.js
- *
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-/** @license React v17.0.2
- * react.production.min.js
- *
- * Copyright (c) Facebook, Inc. and its affiliates.
- *
- * This source code is licensed under the MIT license found in the
- * LICENSE file in the root directory of this source tree.
- */

package/lib/esm/creevey.js

@@ -1,53 +0,0 @@
-import cluster from 'cluster';
-import minimist from 'minimist';
-import creevey from './server';
-import { noop } from './types';
-import { emitWorkerMessage } from './server/messages';
-import { isShuttingDown, shutdown, shutdownWorkers } from './server/utils';
-import { setDefaultLevel, levels } from 'loglevel';
-import { logger } from './server/logger';
-function shutdownOnException(reason) {
-  if (isShuttingDown.current) return;
-  const error = reason instanceof Error ? reason.stack ?? reason.message : reason;
-  logger.error(error);
-  process.exitCode = -1;
-  if (cluster.isWorker) emitWorkerMessage({
-    type: 'error',
-    payload: {
-      error
-    }
-  });
-  if (cluster.isPrimary && !isShuttingDown.current) void shutdownWorkers();
-}
-process.on('uncaughtException', shutdownOnException);
-process.on('unhandledRejection', shutdownOnException);
-if (cluster.isWorker) process.on('SIGINT', noop);
-if (cluster.isPrimary) process.on('SIGINT', shutdown);
-const argv = minimist(process.argv.slice(2), {
-  string: ['browser', 'config', 'reporter', 'reportDir', 'screenDir', 'storybookUrl'],
-  boolean: ['debug', 'trace', 'ui', 'saveReport', 'tests'],
-  default: {
-    port: 3000,
-    saveReport: true
-  },
-  alias: {
-    port: 'p',
-    config: 'c',
-    debug: 'd',
-    update: 'u'
-  }
-});
-
-// @ts-expect-error: define log level for storybook
-global.LOGLEVEL = argv.trace ? 'trace' : argv.debug ? 'debug' : 'warn';
-if (argv.trace) {
-  logger.setDefaultLevel(levels.TRACE);
-  setDefaultLevel(levels.TRACE);
-} else if (argv.debug) {
-  logger.setDefaultLevel(levels.DEBUG);
-  setDefaultLevel(levels.DEBUG);
-} else {
-  logger.setDefaultLevel(levels.INFO);
-  setDefaultLevel(levels.INFO);
-}
-void creevey(argv);

package/lib/esm/index.js

@@ -1,4 +0,0 @@
-export * from './types';
-export { loadStories as browserStoriesProvider } from './server/storybook/providers/browser';
-export { loadStories as hybridStoriesProvider } from './server/storybook/providers/hybrid';
-export * from './server/testsFiles/parser';

package/lib/esm/server/config.js

@@ -1,66 +0,0 @@
-import fs from 'fs';
-import path from 'path';
-import { loadStories as browserStoriesProvider } from './storybook/providers/browser';
-import { isDefined } from '../types';
-export const defaultBrowser = 'chrome';
-export const defaultConfig = {
-  disableTelemetry: false,
-  useDocker: true,
-  dockerImage: 'aerokube/selenoid:latest-release',
-  dockerImagePlatform: '',
-  pullImages: true,
-  failFast: false,
-  storybookUrl: 'http://localhost:6006',
-  screenDir: path.resolve('images'),
-  reportDir: path.resolve('report'),
-  maxRetries: 0,
-  diffOptions: {
-    threshold: 0,
-    includeAA: true
-  },
-  browsers: {
-    [defaultBrowser]: true
-  },
-  hooks: {},
-  babelOptions: _ => _,
-  testsRegex: /\.creevey\.(t|j)s$/
-};
-function normalizeBrowserConfig(name, config) {
-  if (typeof config == 'boolean') return {
-    browserName: name
-  };
-  if (typeof config == 'string') return {
-    browserName: config
-  };
-  return config;
-}
-function resolveConfigPath(configPath) {
-  const rootDir = process.cwd();
-  const configDir = path.resolve('.creevey');
-  if (isDefined(configPath)) {
-    configPath = path.resolve(configPath);
-  } else if (fs.existsSync(configDir)) {
-    configPath = path.join(configDir, 'config');
-    // TODO We already find file with extension, why not use it?
-  } else if (fs.readdirSync(rootDir).find(filename => filename.startsWith('creevey.config'))) {
-    configPath = path.join(rootDir, 'creevey.config');
-  }
-  return configPath;
-}
-export async function readConfig(options) {
-  const configPath = resolveConfigPath(options.config);
-  const userConfig = {
-    ...defaultConfig
-  };
-  if (isDefined(configPath)) Object.assign(userConfig, (await import(configPath)).default);
-  if (!userConfig.storiesProvider) userConfig.storiesProvider = browserStoriesProvider;
-  if (options.failFast != undefined) userConfig.failFast = Boolean(options.failFast);
-  if (options.reportDir) userConfig.reportDir = path.resolve(options.reportDir);
-  if (options.screenDir) userConfig.screenDir = path.resolve(options.screenDir);
-  if (options.storybookUrl) userConfig.storybookUrl = options.storybookUrl;
-
-  // NOTE: Hack to pass typescript checking
-  const config = userConfig;
-  Object.entries(config.browsers).forEach(([browser, browserConfig]) => config.browsers[browser] = normalizeBrowserConfig(browser, browserConfig));
-  return config;
-}

package/lib/esm/server/docker.js

@@ -1,115 +0,0 @@
-import cluster from 'cluster';
-import { isDockerMessage } from '../types';
-import { subscribeOn, sendDockerMessage, emitDockerMessage } from './messages';
-import { isInsideDocker, LOCALHOST_REGEXP } from './utils';
-import Dockerode from 'dockerode';
-import { Writable } from 'stream';
-import ora from 'ora';
-import { logger } from './logger';
-const docker = new Dockerode();
-class DevNull extends Writable {
-  _write(_chunk, _encoding, callback) {
-    setImmediate(callback);
-  }
-}
-export async function pullImages(images, {
-  auth,
-  platform
-} = {}) {
-  const args = {};
-  if (auth) args.authconfig = auth;
-  if (platform) args.platform = platform;
-  logger.info('Pull docker images');
-  for (const image of images) {
-    await new Promise((resolve, reject) => {
-      const spinner = ora(`${image}: Pull start`).start();
-
-      // eslint-disable-next-line @typescript-eslint/no-floating-promises
-      docker.pull(image, args, function (pullError, stream) {
-        if (pullError) {
-          spinner.fail();
-          return reject(pullError);
-        }
-
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-call, @typescript-eslint/no-unsafe-member-access
-        docker.modem.followProgress(stream, onFinished, onProgress);
-        function onFinished(error) {
-          if (error) {
-            spinner.fail();
-            return reject(error);
-          }
-          spinner.succeed(`${image}: Pull complete`);
-          resolve();
-        }
-        function onProgress(event) {
-          if (!/^[a-z0-9]{12}$/i.test(event.id)) return;
-          spinner.text = `${image}: [${event.id}] ${event.status} ${event.progress ? `${event.progress}` : ''}`;
-        }
-      });
-    });
-  }
-}
-export async function runImage(image, args, options, debug) {
-  await Promise.all((await docker.listContainers({
-    all: true,
-    filters: {
-      ancestor: [image]
-    }
-  })).map(async info => {
-    const container = docker.getContainer(info.Id);
-    try {
-      await container.stop();
-    } catch (_) {
-      /* noop */
-    }
-    await container.remove();
-  }));
-  const hub = docker.run(image, args, debug ? process.stdout : new DevNull(), options, error => {
-    if (error) throw error;
-  });
-  return new Promise(resolve => {
-    hub.once('container', container => {
-      // eslint-disable-next-line @typescript-eslint/no-misused-promises
-      subscribeOn('shutdown', async () => {
-        try {
-          await container.stop();
-          await container.remove();
-        } catch (error) {
-          /* noop */
-        }
-      });
-    });
-    hub.once('start', container => void container.inspect().then(info => resolve(info.NetworkSettings.Networks.bridge.IPAddress)));
-  });
-}
-export default async function (config, browser, startContainer) {
-  if (cluster.isPrimary) {
-    const host = await startContainer();
-    let gridUrl = 'http://localhost:4444/wd/hub';
-    gridUrl = isInsideDocker ? gridUrl.replace(LOCALHOST_REGEXP, host) : gridUrl;
-    cluster.on('message', (worker, message) => {
-      if (!isDockerMessage(message)) return;
-      const dockerMessage = message;
-      if (dockerMessage.type != 'start') return;
-      sendDockerMessage(worker, {
-        type: 'success',
-        payload: {
-          gridUrl
-        }
-      });
-    });
-  } else {
-    if (browser && config.browsers[browser].gridUrl) return Promise.resolve();
-    return new Promise(resolve => {
-      subscribeOn('docker', message => {
-        if (message.type == 'success') {
-          config.gridUrl = message.payload.gridUrl;
-          resolve();
-        }
-      });
-      emitDockerMessage({
-        type: 'start'
-      });
-    });
-  }
-}

package/lib/esm/server/index.js

@@ -1,50 +0,0 @@
-import cluster from 'cluster';
-import { readConfig, defaultBrowser } from './config';
-import { logger } from './logger';
-
-// NOTE: Impure function, mutate config by adding gridUrl prop
-async function startWebdriverServer(config, options) {
-  if (config.useDocker) {
-    return (await import('./docker')).default(config, options.browser, async () => (await import('./selenium/selenoid')).startSelenoidContainer(config, options.debug));
-  } else {
-    return (await import('./selenium/selenoid')).startSelenoidStandalone(config, options.debug);
-  }
-}
-export default async function (options) {
-  const config = await readConfig(options);
-  const {
-    browser = defaultBrowser,
-    tests,
-    update,
-    ui,
-    port
-  } = options;
-  if (!config) return;
-
-  // NOTE: We don't need docker nor selenoid for webpack or update options
-  if (!(config.gridUrl || Object.values(config.browsers).every(({
-    gridUrl
-  }) => gridUrl)) && !tests && !update) {
-    await startWebdriverServer(config, options);
-  }
-  switch (true) {
-    case Boolean(update):
-      {
-        return (await import('./update')).default(config, typeof update == 'string' ? update : undefined);
-      }
-    case cluster.isPrimary:
-      {
-        logger.info('Starting Master Process');
-        const resolveApi = (await import('./master/server')).default(config.reportDir, port, ui);
-        return (await import('./master')).default(config, options, resolveApi);
-      }
-    default:
-      {
-        logger.info(`Starting Worker for ${browser}`);
-        return (await import('./worker')).default(config, {
-          ...options,
-          browser
-        });
-      }
-  }
-}

package/lib/esm/server/master/api.js

@@ -1,51 +0,0 @@
-import WebSocket from 'ws';
-import { logger } from '../logger';
-function broadcast(wss, message) {
-  wss.clients.forEach(ws => {
-    if (ws.readyState === WebSocket.OPEN) {
-      ws.send(JSON.stringify(message));
-    }
-  });
-}
-export default function creeveyApi(runner) {
-  return {
-    subscribe(wss) {
-      runner.on('update', payload => broadcast(wss, {
-        type: 'update',
-        payload
-      }));
-    },
-    handleMessage(ws, message) {
-      if (typeof message != 'string') {
-        logger.info('unhandled message', message);
-        return;
-      }
-      const command = JSON.parse(message);
-      switch (command.type) {
-        case 'status':
-          {
-            ws.send(JSON.stringify({
-              type: 'status',
-              payload: runner.status
-            }));
-            return;
-          }
-        case 'start':
-          {
-            runner.start(command.payload);
-            return;
-          }
-        case 'stop':
-          {
-            runner.stop();
-            return;
-          }
-        case 'approve':
-          {
-            void runner.approve(command.payload);
-            return;
-          }
-      }
-    }
-  };
-}

package/lib/esm/server/master/index.js

@@ -1,115 +0,0 @@
-import path from 'path';
-import { copyFile, readdir, mkdir, existsSync, writeFile } from 'fs';
-import { promisify } from 'util';
-import master from './master';
-import creeveyApi from './api';
-import { isDefined } from '../../types';
-import { shutdown, shutdownWorkers, testsToImages, readDirRecursive } from '../utils';
-import { subscribeOn } from '../messages';
-import { logger } from '../logger';
-import { sendScreenshotsCount } from '../telemetry';
-const writeFileAsync = promisify(writeFile);
-const copyFileAsync = promisify(copyFile);
-const readdirAsync = promisify(readdir);
-const mkdirAsync = promisify(mkdir);
-async function copyStatics(reportDir) {
-  const clientDir = path.join(__dirname, '../../client/web');
-  const files = (await readdirAsync(clientDir, {
-    withFileTypes: true
-  })).filter(dirent => dirent.isFile() && !dirent.name.endsWith('.d.ts') && !dirent.name.endsWith('.tsx')).map(dirent => dirent.name);
-  await mkdirAsync(reportDir, {
-    recursive: true
-  });
-  for (const file of files) {
-    await copyFileAsync(path.join(clientDir, file), path.join(reportDir, file));
-  }
-}
-function reportDataModule(data) {
-  return `
-(function (root, factory) {
-  if (typeof module === 'object' && module.exports) {
-    module.exports = factory();
-  } else {
-    root.__CREEVEY_DATA__ = factory();
-  }
-}(this, function () { return ${JSON.stringify(data)} }));
-`;
-}
-function outputUnnecessaryImages(imagesDir, images) {
-  if (!existsSync(imagesDir)) return;
-  const unnecessaryImages = readDirRecursive(imagesDir).map(imagePath => path.posix.relative(imagesDir, imagePath)).filter(imagePath => !images.has(imagePath));
-  if (unnecessaryImages.length > 0) {
-    logger.warn('We found unnecessary screenshot images, those can be safely removed:\n', unnecessaryImages.join('\n'));
-  }
-}
-export default async function (config, options, resolveApi) {
-  let runner = null;
-  if (config.hooks.before) {
-    await config.hooks.before();
-  }
-  subscribeOn('shutdown', () => {
-    var _config$hooks$after, _config$hooks;
-    return (_config$hooks$after = (_config$hooks = config.hooks).after) === null || _config$hooks$after === void 0 ? void 0 : _config$hooks$after.call(_config$hooks);
-  });
-  process.removeListener('SIGINT', shutdown);
-  process.on('SIGINT', () => {
-    var _runner, _runner2;
-    (_runner = runner) === null || _runner === void 0 || _runner.removeAllListeners('stop');
-    if ((_runner2 = runner) !== null && _runner2 !== void 0 && _runner2.isRunning) {
-      var _runner4;
-      // TODO Better handle stop
-      void Promise.race([new Promise(resolve => setTimeout(resolve, 10000)), new Promise(resolve => {
-        var _runner3;
-        return (_runner3 = runner) === null || _runner3 === void 0 ? void 0 : _runner3.once('stop', resolve);
-      })]).then(() => shutdownWorkers());
-      (_runner4 = runner) === null || _runner4 === void 0 || _runner4.stop();
-    } else {
-      void shutdownWorkers();
-    }
-  });
-  runner = await master(config, {
-    watch: options.ui,
-    debug: options.debug,
-    port: options.port
-  });
-  if (options.saveReport) {
-    runner.on('stop', () => {
-      void copyStatics(config.reportDir).then(() => {
-        var _runner5;
-        return writeFileAsync(path.join(config.reportDir, 'data.js'), reportDataModule((_runner5 = runner) === null || _runner5 === void 0 ? void 0 : _runner5.status.tests));
-      });
-    });
-  }
-  if (options.ui) {
-    resolveApi(creeveyApi(runner));
-    logger.info(`Started on http://localhost:${options.port}`);
-  } else {
-    if (Object.values(runner.status.tests).filter(test => test && !test.skip).length == 0) {
-      logger.warn("Don't have any tests to run");
-      // eslint-disable-next-line no-process-exit
-      void shutdownWorkers().then(() => process.exit());
-      return;
-    }
-    runner.once('stop', () => {
-      var _runner6, _runner7;
-      const tests = Object.values(((_runner6 = runner) === null || _runner6 === void 0 ? void 0 : _runner6.status.tests) ?? {});
-      const isSuccess = tests.filter(isDefined).filter(({
-        skip
-      }) => !skip).every(({
-        status
-      }) => status == 'success');
-      // TODO output summary
-      process.exitCode = isSuccess ? 0 : -1;
-      if (!config.failFast) outputUnnecessaryImages(config.screenDir, testsToImages(tests));
-      sendScreenshotsCount(config, options, (_runner7 = runner) === null || _runner7 === void 0 ? void 0 : _runner7.status).catch(reason => {
-        const error = reason instanceof Error ? reason.stack ?? reason.message : reason;
-        logger.warn(`Can't send telemetry: ${error}`);
-      }).finally(() => {
-        // eslint-disable-next-line no-process-exit
-        void shutdownWorkers().then(() => process.exit());
-      });
-    });
-    // TODO grep
-    runner.start(Object.keys(runner.status.tests));
-  }
-}

package/lib/esm/server/master/master.js

@@ -1,33 +0,0 @@
-import path from 'path';
-import { isDefined } from '../../types';
-import { loadTestsFromStories, saveTestsJson } from '../stories';
-import Runner from './runner';
-function mergeTests(testsWithReports, testsFromStories) {
-  Object.values(testsFromStories).filter(isDefined).forEach(test => {
-    const testWithReport = testsWithReports[test.id];
-    if (!testWithReport) return;
-    test.retries = testWithReport.retries;
-    if (testWithReport.status == 'success' || testWithReport.status == 'failed') test.status = testWithReport.status;
-    test.results = testWithReport.results;
-    test.approved = testWithReport.approved;
-  });
-  return testsFromStories;
-}
-export default async function master(config, options) {
-  const runner = new Runner(config);
-  const reportDataPath = path.join(config.reportDir, 'data.js');
-  let testsFromReport = {};
-  try {
-    testsFromReport = await import(reportDataPath);
-  } catch (error) {
-    // Ignore error
-  }
-  await runner.init();
-  const tests = await loadTestsFromStories(Object.keys(config.browsers), listener => config.storiesProvider(config, options, listener), testsDiff => {
-    runner.updateTests(testsDiff);
-    saveTestsJson(runner.tests, config.reportDir);
-  });
-  runner.tests = mergeTests(testsFromReport, tests);
-  saveTestsJson(runner.tests, config.reportDir);
-  return runner;
-}

package/lib/esm/server/master/pool.js

@@ -1,154 +0,0 @@
-import cluster, { Worker as ClusterWorker } from 'cluster';
-import { EventEmitter } from 'events';
-import { isWorkerMessage } from '../../types';
-import { sendTestMessage, sendShutdownMessage, subscribeOnWorker } from '../messages';
-import { isShuttingDown } from '../utils';
-const FORK_RETRIES = 5;
-export default class Pool extends EventEmitter {
-  workers = [];
-  queue = [];
-  forcedStop = false;
-  get isRunning() {
-    return this.workers.length !== this.freeWorkers.length;
-  }
-  constructor(config, browser) {
-    super();
-    this.browser = browser;
-    this.failFast = config.failFast;
-    this.maxRetries = config.maxRetries;
-    this.config = config.browsers[browser];
-  }
-  async init() {
-    const poolSize = this.config.limit || 1;
-    // TODO Init queue for workers to smooth browser starting load
-    this.workers = (await Promise.all(Array.from({
-      length: poolSize
-    }).map(() => this.forkWorker()))).filter(workerOrError => workerOrError instanceof ClusterWorker);
-    if (this.workers.length != poolSize) throw new Error(`Can't instantiate workers for ${this.browser} due many errors`);
-    this.workers.forEach(worker => this.exitHandler(worker));
-  }
-  start(tests) {
-    if (this.isRunning) return false;
-    this.queue = tests.map(({
-      id,
-      path
-    }) => ({
-      id,
-      path,
-      retries: 0
-    }));
-    this.process();
-    return true;
-  }
-  stop() {
-    if (!this.isRunning) {
-      this.emit('stop');
-      return;
-    }
-    this.forcedStop = true;
-    this.queue = [];
-  }
-  process() {
-    const worker = this.getFreeWorker();
-    const [test] = this.queue;
-    if (this.queue.length == 0 && this.workers.length === this.freeWorkers.length) {
-      this.forcedStop = false;
-      this.emit('stop');
-      return;
-    }
-    if (!worker || !test) return;
-    worker.isRunning = true;
-    const {
-      id
-    } = test;
-    this.queue.shift();
-    this.sendStatus({
-      id,
-      status: 'running'
-    });
-    this.subscribe(worker, test);
-    sendTestMessage(worker, {
-      type: 'start',
-      payload: test
-    });
-    this.process();
-  }
-  sendStatus(message) {
-    this.emit('test', message);
-  }
-  getFreeWorker() {
-    return this.freeWorkers[Math.floor(Math.random() * this.freeWorkers.length)];
-  }
-  get aliveWorkers() {
-    return this.workers.filter(worker => !worker.exitedAfterDisconnect);
-  }
-  get freeWorkers() {
-    return this.aliveWorkers.filter(worker => !worker.isRunning);
-  }
-  async forkWorker(retry = 0) {
-    cluster.setupPrimary({
-      args: ['--browser', this.browser, ...process.argv.slice(2)]
-    });
-    const worker = cluster.fork();
-    const message = await new Promise(resolve => {
-      const readyHandler = message => {
-        if (!isWorkerMessage(message)) return;
-        worker.off('message', readyHandler);
-        resolve(message);
-      };
-      worker.on('message', readyHandler);
-    });
-    if (message.type != 'error') return worker;
-    this.gracefullyKill(worker);
-    if (retry == FORK_RETRIES) return message.payload;
-    return this.forkWorker(retry + 1);
-  }
-  exitHandler(worker) {
-    // eslint-disable-next-line @typescript-eslint/no-misused-promises
-    worker.once('exit', async () => {
-      if (isShuttingDown.current) return;
-      const workerOrError = await this.forkWorker();
-      if (!(workerOrError instanceof ClusterWorker)) throw new Error(`Can't instantiate worker for ${this.browser} due many errors`);
-      this.exitHandler(workerOrError);
-      this.workers[this.workers.indexOf(worker)] = workerOrError;
-      this.process();
-    });
-  }
-  gracefullyKill(worker) {
-    const timeout = setTimeout(() => worker.kill(), 10000);
-    worker.on('exit', () => clearTimeout(timeout));
-    sendShutdownMessage(worker);
-  }
-  shouldRetry(test) {
-    return test.retries < this.maxRetries && !this.forcedStop;
-  }
-  handleTestResult(worker, test, result) {
-    const shouldRetry = result.status == 'failed' && this.shouldRetry(test);
-    if (shouldRetry) {
-      test.retries += 1;
-      this.queue[this.failFast ? 'unshift' : 'push'](test);
-    }
-    this.sendStatus({
-      id: test.id,
-      status: shouldRetry ? 'retrying' : result.status,
-      result
-    });
-    worker.isRunning = false;
-    setImmediate(() => this.process());
-  }
-  subscribe(worker, test) {
-    const subscriptions = [subscribeOnWorker(worker, 'worker', message => {
-      if (message.type != 'error') return;
-      subscriptions.forEach(unsubscribe => unsubscribe());
-      this.gracefullyKill(worker);
-      this.handleTestResult(worker, test, {
-        status: 'failed',
-        ...message.payload
-      });
-    }), subscribeOnWorker(worker, 'test', message => {
-      if (message.type != 'end') return;
-      subscriptions.forEach(unsubscribe => unsubscribe());
-      this.handleTestResult(worker, test, message.payload);
-    })];
-  }
-}