Add forward networks mapper (#451)

* Add forwardnetworks mapper and update docs * update docs
networktocode · Feb 9, 2024 · 5bcf145 · 5bcf145
1 parent a026c91
commit 5bcf145
Show file tree

Hide file tree

Showing 7 changed files with 94 additions and 1 deletion.
diff --git a/development_scripts.py b/development_scripts.py
@@ -70,6 +70,18 @@
             "_dict": lib_mapper.CAPIRCA_LIB_MAPPER_REVERSE,
             "_file": "docs/user/lib_mapper/capirca_reverse.md",
         },
+        "forwardnetworks": {
+            "header_src": "FORWARDNETWORKS",
+            "header_dst": "NORMALIZED",
+            "_dict": lib_mapper.FORWARDNETWORKS_LIB_MAPPER,
+            "_file": "docs/user/lib_mapper/forwardnetworks.md",
+        },
+        "forwardnetworks_reverse": {
+            "header_src": "NORMALIZED",
+            "header_dst": "FORWARDNETWORKS",
+            "_dict": lib_mapper.FORWARDNETWORKS_LIB_MAPPER_REVERSE,
+            "_file": "docs/user/lib_mapper/forwardnetworks_reverse.md",
+        },
         "hierconfig": {
             "header_src": "HIERCONFIG",
             "header_dst": "NORMALIZED",

diff --git a/docs/user/lib_mapper/forwardnetworks.md b/docs/user/lib_mapper/forwardnetworks.md
@@ -0,0 +1,18 @@
+| FORWARDNETWORKS | | NORMALIZED |
+| ---------- | -- | ------ |
+| ARISTA_EOS | → | arista_eos |
+| ARUBA_SWITCH | → | aruba_aoscx |
+| ASA | → | cisco_asa |
+| EXTREME_NOS | → | extreme_netiron |
+| F5 | → | bigip_f5 |
+| FORTINET | → | fortinet_fortios |
+| IOS | → | cisco_ios |
+| IOS_XE | → | cisco_ios |
+| IOS_XR | → | cisco_iosxr |
+| JUNOS | → | juniper_junos |
+| LINUX | → | linux |
+| LINUX_OVS_OFCTL | → | linux |
+| NETSCALER | → | netscaler |
+| NXOS | → | cisco_nxos |
+| PAN_OS | → | paloalto_panos |
+| SRX | → | juniper_junos |
diff --git a/docs/user/lib_mapper/forwardnetworks_reverse.md b/docs/user/lib_mapper/forwardnetworks_reverse.md
@@ -0,0 +1,15 @@
+| NORMALIZED | | FORWARDNETWORKS |
+| ---------- | -- | ------ |
+| arista_eos | → | ARISTA_EOS |
+| aruba_aoscx | → | ARUBA_SWITCH |
+| bigip_f5 | → | F5 |
+| cisco_asa | → | ASA |
+| cisco_ios | → | IOS |
+| cisco_iosxr | → | IOS_XR |
+| cisco_nxos | → | NXOS |
+| extreme_netiron | → | EXTREME_NOS |
+| fortinet_fortios | → | FORTINET |
+| juniper_junos | → | JUNOS |
+| linux | → | LINUX |
+| netscaler | → | NETSCALER |
+| paloalto_panos | → | PAN_OS |
diff --git a/docs/user/lib_use_cases_lib_mapper.md b/docs/user/lib_use_cases_lib_mapper.md
@@ -47,6 +47,14 @@ Another use case could be using an example like the above in an Ansible filter.
 
 --8<-- "docs/user/lib_mapper/ansible_reverse.md"
 
+## Forward Networks Mapper
+
+--8<-- "docs/user/lib_mapper/forwardnetworks.md"
+
+## Reverse Forward Networks Mapper
+
+--8<-- "docs/user/lib_mapper/forwardnetworks_reverse.md"
+
 ## Hier Config Mapper
 
 --8<-- "docs/user/lib_mapper/hierconfig.md"

diff --git a/netutils/lib_mapper.py b/netutils/lib_mapper.py
@@ -381,6 +381,26 @@
     "ubiquiti_airos": "ubiquiti_airos",
 }
 
