We currently have two occasions where we need to support backward incompatible changes in test frameworks:
Behave 1.2.7 (a pre-release, as for now) replaced Configuration.tags with Configuration.tag_expression.
pytest 8.1 requires a node object to be passed to FixtureManager.getfixturedefs instead of the nodeid string.
We initially handled those by directly comparing Behave/pytest versions with packaging.version.parse.
The solution works fine in allure-pytest since the packaging module is a transitive dependency of pytest.
On the other hand, allure-behave crashes with ModuleNotFoundError unless packaging becomes available either by hand or via some other package (e.g., setuptools). That happens because packaging is missing in the install_requires metadata of allure-behave.
After some discussion, we've decided to abandon version comparison in favor of duck-style checking:
It doesn't require an extra dependency to parse versions.
It's more resistant to future changes (in case the change will be reverted).
Compatibility with Behave
We now try to access the tag_expression attribute first. If the attribute doesn't exist, the tags attribute is accessed instead.
Compatibility with pytest
We're checking the getfixturedefs signature. If the second parameter's annotation is str, it's provided with nodeid. Otherwise, it's provided with the node object itself. The inspection is only done once, on the first call to getfixturedefs. The remaining calls use the cached result of the check.
Additional changes
Log capturing tests
Log capturing tests for allure-pytest and allure-pytest-bdd now raise --log-level to WARNING instead of turning off the logging plugin when checking the case of disabled capturing. That prevents the unrecognized arguments: --log-level=INFO error when running against pytest 7.
CI actions update
As described here, actions that use Node.js version 16 are now deprecated. This PR updates such actions to the latest versions.
Flake config adjustment
This PR configs flake8 to ignore the new A005: the module is shadowing a Python builtin module rule for already existing modules allure_commons.types and allure-robotframework.listener.types.
delatrie
changed the title
Add packaging to install_requires of allure-behave and allure-pytest (fix #802)
Replace version compatison with duck-style checks (fix #802)
Apr 1, 2024
skhomuti
changed the title
Replace version compatison with duck-style checks (fix #802)
Replace version comparison with duck-style checks (fix #802)
Apr 1, 2024
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Context
We currently have two occasions where we need to support backward incompatible changes in test frameworks:
We initially handled those by directly comparing Behave/pytest versions with packaging.version.parse.
The solution works fine in allure-pytest since the packaging module is a transitive dependency of pytest.
On the other hand, allure-behave crashes with ModuleNotFoundError unless packaging becomes available either by hand or via some other package (e.g., setuptools). That happens because packaging is missing in the install_requires metadata of allure-behave.
After some discussion, we've decided to abandon version comparison in favor of duck-style checking:
Compatibility with Behave
We now try to access the tag_expression attribute first. If the attribute doesn't exist, the tags attribute is accessed instead.
Compatibility with pytest
We're checking the getfixturedefs signature. If the second parameter's annotation is str, it's provided with nodeid. Otherwise, it's provided with the node object itself. The inspection is only done once, on the first call to getfixturedefs. The remaining calls use the cached result of the check.
Additional changes
Log capturing tests
Log capturing tests for allure-pytest and allure-pytest-bdd now raise --log-level to WARNING instead of turning off the logging plugin when checking the case of disabled capturing. That prevents the unrecognized arguments: --log-level=INFO error when running against pytest 7.
CI actions update
As described here, actions that use Node.js version 16 are now deprecated. This PR updates such actions to the latest versions.
Flake config adjustment
This PR configs flake8 to ignore the new A005: the module is shadowing a Python builtin module rule for already existing modules allure_commons.types and allure-robotframework.listener.types.
Fixes #802.