Add ACL class, create several ip functions in the process

itdependsnetworks · Aug 2, 2023 · 83abaee · 83abaee
1 parent cd7d728
commit 83abaee
Show file tree

Hide file tree

Showing 22 changed files with 2,123 additions and 29 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/docs/assets/acl-workflow.drawio b/docs/assets/acl-workflow.drawio
diff --git a/docs/dev/code_reference/acl.md b/docs/dev/code_reference/acl.md
@@ -0,0 +1,5 @@
+# ACLs
+
+::: netutils.acl
+    options:
+        show_submodules: True
diff --git a/docs/dev/arch_decision.md → docs/dev/dev_adr.md b/docs/dev/arch_decision.md → docs/dev/dev_adr.md
diff --git a/docs/images/acl-workflow.png b/docs/images/acl-workflow.png
diff --git a/docs/user/include_jinja_list.md b/docs/user/include_jinja_list.md
@@ -33,6 +33,7 @@
 | get_broadcast_address | netutils.ip.get_broadcast_address |
 | get_first_usable | netutils.ip.get_first_usable |
 | get_peer_ip | netutils.ip.get_peer_ip |
+| get_range_ips | netutils.ip.get_range_ips |
 | get_usable_range | netutils.ip.get_usable_range |
 | ip_addition | netutils.ip.ip_addition |
 | ip_subtract | netutils.ip.ip_subtract |
@@ -43,7 +44,10 @@
 | ipaddress_network | netutils.ip.ipaddress_network |
 | is_classful | netutils.ip.is_classful |
 | is_ip | netutils.ip.is_ip |
+| is_ip_range | netutils.ip.is_ip_range |
+| is_ip_within | netutils.ip.is_ip_within |
 | is_netmask | netutils.ip.is_netmask |
+| is_network | netutils.ip.is_network |
 | netmask_to_cidr | netutils.ip.netmask_to_cidr |
 | get_napalm_getters | netutils.lib_helpers.get_napalm_getters |
 | get_oui | netutils.mac.get_oui |

diff --git a/docs/user/lib_use_cases.md b/docs/user/lib_use_cases.md
@@ -23,7 +23,7 @@ Functions are grouped with like functions, such as IP or MAC address based funct
 - Ping - Provides the ability to ping, currently only tcp ping.
 - Protocol Mapper - Provides a mapping for protocol names to numbers and vice versa.
 - Route - Provides the ability to provide a list of routes and an IP Address and return the longest prefix matched route.
-- Time -Provides the ability to convert between integer time and string times.
+- Time - Provides the ability to convert between integer time and string times.
 - VLANs - Provide the ability to convert configuration into lists or lists into configuration.
 
 ## Examples

diff --git a/docs/user/lib_use_cases_acl.md b/docs/user/lib_use_cases_acl.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -100,6 +100,7 @@ nav:
       - Jinja Filters: "user/lib_use_cases_jinja_filters.md"
       - Library Mapper: "user/lib_use_cases_lib_mapper.md"
       - Protocol Mapper: "user/lib_use_cases_protocol_mappers.md"
+      - ACL: "user/lib_use_cases_acl.md"
       - Upgrade Paths: "user/lib_upgrade_paths.md"
       - Getting Started: "user/lib_getting_started.md"
       - Frequently Asked Questions: "user/faq.md"
@@ -122,10 +123,12 @@ nav:
       - Contributing to the Library: "dev/contributing.md"
       - Development Environment: "dev/dev_environment.md"
       - Config Parser Development: "dev/dev_config.md"
+      - Arch Decision Records: "dev/dev_adr.md"
       - Code Attribution to the Library: "dev/attribution.md"
       - Code Reference:
           - "dev/code_reference/index.md"
           - ASN: "dev/code_reference/asn.md"
+          - ACL: "dev/code_reference/acl.md"
           - Bandwidth: "dev/code_reference/bandwidth.md"
           - Banner: "dev/code_reference/banner.md"
           - Configs: "dev/code_reference/configs.md"