Fix CI: pytest-xdist 2 and attrs

blueyed · web-flow · commit b3085e17844b · 2020-08-25T19:32:05.000+02:00
diff --git a/.builds/freebsd.yml b/.builds/freebsd.yml
@@ -21,6 +21,8 @@ tasks:
       .venv/bin/tox --version
       cd pytest
       ../.venv/bin/tox --notest -v
+      .tox/py37-coverage-xdist/bin/pip --version
+      .tox/py37-coverage-xdist/bin/pip freeze
 
   - test: |
       cd pytest
diff --git a/.ci/report-coverage.sh b/.ci/report-coverage.sh
@@ -3,8 +3,7 @@
 set -ex
 
 # Set --connect-timeout to work around https://github.com/curl/curl/issues/4461
-curl -S -L --connect-timeout 5 --retry 6 -s -o /tmp/codecov.sh \
-  https://raw.githubusercontent.com/blueyed/codecov-bash/my-master/codecov
+curl -S -L --connect-timeout 5 --retry 6 -s -o /tmp/codecov.sh https://codecov.io/bash
 
 for _ in 1 2 3 4 5; do
   bash /tmp/codecov.sh -Z -X fix -X s3 -f coverage.xml "$@" && break
diff --git a/changelog/7255.feature.rst b/changelog/7255.feature.rst
@@ -0,0 +1,3 @@
+Introduced a new hook named `pytest_warning_recorded` to convey information about warnings captured by the internal `pytest` warnings plugin.
+
+This hook is meant to replace `pytest_warning_captured`, which will be removed in a future release.
diff --git a/changelog/7356.trivial.rst b/changelog/7356.trivial.rst
@@ -0,0 +1 @@
+Remove last internal uses of deprecated "slave" term from old pytest-xdist.
diff --git a/doc/en/announce/release-2.3.5.rst b/doc/en/announce/release-2.3.5.rst
@@ -46,7 +46,7 @@ Changes between 2.3.4 and 2.3.5
 - Issue 265 - integrate nose setup/teardown with setupstate
   so it doesn't try to teardown if it did not setup
 
-- issue 271 - don't write junitxml on slave nodes
+- issue 271 - don't write junitxml on worker nodes
 
 - Issue 274 - don't try to show full doctest example
   when doctest does not know the example location
diff --git a/doc/en/announce/release-2.6.1.rst b/doc/en/announce/release-2.6.1.rst
@@ -32,7 +32,7 @@ Changes 2.6.1
   purely the nodeid.  The line number is still shown in failure reports.
   Thanks Floris Bruynooghe.
 
-- fix issue437 where assertion rewriting could cause pytest-xdist slaves
+- fix issue437 where assertion rewriting could cause pytest-xdist worker nodes
   to collect different tests. Thanks Bruno Oliveira.
 
 - fix issue555: add "errors" attribute to capture-streams to satisfy
diff --git a/doc/en/changelog.rst b/doc/en/changelog.rst
@@ -5869,7 +5869,7 @@ time or change existing behaviors in order to make them less surprising/more use
   purely the nodeid.  The line number is still shown in failure reports.
   Thanks Floris Bruynooghe.
 
-- fix issue437 where assertion rewriting could cause pytest-xdist slaves
+- fix issue437 where assertion rewriting could cause pytest-xdist worker nodes
   to collect different tests. Thanks Bruno Oliveira.
 
 - fix issue555: add "errors" attribute to capture-streams to satisfy
@@ -6416,7 +6416,7 @@ Bug fixes:
 - Issue 265 - integrate nose setup/teardown with setupstate
   so it doesn't try to teardown if it did not setup
 
-- issue 271 - don't write junitxml on slave nodes
+- issue 271 - don't write junitxml on worker nodes
 
 - Issue 274 - don't try to show full doctest example
   when doctest does not know the example location
@@ -7298,7 +7298,7 @@ Bug fixes:
 - fix assert reinterpreation that sees a call containing "keyword=..."
 
 - fix issue66: invoke pytest_sessionstart and pytest_sessionfinish
-  hooks on slaves during dist-testing, report module/session teardown
+  hooks on worker nodes during dist-testing, report module/session teardown
   hooks correctly.
 
 - fix issue65: properly handle dist-testing if no
diff --git a/doc/en/funcarg_compare.rst b/doc/en/funcarg_compare.rst
@@ -170,7 +170,7 @@ several problems:
 
 1. in distributed testing the master process would setup test resources
    that are never needed because it only co-ordinates the test run
