@wdio/allure-reporter 8.10.4 → 8.10.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -1
- package/build/common/api.d.ts +2 -2
- package/build/common/api.d.ts.map +1 -1
- package/build/common/api.js +4 -4
- package/build/constants.d.ts +0 -1
- package/build/constants.d.ts.map +1 -1
- package/build/constants.js +0 -1
- package/build/reporter.d.ts +2 -4
- package/build/reporter.d.ts.map +1 -1
- package/build/reporter.js +3 -8
- package/build/types.d.ts +5 -4
- package/build/types.d.ts.map +1 -1
- package/cjs/common/api.js +4 -4
- package/cjs/constants.js +0 -1
- package/package.json +4 -4
package/README.md
CHANGED
|
@@ -52,6 +52,7 @@ export const config = {
|
|
|
52
52
|
- `useCucumberStepReporter` - optional parameter (`false` by default), set it to true in order to change the report hierarchy when using cucumber. Try it for yourself and see how it looks.
|
|
53
53
|
- `disableMochaHooks` - optional parameter (`false` by default), set it to true in order to not fetch the `before/after` stacktrace/screenshot/result hooks into the Allure Reporter.
|
|
54
54
|
- `addConsoleLogs` - optional parameter(`false` by default), set to true in order to attach console logs from step to the reporter.
|
|
55
|
+
- `reportedEnvironmentVars` - Set this option to display the environment variables in the report. Note that setting this, does not modify the actual environment variables.
|
|
55
56
|
|
|
56
57
|
## Supported Allure API
|
|
57
58
|
* `addLabel(name, value)` - assign a custom label to test
|
|
@@ -67,7 +68,7 @@ export const config = {
|
|
|
67
68
|
* `addIssue(value)` – assign issue id to test
|
|
68
69
|
* `addAllureId(value)` – assign allure test ops id label to test
|
|
69
70
|
* `addTestId(value)` – assign TMS test id to test
|
|
70
|
-
*
|
|
71
|
+
* ~~`addEnvironment(name, value)` ~~ – a deprecated function that no longer works. Use `reportedEnvironmentVars` instead
|
|
71
72
|
* `addAttachment(name, content, [type])` – save attachment to test.
|
|
72
73
|
* `name` (*String*) - attachment name.
|
|
73
74
|
* `content` – attachment content.
|
package/build/common/api.d.ts
CHANGED
|
@@ -91,8 +91,7 @@ export declare function addTag(tag: string): void;
|
|
|
91
91
|
/**
|
|
92
92
|
* Add environment value
|
|
93
93
|
* @name addEnvironment
|
|
94
|
-
* @
|
|
95
|
-
* @param {string} value - environment value
|
|
94
|
+
* @deprecated addEnvironment is deprecated. Use reportedEnvironmentVars in config instead.
|
|
96
95
|
*/
|
|
97
96
|
export declare function addEnvironment(name: string, value: string): void;
|
|
98
97
|
/**
|
|
@@ -163,6 +162,7 @@ declare const _default: {
|
|
|
163
162
|
addStep: typeof addStep;
|
|
164
163
|
addArgument: typeof addArgument;
|
|
165
164
|
step: typeof step;
|
|
165
|
+
addTag: typeof addTag;
|
|
166
166
|
};
|
|
167
167
|
export default _default;
|
|
168
168
|
//# sourceMappingURL=api.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/common/api.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACzD,OAAO,EAAE,MAAM,EAA+B,MAAM,mBAAmB,CAAA;AAavE;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAEpD;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,QAEhE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,EAAE,EAAE,MAAM,QAErC;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAE,WAAW,EAAE,MAAM,QAE9C;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAE,QAAQ,EAAE,MAAM,QAE5C;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAE,KAAK,EAAE,MAAM,QAEtC;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAE,MAAM,EAAE,MAAM,QAExC;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAE,SAAS,EAAE,MAAM,QAE1C;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,SAAS,EAAE,MAAM,QAEzC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,MAAM,QAE/C;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,MAAM,QAE5C;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,QAAQ,EAAE,MAAM,QAEvC;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,QAErC;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,QAEjC;AAED
|
|
1
|
+
{"version":3,"file":"api.d.ts","sourceRoot":"","sources":["../../src/common/api.ts"],"names":[],"mappings":";AAAA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAA;AACzD,OAAO,EAAE,MAAM,EAA+B,MAAM,mBAAmB,CAAA;AAavE;;;;;GAKG;AACH,wBAAgB,QAAQ,CAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAEpD;AAED;;;;;;GAMG;AACH,wBAAgB,OAAO,CAAC,GAAG,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE,MAAM,QAEhE;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,EAAE,EAAE,MAAM,QAErC;AAED;;;;GAIG;AACH,wBAAgB,UAAU,CAAE,WAAW,EAAE,MAAM,QAE9C;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAE,QAAQ,EAAE,MAAM,QAE5C;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAE,KAAK,EAAE,MAAM,QAEtC;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAE,MAAM,EAAE,MAAM,QAExC;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAE,SAAS,EAAE,MAAM,QAE1C;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,SAAS,EAAE,MAAM,QAEzC;AAED;;;;GAIG;AACH,wBAAgB,cAAc,CAAC,SAAS,EAAE,MAAM,QAE/C;AAED;;;;GAIG;AACH,wBAAgB,WAAW,CAAC,SAAS,EAAE,MAAM,QAE5C;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,QAAQ,EAAE,MAAM,QAEvC;AAED;;;;GAIG;AACH,wBAAgB,QAAQ,CAAC,KAAK,EAAE,MAAM,QAErC;AAED;;;;GAIG;AACH,wBAAgB,MAAM,CAAC,GAAG,EAAE,MAAM,QAEjC;AAED;;;;GAIG;AAEH,wBAAgB,cAAc,CAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAE1D;AAED;;;;;GAKG;AACH,wBAAgB,cAAc,CAAE,WAAW,EAAE,MAAM,EAAE,eAAe,EAAE,MAAM,QAE3E;AAED;;;;;;GAMG;AACH,wBAAgB,aAAa,CAAE,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,GAAG,MAAM,EAAE,IAAI,EAAE,MAAM,QAK3F;AAED;;;;GAIG;AACH,wBAAgB,SAAS,CAAE,KAAK,EAAE,MAAM,QAEvC;AAED;;;;GAIG;AACH,wBAAgB,OAAO,CAAE,MAAM,GAAE,MAAsB,QAKtD;AAED;;;;;;;;;GASG;AACH,wBAAgB,OAAO,CACnB,KAAK,EAAE,MAAM,EACb,EACI,OAAO,EACP,IAAmB,EACnB,IAAmB,EACtB,GAAE,GAAQ,EACX,MAAM,GAAE,MAAsB,QAQjC;AAED;;;;;GAKG;AACH,wBAAgB,WAAW,CAAE,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,QAEvD;AAED;;;;;GAKG;AACH,wBAAsB,IAAI,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,gBAAgB,iBAK9D;;;;;;;;;;;;;;;;;;;AAED,wBAGC"}
|
package/build/common/api.js
CHANGED
|
@@ -127,11 +127,11 @@ export function addTag(tag) {
|
|
|
127
127
|
/**
|
|
128
128
|
* Add environment value
|
|
129
129
|
* @name addEnvironment
|
|
130
|
-
* @
|
|
131
|
-
* @param {string} value - environment value
|
|
130
|
+
* @deprecated addEnvironment is deprecated. Use reportedEnvironmentVars in config instead.
|
|
132
131
|
*/
|
|
132
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
133
133
|
export function addEnvironment(name, value) {
|
|
134
|
-
|
|
134
|
+
console.warn('⚠️ addEnvironment is deprecated and has no longer any functionality. Use reportedEnvironmentVars in wdio config instead. Read more in https://webdriver.io/docs/allure-reporter.');
|
|
135
135
|
}
|
|
136
136
|
/**
|
|
137
137
|
* Assign test description to test
|
|
@@ -214,5 +214,5 @@ export async function step(name, body) {
|
|
|
214
214
|
}
|
|
215
215
|
export default {
|
|
216
216
|
addFeature, addAllureId, addLabel, addSeverity, addIssue, addTestId, addStory, addEnvironment,
|
|
217
|
-
addDescription, addAttachment, startStep, endStep, addStep, addArgument, step,
|
|
217
|
+
addDescription, addAttachment, startStep, endStep, addStep, addArgument, step, addTag
|
|
218
218
|
};
|
package/build/constants.d.ts
CHANGED
|
@@ -13,7 +13,6 @@ export declare const events: {
|
|
|
13
13
|
readonly addIssue: "allure:addIssue";
|
|
14
14
|
readonly addAllureId: "allure:addAllureId";
|
|
15
15
|
readonly addTestId: "allure:addTestId";
|
|
16
|
-
readonly addEnvironment: "allure:addEnvironment";
|
|
17
16
|
readonly addDescription: "allure:addDescription";
|
|
18
17
|
readonly addAttachment: "allure:addAttachment";
|
|
19
18
|
readonly startStep: "allure:startStep";
|
package/build/constants.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM
|
|
1
|
+
{"version":3,"file":"constants.d.ts","sourceRoot":"","sources":["../src/constants.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,MAAM;;;;;;;;;;;;;;;;;;;;;;CAsBT,CAAA;AAEV,eAAO,MAAM,cAAc,0DAAuD,CAAA;AAClF,eAAO,MAAM,aAAa,wDAAqD,CAAA;AAC/E,eAAO,MAAM,eAAe,OAAO,CAAA"}
|
package/build/constants.js
CHANGED
|
@@ -13,7 +13,6 @@ export const events = {
|
|
|
13
13
|
addIssue: 'allure:addIssue',
|
|
14
14
|
addAllureId: 'allure:addAllureId',
|
|
15
15
|
addTestId: 'allure:addTestId',
|
|
16
|
-
addEnvironment: 'allure:addEnvironment',
|
|
17
16
|
addDescription: 'allure:addDescription',
|
|
18
17
|
addAttachment: 'allure:addAttachment',
|
|
19
18
|
startStep: 'allure:startStep',
|
package/build/reporter.d.ts
CHANGED
|
@@ -3,9 +3,9 @@ import type { SuiteStats, HookStats, RunnerStats, TestStats, BeforeCommandArgs,
|
|
|
3
3
|
import WDIOReporter from '@wdio/reporter';
|
|
4
4
|
import type { MetadataMessage, AllureStep } from 'allure-js-commons';
|
|
5
5
|
import { AllureGroup, AllureTest, Status as AllureStatus, ContentType } from 'allure-js-commons';
|
|
6
|
-
import { addFeature, addLink, addOwner, addEpic, addSuite, addSubSuite, addParentSuite, addTag, addLabel, addSeverity, addIssue, addTestId, addStory,
|
|
6
|
+
import { addFeature, addLink, addOwner, addEpic, addSuite, addSubSuite, addParentSuite, addTag, addLabel, addSeverity, addIssue, addTestId, addStory, addAllureId, addDescription, addAttachment, startStep, endStep, addStep, addArgument, step } from './common/api.js';
|
|
7
7
|
import { AllureReporterState } from './state.js';
|
|
8
|
-
import type { AddAttachmentEventArgs, AddDescriptionEventArgs,
|
|
8
|
+
import type { AddAttachmentEventArgs, AddDescriptionEventArgs, AddFeatureEventArgs, AddIssueEventArgs, AddLabelEventArgs, AddSeverityEventArgs, AddEpicEventArgs, AddOwnerEventArgs, AddParentSuiteEventArgs, AddSubSuiteEventArgs, AddLinkEventArgs, AddAllureIdEventArgs, AddSuiteEventArgs, AddTagEventArgs, AddStoryEventArgs, AddTestIdEventArgs, AllureReporterOptions } from './types.js';
|
|
9
9
|
export default class AllureReporter extends WDIOReporter {
|
|
10
10
|
private _allure;
|
|
11
11
|
private _capabilities;
|
|
@@ -54,7 +54,6 @@ export default class AllureReporter extends WDIOReporter {
|
|
|
54
54
|
addTag({ tag, }: AddTagEventArgs): void;
|
|
55
55
|
addTestId({ testId, linkName, }: AddTestIdEventArgs): void;
|
|
56
56
|
addIssue({ issue, linkName, }: AddIssueEventArgs): void;
|
|
57
|
-
addEnvironment({ name, value }: AddEnvironmentEventArgs): void;
|
|
58
57
|
addDescription({ description, descriptionType }: AddDescriptionEventArgs): void;
|
|
59
58
|
addAttachment({ name, content, type }: AddAttachmentEventArgs): void;
|
|
60
59
|
startStep(title: string): void;
|
|
@@ -79,7 +78,6 @@ export default class AllureReporter extends WDIOReporter {
|
|
|
79
78
|
static addParentSuite: typeof addParentSuite;
|
|
80
79
|
static addTestId: typeof addTestId;
|
|
81
80
|
static addStory: typeof addStory;
|
|
82
|
-
static addEnvironment: typeof addEnvironment;
|
|
83
81
|
static addDescription: typeof addDescription;
|
|
84
82
|
static addAttachment: typeof addAttachment;
|
|
85
83
|
static startStep: typeof startStep;
|
package/build/reporter.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,EACR,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,iBAAiB,EAChE,gBAAgB,EACnB,MAAM,gBAAgB,CAAA;AACvB,OAAO,YAAY,MAAM,gBAAgB,CAAA;AAEzC,OAAO,KAAK,EAAS,eAAe,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAC3E,OAAO,EACY,WAAW,EAAE,UAAU,EAAE,MAAM,IAAI,YAAY,EACpD,WAAW,EACxB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EACH,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,cAAc,EAC7E,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,
|
|
1
|
+
{"version":3,"file":"reporter.d.ts","sourceRoot":"","sources":["../src/reporter.ts"],"names":[],"mappings":";AACA,OAAO,KAAK,EACR,UAAU,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,iBAAiB,EAChE,gBAAgB,EACnB,MAAM,gBAAgB,CAAA;AACvB,OAAO,YAAY,MAAM,gBAAgB,CAAA;AAEzC,OAAO,KAAK,EAAS,eAAe,EAAE,UAAU,EAAE,MAAM,mBAAmB,CAAA;AAC3E,OAAO,EACY,WAAW,EAAE,UAAU,EAAE,MAAM,IAAI,YAAY,EACpD,WAAW,EACxB,MAAM,mBAAmB,CAAA;AAC1B,OAAO,EACH,UAAU,EAAE,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,QAAQ,EAAE,WAAW,EAAE,cAAc,EAC7E,MAAM,EAAE,QAAQ,EAAE,WAAW,EAAE,QAAQ,EAAE,SAAS,EAAE,QAAQ,EAAE,WAAW,EACzE,cAAc,EAAE,aAAa,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,WAAW,EAAE,IAAI,EAChF,MAAM,iBAAiB,CAAA;AACxB,OAAO,EAAE,mBAAmB,EAAE,MAAM,YAAY,CAAA;AAMhD,OAAO,KAAK,EACR,sBAAsB,EAAE,uBAAuB,EAC/C,mBAAmB,EAAE,iBAAiB,EAAE,iBAAiB,EAAE,oBAAoB,EAC/E,gBAAgB,EAAE,iBAAiB,EAAE,uBAAuB,EAAE,oBAAoB,EAClF,gBAAgB,EAAE,oBAAoB,EAAE,iBAAiB,EAAE,eAAe,EAC1E,iBAAiB,EAAE,kBAAkB,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAA;AAKpF,MAAM,CAAC,OAAO,OAAO,cAAe,SAAQ,YAAY;IACpD,OAAO,CAAC,OAAO,CAAe;IAC9B,OAAO,CAAC,aAAa,CAA+B;IACpD,OAAO,CAAC,cAAc,CAAC,CAAS;IAChC,OAAO,CAAC,OAAO,CAAC,CAAoB;IACpC,OAAO,CAAC,QAAQ,CAAuB;IACvC,OAAO,CAAC,cAAc,CAAQ;IAC9B,OAAO,CAAC,oBAAoB,CAAU;IAEtC,MAAM,EAAE,mBAAmB,CAAA;IAE3B,aAAa,EAAE,KAAK,CAAC,WAAW,GAAG,UAAU,GAAG,UAAU,CAAC,CAAK;gBAEpD,OAAO,GAAE,qBAA0B;IAkC/C,UAAU;IAiBV,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,WAAW,EAAE,WAAW;IAgB3E,UAAU,CAAC,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,GAAG;IAOlC,gBAAgB,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM;IAI9C,WAAW,CAAC,UAAU,EAAE,MAAM;IAQ9B,SAAS;IAqBT,UAAU,CAAC,SAAS,EAAE,MAAM,EAAE,GAAG,CAAC,EAAE,MAAM;IAS1C,SAAS;IAkBT,QAAQ,CAAC,MAAM,EAAE,YAAY,EAAE,KAAK,CAAC,EAAE,KAAK;IAuB5C,UAAU,CAAC,SAAS,EAAE,MAAM;IAU5B,iBAAiB,CAAC,GAAG,CAAC,EAAE,MAAM;IAyD9B,iBAAiB;IAwBjB,aAAa,CAAC,MAAM,EAAE,WAAW;IAMjC,YAAY,CAAC,KAAK,EAAE,UAAU;IAqC9B,UAAU,CAAC,KAAK,EAAE,UAAU;IAqE5B,WAAW,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS;IA4BvC,UAAU;IAKV,UAAU,CAAC,IAAI,EAAE,SAAS,GAAG,SAAS;IAyBtC,UAAU,CAAC,IAAI,EAAE,SAAS;IAY1B,eAAe,CAAC,OAAO,EAAE,iBAAiB;IAqB1C,cAAc,CAAC,OAAO,EAAE,gBAAgB;IAoBxC,WAAW,CAAC,IAAI,EAAE,SAAS;IA+B3B,SAAS,CAAC,IAAI,EAAE,SAAS;IAkCzB,QAAQ,CAAC,EACL,IAAI,EACJ,KAAK,EACR,EAAE,iBAAiB;IAQpB,OAAO,CAAC,EACJ,IAAI,EACJ,GAAG,EACH,IAAI,GACP,EAAE,gBAAgB;IAQnB,WAAW,CAAC,EACR,EAAE,GACL,EAAE,oBAAoB;IAOvB,QAAQ,CAAC,EACL,SAAS,EACZ,EAAE,iBAAiB;IAOpB,UAAU,CAAC,EACP,WAAW,EACd,EAAE,mBAAmB;IAOtB,WAAW,CAAC,EACR,QAAQ,EACX,EAAE,oBAAoB;IAOvB,OAAO,CAAC,EACJ,QAAQ,GACX,EAAE,gBAAgB;IAOnB,QAAQ,CAAC,EACL,KAAK,GACR,EAAE,iBAAiB;IAOpB,QAAQ,CAAC,EACL,SAAS,GACZ,EAAE,iBAAiB;IAOpB,cAAc,CAAC,EACX,SAAS,GACZ,EAAE,uBAAuB;IAO1B,WAAW,CAAC,EACR,SAAS,GACZ,EAAE,oBAAoB;IAOvB,MAAM,CAAC,EACH,GAAG,GACN,EAAE,eAAe;IAOlB,SAAS,CAAC,EACN,MAAM,EACN,QAAQ,GACX,EAAE,kBAAkB;IAkBrB,QAAQ,CAAC,EACL,KAAK,EACL,QAAQ,GACX,EAAE,iBAAiB;IAkBpB,cAAc,CAAC,EACX,WAAW,EACX,eAAe,EAClB,EAAE,uBAAuB;IAa1B,aAAa,CAAC,EACV,IAAI,EACJ,OAAO,EACP,IAAuB,EAC1B,EAAE,sBAAsB;IAazB,SAAS,CAAC,KAAK,EAAE,MAAM;IAQvB,OAAO,CAAC,MAAM,EAAE,YAAY;IAQ5B,OAAO,CAAC,EACJ,IAAI,EACP,EAAE,GAAG;IAcN,WAAW,CAAC,EACR,IAAI,EACJ,KAAK,EACR,EAAE,GAAG;IAQN,aAAa,CAAC,QAAQ,EAAE,eAAe;IAgDvC;;;OAGG;IACH,MAAM,CAAC,UAAU,oBAAa;IAC9B,MAAM,CAAC,OAAO,iBAAU;IACxB,MAAM,CAAC,OAAO,iBAAU;IACxB,MAAM,CAAC,QAAQ,kBAAW;IAC1B,MAAM,CAAC,MAAM,gBAAS;IACtB,MAAM,CAAC,QAAQ,kBAAW;IAC1B,MAAM,CAAC,WAAW,qBAAc;IAChC,MAAM,CAAC,QAAQ,kBAAW;IAC1B,MAAM,CAAC,QAAQ,kBAAW;IAC1B,MAAM,CAAC,WAAW,qBAAc;IAChC,MAAM,CAAC,cAAc,wBAAiB;IACtC,MAAM,CAAC,SAAS,mBAAY;IAC5B,MAAM,CAAC,QAAQ,kBAAW;IAC1B,MAAM,CAAC,cAAc,wBAAiB;IACtC,MAAM,CAAC,aAAa,uBAAgB;IACpC,MAAM,CAAC,SAAS,mBAAY;IAC5B,MAAM,CAAC,OAAO,iBAAU;IACxB,MAAM,CAAC,OAAO,iBAAU;IACxB,MAAM,CAAC,WAAW,qBAAc;IAChC,MAAM,CAAC,WAAW,qBAAc;IAChC,MAAM,CAAC,IAAI,cAAO;CACrB"}
|
package/build/reporter.js
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { stringify } from 'csv-stringify/sync';
|
|
2
2
|
import WDIOReporter from '@wdio/reporter';
|
|
3
3
|
import { AllureRuntime, AllureGroup, AllureTest, Status as AllureStatus, Stage, LabelName, LinkType, ContentType, AllureCommandStepExecutable, } from 'allure-js-commons';
|
|
4
|
-
import { addFeature, addLink, addOwner, addEpic, addSuite, addSubSuite, addParentSuite, addTag, addLabel, addSeverity, addIssue, addTestId, addStory,
|
|
4
|
+
import { addFeature, addLink, addOwner, addEpic, addSuite, addSubSuite, addParentSuite, addTag, addLabel, addSeverity, addIssue, addTestId, addStory, addAllureId, addDescription, addAttachment, startStep, endStep, addStep, addArgument, step, } from './common/api.js';
|
|
5
5
|
import { AllureReporterState } from './state.js';
|
|
6
6
|
import { getTestStatus, isEmpty, isMochaEachHooks, getErrorFromFailedTest, isMochaAllHooks, getLinkByTemplate, isScreenshotCommand, getSuiteLabels, setHistoryId, } from './utils.js';
|
|
7
7
|
import { events } from './constants.js';
|
|
@@ -40,6 +40,8 @@ class AllureReporter extends WDIOReporter {
|
|
|
40
40
|
return this._originalStdoutWrite(chunk, encoding, callback);
|
|
41
41
|
};
|
|
42
42
|
}
|
|
43
|
+
const { reportedEnvironmentVars } = this._options;
|
|
44
|
+
reportedEnvironmentVars && this._allure.writeEnvironmentInfo(reportedEnvironmentVars);
|
|
43
45
|
}
|
|
44
46
|
attachLogs() {
|
|
45
47
|
if (!this._consoleOutput || !this._state.currentAllureTestOrStep) {
|
|
@@ -198,7 +200,6 @@ class AllureReporter extends WDIOReporter {
|
|
|
198
200
|
process.on(events.addEpic, this.addEpic.bind(this));
|
|
199
201
|
process.on(events.addIssue, this.addIssue.bind(this));
|
|
200
202
|
process.on(events.addTestId, this.addTestId.bind(this));
|
|
201
|
-
process.on(events.addEnvironment, this.addEnvironment.bind(this));
|
|
202
203
|
process.on(events.addAttachment, this.addAttachment.bind(this));
|
|
203
204
|
process.on(events.addDescription, this.addDescription.bind(this));
|
|
204
205
|
process.on(events.startStep, this.startStep.bind(this));
|
|
@@ -526,11 +527,6 @@ class AllureReporter extends WDIOReporter {
|
|
|
526
527
|
type: LinkType.ISSUE
|
|
527
528
|
});
|
|
528
529
|
}
|
|
529
|
-
addEnvironment({ name, value }) {
|
|
530
|
-
this._allure.writeEnvironmentInfo({
|
|
531
|
-
[name]: value,
|
|
532
|
-
});
|
|
533
|
-
}
|
|
534
530
|
addDescription({ description, descriptionType }) {
|
|
535
531
|
if (!this._state.currentTest) {
|
|
536
532
|
return;
|
|
@@ -630,7 +626,6 @@ class AllureReporter extends WDIOReporter {
|
|
|
630
626
|
static addParentSuite = addParentSuite;
|
|
631
627
|
static addTestId = addTestId;
|
|
632
628
|
static addStory = addStory;
|
|
633
|
-
static addEnvironment = addEnvironment;
|
|
634
629
|
static addDescription = addDescription;
|
|
635
630
|
static addAttachment = addAttachment;
|
|
636
631
|
static startStep = startStep;
|
package/build/types.d.ts
CHANGED
|
@@ -42,6 +42,11 @@ export interface AllureReporterOptions {
|
|
|
42
42
|
* @default false
|
|
43
43
|
*/
|
|
44
44
|
addConsoleLogs?: boolean;
|
|
45
|
+
/**
|
|
46
|
+
* Set this option to display the environment variables in the report.
|
|
47
|
+
* Note that setting this does not modify the actual environment variables.
|
|
48
|
+
*/
|
|
49
|
+
reportedEnvironmentVars?: Record<string, string>;
|
|
45
50
|
}
|
|
46
51
|
export interface AddLabelEventArgs {
|
|
47
52
|
name: string;
|
|
@@ -90,10 +95,6 @@ export interface AddTestIdEventArgs {
|
|
|
90
95
|
testId: string;
|
|
91
96
|
linkName?: string;
|
|
92
97
|
}
|
|
93
|
-
export interface AddEnvironmentEventArgs {
|
|
94
|
-
name: string;
|
|
95
|
-
value: string;
|
|
96
|
-
}
|
|
97
98
|
export declare enum TYPE {
|
|
98
99
|
TEXT = "text",
|
|
99
100
|
HTML = "html",
|
package/build/types.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAA;IACjC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;OAEG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAA;IACxC;;OAEG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAA;IAC9C;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;;MAGE;IACF,cAAc,CAAC,EAAE,OAAO,CAAA;
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC;;;;OAIG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB;;;OAGG;IACH,uBAAuB,CAAC,EAAE,OAAO,CAAA;IACjC;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAA;IAC3B;;OAEG;IACH,8BAA8B,CAAC,EAAE,OAAO,CAAA;IACxC;;OAEG;IACH,oCAAoC,CAAC,EAAE,OAAO,CAAA;IAC9C;;;;OAIG;IACH,iBAAiB,CAAC,EAAE,MAAM,CAAA;IAC1B;;;OAGG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IACxB;;;MAGE;IACF,cAAc,CAAC,EAAE,OAAO,CAAA;IACxB;;;MAGE;IACF,uBAAuB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CACnD;AAED,MAAM,WAAW,iBAAiB;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,iBAAiB;IAC9B,SAAS,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,oBAAoB;IACjC,EAAE,EAAE,MAAM,CAAA;CACb;AAED,MAAM,WAAW,mBAAmB;IAChC,WAAW,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,oBAAoB;IACjC,QAAQ,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,gBAAgB;IAC7B,QAAQ,EAAE,MAAM,CAAA;CACnB;AAED,MAAM,WAAW,iBAAiB;IAC9B,SAAS,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,uBAAuB;IACpC,SAAS,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,oBAAoB;IACjC,SAAS,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,iBAAiB;IAC9B,KAAK,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,eAAe;IAC5B,GAAG,EAAE,MAAM,CAAA;CACd;AAED,MAAM,WAAW,gBAAgB;IAC7B,GAAG,EAAE,MAAM,CAAA;IACX,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,CAAC,EAAE,MAAM,CAAA;CAChB;AAED,MAAM,WAAW,iBAAiB;IAC9B,KAAK,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,kBAAkB;IAC/B,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,oBAAY,IAAI;IACZ,IAAI,SAAS;IACb,IAAI,SAAS;IACb,QAAQ,aAAa;CACxB;AAED,MAAM,WAAW,uBAAuB;IACpC,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,eAAe,CAAC,EAAE,IAAI,CAAA;CACzB;AAED,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,GAAG,MAAM,CAAA;IACxB,IAAI,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,IAAI;IACjB,WAAW,EAAE,UAAU,EAAE,CAAC;IAC1B,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAC1B,aAAa,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IAC5C,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5D,KAAK,IAAI,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,MAAM,GAAG,QAAQ,GAAG,SAAS,GAAG,SAAS,GAAG,QAAQ,GAAG,QAAQ,GAAG,UAAU,CAAC;AACzF,MAAM,WAAW,UAAU;IACvB,OAAO,CAAC,IAAI,EAAE,IAAI,GAAG,IAAI,CAAC;IAC1B,aAAa,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAC;IAC5C,GAAG,CAAC,MAAM,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,EAAE,SAAS,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAC5D,KAAK,IAAI,MAAM,CAAC;CACnB;AAED,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,WAAW,CAAC;QAClB,UAAU,cAAe,SAAQ,qBAAqB;SAAI;KAC7D;CACJ"}
|
package/cjs/common/api.js
CHANGED
|
@@ -144,11 +144,11 @@ exports.addTag = addTag;
|
|
|
144
144
|
/**
|
|
145
145
|
* Add environment value
|
|
146
146
|
* @name addEnvironment
|
|
147
|
-
* @
|
|
148
|
-
* @param {string} value - environment value
|
|
147
|
+
* @deprecated addEnvironment is deprecated. Use reportedEnvironmentVars in config instead.
|
|
149
148
|
*/
|
|
149
|
+
// eslint-disable-next-line @typescript-eslint/no-unused-vars
|
|
150
150
|
function addEnvironment(name, value) {
|
|
151
|
-
|
|
151
|
+
console.warn('⚠️ addEnvironment is deprecated and has no longer any functionality. Use reportedEnvironmentVars in wdio config instead. Read more in https://webdriver.io/docs/allure-reporter.');
|
|
152
152
|
}
|
|
153
153
|
exports.addEnvironment = addEnvironment;
|
|
154
154
|
/**
|
|
@@ -239,5 +239,5 @@ async function step(name, body) {
|
|
|
239
239
|
exports.step = step;
|
|
240
240
|
exports.default = {
|
|
241
241
|
addFeature, addAllureId, addLabel, addSeverity, addIssue, addTestId, addStory, addEnvironment,
|
|
242
|
-
addDescription, addAttachment, startStep, endStep, addStep, addArgument, step,
|
|
242
|
+
addDescription, addAttachment, startStep, endStep, addStep, addArgument, step, addTag
|
|
243
243
|
};
|
package/cjs/constants.js
CHANGED
|
@@ -16,7 +16,6 @@ exports.events = {
|
|
|
16
16
|
addIssue: 'allure:addIssue',
|
|
17
17
|
addAllureId: 'allure:addAllureId',
|
|
18
18
|
addTestId: 'allure:addTestId',
|
|
19
|
-
addEnvironment: 'allure:addEnvironment',
|
|
20
19
|
addDescription: 'allure:addDescription',
|
|
21
20
|
addAttachment: 'allure:addAttachment',
|
|
22
21
|
startStep: 'allure:startStep',
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@wdio/allure-reporter",
|
|
3
|
-
"version": "8.10.
|
|
3
|
+
"version": "8.10.7",
|
|
4
4
|
"description": "A WebdriverIO reporter plugin to create Allure Test Reports",
|
|
5
5
|
"author": "Boris Osipov <osipov.boris@gmail.com>",
|
|
6
6
|
"homepage": "https://github.com/webdriverio/webdriverio/tree/main/packages/wdio-allure-reporter",
|
|
@@ -40,14 +40,14 @@
|
|
|
40
40
|
},
|
|
41
41
|
"dependencies": {
|
|
42
42
|
"@types/node": "^20.1.0",
|
|
43
|
-
"@wdio/reporter": "8.10.
|
|
43
|
+
"@wdio/reporter": "8.10.6",
|
|
44
44
|
"@wdio/types": "8.10.4",
|
|
45
45
|
"allure-js-commons": "^2.0.0",
|
|
46
46
|
"csv-stringify": "^6.0.4",
|
|
47
|
-
"strip-ansi": "^
|
|
47
|
+
"strip-ansi": "^7.1.0"
|
|
48
48
|
},
|
|
49
49
|
"publishConfig": {
|
|
50
50
|
"access": "public"
|
|
51
51
|
},
|
|
52
|
-
"gitHead": "
|
|
52
|
+
"gitHead": "c7f9f09295f3ddfff03279f552f7b36a03575d1f"
|
|
53
53
|
}
|