Merge pull request #368 from networktocode/develop

Merge 1.6.0 into main
networktocode · Sep 8, 2023 · c771a89 · c771a89
2 parents 1e7355b + 93597ec
commit c771a89
Show file tree

Hide file tree

Showing 75 changed files with 4,432 additions and 588 deletions.
diff --git a/.bandit.yml b/.bandit.yml
@@ -3,4 +3,4 @@
 exclude_dirs:
   - "./tests/"
   - "./docs/"
-  - "netutils/oui_mappings.py"
+  - "netutils/data_files/"
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -204,10 +204,10 @@ jobs:
         run: "docker image ls"
       - name: "Run Tests"
         run: "poetry run invoke pytest"
-      - name: "Install Napalm"
-        run: "pip install napalm"
+      - name: "Install Optional Dependencies"
+        run: "poetry run poetry install --extras optionals"
       - name: "Run Optional Tests"
-        run: "poetry run pytest tests/unit/test_lib_helpers_optionals.py"
+        run: "poetry run pytest tests/unit/test_lib_helpers_optionals.py tests/unit/test_acl.py"
     needs:
       - "pylint"
   publish_gh:

diff --git a/.github/workflows/oui_filepull.yml b/.github/workflows/oui_filepull.yml
@@ -3,7 +3,7 @@ name: "OUI-Updates"
 
 on:   # yamllint disable-line rule:truthy
   schedule:
-    - cron: "0 8 * * 4"
+    - cron: "0 2 1 * *"
 
 jobs:
   data_gathering:

diff --git a/.github/workflows/proto_filepull.yml b/.github/workflows/proto_filepull.yml
@@ -3,7 +3,7 @@ name: "Protocol-Updates"
 
 on:   # yamllint disable-line rule:truthy
   schedule:
-    - cron: "0 8 * * 4"
+    - cron: "0 2 1 * *"
 
 jobs:
   data_gathering:

diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -20,3 +20,5 @@ mkdocs:
 python:
   install:
     - requirements: "docs/requirements.txt"
+    - method: "pip"
+      path: "."
diff --git a/development_scripts.py b/development_scripts.py
@@ -35,89 +35,113 @@
 MAPPER = {
     "LIB_MAPPER_TEMPLATE": {
         "ansible": {
-            "header_src": "NORMALIZED",
-            "header_dst": "ANSIBLE",
+            "header_src": "ANSIBLE",
+            "header_dst": "NORMALIZED",
             "_dict": lib_mapper.ANSIBLE_LIB_MAPPER,
             "_file": "docs/user/lib_mapper/ansible.md",
         },
         "ansible_reverse": {
-            "header_src": "ANSIBLE",
-            "header_dst": "NORMALIZED",
+            "header_src": "NORMALIZED",
+            "header_dst": "ANSIBLE",
             "_dict": lib_mapper.ANSIBLE_LIB_MAPPER_REVERSE,
             "_file": "docs/user/lib_mapper/ansible_reverse.md",
         },
-        "napalm": {
+        "hierconfig": {
+            "header_src": "HIERCONFIG",
+            "header_dst": "NORMALIZED",
+            "_dict": lib_mapper.HIERCONFIG_LIB_MAPPER,
+            "_file": "docs/user/lib_mapper/hierconfig.md",
+        },
+        "hierconfig_reverse": {
             "header_src": "NORMALIZED",
-            "header_dst": "NAPALM",
+            "header_dst": "HIERCONFIG",
+            "_dict": lib_mapper.HIERCONFIG_LIB_MAPPER_REVERSE,
+            "_file": "docs/user/lib_mapper/hierconfig_reverse.md",
+        },
+        "napalm": {
+            "header_src": "NAPALM",
+            "header_dst": "NORMALIZED",
             "_dict": lib_mapper.NAPALM_LIB_MAPPER,
             "_file": "docs/user/lib_mapper/napalm.md",
         },
         "napalm_reverse": {
-            "header_src": "NAPALM",
-            "header_dst": "NORMALIZED",
+            "header_src": "NORMALIZED",
+            "header_dst": "NAPALM",
             "_dict": lib_mapper.NAPALM_LIB_MAPPER_REVERSE,
             "_file": "docs/user/lib_mapper/napalm_reverse.md",
         },
-        "ntctemplates": {
+        "netmiko": {
+            "header_src": "NETMIKO",
+            "header_dst": "NORMALIZED",
+            "_dict": lib_mapper.NETMIKO_LIB_MAPPER,
+            "_file": "docs/user/lib_mapper/netmiko.md",
+        },
+        "netmiko_reverse": {
             "header_src": "NORMALIZED",
-            "header_dst": "NTCTEMPLATES",
+            "header_dst": "NETMIKO",
+            "_dict": lib_mapper.NETMIKO_LIB_MAPPER_REVERSE,
+            "_file": "docs/user/lib_mapper/netmiko_reverse.md",
+        },
+        "netutilsparser": {
+            "header_src": "NETUTILSPARSER",
+            "header_dst": "NORMALIZED",
+            "_dict": lib_mapper.NETUTILSPARSER_LIB_MAPPER,
+            "_file": "docs/user/lib_mapper/netutilsparser.md",
+        },
+        "netutilsparser_reverse": {
+            "header_src": "NORMALIZED",
+            "header_dst": "NETUTILSPARSER",
+            "_dict": lib_mapper.NETUTILSPARSER_LIB_MAPPER_REVERSE,
+            "_file": "docs/user/lib_mapper/netutilsparser_reverse.md",
+        },
+        "ntctemplates": {
+            "header_src": "NTCTEMPLATES",
+            "header_dst": "NORMALIZED",
             "_dict": lib_mapper.NTCTEMPLATES_LIB_MAPPER,
             "_file": "docs/user/lib_mapper/ntctemplates.md",
         },
         "ntctemplates_reverse": {
-            "header_src": "NTCTEMPLATES",
-            "header_dst": "NORMALIZED",
+            "header_src": "NORMALIZED",
+            "header_dst": "NTCTEMPLATES",
             "_dict": lib_mapper.NTCTEMPLATES_LIB_MAPPER_REVERSE,
             "_file": "docs/user/lib_mapper/ntctemplates_reverse.md",
         },
         "pyats": {
-            "header_src": "NORMALIZED",
-            "header_dst": "PYATS",
+            "header_src": "PYATS",
+            "header_dst": "NORMALIZED",
             "_dict": lib_mapper.PYATS_LIB_MAPPER,
             "_file": "docs/user/lib_mapper/pyats.md",
         },
         "pyats_reverse": {
-            "header_src": "PYATS",
-            "header_dst": "NORMALIZED",
+            "header_src": "NORMALIZED",
+            "header_dst": "PYATS",
             "_dict": lib_mapper.PYATS_LIB_MAPPER_REVERSE,
             "_file": "docs/user/lib_mapper/pyats_reverse.md",
         },
         "pyntc": {
-            "header_src": "NORMALIZED",
-            "header_dst": "PYNTC",
+            "header_src": "PYNTC",
+            "header_dst": "NORMALIZED",
             "_dict": lib_mapper.PYNTC_LIB_MAPPER,
             "_file": "docs/user/lib_mapper/pyntc.md",
         },
         "pyntc_reverse": {
-            "header_src": "PYNTC",
-            "header_dst": "NORMALIZED",
+            "header_src": "NORMALIZED",
+            "header_dst": "PYNTC",
             "_dict": lib_mapper.PYNTC_LIB_MAPPER_REVERSE,
             "_file": "docs/user/lib_mapper/pyntc_reverse.md",
         },
         "scrapli": {
-            "header_src": "NORMALIZED",
-            "header_dst": "SCRAPLI",
+            "header_src": "SCRAPLI",
+            "header_dst": "NORMALIZED",
             "_dict": lib_mapper.SCRAPLI_LIB_MAPPER,
             "_file": "docs/user/lib_mapper/scrapli.md",
         },
         "scrapli_reverse": {
-            "header_src": "SCRAPLI",
-            "header_dst": "NORMALIZED",
+            "header_src": "NORMALIZED",
+            "header_dst": "SCRAPLI",
             "_dict": lib_mapper.SCRAPLI_LIB_MAPPER_REVERSE,
             "_file": "docs/user/lib_mapper/scrapli_reverse.md",
         },
-        "hierconfig": {
-            "header_src": "HIERCONFIG",
-            "header_dst": "NORMALIZED",
-            "_dict": lib_mapper.HIERCONFIG_LIB_MAPPER,
-            "_file": "docs/user/lib_mapper/hierconfig.md",
-        },
-        "hierconfig_reverse": {
-            "header_src": "NORMALIZED",
-            "header_dst": "HIERCONFIG",
-            "_dict": lib_mapper.HIERCONFIG_LIB_MAPPER_REVERSE,
-            "_file": "docs/user/lib_mapper/hierconfig_reverse.md",
-        },
     },
     "PARSER_MAPPER_TEMPLATE": {
         "default": {

diff --git a/docs/admin/release_notes/version_1.6.md b/docs/admin/release_notes/version_1.6.md
@@ -0,0 +1,36 @@
+# v1.6 Release Notes
+
+## Release Overview
+
+- Added `ubiquiti_airos` parser.
+- Added `ACLRule` and `ACLRules` classes.
+- Added the `ip` functions `is_ip_range`, `is_ip_within`, `is_network`, and `get_range_ips`.
+- Added the `asn` function `int_to_asn` in the function.
+- Added `NETUTILSPARSER_LIB_MAPPER` and `NETUTILSPARSER_LIB_MAPPER_REVERSE` to lib mapper.
+- Added classy docs to view config parser classes.
+
+
+## [v1.6.0] - 2023-09
+
+### Added
+
+- [#290](https://github.com/networktocode/netutils/pull/290) Added `ACLRule` and `ACLRules` classes.
+- [#290](https://github.com/networktocode/netutils/pull/290) Added the `ip` functions `is_ip_range`, `is_ip_within`, `is_network`, and `get_range_ips`.
+- [#325](https://github.com/networktocode/netutils/pull/325) Added classy docs to view config parser classes.
+- [#329](https://github.com/networktocode/netutils/pull/329) Added `ubiquiti_airos` parser.
+- [#332](https://github.com/networktocode/netutils/pull/332) Added the `asn` function `int_to_asn` in the function.
+- [#352](https://github.com/networktocode/netutils/pull/352) Added `NETUTILSPARSER_LIB_MAPPER` and `NETUTILSPARSER_LIB_MAPPER_REVERSE` to lib mapper.
+
+### Changed
+
+- [#346](https://github.com/networktocode/netutils/pull/346) Updated `mac_to_format` docs.
+- [#352](https://github.com/networktocode/netutils/pull/352) Clean up docs and sorting for lib mapper.
+- [#358](https://github.com/networktocode/netutils/pull/358) Changed flatbot schedule.
+
+### Fixed
+
+- [#339](https://github.com/networktocode/netutils/pull/339) Fix for ASN functions.
+- [#340](https://github.com/networktocode/netutils/pull/340) Fixed Netscaler parser slug.
+- [#346](https://github.com/networktocode/netutils/pull/346) Fix issue where interface abbreviation not working.
+- [#350](https://github.com/networktocode/netutils/pull/350) Update library mappings to be correct order.
+- [#356](https://github.com/networktocode/netutils/pull/356) Fixed mkdocs dependencies.