Skip to content

Change junit_family default to xunit2 in pytest 6 #6178

Closed
Closed
Change junit_family default to xunit2 in pytest 6#6178
Assignees
nicoddemus
Labels
good first issueeasy issue that is friendly to new contributorplugin: junitxmlrelated to the junitxml builtin plugintype: backward compatibilitymight present some backward compatibility issues which should be carefully noted in the changelog
Milestone
6.1

Description

@nicoddemus
nicoddemus
opened on Nov 13, 2019

In order to do that, we also need to show a warning if the user does not have junit_family configured stating that the default will change in 6.0

Activity

  1. nicoddemus
    added this to the 6.1 milestone on Nov 13, 2019
  2. nicoddemus
    added
    plugin: junitxmlrelated to the junitxml builtin plugin
    type: backward compatibilitymight present some backward compatibility issues which should be carefully noted in the changelog
    on Nov 13, 2019
  3. nicoddemus
    self-assigned this
    on Nov 13, 2019

  4. Zac-HD commented on Nov 26, 2019

    @Zac-HD
    Zac-HD
    on Nov 26, 2019
    Member

    Per #6265 (comment) we already have such a warning - that issue is just to expand and clarify the message.

  5. Zac-HD
    added
    good first issueeasy issue that is friendly to new contributor
    on Nov 26, 2019
  6. blueyed
    closed this as completedon Nov 27, 2019

  7. Zac-HD commented on Nov 27, 2019

    @Zac-HD
    Zac-HD
    on Nov 27, 2019
    Member

    @blueyed - I think it's worth keeping this open so we remember to change it in pytest 6?

  8. blueyed
    reopened this on Nov 27, 2019

  9. blueyed commented on Nov 27, 2019

    @blueyed
    blueyed
    on Nov 27, 2019
    Contributor

    @Zac-HD
    GitHub failed me when I only wanted to close my issues, sorry.

  10. Zac-HD commented on Nov 27, 2019

    @Zac-HD
    Zac-HD
    on Nov 27, 2019
    Member

    No worries, easily fixed 😄

  11. Zac-HD
    changed the title [-]Change junit_family default to xunit2[/-] [+]Change junit_family default to xunit2 in pytest 6[/+] on Nov 27, 2019

  12. bittner commented on Apr 26, 2020

    @bittner
    bittner
    on Apr 26, 2020

    Running tests with pytest now shows the warning you mention. But it's unclear what the impact of this change is, hence what should I as a developer actually do?

    • Is it required to add the junit_family=xunit1 line to my pytest configuration?
    • Will my CI build be affected or something (aka, can I ignore this warning if I don't use Jenkins)?
    .tox/py37/lib/python3.7/site-packages/_pytest/junitxml.py:417
  <redacted>/_pytest/junitxml.py:417: PytestDeprecationWarning: The 'junit_family' default value will change to 'xunit2' in pytest 6.0.
  Add 'junit_family=xunit1' to your pytest.ini file to keep the current format in future versions of pytest and silence this warning.
    _issue_warning_captured(deprecated.JUNIT_XML_DEFAULT_FAMILY, config.hook, 2)

-- Docs: https://docs.pytest.org/en/latest/warnings.html

    The link provided doesn't seem to have information related to the impact of the change, but rather on how warnings are handled and can be controled.

    ➜ Where can I find information about the impact that this change will have?

  13. nicoddemus commented on Apr 28, 2020

    @nicoddemus
    nicoddemus
    on Apr 28, 2020
    MemberAuthor

    Hi @bittner,

    Actually the important bit is here (emphasis mine):

    Add 'junit_family=xunit1' to your pytest.ini file to keep the current format in future versions of pytest

    So yes the answer is to add that line to your pytest.ini to avoid having your suite breaking when upgrading to pytest 6. 👍

  14. bittner commented on Apr 28, 2020

    @bittner
    bittner
    on Apr 28, 2020

    I did read (and understand) that, but why should my test suite break for a jUnit output format? Note that I guess it's all about the --junitxml option. My tests won't break, will they?

    So, if they won't, what will break? What are you warning about? Should I (and others) care? What would the "upgrade path" look like?

  15. 32 remaining items

  16. clrpackages
    added 4 commits that reference this issue on Nov 9, 2021

    setuptools: Autospec creation for update from version 58.3.0 to versi…

    805d443

    jaraco.functools: Autospec creation for update from version 3.3.0 to …

    ab4c66c

    backports.entry_points_selectable: Autospec creation for update from …

    c8c9de5

    importlib_metadata: Autospec creation for update from version 4.8.1 t…

    006fed5
  17. clrpackages
    added a commit that references this issue on Dec 2, 2021

    keyring: Autospec creation for update from version 23.2.1 to version …

    fcadda1
  18. clrpackages
    added 2 commits that reference this issue on Jan 4, 2022

    zipp: Autospec creation for update from version 3.6.0 to version 3.7.0

    5a6aeb2

    jaraco.collections: Autospec creation for update from version 3.4.0 t…

    3e6b455
  19. clrpackages
    added a commit that references this issue on Jan 17, 2022

    pypi-tempora: Autospec creation for update from version 4.1.2 to vers…

    c8fc81a
  20. clrpackages
    added a commit that references this issue on Mar 1, 2022

    pypi-pytest_runner: Autospec creation for update from version 5.3.1 t…

    a82e5db
  21. jaraco
    added a commit that references this issue on Mar 18, 2022

    Rely on pytest 6 and drop workaround for pytest-dev/pytest#6178.

    c7f7d5c
  22. clrpackages
    added a commit that references this issue on Jul 14, 2022

    pypi-jaraco.classes: Autospec creation for update from version 3.2.1 …

    c1d95d6
  23. jaraco
    added 2 commits that reference this issue on Jun 20, 2023

    Add workaround for warning emitted when junitxml is used. Ref pytest-…

    11fcbd2

    Rely on pytest 6 and drop workaround for pytest-dev/pytest#6178.

    1baec6b
  24. hswong3i
    added 2 commits that reference this issue on Jan 3, 2025

    Rely on pytest 6 and drop workaround for pytest-dev/pytest#6178.

    f6537ce

    Rely on pytest 6 and drop workaround for pytest-dev/pytest#6178.

    227d958
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

good first issueeasy issue that is friendly to new contributorplugin: junitxmlrelated to the junitxml builtin plugintype: backward compatibilitymight present some backward compatibility issues which should be carefully noted in the changelog

Type

No type

Projects

No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions