- Ignored return code 1 for 'pkill' command in config_nic.py

 - Added few utility functions to report events to the underlying
   VMware Virtualization platform
 - Re-factored code little bit.
 - Executed ./tools/run-pep8 and no pep8 errors were reported.

5 files changed, 163 insertions, 6 deletions

diff --git a/cloudinit/sources/helpers/vmware/imc/config_nic.py b/cloudinit/sources/helpers/vmware/imc/config_nic.py
index 172a1649..42fbcc7e 100644
--- a/cloudinit/sources/helpers/vmware/imc/config_nic.py
+++ b/cloudinit/sources/helpers/vmware/imc/config_nic.py
@@ -47,12 +47,12 @@ class NicConfigurator:
         """
         primary_nics = [nic for nic in self.nics if nic.primary]
         if not primary_nics:
-           return None
+            return None
         elif len(primary_nics) > 1:
-           raise Exception('There can only be one primary nic',
+            raise Exception('There can only be one primary nic',
                             [nic.mac for nic in primary_nics])
         else:
-           return primary_nics[0]
+            return primary_nics[0]
 
     def find_devices(self):
         """
@@ -186,8 +186,9 @@ class NicConfigurator:
         lines = []
 
         for addr in addrs:
-            lines.append('    up route -A inet6 add default gw %s metric 10000' %
-                         addr.gateway)
+            lines.append(
+                     '    up route -A inet6 add default gw %s metric 10000' %
+                     addr.gateway)
 
         return lines
 
@@ -206,7 +207,8 @@ class NicConfigurator:
     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):
diff --git a/cloudinit/sources/helpers/vmware/imc/guestcust_error.py b/cloudinit/sources/helpers/vmware/imc/guestcust_error.py
new file mode 100644
index 00000000..1b04161f
--- /dev/null
+++ b/cloudinit/sources/helpers/vmware/imc/guestcust_error.py
@@ -0,0 +1,24 @@
+# vi: ts=4 expandtab

+#

+#    Copyright (C) 2016 Canonical Ltd.

+#    Copyright (C) 2016 VMware Inc.

+#

+#    Author: Sankar Tanguturi <stanguturi@vmware.com>

+#

+#    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

diff --git a/cloudinit/sources/helpers/vmware/imc/guestcust_event.py b/cloudinit/sources/helpers/vmware/imc/guestcust_event.py
new file mode 100644
index 00000000..fc22568f
--- /dev/null
+++ b/cloudinit/sources/helpers/vmware/imc/guestcust_event.py
@@ -0,0 +1,27 @@
+# vi: ts=4 expandtab

+#

+#    Copyright (C) 2016 Canonical Ltd.

+#    Copyright (C) 2016 VMware Inc.

+#

+#    Author: Sankar Tanguturi <stanguturi@vmware.com>

+#

+#    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

diff --git a/cloudinit/sources/helpers/vmware/imc/guestcust_state.py b/cloudinit/sources/helpers/vmware/imc/guestcust_state.py
new file mode 100644
index 00000000..f255be5f
--- /dev/null
+++ b/cloudinit/sources/helpers/vmware/imc/guestcust_state.py
@@ -0,0 +1,25 @@
+# vi: ts=4 expandtab

+#

+#    Copyright (C) 2016 Canonical Ltd.

+#    Copyright (C) 2016 VMware Inc.

+#

+#    Author: Sankar Tanguturi <stanguturi@vmware.com>

+#

+#    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

diff --git a/cloudinit/sources/helpers/vmware/imc/guestcust_util.py b/cloudinit/sources/helpers/vmware/imc/guestcust_util.py
new file mode 100644
index 00000000..2466a47e
--- /dev/null
+++ b/cloudinit/sources/helpers/vmware/imc/guestcust_util.py
@@ -0,0 +1,79 @@
+# vi: ts=4 expandtab

+#

+#    Copyright (C) 2016 Canonical Ltd.

+#    Copyright (C) 2016 VMware Inc.

+#

+#    Author: Sankar Tanguturi <stanguturi@vmware.com>

+#

+#    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

+

+from cloudinit import util

+

+

+logger = logging.getLogger(__name__)

+

+

+CLOUDINIT_LOG_FILE = "/var/log/cloud-init.log"

+

+

+# This will send a RPC command to the underlying

+# VMware Virtualization Platform.

+def send_rpc(rpc):

+    if not rpc:

+        return None

+

+    rc = 1

+    output = "Error sending the RPC command"

+

+    try:

+        logger.debug("Sending RPC command: %s", rpc)

+        (rc, output) = util.subp(["vmware-rpctool", rpc], rcs=[0])

+    except Exception as e:

+        logger.debug("Failed to send RPC command")

+        logger.exception(e)

+

+    return (rc, output)

+

+

+# 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)

+    (rc, output) = send_rpc(rpc)

+

+

+# 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