creevey 0.8.1-beta.1 → 0.8.1-sb7.0

package/lib/esm/server/update.js

@@ -1,61 +0,0 @@
-import path from 'path';
-import fs, { mkdirSync } from 'fs';
-import micromatch from 'micromatch';
-import { isDefined } from '../types';
-
-function tryToLoadTestsData(filename) {
-  try {
-    // eslint-disable-next-line @typescript-eslint/no-var-requires
-    return require(filename);
-  } catch (_) {
-    /* noop */
-  }
-}
-
-const actualRegex = /^(.*)-actual-(\d+)\.png$/i;
-
-function approve(dirents, srcPath, dstPath, testPaths, isMatch) {
-  dirents.filter(dirent => dirent.isFile()).map(dirent => actualRegex.exec(dirent.name)).filter(isDefined).filter(([fileName, imageName]) => !testPaths || testPaths.find(([token]) => token == imageName) && isMatch(path.join(srcPath, fileName))).reduce((images, [, imageName, retry]) => Number(retry) > (images.get(imageName) ?? -1) ? images.set(imageName, Number(retry)) : images, new Map()).forEach((retry, imageName) => {
-    mkdirSync(dstPath, {
-      recursive: true
-    });
-    fs.copyFileSync(path.join(srcPath, `${imageName}-actual-${retry}.png`), path.join(dstPath, `${imageName}.png`));
-  });
-}
-
-function traverse(srcPath, dstPath, testPaths, isMatch) {
-  const dirents = fs.readdirSync(srcPath, {
-    withFileTypes: true
-  });
-  approve(dirents, srcPath, dstPath, testPaths, isMatch);
-  dirents.filter(dirent => dirent.isDirectory()).map(dirent => [dirent.name, testPaths === null || testPaths === void 0 ? void 0 : testPaths.map(([token, ...restPath]) => token == dirent.name ? restPath : null).filter(isDefined)]).filter(([, paths]) => !paths || paths.length > 0).forEach(([dirname, paths]) => traverse(path.join(srcPath, dirname), path.join(dstPath, dirname), paths, isMatch));
-}
-
-export default function update(config, grepPattern) {
-  const {
-    reportDir,
-    screenDir
-  } = config;
-  const isMatch = grepPattern ? micromatch.matcher(grepPattern, {
-    contains: true
-  }) : () => true;
-  const testsMeta = tryToLoadTestsData(`${reportDir}/tests.json`);
-  const testsReport = tryToLoadTestsData(`${reportDir}/data`);
-  let testPaths = null;
-
-  if (testsMeta && testsReport) {
-    testPaths = Object.values(testsMeta).filter(isDefined).filter(({
-      id
-    }) => {
-      var _testsReport$id;
-
-      return ((_testsReport$id = testsReport[id]) === null || _testsReport$id === void 0 ? void 0 : _testsReport$id.status) == 'failed';
-    }).map(({
-      storyPath,
-      testName,
-      browser
-    }) => [...storyPath, ...(testName ? [testName] : []), browser]);
-  }
-
-  traverse(reportDir, screenDir, testPaths, value => isMatch(path.relative(reportDir, value)));
-}

package/lib/esm/server/utils.js

