Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improvement: Add Custom Data to the Environment Section of Allure, using config #277

Closed
8 tasks done
wurzelkuchen opened this issue Jul 31, 2024 · 1 comment · Fixed by #284
Closed
8 tasks done
Assignees
Labels
codeDone The issue is rechecked for development branch docsDone The documentation for this issue was rechecked and merged to the develop branch
Milestone

Comments

@wurzelkuchen
Copy link
Contributor

wurzelkuchen commented Jul 31, 2024

Quick Description

Allure provides the feature to add additional data to the environment box on the dashboard. Currently we store the neodymium version there as default, but adding additional data here has to be done by altering a file content which is not super nice.

We already have a function to add data on the fly: AllureAddons.addEnvironmentInformation(). But this would need changes in the test code, or some self build set up, if the environment should be changed.
To tackle this we should add the possibility to add environment data by using our property config. This way the data could be changed from outside for example by setting data in a build pipeline.

User Stories

As a test automation engineer,
I want to add environment data to the allure report using the configuration
so that I can see additional data about which environment the test ran upon without touching the code or the repository

Functional Requirements

  • Add the possibility to configure custom values to be added to the neodymium.properties.
  • The properties should be look like: neodymium.report.environment.custom.myValue = myKey
  • The properties should be added to the allure report automatically using myValue and myKey (as taken from the example above) as key and value.
  • This should work with properties variable replacments (see below).
  • Add some of our base values as an example in our provided neodymium.properties:
    neodymium.report.environment.custom.baseURL = ${neodymium.url}
    neodymium.report.environment.custom.baseURL = ${neodymium.locale}
  • This should work like our normal properties and look in different sources in the following order:
  1. System Environment Variables (NOTE: this is an "if possible" option, it might be difficult to achieve this)
  2. System Properties
  3. dev-neodymium.properties
  4. neodymium.properties

NOTE: this feature is probably not compatible with the owner framework we use. But we have some similar logic in our XLTProperties in the method getPropertiesForKey.

Documentation Requirements

  • Add a quick documentation for this feature to the Reports page in the wiki.

Test Requirements

  • Do a smoke test using an external test suite like neodymium example
@wurzelkuchen wurzelkuchen added docsNeeded The documenttion needs to be checked if there are changes needed and if so, adaptions should be made codeImplementationNeeded This issue requires a change in the code of Neodymium labels Jul 31, 2024
@wurzelkuchen wurzelkuchen added this to the v5.1.0 milestone Jul 31, 2024
@wurzelkuchen wurzelkuchen changed the title Add Custom Data to the Environment Section of Allure, using config Improvement: Add Custom Data to the Environment Section of Allure, using config Jul 31, 2024
@georgkunze georgkunze self-assigned this Aug 5, 2024
@georgkunze georgkunze linked a pull request Aug 9, 2024 that will close this issue
@georgkunze georgkunze added codeReadyForRecheck The issue is fixed/implemented AND merged into development, but needs to be rechecked there codeDone The issue is rechecked for development branch docsDone The documentation for this issue was rechecked and merged to the develop branch docsReadyForMerge Documentation was created for this issue in a separate branch which is ready to merge to develop and removed docsNeeded The documenttion needs to be checked if there are changes needed and if so, adaptions should be made codeImplementationNeeded This issue requires a change in the code of Neodymium codeDone The issue is rechecked for development branch docsDone The documentation for this issue was rechecked and merged to the develop branch labels Aug 9, 2024
@georgkunze
Copy link

Documentation done. Code is ready for Review. i added the example lines to the neodymium example project in a corresponding branch.

@georgkunze georgkunze assigned wurzelkuchen and unassigned georgkunze Aug 9, 2024
wurzelkuchen added a commit that referenced this issue Oct 23, 2024
@wurzelkuchen wurzelkuchen added docsDone The documentation for this issue was rechecked and merged to the develop branch and removed docsReadyForMerge Documentation was created for this issue in a separate branch which is ready to merge to develop labels Nov 29, 2024
@wurzelkuchen wurzelkuchen added codeDone The issue is rechecked for development branch and removed codeReadyForRecheck The issue is fixed/implemented AND merged into development, but needs to be rechecked there labels Jan 23, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
codeDone The issue is rechecked for development branch docsDone The documentation for this issue was rechecked and merged to the develop branch
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants