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

Replace version comparison with duck-style checks (fix #802) #803

Merged
merged 5 commits into from
Apr 1, 2024

Conversation

delatrie
Copy link
Contributor

@delatrie delatrie commented Apr 1, 2024

Context

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:

  1. It doesn't require an extra dependency to parse versions.
  2. 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.

Fixes #802.

@delatrie delatrie added bug Something isn't working theme:pytest theme:behave labels Apr 1, 2024
@delatrie delatrie self-assigned this Apr 1, 2024
@delatrie delatrie force-pushed the bugfix-802-packaging branch from 9ba3bdb to c6f146a Compare April 1, 2024 14:38
@delatrie 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
@delatrie delatrie requested a review from skhomuti April 1, 2024 15:22
@delatrie delatrie marked this pull request as ready for review April 1, 2024 15:30
@delatrie delatrie force-pushed the bugfix-802-packaging branch from 5cd6d6c to 3bc79f5 Compare April 1, 2024 16:32
@skhomuti 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
@delatrie delatrie merged commit d857349 into master Apr 1, 2024
28 checks passed
@delatrie delatrie deleted the bugfix-802-packaging branch April 1, 2024 16:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working theme:behave theme:pytest
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Allure-behave 2.13.4 causes error with formatter in Python Behave
2 participants