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

package/lib/cjs/server/worker/chai-image.js

@@ -1,142 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = _default;
-
-var _pngjs = require("pngjs");
-
-var _pixelmatch = _interopRequireDefault(require("pixelmatch"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-function normalizeImageSize(image, width, height) {
-  const normalizedImage = Buffer.alloc(4 * width * height);
-
-  for (let y = 0; y < height; y++) {
-    for (let x = 0; x < width; x++) {
-      const i = (y * width + x) * 4;
-
-      if (x < image.width && y < image.height) {
-        const j = (y * image.width + x) * 4;
-        normalizedImage[i + 0] = image.data[j + 0];
-        normalizedImage[i + 1] = image.data[j + 1];
-        normalizedImage[i + 2] = image.data[j + 2];
-        normalizedImage[i + 3] = image.data[j + 3];
-      } else {
-        normalizedImage[i + 0] = 0;
-        normalizedImage[i + 1] = 0;
-        normalizedImage[i + 2] = 0;
-        normalizedImage[i + 3] = 0;
-      }
-    }
-  }
-
-  return normalizedImage;
-}
-
-function hasDiffPixels(diff) {
-  for (let i = 0; i < diff.length; i += 4) {
-    if (diff[i + 0] == 255 && diff[i + 1] == 0 && diff[i + 2] == 0 && diff[i + 3] == 255) return true;
-  }
-
-  return false;
-}
-
-function compareImages(expect, actual, diffOptions) {
-  const expectImage = _pngjs.PNG.sync.read(expect);
-
-  const actualImage = _pngjs.PNG.sync.read(actual);
-
-  const width = Math.max(actualImage.width, expectImage.width);
-  const height = Math.max(actualImage.height, expectImage.height);
-  const diffImage = new _pngjs.PNG({
-    width,
-    height
-  });
-  let actualImageData = actualImage.data;
-
-  if (actualImage.width < width || actualImage.height < height) {
-    actualImageData = normalizeImageSize(actualImage, width, height);
-  }
-
-  let expectImageData = expectImage.data;
-
-  if (expectImage.width < width || expectImage.height < height) {
-    expectImageData = normalizeImageSize(expectImage, width, height);
-  }
-
-  (0, _pixelmatch.default)(expectImageData, actualImageData, diffImage.data, width, height, diffOptions);
-  return {
-    isEqual: !hasDiffPixels(diffImage.data),
-    diff: _pngjs.PNG.sync.write(diffImage)
-  };
-}
-
-function _default(getExpected, diffOptions) {
-  return function chaiImage({
-    Assertion
-  }, utils) {
-    async function assertImage(actual, imageName) {
-      let onCompare = () => Promise.resolve();
-
-      let expected = await getExpected(imageName);
-      if (!(expected instanceof Buffer) && expected != null) ({
-        expected,
-        onCompare
-      } = expected);
-
-      if (expected == null) {
-        await onCompare(actual);
-        return imageName ? `Expected image '${imageName}' does not exists` : 'Expected image does not exists';
-      }
-
-      if (actual.equals(expected)) return await onCompare(actual);
-      const {
-        isEqual,
-        diff
-      } = compareImages(expected, actual, diffOptions);
-      if (isEqual) return await onCompare(actual);
-      await onCompare(actual, expected, diff);
-      return imageName ? `Expected image '${imageName}' to match` : 'Expected image to match';
-    }
-
-    utils.addMethod(Assertion.prototype, 'matchImage', async function matchImage(imageName) {
-      const actual = utils.flag(this, 'object');
-      const errorMessage = await assertImage(typeof actual == 'string' ? Buffer.from(actual, 'base64') : actual, imageName);
-
-      if (errorMessage) {
-        throw createImageError(imageName ? {
-          [imageName]: errorMessage
-        } : errorMessage);
-      }
-    });
-    utils.addMethod(Assertion.prototype, 'matchImages', async function matchImages() {
-      const errors = {};
-      await Promise.all(Object.entries(utils.flag(this, 'object')).map(async ([imageName, imageOrBase64]) => {
-        let errorMessage;
-
-        try {
-          errorMessage = await assertImage(typeof imageOrBase64 == 'string' ? Buffer.from(imageOrBase64, 'base64') : imageOrBase64, imageName);
-        } catch (error) {
-          errorMessage = error.stack;
-        }
-
-        if (errorMessage) {
-          errors[imageName] = errorMessage;
-        }
-      }));
-
-      if (Object.keys(errors).length > 0) {
-        throw createImageError(errors);
-      }
-    });
-  };
-}
-
-function createImageError(imageErrors) {
-  const error = new Error('Expected image to match');
-  error.images = imageErrors;
-  return error;
-}

package/lib/cjs/server/worker/helpers.js

@@ -1,69 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.addTestsFromStories = addTestsFromStories;
-
-var _mocha = require("mocha");
-
-var _types = require("../../types");
-
-var _stories = require("../stories");
-
-function findOrCreateSuite(name, parent) {
-  const suite = parent.suites.find(({
-    title
-  }) => title == name) || new _mocha.Suite(name, parent.ctx);
-
-  if (!suite.parent) {
-    suite.parent = parent;
-    parent.addSuite(suite);
-  }
-
-  return suite;
-}
-
-function createTest(name, fn, skip = false) {
-  const test = new _mocha.Test(name, skip ? undefined : fn);
-  test.pending = Boolean(skip); // NOTE Can't define skip reason in mocha https://github.com/mochajs/mocha/issues/2026
-
-  test.skipReason = skip;
-  return test;
-}
-
-function addTest(rootSuite, test) {
-  const [testName, ...suitePath] = [...test.storyPath, test.testName].reverse().filter(_types.isDefined);
-  const suite = suitePath.reduceRight((subSuite, suiteName) => findOrCreateSuite(suiteName, subSuite), rootSuite);
-  const mochaTest = createTest(testName, test.fn, test.skip);
-  suite.addTest(mochaTest);
-  mochaTest.ctx = Object.setPrototypeOf({
-    id: test.id,
-    story: test.story
-  }, suite.ctx);
-  return mochaTest;
-}
-
-function removeTestOrSuite(testOrSuite) {
-  const {
-    parent
-  } = testOrSuite;
-  if (!parent) return;
-  if (testOrSuite instanceof _mocha.Test) parent.tests = parent.tests.filter(test => test != testOrSuite);
-  if (testOrSuite instanceof _mocha.Suite) parent.suites = parent.suites.filter(suite => suite != testOrSuite);
-  if (parent.tests.length == 0 && parent.suites.length == 0) removeTestOrSuite(parent);
-}
-
-async function addTestsFromStories(rootSuite, config, {
-  browser,
-  ...options
-}) {
-  const mochaTestsById = new Map();
-  const tests = await (0, _stories.loadTestsFromStories)([browser], listener => config.storiesProvider(config, options, listener), testsDiff => Object.entries(testsDiff).forEach(([id, newTest]) => {
-    const oldTest = mochaTestsById.get(id);
-    mochaTestsById.delete(id);
-    if (oldTest) removeTestOrSuite(oldTest);
-    if (newTest) mochaTestsById.set(id, addTest(rootSuite, newTest));
-  }));
-  Object.values(tests).filter(_types.isDefined).forEach(test => mochaTestsById.set(test.id, addTest(rootSuite, test)));
-}

package/lib/cjs/server/worker/index.js

@@ -1,15 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-Object.defineProperty(exports, "default", {
-  enumerable: true,
-  get: function () {
-    return _worker.default;
-  }
-});
-
-var _worker = _interopRequireDefault(require("./worker"));
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }

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

@@ -1,120 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.TeamcityReporter = exports.CreeveyReporter = void 0;
-
-var _chalk = _interopRequireDefault(require("chalk"));
-
-var _mocha = require("mocha");
-
-var _loglevelPluginPrefix = _interopRequireDefault(require("loglevel-plugin-prefix"));
-
-var _types = require("../../types");
-
-var _logger = require("../logger");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-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; }
-
-const testLevels = {
-  INFO: _chalk.default.green('PASS'),
-  WARN: _chalk.default.yellow('START'),
-  ERROR: _chalk.default.red('FAIL')
-};
-
-class CreeveyReporter extends _mocha.reporters.Base {
-  constructor(runner, options) {
-    super(runner);
-    const {
-      sessionId,
-      topLevelSuite
-    } = options.reporterOptions;
-    const testLogger = (0, _logger.getLogger)(topLevelSuite);
-
-    _loglevelPluginPrefix.default.apply(testLogger, {
-      format(level) {
-        return `${testLevels[level]} => (${topLevelSuite}:${_chalk.default.gray(sessionId)})`;
-      }
-
-    });
-
-    runner.on('test', test => testLogger.warn(_chalk.default.cyan(test.titlePath().join('/'))));
-    runner.on('pass', test => testLogger.info(_chalk.default.cyan(test.titlePath().join('/'))));
-    runner.on('fail', (test, error) => testLogger.error(_chalk.default.cyan(test.titlePath().join('/')), '\n  ', getErrors(error, (error, imageName) => `${_chalk.default.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  ')));
-  }
-
-}
-
-exports.CreeveyReporter = CreeveyReporter;
-
-class TeamcityReporter extends _mocha.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(_types.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}']`));
-  }
-
-}
-
-exports.TeamcityReporter = TeamcityReporter;
-
-function getErrors(error, imageErrorToString, errorToString) {
-  const errors = [];
-
-  if (!(error instanceof Error)) {
-    errors.push(error);
-  } else if (!(0, _types.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/cjs/server/worker/worker.js

@@ -1,278 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.default = worker;
-
-var _util = require("util");
-
-var _fs = _interopRequireDefault(require("fs"));
-
-var _path = _interopRequireDefault(require("path"));
-
-var _chai = _interopRequireDefault(require("chai"));
-
-var _chalk = _interopRequireDefault(require("chalk"));
-
-var _mocha = _interopRequireDefault(require("mocha"));
-
-var _seleniumWebdriver = require("selenium-webdriver");
-
-var _types = require("../../types");
-
-var _messages = require("../messages");
-
-var _chaiImage = _interopRequireDefault(require("./chai-image"));
-
-var _selenium = require("../selenium");
-
-var _reporter = require("./reporter");
-
-var _helpers = require("./helpers");
-
-var _logger = require("../logger");
-
-function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
-
-const statAsync = (0, _util.promisify)(_fs.default.stat);
-const readdirAsync = (0, _util.promisify)(_fs.default.readdir);
-const readFileAsync = (0, _util.promisify)(_fs.default.readFile);
-const writeFileAsync = (0, _util.promisify)(_fs.default.writeFile);
-const mkdirAsync = (0, _util.promisify)(_fs.default.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
-
-
-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 ? (0, _messages.emitWorkerMessage)({
-        type: 'error',
-        payload: {
-          error: (_error2 = error) !== null && _error2 !== void 0 ? _error2 : 'Unknown error'
-        }
-      }) : (0, _messages.emitTestMessage)({
-        type: 'end',
-        payload
-      });
-    } else {
-      (0, _messages.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.default.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.default.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.default.join(config.screenDir, ...testPath);
-
-    const expectImageStat = await getStat(_path.default.join(expectImageDir, `${imageName}.png`));
-    if (!expectImageStat) return {
-      expected: null,
-      onCompare
-    };
-    const expected = await readFileAsync(_path.default.join(expectImageDir, `${imageName}.png`));
-    return {
-      expected,
-      onCompare
-    };
-  }
-
-  const mochaOptions = {
-    timeout: 30000,
-    reporter: process.env.TEAMCITY_VERSION ? _reporter.TeamcityReporter : options.reporter || _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.default(mochaOptions); // @ts-expect-error: @types/mocha has out-dated types
-  // eslint-disable-next-line @typescript-eslint/no-unsafe-call
-
-  mocha.cleanReferencesAfterRun(false);
-
-  _chai.default.use((0, _chaiImage.default)(getExpected, config.diffOptions));
-
-  if ((await (0, _selenium.getBrowser)(config, options.browser)) == null) return;
-  await (0, _helpers.addTestsFromStories)(mocha.suite, config, {
-    browser: options.browser,
-    watch: options.ui,
-    debug: options.debug,
-    port: options.port
-  });
-
-  try {
-    var _await$getBrowser;
-
-    await ((_await$getBrowser = await (0, _selenium.getBrowser)(config, options.browser)) === null || _await$getBrowser === void 0 ? void 0 : _await$getBrowser.getCurrentUrl());
-  } catch (_) {
-    await (0, _selenium.closeBrowser)();
-  }
-
-  const browser = await (0, _selenium.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.logger.debug(`${options.browser}:${_chalk.default.gray(sessionId)}`, 'current url', _chalk.default.magenta(url));
-  }), 10 * 1000);
-  (0, _messages.subscribeOn)('shutdown', () => clearInterval(interval));
-  mocha.suite.beforeAll(function () {
-    this.config = config;
-    this.browser = browser;
-    this.until = _seleniumWebdriver.until;
-    this.keys = _seleniumWebdriver.Key;
-    this.expect = _chai.default.expect;
-    this.browserName = options.browser;
-    this.testScope = testScope;
-    this.screenshots = screenshots;
-  });
-  mocha.suite.beforeEach(_selenium.switchStory);
-  (0, _messages.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 (!(0, _types.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.logger.info(`${options.browser}:${_chalk.default.gray(sessionId)} is ready`);
-
-  (0, _messages.emitWorkerMessage)({
-    type: 'ready'
-  });
-}
-
-function hasTimeout(str) {
-  return str != null && str.toLowerCase().includes('timeout');
-}