new test case when [content] is missing from macro body

clouless · clouless · commit 51b9fc6ecde6 · 2025-12-19T20:19:37.000+01:00
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@ lib/output/*
 !lib/output/.gitkeep
 .coverage
 .DS_Store
+acm
diff --git a/README.md b/README.md
@@ -66,6 +66,10 @@ The Cloud App equivalent will look like this:
 git clone https://github.com/codeclou/advanced-codeblocks-cloud-migration-helper.git
 cd advanced-codeblocks-cloud-migration-helper
 python3 -m pip install -r requirements.txt
+# or
+python3 -m venv ./acm
+source ./acm/bin/activate
+python3 -m pip install -r requirements.txt
 ```
 
 &nbsp;
diff --git a/lib/input/ac-multi-test2.input.storage b/lib/input/ac-multi-test2.input.storage
@@ -2,10 +2,10 @@
 <p>test123</p><ac:structured-macro ac:name="advanced-codeblock-macro" ac:schema-version="1" ac:macro-id="544fd4da-43cf-4d4b-b675-34ee3cb50000"><ac:parameter ac:name="enableddl">true</ac:parameter><ac:parameter ac:name="theme">light-spring</ac:parameter><ac:parameter ac:name="lang">Apache</ac:parameter><ac:parameter ac:name="expandFirst">true</ac:parameter><ac:parameter ac:name="globaltitle">multi title</ac:parameter><ac:plain-text-body><![CDATA[[test a]
 foo = bar
 
-[content]
+[MISSINGCONTENT]
 <VirtualHost>
   serverName = ${foo}
 </VirtualHost> ]]></ac:plain-text-body></ac:structured-macro>
 <p><br /></p>
 <p><br /></p>
-<p><br /></p>
+<p><br /></p>
diff --git a/lib/macro_storage_format_parser.py b/lib/macro_storage_format_parser.py
@@ -3,8 +3,11 @@
 from lib.macro_storage_format_builder import MacroStorageFormatBuilder
 from lib.util import Util
 
+
 class MacroStorageFormatParser:
-    def __init__(self, inputfile: str, outputfile: str, extensionkey: str, forceUUIDsZeroed: bool):
+    def __init__(
+        self, inputfile: str, outputfile: str, extensionkey: str, forceUUIDsZeroed: bool
+    ):
         self.inputfile = inputfile
         self.outputfile = outputfile
         self.extensionkey = extensionkey
@@ -16,19 +19,21 @@ def transform(self):
         print("START > reading storage format file from: " + self.inputfile)
         print(" ")
         with open(self.inputfile) as file:
-            xml_string =  file.read()
+            xml_string = file.read()
         soup = self.util.get_xml_parser(xml_string)
         all_macros = soup.find_all("ac:structured-macro", recursive=True)
         page_has_ac_macro = False
         for macro_node in all_macros:
             #
             # STEP 1: Parse DC Advanced Codeblock Macros
             #
-            if (macro_node.attrs['ac:name'] == 'advanced-single-codeblock-macro' or 
-                macro_node.attrs['ac:name'] == 'advanced-codeblock-macro' or
-                macro_node.attrs['ac:name'] == 'advanced-remote-codeblock-macro'):
+            if (
+                macro_node.attrs["ac:name"] == "advanced-single-codeblock-macro"
+                or macro_node.attrs["ac:name"] == "advanced-codeblock-macro"
+                or macro_node.attrs["ac:name"] == "advanced-remote-codeblock-macro"
+            ):
                 page_has_ac_macro = True
-                macro_name = macro_node.attrs['ac:name']
+                macro_name = macro_node.attrs["ac:name"]
                 print(">> " + macro_name)
                 # ----
                 # all macros:
@@ -47,7 +52,7 @@ def transform(self):
                 macro_param_enableddl = "false"
                 #
                 # multi and remote only:
-                #   <ac:parameter ac:name="expandFirst">true</ac:parameter> 
+                #   <ac:parameter ac:name="expandFirst">true</ac:parameter>
                 macro_param_expand_first = "false"
                 #
                 # remote only:
@@ -60,55 +65,103 @@ def transform(self):
                 # ----
                 macro_children = macro_node.findChildren()
                 for child in macro_children:
-                    if (child.name == "ac:plain-text-body"):
-                        if (macro_name == 'advanced-single-codeblock-macro'):
+                    if child.name == "ac:plain-text-body":
+                        if macro_name == "advanced-single-codeblock-macro":
                             macro_code = child.text
                             macro_config = ""
-                        elif (macro_name == 'advanced-codeblock-macro'):
-                            config_and_code = child.text.split("[content]\n", 1)
-                            macro_code = config_and_code[1]
-                            macro_config = config_and_code[0]
-                        elif (macro_name == 'advanced-remote-codeblock-macro'):
+                        elif macro_name == "advanced-codeblock-macro":
+                            if "[content]\n" not in child.text:
+                                print(
+                                    ">> ERROR: no [content] element in macro body found!"
+                                )
+                                macro_code = "ERROR - COULD NOT PARSE"
+                                macro_config = "ERROR - COULD NOT PARSE"
+                            else:
+                                config_and_code = child.text.split("[content]\n", 1)
+                                macro_code = config_and_code[1]
+                                macro_config = config_and_code[0]
+                        elif macro_name == "advanced-remote-codeblock-macro":
                             macro_code = ""
                             macro_config = child.text
-                        print ("    macro config (shortened): " + self.util.shorten_string_for_print(macro_config))
-                        print ("    macro code (shortened)  : " + self.util.shorten_string_for_print(macro_code))
-                    if (child.name == "ac:parameter"):
-                        ac_name = child.get('ac:name')
-                        if (ac_name == "lang"):
-                            macro_param_lang = self.util.replace_server_macro_lang_with_cloud_pendant(child.text)
-                            print ("    macro param lang        : " + macro_param_lang)
-                        if (ac_name == "enableddl"):
+                        print(
+                            "    macro config (shortened): "
+                            + self.util.shorten_string_for_print(macro_config)
+                        )
+                        print(
+                            "    macro code (shortened)  : "
+                            + self.util.shorten_string_for_print(macro_code)
+                        )
+                    if child.name == "ac:parameter":
+                        ac_name = child.get("ac:name")
+                        if ac_name == "lang":
+                            macro_param_lang = (
+                                self.util.replace_server_macro_lang_with_cloud_pendant(
+                                    child.text
+                                )
+                            )
+                            print("    macro param lang        : " + macro_param_lang)
+                        if ac_name == "enableddl":
                             macro_param_enableddl = child.text
-                            print ("    macro param enableddl   : " + macro_param_enableddl)
-                        if (ac_name == "globaltitle"):
+                            print(
+                                "    macro param enableddl   : " + macro_param_enableddl
+                            )
+                        if ac_name == "globaltitle":
                             macro_param_globaltitle = child.text
-                            print ("    macro param globaltitle : " + macro_param_globaltitle)
-                        if (ac_name == "theme"):
+                            print(
+                                "    macro param globaltitle : "
+                                + macro_param_globaltitle
+                            )
+                        if ac_name == "theme":
                             macro_param_theme = child.text
-                            print ("    macro param theme       : " + macro_param_theme)
-                        if (ac_name == "expandFirst"):
+                            print("    macro param theme       : " + macro_param_theme)
+                        if ac_name == "expandFirst":
                             macro_param_expand_first = child.text
-                            print ("    macro param expand first: " + macro_param_expand_first)
-                        if (ac_name == "remotefileurl"):
+                            print(
+                                "    macro param expand first: "
+                                + macro_param_expand_first
+                            )
+                        if ac_name == "remotefileurl":
                             macro_param_remotefileurl = child.text
-                            print ("    macro param remote url  : " + macro_param_remotefileurl)
-                        if (ac_name == "remotefilehttpuser"):
+                            print(
+                                "    macro param remote url  : "
+                                + macro_param_remotefileurl
+                            )
+                        if ac_name == "remotefilehttpuser":
                             macro_param_remotefilehttpuser = child.text
-                            print ("    macro param remote user : " + macro_param_remotefilehttpuser)
-                        if (ac_name == "remotefilehttppassword"):
+                            print(
+                                "    macro param remote user : "
+                                + macro_param_remotefilehttpuser
+                            )
+                        if ac_name == "remotefilehttppassword":
                             macro_param_remotefilehttppassword = child.text
-                            print ("    macro param remote pass : " + macro_param_remotefilehttppassword)
+                            print(
+                                "    macro param remote pass : "
+                                + macro_param_remotefilehttppassword
+                            )
                 #
                 # STEP 2: Generate Cloud Advanced Codeblock Macro storage formats
                 #
                 cloud_adf_attribute_local_id = self.util.generate_uuid()
                 cloud_adf_parameter_local_id = self.util.generate_uuid()
-                print ("    macro attr local id     : " + cloud_adf_attribute_local_id)
-                print ("    macro param local id    : " + cloud_adf_parameter_local_id)
-                cloud_macro_storage_format = builder.generate_ac_cloud_macro(macro_name, cloud_adf_attribute_local_id, cloud_adf_parameter_local_id, macro_config, macro_code, macro_param_lang, macro_param_enableddl, macro_param_globaltitle, macro_param_theme, macro_param_expand_first, macro_param_remotefileurl, macro_param_remotefilehttppassword, macro_param_remotefilehttpuser)
+                print("    macro attr local id     : " + cloud_adf_attribute_local_id)
+                print("    macro param local id    : " + cloud_adf_parameter_local_id)
+                cloud_macro_storage_format = builder.generate_ac_cloud_macro(
+                    macro_name,
+                    cloud_adf_attribute_local_id,
+                    cloud_adf_parameter_local_id,
+                    macro_config,
+                    macro_code,
+                    macro_param_lang,
+                    macro_param_enableddl,
+                    macro_param_globaltitle,
+                    macro_param_theme,
+                    macro_param_expand_first,
+                    macro_param_remotefileurl,
+                    macro_param_remotefilehttppassword,
+                    macro_param_remotefilehttpuser,
+                )
                 macro_node.replaceWith(cloud_macro_storage_format)
-        if (not page_has_ac_macro):
+        if not page_has_ac_macro:
             print(">> no Advanced Codeblocks macros found in page")
         #
         # STEP 3: Write outputfile
diff --git a/lib/output-expected/ac-multi-test2.output.storage b/lib/output-expected/ac-multi-test2.output.storage
@@ -0,0 +1,24 @@
+<p>test123</p>
+<ac:adf-extension>
+ <ac:adf-node type="extension">
+  <ac:adf-attribute key="extension-type">com.atlassian.ecosystem</ac:adf-attribute>
+  <ac:adf-attribute key="extension-key">9a81c16f-31e6-4be7-be6e-dfc872fe4155/35d2082a-431b-46b7-90da-75a526882f2f/static/advancedcodeblockmacro</ac:adf-attribute>
+  <ac:adf-attribute key="parameters"><ac:adf-parameter key="local-id">00000000-0000-0000-0000-000000000000</ac:adf-parameter><ac:adf-parameter key="extension-id">ari:cloud:ecosystem::extension/9a81c16f-31e6-4be7-be6e-dfc872fe4155/35d2082a-431b-46b7-90da-75a526882f2f/static/advancedcodeblockmacro</ac:adf-parameter><ac:adf-parameter key="extension-title">Advanced Codeblocks Multi</ac:adf-parameter><ac:adf-parameter key="guest-params"><ac:adf-parameter key="globaltitle">multi title</ac:adf-parameter><ac:adf-parameter key="code"><![CDATA[ERROR - COULD NOT PARSE]]></ac:adf-parameter><ac:adf-parameter key="config"><![CDATA[ERROR - COULD NOT PARSE]]></ac:adf-parameter><ac:adf-parameter key="enableddl"><ac:adf-parameter-value>true</ac:adf-parameter-value></ac:adf-parameter><ac:adf-parameter key="expandfirst"><ac:adf-parameter-value>true</ac:adf-parameter-value></ac:adf-parameter><ac:adf-parameter key="theme">light-spring</ac:adf-parameter><ac:adf-parameter key="lang">apache</ac:adf-parameter></ac:adf-parameter></ac:adf-attribute>
+  <ac:adf-attribute key="text">Advanced Codeblocks Multi</ac:adf-attribute>
+  <ac:adf-attribute key="layout">default</ac:adf-attribute>
+  <ac:adf-attribute key="local-id">00000000-0000-0000-0000-000000000000</ac:adf-attribute>
+ </ac:adf-node>
+ <ac:adf-fallback>
+  <ac:adf-node type="extension">
+   <ac:adf-attribute key="extension-type">com.atlassian.ecosystem</ac:adf-attribute>
+   <ac:adf-attribute key="extension-key">9a81c16f-31e6-4be7-be6e-dfc872fe4155/35d2082a-431b-46b7-90da-75a526882f2f/static/advancedcodeblockmacro</ac:adf-attribute>
+   <ac:adf-attribute key="parameters"><ac:adf-parameter key="local-id">00000000-0000-0000-0000-000000000000</ac:adf-parameter><ac:adf-parameter key="extension-id">ari:cloud:ecosystem::extension/9a81c16f-31e6-4be7-be6e-dfc872fe4155/35d2082a-431b-46b7-90da-75a526882f2f/static/advancedcodeblockmacro</ac:adf-parameter><ac:adf-parameter key="extension-title">Advanced Codeblocks Multi</ac:adf-parameter><ac:adf-parameter key="guest-params"><ac:adf-parameter key="globaltitle">multi title</ac:adf-parameter><ac:adf-parameter key="code"><![CDATA[ERROR - COULD NOT PARSE]]></ac:adf-parameter><ac:adf-parameter key="config"><![CDATA[ERROR - COULD NOT PARSE]]></ac:adf-parameter><ac:adf-parameter key="enableddl"><ac:adf-parameter-value>true</ac:adf-parameter-value></ac:adf-parameter><ac:adf-parameter key="expandfirst"><ac:adf-parameter-value>true</ac:adf-parameter-value></ac:adf-parameter><ac:adf-parameter key="theme">light-spring</ac:adf-parameter><ac:adf-parameter key="lang">apache</ac:adf-parameter></ac:adf-parameter></ac:adf-attribute>
+   <ac:adf-attribute key="text">Advanced Codeblocks Multi</ac:adf-attribute>
+   <ac:adf-attribute key="layout">default</ac:adf-attribute>
+   <ac:adf-attribute key="local-id">00000000-0000-0000-0000-000000000000</ac:adf-attribute>
+  </ac:adf-node>
+ </ac:adf-fallback>
+</ac:adf-extension>
+<p><br/></p>
+<p><br/></p>
+<p><br/></p>
diff --git a/lib/test_macro_storage_format_parser.py b/lib/test_macro_storage_format_parser.py
@@ -2,52 +2,68 @@
 
 # https://docs.python.org/3/library/unittest.html
 
-import unittest 
+import unittest
+
 from lib.macro_storage_format_parser import MacroStorageFormatParser
 
-class TestMacroStorageFormatParser(unittest.TestCase):
 
+class TestMacroStorageFormatParser(unittest.TestCase):
     def test_transform___valid_multi(self):
-        self.maxDiff=None
+        self.maxDiff = None
         # GIVEN
         input_file = "./lib/input/ac-multi-test1.input.storage"
         output_file = "./lib/output/ac-multi-test1.output.storage"
         expected_output_file = "./lib/output-expected/ac-multi-test1.output.storage"
-        extension_key = "9a81c16f-31e6-4be7-be6e-dfc872fe4155/35d2082a-431b-46b7-90da-75a526882f2f"
+        extension_key = (
+            "9a81c16f-31e6-4be7-be6e-dfc872fe4155/35d2082a-431b-46b7-90da-75a526882f2f"
+        )
+        # WHEN
+        parser = MacroStorageFormatParser(input_file, output_file, extension_key, True)
+        parser.transform()
+        # THEN
+        self.assertListEqual(list(open(output_file)), list(open(expected_output_file)))
+
+    def test_transform___invalid_multi(self):
+        self.maxDiff = None
+        # GIVEN
+        input_file = "./lib/input/ac-multi-test2.input.storage"
+        output_file = "./lib/output/ac-multi-test2.output.storage"
+        expected_output_file = "./lib/output-expected/ac-multi-test2.output.storage"
+        extension_key = (
+            "9a81c16f-31e6-4be7-be6e-dfc872fe4155/35d2082a-431b-46b7-90da-75a526882f2f"
+        )
         # WHEN
         parser = MacroStorageFormatParser(input_file, output_file, extension_key, True)
-        parser.transform();
+        parser.transform()
         # THEN
-        self.assertListEqual(
-            list(open(output_file)),
-            list(open(expected_output_file)))
+        self.assertListEqual(list(open(output_file)), list(open(expected_output_file)))
 
     def test_transform___valid_single(self):
-        self.maxDiff=None
+        self.maxDiff = None
         # GIVEN
         input_file = "./lib/input/ac-single-test1.input.storage"
         output_file = "./lib/output/ac-single-test1.output.storage"
         expected_output_file = "./lib/output-expected/ac-single-test1.output.storage"
-        extension_key = "9a81c16f-31e6-4be7-be6e-dfc872fe4155/35d2082a-431b-46b7-90da-75a526882f2f"
+        extension_key = (
+            "9a81c16f-31e6-4be7-be6e-dfc872fe4155/35d2082a-431b-46b7-90da-75a526882f2f"
+        )
         # WHEN
         parser = MacroStorageFormatParser(input_file, output_file, extension_key, True)
-        parser.transform();
+        parser.transform()
         # THEN
-        self.assertListEqual(
-            list(open(output_file)),
-            list(open(expected_output_file)))
+        self.assertListEqual(list(open(output_file)), list(open(expected_output_file)))
 
     def test_transform___valid_remote(self):
-        self.maxDiff=None
+        self.maxDiff = None
         # GIVEN
         input_file = "./lib/input/ac-remote-test1.input.storage"
         output_file = "./lib/output/ac-remote-test1.output.storage"
         expected_output_file = "./lib/output-expected/ac-remote-test1.output.storage"
-        extension_key = "9a81c16f-31e6-4be7-be6e-dfc872fe4155/35d2082a-431b-46b7-90da-75a526882f2f"
+        extension_key = (
+            "9a81c16f-31e6-4be7-be6e-dfc872fe4155/35d2082a-431b-46b7-90da-75a526882f2f"
+        )
         # WHEN
         parser = MacroStorageFormatParser(input_file, output_file, extension_key, True)
-        parser.transform();
+        parser.transform()
         # THEN
-        self.assertListEqual(
-            list(open(output_file)),
-            list(open(expected_output_file)))
+        self.assertListEqual(list(open(output_file)), list(open(expected_output_file)))
diff --git a/pyproject.toml b/pyproject.toml
diff --git a/requirements.txt b/requirements.txt
@@ -1,5 +1,5 @@
 uuid7==0.1.0
-beautifulsoup4==4.12.2
-pytest==7.4.3
-pytest_cov==4.1.0
-lxml==4.9.4
+beautifulsoup4==4.14.3
+pytest==9.0.2
+pytest_cov==7.0.0
+lxml==6.0.2
