[gnome-continuous-yocto/gnomeostree-3.28-rocko: 4510/8267] wic: flatten imager class hierarchy

[Emmanuele Bassi <ebassi src gnome org>]

commit 71ce8d09e0f5912544936b0364990250c1381fed
Author: Ed Bartosh <ed bartosh linux intel com>
Date:   Fri Feb 3 22:26:06 2017 +0200

    wic: flatten imager class hierarchy
    
    wic code is hard to follow due to deep and twiggy class
    inheritance tree.
    
    Flatten imager tree:
     wic -> wic_create -> Creator -> DirectPlugin -> DirectImageCreator
    to
     wic -> wic_create -> DirectPlugin
    by
     removing Creator class and creator module
     merging DirectImageCreator into DirectPlugin
    
    Changed APIs to use the same parameters names.
    
    Passed parsed command line options as an object down the stack.
    
    (From OE-Core rev: 1e28d512341ce470c7afb256a01e597ab87170ca)
    
    Signed-off-by: Ed Bartosh <ed bartosh linux intel com>
    Signed-off-by: Ross Burton <ross burton intel com>
    Signed-off-by: Richard Purdie <richard purdie linuxfoundation org>

 scripts/lib/wic/creator.py               |  106 -----------------------------
 scripts/lib/wic/engine.py                |   32 +++++-----
 scripts/lib/wic/plugins/imager/direct.py |  108 +++++++++++-------------------
 scripts/wic                              |    3 +-
 4 files changed, 56 insertions(+), 193 deletions(-)
---
diff --git a/scripts/lib/wic/engine.py b/scripts/lib/wic/engine.py
index 7fb6f13..e27598d 100644
--- a/scripts/lib/wic/engine.py
+++ b/scripts/lib/wic/engine.py
@@ -31,7 +31,7 @@
 import os
 import sys
 
-from wic import msger, creator
+from wic import msger
 from wic.plugin import pluginmgr
 from wic.utils.misc import get_bitbake_var
 
@@ -145,10 +145,10 @@ def list_source_plugins():
         print("  %s" % plugin)
 
 
-def wic_create(wks_file, rootfs_dir, bootimg_dir, kernel_dir,
-               native_sysroot, scripts_path, image_output_dir,
-               compressor, bmap, debug):
-    """Create image
+def wic_create(wks_file, rootfs_dir, bootimg_dir, kernel_dir, native_sysroot,
+               scripts_path, options):
+    """
+    Create image
 
     wks_file - user-defined OE kickstart file
     rootfs_dir - absolute path to the build's /rootfs dir
