karma-allure2-reporter
Version:
A Karma reporter for generating Allure 2 test results.
151 lines (150 loc) • 8.31 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
exports.default = void 0;
var _nodeProcess = require("node:process");
var _allureJsCommons = require("allure-js-commons");
var _reporter = require("allure-js-commons/sdk/reporter");
var _sdk = require("allure-js-commons/sdk");
var _utils = require("./utils");
var _excluded = ["resultsDir", "customOptions"];
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 _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 _objectWithoutProperties(e, t) { if (null == e) return {}; var o, r, i = _objectWithoutPropertiesLoose(e, t); if (Object.getOwnPropertySymbols) { var n = Object.getOwnPropertySymbols(e); for (r = 0; r < n.length; r++) o = n[r], -1 === t.indexOf(o) && {}.propertyIsEnumerable.call(e, o) && (i[o] = e[o]); } return i; }
function _objectWithoutPropertiesLoose(r, e) { if (null == r) return {}; var t = {}; for (var n in r) if ({}.hasOwnProperty.call(r, n)) { if (-1 !== e.indexOf(n)) continue; t[n] = r[n]; } return t; }
function KarmaAllure2Reporter(baseReporterDecorator, config, logger) {
baseReporterDecorator(this);
var log = logger.create('allure2-reporter');
var _ref = config !== null && config !== void 0 ? config : {},
{
resultsDir = (0, _utils.getDefaultAllureResultsDir)(),
customOptions = {}
} = _ref,
reporterOptions = _objectWithoutProperties(_ref, _excluded);
log.debug('Allure 2 reporter results directory: ', resultsDir);
var {
projectLanguage,
testFramework = (0, _utils.getDefaultFrameworkName)(),
packageLabel,
parentSuiteLabel
} = customOptions;
log.debug('Allure 2 reporter custom options: ', JSON.stringify(customOptions, undefined, 2));
var allureRuntime = new _reporter.ReporterRuntime(_objectSpread({
writer: (0, _reporter.createDefaultWriter)({
resultsDir
})
}, reporterOptions));
var scopeStack = [];
var currentTestUuid;
this.onSpecComplete = (browser, result) => {
var _getEnvironmentLabels;
var {
description: resultDescription,
suite: resultSuite = []
} = result !== null && result !== void 0 ? result : {};
var metadata = (0, _sdk.extractMetadataFromString)(resultDescription);
var testName = resultDescription;
var packageName = resultSuite.join('.');
var parentSuite = resultSuite.join(' > ');
var suiteLabel;
var subSuiteLabel;
if (resultSuite.length === 2) {
suiteLabel = resultSuite[1];
} else if (resultSuite.length > 2) {
suiteLabel = resultSuite[1];
subSuiteLabel = resultSuite.slice(2).join(' > ');
}
var globalLabels = (_getEnvironmentLabels = (0, _reporter.getEnvironmentLabels)().filter(label => !!label.value)) !== null && _getEnvironmentLabels !== void 0 ? _getEnvironmentLabels : [];
var initialLabels = [(0, _reporter.getLanguageLabel)(), (0, _reporter.getFrameworkLabel)(testFramework), (0, _reporter.getHostLabel)(), (0, _reporter.getThreadLabel)("".concat(_nodeProcess.pid))];
if (projectLanguage) {
var languageLabel = initialLabels.find(label => label.name === 'language');
if (languageLabel) {
languageLabel.value = projectLanguage;
}
}
if (!currentTestUuid) {
var _metadata$cleanTitle, _metadata$labels, _packageLabel$prefix, _packageLabel$suffix, _parentSuiteLabel$pre, _parentSuiteLabel$suf, _metadata$links;
var scopeUuid = allureRuntime.startScope();
scopeStack.push(scopeUuid);
var currentTestResult = _objectSpread({
name: (_metadata$cleanTitle = metadata.cleanTitle) !== null && _metadata$cleanTitle !== void 0 ? _metadata$cleanTitle : testName,
fullName: "".concat(parentSuite, " > ").concat(testName),
stage: _allureJsCommons.Stage.RUNNING,
labels: [...globalLabels, ...initialLabels, ...((_metadata$labels = metadata.labels) !== null && _metadata$labels !== void 0 ? _metadata$labels : []), {
name: 'browser',
value: browser.name
}, {
name: 'package',
value: "".concat((_packageLabel$prefix = packageLabel === null || packageLabel === void 0 ? void 0 : packageLabel.prefix) !== null && _packageLabel$prefix !== void 0 ? _packageLabel$prefix : '').concat(packageName).concat((_packageLabel$suffix = packageLabel === null || packageLabel === void 0 ? void 0 : packageLabel.suffix) !== null && _packageLabel$suffix !== void 0 ? _packageLabel$suffix : '')
}, {
name: 'parentSuite',
value: "".concat((_parentSuiteLabel$pre = parentSuiteLabel === null || parentSuiteLabel === void 0 ? void 0 : parentSuiteLabel.prefix) !== null && _parentSuiteLabel$pre !== void 0 ? _parentSuiteLabel$pre : '').concat(resultSuite[0]).concat((_parentSuiteLabel$suf = parentSuiteLabel === null || parentSuiteLabel === void 0 ? void 0 : parentSuiteLabel.suffix) !== null && _parentSuiteLabel$suf !== void 0 ? _parentSuiteLabel$suf : '')
}]
}, (_metadata$links = metadata.links) !== null && _metadata$links !== void 0 ? _metadata$links : []);
if (suiteLabel) {
currentTestResult.labels.push({
name: 'suite',
value: suiteLabel
});
}
if (subSuiteLabel) {
currentTestResult.labels.push({
name: 'subSuite',
value: subSuiteLabel
});
}
currentTestUuid = allureRuntime.startTest(currentTestResult, scopeStack);
}
allureRuntime.updateTest(currentTestUuid, test => {
test.stage = _allureJsCommons.Stage.FINISHED;
if (result.skipped) {
test.status = _allureJsCommons.Status.SKIPPED;
test.statusDetails = {
message: 'Test skipped',
trace: 'Test execution was skipped by either \'xdescribe\' or \'xit\''
};
} else if (result.success) {
test.status = _allureJsCommons.Status.PASSED;
} else {
var _result$log$join, _result$log;
test.status = _allureJsCommons.Status.FAILED;
test.statusDetails = {
message: 'Test failed. See the stack trace for details',
trace: (_result$log$join = (_result$log = result.log) === null || _result$log === void 0 ? void 0 : _result$log.join('\n')) !== null && _result$log$join !== void 0 ? _result$log$join : 'No trace available'
};
}
});
finalizeTest();
};
this.onRunComplete = () => {
log.debug('Cleaning up...');
finalizeScopes();
};
function finalizeTest() {
if (currentTestUuid) {
allureRuntime.stopTest(currentTestUuid);
allureRuntime.writeTest(currentTestUuid);
currentTestUuid = undefined;
}
var scopeUuid = scopeStack.pop();
if (scopeUuid) {
allureRuntime.writeScope(scopeUuid);
}
}
function finalizeScopes() {
while (scopeStack.length > 0) {
var scopeUuid = scopeStack.pop();
allureRuntime.writeScope(scopeUuid);
}
}
}
KarmaAllure2Reporter.$inject = ['baseReporterDecorator', 'config.allureReporter', 'logger'];
var _default = exports.default = {
'reporter:allure': ['type', KarmaAllure2Reporter]
};
module.exports = exports.default;
//# sourceMappingURL=index.js.map