-   activities of the slave processes.
+   activities of the worker processes.
 
 2. if you only perform a collection (with "--collect-only")
    resource-setup will still be executed.
diff --git a/doc/en/reference.rst b/doc/en/reference.rst
@@ -710,6 +710,7 @@ Session related reporting hooks:
 .. autofunction:: pytest_fixture_setup
 .. autofunction:: pytest_fixture_post_finalizer
 .. autofunction:: pytest_warning_captured
+.. autofunction:: pytest_warning_recorded
 
 Central hook for reporting about test execution:
 
diff --git a/src/_pytest/cacheprovider.py b/src/_pytest/cacheprovider.py
@@ -344,7 +344,7 @@ def pytest_collection_modifyitems(
 
     def pytest_sessionfinish(self, session):
         config = self.config
-        if config.getoption("cacheshow") or hasattr(config, "slaveinput"):
+        if config.getoption("cacheshow") or hasattr(config, "workerinput"):
             return
 
         saved_lastfailed = config.cache.get("cache/lastfailed", {})
@@ -390,7 +390,7 @@ def _get_increasing_order(self, items):
 
     def pytest_sessionfinish(self) -> None:
         config = self.config
-        if config.getoption("cacheshow") or hasattr(config, "slaveinput"):
+        if config.getoption("cacheshow") or hasattr(config, "workerinput"):
             return
         if config.getoption("collectonly"):
             return
diff --git a/src/_pytest/config/__init__.py b/src/_pytest/config/__init__.py
@@ -769,7 +769,7 @@ class InvocationParams:
             Plugins accessing ``InvocationParams`` must be aware of that.
         """
 
-        args = attr.ib(converter=tuple)
+        args = attr.ib(type=Tuple[str, ...], converter=tuple)
         plugins = attr.ib()
         dir = attr.ib(type=Path)
 
diff --git a/src/_pytest/deprecated.py b/src/_pytest/deprecated.py
@@ -49,3 +49,8 @@
     "--no-print-logs is deprecated and scheduled for removal in pytest 6.0.\n"
     "Please use --show-capture instead."
 )
+
+WARNING_CAPTURED_HOOK = PytestDeprecationWarning(
+    "The pytest_warning_captured is deprecated and will be removed in a future release.\n"
+    "Please use pytest_warning_recorded instead."
+)
diff --git a/src/_pytest/fixtures.py b/src/_pytest/fixtures.py
@@ -1022,7 +1022,10 @@ def result(*args, **kwargs):
 @attr.s(frozen=True)
 class FixtureFunctionMarker:
     scope = attr.ib()
-    params = attr.ib(converter=attr.converters.optional(tuple))
+    params = attr.ib(
+        type=Optional[Tuple[object, ...]],
+        converter=attr.converters.optional(tuple),
+    )
     autouse = attr.ib(default=False)
     # Ignore type because of https://github.com/python/mypy/issues/6172.
     ids = attr.ib(default=None, converter=_ensure_immutable_ids)  # type: ignore
diff --git a/src/_pytest/hookspec.py b/src/_pytest/hookspec.py
@@ -6,9 +6,11 @@
 
 from pluggy import HookspecMarker
 
+from .deprecated import WARNING_CAPTURED_HOOK
 from _pytest.compat import TYPE_CHECKING
 
 if TYPE_CHECKING:
+    import warnings
     from typing import List
 
     from _pytest.config import Config
@@ -583,10 +585,12 @@ def pytest_terminal_summary(terminalreporter, exitstatus, config):
     """
 
 
-@hookspec(historic=True)
+@hookspec(historic=True, warn_on_impl=WARNING_CAPTURED_HOOK)
 def pytest_warning_captured(warning_message, when, item, location):
-    """
-    Process a warning captured by the internal pytest warnings plugin.
+    """(**Deprecated**) Process a warning captured by the internal pytest warnings plugin.
+
+    This hook is considered deprecated and will be removed in a future pytest version.
+    Use :func:`pytest_warning_recorded` instead.
 
     :param warnings.WarningMessage warning_message:
         The captured warning. This is the same object produced by :py:func:`warnings.catch_warnings`, and contains
@@ -600,9 +604,6 @@ def pytest_warning_captured(warning_message, when, item, location):
         * ``"runtest"``: during test execution.
 
     :param pytest.Item|None item:
-        **DEPRECATED**: This parameter is incompatible with ``pytest-xdist``, and will always receive ``None``
-        in a future release.
-
         The item being executed if ``when`` is ``"runtest"``, otherwise ``None``.
 
     :param tuple location:
@@ -611,6 +612,35 @@ def pytest_warning_captured(warning_message, when, item, location):
     """
 
 
+@hookspec(historic=True)
+def pytest_warning_recorded(
+    warning_message: "warnings.WarningMessage",
+    when: str,
+    nodeid: str,
+    location: Tuple[str, int, str],
+):
+    """
+    Process a warning captured by the internal pytest warnings plugin.
+
+    :param warnings.WarningMessage warning_message:
+        The captured warning. This is the same object produced by :py:func:`warnings.catch_warnings`, and contains
+        the same attributes as the parameters of :py:func:`warnings.showwarning`.
+
+    :param str when:
+        Indicates when the warning was captured. Possible values:
+
+        * ``"config"``: during pytest configuration/initialization stage.
+        * ``"collect"``: during test collection.
+        * ``"runtest"``: during test execution.
+
+    :param str nodeid: full id of the item
+
+    :param tuple location:
+        Holds information about the execution context of the captured warning (filename, linenumber, function).
+        ``function`` evaluates to <module> when the execution context is at the module level.
+    """
+
+
 # -------------------------------------------------------------------------
 # doctest hooks
 # -------------------------------------------------------------------------
diff --git a/src/_pytest/junitxml.py b/src/_pytest/junitxml.py
@@ -406,8 +406,8 @@ def pytest_addoption(parser):
 
 def pytest_configure(config):
     xmlpath = config.option.xmlpath
-    # prevent opening xmllog on slave nodes (xdist)
-    if xmlpath and not hasattr(config, "slaveinput"):
+    # prevent opening xmllog on worker nodes (xdist)
+    if xmlpath and not hasattr(config, "workerinput"):
         junit_family = config.getini("junit_family")
         if not junit_family:
             _issue_warning_captured(deprecated.JUNIT_XML_DEFAULT_FAMILY, config.hook, 2)
@@ -481,17 +481,17 @@ def __init__(
     def finalize(self, report):
         nodeid = getattr(report, "nodeid", report)
         # local hack to handle xdist report order
-        slavenode = getattr(report, "node", None)
-        reporter = self.node_reporters.pop((nodeid, slavenode))
+        workernode = getattr(report, "node", None)
+        reporter = self.node_reporters.pop((nodeid, workernode))
         if reporter is not None:
             reporter.finalize()
 
     def node_reporter(self, report):
         nodeid = getattr(report, "nodeid", report)
         # local hack to handle xdist report order
-        slavenode = getattr(report, "node", None)
+        workernode = getattr(report, "node", None)
 
-        key = nodeid, slavenode
+        key = nodeid, workernode
 
         if key in self.node_reporters:
             # TODO: breaks for --dist=each
diff --git a/src/_pytest/pastebin.py b/src/_pytest/pastebin.py
@@ -22,7 +22,7 @@ def pytest_configure(config):
     if config.option.pastebin == "all":
         tr = config.pluginmanager.getplugin("terminalreporter")
         # if no terminal reporter plugin is present, nothing we can do here;
-        # this can happen when this function executes in a slave node
+        # this can happen when this function executes in a worker node
         # when using pytest-xdist, for example
         if tr is not None:
             # pastebin file will be utf-8 encoded binary file
diff --git a/src/_pytest/reports.py b/src/_pytest/reports.py
@@ -26,13 +26,13 @@
 from _pytest.pathlib import Path
 
 
-def getslaveinfoline(node):
+def getworkerinfoline(node):
     try:
-        return node._slaveinfocache
+        return node._workerinfocache
     except AttributeError:
-        d = node.slaveinfo
+        d = node.workerinfo
         ver = "%s.%s.%s" % d["version_info"][:3]
-        node._slaveinfocache = s = "[{}] {} -- Python {} {}".format(
+        node._workerinfocache = s = "[{}] {} -- Python {} {}".format(
             d["id"], d["sysplatform"], ver, d["executable"]
         )
         return s
@@ -55,7 +55,7 @@ def __getattr__(self, key: str) -> Any:
 
     def toterminal(self, out) -> None:
         if hasattr(self, "node"):
-            out.line(getslaveinfoline(self.node))
+            out.line(getworkerinfoline(self.node))
 
         longrepr = self.longrepr
         if longrepr is None:
diff --git a/src/_pytest/resultlog.py b/src/_pytest/resultlog.py
@@ -20,8 +20,8 @@ def pytest_addoption(parser):
 
 def pytest_configure(config):
     resultlog = config.option.resultlog
-    # prevent opening resultlog on slave nodes (xdist)
-    if resultlog and not hasattr(config, "slaveinput"):
+    # prevent opening resultlog on worker nodes (xdist)
+    if resultlog and not hasattr(config, "workerinput"):
         dirname = os.path.dirname(os.path.abspath(resultlog))
         if not os.path.isdir(dirname):
             os.makedirs(dirname)
diff --git a/src/_pytest/terminal.py b/src/_pytest/terminal.py
@@ -347,7 +347,7 @@ def pytest_report_teststatus(report: TestReport) -> Tuple[str, str, str]:
 @attr.s
 class WarningReport:
     """Holds information for warnings captured by
-    :func:`TerminalReporter.pytest_warning_captured`."""
+    :func:`TerminalReporter.pytest_warning_recorded`."""
 
     warning = attr.ib(type=warnings.WarningMessage)
     """The original warning."""
@@ -533,11 +533,10 @@ def pytest_internalerror(self, excrepr):
             self.write_line("INTERNALERROR> " + line)
         return 1
 
-    def pytest_warning_captured(
-        self, when: str, warning_message: "warnings.WarningMessage", item: "nodes.Item"
+    def pytest_warning_recorded(
+        self, when: str, warning_message: "warnings.WarningMessage", nodeid: str
     ) -> None:
         fslocation = warning_message.filename, warning_message.lineno
-        nodeid = item.nodeid if item is not None else ""
         warning_report = WarningReport(
             warning=warning_message, fslocation=fslocation, nodeid=nodeid, when=when
         )
diff --git a/src/_pytest/warnings.py b/src/_pytest/warnings.py
@@ -63,7 +63,7 @@ def catch_warnings_for_item(config, ihook, when, item):
 
     ``item`` can be None if we are not in the context of an item execution.
 
-    Each warning captured triggers the ``pytest_warning_captured`` hook.
+    Each warning captured triggers the ``pytest_warning_recorded`` hook.
     """
     cmdline_filters = config.getoption("pythonwarnings") or []
     inifilters = config.getini("filterwarnings")
@@ -84,6 +84,7 @@ def catch_warnings_for_item(config, ihook, when, item):
         for arg in cmdline_filters:
             warnings._setoption(arg)
 
+        nodeid = "" if item is None else item.nodeid
         if item is not None:
             for mark in item.iter_markers(name="filterwarnings"):
                 for arg in mark.args:
@@ -95,6 +96,14 @@ def catch_warnings_for_item(config, ihook, when, item):
             ihook.pytest_warning_captured.call_historic(
                 kwargs=dict(warning_message=warning_message, when=when, item=item)
             )
+            ihook.pytest_warning_recorded.call_historic(
+                kwargs=dict(
+                    warning_message=warning_message,
+                    nodeid=nodeid,
+                    when=when,
+                    location=None,
+                )
+            )
 
 
 @pytest.hookimpl(hookwrapper=True, tryfirst=True)
@@ -135,7 +144,7 @@ def pytest_sessionfinish(session):
 def _issue_warning_captured(warning, hook, stacklevel):
     """
     This function should be used instead of calling ``warnings.warn`` directly when we are in the "configure" stage:
-    at this point the actual options might not have been set, so we manually trigger the pytest_warning_captured
+    at this point the actual options might not have been set, so we manually trigger the pytest_warning_recorded
     hook so we can display these warnings in the terminal. This is a hack until we can sort out #2891.
 
     :param warning: the warning instance.
@@ -154,3 +163,8 @@ def _issue_warning_captured(warning, hook, stacklevel):
             warning_message=records[0], when="config", item=None, location=location
         )
     )
+    hook.pytest_warning_recorded.call_historic(
+        kwargs=dict(
+            warning_message=records[0], when="config", nodeid="", location=location
+        )
+    )
diff --git a/testing/test_junitxml.py b/testing/test_junitxml.py
diff --git a/testing/test_resultlog.py b/testing/test_resultlog.py
diff --git a/testing/test_warnings.py b/testing/test_warnings.py

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+Introduced a new hook named `pytest_warning_recorded` to convey information about warnings captured by the internal `pytest` warnings plugin.
	`2`	`+`
	`3`	+This hook is meant to replace `pytest_warning_captured`, which will be removed in a future release.
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+Remove last internal uses of deprecated "slave" term from old pytest-xdist.`