Allure reporter add environment variables in config #10452

m4hdyar · 2023-05-26T10:05:33Z

Proposed changes

Closes #10321
With this pull request we can use reportedEnvironmentVars in the config instead of using addEnvironment in tests

Types of changes

Bugfix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)
Documentation update

Checklist

I have read the CONTRIBUTING doc
I have added tests that prove my fix is effective or that my feature works
I have added necessary documentation (if appropriate)
I have added proper type definitions for new commands (if appropriate)

Further comments

Reviewers: @webdriverio/project-committers

* update code links for browser->waitUntil * update example link with SHA commit instead of main

* New translations Donate.md (Bulgarian) * New translations Element.md (Polish) * New translations Donate.md (Bulgarian) * New translations Element.md (Polish) * New translations Donate.md (Bulgarian) * New translations Materials.md (Bulgarian) * New translations code.json (Bulgarian)

linux-foundation-easycla · 2023-05-26T10:05:39Z

The committers listed above are authorized under a signed CLA.

✅ login: harsha509 / name: Sri Harsha (5d3f874)
✅ login: christian-bromann / name: Christian Bromann (8dd7987, 69b8e40, 253f0ef, 9d3e576, 42de21d, 053fa39)
✅ login: admc / name: Adam Christian (a7214a8)
✅ login: dependabot[bot] (ab1d0a6, f7595d8, 928fc4f, f7d9a04, da84760, 72c64e5, 899be18, 607efda, a8ade14, fdb3ef9)
✅ login: udarrr / name: Siarhei Kliushnikau (36e2c20)
✅ login: lukefitz1 (cd0a7bf)
✅ login: wdio-bot / name: WebdriverIO Bot (0afe30e)
✅ login: m4hdyar / name: Mahdyar (c955b8a, 8893557, 0087f96, 633ba1c, 9217520, 58170a6, 1488634)

christian-bromann · 2023-05-26T15:43:57Z

Thanks for raising the pull request.

I am a bit concerned removing addEnvironment entirely because it could potentially break other peoples test. I would recommend better deprecate it and log a warning that the method will be removed soon. Does addEnvironment still has a function in the reporter?

m4hdyar · 2023-05-27T21:43:26Z

Thanks for raising the pull request.

I am a bit concerned removing addEnvironment entirely because it could potentially break other peoples test. I would recommend better deprecate it and log a warning that the method will be removed soon. Does addEnvironment still has a function in the reporter?

addEnvironment still has a function, but when you use it a second time, it will overwrite the first value. This means you cannot add more than one environment variable. So, if you only need to add one environment variable, it works correctly, although that is not usually the case.
If we keep it, it will also override environment variables that you write in the config.

I understand the importance of not disrupting people's tests. But the error is relatively easy to fix. However, in my opinion, deprecating addEnvironment without correcting its functionality would result in incorrect functionality without displaying any error, leading to unpredictable behavior for users.

On the other hand, if we choose to deprecate and also correct the behavior of addEnvironment, it would involve introducing a significant amount of unnecessary complexity.

What do you think?

