Move LVM cleanup phase into cleanup

A recap -- we run umount phase then cleanup phase.

Currently we register a object to do the final LVM cleanup based on
the parent PV.  In light of I697bfbf042816c5ddf170bde9534cc4f0c7279ff,
I believe this should just be done in the cleanup phase.  Note there
was probably additional confusion because the partition removal was
done in the cleanup phase until
I7af3c5cf66afd81a481f454b5207af552ad52a32, where is was moved into the
umount phase.

Thus it is moved into the cleanup() function and this should now run,
per the comment, after everything is unmounted in umount phase.

This also exposes that we didn't have the cleanup phase in the unit
tests (because it wasn't doing anything I guess).  Add it.

Change-Id: I1c5f4ffc9619c774f78d21b918a81647b3dc28f5

diskimage_builder/block_device/level1/lvm.py

@@ -288,41 +288,21 @@ class LVMNode(NodeBase):
 
         exec_sudo(['udevadm', 'settle'])
 
-
+    def cleanup(self):
-class LVMUmountNode(NodeBase):
+        # Information about the PV, VG and LV is typically
-    def __init__(self, name, state, pvs):
+        # cached in lvmetad. Even after removing PV device and
-        """Umount Node for LVM
+        # partitions this data is not automatically updated
-
+        # which leads to a couple of problems.
-        Information about the PV, VG and LV is typically
+        # the 'pvscan --cache' scans the available disks
-        cached in lvmetad. Even after removing PV device and
+        # and updates the cache.
-        partitions this data is not automatically updated
+        # This is in cleanup because it must be called after the
-        which leads to a couple of problems.
+        # umount of the containing block device is done, (which should
-        the 'pvscan --cache' scans the available disks
+        # all be done in umount phase).
-        and updates the cache.
-        This must be called after the umount of the
-        containing block device is done.
-        """
-        super(LVMUmountNode, self).__init__(name, state)
-        self.pvs = pvs
-
-    def create(self):
-        # This class is used for cleanup only
-        pass
-
-    def umount(self):
         try:
             exec_sudo(['pvscan', '--cache'])
         except BlockDeviceSetupException as e:
             logger.info("pvscan call failed [%s]", e.returncode)
 
-    def get_edges(self):
-        # This node depends on all physical device(s), which is
-        # recorded in the "base" argument of the PV nodes.
-        edge_to = set()
-        for pv in self.pvs:
-            edge_to.add(pv.base)
-        return ([], edge_to)
-
 
 class LVMPlugin(PluginBase):
 
@@ -411,12 +391,10 @@ class LVMPlugin(PluginBase):
         # create the "driver" node
         self.lvm_node = LVMNode(config['name'], state,
                                 self.pvs, self.lvs, self.vgs)
-        self.lvm_umount_node = LVMUmountNode(
-            config['name'] + "-UMOUNT", state, self.pvs)
 
     def get_nodes(self):
         # the nodes for insertion into the graph are all of the pvs,
-        # vgs and lvs nodes we have created above, the root node and
+        # vgs and lvs nodes we have created above and the root node and
         # the cleanup node.
         return self.pvs + self.vgs + self.lvs \
-            + [self.lvm_node, self.lvm_umount_node]
+            + [self.lvm_node]

diskimage_builder/block_device/tests/test_lvm.py

@@ -23,7 +23,6 @@ from diskimage_builder.block_device.exception import \
     BlockDeviceSetupException
 from diskimage_builder.block_device.level1.lvm import LVMNode
 from diskimage_builder.block_device.level1.lvm import LVMPlugin
-from diskimage_builder.block_device.level1.lvm import LVMUmountNode
 from diskimage_builder.block_device.level1.lvm import LvsNode
 from diskimage_builder.block_device.level1.lvm import PvsNode
 from diskimage_builder.block_device.level1.lvm import VgsNode
@@ -89,7 +88,7 @@ class TestLVM(tc.TestGraphGeneration):
             # XXX: This has not mocked out the "lower" layers of
             # creating the devices, which we're assuming works OK, nor
             # the upper layers.
-            if isinstance(node, (LVMNode, LVMUmountNode, PvsNode,
+            if isinstance(node, (LVMNode, PvsNode,
                                  VgsNode, LvsNode)):
                 # only the LVMNode actually does anything here...
                 node.create()
@@ -198,7 +197,7 @@ class TestLVM(tc.TestGraphGeneration):
                 # XXX: This has not mocked out the "lower" layers of
                 # creating the devices, which we're assuming works OK, nor
                 # the upper layers.
-                if isinstance(node, (LVMNode, LVMUmountNode, PvsNode,
+                if isinstance(node, (LVMNode, PvsNode,
                                      VgsNode, LvsNode)):
                     # only the PvsNode actually does anything here...
                     node.create()
@@ -306,11 +305,16 @@ class TestLVM(tc.TestGraphGeneration):
                 return r
             mock_temp.side_effect = new_tempfile
 
+            def run_it(phase):
                 reverse_order = reversed(call_order)
                 for node in reverse_order:
-                if isinstance(node, (LVMNode, LVMUmountNode, PvsNode,
+                    if isinstance(node, (LVMNode, PvsNode, VgsNode, LvsNode)):
-                                     VgsNode, LvsNode)):
+                        getattr(node, phase)()
-                    node.umount()
+                    else:
+                        logger.debug("Skipping node for test: %s", node)
+
+            run_it('umount')
+            run_it('cleanup')
 
             cmd_sequence = [
                 # delete the lv's
@@ -365,8 +369,7 @@ class TestLVM(tc.TestGraphGeneration):
                 # XXX: This has not mocked out the "lower" layers of
                 # creating the devices, which we're assuming works OK, nor
                 # the upper layers.
-                if isinstance(node, (LVMNode, LVMUmountNode,
+                if isinstance(node, (LVMNode, PvsNode, VgsNode, LvsNode)):
-                                     PvsNode, VgsNode, LvsNode)):
                     # only the LVMNode actually does anything here...
                     node.create()
 
@@ -407,11 +410,16 @@ class TestLVM(tc.TestGraphGeneration):
                 return r
             mock_temp.side_effect = new_tempfile
 
+            def run_it(phase):
                 reverse_order = reversed(call_order)
                 for node in reverse_order:
-                if isinstance(node, (LVMNode, LVMUmountNode,
+                    if isinstance(node, (LVMNode, PvsNode, VgsNode, LvsNode)):
-                                     PvsNode, VgsNode, LvsNode)):
+                        getattr(node, phase)()
-                    node.umount()
+                    else:
+                        logger.debug("Skipping node for test: %s", node)
+
+            run_it('umount')
+            run_it('cleanup')
 
             cmd_sequence = [
                 # deactivate lv's