Implement transactions

Author: nadvornik

cobbler/actions/sync.py

@@ -296,7 +296,7 @@ def rsync_gen(self):
 
         self.templar.render(template_data, metadata, "/etc/rsyncd.conf")
 
-    def add_single_distro(self, name):
+    def add_single_distro(self, name, rebuild_menu: bool = True):
         """
         Sync adding a single distro.
 
@@ -331,9 +331,10 @@ def add_single_distro(self, name):
         kids = self.api.find_items("profile", {"distro": name}, return_list=True)
         for k in kids:
             self.add_single_profile(k, rebuild_menu=False)
-        self.tftpgen.make_pxe_menu()
+        if rebuild_menu:
+            self.tftpgen.make_pxe_menu()
 
-    def add_single_image(self, name):
+    def add_single_image(self, name, rebuild_menu: bool = True):
         """
         Sync adding a single image.
 
@@ -344,7 +345,8 @@ def add_single_image(self, name):
         kids = self.api.find_items("system", {"image": name})
         for k in kids:
             self.add_single_system(k)
-        self.tftpgen.make_pxe_menu()
+        if rebuild_menu:
+            self.tftpgen.make_pxe_menu()
 
     def remove_single_distro(self, name):
         """

cobbler/api.py

@@ -26,7 +26,7 @@
 import threading
 from configparser import ConfigParser
 from pathlib import Path
-from typing import Dict, List, Optional, Union
+from typing import Dict, List, Optional, Tuple, Union
 
 from schema import SchemaError
 
@@ -1005,6 +1005,45 @@ def add_menu(self, ref, check_for_duplicate_names=False, save=True):
         self.add_item("menu", ref, check_for_duplicate_names=check_for_duplicate_names, save=save)
 
     # ==========================================================================
+    def add_remove_items(self, items: List[Tuple[str, "Item", bool, float, str]]):
+        """
+        Add or remove multiple items.
+
+        :param items: The list of items.
+        """
+        for what, ref, _, mtime, base_id in items:
+            if base_id:
+                orig_ref = self.find_items(what, criteria={"uid": base_id}, return_list=False)
+                if not orig_ref or isinstance(orig_ref, list) or mtime != orig_ref.mtime:
+                    raise ValueError("The item has been modified")
+
+        to_remove = [i for i in items if i[2]]
+        to_add = [i for i in items if not i[2]]
+
+        to_remove.sort(key=lambda x: -x[1].depth)
+        to_add.sort(key=lambda x: x[1].depth)
+
+        for what, ref, _, _, _ in to_add:
+            self.log(f"add_item({what})", [ref.name])
+            self.get_items(what).add(
+                ref,  # type: ignore
+                check_for_duplicate_names=False,
+                save=True,
+                with_triggers=True,
+                rebuild_menu=False
+            )
+
+        for what, ref, _, _, _ in to_remove:
+            self.log(f"remove_item({what})", [ref.name])
+            self.get_items(what).remove(
+                ref.name,
+                recursive=False,
+                with_delete=True,
+                with_triggers=True,
+                rebuild_menu=False
+            )
+
+        self.tftpgen.make_pxe_menu()
 
     def find_items(self, what: str = "", criteria: dict = None, name: str = "", return_list: bool = True,
                    no_errors: bool = False):

cobbler/cobbler_collections/collection.py

@@ -84,6 +84,7 @@ def remove(
         with_sync: bool = True,
         with_triggers: bool = True,
         recursive: bool = False,
+        rebuild_menu: bool = True,
     ) -> None:
         """
         Remove an item from collection. This method must be overridden in any subclass.