Bumps [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser) from 5.59.6 to 5.59.7. - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases) - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/parser/CHANGELOG.md) - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v5.59.7/packages/parser) --- updated-dependencies: - dependency-name: "@typescript-eslint/parser" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [@typescript-eslint/utils](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/utils) from 5.59.6 to 5.59.7. - [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases) - [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/utils/CHANGELOG.md) - [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v5.59.7/packages/utils) --- updated-dependencies: - dependency-name: "@typescript-eslint/utils" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…0458) Bumps [devtools-protocol](https://github.com/ChromeDevTools/devtools-protocol) from 0.0.1146845 to 0.0.1149535. - [Changelog](https://github.com/ChromeDevTools/devtools-protocol/blob/master/changelog.md) - [Commits](ChromeDevTools/devtools-protocol@v0.0.1146845...v0.0.1149535) --- updated-dependencies: - dependency-name: devtools-protocol dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [aws-sdk](https://github.com/aws/aws-sdk-js) from 2.1381.0 to 2.1386.0. - [Release notes](https://github.com/aws/aws-sdk-js/releases) - [Commits](aws/aws-sdk-js@v2.1381.0...v2.1386.0) --- updated-dependencies: - dependency-name: aws-sdk dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [@types/jasmine](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/HEAD/types/jasmine) from 4.3.1 to 4.3.2. - [Release notes](https://github.com/DefinitelyTyped/DefinitelyTyped/releases) - [Commits](https://github.com/DefinitelyTyped/DefinitelyTyped/commits/HEAD/types/jasmine) --- updated-dependencies: - dependency-name: "@types/jasmine" dependency-type: direct:development update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

) Bumps [@sveltejs/vite-plugin-svelte](https://github.com/sveltejs/vite-plugin-svelte/tree/HEAD/packages/vite-plugin-svelte) from 2.3.0 to 2.4.1. - [Release notes](https://github.com/sveltejs/vite-plugin-svelte/releases) - [Changelog](https://github.com/sveltejs/vite-plugin-svelte/blob/main/packages/vite-plugin-svelte/CHANGELOG.md) - [Commits](https://github.com/sveltejs/vite-plugin-svelte/commits/@sveltejs/vite-plugin-svelte@2.4.1/packages/vite-plugin-svelte) --- updated-dependencies: - dependency-name: "@sveltejs/vite-plugin-svelte" dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [@vitest/coverage-c8](https://github.com/vitest-dev/vitest/tree/HEAD/packages/coverage-c8) from 0.30.1 to 0.31.1. - [Release notes](https://github.com/vitest-dev/vitest/releases) - [Commits](https://github.com/vitest-dev/vitest/commits/v0.31.1/packages/coverage-c8) --- updated-dependencies: - dependency-name: "@vitest/coverage-c8" dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [strip-ansi](https://github.com/chalk/strip-ansi) from 6.0.1 to 7.1.0. - [Release notes](https://github.com/chalk/strip-ansi/releases) - [Commits](chalk/strip-ansi@v6.0.1...v7.1.0) --- updated-dependencies: - dependency-name: strip-ansi dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [dependabot/fetch-metadata](https://github.com/dependabot/fetch-metadata) from 1.4.0 to 1.5.1. - [Release notes](https://github.com/dependabot/fetch-metadata/releases) - [Commits](dependabot/fetch-metadata@v1.4.0...v1.5.1) --- updated-dependencies: - dependency-name: dependabot/fetch-metadata dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

christian-bromann · 2023-05-30T04:11:26Z

However, in my opinion, deprecating addEnvironment without correcting its functionality would result in incorrect functionality without displaying any error, leading to unpredictable behavior for users.

Why we can't deprecated and notify people at the same time about the error, even give them some instructions how to use the new interface. I am not sure why keeping addEnvironment imposes more complexity but I would rather want to keep it with a deprecation warning.

…ebdriverio#10454) * added new service have been named 'wdio-robonut-service' * fixed title mistake * added wdio-robonut-service to cli constants external section

* New translations options.json (Bulgarian) * New translations current.json (Bulgarian) * New translations current.json (Bulgarian) * New translations current.json (Bulgarian) * New translations code.json (Bulgarian) * New translations current.json (Bulgarian) * New translations current.json (Bulgarian) * New translations footer.json (Bulgarian) * New translations navbar.json (Bulgarian) * New translations code.json (Bulgarian) * New translations current.json (Bulgarian) * New translations Browser.md (Bulgarian) * New translations Team.md (Bulgarian) * New translations code.json (Bulgarian) * New translations code.json (Bulgarian) * New translations Environment.md (Polish) * New translations Environment.md (Polish) * New translations Environment.md (Polish) * New translations Browser.md (Polish) * New translations Globals.md (Polish) * New translations Mock.md (Polish) * New translations Mock.md (Polish)

Co-authored-by: Luke Fitzgerald <luke.fitzgerald@nutrien.com>

BorisOsipov · 2023-05-30T18:47:39Z

@m4hdyar @christian-bromann

The best solution for me would be to deprecate addEnvironment and display a warning message with a link to the documentation. Additionally, we should modify addEnvironment to have no functionality at all. This approach will alert users to switch to the new method(config approach) and provide an easy way to migrate. Of course, we may encounter some issues where users complain that addEnvironment is not working, but there is no better solution available.

christian-bromann · 2023-05-30T18:49:38Z

Sounds reasonable @BorisOsipov 👍

* New translations Modules.md (Polish) * New translations Modules.md (Polish)

Bumps [got](https://github.com/sindresorhus/got) from 12.6.1 to 13.0.0. - [Release notes](https://github.com/sindresorhus/got/releases) - [Commits](sindresorhus/got@v12.6.1...v13.0.0) --- updated-dependencies: - dependency-name: got dependency-type: direct:production update-type: version-update:semver-major ... Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

ref sindresorhus/got#2267

m4hdyar · 2023-06-01T13:29:51Z

@christian-bromann Sounds reasonable to me too.
I've added it again as a deprecated function.

christian-bromann

LGTM 👍

@BorisOsipov any comments?

packages/wdio-allure-reporter/src/common/api.ts

BorisOsipov · 2023-06-01T16:38:20Z

LGTM

christian-bromann · 2023-06-01T17:12:42Z

@m4hdyar mind signing the CLA, also please see my comment?

Change the deprecation message Co-authored-by: Christian Bromann <git@bromann.dev>

m4hdyar · 2023-06-01T19:52:05Z

@christian-bromann In order to sign EasyCLA, I had to change the commit's author and email so I did a rebase. If this is not suitable I can make another pull request with the appropriate commits.

christian-bromann · 2023-06-01T20:01:31Z

That should work, thanks!

harsha509 and others added 4 commits May 24, 2023 12:19

update code links for browser->waitUntil (webdriverio#10446)

5d3f874

* update code links for browser->waitUntil * update example link with SHA commit instead of main

Recommend the runme extension for vs coders (webdriverio#10449)

a7214a8

tabs vs spaces

69b8e40

dependabot bot added 9 commits May 29, 2023 12:23

udarrr and others added 3 commits May 30, 2023 17:54

added new service to services list is named 'wdio-robonut-service' (w…

36e2c20

…ebdriverio#10454) * added new service have been named 'wdio-robonut-service' * fixed title mistake * added wdio-robonut-service to cli constants external section

exporting the addTag method so it can be used (webdriverio#10477)

cd0a7bf

Co-authored-by: Luke Fitzgerald <luke.fitzgerald@nutrien.com>

christian-bromann and others added 5 commits May 31, 2023 13:17

New Crowdin updates (webdriverio#10478)

9d3e576

* New translations Modules.md (Polish) * New translations Modules.md (Polish)

Revert got from v13 to v12.6.0 due to type issues

42de21d

ref sindresorhus/got#2267

adjust test coverage

053fa39

v8.10.6

0afe30e

christian-bromann approved these changes Jun 1, 2023

View reviewed changes

packages/wdio-allure-reporter/src/common/api.ts Outdated Show resolved Hide resolved

BorisOsipov approved these changes Jun 1, 2023

View reviewed changes

m4hdyar and others added 6 commits June 1, 2023 21:36

Remove addEnvironment

c955b8a

Setting the environment variables in the config

8893557

Adjust allure tests because of environment changes

0087f96

Merge branch 'webdriverio:main' into main

633ba1c

Add environment changes of allure to documentation

9217520

Add addEnvironment function again as a deprecated function

58170a6

m4hdyar force-pushed the main branch from 72d20ac to 8462023 Compare June 1, 2023 19:41

Merge remote-tracking branch 'upstream/main'

1488634

m4hdyar force-pushed the main branch from 8462023 to 1488634 Compare June 1, 2023 19:43

Update packages/wdio-allure-reporter/src/common/api.ts

e0b5b6f

Change the deprecation message Co-authored-by: Christian Bromann <git@bromann.dev>

baev approved these changes Jun 1, 2023

View reviewed changes

christian-bromann added the PR: Bug Fix 🐛 PRs that contain bug fixes label Jun 1, 2023

christian-bromann merged commit 7d4f930 into webdriverio:main Jun 1, 2023
7 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Allure reporter add environment variables in config #10452

Allure reporter add environment variables in config #10452

m4hdyar commented May 26, 2023 •

edited

linux-foundation-easycla bot commented May 26, 2023 •

edited

christian-bromann commented May 26, 2023 •

edited

m4hdyar commented May 27, 2023

christian-bromann commented May 30, 2023

BorisOsipov commented May 30, 2023 •

edited

christian-bromann commented May 30, 2023

m4hdyar commented Jun 1, 2023

christian-bromann left a comment

BorisOsipov commented Jun 1, 2023

christian-bromann commented Jun 1, 2023 •

edited

m4hdyar commented Jun 1, 2023

christian-bromann commented Jun 1, 2023

Allure reporter add environment variables in config #10452

Allure reporter add environment variables in config #10452

Conversation

m4hdyar commented May 26, 2023 • edited

Proposed changes

Types of changes

Checklist

Further comments

Reviewers: @webdriverio/project-committers

linux-foundation-easycla bot commented May 26, 2023 • edited

christian-bromann commented May 26, 2023 • edited

m4hdyar commented May 27, 2023

christian-bromann commented May 30, 2023

BorisOsipov commented May 30, 2023 • edited

christian-bromann commented May 30, 2023

m4hdyar commented Jun 1, 2023

christian-bromann left a comment

Choose a reason for hiding this comment

BorisOsipov commented Jun 1, 2023

christian-bromann commented Jun 1, 2023 • edited

m4hdyar commented Jun 1, 2023

christian-bromann commented Jun 1, 2023

m4hdyar commented May 26, 2023 •

edited

linux-foundation-easycla bot commented May 26, 2023 •

edited

christian-bromann commented May 26, 2023 •

edited

BorisOsipov commented May 30, 2023 •

edited

christian-bromann commented Jun 1, 2023 •

edited