Merge branch 'main' into ip_module

costasd · web-flow · commit a1aa1056b917 · 2023-08-31T11:20:40.000+02:00
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -2,6 +2,16 @@
 Changelog
 =========
 
+9.0.0
+=====
+
+* [BREAKING] pytest-testinfra now require python >= 3.9
+* [BREAKING] Drop deprecated module PipPackage
+* [NEW] Add support for the SSH ControlPath connection sharing option (#713)
+* [FIX] Retry SSH on ConnectionResetError (#708)
+* [FIX] List openSUSE Leap and Tumbleweed explicitly as rpm based distributions
+* [FIX] Make group name mandatory in group module
+
 8.1.0
 =====
 
diff --git a/dev-requirements.txt b/dev-requirements.txt
@@ -1,3 +1,3 @@
-sphinx>=1.3
+sphinx>=7.1,<7.2
 alabaster>=0.7.2
 .
diff --git a/doc/source/modules.rst b/doc/source/modules.rst
@@ -70,10 +70,6 @@ host
 
        :class:`testinfra.modules.pip.Pip` class
 
-    .. attribute:: pip_package
-
-       :class:`testinfra.modules.pip.PipPackage` class
-
     .. attribute:: podman
 
        :class:`testinfra.modules.podman.Podman` class
@@ -215,12 +211,6 @@ Pip
    :members:
 
 
-PipPackage
-~~~~~~~~~~
-
-.. autoclass:: testinfra.modules.pip.PipPackage
-
-
 Podman
 ~~~~~~
 
diff --git a/setup.cfg b/setup.cfg
@@ -6,7 +6,7 @@ long_description = file:README.rst
 long_description_content_type = text/x-rst
 author = Philippe Pepiot
 author_email = phil@philpep.org
-license_file = LICENSE
+license_files = LICENSE
 classifiers =
     Development Status :: 5 - Production/Stable
     Environment :: Console
diff --git a/test/test_backends.py b/test/test_backends.py
@@ -183,14 +183,14 @@ def get_vars(host):
             "c": "d",
             "x": "z",
             "inventory_hostname": "debian",
-            "group_names": ["g"],
+            "group_names": ["all", "g"],
             "groups": groups,
         }
         assert get_vars("rockylinux") == {
             "a": "a",
             "e": "f",
             "inventory_hostname": "rockylinux",
-            "group_names": ["ungrouped"],
+            "group_names": ["all", "ungrouped"],
             "groups": groups,
         }
 
diff --git a/test/test_modules.py b/test/test_modules.py
@@ -348,7 +348,7 @@ def test_ansible_module(host):
     assert variables["myhostvar"] == "bar"
     assert variables["mygroupvar"] == "qux"
     assert variables["inventory_hostname"] == "debian_bookworm"
-    assert variables["group_names"] == ["testgroup"]
+    assert variables["group_names"] == ["all", "testgroup"]
     assert variables["groups"] == {
         "all": ["debian_bookworm"],
         "testgroup": ["debian_bookworm"],
diff --git a/testinfra/backend/paramiko.py b/testinfra/backend/paramiko.py
@@ -148,7 +148,7 @@ def run(self, command: str, *args: str, **kwargs: Any) -> base.CommandResult:
         cmd = self.encode(command)
         try:
             rc, stdout, stderr = self._exec_command(cmd)
-        except paramiko.ssh_exception.SSHException:
+        except (paramiko.ssh_exception.SSHException, ConnectionResetError):
             transport = self.client.get_transport()
             assert transport is not None
             if not transport.is_active():
diff --git a/testinfra/backend/ssh.py b/testinfra/backend/ssh.py
@@ -27,6 +27,7 @@ def __init__(
         ssh_config: Optional[str] = None,
         ssh_identity_file: Optional[str] = None,
         timeout: int = 10,
+        controlpath: str = "",
         controlpersist: int = 60,
         ssh_extra_args: Optional[str] = None,
         *args: Any,
@@ -36,6 +37,7 @@ def __init__(
         self.ssh_config = ssh_config
         self.ssh_identity_file = ssh_identity_file
         self.timeout = int(timeout)
+        self.controlpath = controlpath
         self.controlpersist = int(controlpersist)
         self.ssh_extra_args = ssh_extra_args
         super().__init__(self.host.name, *args, **kwargs)
@@ -75,6 +77,12 @@ def _build_ssh_command(self, command: str) -> tuple[list[str], list[str]]:
                     self.controlpersist
                 )
             )
+        if (
+            "ControlMaster" in " ".join(cmd)
+            and self.controlpath
+            and ("controlpath" not in (self.ssh_extra_args or "").lower())
+        ):
+            cmd.append("-o ControlPath={}".format(self.controlpath))
         cmd.append("%s %s")
         cmd_args.extend([self.host.name, command])
         return cmd, cmd_args
diff --git a/testinfra/modules/__init__.py b/testinfra/modules/__init__.py
@@ -31,7 +31,6 @@
     "mount_point": "mountpoint:MountPoint",
     "package": "package:Package",
     "pip": "pip:Pip",
-    "pip_package": "pip:PipPackage",
     "process": "process:Process",
     "puppet_resource": "puppet:PuppetResource",
     "facter": "puppet:Facter",
diff --git a/testinfra/modules/package.py b/testinfra/modules/package.py
@@ -77,6 +77,8 @@ def get_module_class(cls, host):
                 "centos",
                 "cloudlinux",
                 "fedora",
+                "opensuse-leap",
+                "opensuse-tumbleweed",
                 "rocky",
             )
         ):
