Merge pull request #23 from romecode/main

add min_version and min_change_number

Author: romecode

README.md

@@ -1,9 +1,9 @@
 Netdut: automated software testing for switches using pytest
 ============================================================
 
-![PyPi](https://img.shields.io/pypi/v/pytest-netdut.svg) 
+![PyPi](https://img.shields.io/pypi/v/pytest-netdut.svg)
 ![Python Versions](https://img.shields.io/pypi/pyversions/pytest-netdut.svg)
-![collection version](https://img.shields.io/github/v/release/aristanetworks/pytest-netdut) 
+![collection version](https://img.shields.io/github/v/release/aristanetworks/pytest-netdut)
 ![License](https://img.shields.io/github/license/aristanetworks/pytest-netdut)
 
 Netdut is a [pytest](https://docs.pytest.org/) plugin which provides infrastructure (e.g. pytest fixtures) which make it easy to write automated tests for network switches.
@@ -13,8 +13,8 @@ Features
 --------
 
 * Brings the power, maturity and ecosystem of pytest to testing on network switches.
-* The `dut` fixture (Device Under Test) providing serial, ssh or [EAPI](https://github.com/arista-eosplus/pyeapi) connectivity for running CLI commands on a network switch. 
-* Command-line configuration of a hostname and console name. 
+* The `dut` fixture (Device Under Test) providing serial, ssh or [EAPI](https://github.com/arista-eosplus/pyeapi) connectivity for running CLI commands on a network switch.
+* Command-line configuration of a hostname and console name.
 * Markers for skipping tests based on the device's type or software configuration.
 * Compatibility with both Arista's EOS operating system, and the Metamako MOS operating system.
 * A pythonic interfaces for writing EOS CLI commands.
@@ -156,6 +156,18 @@ def test_that_only_runs_on_eos_on_7130(dut):
     logging.info("Must be EOS on 7130!")
 ```
 
+OS decorators accept the following keywords:
+ - min_version (string)
+ - min_change_number (int)
+
+If both kwargs are specified, min_change_number takes precedence.
+```python
+@pytest.mark.eos(min_version="4.30.0", min_change_number=3452345)
+@pytest.mark.skip_device_type("DCS-7130.*")
+def test_that_only_runs_on_eos_on_7130(dut):
+    logging.info("Must be EOS on 7130!")
+```
+
 ### Building test harnesses
 
 Pytest's fixture mechanism is very powerful in this scenario, allowing us to set up and tear
@@ -216,7 +228,7 @@ to snake_case.
 The translator has a predefined set of translations which can be extended by subclassing the Translator class and overriding `config_patterns`.
 Return values are processed by the `translate_key` function which must be defined in the subclass.
 
-Set the new translator class via `eapi.set_translator(<class instance>)`. 
+Set the new translator class via `eapi.set_translator(<class instance>)`.
 
 Contributing
 ------------

setup.cfg

@@ -41,6 +41,7 @@ install_requires =
     pyeapi>=0.8.4
     pytest>=3.5.0
     six>=1.15
+    packaging>=22.0
 
 [options.packages.find]
 where=src

src/pytest_netdut/__init__.py

@@ -144,6 +144,7 @@ def create(name) -> Callable:
         factories.create_console_url_fixture(name),
         factories.create_skipper_fixture(name),
         factories.create_sku_fixture(name),
+        factories.create_os_version_fixture(name),
         factories.create_softened_fixture(name),
         factories.create_ssh_fixture(name),
         factories.create_xapi_fixture(name),

src/pytest_netdut/factories.py

@@ -17,6 +17,7 @@
 import logging
 import re
 import pytest
+from packaging import version
 from .wrappers import CLI, xapi
 
 logger = logging.getLogger(__name__)
@@ -72,16 +73,46 @@ def _console_url(request):
     return _console_url
 
 
+def parse_version(v):
+    """Return series of dot separated digits from beginning of string
+    as release and the last group delimited by - as change number."""
+    _regex = r"""
+        (?P<release>[0-9]+(?:\.[0-9]+)*)
+        (?:
+            [-]?
+            (?P<change_number>[\w]+)
+        )*
+    """
+    _regex = re.compile(_regex, re.VERBOSE)
+    # _regex = r"(?P<release>[\d\.]*)"
+    parsed = re.match(_regex, v)
+    return (parsed.group("release"), parsed.group("change_number"))
+
+
+def version_skipper(found, expected):
+    try:
+        found = version.Version(str(found))
+        expected = version.Version(str(expected))
+        if found < expected:
+            pytest.skip(f"min_version {expected} not satisfied: {found}")
+    except version.InvalidVersion:
+        logging.error("Could not parse versions: %s < %s", found, expected)
+
+
 def create_skipper_fixture(name):
     @pytest.fixture(scope="session", name=f"{name}_skipper")
     def _skipper(request):
         def skipper(node):
             allowed_os = set()
+            min_version = None
+            min_chg_num = None
 
             # Restrict SKUs
             for marker in node.iter_markers():
                 if marker.name in {"mos", "eos"}:
                     allowed_os.add(marker.name)
+                    min_chg_num = marker.kwargs.get("min_change_number", None)
+                    min_version = marker.kwargs.get("min_version", None)
 
                 elif marker.name == "only_device_type":
                     pattern = marker.args[0]
@@ -97,8 +128,16 @@ def skipper(node):
 
             if allowed_os:
                 dut_ssh = request.getfixturevalue(f"{name}_ssh")
+                dut_os_version = request.getfixturevalue(f"{name}_os_version")
                 if dut_ssh.cli_flavor not in allowed_os:
-                    pytest.skip(f"cannot run on platform {dut_ssh.cli_flavor}")
+                    pytest.skip(f"Cannot run on platform {dut_ssh.cli_flavor}")
+                if min_version or min_chg_num:
+                    # matches the pattern X.XX.X.XX with digits only
+                    release, change_number = parse_version(dut_os_version)
+                    if min_chg_num:
+                        version_skipper(change_number, min_chg_num)
+                    else:
+                        version_skipper(release, min_version)
 
         return skipper
 
@@ -118,6 +157,19 @@ def _sku(request):
     return _sku
 
 
+def create_os_version_fixture(name):
+    @pytest.fixture(scope="session", name=f"{name}_os_version")
+    def _os_version(request):
+        ssh = request.getfixturevalue(f"{name}_ssh")
+        assert ssh.cli_flavor in {"eos", "mos"}
+        output = ssh.sendcmd("show version", timeout=300)
+        matcher = re.search(r"Software image version: (\S*)", output)
+        logging.info("Got OS version: %s", matcher.group(1))
+        yield matcher.group(1)
+
+    return _os_version
+
+
 def create_softened_fixture(name):
     @pytest.fixture(scope="session", name=f"{name}_softened")
     def _softened(dut_ssh):