From 45426d8d38a7224962867ba71f390cce653e0d17 Mon Sep 17 00:00:00 2001
From: Xiaofeng Wang <xiaofengw@vmware.com>
Date: Wed, 11 Sep 2019 18:53:01 +0000
Subject: VMWware: add option into VMTools config to enable/disable custom
 script.

VMWware customization already has support to run a custom script during
the VM customization. Adding this option allows a VM administrator to
disable the execution of customization scripts.  If set the script
will not execute and the customization status is set to
GUESTCUST_ERROR_SCRIPT_DISABLED.
---
 .../sources/helpers/vmware/imc/guestcust_util.py   | 37 ++++++++++++++++++++++
 1 file changed, 37 insertions(+)

(limited to 'cloudinit/sources/helpers/vmware/imc/guestcust_util.py')

diff --git a/cloudinit/sources/helpers/vmware/imc/guestcust_util.py b/cloudinit/sources/helpers/vmware/imc/guestcust_util.py
index a590f323..eb78172e 100644
--- a/cloudinit/sources/helpers/vmware/imc/guestcust_util.py
+++ b/cloudinit/sources/helpers/vmware/imc/guestcust_util.py
@@ -7,6 +7,7 @@
 
 import logging
 import os
+import re
 import time
 
 from cloudinit import util
@@ -117,4 +118,40 @@ def enable_nics(nics):
     logger.warning("Can't connect network interfaces after %d attempts",
                    enableNicsWaitRetries)
 
+
+def get_tools_config(section, key, defaultVal):
+    """ Return the value of [section] key from VMTools configuration.
+
+        @param section: String of section to read from VMTools config
+        @returns: String value from key in [section] or defaultVal if
+                  [section] is not present or vmware-toolbox-cmd is
+                  not installed.
+    """
+
+    if not util.which('vmware-toolbox-cmd'):
+        logger.debug(
+            'vmware-toolbox-cmd not installed, returning default value')
+        return defaultVal
+
+    retValue = defaultVal
+    cmd = ['vmware-toolbox-cmd', 'config', 'get', section, key]
+
+    try:
+        (outText, _) = util.subp(cmd)
+        m = re.match(r'([a-zA-Z0-9 ]+)=(.*)', outText)
+        if m:
+            retValue = m.group(2).strip()
+            logger.debug("Get tools config: [%s] %s = %s",
+                         section, key, retValue)
+        else:
+            logger.debug(
+                "Tools config: [%s] %s is not found, return default value: %s",
+                section, key, retValue)
+    except util.ProcessExecutionError as e:
+        logger.error("Failed running %s[%s]", cmd, e.exit_code)
+        logger.exception(e)
+
+    return retValue
+
+
 # vi: ts=4 expandtab
-- 
cgit v1.2.3


From ecb501b84338f078be18c38c68c3ce87fed3584b Mon Sep 17 00:00:00 2001
From: Xiaofeng Wang <xiaofengw@vmware.com>
Date: Thu, 17 Oct 2019 15:18:44 +0000
Subject: guestcust_util: handle special characters in config file

Handle the special characters when reading VM Tools configure file.
For example, the key and value may contain _, - and . etc.
---
 cloudinit/sources/helpers/vmware/imc/guestcust_util.py | 2 +-
 tests/unittests/test_vmware/test_guestcust_util.py     | 7 +++++++
 2 files changed, 8 insertions(+), 1 deletion(-)

(limited to 'cloudinit/sources/helpers/vmware/imc/guestcust_util.py')

diff --git a/cloudinit/sources/helpers/vmware/imc/guestcust_util.py b/cloudinit/sources/helpers/vmware/imc/guestcust_util.py
index eb78172e..3d369d04 100644
--- a/cloudinit/sources/helpers/vmware/imc/guestcust_util.py
+++ b/cloudinit/sources/helpers/vmware/imc/guestcust_util.py
@@ -138,7 +138,7 @@ def get_tools_config(section, key, defaultVal):
 
     try:
         (outText, _) = util.subp(cmd)
-        m = re.match(r'([a-zA-Z0-9 ]+)=(.*)', outText)
+        m = re.match(r'([^=]+)=(.*)', outText)
         if m:
             retValue = m.group(2).strip()
             logger.debug("Get tools config: [%s] %s = %s",
diff --git a/tests/unittests/test_vmware/test_guestcust_util.py b/tests/unittests/test_vmware/test_guestcust_util.py
index b8fa9942..b175a998 100644
--- a/tests/unittests/test_vmware/test_guestcust_util.py
+++ b/tests/unittests/test_vmware/test_guestcust_util.py
@@ -62,4 +62,11 @@ class TestGuestCustUtil(CiTestCase):
                     get_tools_config('section', 'key', 'defaultVal'),
                     'Bar=Wark')
 
+            # value contains specific characters
+            with mock.patch.object(util, 'subp',
+                                   return_value=('[a] b.c_d=e-f', b'')):
+                self.assertEqual(
+                    get_tools_config('section', 'key', 'defaultVal'),
+                    'e-f')
+
 # vi: ts=4 expandtab
-- 
cgit v1.2.3