diff --git a/testinfra/modules/pip.py b/testinfra/modules/pip.py
@@ -12,7 +12,6 @@
 
 import json
 import re
-import warnings
 
 from testinfra.modules.base import Module
 
@@ -58,7 +57,7 @@ def version(self):
     def check(cls, pip_path="pip"):
         """Verify installed packages have compatible dependencies.
 
-        >>> cmd = host.pip_package.check()
+        >>> cmd = host.pip.check()
         >>> cmd.rc
         0
         >>> cmd.stdout
@@ -76,7 +75,7 @@ def check(cls, pip_path="pip"):
     def get_packages(cls, pip_path="pip"):
         """Get all installed packages and versions returned by `pip list`:
 
-        >>> host.pip_package.get_packages(pip_path='~/venv/website/bin/pip')
+        >>> host.pip.get_packages(pip_path='~/venv/website/bin/pip')
         {'Django': {'version': '1.10.2'},
          'mywebsite': {'version': '1.0a3', 'path': '/srv/website'},
          'psycopg2': {'version': '2.6.2'}}
@@ -106,7 +105,7 @@ def get_packages(cls, pip_path="pip"):
     def get_outdated_packages(cls, pip_path="pip"):
         """Get all outdated packages with current and latest version
 
-        >>> host.pip_package.get_outdated_packages(
+        >>> host.pip.get_outdated_packages(
         ...     pip_path='~/venv/website/bin/pip')
         {'Django': {'current': '1.10.2', 'latest': '1.10.3'}}
         """
@@ -134,34 +133,3 @@ def get_outdated_packages(cls, pip_path="pip"):
                 name, current, latest = _re_match(line, output_re)
                 pkgs[name] = {"current": current, "latest": latest}
         return pkgs
-
-
-class PipPackage(Pip):
-    """.. deprecated:: 6.2
-
-    Use :class:`~testinfra.modules.pip.Pip` instead.
-    """
-
-    @staticmethod
-    def _deprecated():
-        """Raise a `DeprecationWarning`"""
-        warnings.warn(
-            "Calling host.pip_package is deprecated, call host.pip instead",
-            category=DeprecationWarning,
-            stacklevel=2,
-        )
-
-    @classmethod
-    def check(cls, pip_path="pip"):
-        PipPackage._deprecated()
-        return super().check(pip_path=pip_path)
-
-    @classmethod
-    def get_packages(cls, pip_path="pip"):
-        PipPackage._deprecated()
-        return super().get_packages(pip_path=pip_path)
-
-    @classmethod
-    def get_outdated_packages(cls, pip_path="pip"):
-        PipPackage._deprecated()
-        return super().get_outdated_packages(pip_path=pip_path)
diff --git a/testinfra/modules/systeminfo.py b/testinfra/modules/systeminfo.py
@@ -50,21 +50,6 @@ def sysinfo(self):
     def _get_linux_sysinfo(self):
         sysinfo = {}
 
