creevey 0.9.0-beta.0 → 0.9.0-beta.1

package/lib/esm/server/worker/reporter.js

@@ -1,98 +0,0 @@
-function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
-
-import chalk from 'chalk';
-import { reporters } from 'mocha';
-import prefix from 'loglevel-plugin-prefix';
-import { isDefined, isImageError } from '../../types';
-import { getLogger } from '../logger';
-const testLevels = {
-  INFO: chalk.green('PASS'),
-  WARN: chalk.yellow('START'),
-  ERROR: chalk.red('FAIL')
-};
-export class CreeveyReporter extends reporters.Base {
-  constructor(runner, options) {
-    super(runner);
-    const {
-      sessionId,
-      topLevelSuite
-    } = options.reporterOptions;
-    const testLogger = getLogger(topLevelSuite);
-    prefix.apply(testLogger, {
-      format(level) {
-        return `${testLevels[level]} => (${topLevelSuite}:${chalk.gray(sessionId)})`;
-      }
-
-    });
-    runner.on('test', test => testLogger.warn(chalk.cyan(test.titlePath().join('/'))));
-    runner.on('pass', test => testLogger.info(chalk.cyan(test.titlePath().join('/'))));
-    runner.on('fail', (test, error) => testLogger.error(chalk.cyan(test.titlePath().join('/')), '\n  ', getErrors(error, (error, imageName) => `${chalk.bold(imageName !== null && imageName !== void 0 ? imageName : topLevelSuite)}:${error}`, error => {
-      var _error$stack;
-
-      return `${(_error$stack = error.stack) !== null && _error$stack !== void 0 ? _error$stack : error.message}`;
-    }).join('\n  ')));
-  }
-
-}
-export class TeamcityReporter extends reporters.Base {
-  constructor(runner, options) {
-    super(runner);
-
-    _defineProperty(this, "escape", str => {
-      if (!str) return '';
-      return str.toString() // eslint-disable-next-line no-control-regex
-      .replace(/\x1B.*?m/g, '').replace(/\|/g, '||').replace(/\n/g, '|n').replace(/\r/g, '|r').replace(/\[/g, '|[').replace(/\]/g, '|]').replace(/\u0085/g, '|x').replace(/\u2028/g, '|l').replace(/\u2029/g, '|p').replace(/'/g, "|'");
-    });
-
-    const topLevelSuite = this.escape(options.reporterOptions.topLevelSuite);
-    const reporterOptions = options.reporterOptions;
-    runner.on('suite', suite => suite.root ? console.log(`##teamcity[testSuiteStarted name='${topLevelSuite}' flowId='${process.pid}']`) : console.log(`##teamcity[testSuiteStarted name='${this.escape(suite.title)}' flowId='${process.pid}']`));
-    runner.on('test', test => console.log(`##teamcity[testStarted name='${this.escape(test.title)}' flowId='${process.pid}']`));
-    runner.on('fail', (test, error) => {
-      var _error$stack2;
-
-      Object.entries(reporterOptions.images).forEach(([name, image]) => {
-        if (!image) return;
-        const filePath = test.titlePath().concat(name == topLevelSuite ? [] : [topLevelSuite]).map(this.escape).join('/'); // eslint-disable-next-line @typescript-eslint/no-unused-vars
-
-        const {
-          error,
-          ...rest
-        } = image;
-        Object.values(rest).filter(isDefined).forEach(fileName => {
-          console.log(`##teamcity[publishArtifacts '${reporterOptions.reportDir}/${filePath}/${fileName} => report/${filePath}']`);
-          console.log(`##teamcity[testMetadata testName='${this.escape(test.title)}' type='image' value='report/${filePath}/${fileName}' flowId='${process.pid}']`);
-        });
-      }); // Output failed test as passed due TC don't support retry mechanic
-      // https://teamcity-support.jetbrains.com/hc/en-us/community/posts/207216829-Count-test-as-successful-if-at-least-one-try-is-successful?page=1#community_comment_207394125
-
-      reporterOptions.willRetry ? console.log(`##teamcity[testFinished name='${this.escape(test.title)}' flowId='${process.pid}']`) : console.log(`##teamcity[testFailed name='${this.escape(test.title)}' message='${this.escape(error.message)}' details='${this.escape((_error$stack2 = error.stack) !== null && _error$stack2 !== void 0 ? _error$stack2 : '')}' flowId='${process.pid}']`);
-    });
-    runner.on('pending', test => console.log(`##teamcity[testIgnored name='${this.escape(test.title)}' message='${this.escape(typeof test.skipReason == 'boolean' ? test.title : test.skipReason)}' flowId='${process.pid}']`));
-    runner.on('test end', test => console.log(`##teamcity[testFinished name='${this.escape(test.title)}' flowId='${process.pid}']`));
-    runner.on('suite end', suite => suite.root || console.log(`##teamcity[testSuiteFinished name='${this.escape(suite.title)}' flowId='${process.pid}']`));
-    runner.on('end', () => console.log(`##teamcity[testSuiteFinished name='${topLevelSuite}' flowId='${process.pid}']`));
-  }
-
-}
-
-function getErrors(error, imageErrorToString, errorToString) {
-  const errors = [];
-
-  if (!(error instanceof Error)) {
-    errors.push(error);
-  } else if (!isImageError(error)) {
-    errors.push(errorToString(error));
-  } else if (typeof error.images == 'string') {
-    errors.push(imageErrorToString(error.images));
-  } else {
-    const imageErrors = error.images;
-    Object.keys(imageErrors).forEach(imageName => {
-      var _imageErrors$imageNam;
-
-      errors.push(imageErrorToString((_imageErrors$imageNam = imageErrors[imageName]) !== null && _imageErrors$imageNam !== void 0 ? _imageErrors$imageNam : '', imageName));
-    });
-  }
-
-  return errors;
-}

package/lib/esm/server/worker/worker.js

@@ -1,248 +0,0 @@
-import { promisify } from 'util';
-import fs from 'fs';
-import path from 'path';
-import chai from 'chai';
-import chalk from 'chalk';
-import Mocha from 'mocha';
-import { Key, until } from 'selenium-webdriver';
-import { isImageError } from '../../types';
-import { subscribeOn, emitTestMessage, emitWorkerMessage } from '../messages';
-import chaiImage from './chai-image';
-import { closeBrowser, getBrowser, switchStory } from '../selenium';
-import { CreeveyReporter, TeamcityReporter } from './reporter';
-import { addTestsFromStories } from './helpers';
-import { logger } from '../logger';
-const statAsync = promisify(fs.stat);
-const readdirAsync = promisify(fs.readdir);
-const readFileAsync = promisify(fs.readFile);
-const writeFileAsync = promisify(fs.writeFile);
-const mkdirAsync = promisify(fs.mkdir);
-
-async function getStat(filePath) {
-  try {
-    return await statAsync(filePath);
-  } catch (error) {
-    if (typeof error == 'object' && error && error.code === 'ENOENT') {
-      return null;
-    }
-
-    throw error;
-  }
-}
-
-async function getLastImageNumber(imageDir, imageName) {
-  const actualImagesRegexp = new RegExp(`${imageName}-actual-(\\d+)\\.png`);
-
-  try {
-    var _await$readdirAsync$m;
-
-    return (_await$readdirAsync$m = (await readdirAsync(imageDir)).map(filename => filename.replace(actualImagesRegexp, '$1')).map(Number).filter(x => !isNaN(x)).sort((a, b) => b - a)[0]) !== null && _await$readdirAsync$m !== void 0 ? _await$readdirAsync$m : 0;
-  } catch (_error) {
-    return 0;
-  }
-} // FIXME browser options hotfix
-
-
-export default async function worker(config, options) {
-  var _await$browser$getSes;
-
-  let retries = 0;
-  let images = {};
-  let error = undefined;
-  const screenshots = [];
-  const testScope = [];
-
-  function runHandler(failures) {
-    if (failures > 0 && (error || Object.values(images).some(image => (image === null || image === void 0 ? void 0 : image.error) != null))) {
-      var _error2;
-
-      const isTimeout = hasTimeout(error) || Object.values(images).some(image => hasTimeout(image === null || image === void 0 ? void 0 : image.error));
-      const payload = {
-        status: 'failed',
-        images,
-        error
-      };
-      isTimeout ? emitWorkerMessage({
-        type: 'error',
-        payload: {
-          error: (_error2 = error) !== null && _error2 !== void 0 ? _error2 : 'Unknown error'
-        }
-      }) : emitTestMessage({
-        type: 'end',
-        payload
-      });
-    } else {
-      emitTestMessage({
-        type: 'end',
-        payload: {
-          status: 'success',
-          images
-        }
-      });
-    }
-  }
-
-  async function saveImages(imageDir, images) {
-    await mkdirAsync(imageDir, {
-      recursive: true
-    });
-
-    for (const {
-      name,
-      data
-    } of images) {
-      await writeFileAsync(path.join(imageDir, name), data);
-    }
-  }
-
-  async function getExpected(assertImageName) {
-    var _images$imageName;
-
-    // context => [kind, story, test, browser]
-    // rootSuite -> kindSuite -> storyTest -> [browsers.png]
-    // rootSuite -> kindSuite -> storySuite -> test -> [browsers.png]
-    const testPath = [...testScope];
-    const imageName = assertImageName !== null && assertImageName !== void 0 ? assertImageName : testPath.pop();
-    const imagesMeta = [];
-    const reportImageDir = path.join(config.reportDir, ...testPath);
-    const imageNumber = (await getLastImageNumber(reportImageDir, imageName)) + 1;
-    const actualImageName = `${imageName}-actual-${imageNumber}.png`;
-    const image = images[imageName] = (_images$imageName = images[imageName]) !== null && _images$imageName !== void 0 ? _images$imageName : {
-      actual: actualImageName
-    };
-
-    const onCompare = async (actual, expect, diff) => {
-      imagesMeta.push({
-        name: image.actual,
-        data: actual
-      });
-
-      if (diff && expect) {
-        image.expect = `${imageName}-expect-${imageNumber}.png`;
-        image.diff = `${imageName}-diff-${imageNumber}.png`;
-        imagesMeta.push({
-          name: image.expect,
-          data: expect
-        });
-        imagesMeta.push({
-          name: image.diff,
-          data: diff
-        });
-      }
-
-      if (options.saveReport) {
-        await saveImages(reportImageDir, imagesMeta);
-      }
-    };
-
-    const expectImageDir = path.join(config.screenDir, ...testPath);
-    const expectImageStat = await getStat(path.join(expectImageDir, `${imageName}.png`));
-    if (!expectImageStat) return {
-      expected: null,
-      onCompare
-    };
-    const expected = await readFileAsync(path.join(expectImageDir, `${imageName}.png`));
-    return {
-      expected,
-      onCompare
-    };
-  }
-
-  const mochaOptions = {
-    timeout: 30000,
-    reporter: process.env.TEAMCITY_VERSION ? TeamcityReporter : options.reporter || CreeveyReporter,
-    reporterOptions: {
-      reportDir: config.reportDir,
-      topLevelSuite: options.browser,
-
-      get willRetry() {
-        return retries < config.maxRetries;
-      },
-
-      get images() {
-        return images;
-      },
-
-      get sessionId() {
-        return sessionId;
-      }
-
-    }
-  };
-  const mocha = new Mocha(mochaOptions); // @ts-expect-error: @types/mocha has out-dated types
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-call
-
-  mocha.cleanReferencesAfterRun(false);
-  chai.use(chaiImage(getExpected, config.diffOptions));
-  if ((await getBrowser(config, options.browser)) == null) return;
-  await addTestsFromStories(mocha.suite, config, {
-    browser: options.browser,
-    watch: options.ui,
-    debug: options.debug,
-    port: options.port
-  });
-
-  try {
-    var _await$getBrowser;
-
-    await ((_await$getBrowser = await getBrowser(config, options.browser)) === null || _await$getBrowser === void 0 ? void 0 : _await$getBrowser.getCurrentUrl());
-  } catch (_) {
-    await closeBrowser();
-  }
-
-  const browser = await getBrowser(config, options.browser);
-  const sessionId = (_await$browser$getSes = await (browser === null || browser === void 0 ? void 0 : browser.getSession())) === null || _await$browser$getSes === void 0 ? void 0 : _await$browser$getSes.getId();
-  if (browser == null) return;
-  const interval = setInterval(() => void browser.getCurrentUrl().then(url => {
-    if (options.debug) logger.debug(`${options.browser}:${chalk.gray(sessionId)}`, 'current url', chalk.magenta(url));
-  }), 10 * 1000);
-  subscribeOn('shutdown', () => clearInterval(interval));
-  mocha.suite.beforeAll(function () {
-    this.config = config;
-    this.browser = browser;
-    this.until = until;
-    this.keys = Key;
-    this.expect = chai.expect;
-    this.browserName = options.browser;
-    this.testScope = testScope;
-    this.screenshots = screenshots;
-  });
-  mocha.suite.beforeEach(switchStory);
-  subscribeOn('test', message => {
-    if (message.type != 'start') return;
-    const test = message.payload;
-    const testPath = test.path.join(' ').replace(/[|\\{}()[\]^$+*?.-]/g, '\\$&');
-    images = {};
-    error = undefined;
-    retries = test.retries;
-    mocha.grep(new RegExp(`^${testPath}$`));
-    const runner = mocha.run(runHandler); // TODO How handle browser corruption?
-
-    runner.on('fail', (_test, reason) => {
-      if (!(reason instanceof Error)) {
-        error = reason;
-      } else if (!isImageError(reason)) {
-        var _reason$stack;
-
-        error = (_reason$stack = reason.stack) !== null && _reason$stack !== void 0 ? _reason$stack : reason.message;
-      } else if (typeof reason.images == 'string') {
-        const image = images[testScope.slice(-1)[0]];
-        if (image) image.error = reason.images;
-      } else {
-        const imageErrors = reason.images;
-        Object.keys(imageErrors).forEach(imageName => {
-          const image = images[imageName];
-          if (image) image.error = imageErrors[imageName];
-        });
-      }
-    });
-  });
-  logger.info(`${options.browser}:${chalk.gray(sessionId)} is ready`);
-  emitWorkerMessage({
-    type: 'ready'
-  });
-}
-
-function hasTimeout(str) {
-  return str != null && str.toLowerCase().includes('timeout');
-}

package/lib/esm/shared.js

@@ -1,76 +0,0 @@
-import { mapValues, mergeWith, cloneDeepWith } from 'lodash';
-// NOTE: Copy-paste from storybook/api
-export const combineParameters = (...parameterSets) => // eslint-disable-next-line @typescript-eslint/no-unsafe-return
-mergeWith({}, ...parameterSets, (_, srcValue) => {
-  // Treat arrays as scalars:
-  if (Array.isArray(srcValue)) return srcValue;
-  return undefined;
-}); // NOTE: Copy-paste from storybook/api
-
-export const denormalizeStoryParameters = ({
-  globalParameters,
-  kindParameters,
-  stories
-}) => {
-  return mapValues(stories, storyData => {
-    var _globalParameters$cre, _kindParameters$story, _kindParameters$story2;
-
-    storyData.parameters.creevey = combineParameters((_globalParameters$cre = globalParameters.creevey) !== null && _globalParameters$cre !== void 0 ? _globalParameters$cre : {}, (_kindParameters$story = (_kindParameters$story2 = kindParameters[storyData.kind]) === null || _kindParameters$story2 === void 0 ? void 0 : _kindParameters$story2.creevey) !== null && _kindParameters$story !== void 0 ? _kindParameters$story : {}, storyData.parameters.creevey);
-    return storyData;
-  });
-};
-export const isSerializedRegExp = exp => {
-  return typeof exp === 'object' && exp !== null && Reflect.get(exp, '__regexp') === true;
-};
-export const serializeRegExp = exp => {
-  const {
-    source,
-    flags
-  } = exp;
-  return {
-    __regexp: true,
-    source,
-    flags
-  };
-};
-export const deserializeRegExp = ({
-  source,
-  flags
-}) => {
-  return new RegExp(source, flags);
-};
-export const serializeRawStories = stories => {
-  return mapValues(stories, storyData => {
-    const creevey = storyData.parameters.creevey;
-
-    if ((creevey === null || creevey === void 0 ? void 0 : creevey.skip) !== undefined) {
-      creevey.skip = cloneDeepWith(creevey.skip, value => {
-        if (value instanceof RegExp) {
-          return serializeRegExp(value);
-        }
-
-        return undefined;
-      });
-    }
-
-    return storyData;
-  });
-};
-export const deserializeRawStories = stories => {
-  return mapValues(stories, deserializeStory);
-};
-export const deserializeStory = story => {
-  const creevey = story.parameters.creevey;
-
-  if ((creevey === null || creevey === void 0 ? void 0 : creevey.skip) !== undefined) {
-    creevey.skip = cloneDeepWith(creevey.skip, value => {
-      if (isSerializedRegExp(value)) {
-        return deserializeRegExp(value);
-      }
-
-      return undefined;
-    });
-  }
-
-  return story;
-};

package/lib/esm/types.js

@@ -1,43 +0,0 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
-
-/* eslint-enable @typescript-eslint/no-explicit-any */
-export function noop() {
-  /* noop */
-}
-export function isDefined(value) {
-  return value !== null && value !== undefined;
-}
-export function isTest(x) {
-  return isDefined(x) && 'id' in x && 'storyId' in x && typeof x.id == 'string' && typeof x.storyId == 'string';
-}
-export function isObject(x) {
-  return typeof x == 'object' && x != null;
-}
-export function isString(x) {
-  return typeof x == 'string';
-} // eslint-disable-next-line @typescript-eslint/no-explicit-any
-
-export function isFunction(x) {
-  return typeof x == 'function';
-}
-export function isImageError(error) {
-  return error instanceof Error && 'images' in error;
-}
-export function isProcessMessage(message) {
-  return isObject(message) && 'scope' in message;
-}
-export function isWorkerMessage(message) {
-  return isProcessMessage(message) && message.scope == 'worker';
-}
-export function isStoriesMessage(message) {
-  return isProcessMessage(message) && message.scope == 'stories';
-}
-export function isTestMessage(message) {
-  return isProcessMessage(message) && message.scope == 'test';
-}
-export function isWebpackMessage(message) {
-  return isProcessMessage(message) && message.scope == 'webpack';
-}
-export function isDockerMessage(message) {
-  return isProcessMessage(message) && message.scope == 'docker';
-}