Implementation of blueprint hypervisor-vmware-vsphere-support. (Link to blueprint: https://blueprints.launchpad.net/nova/+spec/hypervisor-vmware-vsphere-support)

Adds support for hypervisor vmware ESX/ESXi server in OpenStack (Nova).

Key features included are,
1) Support for FLAT and VLAN networking model
2) Support for Guest console access through VMware vmrc
3) Integrated with Glance service for image storage and retrival


Documentation: A readme file at "doc/source/vmwareapi_readme.rst" encapsulates configuration/installation instructions required to use this module/feature.

4 files changed, 428 insertions, 0 deletions

diff --git a/nova/tests/test_vmwareapi.py b/nova/tests/test_vmwareapi.py
new file mode 100644
index 000000000..22b66010a
--- /dev/null
+++ b/nova/tests/test_vmwareapi.py
@@ -0,0 +1,252 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4

+

+# Copyright (c) 2011 Citrix Systems, Inc.

+# Copyright 2011 OpenStack LLC.

+#

+#    Licensed under the Apache License, Version 2.0 (the "License"); you may

+#    not use this file except in compliance with the License. You may obtain

+#    a copy of the License at

+#

+#         http://www.apache.org/licenses/LICENSE-2.0

+#

+#    Unless required by applicable law or agreed to in writing, software

+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the

+#    License for the specific language governing permissions and limitations

+#    under the License.

+

+"""

+Test suite for VMWareAPI.

+"""

+

+import stubout

+

+from nova import context

+from nova import db

+from nova import flags

+from nova import test

+from nova import utils

+from nova.auth import manager

+from nova.compute import power_state

+from nova.tests.glance import stubs as glance_stubs

+from nova.tests.vmwareapi import db_fakes

+from nova.tests.vmwareapi import stubs

+from nova.virt import vmwareapi_conn

+from nova.virt.vmwareapi import fake as vmwareapi_fake

+

+

+FLAGS = flags.FLAGS

+

+

+class VMWareAPIVMTestCase(test.TestCase):

+    """Unit tests for Vmware API connection calls."""

+

+    def setUp(self):

+        super(VMWareAPIVMTestCase, self).setUp()

+        self.flags(vmwareapi_host_ip='test_url',

+                   vmwareapi_host_username='test_username',

+                   vmwareapi_host_password='test_pass')

+        self.manager = manager.AuthManager()

+        self.user = self.manager.create_user('fake', 'fake', 'fake',

+                                             admin=True)

+        self.project = self.manager.create_project('fake', 'fake', 'fake')

+        self.network = utils.import_object(FLAGS.network_manager)

+        self.stubs = stubout.StubOutForTesting()

+        vmwareapi_fake.reset()

+        db_fakes.stub_out_db_instance_api(self.stubs)

+        stubs.set_stubs(self.stubs)

+        glance_stubs.stubout_glance_client(self.stubs,

+                                           glance_stubs.FakeGlance)

+        self.conn = vmwareapi_conn.get_connection(False)

+

+    def _create_instance_in_the_db(self):

+        values = {'name': 1,

+                  'id': 1,

+                  'project_id': self.project.id,

+                  'user_id': self.user.id,

+                  'image_id': "1",

+                  'kernel_id': "1",

+                  'ramdisk_id': "1",

+                  'instance_type': 'm1.large',

+                  'mac_address': 'aa:bb:cc:dd:ee:ff',

+                  }

+        self.instance = db.instance_create(values)

+

+    def _create_vm(self):

+        """Create and spawn the VM."""

+        self._create_instance_in_the_db()

+        self.type_data = db.instance_type_get_by_name(None, 'm1.large')

+        self.conn.spawn(self.instance)

+        self._check_vm_record()

+

+    def _check_vm_record(self):

+        """

+        Check if the spawned VM's properties correspond to the instance in

+        the db.

+        """

+        instances = self.conn.list_instances()

+        self.assertEquals(len(instances), 1)

+

+        # Get Nova record for VM

+        vm_info = self.conn.get_info(1)

+

+        # Get record for VM

+        vms = vmwareapi_fake._get_objects("VirtualMachine")

+        vm = vms[0]

+

+        # Check that m1.large above turned into the right thing.

+        mem_kib = long(self.type_data['memory_mb']) << 10

+        vcpus = self.type_data['vcpus']

+        self.assertEquals(vm_info['max_mem'], mem_kib)

+        self.assertEquals(vm_info['mem'], mem_kib)

+        self.assertEquals(vm.get("summary.config.numCpu"), vcpus)

+        self.assertEquals(vm.get("summary.config.memorySizeMB"),

+                          self.type_data['memory_mb'])

+

+        # Check that the VM is running according to Nova

+        self.assertEquals(vm_info['state'], power_state.RUNNING)

+

+        # Check that the VM is running according to vSphere API.

+        self.assertEquals(vm.get("runtime.powerState"), 'poweredOn')

+

+    def _check_vm_info(self, info, pwr_state=power_state.RUNNING):

+        """

+        Check if the get_info returned values correspond to the instance

+        object in the db.

+        """

+        mem_kib = long(self.type_data['memory_mb']) << 10

+        self.assertEquals(info["state"], pwr_state)

+        self.assertEquals(info["max_mem"], mem_kib)

+        self.assertEquals(info["mem"], mem_kib)

+        self.assertEquals(info["num_cpu"], self.type_data['vcpus'])

+

+    def test_list_instances(self):

+        instances = self.conn.list_instances()

+        self.assertEquals(len(instances), 0)

+

+    def test_list_instances_1(self):

+        self._create_vm()

+        instances = self.conn.list_instances()

+        self.assertEquals(len(instances), 1)

+

+    def test_spawn(self):

+        self._create_vm()

+        info = self.conn.get_info(1)

+        self._check_vm_info(info, power_state.RUNNING)

+

+    def test_snapshot(self):

+        self._create_vm()

+        info = self.conn.get_info(1)

+        self._check_vm_info(info, power_state.RUNNING)

+        self.conn.snapshot(self.instance, "Test-Snapshot")

+        info = self.conn.get_info(1)

+        self._check_vm_info(info, power_state.RUNNING)

+

+    def test_snapshot_non_existent(self):

+        self._create_instance_in_the_db()

+        self.assertRaises(Exception, self.conn.snapshot, self.instance,

+                          "Test-Snapshot")

+

+    def test_reboot(self):

+        self._create_vm()

+        info = self.conn.get_info(1)

+        self._check_vm_info(info, power_state.RUNNING)

+        self.conn.reboot(self.instance)

+        info = self.conn.get_info(1)

+        self._check_vm_info(info, power_state.RUNNING)

+

+    def test_reboot_non_existent(self):

+        self._create_instance_in_the_db()

+        self.assertRaises(Exception, self.conn.reboot, self.instance)

+

+    def test_reboot_not_poweredon(self):

+        self._create_vm()

+        info = self.conn.get_info(1)

+        self._check_vm_info(info, power_state.RUNNING)

+        self.conn.suspend(self.instance, self.dummy_callback_handler)

+        info = self.conn.get_info(1)

+        self._check_vm_info(info, power_state.PAUSED)

+        self.assertRaises(Exception, self.conn.reboot, self.instance)

+

+    def test_suspend(self):

+        self._create_vm()

+        info = self.conn.get_info(1)

+        self._check_vm_info(info, power_state.RUNNING)

+        self.conn.suspend(self.instance, self.dummy_callback_handler)

+        info = self.conn.get_info(1)

+        self._check_vm_info(info, power_state.PAUSED)

+

+    def test_suspend_non_existent(self):

+        self._create_instance_in_the_db()

+        self.assertRaises(Exception, self.conn.suspend, self.instance,

+                          self.dummy_callback_handler)

+

+    def test_resume(self):

+        self._create_vm()

+        info = self.conn.get_info(1)

+        self._check_vm_info(info, power_state.RUNNING)

+        self.conn.suspend(self.instance, self.dummy_callback_handler)

+        info = self.conn.get_info(1)

+        self._check_vm_info(info, power_state.PAUSED)

+        self.conn.resume(self.instance, self.dummy_callback_handler)

+        info = self.conn.get_info(1)

+        self._check_vm_info(info, power_state.RUNNING)

+

+    def test_resume_non_existent(self):

+        self._create_instance_in_the_db()

+        self.assertRaises(Exception, self.conn.resume, self.instance,

+                          self.dummy_callback_handler)

+

+    def test_resume_not_suspended(self):

+        self._create_vm()

+        info = self.conn.get_info(1)

+        self._check_vm_info(info, power_state.RUNNING)

+        self.assertRaises(Exception, self.conn.resume, self.instance,

+                          self.dummy_callback_handler)

+

+    def test_get_info(self):

+        self._create_vm()

+        info = self.conn.get_info(1)

+        self._check_vm_info(info, power_state.RUNNING)

+

+    def test_destroy(self):

+        self._create_vm()

+        info = self.conn.get_info(1)

+        self._check_vm_info(info, power_state.RUNNING)

+        instances = self.conn.list_instances()

+        self.assertEquals(len(instances), 1)

+        self.conn.destroy(self.instance)

+        instances = self.conn.list_instances()

+        self.assertEquals(len(instances), 0)

+

+    def test_destroy_non_existent(self):

+        self._create_instance_in_the_db()

+        self.assertEquals(self.conn.destroy(self.instance), None)

+

+    def test_pause(self):

+        pass

+

+    def test_unpause(self):

+        pass

+

+    def test_diagnostics(self):

+        pass

+

+    def test_get_console_output(self):

+        pass

+

+    def test_get_ajax_console(self):

+        pass

+

+    def dummy_callback_handler(self, ret):

+        """

+        Dummy callback function to be passed to suspend, resume, etc., calls.

+        """

+        pass

+

+    def tearDown(self):

+        super(VMWareAPIVMTestCase, self).tearDown()

+        vmwareapi_fake.cleanup()

+        self.manager.delete_project(self.project)

+        self.manager.delete_user(self.user)

+        self.stubs.UnsetAll()

diff --git a/nova/tests/vmwareapi/__init__.py b/nova/tests/vmwareapi/__init__.py
new file mode 100644
index 000000000..478ee742b
--- /dev/null
+++ b/nova/tests/vmwareapi/__init__.py
@@ -0,0 +1,21 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4

+

+# Copyright (c) 2011 Citrix Systems, Inc.

+# Copyright 2011 OpenStack LLC.

+#

+#    Licensed under the Apache License, Version 2.0 (the "License"); you may

+#    not use this file except in compliance with the License. You may obtain

+#    a copy of the License at

+#

+#         http://www.apache.org/licenses/LICENSE-2.0

+#

+#    Unless required by applicable law or agreed to in writing, software

+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the

+#    License for the specific language governing permissions and limitations

+#    under the License.

+

+"""

+:mod:`vmwareapi` -- Stubs for VMware API

+=======================================

+"""

diff --git a/nova/tests/vmwareapi/db_fakes.py b/nova/tests/vmwareapi/db_fakes.py
new file mode 100644
index 000000000..0addd5573
--- /dev/null
+++ b/nova/tests/vmwareapi/db_fakes.py
@@ -0,0 +1,109 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4

+

+# Copyright (c) 2011 Citrix Systems, Inc.

+# Copyright 2011 OpenStack LLC.

+#

+#    Licensed under the Apache License, Version 2.0 (the "License"); you may

+#    not use this file except in compliance with the License. You may obtain

+#    a copy of the License at

+#

+#         http://www.apache.org/licenses/LICENSE-2.0

+#

+#    Unless required by applicable law or agreed to in writing, software

+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the

+#    License for the specific language governing permissions and limitations

+#    under the License.

+

+"""

+Stubouts, mocks and fixtures for the test suite

+"""

+

+import time

+

+from nova import db

+from nova import utils

+

+

+def stub_out_db_instance_api(stubs):

+    """Stubs out the db API for creating Instances."""

+

+    INSTANCE_TYPES = {

+        'm1.tiny': dict(memory_mb=512, vcpus=1, local_gb=0, flavorid=1),

+        'm1.small': dict(memory_mb=2048, vcpus=1, local_gb=20, flavorid=2),

+        'm1.medium':

+            dict(memory_mb=4096, vcpus=2, local_gb=40, flavorid=3),

+        'm1.large': dict(memory_mb=8192, vcpus=4, local_gb=80, flavorid=4),

+        'm1.xlarge':

+            dict(memory_mb=16384, vcpus=8, local_gb=160, flavorid=5)}

+

+    class FakeModel(object):

+        """Stubs out for model."""

+

+        def __init__(self, values):

+            self.values = values

+

+        def __getattr__(self, name):

+            return self.values[name]

+

+        def __getitem__(self, key):

+            if key in self.values:

+                return self.values[key]

+            else:

+                raise NotImplementedError()

+

+    def fake_instance_create(values):

+        """Stubs out the db.instance_create method."""

+

+        type_data = INSTANCE_TYPES[values['instance_type']]

+

+        base_options = {

+            'name': values['name'],

+            'id': values['id'],

+            'reservation_id': utils.generate_uid('r'),

+            'image_id': values['image_id'],

+            'kernel_id': values['kernel_id'],

+            'ramdisk_id': values['ramdisk_id'],

+            'state_description': 'scheduling',

+            'user_id': values['user_id'],

+            'project_id': values['project_id'],

+            'launch_time': time.strftime('%Y-%m-%dT%H:%M:%SZ', time.gmtime()),

+            'instance_type': values['instance_type'],

+            'memory_mb': type_data['memory_mb'],

+            'mac_address': values['mac_address'],

+            'vcpus': type_data['vcpus'],

+            'local_gb': type_data['local_gb'],

+            }

+        return FakeModel(base_options)

+

+    def fake_network_get_by_instance(context, instance_id):

+        """Stubs out the db.network_get_by_instance method."""

+

+        fields = {

+            'bridge': 'vmnet0',

+            'netmask': '255.255.255.0',

+            'gateway': '10.10.10.1',

+            'vlan': 100}

+        return FakeModel(fields)

+

+    def fake_instance_action_create(context, action):

+        """Stubs out the db.instance_action_create method."""

+        pass

+

+    def fake_instance_get_fixed_address(context, instance_id):

+        """Stubs out the db.instance_get_fixed_address method."""

+        return '10.10.10.10'

+

+    def fake_instance_type_get_all(context, inactive=0):

+        return INSTANCE_TYPES

+

+    def fake_instance_type_get_by_name(context, name):

+        return INSTANCE_TYPES[name]

+

+    stubs.Set(db, 'instance_create', fake_instance_create)

+    stubs.Set(db, 'network_get_by_instance', fake_network_get_by_instance)

+    stubs.Set(db, 'instance_action_create', fake_instance_action_create)

+    stubs.Set(db, 'instance_get_fixed_address',

+                fake_instance_get_fixed_address)

+    stubs.Set(db, 'instance_type_get_all', fake_instance_type_get_all)

+    stubs.Set(db, 'instance_type_get_by_name', fake_instance_type_get_by_name)

diff --git a/nova/tests/vmwareapi/stubs.py b/nova/tests/vmwareapi/stubs.py
new file mode 100644
index 000000000..a648efb16
--- /dev/null
+++ b/nova/tests/vmwareapi/stubs.py
@@ -0,0 +1,46 @@
+# vim: tabstop=4 shiftwidth=4 softtabstop=4

+

+# Copyright (c) 2011 Citrix Systems, Inc.

+# Copyright 2011 OpenStack LLC.

+#

+#    Licensed under the Apache License, Version 2.0 (the "License"); you may

+#    not use this file except in compliance with the License. You may obtain

+#    a copy of the License at

+#

+#         http://www.apache.org/licenses/LICENSE-2.0

+#

+#    Unless required by applicable law or agreed to in writing, software

+#    distributed under the License is distributed on an "AS IS" BASIS, WITHOUT

+#    WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the

+#    License for the specific language governing permissions and limitations

+#    under the License.

+

+"""

+Stubouts for the test suite

+"""

+

+from nova.virt import vmwareapi_conn

+from nova.virt.vmwareapi import fake

+from nova.virt.vmwareapi import vmware_images

+

+

+def fake_get_vim_object(arg):

+    """Stubs out the VMWareAPISession's get_vim_object method."""

+    return fake.FakeVim()

+

+

+def fake_is_vim_object(arg, module):

+    """Stubs out the VMWareAPISession's is_vim_object method."""

+    return isinstance(module, fake.FakeVim)

+

+

+def set_stubs(stubs):

+    """Set the stubs."""

+    stubs.Set(vmware_images, 'fetch_image', fake.fake_fetch_image)

+    stubs.Set(vmware_images, 'get_vmdk_size_and_properties',

+              fake.fake_get_vmdk_size_and_properties)

+    stubs.Set(vmware_images, 'upload_image', fake.fake_upload_image)

+    stubs.Set(vmwareapi_conn.VMWareAPISession, "_get_vim_object",

+              fake_get_vim_object)

+    stubs.Set(vmwareapi_conn.VMWareAPISession, "_is_vim_object",

+              fake_is_vim_object)