remove packaging api dependency from update services script

Author: katzy687

packaging-api-samples/update-services/etree_xml_handler.py

@@ -0,0 +1,73 @@
+import xml.etree.ElementTree as ET
+from xml.etree.ElementTree import ElementTree
+
+
+def get_element_tree_from_str(xml_str: str) -> ElementTree:
+    """
+    https://stackoverflow.com/a/18281386
+    """
+    return ET.ElementTree(ET.fromstring(xml_str))
+
+
+def get_element_tree_from_file_path(file_path: str) -> ElementTree:
+    return ET.parse(file_path)
+
+
+def edit_vlan_id_in_tree(element_tree: ElementTree, target_service_model: str, new_vlan_id: str) -> ElementTree:
+    """
+    Iterate over services, find ServiceName that matches service model
+    Iterate over the attributes, update the VLAN ID attribute
+    write to tree
+    """
+    root_element = element_tree.getroot()
+    for curr_service in root_element.iter("Service"):
+        service_data: dict = curr_service.attrib
+        if service_data["ServiceName"] != target_service_model:
+            continue
+        for curr_attr in curr_service.iter("Attribute"):
+            attr_data: dict = curr_attr.attrib
+            if attr_data["Name"] == "VLAN ID":
+                attr_data["Value"] = new_vlan_id
+                return element_tree
+    raise ValueError("Target Service not found in Element Tree")
+
+
+def update_xml_tree(xml_path: str, target_service_model: str, new_vlan_id: str):
+    element_tree = get_element_tree_from_file_path(xml_path)
+    element_tree = edit_vlan_id_in_tree(element_tree, target_service_model, new_vlan_id)
+    element_tree.write(xml_path)
+
+
+if __name__ == "__main__":
+    TEST_TOPOLOGY_XML = """
+        <TopologyInfo xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+          <Details Name="vlan dev" Alias="vlan dev" Driver="Python Setup &amp; Teardown" SetupDuration="10" TeardownDuration="10" Public="false" DefaultDuration="120" EnableSandboxSave="true" AbstractOnSavePolicy="Default" IsPersistentSandbox="false" TopologyId="f36c4723-8496-4d5b-9b61-8374d01c0fe2" BaseTopologyId="">
+            <Description>Blueprint with preconfigured setup &amp; teardown processes.Deploys Apps and resolves connections on Setup, and deletes App VMs on Teardown</Description>
+            <Categories />
+            <Scripts>
+              <Script Name="Default Sandbox Setup 4.0" />
+            </Scripts>
+            <Diagram Zoom="1" NodeSize="Medium" />
+          </Details>
+          <Services>
+            <Service PositionX="1034.09091186523" PositionY="169.01136779785202" Alias="VLAN Manual" ServiceName="VLAN Manual">
+              <Attributes>
+                <Attribute Name="VLAN ID" Value="169" />
+                <Attribute Name="Dummy Attr" Value="Hi" />
+              </Attributes>
+            </Service>
+            <Service PositionX="100" PositionY="100" Alias="Dummy Service" ServiceName="DummyService">
+              <Attributes>
+                <Attribute Name="Dummy Attr 5" Value="179" />
+                <Attribute Name="Dummy Attr" Value="Hi" />
+              </Attributes>
+            </Service>
+          </Services>
+          <Apps />
+        </TopologyInfo>
+    """
+    element_tree = get_element_tree_from_str(TEST_TOPOLOGY_XML)
+    element_tree = edit_vlan_id_in_tree(element_tree, "VLAN Manual", "66")
+    root = element_tree.getroot()
+    ET.indent(root)
+    print(ET.tostring(root, encoding="unicode"))

packaging-api-samples/update-services/process_blueprint.py

@@ -1,6 +1,7 @@
 import os
 
 import update_package
+import update_xml_topology
 from quali_api import QualiAPISession
 from timeit import default_timer
 
