Skip to content

Add pytest ParameterSet.id placeholder for @allure.title formatter#787

Merged
delatrie merged 7 commits intoallure-framework:masterfrom
betapl3b:param_id
Feb 16, 2024
Merged

Add pytest ParameterSet.id placeholder for @allure.title formatter#787
delatrie merged 7 commits intoallure-framework:masterfrom
betapl3b:param_id

Conversation

@betapl3b
Copy link
Copy Markdown
Contributor

@betapl3b betapl3b commented Jan 2, 2024 •
edited
Loading

Context

Currently, to use ParameterSet.id (pytest.param(id=*)) in allure.title you need to use the request fixture in combination with the allure.dynamic.title function.
Thus, the complete design looks like this:

@pytest.mark.parametrize("name", [pytest.param("value", id="some id")])
def test_1(request)
    allure.dynamic.title(f"Test name with id = {request.node.callspec.id}")
    ...

My fix suggests using the following syntax:

@pytest.mark.parametrize("name", [pytest.param("value", id="some id")])
@allure.title("Test name with id = {param_id}")
def test_1()
    ...

Since many people already assign identifiers to their parameter sets, this syntax will save them from duplicating code. And it will also help avoid situations where a test fails before allure.dynamic.title is executed and the test result is left without DisplayName.

Checklist

@betapl3b betapl3b marked this pull request as ready for review January 2, 2024 17:21
delatrie
delatrie requested changes Feb 13, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@delatrie delatrie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi, @betapl3b ! Sorry for taking it so long.

Thanks for your contribution. The feature is nice to have, and I'm okay with pre-defined variables in that context.

The only thing I would ask you to change is to make the pre-defined variable overwritable by an explicit argument of a test (an extra test for that behavior would also be nice to have). See my comment for the example.

@betapl3b
Copy link
Copy Markdown
Contributor Author

betapl3b commented Feb 13, 2024

Hi, @betapl3b ! Sorry for taking it so long.

Thanks for your contribution. The feature is nice to have, and I'm okay with pre-defined variables in that context.

The only thing I would ask you to change is to make the pre-defined variable overwritable by an explicit argument of a test (an extra test for that behavior would also be nice to have). See my comment for the example.

Hello! Thank you for your feedback. It makes sense!

@betapl3b
Copy link
Copy Markdown
Contributor Author

betapl3b commented Feb 13, 2024 •
edited
Loading

Hi @delatrie, the changes in the pytest 8.0.0 release seem to break the tests. I tested them locally using the previous version (pytest 7.4.4) and they work fine. What do you do in these cases? Should we fix the requirements to prevent pytest 8.0.0 from being updated?

P.S. seems like TvoroG/pytest-lazy-fixture#65 is the reason

@delatrie
Copy link
Copy Markdown
Contributor

delatrie commented Feb 14, 2024

I don't think we should refrain from testing against the most recent version of pytest. It's unlikely the issue will be fixed soon (if at all) in lazy-fixture.
Let's wait until #793 gets merged (a day or two, I believe).

delatrie
delatrie requested changes Feb 15, 2024
View reviewed changes
Copy link
Copy Markdown
Contributor

@delatrie delatrie left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

#793 is merged.
Just one small grammar fix and we're good to go!

@betapl3b @delatrie
small grammar fix
0c79c5c 
Co-authored-by: Maxim <17935127+delatrie@users.noreply.github.com>
@delatrie delatrie merged commit 2e7ecd7 into allure-framework:master Feb 16, 2024
@betapl3b betapl3b deleted the param_id branch February 16, 2024 12:52
@delatrie delatrie self-assigned this Mar 1, 2024
IvanBuruyane pushed a commit to IvanBuruyane/allure-python that referenced this pull request Mar 19, 2024
@betapl3b @delatrie
Add pytest ParameterSet.id placeholder for @allure.title formatter (a…
3ae1278 
…llure-framework#787)

Co-authored-by: Maxim <17935127+delatrie@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@delatrie delatrie delatrie approved these changes

Assignees

@delatrie delatrie

Labels

theme:pytest type:enhancement

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@betapl3b @delatrie