@argos-ci/cypress
Version:
Cypress SDK for visual testing with Argos.
121 lines (117 loc) • 4.69 kB
JavaScript
;
var __create = Object.create;
var __defProp = Object.defineProperty;
var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
var __getOwnPropNames = Object.getOwnPropertyNames;
var __getProtoOf = Object.getPrototypeOf;
var __hasOwnProp = Object.prototype.hasOwnProperty;
var __export = (target, all) => {
for (var name in all)
__defProp(target, name, { get: all[name], enumerable: true });
};
var __copyProps = (to, from, except, desc) => {
if (from && typeof from === "object" || typeof from === "function") {
for (let key of __getOwnPropNames(from))
if (!__hasOwnProp.call(to, key) && key !== except)
__defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
}
return to;
};
var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
// If the importer is in node compatibility mode or this is not an ESM
// file that has been converted to a CommonJS file using a Babel-
// compatible transform (i.e. "__esModule" has not been set), then set
// "default" to the CommonJS "module.exports" for node compatibility.
isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
mod
));
var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
// src/task.ts
var task_exports = {};
__export(task_exports, {
registerArgosTask: () => registerArgosTask
});
module.exports = __toCommonJS(task_exports);
var import_core = require("@argos-ci/core");
var import_node_path = require("path");
// src/shared.ts
var NAME_PREFIX = "argos/";
// src/task.ts
var import_promises = require("fs/promises");
function checkIsCypressFailedResult(results) {
return "status" in results && results.status === "failed";
}
var screenshotsDirectoryPromise = void 0;
async function getScreenshotsDirectory() {
const { createTemporaryDirectory } = await import("@argos-ci/util");
if (!screenshotsDirectoryPromise) {
screenshotsDirectoryPromise = createTemporaryDirectory();
}
return screenshotsDirectoryPromise;
}
async function createDirectory(directory) {
const { createDirectory: createDirectory2 } = await import("@argos-ci/util");
await createDirectory2(directory);
}
function registerArgosTask(on, config, options) {
on("after:screenshot", async (details) => {
const { uploadToArgos = true } = options || {};
if (!uploadToArgos) {
return { path: details.path };
}
const argosScreenshotsDir = await getScreenshotsDirectory();
if (details.name?.startsWith(NAME_PREFIX)) {
const newPath2 = (0, import_node_path.join)(
argosScreenshotsDir,
details.name.slice(NAME_PREFIX.length) + (0, import_node_path.extname)(details.path)
);
await createDirectory((0, import_node_path.dirname)(newPath2));
await (0, import_promises.copyFile)(details.path, newPath2);
return { path: newPath2 };
}
const { screenshotsFolder } = config;
if (!screenshotsFolder) {
throw new Error(
"Cypress screenshotsFolder is not defined. Please set it in your cypress.config.js"
);
}
if (!details.path.startsWith(screenshotsFolder)) {
throw new Error(
`Cypress screenshot path ${details.path} does not start with the configured screenshotsFolder ${screenshotsFolder}. Please check your cypress.config.js.`
);
}
const relativePath = details.path.slice(
screenshotsFolder.length + (screenshotsFolder.endsWith("/") ? 0 : 1)
);
const newPath = (0, import_node_path.join)(argosScreenshotsDir, relativePath);
await createDirectory((0, import_node_path.dirname)(newPath));
await (0, import_promises.copyFile)(details.path, newPath);
return { path: (0, import_node_path.join)(argosScreenshotsDir, relativePath) };
});
on("after:run", async (results) => {
const { uploadToArgos = true } = options || {};
if (!uploadToArgos) {
return;
}
const argosScreenshotsDir = await getScreenshotsDirectory();
const res = await (0, import_core.upload)({
...options,
files: ["**/*.png"],
root: argosScreenshotsDir,
metadata: {
testReport: checkIsCypressFailedResult(results) ? { status: "failed" } : {
status: "passed",
stats: {
startTime: results.startedTestsAt,
duration: results.totalDuration
}
}
}
});
console.log(`\u2705 Argos build created: ${res.build.url}`);
});
}
// Annotate the CommonJS export names for ESM import in node:
0 && (module.exports = {
registerArgosTask
});