Merge pull request #804 from networktocode/u/joewesch-fix-empty-config

Fixed PanOS empty config parsing

Author: joewesch

changes/803.fixed

@@ -0,0 +1 @@
+Fixed an issue where an empty config would raise an error when parsing Palo Alto Networks PanOS.

netutils/config/parser.py

@@ -1553,12 +1553,14 @@ def build_config_relationship(self) -> t.List[ConfigLine]:  # pylint: disable=to
             True
         """
         if self.config_lines_only is None:
-            raise ValueError("Config is empty.")
+            return []
+        config_lines = self.config_lines_only.splitlines()
+        if not config_lines:
+            return []
 
         if "@dirtyId" in self.config_lines_only:
             # We have to specifically check for JSON format because it can be confused with the brace format
             raise ValueError("Found 'json' configuration format. Please provide in 'set' or 'default' (brace) format.")
-        config_lines = self.config_lines_only.splitlines()
         if any(line.endswith("{") for line in config_lines):
             converted_config = paloalto_panos_brace_to_set(cfg=self.config, cfg_type="string")
             list_config = converted_config.splitlines()

tests/unit/test_parser.py

@@ -13,17 +13,18 @@
 base_parameters = []
 find_all_children_parameters = []
 find_children_w_parents_parameters = []
-for network_os in list(compliance.parser_map.keys()):
-    for _file in glob.glob(f"{MOCK_DIR}/base/{network_os}/*{TXT_FILE}"):
-        base_parameters.append([_file, network_os])
-    for _file in glob.glob(f"{MOCK_DIR}/find_all_children/{network_os}/*{TXT_FILE}"):
-        find_all_children_parameters.append([_file, network_os])
-    for _file in glob.glob(f"{MOCK_DIR}/find_children_w_parents/{network_os}/*{TXT_FILE}"):
-        find_children_w_parents_parameters.append([_file, network_os])
+all_network_os = list(compliance.parser_map.keys())
+for _network_os in all_network_os:
+    for _file in glob.glob(f"{MOCK_DIR}/base/{_network_os}/*{TXT_FILE}"):
+        base_parameters.append([_file, _network_os])
+    for _file in glob.glob(f"{MOCK_DIR}/find_all_children/{_network_os}/*{TXT_FILE}"):
+        find_all_children_parameters.append([_file, _network_os])
+    for _file in glob.glob(f"{MOCK_DIR}/find_children_w_parents/{_network_os}/*{TXT_FILE}"):
+        find_children_w_parents_parameters.append([_file, _network_os])
 
 
 @pytest.mark.parametrize("_file, network_os", base_parameters)
-def test_parser(_file, network_os, get_text_data, get_python_data):  # pylint: disable=redefined-outer-name
+def test_parser(_file, network_os, get_text_data, get_python_data):
     truncate_file = os.path.join(MOCK_DIR, "base", _file[: -len(TXT_FILE)])
 
     device_cfg = get_text_data(os.path.join(MOCK_DIR, "base", _file))
@@ -33,7 +34,7 @@ def test_parser(_file, network_os, get_text_data, get_python_data):  # pylint: d
 
 
 @pytest.mark.parametrize("_file, network_os", find_all_children_parameters)
-def test_find_all_children(_file, network_os, get_text_data, get_json_data):  # pylint: disable=redefined-outer-name
+def test_find_all_children(_file, network_os, get_text_data, get_json_data):
     truncate_file = os.path.join(MOCK_DIR, "find_all_children", _file[: -len(TXT_FILE)])
 
     device_cfg = get_text_data(os.path.join(MOCK_DIR, "find_all_children", _file))
@@ -44,7 +45,7 @@ def test_find_all_children(_file, network_os, get_text_data, get_json_data):  #
 
 
 @pytest.mark.parametrize("_file, network_os", find_children_w_parents_parameters)
-def test_find_children_w_parents(_file, network_os, get_text_data, get_json_data):  # pylint: disable=redefined-outer-name
+def test_find_children_w_parents(_file, network_os, get_text_data, get_json_data):
     truncate_file = os.path.join(MOCK_DIR, "find_children_w_parents", _file[: -len(TXT_FILE)])
 
     device_cfg = get_text_data(os.path.join(MOCK_DIR, "find_children_w_parents", _file))
@@ -81,7 +82,7 @@ def test_duplicate_line():
 
 
 @pytest.mark.parametrize("network_os", ["cisco_ios", "arista_eos", "cisco_iosxr"])
-def test_leading_spaces_config_start(network_os):  # pylint: disable=redefined-outer-name
+def test_leading_spaces_config_start(network_os):
     logging = (
         "! Command: show running-config\n"
         " 24.1.4\n"
@@ -95,3 +96,11 @@ def test_leading_spaces_config_start(network_os):  # pylint: disable=redefined-o
     )
     with pytest.raises(IndexError, match=r".*Validate the first line does not begin with a space.*"):
         compliance.parser_map[network_os](logging).config_lines  # pylint: disable=expression-not-assigned
+
+
+@pytest.mark.parametrize("network_os", all_network_os)
+def test_empty_config(network_os):
+    """Test that an empty config returns an empty list and does not raise an error."""
+    config = ""
+    os_parser = compliance.parser_map[network_os]
+    assert os_parser(config).config_lines == []