prep for 1.8.1 release (#510)

susanhooks · jeffkala · web-flow · commit 3b1004eaa66b · 2024-04-19T11:41:03.000-06:00
* prep for 1.8.1 release * More IOS banner related fixes. (#509) * dual banner parser actual parser fix and empty banner fix * black * fixed docs * Update docs/admin/release_notes/version_1.8.md * Update docs/admin/release_notes/version_1.8.md --------- Co-authored-by: Jeff Kala <48843785+jeffkala@users.noreply.github.com>
diff --git a/development_scripts.py b/development_scripts.py
@@ -1,4 +1,5 @@
 """Developer script to generate markdown tables."""
+
 from jinja2 import Environment, BaseLoader, select_autoescape
 from netutils.utils import _JINJA2_FUNCTION_MAPPINGS
 from netutils import lib_mapper
diff --git a/docs/admin/release_notes/version_1.8.md b/docs/admin/release_notes/version_1.8.md
@@ -29,3 +29,9 @@
 
 - [#496](https://github.com/networktocode/netutils/pull/496) Fixed vyos lib_mapper.
 - [#416](https://github.com/networktocode/netutils/pull/416) Fixed for `\n` characters in parsing bug in palo parser.
+
+## [v1.8.1] 2024-04
+
+### Fixed
+- [#509](https://github.com/networktocode/netutils/pull/509) Fixed parsing of empty banner, and dual banner for Cisco platforms.
+
diff --git a/flat_postprocess/oui_postprocess.py b/flat_postprocess/oui_postprocess.py
@@ -1,4 +1,5 @@
 """Python code used to postprocess Flat github action data related to OUI mappings."""
+
 import sys
 import re
 from urllib.request import urlopen
diff --git a/flat_postprocess/protocol_number_postprocess.py b/flat_postprocess/protocol_number_postprocess.py
@@ -1,4 +1,5 @@
 """Python code used to postprocess Flat github action data related to Protocol mappings."""
+
 import csv
 import os
 import sys
diff --git a/flat_postprocess/protocol_postprocess.py b/flat_postprocess/protocol_postprocess.py
@@ -1,4 +1,5 @@
 """Python code used to postprocess Flat github action data related to Protocol mappings."""
+
 import csv
 import os
 import sys
diff --git a/netutils/__init__.py b/netutils/__init__.py
@@ -1,6 +1,5 @@
 """Initialization file for library."""
 
-
 from importlib import metadata
 
 
diff --git a/netutils/bandwidth.py b/netutils/bandwidth.py
@@ -1,4 +1,5 @@
 """Functions for performing bandwidth calculations."""
+
 import re
 import typing as t
 
diff --git a/netutils/banner.py b/netutils/banner.py
@@ -1,4 +1,5 @@
 """Functions for working with the banner configuration."""
+
 import re
 
 from netutils.constants import CARET_C
diff --git a/netutils/config/clean.py b/netutils/config/clean.py
@@ -1,4 +1,5 @@
 """Functions for working with configuration to clean the config."""
+
 # pylint: disable=anomalous-backslash-in-string
 
 import re
diff --git a/netutils/config/conversion.py b/netutils/config/conversion.py
@@ -114,9 +114,11 @@ def paloalto_panos_clean_newlines(cfg: str) -> str:
     )
 
     newlines_cleaned_cfg = paloalto_panos_newline_regex.sub(
-        lambda match: match.group().replace("\n", " ")
-        if not any(substring in match.group() for substring in paloalto_panos_no_newline_cleanup_match)
-        else match.group(),
+        lambda match: (
+            match.group().replace("\n", " ")
+            if not any(substring in match.group() for substring in paloalto_panos_no_newline_cleanup_match)
+            else match.group()
+        ),
         cfg,
     )
 
diff --git a/netutils/constants.py b/netutils/constants.py
@@ -1,4 +1,5 @@
 """Constant definitions used in project."""
+
 from netutils.data_files.protocol_mappings import (  # noqa: F401 # pylint:disable=unused-import
     PROTOCOLS,
 )
diff --git a/netutils/dns.py b/netutils/dns.py
@@ -1,4 +1,5 @@
 """Functions for working with DNS."""
+
 import socket
 
 
diff --git a/netutils/hash.py b/netutils/hash.py
@@ -1,4 +1,5 @@
 """Functions for hashing data."""
+
 import hashlib
 import typing as t
 
diff --git a/netutils/interface.py b/netutils/interface.py
@@ -1,4 +1,5 @@
 """Functions for working with interface."""
+
 import itertools
 import re
 import typing as t
diff --git a/netutils/os_version.py b/netutils/os_version.py
@@ -1,4 +1,5 @@
 """Functions for working with OS Versions."""
+
 import typing as t
 
 from netutils._private.version import LooseVersion, StrictVersion  # type: ignore
diff --git a/netutils/ping.py b/netutils/ping.py
@@ -1,4 +1,5 @@
 """Functions to create a ping via pure Python."""
+
 import socket
 
 
diff --git a/netutils/protocol_mapper.py b/netutils/protocol_mapper.py
@@ -1,4 +1,5 @@
 """Protocol Mappers."""
+
 import typing as t
 
 from netutils.constants import PROTOCOLS
diff --git a/netutils/time.py b/netutils/time.py
@@ -1,4 +1,5 @@
 """Functions for working with time."""
+
 import re
 import typing as t
 
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "netutils"
-version = "1.8.0"
+version = "1.8.1"
 description = "Common helper functions useful in network automation."
 authors = ["Network to Code, LLC <opensource@networktocode.com>"]
 license = "Apache-2.0"
diff --git a/tasks.py b/tasks.py
@@ -1,4 +1,5 @@
 """Tasks for use with Invoke."""
+
 import os
 import sys
 
diff --git a/tests/unit/conftest.py b/tests/unit/conftest.py
@@ -1,4 +1,5 @@
 """Used to setup fixtures to be used through tests"""
+
 import json
 import os
 import importlib.util
diff --git a/tests/unit/test_acl.py b/tests/unit/test_acl.py
@@ -1,4 +1,5 @@
 """Test for the BGP ASN functions."""
+
 # pylint: disable=use-dict-literal
 
 import pytest
diff --git a/tests/unit/test_basics.py b/tests/unit/test_basics.py
@@ -1,4 +1,5 @@
 """Basic tests that do not require netutils."""
+
 import os
 import unittest
 import toml
diff --git a/tests/unit/test_compliance.py b/tests/unit/test_compliance.py
@@ -1,4 +1,5 @@
 """Test for the config compliance functions."""
+
 import glob
 import os
 
diff --git a/tests/unit/test_config_clean.py b/tests/unit/test_config_clean.py
@@ -1,4 +1,5 @@
 """Test for the config cleaning functions."""
+
 import glob
 import os
 
diff --git a/tests/unit/test_conversion.py b/tests/unit/test_conversion.py
@@ -1,4 +1,5 @@
 """Test that configurations properly convert from undesired format to desired"""
+
 import glob
 import os
 
diff --git a/tests/unit/test_docs.py b/tests/unit/test_docs.py
@@ -1,4 +1,5 @@
 """Update docs tests to include assurance that development script ran."""
+
 import sys
 
 sys.path.append("...")
diff --git a/tests/unit/test_hash.py b/tests/unit/test_hash.py
@@ -1,4 +1,5 @@
 """Tests for the hash functions."""
+
 import pytest
 
 from netutils.hash import hash_data
diff --git a/tests/unit/test_interface.py b/tests/unit/test_interface.py
@@ -1,4 +1,5 @@
 """Test for the interface functions."""
+
 import pytest
 
 from netutils import interface
diff --git a/tests/unit/test_lib_helpers.py b/tests/unit/test_lib_helpers.py
@@ -1,4 +1,5 @@
 """Test for the lib_helpers definitions."""
+
 from unittest import mock
 
 import pytest
diff --git a/tests/unit/test_lib_helpers_optionals.py b/tests/unit/test_lib_helpers_optionals.py
@@ -1,4 +1,5 @@
 """Test for the lib_helpers definitions when optional packages are installed."""
+
 from unittest import mock
 
 import pytest
diff --git a/tests/unit/test_mac.py b/tests/unit/test_mac.py
@@ -1,4 +1,5 @@
 """Test for the MAC address functions."""
+
 import pytest
 
 from netutils import mac
diff --git a/tests/unit/test_os_versions.py b/tests/unit/test_os_versions.py
@@ -1,4 +1,5 @@
 """Test for the lib_helpers definitions."""
+
 import pytest
 from netutils import os_version
 from netutils.constants import UPGRADE_PATHS
diff --git a/tests/unit/test_parser.py b/tests/unit/test_parser.py
@@ -1,4 +1,5 @@
 """Test for the network os parser functions."""
+
 import glob
 import os
 
diff --git a/tests/unit/test_password.py b/tests/unit/test_password.py
@@ -1,4 +1,5 @@
 """Test for the password functions."""
+
 import pytest
 
 from netutils import password
diff --git a/tests/unit/test_private_version.py b/tests/unit/test_private_version.py
@@ -1,4 +1,5 @@
 """Tests for distutils.version."""
+
 # pylint: disable=deprecated-module,missing-class-docstring,invalid-name,protected-access,consider-using-f-string,no-else-continue,raise-missing-from
 
 # Taken from https://github.com/python/cpython/blob/3.11/Lib/distutils/tests/test_version.py
diff --git a/tests/unit/test_protocol_mapper.py b/tests/unit/test_protocol_mapper.py
@@ -1,4 +1,5 @@
 """Test for the lib_mapper definitions."""
+
 import pytest
 
 from netutils.protocol_mapper import (
diff --git a/tests/unit/test_route.py b/tests/unit/test_route.py
@@ -1,4 +1,5 @@
 """Test for the longest_prefix_match definitions."""
+
 from ipaddress import AddressValueError, NetmaskValueError
 
 import pytest
diff --git a/tests/unit/test_sanitize.py b/tests/unit/test_sanitize.py
@@ -1,4 +1,5 @@
 """Test for the network os sanitize functions."""
+
 import glob
 import os
 
diff --git a/tests/unit/test_time.py b/tests/unit/test_time.py
@@ -1,4 +1,5 @@
 """Test for the time functions."""
+
 import pytest
 from netutils.time import uptime_string_to_seconds, uptime_seconds_to_string
 
diff --git a/tests/unit/test_utils.py b/tests/unit/test_utils.py
@@ -1,4 +1,5 @@
 """Test for the library utilities."""
+
 import os
 from glob import glob
 from importlib import import_module
diff --git a/tests/unit/test_version.py b/tests/unit/test_version.py
@@ -1,4 +1,5 @@
 """Basic test for version check."""
+
 import unittest
 import os
 import toml
diff --git a/tests/unit/test_vlan.py b/tests/unit/test_vlan.py
@@ -1,4 +1,5 @@
 """Test for the VLAN functions."""
+
 import os
 import glob
 

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`"""Developer script to generate markdown tables."""`
	`2`	`+`
`2`	`3`	`from jinja2 import Environment, BaseLoader, select_autoescape`
`3`	`4`	`from netutils.utils import _JINJA2_FUNCTION_MAPPINGS`
`4`	`5`	`from netutils import lib_mapper`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`"""Python code used to postprocess Flat github action data related to OUI mappings."""`
	`2`	`+`
`2`	`3`	`import sys`
`3`	`4`	`import re`
`4`	`5`	`from urllib.request import urlopen`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`"""Python code used to postprocess Flat github action data related to Protocol mappings."""`
	`2`	`+`
`2`	`3`	`import csv`
`3`	`4`	`import os`
`4`	`5`	`import sys`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,5 @@`
`1`	`1`	`"""Initialization file for library."""`
`2`	`2`
`3`		`-`
`4`	`3`	`from importlib import metadata`
`5`	`4`
`6`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`"""Functions for performing bandwidth calculations."""`
	`2`	`+`
`2`	`3`	`import re`
`3`	`4`	`import typing as t`
`4`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`"""Functions for working with the banner configuration."""`
	`2`	`+`
`2`	`3`	`import re`
`3`	`4`
`4`	`5`	`from netutils.constants import CARET_C`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,5 @@`
`1`	`1`	`"""Functions for working with configuration to clean the config."""`
	`2`	`+`
`2`	`3`	`# pylint: disable=anomalous-backslash-in-string`
`3`	`4`
`4`	`5`	`import re`
Original file line number	Diff line number	Diff line change
`@@ -114,9 +114,11 @@ def paloalto_panos_clean_newlines(cfg: str) -> str:`
`114`	`114`	`)`
`115`	`115`
`116`	`116`	`newlines_cleaned_cfg = paloalto_panos_newline_regex.sub(`
`117`		`- lambda match: match.group().replace("\n", " ")`
`118`		`- if not any(substring in match.group() for substring in paloalto_panos_no_newline_cleanup_match)`
`119`		`- else match.group(),`
	`117`	`+ lambda match: (`
	`118`	`+ match.group().replace("\n", " ")`
	`119`	`+ if not any(substring in match.group() for substring in paloalto_panos_no_newline_cleanup_match)`
	`120`	`+ else match.group()`
	`121`	`+ ),`
`120`	`122`	`cfg,`
`121`	`123`	`)`
`122`	`124`