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

[Sankar Tanguturi]

  Add Image Customization Parser for VMware vSphere Hypervisor Support.

  This is the first changeset submitted as a part of project to
  add cloud-init support for VMware vSphere Hypervisor. This changeset
  contains _only_ the changes for a simple python parser for a
  Image Customization Specification file pushed by VMware vSphere
  hypervisor into the guest VMs. In a later changeset, will be submitting
  another patch to actually detect the underlying VMware vSphere hypervisor
  and do the necessary customization.

[Dan Watkins (daniel-thewatkins)]

Hi Sankar,

Thanks for submitting this change!

I have a few high-level stylistic comments; it would be good if you could address these so it's easier for us to undertake a more in-depth code review:

- there is a decent chunk of commented code in here; this should be removed
- the cloud-init code-base (and Python best practice in general) uses underscored_method_names instead of camelCasedMethodNames
- the documentation for methods and functions should be in a docstring within the code block, not a comment above it
  - additionally, I would suggest that you don't need to document when a callable takes no arguments, throws nothing or returns None; these are reasonable default assumptions

Thanks,

Dan

review: Needs Fixing

[Dan Watkins (daniel-thewatkins)]

Hi Sankar,

On 21/12/15 21:20, Sankar Tanguturi wrote:
> Thanks a lot for your valuable inputs. Is there any python coding style guide that is followed by all cloudinit developers? I can follow that guide and make necessary changes.

Generally, we follow PEP-8[0], which is the generally accepted style
guide for Python code. I would suggest using the pep8 checker[1] to
check if your code meets the requirements. As with all linters, you
don't necessarily need to fix 100% of the problems it raises, but fixing
most of them should get you there. :)

Dan

[0] https://www.python.org/dev/peps/pep-0008/
[1] https://pypi.python.org/pypi/pep8

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

1158. By Sankar Tanguturi <stanguturi@stanguturi-rhel> on 2016-01-05

 Fixed all the styling nits.
 Used proper naming convention for the methods.
 Added proper documentation.
 Checked pep8 and flake8 output and no issues were reported.

[Sankar Tanguturi (sankaraditya)]

Updated the branch with the new code. Waiting for review comments.

Thanks a lot for the help.

[Dan Watkins (daniel-thewatkins)]

Hi Sankar,

Do you have any examples/documentations of the Image Customization Specification that I could refer to while reviewing this? I've tried Googling for it, but there isn't anything obviously canonical, and I want to make sure that I'm looking at the correct thing. :)

In the meantime, I'll do a high-level review to get a handle on everything hangs together.

Thanks,

Dan

[Dan Watkins (daniel-thewatkins)]

OK, here are some more implementation comments. I'll do another pass once I have some specification documentation to compare against. :)

[Sankar Tanguturi (sankaraditya)]

Thanks Daniel. I have updated the code with your review comments. Will update the diff.

[Sankar Tanguturi (sankaraditya)]

Hi,

Thanks a lot for the review comments.

I will update the diff in few minutes. I am attaching an example for the 'customization specification' file (cust.cfg). Can you please check it out.

Thanks
SAT

________________________________________
From: <email address hidden> <email address hidden> on behalf of Dan Watkins <email address hidden>
Sent: Tuesday, January 19, 2016 3:16 AM
To: Sankar Tanguturi
Subject: Re: [Merge] lp:~sankaraditya/cloud-init/topic-stanguturi-vmware-support into lp:cloud-init

Hi Sankar,

Do you have any examples/documentations of the Image Customization Specification that I could refer to while reviewing this? I've tried Googling for it, but there isn't anything obviously canonical, and I want to make sure that I'm looking at the correct thing. :)

In the meantime, I'll do a high-level review to get a handle on everything hangs together.

Thanks,

Dan
--
https://code.launchpad.net/~sankaraditya/cloud-init/topic-stanguturi-vmware-support/+merge/277933
You are the owner of lp:~sankaraditya/cloud-init/topic-stanguturi-vmware-support.

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

1159. By Sankar Tanguturi <stanguturi@stanguturi-rhel> on 2016-01-20

  Fixed all the review comments from Daniel.
  Added a new file i.e. nic_base.py which will be used a base calls for all
  NIC related configuration.
  Modified some code in nic.py.

[Sankar Tanguturi (sankaraditya)]

I couldn't add the 'customization specification' file. I have updated the diff and am pasting the content of a sample 'customization specification' file. Please check it out.

""" cust.cfg file"""

[NETWORK]
NETWORKING = yes
BOOTPROTO = dhcp
HOSTNAME = CENTOS510OSPX64
DOMAINNAME = google.com

[NIC-CONFIG]
NICS = NIC1

[NIC1]
MACADDR = 00:50:56:a7:00:5e
ONBOOT = yes
IPv4_MODE = BACKWARDS_COMPATIBLE
BOOTPROTO = dhcp
GATEWAY = 192.4.5.6
# This is a comment
-abc = def

[DNS]
DNSFROMDHCP=no
SUFFIX|1 = vmware.com
NAMESERVER|1 = 10.20.20.1

[DATETIME]
TIMEZONE = Africa/Abidjan
UTC = yes

