Merge pull request #113 from network-unit-testing-system/111-support-regex-for-interfaces-in-vrf

add regex

Author: marcom4rtinez

docs/source/testbundles/alltestbundles.rst

@@ -408,7 +408,7 @@ Network Instances
         - host: <host name, required>
           network_instance: <VRF name, required>
           interfaces:
-            - <interface name>
+            - <interface name, regex allowed>
           route_distinguisher: "<number>:<number>"
 
 Required fields for specific tests in this bundle:
@@ -429,6 +429,7 @@ Required fields for specific tests in this bundle:
           interfaces:
             - GigabitEthernet2
             - GigabitEthernet3
+            - GigabitEthernet\d{1}
             - Loopback0
           route_distinguisher: "1:1"
 

nuts/base_tests/napalm_network_instances.py

@@ -1,5 +1,7 @@
 """Query network instances of a device."""
 
+import copy
+import re
 from typing import Dict, List, Callable, Any
 
 import pytest
@@ -50,7 +52,21 @@ def test_network_instance_exists(self, single_result, network_instance):
     def test_network_instance_contains_interfaces(
         self, single_result: NutsResult, network_instance: str, interfaces: List[str]
     ) -> None:
-        assert single_result.result[network_instance]["interfaces"] == interfaces
+        result = copy.deepcopy(single_result.result[network_instance]["interfaces"])
+        patterns = len(interfaces)
+        matches = 0
+        for interface in interfaces:
+            pattern = re.compile(interface)
+            for i in result:
+                if pattern.match(i):
+                    single_result.result[network_instance]["interfaces"].remove(i)
+            if len(result) != len(single_result.result[network_instance]["interfaces"]):
+                result = copy.deepcopy(
+                    single_result.result[network_instance]["interfaces"]
+                )
+                matches += 1
+        assert patterns == matches
+        assert result == []
 
     @pytest.mark.nuts("network_instance,route_distinguisher")
     def test_route_distinguisher(

tests/base_tests/test_napalm_network_instances.py

@@ -1,3 +1,5 @@
+import copy
+import re
 import pytest
 from nornir.core.task import AggregatedResult
 from nornir_napalm.plugins import tasks
@@ -137,6 +139,34 @@
     },
 )
 
+r2_default_range = SelfTestData(
+    name="r2_default",
+    nornir_raw_result=nornir_raw_result_r2,
+    test_data={
+        "host": "R2",
+        "network_instance": "default",
+        "interfaces": [
+            "GigabitEthernet[2-4]",
+            "Loopback0",
+        ],
+        "route_distinguisher": "",
+    },
+)
+
+r2_default_digit = SelfTestData(
+    name="r2_default",
+    nornir_raw_result=nornir_raw_result_r2,
+    test_data={
+        "host": "R2",
+        "network_instance": "default",
+        "interfaces": [
+            "GigabitEthernet\\d{1}",
+            "Loopback0",
+        ],
+        "route_distinguisher": "",
+    },
+)
+
 
 r2_mgmt = SelfTestData(
     name="r2_mgmt",
@@ -171,6 +201,8 @@ def general_result(timeouted_multiresult):
         r1_space,
         r1_ship,
         r2_default,
+        r2_default_range,
+        r2_default_digit,
         r2_mgmt,
     ],
     ids=lambda data: data.name,
@@ -213,7 +245,20 @@ def test_contains_interfaces_at_network_instance(transformed_result, testdata):
 
     host_result = transformed_result[host]
     host_result.validate()
-    assert host_result.result[network_instance]["interfaces"] == expected
+    patterns = len(expected)
+    matches = 0
+    result = copy.deepcopy(host_result.result[network_instance]["interfaces"])
+    for interface in expected:
+        pattern = re.compile(interface)
+        for i in result:
+            if pattern.match(i):
+                host_result.result[network_instance]["interfaces"].remove(i)
+        if len(result) != len(host_result.result[network_instance]["interfaces"]):
+            result = copy.deepcopy(host_result.result[network_instance]["interfaces"])
+            matches += 1
+    assert patterns == matches
+    assert result == []
+    # assert host_result.result[network_instance]["interfaces"] == expected
 
 
 def test_contains_route_distinguisher_at_network_instance(transformed_result, testdata):