Merge lp:~sankaraditya/cloud-init/topic-stanguturi-vmware-support into lp:~cloud-init-dev/cloud-init/trunk

[Sankar Tanguturi]

Send proper SUCCESS / FAILED events to the underlying VMware hypervisor.

Added code to customize timezone.
Added few utility functions to send events to the VMware hypervisor.
Re-factored the code little bit.
Added code to send SUCCESS event when customization succeeds.
Added code to send FAILED event if any error occurs during customization.

Added some utility functions to report some events to the
underlying VMware Virtualization Platform.

[lp:~sankaraditya/cloud-init/topic-stanguturi-vmware-support]

1167. By Sankar Tanguturi <stanguturi@stanguturi-rhel> on 2016-03-10

 - Fixed few issues with return values form util.subp()
 - Added a new utility method to send a RPC for enabling NICS
 - Modified DataSourceOVF.py to enable nics.
 - Executed ./tools/run-pep8 and no issues were reported.

[Sankar Tanguturi (sankaraditya)]

Fixed few issues. Added new utility function. No pep8 errors are reported. Updated the diff. Thanks.

[Scott Moser (smoser)]

some initial comments. have not had time to fully review.

review: Needs Fixing

[Sankar Tanguturi (sankaraditya)]

> some initial comments. have not had time to fully review.
Thanks Scott. I executed 'bzr merge' in my branch and resolved all the conflicts. Do I need to execute 'bzr commit' and 'bzr push' after resolving?

[lp:~sankaraditya/cloud-init/topic-stanguturi-vmware-support]

1168. By Sankar Tanguturi <stanguturi@stanguturi-rhel> on 2016-03-11

- Executed 'bzr merge' and resolved all the conflicts.
- Now my branch is identical to trunk.dist

1169. By Sankar Tanguturi <stanguturi@stanguturi-rhel> on 2016-03-11

 - Fixed few pep8 and flake8 issues.
 - Changed the really long 'from ... import ...' statements.

[Sankar Tanguturi (sankaraditya)]

Fixed the merge issues. Fixed the pep8 and flake8 issues. Updated the diff. Thanks

[lp:~sankaraditya/cloud-init/topic-stanguturi-vmware-support]

1170. By Sankar Tanguturi <stanguturi@stanguturi-rhel> on 2016-03-16

 - Added the code to customize timezone.

=== modified file 'cloudinit/sources/DataSourceOVF.py'
--- cloudinit/sources/DataSourceOVF.py	2016-03-04 06:55:28 +0000
+++ cloudinit/sources/DataSourceOVF.py	2016-03-16 00:29:03 +0000
@@ -31,9 +31,17 @@
 from cloudinit import log as logging
 from cloudinit import sources
 from cloudinit import util
-from cloudinit.sources.helpers.vmware.imc.config import Config
-from cloudinit.sources.helpers.vmware.imc.config_file import ConfigFile
-from cloudinit.sources.helpers.vmware.imc.config_nic import NicConfigurator
+from .helpers.vmware.imc.config import Config
+from .helpers.vmware.imc.config_file import ConfigFile
+from .helpers.vmware.imc.config_nic import NicConfigurator
+from .helpers.vmware.imc.guestcust_event import GuestCustEventEnum
+from .helpers.vmware.imc.guestcust_state import GuestCustStateEnum
+from .helpers.vmware.imc.guestcust_error import GuestCustErrorEnum
+from .helpers.vmware.imc.guestcust_util import (
+    set_customization_status,
+    get_nics_to_enable,
+    enable_nics
+)
 
 LOG = logging.getLogger(__name__)
 
@@ -73,6 +81,9 @@
                     self.sys_cfg, "disable_vmware_customization", True):
                 deployPkgPluginPath = search_file("/usr/lib/vmware-tools",
                                                   "libdeployPkgPlugin.so")