-        # LSB
-        lsb = self.run("lsb_release -a")
-        if lsb.rc == 0:
-            for line in lsb.stdout.splitlines():
-                key, value = line.split(":", 1)
-                key = key.strip().lower()
-                value = value.strip().lower()
-                if key == "distributor id":
-                    sysinfo["distribution"] = value
-                elif key == "release":
-                    sysinfo["release"] = value
-                elif key == "codename":
-                    sysinfo["codename"] = value
-            return sysinfo
-
         # https://www.freedesktop.org/software/systemd/man/os-release.html
         os_release = self.run("cat /etc/os-release")
         if os_release.rc == 0:
@@ -100,6 +85,21 @@ def _get_linux_sysinfo(self):
             sysinfo["release"] = alpine_release.stdout.strip()
             return sysinfo
 
+        # LSB
+        lsb = self.run("lsb_release -a")
+        if lsb.rc == 0:
+            for line in lsb.stdout.splitlines():
+                key, value = line.split(":", 1)
+                key = key.strip().lower()
+                value = value.strip().lower()
+                if key == "distributor id":
+                    sysinfo["distribution"] = value
+                elif key == "release":
+                    sysinfo["release"] = value
+                elif key == "codename":
+                    sysinfo["codename"] = value
+            return sysinfo
+
         return sysinfo
 
     def _get_darwin_sysinfo(self):
diff --git a/testinfra/utils/ansible_runner.py b/testinfra/utils/ansible_runner.py
@@ -185,6 +185,16 @@ def get_config(
         ]
     ).strip()
 
+    control_path = config.get("ssh_connection", "control_path", fallback="", raw=True)
+    if control_path:
+        directory = config.get(
+            "persistent_connection", "control_path_dir", fallback="~/.ansible/cp"
+        )
+        control_path = control_path % ({"directory": directory})  # noqa: S001
+        # restore original "%%"
+        control_path = control_path.replace("%", "%%")
+        kwargs["controlpath"] = control_path
+
     spec = "{}://".format(connection)
 
     # Fallback to user:password auth when identity file is not used
@@ -301,12 +311,14 @@ def get_variables(self, host: str) -> dict[str, Any]:
         hostvars.setdefault("inventory_hostname", host)
         group_names = []
         groups = {}
+
         for group in sorted(inventory):
             if group == "_meta":
                 continue
             groups[group] = sorted(itergroup(inventory, group))
-            if group != "all" and host in inventory[group].get("hosts", []):
+            if host in groups[group]:
                 group_names.append(group)
+
         hostvars.setdefault("group_names", group_names)
         hostvars.setdefault("groups", groups)
         return hostvars
@@ -383,9 +395,7 @@ def run_module(
                     "msg": "Skipped. You might want to try check=False",
                 }
             if not files:
-                raise RuntimeError(
-                    "Error while running {}: {}".format(" ".join(cmd), out)
-                )
+                raise RuntimeError(f"{out}")
             fpath = os.path.join(d, files[0])
             try:
                 with open(fpath, "r", encoding="ascii") as f:

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,3 @@`
`1`		`-sphinx>=1.3`
	`1`	`+sphinx>=7.1,<7.2`
`2`	`2`	`alabaster>=0.7.2`
`3`	`3`	`.`
Original file line number	Diff line number	Diff line change
`@@ -77,6 +77,8 @@ def get_module_class(cls, host):`
`77`	`77`	`"centos",`
`78`	`78`	`"cloudlinux",`
`79`	`79`	`"fedora",`
	`80`	`+ "opensuse-leap",`
	`81`	`+ "opensuse-tumbleweed",`
`80`	`82`	`"rocky",`
`81`	`83`	`)`
`82`	`84`	`):`