@@ -15,11 +16,14 @@ def process_blueprint_flow(quali_api: QualiAPISession, blueprint_name: str, targ
     quali_api.export_package(blueprint_full_names=[blueprint_name],
                              file_path=zip_name)
 
-    # remove unneeded files
-    update_package.clean_bp_archive(zip_name)
+    # with packaging api, commented out to remove dependency
+    # update_package.edit_vlan_id_in_package(zip_name, target_service, new_vlan_id)
 
-    # update target attribute
-    update_package.edit_vlan_id_in_package(zip_name, target_service, new_vlan_id)
+    # with Etree xml manipulation
+    update_xml_topology.edit_vlan_id_in_xml(bp_name=blueprint_name,
+                                            package_path=zip_name,
+                                            target_service=target_service,
+                                            new_vlan_id=new_vlan_id)
 
     # re-upload
     quali_api.import_package(zip_name)

packaging-api-samples/update-services/requirements.txt

@@ -1,4 +1,7 @@
 cloudshell-automation-api
-quali-utils # from cloudshell download center
 requests
-cloudshell-scriptfoundry
+cloudshell-scriptfoundry
+
+
+# Quali Utils not on pypi - get from cloudshell download center and pip install manually
+# quali-utils

packaging-api-samples/update-services/update_package.py

@@ -1,7 +1,6 @@
 import os
 import shutil
 import zipfile
-
 from quali_utils.quali_packaging import PackageEditor
 import constants
 
@@ -20,7 +19,7 @@ def _clean_bp_package(base_path: str):
         shutil.rmtree(full_path)
 
 
-def clean_bp_archive(package_path: str):
+def _clean_bp_archive(package_path: str):
     """
     1. unzip the package
     2. clean out package for everything except Topology xml
@@ -44,6 +43,7 @@ def clean_bp_archive(package_path: str):
 
 
 def edit_vlan_id_in_package(package_path: str, target_service: str, new_vlan_id: str):
+    _clean_bp_archive(package_path)
     p = PackageEditor()
     p.load(package_path)
     bp_names = p.get_topology_names()
@@ -55,11 +55,9 @@ def edit_vlan_id_in_package(package_path: str, target_service: str, new_vlan_id:
                                attribute_name=constants.VLAN_ID_ATTR,
                                attribute_value=new_vlan_id,
                                publish=False)
-    pass
 
 
 if __name__ == "__main__":
     TARGET_PACKAGE = "vlan dev.zip"
     TARGET_SERVICE = "VLAN Manual"
-    clean_bp_archive(TARGET_PACKAGE)
     edit_vlan_id_in_package(TARGET_PACKAGE, TARGET_SERVICE, "42")

packaging-api-samples/update-services/update_xml_topology.py

@@ -0,0 +1,46 @@
+import os
+import shutil
+import zipfile
+from etree_xml_handler import update_xml_tree
+
+
+def _clean_bp_package(base_path: str):
+    """
+    clean out unwanted folders
+    """
+    dir_contents = os.listdir(base_path)
+    for item in dir_contents:
+        if item.endswith(".xml"):
+            continue
+        if item == "Topologies":
+            continue
+        full_path = os.path.join(base_path, item)
+        shutil.rmtree(full_path)
+
+
+def edit_vlan_id_in_xml(bp_name: str, package_path: str, target_service: str, new_vlan_id: str):
+    """
+    1. unzip the package to temp folder
+    2. clean out package for everything except Topology xml
+    3. update xml tree
+    4. zip up extracted folders
+    5. delete temp extracted content
+    """
+    temp_folder = "temp_bp_extracted"
+
+    # UNZIP PACKAGE TO TEMP FOLDER
+    with zipfile.ZipFile(package_path, 'r') as zip_ref:
+        zip_ref.extractall(temp_folder)
+
+    # CLEAR OUT EVERYTHING EXCEPT TOPOLOGIES FOLDER AND METADATA XML
+    _clean_bp_package(temp_folder)
+
+    xml_path = os.path.join(temp_folder, "Topologies", f"{bp_name}.xml")
+    update_xml_tree(xml_path=xml_path, target_service_model=target_service, new_vlan_id=new_vlan_id)
+
+    # REZIP TEMP FOLDER BACK TO ZIP PACKAGE
+    package_file_name = package_path.split("/")[-1].split(".zip")[0]  # handle full path and remove zip extension
+    shutil.make_archive(package_file_name, 'zip', temp_folder)
+
+    # clean up temp folder
+    shutil.rmtree(temp_folder)

packaging-api-samples/update-services/version.txt

@@ -1 +1 @@
-1.0
+1.1