+                if not deployPkgPluginPath:
+                    deployPkgPluginPath = search_file("/usr/lib/open-vm-tools",
+                                                      "libdeployPkgPlugin.so")
                 if deployPkgPluginPath:
                     vmwareImcConfigFilePath = util.log_time(
                         logfunc=LOG.debug,
@@ -88,19 +99,41 @@
                 LOG.debug("Customization for VMware platform is disabled.")
 
         if vmwareImcConfigFilePath:
+            nics = ""
             try:
                 cf = ConfigFile(vmwareImcConfigFilePath)
                 conf = Config(cf)
                 (md, ud, cfg) = read_vmware_imc(conf)
-                nicConfigurator = NicConfigurator(conf.nics)
-                nicConfigurator.configure()
-                vmwarePlatformFound = True
-            except Exception as inst:
-                LOG.debug("Error while parsing the Customization "
-                          "Config File: %s", inst)
+                dirpath = os.path.dirname(vmwareImcConfigFilePath)
+                nics = get_nics_to_enable(dirpath)
+            except Exception as e:
+                LOG.debug("Error parsing the customization Config File")
+                LOG.exception(e)
+                set_customization_status(
+                    GuestCustStateEnum.GUESTCUST_STATE_RUNNING,
+                    GuestCustEventEnum.GUESTCUST_EVENT_CUSTOMIZE_FAILED)
+                return False
             finally:
                 dirPath = os.path.dirname(vmwareImcConfigFilePath)
                 shutil.rmtree(dirPath)
+
+            try:
+                LOG.debug("Applying the Network customization")
+                nicConfigurator = NicConfigurator(conf.nics)
+                nicConfigurator.configure()
+            except Exception as e:
+                LOG.debug("Error applying the Network Configuration")
+                LOG.exception(e)
+                set_customization_status(
+                    GuestCustStateEnum.GUESTCUST_STATE_RUNNING,
+                    GuestCustEventEnum.GUESTCUST_EVENT_NETWORK_SETUP_FAILED)
+                return False
+
+            vmwarePlatformFound = True
+            enable_nics(nics)
+            set_customization_status(
+                GuestCustStateEnum.GUESTCUST_STATE_DONE,
+                GuestCustErrorEnum.GUESTCUST_ERROR_SUCCESS)
         elif seedfile:
             # Found a seed dir
             seed = os.path.join(self.paths.seed_dir, seedfile)
@@ -198,6 +231,9 @@
         else:
             md['local-hostname'] = config.host_name
 
+    if config.timezone:
+        cfg['timezone'] = config.timezone
+
     return (md, ud, cfg)
 
 

=== modified file 'cloudinit/sources/helpers/vmware/imc/config_nic.py'
--- cloudinit/sources/helpers/vmware/imc/config_nic.py	2016-03-03 23:16:13 +0000
+++ cloudinit/sources/helpers/vmware/imc/config_nic.py	2016-03-16 00:29:03 +0000
@@ -205,7 +205,8 @@
     def clear_dhcp(self):
         logger.info('Clearing DHCP leases')
 
-        util.subp(["pkill", "dhclient"])
+        # Ignore the return code 1.
+        util.subp(["pkill", "dhclient"], rcs=[0, 1])
         util.subp(["rm", "-f", "/var/lib/dhcp/*"])
 
     def if_down_up(self):

=== added file 'cloudinit/sources/helpers/vmware/imc/guestcust_error.py'
--- cloudinit/sources/helpers/vmware/imc/guestcust_error.py	1970-01-01 00:00:00 +0000
+++ cloudinit/sources/helpers/vmware/imc/guestcust_error.py	2016-03-16 00:29:03 +0000
@@ -0,0 +1,24 @@
+# vi: ts=4 expandtab
+#
+#    Copyright (C) 2016 Canonical Ltd.
+#    Copyright (C) 2016 VMware Inc.
+#
+#    Author: Sankar Tanguturi <[e-mail]>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License version 3, as
+#    published by the Free Software Foundation.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+class GuestCustErrorEnum:
+    """Specifies different errors of Guest Customization engine"""
+
+    GUESTCUST_ERROR_SUCCESS = 0

=== added file 'cloudinit/sources/helpers/vmware/imc/guestcust_event.py'
--- cloudinit/sources/helpers/vmware/imc/guestcust_event.py	1970-01-01 00:00:00 +0000
+++ cloudinit/sources/helpers/vmware/imc/guestcust_event.py	2016-03-16 00:29:03 +0000
@@ -0,0 +1,27 @@
+# vi: ts=4 expandtab
+#
+#    Copyright (C) 2016 Canonical Ltd.
+#    Copyright (C) 2016 VMware Inc.
+#
+#    Author: Sankar Tanguturi <[e-mail]>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License version 3, as
+#    published by the Free Software Foundation.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+class GuestCustEventEnum:
+    """Specifies different types of Guest Customization Events"""
+
+    GUESTCUST_EVENT_CUSTOMIZE_FAILED = 100
+    GUESTCUST_EVENT_NETWORK_SETUP_FAILED = 101
+    GUESTCUST_EVENT_ENABLE_NICS = 103
+    GUESTCUST_EVENT_QUERY_NICS = 104

=== added file 'cloudinit/sources/helpers/vmware/imc/guestcust_state.py'
--- cloudinit/sources/helpers/vmware/imc/guestcust_state.py	1970-01-01 00:00:00 +0000
+++ cloudinit/sources/helpers/vmware/imc/guestcust_state.py	2016-03-16 00:29:03 +0000
@@ -0,0 +1,25 @@
+# vi: ts=4 expandtab
+#
+#    Copyright (C) 2016 Canonical Ltd.
+#    Copyright (C) 2016 VMware Inc.
+#
+#    Author: Sankar Tanguturi <[e-mail]>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License version 3, as
+#    published by the Free Software Foundation.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+class GuestCustStateEnum:
+    """Specifies different states of Guest Customization engine"""
+
+    GUESTCUST_STATE_RUNNING = 4
+    GUESTCUST_STATE_DONE = 5

=== added file 'cloudinit/sources/helpers/vmware/imc/guestcust_util.py'
--- cloudinit/sources/helpers/vmware/imc/guestcust_util.py	1970-01-01 00:00:00 +0000
+++ cloudinit/sources/helpers/vmware/imc/guestcust_util.py	2016-03-16 00:29:03 +0000
@@ -0,0 +1,128 @@
+# vi: ts=4 expandtab
+#
+#    Copyright (C) 2016 Canonical Ltd.
+#    Copyright (C) 2016 VMware Inc.
+#
+#    Author: Sankar Tanguturi <[e-mail]>
+#
+#    This program is free software: you can redistribute it and/or modify
+#    it under the terms of the GNU General Public License version 3, as
+#    published by the Free Software Foundation.
+#
+#    This program is distributed in the hope that it will be useful,
+#    but WITHOUT ANY WARRANTY; without even the implied warranty of
+#    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+#    GNU General Public License for more details.
+#
+#    You should have received a copy of the GNU General Public License
+#    along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import logging
+import os
+import time
+
+from cloudinit import util
+
+from .guestcust_state import GuestCustStateEnum
+from .guestcust_event import GuestCustEventEnum
+
+logger = logging.getLogger(__name__)
+
+
+CLOUDINIT_LOG_FILE = "/var/log/cloud-init.log"
+QUERY_NICS_SUPPORTED = "queryNicsSupported"
+NICS_STATUS_CONNECTED = "connected"
+
+
+# This will send a RPC command to the underlying
+# VMware Virtualization Platform.
+def send_rpc(rpc):
+    if not rpc:
+        return None
+
+    out = ""
+    err = "Error sending the RPC command"
+
+    try:
+        logger.debug("Sending RPC command: %s", rpc)
+        (out, err) = util.subp(["vmware-rpctool", rpc], rcs=[0])
+        # Remove the trailing newline in the output.
+        if out:
+            out = out.rstrip()
+    except Exception as e:
+        logger.debug("Failed to send RPC command")
+        logger.exception(e)
+
+    return (out, err)
+
+
+# This will send the customization status to the
+# underlying VMware Virtualization Platform.
+def set_customization_status(custstate, custerror, errormessage=None):
+    message = ""
+
+    if errormessage:
+        message = CLOUDINIT_LOG_FILE + "@" + errormessage
+    else:
+        message = CLOUDINIT_LOG_FILE
+
+    rpc = "deployPkg.update.state %d %d %s" % (custstate, custerror, message)
+    (out, err) = send_rpc(rpc)
+    return (out, err)
+
+
+# This will read the file nics.txt in the specified directory
+# and return the content
+def get_nics_to_enable(dirpath):
+    if not dirpath:
+        return None
+
+    NICS_SIZE = 1024
+    nicsfilepath = os.path.join(dirpath, "nics.txt")
+    if not os.path.exists(nicsfilepath):
+        return None
+
+    with open(nicsfilepath, 'r') as fp:
+        nics = fp.read(NICS_SIZE)
+
+    return nics
+
+
+# This will send a RPC command to the underlying VMware Virtualization platform
+# and enable nics.
+def enable_nics(nics):
+    if not nics:
+        logger.warning("No Nics found")
+        return
+
+    enableNicsWaitRetries = 5
+    enableNicsWaitCount = 5
+    enableNicsWaitSeconds = 1
+
+    for attempt in range(0, enableNicsWaitRetries):
+        logger.debug("Trying to connect interfaces, attempt %d", attempt)
+        (out, err) = set_customization_status(
+            GuestCustStateEnum.GUESTCUST_STATE_RUNNING,
+            GuestCustEventEnum.GUESTCUST_EVENT_ENABLE_NICS,
+            nics)
+        if not out:
+            time.sleep(enableNicsWaitCount * enableNicsWaitSeconds)
+            continue
+
+        if out != QUERY_NICS_SUPPORTED:
+            logger.warning("NICS connection status query is not supported")
+            return
+
+        for count in range(0, enableNicsWaitCount):
+            (out, err) = set_customization_status(
+                GuestCustStateEnum.GUESTCUST_STATE_RUNNING,
+                GuestCustEventEnum.GUESTCUST_EVENT_QUERY_NICS,
+                nics)
+            if out and out == NICS_STATUS_CONNECTED:
+                logger.info("NICS are connected on %d second", count)
+                return
+
+            time.sleep(enableNicsWaitSeconds)
+
+    logger.warning("Can't connect network interfaces after %d attempts",
+                   enableNicsWaitRetries)