allure-playwright
Version:
Allure Playwright integration
857 lines (849 loc) • 45.2 kB
JavaScript
"use strict";
function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
Object.defineProperty(exports, "__esModule", {
value: true
});
exports["default"] = exports.allure = exports.AllureReporter = void 0;
Object.defineProperty(exports, "expect", {
enumerable: true,
get: function get() {
return _test.expect;
}
});
Object.defineProperty(exports, "test", {
enumerable: true,
get: function get() {
return _test.test;
}
});
var _nodeFs = require("node:fs");
var _nodePath = _interopRequireDefault(require("node:path"));
var _nodeProcess = _interopRequireDefault(require("node:process"));
var _allureJsCommons = require("allure-js-commons");
var _sdk = require("allure-js-commons/sdk");
var _reporter = require("allure-js-commons/sdk/reporter");
var _legacy = require("./legacy.js");
var _utils = require("./utils.js");
var _test = require("@playwright/test");
function _interopRequireDefault(e) { return e && e.__esModule ? e : { "default": e }; }
function _regenerator() { /*! regenerator-runtime -- Copyright (c) 2014-present, Facebook, Inc. -- license (MIT): https://github.com/babel/babel/blob/main/packages/babel-helpers/LICENSE */ var e, t, r = "function" == typeof Symbol ? Symbol : {}, n = r.iterator || "@@iterator", o = r.toStringTag || "@@toStringTag"; function i(r, n, o, i) { var c = n && n.prototype instanceof Generator ? n : Generator, u = Object.create(c.prototype); return _regeneratorDefine2(u, "_invoke", function (r, n, o) { var i, c, u, f = 0, p = o || [], y = !1, G = { p: 0, n: 0, v: e, a: d, f: d.bind(e, 4), d: function d(t, r) { return i = t, c = 0, u = e, G.n = r, a; } }; function d(r, n) { for (c = r, u = n, t = 0; !y && f && !o && t < p.length; t++) { var o, i = p[t], d = G.p, l = i[2]; r > 3 ? (o = l === n) && (u = i[(c = i[4]) ? 5 : (c = 3, 3)], i[4] = i[5] = e) : i[0] <= d && ((o = r < 2 && d < i[1]) ? (c = 0, G.v = n, G.n = i[1]) : d < l && (o = r < 3 || i[0] > n || n > l) && (i[4] = r, i[5] = n, G.n = l, c = 0)); } if (o || r > 1) return a; throw y = !0, n; } return function (o, p, l) { if (f > 1) throw TypeError("Generator is already running"); for (y && 1 === p && d(p, l), c = p, u = l; (t = c < 2 ? e : u) || !y;) { i || (c ? c < 3 ? (c > 1 && (G.n = -1), d(c, u)) : G.n = u : G.v = u); try { if (f = 2, i) { if (c || (o = "next"), t = i[o]) { if (!(t = t.call(i, u))) throw TypeError("iterator result is not an object"); if (!t.done) return t; u = t.value, c < 2 && (c = 0); } else 1 === c && (t = i["return"]) && t.call(i), c < 2 && (u = TypeError("The iterator does not provide a '" + o + "' method"), c = 1); i = e; } else if ((t = (y = G.n < 0) ? u : r.call(n, G)) !== a) break; } catch (t) { i = e, c = 1, u = t; } finally { f = 1; } } return { value: t, done: y }; }; }(r, o, i), !0), u; } var a = {}; function Generator() {} function GeneratorFunction() {} function GeneratorFunctionPrototype() {} t = Object.getPrototypeOf; var c = [][n] ? t(t([][n]())) : (_regeneratorDefine2(t = {}, n, function () { return this; }), t), u = GeneratorFunctionPrototype.prototype = Generator.prototype = Object.create(c); function f(e) { return Object.setPrototypeOf ? Object.setPrototypeOf(e, GeneratorFunctionPrototype) : (e.__proto__ = GeneratorFunctionPrototype, _regeneratorDefine2(e, o, "GeneratorFunction")), e.prototype = Object.create(u), e; } return GeneratorFunction.prototype = GeneratorFunctionPrototype, _regeneratorDefine2(u, "constructor", GeneratorFunctionPrototype), _regeneratorDefine2(GeneratorFunctionPrototype, "constructor", GeneratorFunction), GeneratorFunction.displayName = "GeneratorFunction", _regeneratorDefine2(GeneratorFunctionPrototype, o, "GeneratorFunction"), _regeneratorDefine2(u), _regeneratorDefine2(u, o, "Generator"), _regeneratorDefine2(u, n, function () { return this; }), _regeneratorDefine2(u, "toString", function () { return "[object Generator]"; }), (_regenerator = function _regenerator() { return { w: i, m: f }; })(); }
function _regeneratorDefine2(e, r, n, t) { var i = Object.defineProperty; try { i({}, "", {}); } catch (e) { i = 0; } _regeneratorDefine2 = function _regeneratorDefine(e, r, n, t) { if (r) i ? i(e, r, { value: n, enumerable: !t, configurable: !t, writable: !t }) : e[r] = n;else { var o = function o(r, n) { _regeneratorDefine2(e, r, function (e) { return this._invoke(r, n, e); }); }; o("next", 0), o("throw", 1), o("return", 2); } }, _regeneratorDefine2(e, r, n, t); }
function asyncGeneratorStep(n, t, e, r, o, a, c) { try { var i = n[a](c), u = i.value; } catch (n) { return void e(n); } i.done ? t(u) : Promise.resolve(u).then(r, o); }
function _asyncToGenerator(n) { return function () { var t = this, e = arguments; return new Promise(function (r, o) { var a = n.apply(t, e); function _next(n) { asyncGeneratorStep(a, r, o, _next, _throw, "next", n); } function _throw(n) { asyncGeneratorStep(a, r, o, _next, _throw, "throw", n); } _next(void 0); }); }; }
function _createForOfIteratorHelper(r, e) { var t = "undefined" != typeof Symbol && r[Symbol.iterator] || r["@@iterator"]; if (!t) { if (Array.isArray(r) || (t = _unsupportedIterableToArray(r)) || e && r && "number" == typeof r.length) { t && (r = t); var _n = 0, F = function F() {}; return { s: F, n: function n() { return _n >= r.length ? { done: !0 } : { done: !1, value: r[_n++] }; }, e: function e(r) { throw r; }, f: F }; } throw new TypeError("Invalid attempt to iterate non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); } var o, a = !0, u = !1; return { s: function s() { t = t.call(r); }, n: function n() { var r = t.next(); return a = r.done, r; }, e: function e(r) { u = !0, o = r; }, f: function f() { try { a || null == t["return"] || t["return"](); } finally { if (u) throw o; } } }; }
function _toArray(r) { return _arrayWithHoles(r) || _iterableToArray(r) || _unsupportedIterableToArray(r) || _nonIterableRest(); }
function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
function _arrayWithHoles(r) { if (Array.isArray(r)) return r; }
function _toConsumableArray(r) { return _arrayWithoutHoles(r) || _iterableToArray(r) || _unsupportedIterableToArray(r) || _nonIterableSpread(); }
function _nonIterableSpread() { throw new TypeError("Invalid attempt to spread non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
function _unsupportedIterableToArray(r, a) { if (r) { if ("string" == typeof r) return _arrayLikeToArray(r, a); var t = {}.toString.call(r).slice(8, -1); return "Object" === t && r.constructor && (t = r.constructor.name), "Map" === t || "Set" === t ? Array.from(r) : "Arguments" === t || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(t) ? _arrayLikeToArray(r, a) : void 0; } }
function _iterableToArray(r) { if ("undefined" != typeof Symbol && null != r[Symbol.iterator] || null != r["@@iterator"]) return Array.from(r); }
function _arrayWithoutHoles(r) { if (Array.isArray(r)) return _arrayLikeToArray(r); }
function _arrayLikeToArray(r, a) { (null == a || a > r.length) && (a = r.length); for (var e = 0, n = Array(a); e < a; e++) n[e] = r[e]; return n; }
function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
function _classCallCheck(a, n) { if (!(a instanceof n)) throw new TypeError("Cannot call a class as a function"); }
function _defineProperties(e, r) { for (var t = 0; t < r.length; t++) { var o = r[t]; o.enumerable = o.enumerable || !1, o.configurable = !0, "value" in o && (o.writable = !0), Object.defineProperty(e, _toPropertyKey(o.key), o); } }
function _createClass(e, r, t) { return r && _defineProperties(e.prototype, r), t && _defineProperties(e, t), Object.defineProperty(e, "prototype", { writable: !1 }), e; }
function _classPrivateMethodInitSpec(e, a) { _checkPrivateRedeclaration(e, a), a.add(e); }
function _checkPrivateRedeclaration(e, t) { if (t.has(e)) throw new TypeError("Cannot initialize the same private elements twice on an object"); }
function _defineProperty(e, r, t) { return (r = _toPropertyKey(r)) in e ? Object.defineProperty(e, r, { value: t, enumerable: !0, configurable: !0, writable: !0 }) : e[r] = t, e; }
function _toPropertyKey(t) { var i = _toPrimitive(t, "string"); return "symbol" == _typeof(i) ? i : i + ""; }
function _toPrimitive(t, r) { if ("object" != _typeof(t) || !t) return t; var e = t[Symbol.toPrimitive]; if (void 0 !== e) { var i = e.call(t, r || "default"); if ("object" != _typeof(i)) return i; throw new TypeError("@@toPrimitive must return a primitive value."); } return ("string" === r ? String : Number)(t); }
function _assertClassBrand(e, t, n) { if ("function" == typeof e ? e === t : e.has(t)) return arguments.length < 3 ? t : n; throw new TypeError("Private element is not present on this object"); } /* eslint max-lines: off */
var _AllureReporter_brand = /*#__PURE__*/new WeakSet();
var AllureReporter = exports.AllureReporter = /*#__PURE__*/function () {
function AllureReporter(config) {
_classCallCheck(this, AllureReporter);
_classPrivateMethodInitSpec(this, _AllureReporter_brand);
_defineProperty(this, "config", void 0);
_defineProperty(this, "suite", void 0);
_defineProperty(this, "options", void 0);
_defineProperty(this, "allureRuntime", void 0);
_defineProperty(this, "globalStartTime", new Date());
_defineProperty(this, "processedDiffs", []);
_defineProperty(this, "startedTestCasesTitlesCache", []);
_defineProperty(this, "allureResultsUuids", new Map());
_defineProperty(this, "attachmentSteps", new Map());
_defineProperty(this, "beforeHooksStepsStack", new Map());
_defineProperty(this, "afterHooksStepsStack", new Map());
_defineProperty(this, "beforeHooksAttachmentsStack", new Map());
_defineProperty(this, "afterHooksAttachmentsStack", new Map());
this.options = _objectSpread({
suiteTitle: true,
detail: true
}, config);
}
return _createClass(AllureReporter, [{
key: "onConfigure",
value: function onConfigure(config) {
this.config = config;
var testPlan = (0, _reporter.parseTestPlan)();
if (!testPlan) {
return;
}
// @ts-ignore
var configElement = config[Object.getOwnPropertySymbols(config)[0]];
if (!configElement) {
return;
}
var testsWithSelectors = testPlan.tests.filter(function (test) {
return test.selector;
});
var v1ReporterTests = [];
var v2ReporterTests = [];
var cliArgs = [];
testsWithSelectors.forEach(function (test) {
// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
if (!/#/.test(test.selector)) {
v2ReporterTests.push(test);
return;
}
v1ReporterTests.push(test);
});
// The path needs to be specific to the current OS. Otherwise, it may not match against the test file.
var selectorToGrepPattern = function selectorToGrepPattern(selector) {
return (0, _reporter.escapeRegExp)(_nodePath["default"].normalize("/".concat(selector)));
};
if (v2ReporterTests.length) {
// we need to cut off column because playwright works only with line number
var v2SelectorsArgs = v2ReporterTests
// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
.map(function (test) {
return test.selector.replace(/:\d+$/, "");
}).map(selectorToGrepPattern);
cliArgs.push.apply(cliArgs, _toConsumableArray(v2SelectorsArgs));
}
if (v1ReporterTests.length) {
var v1SelectorsArgs = v1ReporterTests
// we can filter tests only by absolute path, so we need to cut off test name
// eslint-disable-next-line @typescript-eslint/no-unnecessary-type-assertion
.map(function (test) {
return test.selector.split("#")[0];
}).map(selectorToGrepPattern);
cliArgs.push.apply(cliArgs, _toConsumableArray(v1SelectorsArgs));
}
if (!cliArgs.length) {
return;
}
configElement.cliArgs = cliArgs;
}
}, {
key: "onError",
value: function onError() {}
}, {
key: "onExit",
value: function onExit() {}
}, {
key: "onStdErr",
value: function onStdErr() {}
}, {
key: "onStdOut",
value: function onStdOut() {}
}, {
key: "onBegin",
value: function onBegin(suite) {
this.suite = suite;
this.allureRuntime = new _reporter.ReporterRuntime(_objectSpread(_objectSpread({}, this.options), {}, {
writer: (0, _reporter.createDefaultWriter)({
resultsDir: this.options.resultsDir
})
}));
}
}, {
key: "onTestBegin",
value: function onTestBegin(test) {
var suite = test.parent;
var titleMetadata = (0, _sdk.extractMetadataFromString)(test.title);
var project = suite.project();
var testFilePath = _nodePath["default"].relative(project === null || project === void 0 ? void 0 : project.testDir, test.location.file);
var relativeFileParts = testFilePath.split(_nodePath["default"].sep);
var relativeFile = relativeFileParts.join("/");
// root > project > file path > test.describe...
var _suite$titlePath = suite.titlePath(),
_suite$titlePath2 = _toArray(_suite$titlePath),
suiteTitles = _suite$titlePath2.slice(3);
var nameSuites = suiteTitles.length > 0 ? "".concat(suiteTitles.join(" "), " ") : "";
var testCaseIdBase = "".concat(relativeFile, "#").concat(nameSuites).concat(test.title);
var result = {
name: titleMetadata.cleanTitle,
labels: [].concat(_toConsumableArray(titleMetadata.labels), _toConsumableArray((0, _reporter.getEnvironmentLabels)())),
links: _toConsumableArray(titleMetadata.links),
parameters: [],
steps: [],
testCaseId: (0, _reporter.md5)(testCaseIdBase),
fullName: "".concat(relativeFile, ":").concat(test.location.line, ":").concat(test.location.column),
titlePath: relativeFileParts.concat.apply(relativeFileParts, _toConsumableArray(suiteTitles))
};
result.labels.push((0, _reporter.getLanguageLabel)());
result.labels.push((0, _reporter.getFrameworkLabel)("playwright"));
result.labels.push((0, _reporter.getPackageLabel)(testFilePath));
result.labels.push({
name: "titlePath",
value: suite.titlePath().join(" > ")
});
// support for earlier playwright versions
if ("tags" in test) {
var _ref;
var tags = test.tags.map(function (tag) {
return {
name: _allureJsCommons.LabelName.TAG,
value: tag.startsWith("@") ? tag.substring(1) : tag
};
});
(_ref = result.labels).push.apply(_ref, _toConsumableArray(tags));
}
if ("annotations" in test) {
var _iterator = _createForOfIteratorHelper(test.annotations),
_step;
try {
for (_iterator.s(); !(_step = _iterator.n()).done;) {
var annotation = _step.value;
if (annotation.type === "skip" || annotation.type === "fixme") {
continue;
}
if (annotation.type === "issue") {
var _this$options$links;
result.links.push((0, _reporter.formatLink)((_this$options$links = this.options.links) !== null && _this$options$links !== void 0 ? _this$options$links : {}, {
type: _allureJsCommons.LinkType.ISSUE,
url: annotation.description
}));
continue;
}
if (annotation.type === "tms" || annotation.type === "test_key") {
var _this$options$links2;
result.links.push((0, _reporter.formatLink)((_this$options$links2 = this.options.links) !== null && _this$options$links2 !== void 0 ? _this$options$links2 : {}, {
type: _allureJsCommons.LinkType.TMS,
url: annotation.description
}));
continue;
}
if (annotation.type === "description") {
result.description = annotation.description;
continue;
}
var annotationLabel = (0, _sdk.getMetadataLabel)(annotation.type, annotation.description);
if (annotationLabel) {
result.labels.push(annotationLabel);
continue;
}
result.steps.push({
name: "".concat(annotation.type, ": ").concat(annotation.description),
status: _allureJsCommons.Status.PASSED,
stage: _allureJsCommons.Stage.FINISHED,
parameters: [],
steps: [],
attachments: [],
statusDetails: {}
});
}
} catch (err) {
_iterator.e(err);
} finally {
_iterator.f();
}
}
if (project !== null && project !== void 0 && project.name) {
result.parameters.push({
name: "Project",
value: project.name
});
}
if ((project === null || project === void 0 ? void 0 : project.repeatEach) > 1) {
result.parameters.push({
name: "Repetition",
value: "".concat(test.repeatEachIndex + 1)
});
}
var testUuid = this.allureRuntime.startTest(result);
this.allureResultsUuids.set(test.id, testUuid);
this.startedTestCasesTitlesCache.push(titleMetadata.cleanTitle);
}
}, {
key: "onStepBegin",
value: function onStepBegin(test, _result, step) {
var isRootBeforeHook = step.title === _utils.BEFORE_HOOKS_ROOT_STEP_TITLE;
var isRootAfterHook = step.title === _utils.AFTER_HOOKS_ROOT_STEP_TITLE;
var isRootHook = isRootBeforeHook || isRootAfterHook;
var isBeforeHookDescendant = (0, _utils.isBeforeHookStep)(step);
var isAfterHookDescendant = (0, _utils.isAfterHookStep)(step);
var isHookStep = isBeforeHookDescendant || isAfterHookDescendant;
var testUuid = this.allureResultsUuids.get(test.id);
if (["test.attach", "attach"].includes(step.category) && !isHookStep) {
var _this$allureRuntime, _this$attachmentSteps;
var currentStep = (_this$allureRuntime = this.allureRuntime) === null || _this$allureRuntime === void 0 ? void 0 : _this$allureRuntime.currentStep(testUuid);
this.attachmentSteps.set(testUuid, [].concat(_toConsumableArray((_this$attachmentSteps = this.attachmentSteps.get(testUuid)) !== null && _this$attachmentSteps !== void 0 ? _this$attachmentSteps : []), [currentStep]));
return;
}
if (_assertClassBrand(_AllureReporter_brand, this, _shouldIgnoreStep).call(this, step)) {
return;
}
var baseStep = _objectSpread(_objectSpread({}, (0, _reporter.createStepResult)()), {}, {
name: step.title,
start: step.startTime.getTime(),
stage: _allureJsCommons.Stage.RUNNING,
uuid: (0, _reporter.randomUuid)()
});
if (isHookStep) {
var stack = isBeforeHookDescendant ? this.beforeHooksStepsStack.get(test.id) : this.afterHooksStepsStack.get(test.id);
if (["test.attach", "attach"].includes(step.category)) {
stack.startStep(baseStep);
var attachStack = isBeforeHookDescendant ? this.beforeHooksAttachmentsStack : this.afterHooksAttachmentsStack;
stack.updateStep(function (stepResult) {
var _attachStack$get;
stepResult.name = (0, _utils.normalizeHookTitle)(stepResult.name);
stepResult.stage = _allureJsCommons.Stage.FINISHED;
attachStack.set(test.id, [].concat(_toConsumableArray((_attachStack$get = attachStack.get(test.id)) !== null && _attachStack$get !== void 0 ? _attachStack$get : []), [_objectSpread(_objectSpread({}, step), {}, {
uuid: stepResult.uuid
})]));
});
stack.stopStep();
return;
}
stack.startStep(baseStep);
return;
}
if (isRootHook) {
var _stack = new _reporter.ShallowStepsStack();
_stack.startStep(baseStep);
if (isRootBeforeHook) {
this.beforeHooksStepsStack.set(test.id, _stack);
} else {
this.afterHooksStepsStack.set(test.id, _stack);
}
return;
}
this.allureRuntime.startStep(testUuid, undefined, baseStep);
}
}, {
key: "onStepEnd",
value: function onStepEnd(test, _result, step) {
if (_assertClassBrand(_AllureReporter_brand, this, _shouldIgnoreStep).call(this, step)) {
return;
}
// ignore test.attach steps since attachments are already in the report
if (["test.attach", "attach"].includes(step.category)) {
return;
}
var testUuid = this.allureResultsUuids.get(test.id);
var isRootBeforeHook = step.title === _utils.BEFORE_HOOKS_ROOT_STEP_TITLE;
var isRootAfterHook = step.title === _utils.AFTER_HOOKS_ROOT_STEP_TITLE;
var isBeforeHookDescendant = (0, _utils.isBeforeHookStep)(step);
var isAfterHookDescendant = (0, _utils.isAfterHookStep)(step);
var isAfterHook = isRootAfterHook || isAfterHookDescendant;
var isHook = isRootBeforeHook || isRootAfterHook || isBeforeHookDescendant || isAfterHookDescendant;
if (isHook) {
var stack = isAfterHook ? this.afterHooksStepsStack.get(test.id) : this.beforeHooksStepsStack.get(test.id);
stack.updateStep(function (stepResult) {
var _getWorstTestStepResu;
var _ref2 = (_getWorstTestStepResu = (0, _reporter.getWorstTestStepResult)(stepResult.steps)) !== null && _getWorstTestStepResu !== void 0 ? _getWorstTestStepResu : {},
_ref2$status = _ref2.status,
status = _ref2$status === void 0 ? _allureJsCommons.Status.PASSED : _ref2$status;
stepResult.status = step.error ? _allureJsCommons.Status.FAILED : status;
stepResult.stage = _allureJsCommons.Stage.FINISHED;
if (step.error) {
stepResult.statusDetails = _objectSpread({}, (0, _sdk.getMessageAndTraceFromError)(step.error));
}
});
stack.stopStep({
duration: step.duration
});
return;
}
var currentStep = this.allureRuntime.currentStep(testUuid);
if (!currentStep) {
return;
}
this.allureRuntime.updateStep(currentStep, function (stepResult) {
var _getWorstTestStepResu2;
var _ref3 = (_getWorstTestStepResu2 = (0, _reporter.getWorstTestStepResult)(stepResult.steps)) !== null && _getWorstTestStepResu2 !== void 0 ? _getWorstTestStepResu2 : {},
_ref3$status = _ref3.status,
status = _ref3$status === void 0 ? _allureJsCommons.Status.PASSED : _ref3$status;
stepResult.status = step.error ? _allureJsCommons.Status.FAILED : status;
stepResult.stage = _allureJsCommons.Stage.FINISHED;
if (step.error) {
stepResult.statusDetails = _objectSpread({}, (0, _sdk.getMessageAndTraceFromError)(step.error));
}
});
this.allureRuntime.stopStep(currentStep, {
duration: step.duration
});
}
}, {
key: "onTestEnd",
value: function () {
var _onTestEnd = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee(test, result) {
var _this = this,
_this$beforeHooksAtta,
_this$afterHooksAttac,
_this$attachmentSteps2;
var testUuid, threadId, thread, error, _test$parent$titlePat, _test$parent$titlePat2, projectSuiteTitle, fileSuiteTitle, suiteTitles, beforeHooksStack, afterHooksStack, attachmentsInBeforeHooks, attachmentsInAfterHooks, attachmentSteps, attachmentToStepMap, attachmentIndex, _iterator2, _step2, _hookStep, _iterator3, _step3, stepUuid, _iterator4, _step4, _hookStep2, i, attachment, stepInfo, _i, _attachment, _stepInfo, hookStep, isBeforeHook, targetStack, stepResult, fileName;
return _regenerator().w(function (_context) {
while (1) switch (_context.n) {
case 0:
testUuid = this.allureResultsUuids.get(test.id); // We need to check parallelIndex first because pw introduced this field only in v1.30.0
threadId = result.parallelIndex !== undefined ? result.parallelIndex : result.workerIndex;
thread = "pid-".concat(_nodeProcess["default"].pid, "-worker-").concat(threadId);
error = result.error; // only apply default suites if not set by user
_test$parent$titlePat = test.parent.titlePath(), _test$parent$titlePat2 = _toArray(_test$parent$titlePat), projectSuiteTitle = _test$parent$titlePat2[1], fileSuiteTitle = _test$parent$titlePat2[2], suiteTitles = _test$parent$titlePat2.slice(3);
beforeHooksStack = this.beforeHooksStepsStack.get(test.id);
afterHooksStack = this.afterHooksStepsStack.get(test.id);
this.allureRuntime.updateTest(testUuid, function (testResult) {
testResult.labels.push((0, _reporter.getHostLabel)());
testResult.labels.push((0, _reporter.getThreadLabel)(thread));
if (projectSuiteTitle && !(0, _sdk.hasLabel)(testResult, _allureJsCommons.LabelName.PARENT_SUITE)) {
testResult.labels.push({
name: _allureJsCommons.LabelName.PARENT_SUITE,
value: projectSuiteTitle
});
}
if (_this.options.suiteTitle && fileSuiteTitle && !(0, _sdk.hasLabel)(testResult, _allureJsCommons.LabelName.SUITE)) {
testResult.labels.push({
name: _allureJsCommons.LabelName.SUITE,
value: fileSuiteTitle
});
}
if (suiteTitles.length > 0 && !(0, _sdk.hasLabel)(testResult, _allureJsCommons.LabelName.SUB_SUITE)) {
testResult.labels.push({
name: _allureJsCommons.LabelName.SUB_SUITE,
value: suiteTitles.join(" > ")
});
}
if (error) {
testResult.statusDetails = _objectSpread({}, (0, _sdk.getMessageAndTraceFromError)(error));
} else {
var _test$annotations;
var skipReason = (_test$annotations = test.annotations) === null || _test$annotations === void 0 || (_test$annotations = _test$annotations.find(function (annotation) {
return annotation.type === "skip" || annotation.type === "fixme";
})) === null || _test$annotations === void 0 ? void 0 : _test$annotations.description;
if (skipReason) {
testResult.statusDetails = _objectSpread(_objectSpread({}, testResult.statusDetails), {}, {
message: skipReason
});
}
}
testResult.status = (0, _utils.statusToAllureStats)(result.status, test.expectedStatus);
testResult.stage = _allureJsCommons.Stage.FINISHED;
});
attachmentsInBeforeHooks = (_this$beforeHooksAtta = this.beforeHooksAttachmentsStack.get(test.id)) !== null && _this$beforeHooksAtta !== void 0 ? _this$beforeHooksAtta : [];
attachmentsInAfterHooks = (_this$afterHooksAttac = this.afterHooksAttachmentsStack.get(test.id)) !== null && _this$afterHooksAttac !== void 0 ? _this$afterHooksAttac : [];
attachmentSteps = (_this$attachmentSteps2 = this.attachmentSteps.get(testUuid)) !== null && _this$attachmentSteps2 !== void 0 ? _this$attachmentSteps2 : [];
attachmentToStepMap = new Map();
attachmentIndex = 0;
_iterator2 = _createForOfIteratorHelper(attachmentsInBeforeHooks);
try {
for (_iterator2.s(); !(_step2 = _iterator2.n()).done;) {
_hookStep = _step2.value;
attachmentToStepMap.set(attachmentIndex, {
stepUuid: _hookStep.uuid,
isHook: true,
hookStep: _hookStep
});
attachmentIndex++;
}
} catch (err) {
_iterator2.e(err);
} finally {
_iterator2.f();
}
_iterator3 = _createForOfIteratorHelper(attachmentSteps);
try {
for (_iterator3.s(); !(_step3 = _iterator3.n()).done;) {
stepUuid = _step3.value;
attachmentToStepMap.set(attachmentIndex, {
stepUuid: stepUuid,
isHook: false
});
attachmentIndex++;
}
} catch (err) {
_iterator3.e(err);
} finally {
_iterator3.f();
}
_iterator4 = _createForOfIteratorHelper(attachmentsInAfterHooks);
try {
for (_iterator4.s(); !(_step4 = _iterator4.n()).done;) {
_hookStep2 = _step4.value;
attachmentToStepMap.set(attachmentIndex, {
stepUuid: _hookStep2.uuid,
isHook: true,
hookStep: _hookStep2
});
attachmentIndex++;
}
} catch (err) {
_iterator4.e(err);
} finally {
_iterator4.f();
}
i = 0;
case 1:
if (!(i < result.attachments.length)) {
_context.n = 6;
break;
}
attachment = result.attachments[i];
stepInfo = attachmentToStepMap.get(i);
if (!(stepInfo !== null && stepInfo !== void 0 && stepInfo.isHook)) {
_context.n = 2;
break;
}
return _context.a(3, 5);
case 2:
if (!(stepInfo !== null && stepInfo !== void 0 && stepInfo.stepUuid)) {
_context.n = 4;
break;
}
_context.n = 3;
return this.processAttachment(testUuid, stepInfo.stepUuid, attachment);
case 3:
_context.n = 5;
break;
case 4:
_context.n = 5;
return this.processAttachment(testUuid, undefined, attachment);
case 5:
i++;
_context.n = 1;
break;
case 6:
if (result.stdout.length > 0) {
this.allureRuntime.writeAttachment(testUuid, undefined, "stdout", Buffer.from((0, _sdk.stripAnsi)(result.stdout.join("")), "utf-8"), {
contentType: _allureJsCommons.ContentType.TEXT
});
}
if (result.stderr.length > 0) {
this.allureRuntime.writeAttachment(testUuid, undefined, "stderr", Buffer.from((0, _sdk.stripAnsi)(result.stderr.join("")), "utf-8"), {
contentType: _allureJsCommons.ContentType.TEXT
});
}
// FIXME: temp logic for labels override, we need it here to keep the reporter compatible with v2 API
// in next iterations we need to implement the logic for every javascript integration
_i = 0;
case 7:
if (!(_i < result.attachments.length)) {
_context.n = 11;
break;
}
_attachment = result.attachments[_i];
_stepInfo = attachmentToStepMap.get(_i);
if (!(_stepInfo !== null && _stepInfo !== void 0 && _stepInfo.isHook && _stepInfo.hookStep)) {
_context.n = 10;
break;
}
hookStep = _stepInfo.hookStep;
isBeforeHook = attachmentsInBeforeHooks.includes(hookStep);
targetStack = isBeforeHook ? beforeHooksStack : afterHooksStack;
if (!(_attachment.contentType === _reporter.ALLURE_RUNTIME_MESSAGE_CONTENT_TYPE)) {
_context.n = 9;
break;
}
_context.n = 8;
return this.processAttachment(testUuid, hookStep.uuid, _attachment);
case 8:
return _context.a(3, 10);
case 9:
if (targetStack) {
stepResult = targetStack.findStepByUuid(hookStep.uuid);
if (stepResult) {
fileName = targetStack.addAttachment(_attachment, this.allureRuntime.writer);
stepResult.attachments.push({
name: _attachment.name,
type: _attachment.contentType,
source: fileName
});
}
}
case 10:
_i++;
_context.n = 7;
break;
case 11:
this.allureRuntime.updateTest(testUuid, function (testResult) {
var mappedLabels = testResult.labels.reduce(function (acc, label) {
if (!acc[label.name]) {
acc[label.name] = [];
}
acc[label.name].push(label);
return acc;
}, {});
var newLabels = Object.keys(mappedLabels).flatMap(function (labelName) {
var labelsGroup = mappedLabels[labelName];
if (labelName === _allureJsCommons.LabelName.SUITE || labelName === _allureJsCommons.LabelName.PARENT_SUITE || labelName === _allureJsCommons.LabelName.SUB_SUITE) {
return labelsGroup.slice(-1);
}
return labelsGroup;
});
if (beforeHooksStack) {
var _testResult$steps;
(_testResult$steps = testResult.steps).unshift.apply(_testResult$steps, _toConsumableArray(beforeHooksStack.steps));
_this.beforeHooksStepsStack["delete"](test.id);
}
if (afterHooksStack) {
var _testResult$steps2;
(_testResult$steps2 = testResult.steps).push.apply(_testResult$steps2, _toConsumableArray(afterHooksStack.steps));
_this.afterHooksStepsStack["delete"](test.id);
}
testResult.labels = newLabels;
});
this.allureRuntime.stopTest(testUuid, {
duration: result.duration
});
this.allureRuntime.writeTest(testUuid);
case 12:
return _context.a(2);
}
}, _callee, this);
}));
function onTestEnd(_x, _x2) {
return _onTestEnd.apply(this, arguments);
}
return onTestEnd;
}()
}, {
key: "addSkippedResults",
value: function () {
var _addSkippedResults = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee2() {
var _this2 = this;
var unprocessedCases, _iterator5, _step5, testCase, _t;
return _regenerator().w(function (_context2) {
while (1) switch (_context2.n) {
case 0:
unprocessedCases = this.suite.allTests().filter(function (_ref4) {
var title = _ref4.title;
var titleMetadata = (0, _sdk.extractMetadataFromString)(title);
return !_this2.startedTestCasesTitlesCache.includes(titleMetadata.cleanTitle);
});
_iterator5 = _createForOfIteratorHelper(unprocessedCases);
_context2.p = 1;
_iterator5.s();
case 2:
if ((_step5 = _iterator5.n()).done) {
_context2.n = 4;
break;
}
testCase = _step5.value;
this.onTestBegin(testCase);
_context2.n = 3;
return this.onTestEnd(testCase, {
status: _allureJsCommons.Status.SKIPPED,
attachments: [],
duration: 0,
errors: [],
parallelIndex: 0,
workerIndex: 0,
retry: 0,
steps: [],
stderr: [],
stdout: [],
startTime: this.globalStartTime,
annotations: []
});
case 3:
_context2.n = 2;
break;
case 4:
_context2.n = 6;
break;
case 5:
_context2.p = 5;
_t = _context2.v;
_iterator5.e(_t);
case 6:
_context2.p = 6;
_iterator5.f();
return _context2.f(6);
case 7:
return _context2.a(2);
}
}, _callee2, this, [[1, 5, 6, 7]]);
}));
function addSkippedResults() {
return _addSkippedResults.apply(this, arguments);
}
return addSkippedResults;
}()
}, {
key: "onEnd",
value: function () {
var _onEnd = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee3() {
return _regenerator().w(function (_context3) {
while (1) switch (_context3.n) {
case 0:
_context3.n = 1;
return this.addSkippedResults();
case 1:
this.allureRuntime.writeEnvironmentInfo();
this.allureRuntime.writeCategoriesDefinitions();
case 2:
return _context3.a(2);
}
}, _callee3, this);
}));
function onEnd() {
return _onEnd.apply(this, arguments);
}
return onEnd;
}()
}, {
key: "printsToStdio",
value: function printsToStdio() {
return false;
}
}, {
key: "processStepMetadataMessage",
value: function processStepMetadataMessage(attachmentStepUuid, message) {
var _message$data = message.data,
name = _message$data.name,
_message$data$paramet = _message$data.parameters,
parameters = _message$data$paramet === void 0 ? [] : _message$data$paramet;
this.allureRuntime.updateStep(attachmentStepUuid, function (step) {
var _step$parameters;
if (name) {
step.name = name;
}
(_step$parameters = step.parameters).push.apply(_step$parameters, _toConsumableArray(parameters));
});
}
}, {
key: "processAttachment",
value: function () {
var _processAttachment = _asyncToGenerator(/*#__PURE__*/_regenerator().m(function _callee4(testUuid, attachmentStepUuid, attachment) {
var allureRuntimeMessage, message, parentUuid, contentType, pathWithoutEnd, actualBase64, expectedBase64, diffBase64, diffName;
return _regenerator().w(function (_context4) {
while (1) switch (_context4.n) {
case 0:
if (!(!attachment.body && !attachment.path)) {
_context4.n = 1;
break;
}
return _context4.a(2);
case 1:
allureRuntimeMessage = attachment.contentType === _reporter.ALLURE_RUNTIME_MESSAGE_CONTENT_TYPE;
if (!(allureRuntimeMessage && !attachment.body)) {
_context4.n = 2;
break;
}
return _context4.a(2);
case 2:
if (!allureRuntimeMessage) {
_context4.n = 4;
break;
}
message = JSON.parse(attachment.body.toString());
if (!(message.type === "step_metadata")) {
_context4.n = 3;
break;
}
this.processStepMetadataMessage(attachmentStepUuid, message);
return _context4.a(2);
case 3:
this.allureRuntime.applyRuntimeMessages(testUuid, [message]);
return _context4.a(2);
case 4:
parentUuid = this.allureRuntime.startStep(testUuid, attachmentStepUuid, {
name: attachment.name
}); // only stop if step is created. Step may not be created only if test with specified uuid doesn't exists.
// usually, missing test by uuid means we should completely skip result processing;
// the later operations are safe and will only produce console warnings
if (parentUuid) {
this.allureRuntime.stopStep(parentUuid, undefined);
}
if (!attachment.body) {
_context4.n = 5;
break;
}
this.allureRuntime.writeAttachment(testUuid, parentUuid, attachment.name, attachment.body, {
contentType: attachment.contentType
});
_context4.n = 7;
break;
case 5:
if ((0, _nodeFs.existsSync)(attachment.path)) {
_context4.n = 6;
break;
}
return _context4.a(2);
case 6:
contentType = attachment.name === "trace" && attachment.contentType === "application/zip" ? "application/vnd.allure.playwright-trace" : attachment.contentType;
this.allureRuntime.writeAttachment(testUuid, parentUuid, attachment.name, attachment.path, {
contentType: contentType
});
case 7:
if (attachment.name.match(_utils.diffEndRegexp)) {
_context4.n = 8;
break;
}
return _context4.a(2);
case 8:
pathWithoutEnd = attachment.path.replace(_utils.diffEndRegexp, "");
if (!this.processedDiffs.includes(pathWithoutEnd)) {
_context4.n = 9;
break;
}
return _context4.a(2);
case 9:
_context4.n = 10;
return (0, _reporter.readImageAsBase64)("".concat(pathWithoutEnd, "-actual.png"));
case 10:
actualBase64 = _context4.v;
_context4.n = 11;
return (0, _reporter.readImageAsBase64)("".concat(pathWithoutEnd, "-expected.png"));
case 11:
expectedBase64 = _context4.v;
_context4.n = 12;
return (0, _reporter.readImageAsBase64)("".concat(pathWithoutEnd, "-diff.png"));
case 12:
diffBase64 = _context4.v;
diffName = attachment.name.replace(_utils.diffEndRegexp, "");
this.allureRuntime.writeAttachment(testUuid, undefined, diffName, Buffer.from(JSON.stringify({
expected: expectedBase64,
actual: actualBase64,
diff: diffBase64,
name: diffName
}), "utf-8"), {
contentType: _allureJsCommons.ContentType.IMAGEDIFF,
fileExtension: ".imagediff"
});
this.processedDiffs.push(pathWithoutEnd);
case 13:
return _context4.a(2);
}
}, _callee4, this);
}));
function processAttachment(_x3, _x4, _x5) {
return _processAttachment.apply(this, arguments);
}
return processAttachment;
}()
}, {
key: "version",
value: function version() {
return "v2";
}
}]);
}();
/**
* @deprecated for removal, import functions directly from "allure-js-commons".
*/
function _shouldIgnoreStep(step) {
if (!this.options.detail && step.category !== "test.step") {
return true;
}
// ignore noisy route.continue()
if (step.category === "pw:api" && step.title === "route.continue()") {
return true;
}
// playwright doesn't report this step
if (step.title === "Worker Cleanup" || (0, _utils.isDescendantOfStepWithTitle)(step, "Worker Cleanup")) {
return true;
}
return false;
}
var allure = exports.allure = _legacy.allurePlaywrightLegacyApi;
/**
* @deprecated for removal, import functions directly from "@playwright/test".
*/
var _default = exports["default"] = AllureReporter;
//# sourceMappingURL=index.js.map