@@ -1,128 +0,0 @@
-import { createWriteStream, existsSync, readFileSync, unlink } from 'fs';
-import cluster from 'cluster';
-import { isDefined, noop, isFunction } from '../types';
-import { emitShutdownMessage, sendShutdownMessage } from './messages';
-import findCacheDir from 'find-cache-dir';
-import { get } from 'https';
-export const isShuttingDown = {
-  current: false
-};
-export const LOCALHOST_REGEXP = /(localhost|127\.0\.0\.1)/i;
-export const extensions = ['.js', '.jsx', '.ts', '.tsx'];
-export const skipOptionKeys = ['in', 'kinds', 'stories', 'tests', 'reason'];
-
-function matchBy(pattern, value) {
-  return typeof pattern == 'string' && pattern == value || Array.isArray(pattern) && pattern.includes(value) || pattern instanceof RegExp && pattern.test(value) || !isDefined(pattern);
-}
-
-export function shouldSkip(browser, meta, skipOptions, test) {
-  if (typeof skipOptions != 'object') {
-    return skipOptions;
-  }
-
-  for (const skipKey in skipOptions) {
-    const reason = shouldSkipByOption(browser, meta, skipOptions[skipKey], skipKey, test);
-    if (reason) return reason;
-  }
-
-  return false;
-}
-export function shouldSkipByOption(browser, meta, skipOption, reason, test) {
-  if (Array.isArray(skipOption)) {
-    for (const skip of skipOption) {
-      const result = shouldSkipByOption(browser, meta, skip, reason, test);
-      if (result) return result;
-    }
-
-    return false;
-  }
-
-  const {
-    in: browsers,
-    kinds,
-    stories,
-    tests
-  } = skipOption;
-  const {
-    kind,
-    story
-  } = meta;
-  const skipByBrowser = matchBy(browsers, browser);
-  const skipByKind = matchBy(kinds, kind);
-  const skipByStory = matchBy(stories, story);
-  const skipByTest = !isDefined(test) || matchBy(tests, test);
-  return skipByBrowser && skipByKind && skipByStory && skipByTest && reason;
-}
-export async function shutdownWorkers() {
-  isShuttingDown.current = true;
-  await Promise.all(Object.values(cluster.workers ?? {}).filter(isDefined).filter(worker => worker.isConnected()).map(worker => new Promise(resolve => {
-    const timeout = setTimeout(() => worker.kill(), 10000);
-    worker.on('exit', () => {
-      clearTimeout(timeout);
-      resolve();
-    });
-    sendShutdownMessage(worker);
-  })));
-  emitShutdownMessage();
-}
-export function shutdown() {
-  // eslint-disable-next-line no-process-exit
-  process.exit();
-}
-export function getCreeveyCache() {
-  return findCacheDir({
-    name: 'creevey',
-    cwd: __dirname
-  });
-}
-export async function runSequence(seq, predicate) {
-  for (const fn of seq) {
-    if (predicate()) await fn();
-  }
-}
-export function testsToImages(tests) {
-  return new Set([].concat(...tests.filter(isDefined).map(({
-    browser,
-    testName,
-    storyPath,
-    results
-  }) => {
-    var _results$slice$;
-
-    return Object.keys((results === null || results === void 0 ? void 0 : (_results$slice$ = results.slice(-1)[0]) === null || _results$slice$ === void 0 ? void 0 : _results$slice$.images) ?? {}).map(image => `${[...storyPath, testName, browser, browser == image ? undefined : image].filter(isDefined).join('/')}.png`);
-  })));
-} // https://tuhrig.de/how-to-know-you-are-inside-a-docker-container/
-
-export const isInsideDocker = existsSync('/proc/1/cgroup') && /docker/.test(readFileSync('/proc/1/cgroup', 'utf8'));
-export const downloadBinary = (downloadUrl, destination) => new Promise((resolve, reject) => get(downloadUrl, response => {
-  if (response.statusCode == 302) {
-    const {
-      location
-    } = response.headers;
-    if (!location) return reject(new Error(`Couldn't download selenoid. Status code: ${response.statusCode ?? 'UNKNOWN'}`));
-    return resolve(downloadBinary(location, destination));
-  }
-
-  if (response.statusCode != 200) return reject(new Error(`Couldn't download selenoid. Status code: ${response.statusCode ?? 'UNKNOWN'}`));
-  const fileStream = createWriteStream(destination);
-  response.pipe(fileStream);
-  fileStream.on('finish', () => {
-    fileStream.close();
-    resolve();
-  });
-  fileStream.on('error', error => {
-    unlink(destination, noop);
-    reject(error);
-  });
-}));
-export function removeProps(obj, propPath) {
-  const [prop, ...restPath] = propPath;
-
-  if (restPath.length > 0) {
-    if (typeof prop == 'string') obj[prop] && removeProps(obj[prop], restPath);
-    if (isFunction(prop)) Object.keys(obj).filter(prop).forEach(key => obj[key] && removeProps(obj[key], restPath));
-  } else {
-    if (typeof prop == 'string') delete obj[prop];
-    if (isFunction(prop)) Object.keys(obj).filter(prop).forEach(key => delete obj[key]);
-  }
-}

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

@@ -1,130 +0,0 @@
-import { PNG } from 'pngjs';
-import pixelmatch from 'pixelmatch';
-
-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 = PNG.sync.read(expect);
-  const actualImage = PNG.sync.read(actual);
-  const width = Math.max(actualImage.width, expectImage.width);
-  const height = Math.max(actualImage.height, expectImage.height);
-  const diffImage = new 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);
-  }
-
-  pixelmatch(expectImageData, actualImageData, diffImage.data, width, height, diffOptions);
-  return {
-    isEqual: !hasDiffPixels(diffImage.data),
-    diff: PNG.sync.write(diffImage)
-  };
-}
-
-export default function (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/esm/server/worker/helpers.js

@@ -1,60 +0,0 @@
-import { Suite, Test } from 'mocha';
-import { isDefined } from '../../types';
-import { loadTestsFromStories } from '../stories';
-
-function findOrCreateSuite(name, parent) {
-  const suite = parent.suites.find(({
-    title
-  }) => title == name) || new Suite(name, parent.ctx);
-
-  if (!suite.parent) {
-    suite.parent = parent;
-    parent.addSuite(suite);
-  }
-
-  return suite;
-}
-
-function createTest(name, fn, skip = false) {
-  const test = new 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(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 Test) parent.tests = parent.tests.filter(test => test != testOrSuite);
-  if (testOrSuite instanceof Suite) parent.suites = parent.suites.filter(suite => suite != testOrSuite);
-  if (parent.tests.length == 0 && parent.suites.length == 0) removeTestOrSuite(parent);
-}
-
-export async function addTestsFromStories(rootSuite, config, {
-  browser,
-  ...options
-}) {
-  const mochaTestsById = new Map();
-  const tests = await 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(isDefined).forEach(test => mochaTestsById.set(test.id, addTest(rootSuite, test)));
-}

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

@@ -1 +0,0 @@
-export { default } from './worker';

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

@@ -1,86 +0,0 @@
-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 ?? topLevelSuite)}:${error}`, error => `${error.stack ?? error.message}`).join('\n  ')));
-  }
-
-}
-export class TeamcityReporter extends reporters.Base {
-  constructor(runner, options) {
-    super(runner);
-    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) => {
-      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.stack ?? '')}' 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}']`));
-  }
-
-  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, "|'");
-  };
-}
-
-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 => {
-      errors.push(imageErrorToString(imageErrors[imageName] ?? '', imageName));
-    });
-  }
-
-  return errors;
-}