@johnf/react-native-owl/lib/module/screenshot.js

Visual regression testing for React Native

"use strict";

import execa from 'execa';
import { promises as fs } from 'fs';
import path from 'path';
import { fileExists } from "./utils/file-exists.js";
import { Logger } from "./logger.js";
export const cleanupScreenshots = async () => {
  const latestDirPath = path.join(process.cwd(), '.owl', 'latest');
  await fs.rm(latestDirPath, {
    recursive: true,
    force: true
  });
  const diffDirPath = path.join(process.cwd(), '.owl', 'diff');
  await fs.rm(diffDirPath, {
    recursive: true,
    force: true
  });
};

/**
 * Takes a screenshot from the simulator.
 * @param filename - Required. The filename(excluding the extension) that will be used to save the screenshot. ie. 'homepage'
 * @returns the path to the screenshot.
 */
export const takeScreenshot = async filename => {
  const platform = process.env.OWL_PLATFORM;
  const iosDevice = process.env.OWL_IOS_SIMULATOR;
  const iosSimulator = iosDevice?.replace(/([ /])/g, '\\$1');
  const debug = process.env.OWL_DEBUG === 'true';
  const updateBaseline = process.env.OWL_UPDATE_BASELINE === 'true';
  const screenshotFilename = `${filename}.png`;
  const stdio = debug ? 'inherit' : 'ignore';
  const logger = new Logger(!!debug);
  const screenshotsDirPath = path.join(process.cwd(), '.owl');
  await fs.mkdir(screenshotsDirPath, {
    recursive: true
  });
  const gitignoreExist = await fileExists(path.join(screenshotsDirPath, '.gitignore'));
  if (!gitignoreExist) {
    await fs.writeFile(path.join(process.cwd(), '.owl', '.gitignore'), '# generated by react-native-owl\ndiff/\nlatest/\nreport/\n');
  }
  const baselineExist = await fileExists(path.join(screenshotsDirPath, 'baseline', platform, screenshotFilename));
  const DIR_NAME = updateBaseline || !baselineExist ? 'baseline' : 'latest';
  const cwd = path.join(screenshotsDirPath, DIR_NAME, platform);
  await fs.mkdir(cwd, {
    recursive: true
  });
  const screenshotCommand = platform === 'ios' ? `xcrun simctl io ${iosSimulator} screenshot ${screenshotFilename}` : `adb exec-out screencap -p > ${screenshotFilename}`;
  logger.info(`[OWL - CLI] Will run the screenshot command: ${screenshotCommand}.`);
  await execa.command(screenshotCommand, {
    stdio,
    cwd,
    shell: platform === 'android'
  });
  if (!baselineExist) {
    logger.print(`[OWL - CLI] ${screenshotFilename} baseline screenshot created.`);
  }
  const screenshotPath = `${cwd}/${screenshotFilename}`;
  logger.info(`[OWL - CLI] Screenshot saved to ${screenshotPath}.`);
  return screenshotPath;
};
//# sourceMappingURL=screenshot.js.map