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

Add new param annotation #648

Merged
merged 3 commits into from
Sep 13, 2021
Merged

Add new param annotation #648

merged 3 commits into from
Sep 13, 2021

Conversation

baev
Copy link
Member

@baev baev commented Sep 3, 2021

Context

This pull request extends parameters API. The target issues are

  1. Add an ability to exclude some parameters from historyId calculation #80 Opportunity to exclude test parameter from history matching allure2#342 Opportunity to exclude test parameter from history matching. By now, all the parameters are included in history id calculation. The new excluded flag can change the behaviour.

  2. Feature request: a way to disable step parameter auto-displaying in the report. allure2#863 Hidden/Masked parameters. Sometimes, parameters may contains sensitive data. The request add's to additional modes to parameters: HIDDEN and MASKED

API changes

  • New Boolean excluded field added to io.qameta.allure.model.Parameter
  • New io.qameta.allure.model.Parameter.Mode enum added.
  • New Parameter.Mode mode field added to io.qameta.allure.model.Parameter
  • New io.qameta.allure.Param annotation, that already can be used together with Step:
    @Step("Login")
    void doLogin(@Param("Username") String user, @Param(name="Password", mode=MASKED) String pass) {
        // do something
    }
  • Additional Allure#parameter methods to respect new parameter's fields
  • Additional StepContext#parameter methods

Checklist

@baev baev added the type:new feature Change that add something new for end users label Sep 3, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
theme:core theme:workflow type:new feature Change that add something new for end users
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants