Merge pull request #25 from ansible-network/fixes

A bunch of assorted fixes to make pre-commit happy

Author: NilashishC

.pre-commit-config.yaml

@@ -1,24 +1,24 @@
 ---
 default_language_version:
   # ensures that we get same behavior on CI(s) as on local machines
-  python: python3.10
+  python: python3.11
 repos:
   - repo: https://github.com/asottile/add-trailing-comma.git
-    rev: v2.2.2
+    rev: v3.1.0
     hooks:
       - id: add-trailing-comma
         args:
           - --py36-plus
         stages: ["manual"]
 
   - repo: https://github.com/PyCQA/isort
-    rev: 5.10.1
+    rev: 5.13.2
     hooks:
       - id: isort
         name: Sort import statements using isort
 
   - repo: https://github.com/pre-commit/mirrors-prettier
-    rev: "v2.6.2"
+    rev: v4.0.0-alpha.8
     hooks:
       - id: prettier
         # Original hook implementation is flaky due to *several* bugs described
@@ -45,24 +45,24 @@ repos:
           - prettier-plugin-toml
 
   - repo: https://github.com/psf/black.git
-    rev: 22.3.0
+    rev: 24.3.0
     hooks:
       - id: black
         language_version: python3
 
   - repo: https://github.com/streetsidesoftware/cspell-cli
-    rev: v5.9.1
+    rev: v8.6.1
     hooks:
       - id: cspell
         name: Spell check with cspell
 
   - repo: https://github.com/Lucas-C/pre-commit-hooks.git
-    rev: v1.1.13
+    rev: v1.5.5
     hooks:
       - id: remove-tabs
 
   - repo: https://github.com/pre-commit/pre-commit-hooks.git
-    rev: v4.2.0
+    rev: v4.5.0
     hooks:
       # Side-effects:
       - id: trailing-whitespace
@@ -82,46 +82,46 @@ repos:
       - id: debug-statements
 
   - repo: https://github.com/codespell-project/codespell
-    rev: v2.1.0
+    rev: v2.2.6
     hooks:
       - id: codespell
 
   - repo: https://github.com/adrienverge/yamllint.git
-    rev: v1.26.3
+    rev: v1.35.1
     hooks:
       - id: yamllint
         args:
           - --strict
         types: [file, yaml]
 
   - repo: https://github.com/PyCQA/flake8.git
-    rev: 4.0.1
+    rev: 5.0.4
     hooks:
       - id: flake8
         alias: flake8
-        language_version: python3
+        language_version: python311
         additional_dependencies:
           - flake8-2020 >= 1.6.0
           - flake8-isort >= 4.1.1
           - darglint
           - flake8-docstrings # uses pydocstyle
 
   - repo: https://github.com/pre-commit/mirrors-mypy.git
-    rev: v0.942
+    rev: v1.9.0
     hooks:
       - id: mypy
-        alias: mypy-py310
-        name: MyPy, for Python 3.10
+        alias: mypy-py311
+        name: MyPy, for Python 3.11
         additional_dependencies:
           - ansible-pylibssh
           - pytest
           - xmltodict
         args:
-          - --python-version=3.10
+          - --python-version=3.11
         pass_filenames: false
 
   - repo: https://github.com/pycqa/pylint.git
-    rev: v2.13.5
+    rev: v3.1.0
     hooks:
       - id: pylint
         args:

src/pytest_ansible_network_integration/__init__.py

@@ -1,5 +1,6 @@
 # cspell:ignore nodeid
 """Common fixtures for tests."""
+
 import json
 import logging
 import os
@@ -18,6 +19,7 @@
 
 from .defs import AnsibleProject
 from .defs import CmlWrapper
+from .defs import PytestNetworkError
 from .defs import VirshWrapper
 
 
@@ -91,11 +93,11 @@ def pytest_generate_tests(metafunc: pytest.Metafunc) -> None:
     """Generate tests.
 
     :param metafunc: The pytest metafunc object
-    :raises Exception: If the options have not been set
+    :raises PytestNetworkError: If the options have not been set
     """
     if "integration_test_path" in metafunc.fixturenames:
         if not OPTIONS:
-            raise Exception("pytest_configure not called")
+            raise PytestNetworkError("pytest_configure not called")
         rootdir = Path(OPTIONS.integration_tests_path)
         roles = [path for path in Path(rootdir).iterdir() if path.is_dir()]
         # test_ids = [role.name for role in roles]
@@ -179,7 +181,7 @@ def playbook(hosts: str, role: str) -> List[Dict[str, object]]:
 def required_environment_variables() -> Dict[str, str]:
     """Return the required environment variables.
 
-    :raises Exception: If the environment variables are not set
+    :raises PytestNetworkError: If the environment variables are not set
     :returns: The required environment variables
     """
     variables = {
@@ -192,7 +194,7 @@ def required_environment_variables() -> Dict[str, str]:
         "network_os": os.environ.get("ANSIBLE_NETWORK_OS"),
     }
     if not all(variables.values()):
-        raise Exception("CML environment variables not set")
+        raise PytestNetworkError("CML environment variables not set")
 
     return variables  # type: ignore[return-value]
 
