PyTest deprecation: ‘junit_family default value will change to ‘xunit2’

I’m getting deprecation warning from my pipelines at circleci.

Message.

/home/circleci/evobench/env/lib/python3.7/site-packages/_pytest/junitxml.py:436: PytestDeprecationWarning: The 'junit_family' default value will change to 'xunit2' in pytest 6.0.

Command

- run:
    name: Tests
    command: |
      . env/bin/activate
      mkdir test-reports
      python -m pytest --junitxml=test-reports/junit.xml

How should I modify command to use xunit? Is it possible to a default tool, as it is mentioned in the message? I mean without specyfing xunit or junit.

Here’s full pipeline.

Answer

Run your command in this ways.

with xunit2

python -m pytest -o junit_family=xunit2 --junitxml=test-reports/junit.xml

with xunit1

python -m pytest -o junit_family=xunit1 --junitxml=test-reports/junit.xml or

python -m pytest -o junit_family=legacy --junitxml=test-reports/junit.xml

This here describes the change in detail:

The default value of junit_family option will change to xunit2 in pytest 6.0, given that this is the version supported by default in modern tools that manipulate this type of file.

In order to smooth the transition, pytest will issue a warning in case the –junitxml option is given in the command line but junit_family is not explicitly configured in pytest.ini:

PytestDeprecationWarning: The `junit_family` default value will change to 'xunit2' in pytest 6.0.   Add `junit_family=legacy` to your

pytest.ini file to silence this warning and make your suite compatible.

In order to silence this warning, users just need to configure the junit_family option explicitly:

[pytest]
junit_family=legacy