@@ -93,6 +94,7 @@ def remove(
         :param with_sync: sync to server file system
         :param with_triggers: run "on delete" triggers
         :param recursive: recursively delete children
+        :param rebuild_menu: rebuild menu after removing the item
         :returns: NotImplementedError
         """
         raise NotImplementedError("Please implement this in a child class of this class.")
@@ -338,6 +340,7 @@ def add(
         with_sync: bool = True,
         quick_pxe_update: bool = False,
         check_for_duplicate_names: bool = False,
+        rebuild_menu: bool = True,
     ):
         """
         Add an object to the collection
@@ -415,7 +418,7 @@ def add(
                     # we don't need openvz containers to be network bootable
                     if ref.virt_type == "openvz":
                         ref.enable_menu = False
-                    self.lite_sync.add_single_profile(ref)
+                    self.lite_sync.add_single_profile(ref, rebuild_menu=rebuild_menu)
                     self.api.sync_systems(
                         systems=self.find(
                             "system",
@@ -425,9 +428,9 @@ def add(
                         )
                     )
                 elif isinstance(ref, distro.Distro):
-                    self.lite_sync.add_single_distro(ref.name)
+                    self.lite_sync.add_single_distro(ref.name, rebuild_menu=rebuild_menu)
                 elif isinstance(ref, image.Image):
-                    self.lite_sync.add_single_image(ref.name)
+                    self.lite_sync.add_single_image(ref.name, rebuild_menu=rebuild_menu)
                 elif isinstance(ref, repo.Repo):
                     pass
                 elif isinstance(ref, mgmtclass.Mgmtclass):

cobbler/cobbler_collections/distros.py

@@ -49,7 +49,7 @@ def factory_produce(self, api, item_dict):
         return new_distro
 
     def remove(self, name, with_delete: bool = True, with_sync: bool = True, with_triggers: bool = True,
-               recursive: bool = False):
+               recursive: bool = False, rebuild_menu: bool = True):
         """
         Remove element named 'name' from the collection
 

cobbler/cobbler_collections/images.py

@@ -40,7 +40,7 @@ def factory_produce(self, api, item_dict):
         return new_image
 
     def remove(self, name, with_delete: bool = True, with_sync: bool = True, with_triggers: bool = True,
-               recursive: bool = True):
+               recursive: bool = True, rebuild_menu: bool = True):
         """
         Remove element named 'name' from the collection
 

cobbler/cobbler_collections/profiles.py

@@ -46,7 +46,7 @@ def factory_produce(self, api, item_dict):
         return new_profile
 
     def remove(self, name: str, with_delete: bool = True, with_sync: bool = True, with_triggers: bool = True,
-               recursive: bool = False):
+               recursive: bool = False, rebuild_menu: bool = True):
         """
         Remove element named 'name' from the collection
 

cobbler/items/item.py

@@ -817,21 +817,27 @@ def parent(self) -> Any:
         return self.api.get_items(self.COLLECTION_TYPE).get(self._parent)
 
     @parent.setter
-    def parent(self, parent: str):
+    def parent(self, parent: Union["Item", str]):
         """
         Set the parent object for this object.
 
         :param parent: The new parent object. This needs to be a descendant in the logical inheritance chain.
         """
-        if not isinstance(parent, str):
-            raise TypeError('Property "parent" must be of type str!')
+        found = None
+        if isinstance(parent, Item):
+            found = parent
+            parent = parent.name
+        elif not isinstance(parent, str):
+            raise TypeError('Property "parent" must be of type Item or str!')
+
         if not parent:
             self._parent = ""
             return
         if parent == self.name:
             # check must be done in two places as setting parent could be called before/after setting name...
             raise CX("self parentage is weird")
-        found = self.api.get_items(self.COLLECTION_TYPE).get(parent)
+        if found is None:
+            found = self.api.get_items(self.COLLECTION_TYPE).get(parent)
         if found is None:
             raise CX(f'profile "{parent}" not found, inheritance not possible')
         self._parent = parent

cobbler/items/profile.py

@@ -189,18 +189,23 @@ def distro(self):
         return self.api.distros().find(name=self._distro)
 
     @distro.setter
-    def distro(self, distro_name: str):
+    def distro(self, distro_name: Union["Distro", str]):
         """
         Sets the distro. This must be the name of an existing Distro object in the Distros collection.
 
         :param distro_name: The name of the distro.
         """
-        if not isinstance(distro_name, str):
-            raise TypeError("distro_name needs to be of type str")
+        distro = None
+        if isinstance(distro_name, Distro):
+            distro = distro_name
+            distro_name = distro.name
+        elif not isinstance(distro_name, str):
+            raise TypeError("distro_name needs to be of type Distro or str")
         if not distro_name:
             self._distro = ""
             return
-        distro = self.api.distros().find(name=distro_name)
+        if distro is None:
+            distro = self.api.distros().find(name=distro_name)
         if distro is None:
             raise ValueError('distribution "%s" not found' % distro_name)
         self._distro = distro_name