@@ -157,8 +157,7 @@ def wic_create(wks_file, rootfs_dir, bootimg_dir, kernel_dir,
     native_sysroot - absolute path to the build's native sysroots dir
     scripts_path - absolute path to /scripts dir
     image_output_dir - dirname to create for image
-    compressor - compressor utility to compress the image
-    bmap - enable generation of .bmap
+    options - wic command line options (debug, bmap, etc)
 
     Normally, the values for the build artifacts values are determined
     by 'wic -e' from the output of the 'bitbake -e' command given an
@@ -184,20 +183,21 @@ def wic_create(wks_file, rootfs_dir, bootimg_dir, kernel_dir,
         print("BUILDDIR not found, exiting. (Did you forget to source oe-init-build-env?)")
         sys.exit(1)
 
-    if debug:
+    if options.debug:
         msger.set_loglevel('debug')
 
-    if not os.path.exists(image_output_dir):
-        os.makedirs(image_output_dir)
+    if not os.path.exists(options.outdir):
+        os.makedirs(options.outdir)
 
-    crobj = creator.Creator()
+    pname = 'direct'
+    plugin_class = pluginmgr.get_plugins('imager').get(pname)
+    if not plugin_class:
+        msger.error('Unknown plugin: %s' % pname)
 
-    cmdline = ["direct", native_sysroot, kernel_dir, bootimg_dir, rootfs_dir,
-               wks_file, image_output_dir, oe_builddir, compressor or ""]
-    if bmap:
-        cmdline.append('--bmap')
+    plugin = plugin_class(wks_file, rootfs_dir, bootimg_dir, kernel_dir,
+                          native_sysroot, scripts_path, oe_builddir, options)
 
-    crobj.main(cmdline)
+    plugin.do_create()
 
     print("\nThe image(s) were created using OE kickstart file:\n  %s" % wks_file)
 
diff --git a/scripts/lib/wic/plugins/imager/direct.py b/scripts/lib/wic/plugins/imager/direct.py
index b38e876..ae420a6 100644
--- a/scripts/lib/wic/plugins/imager/direct.py
+++ b/scripts/lib/wic/plugins/imager/direct.py
@@ -39,50 +39,6 @@ from wic.utils.errors import CreatorError, ImageError
 from wic.utils.misc import get_bitbake_var, exec_cmd, exec_native_cmd
 from wic.utils.partitionedfs import Image
 
-class DirectPlugin(ImagerPlugin):
-    """
-    Install a system into a file containing a partitioned disk image.
-
-    An image file is formatted with a partition table, each partition
-    created from a rootfs or other OpenEmbedded build artifact and dd'ed
-    into the virtual disk. The disk image can subsequently be dd'ed onto
-    media and used on actual hardware.
-    """
-
-    name = 'direct'
-
-    @staticmethod
-    def do_create(opts, *args):
-        """
-        Create direct image, called from creator as 'direct' cmd
-        """
-        native_sysroot, kernel_dir, bootimg_dir, rootfs_dir, ksconf, \
-            outdir, oe_builddir, compressor = args
-
-        try:
-            ksobj = KickStart(ksconf)
-        except KickStartError as err:
-            msger.error(str(err))
-
-        name = "%s-%s" % (os.path.splitext(os.path.basename(ksconf))[0],
-                          strftime("%Y%m%d%H%M"))
-
-        # parse possible 'rootfs=name' items
-        krootfs_dir = dict(rdir.split('=') for rdir in rootfs_dir.split(' '))
-
-        creator = DirectImageCreator(name, ksobj, oe_builddir, outdir,
-                                     krootfs_dir, bootimg_dir, kernel_dir,
-                                     native_sysroot, compressor, opts.bmap)
-        try:
-            creator.create()
-            creator.assemble()
-            creator.finalize()
-            creator.print_info()
-        except errors.CreatorError:
-            raise
-        finally:
-            creator.cleanup()
-
 class DiskImage():
     """
     A Disk backed by a file.
@@ -101,43 +57,57 @@ class DiskImage():
 
         self.created = True
 
-class DirectImageCreator:
+class DirectPlugin(ImagerPlugin):
     """
-    Installs a system into a file containing a partitioned disk image.
+    Install a system into a file containing a partitioned disk image.
 
-    DirectImageCreator is an advanced ImageCreator subclass; an image
-    file is formatted with a partition table, each partition created
-    from a rootfs or other OpenEmbedded build artifact and dd'ed into
-    the virtual disk. The disk image can subsequently be dd'ed onto
+    An image file is formatted with a partition table, each partition
+    created from a rootfs or other OpenEmbedded build artifact and dd'ed
+    into the virtual disk. The disk image can subsequently be dd'ed onto
     media and used on actual hardware.
     """
+    name = 'direct'
 
-    def __init__(self, name, ksobj, oe_builddir, outdir,
-                 rootfs_dir, bootimg_dir, kernel_dir,
-                 native_sysroot, compressor, bmap=False):
-        """
-        Initialize a DirectImageCreator instance.
+    def __init__(self, wks_file, rootfs_dir, bootimg_dir, kernel_dir,
+                 native_sysroot, scripts_path, oe_builddir, options):
+        try:
+            self.ks = KickStart(wks_file)
+        except KickStartError as err:
+            msger.error(str(err))
 
-        This method takes the same arguments as ImageCreator.__init__()
-        """
-        self.name = name
-        self.outdir = outdir
-        self.workdir = tempfile.mkdtemp(dir=outdir, prefix='tmp.wic.')
-        self.ks = ksobj
+        # parse possible 'rootfs=name' items
+        self.rootfs_dir = dict(rdir.split('=') for rdir in rootfs_dir.split(' '))
+        self.bootimg_dir = bootimg_dir
+        self.kernel_dir = kernel_dir
+        self.native_sysroot = native_sysroot
+        self.oe_builddir = oe_builddir
 
+        self.outdir = options.outdir
+        self.compressor = options.compressor
+        self.bmap = options.bmap
+
+        self.name = "%s-%s" % (os.path.splitext(os.path.basename(wks_file))[0],
+                               strftime("%Y%m%d%H%M"))
+        self.workdir = tempfile.mkdtemp(dir=self.outdir, prefix='tmp.wic.')
         self._image = None
         self._disks = {}
         self._disk_format = "direct"
         self._disk_names = []
         self.ptable_format = self.ks.bootloader.ptable
 
-        self.oe_builddir = oe_builddir
-        self.rootfs_dir = rootfs_dir
-        self.bootimg_dir = bootimg_dir
-        self.kernel_dir = kernel_dir
-        self.native_sysroot = native_sysroot
-        self.compressor = compressor
-        self.bmap = bmap
+    def do_create(self):
+        """
+        Plugin entry point.
+        """
+        try:
+            self.create()
+            self.assemble()
+            self.finalize()
+            self.print_info()
+        except errors.CreatorError:
+            raise
+        finally:
+            self.cleanup()
 
     def _get_part_num(self, num, parts):
         """calculate the real partition number, accounting for partitions not
@@ -359,7 +329,7 @@ class DirectImageCreator:
             extension = "direct" + {"gzip": ".gz",
                                     "bzip2": ".bz2",
                                     "xz": ".xz",
-                                    "": ""}.get(self.compressor)
+                                    None: ""}.get(self.compressor)
             full_path = self._full_path(self.outdir, disk_name, extension)
             msg += '  %s\n\n' % full_path
 
diff --git a/scripts/wic b/scripts/wic
index 17e8231..8a959a0 100755
--- a/scripts/wic
+++ b/scripts/wic
@@ -250,8 +250,7 @@ def wic_create_subcommand(args, usage_str):
 
     print("Creating image(s)...\n")
     engine.wic_create(wks_file, rootfs_dir, bootimg_dir, kernel_dir,
-                      native_sysroot, scripts_path, options.outdir,
-                      options.compressor, options.bmap, options.debug)
+                      native_sysroot, scripts_path, options)
 
 
 def wic_list_subcommand(args, usage_str):