+# Forward Networks Parser | Normalized
+FORWARDNETWORKS_LIB_MAPPER = {
+    "ARISTA_EOS": "arista_eos",
+    "ARUBA_SWITCH": "aruba_aoscx",
+    "ASA": "cisco_asa",
+    "EXTREME_NOS": "extreme_netiron",
+    "FORTINET": "fortinet_fortios",
+    "F5": "bigip_f5",
+    "IOS": "cisco_ios",
+    "IOS_XE": "cisco_ios",
+    "IOS_XR": "cisco_iosxr",
+    "JUNOS": "juniper_junos",
+    "LINUX": "linux",
+    "LINUX_OVS_OFCTL": "linux",
+    "NETSCALER": "netscaler",
+    "NXOS": "cisco_nxos",
+    "PAN_OS": "paloalto_panos",
+    "SRX": "juniper_junos",
+}
+
 # Normalized | NAPALM
 NAPALM_LIB_MAPPER_REVERSE = {
     "arista_eos": "eos",
@@ -508,6 +528,23 @@
     "ubiquiti_airos": "ubiquiti_airos",
 }
 
+# Normalized | Forward Networks Parser
+FORWARDNETWORKS_LIB_MAPPER_REVERSE = {
+    "arista_eos": "ARISTA_EOS",
+    "aruba_aoscx": "ARUBA_SWITCH",
+    "bigip_f5": "F5",
+    "cisco_asa": "ASA",
+    "cisco_ios": "IOS",
+    "cisco_iosxr": "IOS_XR",
+    "cisco_nxos": "NXOS",
+    "extreme_netiron": "EXTREME_NOS",
+    "fortinet_fortios": "FORTINET",
+    "juniper_junos": "JUNOS",
+    "linux": "LINUX",
+    "netscaler": "NETSCALER",
+    "paloalto_panos": "PAN_OS",
+}
+
 # Deep copy the reverse, where there is no actual translation happening.
 NETMIKO_LIB_MAPPER_REVERSE = copy.deepcopy(NETMIKO_LIB_MAPPER)
 NTCTEMPLATES_LIB_MAPPER_REVERSE = copy.deepcopy(NTCTEMPLATES_LIB_MAPPER)

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "netutils"
-version = "1.6.0"
+version = "1.6.1"
 description = "Common helper functions useful in network automation."
 authors = ["Network to Code, LLC <[email protected]>"]
 license = "Apache-2.0"

diff --git a/tests/unit/test_lib_mapper.py b/tests/unit/test_lib_mapper.py
@@ -1,4 +1,5 @@
 """Test for the lib_mapper definitions."""
+
 import pytest
 
 from netutils import lib_mapper
@@ -23,6 +24,8 @@ def test_lib_mapper():
     assert lib_mapper.NAPALM_LIB_MAPPER_REVERSE[lib_mapper.ANSIBLE_LIB_MAPPER["cisco.ios.ios"]] == "ios"
     assert lib_mapper.HIERCONFIG_LIB_MAPPER["ios"] == "cisco_ios"
     assert lib_mapper.HIERCONFIG_LIB_MAPPER_REVERSE[lib_mapper.HIERCONFIG_LIB_MAPPER["ios"]] == "ios"
+    assert lib_mapper.FORWARDNETWORKS_LIB_MAPPER["IOS"] == "cisco_ios"
+    assert lib_mapper.FORWARDNETWORKS_LIB_MAPPER_REVERSE[lib_mapper.FORWARDNETWORKS_LIB_MAPPER["IOS"]] == "IOS"
 
 
 @pytest.mark.parametrize("lib", LIBRARIES)