@@ -221,20 +223,19 @@ def _appliance_dhcp_address(env_vars: Dict[str, str]) -> Generator[str, None, No
     """Build the lab and collect the appliance DHCP address.
 
     :param env_vars: The environment variables
-    :raises Exception: Missing environment variables, lab, or appliance
+    :raises PytestNetworkError: Missing environment variables, lab, or appliance
     :yields: The appliance DHCP address
     """
     _github_action_log("::group::Starting lab provisioning")
 
     _print("Starting lab provisioning")
 
     try:
-
         if not OPTIONS:
-            raise Exception("Missing CML lab")
+            raise PytestNetworkError("Missing CML lab")
         lab_file = OPTIONS.cml_lab
         if not os.path.exists(lab_file):
-            raise Exception(f"Missing lab file '{lab_file}'")
+            raise PytestNetworkError(f"Missing lab file '{lab_file}'")
 
         start = time.time()
         cml = CmlWrapper(
@@ -254,18 +255,18 @@ def _appliance_dhcp_address(env_vars: Dict[str, str]) -> Generator[str, None, No
 
         try:
             ip_address = virsh.get_dhcp_lease(lab_id)
-        except Exception as exc:
+        except PytestNetworkError as exc:
             virsh.close()
             cml.remove()
-            raise Exception("Failed to get DHCP lease for the appliance") from exc
+            raise PytestNetworkError("Failed to get DHCP lease for the appliance") from exc
 
         end = time.time()
         _print(f"Elapsed time to provision {end - start} seconds")
 
-    except Exception as exc:
+    except PytestNetworkError as exc:
         logger.error("Failed to provision lab")
         _github_action_log("::endgroup::")
-        raise Exception("Failed to provision lab") from exc
+        raise PytestNetworkError("Failed to provision lab") from exc
 
     virsh.close()
     _github_action_log("::endgroup::")
@@ -344,10 +345,10 @@ def environment() -> Dict[str, Any]:
     return env
 
 
-@pytest.hookimpl(tryfirst=True, hookwrapper=True)  # type: ignore[misc]
+@pytest.hookimpl(tryfirst=True, hookwrapper=True)
 def pytest_runtest_makereport(
     item: pytest.Item, *_args: Any, **_kwargs: Any
-) -> Generator[None, pluggy_result, None]:
+) -> Generator[None, pluggy_result, None]:  # type: ignore[type-arg]
     """Add additional information to the test item.
 
     :param item: The test item

src/pytest_ansible_network_integration/defs.py

@@ -1,4 +1,7 @@
 """Common objects."""
+
+from __future__ import annotations
+
 import logging
 import os
 import re
@@ -123,7 +126,7 @@ def bring_up(self, file: str) -> None:
         """Bring the lab up.
 
         :param file: The file
-        :raises Exception: If the lab fails to start
+        :raises PytestNetworkError: If the lab fails to start
         """
         logger.info("Check if lab is already provisioned")
         stdout, _stderr = self._run("id")
@@ -142,7 +145,7 @@ def bring_up(self, file: str) -> None:
         # Starting lab xxx (ID: 9fde5f)\n
         current_lab_match = re.match(r".*ID: (?P<id>\S+)\)\n", stdout, re.DOTALL)
         if not current_lab_match:
-            raise Exception(f"Could not get lab ID: {stdout} {stderr}")
+            raise PytestNetworkError(f"Could not get lab ID: {stdout} {stderr}")
         self.current_lab_id = current_lab_match.groupdict()["id"]
         logger.info("Started lab id '%s'", self.current_lab_id)
 
@@ -222,7 +225,7 @@ def get_dhcp_lease(self, current_lab_id: str) -> str:
         """Get the dhcp lease.
 
         :param current_lab_id: The current lab id
-        :raises Exception: If the dhcp lease cannot be found
+        :raises PytestNetworkError: If the dhcp lease cannot be found
         :return: The ip address
         """
         attempt = 0
@@ -248,7 +251,7 @@ def get_dhcp_lease(self, current_lab_id: str) -> str:
                 break
             attempt += 1
             if attempt == 10:
-                raise Exception("Could not find current lab")
+                raise PytestNetworkError("Could not find current lab")
             time.sleep(5)
 
         macs = [
@@ -272,16 +275,27 @@ def get_dhcp_lease(self, current_lab_id: str) -> str:
             ips = [leases[mac] for mac in macs if mac in leases]
             attempt += 1
             if attempt == 30:
-                raise Exception("Could not find IPs")
+                raise PytestNetworkError("Could not find IPs")
             time.sleep(10)
 
         logger.debug("Found IPs: %s", ips)
 
         if len(ips) > 1:
-            raise Exception("Found more than one IP")
+            raise PytestNetworkError("Found more than one IP")
 
         return ips[0]
 
     def close(self) -> None:
         """Close the connection."""
         self.ssh.close()
+
+
+class PytestNetworkError(Exception):
+    """Class representing exceptions raised from the pytest plugin code."""
+
+    def __init__(self: PytestNetworkError, message: str) -> None:
+        """Instantiate an object of this class.
+
+        :param message: The exception message.
+        """
+        super().__init__(message)