"""

[Scott Moser (smoser)]

Sankar,
Thanks for your patience and for your work.

A few minor things:
a.) any information on this format (where it came from, where else it is used... would be good, links to doc would be great)
b.) there is one comment inline.

The next thing is a request.
What you're providing us here is a way to seed networking configuration into cloud-init.
We have other work coming where cloud-init will be able to do this itself so that the user/host/*something* can seed networking information into the system.

So, the request is that
1.) you would in the future when we have that help to port any network-config-rendering code that you provide shortly to re-work onto what we have later.
2.) you can help with that network-config-rendering stuff also.

The last request is just for unit tests.
I realize that this is mostly infrastructure but would be good to have unit tests on it.

Thanks.

[Sankar Tanguturi (sankaraditya)]

Thanks a lot for the review comments.

> a.) any information on this format (where it came from, where else it is used... would be good, links to doc would be great)

I don't have any official documentation to share.

If there is any Guest Customization on a VMware VM, then a specific customization file is pushed inside the guest after the VM comes up. It is usually used only the guest customization and nowhere else. After this patch, I am going to publish another patch which will have all the code to extract, parse and apply the customization.

> b.) there is one comment inline.
Replied to the comment.

> 1.) you would in the future when we have that help to port any network-config-rendering code that you provide shortly to re-work onto what we have later.
> 2.) you can help with that network-config-rendering stuff also.

Sure.

> The last request is just for unit tests.
Can you please let me know in which directory I should include the unit tests?

[Sankar Tanguturi (sankaraditya)]

> canLog depends on the key starting with a '-' or having '|-' ?

This is our way to deliver additional "metadata" with the key. "-" means "confidential". This is a legacy format.

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

1160. By Sankar Tanguturi <stanguturi@stanguturi-rhel> on 2016-02-09

  - Added new Unittests for VMware support.

[Sankar Tanguturi (sankaraditya)]

Thanks for the review. Added new unittests.

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

1161. By Sankar Tanguturi <stanguturi@stanguturi-rhel> on 2016-02-10

  - Added the code to configure the NICs.
  - Added the code to detect VMware Virtual Platform and apply the
    customization based on the 'Customization Specification File' Pushed
    into the guest VM.

[Dan Watkins (daniel-thewatkins)]

review: Needs Fixing

[Sankar Tanguturi (sankaraditya)]

Thanks for the review comments. Will publish the new diff soon.

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

1162. By Sankar Tanguturi <stanguturi@stanguturi-rhel> on 2016-02-17

 - Used proper 4 space indentations for config_nic.py and nic.py
 - Implemented the 'search_file' function using 'os.walk()'
 - Fixed few variable names.
 - Removed size() function in config_file.py
 - Updated the test_config_file.py to use len() instead of .size()

[Sankar Tanguturi (sankaraditya)]

Published the new diff addressing all review comments from Dan Watkins.

Thanks.

[Dan Watkins (daniel-thewatkins)]

A few more notes. Sorry that we're iterating so much on this!

(For future reference; more, smaller merge proposals are much easier and quicker to review :)

review: Needs Fixing

[Sankar Tanguturi (sankaraditya)]

Thanks for the comments. Will update the new diff in few minutes.

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

1163. By Sankar Tanguturi <stanguturi@stanguturi-rhel> on 2016-02-19

 - Removed dmi_data function.
 - Fixed few variable names.
 - Used util.subp methods for process related manipulations.

[Dan Watkins (daniel-thewatkins)]

I'm pretty much happy with this. Thanks for all your work on it!

(I'll wait for smoser to approve before merging :)

review: Approve

=== modified file 'cloudinit/sources/DataSourceOVF.py'
--- cloudinit/sources/DataSourceOVF.py	2015-01-21 22:56:53 +0000
+++ cloudinit/sources/DataSourceOVF.py	2016-02-19 02:34:07 +0000
@@ -24,11 +24,16 @@
 
 import base64
 import os
+import shutil
 import re
+import time
 
 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
 
 LOG = logging.getLogger(__name__)
 
@@ -50,13 +55,46 @@
         found = []
         md = {}
         ud = ""
+        vmwarePlatformFound = False
+        vmwareImcConfigFilePath = ''
 
         defaults = {
             "instance-id": "iid-dsovf",
         }
 
         (seedfile, contents) = get_ovf_env(self.paths.seed_dir)
-        if seedfile:
+
+        system_type = util.read_dmi_data("system-product-name")
+        if system_type is None:
+           LOG.debug("No system-product-name found")
+        elif 'vmware' in system_type.lower():
+            LOG.debug("VMware Virtual Platform found")
+            deployPkgPluginPath = search_file("/usr/lib/vmware-tools", "libdeployPkgPlugin.so")
+            if deployPkgPluginPath:
+                vmwareImcConfigFilePath = util.log_time(logfunc=LOG.debug,
+                                  msg="waiting for configuration file",
+                                  func=wait_for_imc_cfg_file,
+                                  args=("/tmp", "cust.cfg"))
+
+            if vmwareImcConfigFilePath:
+                LOG.debug("Found VMware DeployPkg Config File Path at %s" % vmwareImcConfigFilePath)
+            else:
+                LOG.debug("Didn't find VMware DeployPkg Config File Path")
+
+        if vmwareImcConfigFilePath:
+            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")
+            finally:
+                dirPath = os.path.dirname(vmwareImcConfigFilePath)
+                shutil.rmtree(dirPath)
+        elif seedfile:
             # Found a seed dir
             seed = os.path.join(self.paths.seed_dir, seedfile)
             (md, ud, cfg) = read_ovf_environment(contents)
@@ -76,7 +114,7 @@
                 found.append(name)
 
         # There was no OVF transports found
-        if len(found) == 0:
+        if len(found) == 0 and not vmwarePlatformFound:
             return False
 
         if 'seedfrom' in md and md['seedfrom']:
@@ -108,7 +146,7 @@
 
     def get_public_ssh_keys(self):
         if 'public-keys' not in self.metadata:
-            return []
+           return []
         pks = self.metadata['public-keys']
         if isinstance(pks, (list)):
             return pks
@@ -129,6 +167,31 @@
         self.supported_seed_starts = ("http://", "https://", "ftp://")
 
 
+def wait_for_imc_cfg_file(dirpath, filename, maxwait=180, naplen=5):
+    waited = 0
+    
+    while waited < maxwait:
+        fileFullPath = search_file(dirpath, filename)
+        if fileFullPath:
+            return fileFullPath
+        time.sleep(naplen)
+        waited += naplen
+    return None
+
+# This will return a dict with some content
+#  meta-data, user-data, some config
+def read_vmware_imc(config):
+    md = {}
+    cfg = {}
+    ud = ""
+    if config.host_name:
+       if config.domain_name:
+          md['local-hostname'] = config.host_name + "." + config.domain_name
+       else:
+          md['local-hostname'] = config.host_name
+
+    return (md, ud, cfg)
+
 # This will return a dict with some content
 #  meta-data, user-data, some config
 def read_ovf_environment(contents):
@@ -281,6 +344,16 @@
     return props
 
 
+def search_file(dirpath, filename):
+    if not dirpath or not filename:
+       return None
+
+    for root, dirs, files in os.walk(dirpath):
+        if filename in files:
+            return os.path.join(root, filename)
+
+    return None
+
 class XmlError(Exception):
     pass
 

=== added directory 'cloudinit/sources/helpers/vmware'
=== added file 'cloudinit/sources/helpers/vmware/__init__.py'
--- cloudinit/sources/helpers/vmware/__init__.py	1970-01-01 00:00:00 +0000
+++ cloudinit/sources/helpers/vmware/__init__.py	2016-02-19 02:34:07 +0000
@@ -0,0 +1,13 @@
+# vi: ts=4 expandtab
+#
+#    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/>.

=== added directory 'cloudinit/sources/helpers/vmware/imc'
=== added file 'cloudinit/sources/helpers/vmware/imc/__init__.py'
--- cloudinit/sources/helpers/vmware/imc/__init__.py	1970-01-01 00:00:00 +0000
+++ cloudinit/sources/helpers/vmware/imc/__init__.py	2016-02-19 02:34:07 +0000
@@ -0,0 +1,13 @@
+# vi: ts=4 expandtab
+#
+#    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/>.

=== added file 'cloudinit/sources/helpers/vmware/imc/boot_proto.py'
--- cloudinit/sources/helpers/vmware/imc/boot_proto.py	1970-01-01 00:00:00 +0000
+++ cloudinit/sources/helpers/vmware/imc/boot_proto.py	2016-02-19 02:34:07 +0000
@@ -0,0 +1,25 @@
+# vi: ts=4 expandtab
+#
+#    Copyright (C) 2015 Canonical Ltd.
+#    Copyright (C) 2015 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 BootProtoEnum:
+    """Specifies the NIC Boot Settings."""
+
+    DHCP = 'dhcp'
+    STATIC = 'static'

=== added file 'cloudinit/sources/helpers/vmware/imc/config.py'
--- cloudinit/sources/helpers/vmware/imc/config.py	1970-01-01 00:00:00 +0000
+++ cloudinit/sources/helpers/vmware/imc/config.py	2016-02-19 02:34:07 +0000
@@ -0,0 +1,95 @@
+# vi: ts=4 expandtab
+#
+#    Copyright (C) 2015 Canonical Ltd.
+#    Copyright (C) 2015 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/>.
+
+from .nic import Nic
+
+
+class Config:
+    """
+    Stores the Contents specified in the Customization
+    Specification file.
+    """
+
+    DNS = 'DNS|NAMESERVER|'
+    SUFFIX = 'DNS|SUFFIX|'
+    PASS = 'PASSWORD|-PASS'
+    TIMEZONE = 'DATETIME|TIMEZONE'
+    UTC = 'DATETIME|UTC'
+    HOSTNAME = 'NETWORK|HOSTNAME'
+    DOMAINNAME = 'NETWORK|DOMAINNAME'
+
+    def __init__(self, configFile):
+        self._configFile = configFile
+
+    @property
+    def host_name(self):
+        """Return the hostname."""
+        return self._configFile.get(Config.HOSTNAME, None)
+
+    @property
+    def domain_name(self):
+        """Return the domain name."""
+        return self._configFile.get(Config.DOMAINNAME, None)
+
+    @property
+    def timezone(self):
+        """Return the timezone."""
+        return self._configFile.get(Config.TIMEZONE, None)
+
+    @property
+    def utc(self):
+        """Retrieves whether to set time to UTC or Local."""
+        return self._configFile.get(Config.UTC, None)
+
+    @property
+    def admin_password(self):
+        """Return the root password to be set."""
+        return self._configFile.get(Config.PASS, None)
+
+    @property
+    def name_servers(self):
+        """Return the list of DNS servers."""
+        res = []
+        cnt = self._configFile.get_count_with_prefix(Config.DNS)
+        for i in range(1, cnt + 1):
+            key = Config.DNS + str(i)
+            res.append(self._configFile[key])
+
+        return res
+
+    @property
+    def dns_suffixes(self):
+        """Return the list of DNS Suffixes."""
+        res = []
+        cnt = self._configFile.get_count_with_prefix(Config.SUFFIX)
+        for i in range(1, cnt + 1):
+            key = Config.SUFFIX + str(i)
+            res.append(self._configFile[key])
+
+        return res
+
+    @property
+    def nics(self):
+        """Return the list of associated NICs."""
+        res = []
+        nics = self._configFile['NIC-CONFIG|NICS']
+        for nic in nics.split(','):
+            res.append(Nic(nic, self._configFile))
+
+        return res

=== added file 'cloudinit/sources/helpers/vmware/imc/config_file.py'
--- cloudinit/sources/helpers/vmware/imc/config_file.py	1970-01-01 00:00:00 +0000
+++ cloudinit/sources/helpers/vmware/imc/config_file.py	2016-02-19 02:34:07 +0000
@@ -0,0 +1,129 @@
+# vi: ts=4 expandtab
+#
+#    Copyright (C) 2015 Canonical Ltd.
+#    Copyright (C) 2015 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
+
+try:
+    import configparser
+except ImportError:
+    import ConfigParser as configparser
+
+from .config_source import ConfigSource
+
+logger = logging.getLogger(__name__)
+
+
+class ConfigFile(ConfigSource, dict):
+    """ConfigFile module to load the content from a specified source."""
+
+    def __init__(self, filename):
+        self._loadConfigFile(filename)
+        pass
+
+    def _insertKey(self, key, val):
+        """
+        Inserts a Key Value pair.
+
+        Keyword arguments:
+        key -- The key to insert
+        val -- The value to insert for the key
+
+        """
+        key = key.strip()
+        val = val.strip()
+
+        if key.startswith('-') or '|-' in key:
+            canLog = False
+        else:
+            canLog = True
+
+        # "sensitive" settings shall not be logged
+        if canLog:
+            logger.debug("ADDED KEY-VAL :: '%s' = '%s'" % (key, val))
+        else:
+            logger.debug("ADDED KEY-VAL :: '%s' = '*****************'" % key)
+
+        self[key] = val
+
+    def _loadConfigFile(self, filename):
+        """
+        Parses properties from the specified config file.
+
+        Any previously available properties will be removed.
+        Sensitive data will not be logged in case the key starts
+        from '-'.
+
+        Keyword arguments:
+        filename - The full path to the config file.
+        """
+        logger.info('Parsing the config file %s.' % filename)
+
+        config = configparser.ConfigParser()
+        config.optionxform = str
+        config.read(filename)
+
+        self.clear()
+
+        for category in config.sections():
+            logger.debug("FOUND CATEGORY = '%s'" % category)
+
+            for (key, value) in config.items(category):
+                self._insertKey(category + '|' + key, value)
+
+    def should_keep_current_value(self, key):
+        """
+        Determines whether a value for a property must be kept.
+
+        If the propery is missing, it is treated as it should be not
+        changed by the engine.
+
+        Keyword arguments:
+        key -- The key to search for.
+        """
+        # helps to distinguish from "empty" value which is used to indicate
+        # "removal"
+        return key not in self
+
+    def should_remove_current_value(self, key):
+        """
+        Determines whether a value for the property must be removed.
+
+        If the specified key is empty, it is treated as it should be
+        removed by the engine.
+
+        Return true if the value can be removed, false otherwise.
+
+        Keyword arguments:
+        key -- The key to search for.
+        """
+        # helps to distinguish from "missing" value which is used to indicate
+        # "keeping unchanged"
+        if key in self:
+            return not bool(self[key])
+        else:
+            return False
+
+    def get_count_with_prefix(self, prefix):
+        """
+        Return the total count of keys that start with the specified prefix.
+
+        Keyword arguments:
+        prefix -- prefix of the key
+        """
+        return len([key for key in self if key.startswith(prefix)])

=== added file 'cloudinit/sources/helpers/vmware/imc/config_namespace.py'
--- cloudinit/sources/helpers/vmware/imc/config_namespace.py	1970-01-01 00:00:00 +0000
+++ cloudinit/sources/helpers/vmware/imc/config_namespace.py	2016-02-19 02:34:07 +0000
@@ -0,0 +1,25 @@
+# vi: ts=4 expandtab
+#
+#    Copyright (C) 2015 Canonical Ltd.
+#    Copyright (C) 2015 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/>.
+
+from .config_source import ConfigSource
+
+
+class ConfigNamespace(ConfigSource):
+    """Specifies the Config Namespace."""
+    pass

=== added file 'cloudinit/sources/helpers/vmware/imc/config_nic.py'
--- cloudinit/sources/helpers/vmware/imc/config_nic.py	1970-01-01 00:00:00 +0000
+++ cloudinit/sources/helpers/vmware/imc/config_nic.py	2016-02-19 02:34:07 +0000
@@ -0,0 +1,247 @@
+# vi: ts=4 expandtab
+#
+#    Copyright (C) 2015 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 subprocess
+import re
+
+from cloudinit import util
+
+logger = logging.getLogger(__name__)
+
+
+class NicConfigurator:
+    def __init__(self, nics):
+        """
+        Initialize the Nic Configurator
+        @param nics (list) an array of nics to configure
+        """
+        self.nics = nics
+        self.mac2Name = {}
+        self.ipv4PrimaryGateway = None
+        self.ipv6PrimaryGateway = None
+        self.find_devices()
+        self._primaryNic = self.get_primary_nic()
+
+    def get_primary_nic(self):
+        """
+        Retrieve the primary nic if it exists
+        @return (NicBase): the primary nic if exists, None otherwise
+        """
+        primary_nics = [nic for nic in self.nics if nic.primary]
+        if not primary_nics:
+           return None
+        elif len(primary_nics) > 1:
+           raise Exception('There can only be one primary nic',
+                            [nic.mac for nic in primary_nics])
+        else:
+           return primary_nics[0]
+
+    def find_devices(self):
+        """
+        Create the mac2Name dictionary
+        The mac address(es) are in the lower case
+        """
+        cmd = ['ip', 'addr', 'show']
+        (output, err) = util.subp(cmd)
+        sections = re.split(r'\n\d+: ', '\n' + output)[1:]
+
+        macPat = r'link/ether (([0-9A-Fa-f]{2}[:]){5}([0-9A-Fa-f]{2}))'
+        for section in sections:
+            match = re.search(macPat, section)
+            if not match:  # Only keep info about nics
+                continue
+            mac = match.group(1).lower()
+            name = section.split(':', 1)[0]
+            self.mac2Name[mac] = name
+
+    def gen_one_nic(self, nic):
+        """
+        Return the lines needed to configure a nic
+        @return (str list): the string list to configure the nic
+        @param nic (NicBase): the nic to configure
+        """
+        lines = []
+        name = self.mac2Name.get(nic.mac.lower())
+        if not name:
+            raise ValueError('No known device has MACADDR: %s' % nic.mac)
+
+        if nic.onboot:
+            lines.append('auto %s' % name)
+
+        # Customize IPv4
+        lines.extend(self.gen_ipv4(name, nic))
+
+        # Customize IPv6
+        lines.extend(self.gen_ipv6(name, nic))
+
+        lines.append('')
+
+        return lines
+
+    def gen_ipv4(self, name, nic):
+        """
+        Return the lines needed to configure the IPv4 setting of a nic
+        @return (str list): the string list to configure the gateways
+        @param name (str): name of the nic
+        @param nic (NicBase): the nic to configure
+        """
+        lines = []
+
+        bootproto = nic.bootProto.lower()
+        if nic.ipv4_mode.lower() == 'disabled':
+            bootproto = 'manual'
+        lines.append('iface %s inet %s' % (name, bootproto))
+
+        if bootproto != 'static':
+            return lines
+
+        # Static Ipv4
+        v4 = nic.staticIpv4
+        if v4.ip:
+            lines.append('    address %s' % v4.ip)
+        if v4.netmask:
+            lines.append('    netmask %s' % v4.netmask)
+
+        # Add the primary gateway
+        if nic.primary and v4.gateways:
+            self.ipv4PrimaryGateway = v4.gateways[0]
+            lines.append('    gateway %s metric 0' % self.ipv4PrimaryGateway)
+            return lines
+
+        # Add routes if there is no primary nic
+        if not self._primaryNic:
+            lines.extend(self.gen_ipv4_route(nic, v4.gateways))
+
+        return lines
+
+    def gen_ipv4_route(self, nic, gateways):
+        """
+        Return the lines needed to configure additional Ipv4 route
+        @return (str list): the string list to configure the gateways
+        @param nic (NicBase): the nic to configure
+        @param gateways (str list): the list of gateways
+        """
+        lines = []
+
+        for gateway in gateways:
+            lines.append('    up route add default gw %s metric 10000' %
+                         gateway)
+
+        return lines
+
+    def gen_ipv6(self, name, nic):
+        """
+        Return the lines needed to configure the gateways for a nic
+        @return (str list): the string list to configure the gateways
+        @param name (str): name of the nic
+        @param nic (NicBase): the nic to configure
+        """
+        lines = []
+
+        if not nic.staticIpv6:
+            return lines
+
+        # Static Ipv6
+        addrs = nic.staticIpv6
+        lines.append('iface %s inet6 static' % name)
+        lines.append('    address %s' % addrs[0].ip)
+        lines.append('    netmask %s' % addrs[0].netmask)
+
+        for addr in addrs[1:]:
+            lines.append('    up ifconfig %s inet6 add %s/%s' % (name, addr.ip,
+                                                                 addr.netmask))
+        # Add the primary gateway
+        if nic.primary:
+            for addr in addrs:
+                if addr.gateway:
+                    self.ipv6PrimaryGateway = addr.gateway
+                    lines.append('    gateway %s' % self.ipv6PrimaryGateway)
+                    return lines
+
+        # Add routes if there is no primary nic
+        if not self._primaryNic:
+            lines.extend(self._genIpv6Route(name, nic, addrs))
+
+        return lines
+
+    def _genIpv6Route(self, name, nic, addrs):
+        lines = []
+
+        for addr in addrs:
+            lines.append('    up route -A inet6 add default gw %s metric 10000' %
+                         addr.gateway)
+
+        return lines
+
+    def generate(self):
+        """Return the lines that is needed to configure the nics"""
+        lines = []
+        lines.append('iface lo inet loopback')
+        lines.append('auto lo')
+        lines.append('')
+
+        for nic in self.nics:
+            lines.extend(self.gen_one_nic(nic))
+
+        return lines
+
+    def clear_dhcp(self):
+        logger.info('Clearing DHCP leases')
+
+        util.subp(["pkill", "dhclient"])
+        util.subp(["rm", "-f", "/var/lib/dhcp/*"])
+
+    def if_down_up(self):
+        names = []
+        for nic in self.nics:
+            name = self.mac2Name.get(nic.mac.lower())
+            names.append(name)
+
+        for name in names:
+            logger.info('Bring down interface %s' % name)
+            util.subp(["ifdown", "%s" % name])
+
+        self.clear_dhcp()
+
+        for name in names:
+            logger.info('Bring up interface %s' % name)
+            util.subp(["ifup", "%s" % name])
+
+    def configure(self):
+        """
+        Configure the /etc/network/intefaces
+        Make a back up of the original
+        """
+        containingDir = '/etc/network'
+
+        interfaceFile = os.path.join(containingDir, 'interfaces')
+        originalFile = os.path.join(containingDir,
+                                    'interfaces.before_vmware_customization')
+
+        if not os.path.exists(originalFile) and os.path.exists(interfaceFile):
+            os.rename(interfaceFile, originalFile)
+
+        lines = self.generate()
+        with open(interfaceFile, 'w') as fp:
+            for line in lines:
+                fp.write('%s\n' % line)
+
+        self.if_down_up()

=== added file 'cloudinit/sources/helpers/vmware/imc/config_source.py'
--- cloudinit/sources/helpers/vmware/imc/config_source.py	1970-01-01 00:00:00 +0000
+++ cloudinit/sources/helpers/vmware/imc/config_source.py	2016-02-19 02:34:07 +0000
@@ -0,0 +1,23 @@
+# vi: ts=4 expandtab
+#
+#    Copyright (C) 2015 Canonical Ltd.
+#    Copyright (C) 2015 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 ConfigSource:
+    """Specifies a source for the Config Content."""
+    pass

=== added file 'cloudinit/sources/helpers/vmware/imc/ipv4_mode.py'
--- cloudinit/sources/helpers/vmware/imc/ipv4_mode.py	1970-01-01 00:00:00 +0000
+++ cloudinit/sources/helpers/vmware/imc/ipv4_mode.py	2016-02-19 02:34:07 +0000
@@ -0,0 +1,45 @@
+# vi: ts=4 expandtab
+#
+#    Copyright (C) 2015 Canonical Ltd.
+#    Copyright (C) 2015 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 Ipv4ModeEnum:
+    """
+    The IPv4 configuration mode which directly represents the user's goal.
+
+    This mode effectively acts as a contract of the in-guest customization
+    engine. It must be set based on what the user has requested and should
+    not be changed by those layers. It's up to the in-guest engine to
+    interpret and materialize the user's request.
+    """
+
+    # The legacy mode which only allows dhcp/static based on whether IPv4
+    # addresses list is empty or not
+    IPV4_MODE_BACKWARDS_COMPATIBLE = 'BACKWARDS_COMPATIBLE'
+
+    # IPv4 must use static address. Reserved for future use
+    IPV4_MODE_STATIC = 'STATIC'
+
+    # IPv4 must use DHCPv4. Reserved for future use
+    IPV4_MODE_DHCP = 'DHCP'
+
+    # IPv4 must be disabled
+    IPV4_MODE_DISABLED = 'DISABLED'
+
+    # IPv4 settings should be left untouched. Reserved for future use
+    IPV4_MODE_AS_IS = 'AS_IS'

=== added file 'cloudinit/sources/helpers/vmware/imc/nic.py'
--- cloudinit/sources/helpers/vmware/imc/nic.py	1970-01-01 00:00:00 +0000
+++ cloudinit/sources/helpers/vmware/imc/nic.py	2016-02-19 02:34:07 +0000
@@ -0,0 +1,147 @@
+# vi: ts=4 expandtab
+#
+#    Copyright (C) 2015 Canonical Ltd.
+#    Copyright (C) 2015 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/>.
+
+from .boot_proto import BootProtoEnum
+from .nic_base import NicBase, StaticIpv4Base, StaticIpv6Base
+
+
+class Nic(NicBase):
+    """
+    Holds the information about each NIC specified
+    in the customization specification file
+    """
+
+    def __init__(self, name, configFile):
+        self._name = name
+        self._configFile = configFile
+
+    def _get(self, what):
+        return self._configFile.get(self.name + '|' + what, None)
+
+    def _get_count_with_prefix(self, prefix):
+        return self._configFile.get_count_with_prefix(self.name + prefix)
+
+    @property
+    def name(self):
+        return self._name
+
+    @property
+    def mac(self):
+        return self._get('MACADDR').lower()
+
+    @property
+    def primary(self):
+        value = self._get('PRIMARY')
+        if value:
+            value = value.lower()
+            return value == 'yes' or value == 'true'
+        else:
+            return False
+
+    @property
+    def onboot(self):
+        value = self._get('ONBOOT')
+        if value:
+            value = value.lower()
+            return value == 'yes' or value == 'true'
+        else:
+            return False
+
+    @property
+    def bootProto(self):
+        value = self._get('BOOTPROTO')
+        if value:
+            return value.lower()
+        else:
+            return ""
+
+    @property
+    def ipv4_mode(self):
+        value = self._get('IPv4_MODE')
+        if value:
+            return value.lower()
+        else:
+            return ""
+
+    @property
+    def staticIpv4(self):
+        """
+        Checks the BOOTPROTO property and returns StaticIPv4Addr
+        configuration object if STATIC configuration is set.
+        """
+        if self.bootProto == BootProtoEnum.STATIC:
+            return [StaticIpv4Addr(self)]
+        else:
+            return None
+
+    @property
+    def staticIpv6(self):
+        cnt = self._get_count_with_prefix('|IPv6ADDR|')
+
+        if not cnt:
+            return None
+
+        result = []
+        for index in range(1, cnt + 1):
+            result.append(StaticIpv6Addr(self, index))
+
+        return result
+
+
+class StaticIpv4Addr(StaticIpv4Base):
+    """Static IPV4  Setting."""
+
+    def __init__(self, nic):
+        self._nic = nic
+
+    @property
+    def ip(self):
+        return self._nic._get('IPADDR')
+
+    @property
+    def netmask(self):
+        return self._nic._get('NETMASK')
+
+    @property
+    def gateways(self):
+        value = self._nic._get('GATEWAY')
+        if value:
+            return [x.strip() for x in value.split(',')]
+        else:
+            return None
+
+
+class StaticIpv6Addr(StaticIpv6Base):
+    """Static IPV6 Address."""
+
+    def __init__(self, nic, index):
+        self._nic = nic
+        self._index = index
+
+    @property
+    def ip(self):
+        return self._nic._get('IPv6ADDR|' + str(self._index))
+
+    @property
+    def netmask(self):
+        return self._nic._get('IPv6NETMASK|' + str(self._index))
+
+    @property
+    def gateway(self):
+        return self._nic._get('IPv6GATEWAY|' + str(self._index))

=== added file 'cloudinit/sources/helpers/vmware/imc/nic_base.py'
--- cloudinit/sources/helpers/vmware/imc/nic_base.py	1970-01-01 00:00:00 +0000
+++ cloudinit/sources/helpers/vmware/imc/nic_base.py	2016-02-19 02:34:07 +0000
@@ -0,0 +1,154 @@
+# vi: ts=4 expandtab
+#
+#    Copyright (C) 2015 Canonical Ltd.
+#    Copyright (C) 2015 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 NicBase:
+    """
+    Define what are expected of each nic.
+    The following properties should be provided in an implementation class.
+    """
+
+    @property
+    def mac(self):
+        """
+        Retrieves the mac address of the nic
+        @return (str) : the MACADDR setting
+        """
+        raise NotImplementedError('MACADDR')
+
+    @property
+    def primary(self):
+        """
+        Retrieves whether the nic is the primary nic
+        Indicates whether NIC will be used to define the default gateway.
+        If none of the NICs is configured to be primary, default gateway won't
+        be set.
+        @return (bool): the PRIMARY setting
+        """
+        raise NotImplementedError('PRIMARY')
+
+    @property
+    def onboot(self):
+        """
+        Retrieves whether the nic should be up at the boot time
+        @return (bool) : the ONBOOT setting
+        """
+        raise NotImplementedError('ONBOOT')
+
+    @property
+    def bootProto(self):
+        """
+        Retrieves the boot protocol of the nic
+        @return (str): the BOOTPROTO setting, valid values: dhcp and static.
+        """
+        raise NotImplementedError('BOOTPROTO')
+
+    @property
+    def ipv4_mode(self):
+        """
+        Retrieves the IPv4_MODE
+        @return (str): the IPv4_MODE setting, valid values:
+        backwards_compatible, static, dhcp, disabled, as_is
+        """
+        raise NotImplementedError('IPv4_MODE')
+
+    @property
+    def staticIpv4(self):
+        """
+        Retrieves the static IPv4 configuration of the nic
+        @return (StaticIpv4Base list): the static ipv4 setting
+        """
+        raise NotImplementedError('Static IPv4')
+
+    @property
+    def staticIpv6(self):
+        """
+        Retrieves the IPv6 configuration of the nic
+        @return (StaticIpv6Base list): the static ipv6 setting
+        """
+        raise NotImplementedError('Static Ipv6')
+
+    def validate(self):
+        """
+        Validate the object
+        For example, the staticIpv4 property is required and should not be
+        empty when ipv4Mode is STATIC
+        """
+        raise NotImplementedError('Check constraints on properties')
+
+
+class StaticIpv4Base:
+    """
+    Define what are expected of a static IPv4 setting
+    The following properties should be provided in an implementation class.
+    """
+
+    @property
+    def ip(self):
+        """
+        Retrieves the Ipv4 address
+        @return (str): the IPADDR setting
+        """
+        raise NotImplementedError('Ipv4 Address')
+
+    @property
+    def netmask(self):
+        """
+        Retrieves the Ipv4 NETMASK setting
+        @return (str): the NETMASK setting
+        """
+        raise NotImplementedError('Ipv4 NETMASK')
+
+    @property
+    def gateways(self):
+        """
+        Retrieves the gateways on this Ipv4 subnet
+        @return (str list): the GATEWAY setting
+        """
+        raise NotImplementedError('Ipv4 GATEWAY')
+
+
+class StaticIpv6Base:
+    """Define what are expected of a static IPv6 setting
+    The following properties should be provided in an implementation class.
+    """
+
+    @property
+    def ip(self):
+        """
+        Retrieves the Ipv6 address
+        @return (str): the IPv6ADDR setting
+        """
+        raise NotImplementedError('Ipv6 Address')
+
+    @property
+    def netmask(self):
+        """
+        Retrieves the Ipv6 NETMASK setting
+        @return (str): the IPv6NETMASK setting
+        """
+        raise NotImplementedError('Ipv6 NETMASK')
+
+    @property
+    def gateway(self):
+        """
+        Retrieves the Ipv6 GATEWAY setting
+        @return (str): the IPv6GATEWAY setting
+        """
+        raise NotImplementedError('Ipv6 GATEWAY')

=== added directory 'tests/data/vmware'
=== added file 'tests/data/vmware/cust-dhcp-2nic.cfg'
--- tests/data/vmware/cust-dhcp-2nic.cfg	1970-01-01 00:00:00 +0000
+++ tests/data/vmware/cust-dhcp-2nic.cfg	2016-02-19 02:34:07 +0000
@@ -0,0 +1,34 @@
+[NETWORK]
+NETWORKING = yes
+BOOTPROTO = dhcp
+HOSTNAME = myhost1
+DOMAINNAME = eng.vmware.com
+
+[NIC-CONFIG]
+NICS = NIC1,NIC2
+
+[NIC1]
+MACADDR = 00:50:56:a6:8c:08
+ONBOOT = yes
+IPv4_MODE = BACKWARDS_COMPATIBLE
+BOOTPROTO = dhcp
+
+[NIC2]
+MACADDR = 00:50:56:a6:5a:de
+ONBOOT = yes
+IPv4_MODE = BACKWARDS_COMPATIBLE
+BOOTPROTO = dhcp
+
+# some random comment
+
+[PASSWORD]
+# secret
+-PASS = c2VjcmV0Cg==
+
+[DNS]
+DNSFROMDHCP=yes
+SUFFIX|1 = eng.vmware.com
+
+[DATETIME]
+TIMEZONE = Africa/Abidjan
+UTC = yes

=== added file 'tests/data/vmware/cust-static-2nic.cfg'
--- tests/data/vmware/cust-static-2nic.cfg	1970-01-01 00:00:00 +0000
+++ tests/data/vmware/cust-static-2nic.cfg	2016-02-19 02:34:07 +0000
@@ -0,0 +1,39 @@
+[NETWORK]
+NETWORKING = yes
+BOOTPROTO = dhcp
+HOSTNAME   = myhost1
+DOMAINNAME = eng.vmware.com
+
+[NIC-CONFIG]
+NICS = NIC1,NIC2
+
+[NIC1]
+MACADDR = 00:50:56:a6:8c:08
+ONBOOT = yes
+IPv4_MODE = BACKWARDS_COMPATIBLE
+BOOTPROTO = static
+IPADDR = 10.20.87.154
+NETMASK = 255.255.252.0
+GATEWAY = 10.20.87.253, 10.20.87.105
+IPv6ADDR|1 = fc00:10:20:87::154
+IPv6NETMASK|1 = 64
+IPv6GATEWAY|1 = fc00:10:20:87::253
+[NIC2]
+MACADDR = 00:50:56:a6:ef:7d
+ONBOOT = yes
+IPv4_MODE = BACKWARDS_COMPATIBLE
+BOOTPROTO = static
+IPADDR = 192.168.6.102
+NETMASK = 255.255.0.0
+GATEWAY = 192.168.0.10
+
+[DNS]
+DNSFROMDHCP=no
+SUFFIX|1 = eng.vmware.com
+SUFFIX|2 = proxy.vmware.com
+NAMESERVER|1 = 10.20.145.1
+NAMESERVER|2 = 10.20.145.2
+
+[DATETIME]
+TIMEZONE = Africa/Abidjan
+UTC = yes

=== added file 'tests/unittests/test_vmware_config_file.py'
--- tests/unittests/test_vmware_config_file.py	1970-01-01 00:00:00 +0000
+++ tests/unittests/test_vmware_config_file.py	2016-02-19 02:34:07 +0000
@@ -0,0 +1,103 @@
+# vi: ts=4 expandtab
+#
+#    Copyright (C) 2015 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 sys
+import unittest
+
+from cloudinit.sources.helpers.vmware.imc.boot_proto import BootProtoEnum
+from cloudinit.sources.helpers.vmware.imc.config import Config
+from cloudinit.sources.helpers.vmware.imc.config_file import ConfigFile
+
+logging.basicConfig(level=logging.DEBUG, stream=sys.stdout)
+logger = logging.getLogger(__name__)
+
+
+class TestVmwareConfigFile(unittest.TestCase):
+
+    def test_utility_methods(self):
+        cf = ConfigFile("tests/data/vmware/cust-dhcp-2nic.cfg")
+
+        cf.clear()
+
+        self.assertEqual(0, len(cf), "clear size")
+
+        cf._insertKey("  PASSWORD|-PASS ", "  foo  ")
+        cf._insertKey("BAR", "   ")
+
+        self.assertEqual(2, len(cf), "insert size")
+        self.assertEqual('foo', cf["PASSWORD|-PASS"], "password")
+        self.assertTrue("PASSWORD|-PASS" in cf, "hasPassword")
+        self.assertFalse(cf.should_keep_current_value("PASSWORD|-PASS"),
+                         "keepPassword")
+        self.assertFalse(cf.should_remove_current_value("PASSWORD|-PASS"),
+                         "removePassword")
+        self.assertFalse("FOO" in cf, "hasFoo")
+        self.assertTrue(cf.should_keep_current_value("FOO"), "keepFoo")
+        self.assertFalse(cf.should_remove_current_value("FOO"), "removeFoo")
+        self.assertTrue("BAR" in cf, "hasBar")
+        self.assertFalse(cf.should_keep_current_value("BAR"), "keepBar")
+        self.assertTrue(cf.should_remove_current_value("BAR"), "removeBar")
+
+    def test_configfile_static_2nics(self):
+        cf = ConfigFile("tests/data/vmware/cust-static-2nic.cfg")
+
+        conf = Config(cf)
+
+        self.assertEqual('myhost1', conf.host_name, "hostName")
+        self.assertEqual('Africa/Abidjan', conf.timezone, "tz")
+        self.assertTrue(conf.utc, "utc")
+
+        self.assertEqual(['10.20.145.1', '10.20.145.2'],
+                         conf.name_servers,
+                         "dns")
+        self.assertEqual(['eng.vmware.com', 'proxy.vmware.com'],
+                         conf.dns_suffixes,
+                         "suffixes")
+
+        nics = conf.nics
+        ipv40 = nics[0].staticIpv4
+
+        self.assertEqual(2, len(nics), "nics")
+        self.assertEqual('NIC1', nics[0].name, "nic0")
+        self.assertEqual('00:50:56:a6:8c:08', nics[0].mac, "mac0")
+        self.assertEqual(BootProtoEnum.STATIC, nics[0].bootProto, "bootproto0")
+        self.assertEqual('10.20.87.154', ipv40[0].ip, "ipv4Addr0")
+        self.assertEqual('255.255.252.0', ipv40[0].netmask, "ipv4Mask0")
+        self.assertEqual(2, len(ipv40[0].gateways), "ipv4Gw0")
+        self.assertEqual('10.20.87.253', ipv40[0].gateways[0], "ipv4Gw0_0")
+        self.assertEqual('10.20.87.105', ipv40[0].gateways[1], "ipv4Gw0_1")
+
+        self.assertEqual(1, len(nics[0].staticIpv6), "ipv6Cnt0")
+        self.assertEqual('fc00:10:20:87::154',
+                         nics[0].staticIpv6[0].ip,
+                         "ipv6Addr0")
+
+        self.assertEqual('NIC2', nics[1].name, "nic1")
+        self.assertTrue(not nics[1].staticIpv6, "ipv61 dhcp")
+
+    def test_config_file_dhcp_2nics(self):
+        cf = ConfigFile("tests/data/vmware/cust-dhcp-2nic.cfg")
+
+        conf = Config(cf)
+        nics = conf.nics
+        self.assertEqual(2, len(nics), "nics")
+        self.assertEqual('NIC1', nics[0].name, "nic0")
+        self.assertEqual('00:50:56:a6:8c:08', nics[0].mac, "mac0")
+        self.assertEqual(BootProtoEnum.DHCP, nics[0].bootProto, "bootproto0")