nova-docker/novadocker/tests/virt/docker/test_driver.py

584 lines
26 KiB
Python

# Copyright (c) 2013 dotCloud, Inc.
# All Rights Reserved.
#
# 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.
import contextlib
import os
import socket
import eventlet
import mock
from oslo_config import cfg
from oslo_config import fixture as config_fixture
from oslo_utils import units
from nova.compute import manager
from nova.compute import task_states
from nova import context
from nova import exception
from nova import test
import nova.tests.unit.image.fake
from nova.tests.unit import matchers
from nova.tests.unit import utils
from nova.tests.unit.virt import test_virt_drivers
from novadocker.tests.virt.docker import mock_client
import novadocker.virt.docker
from novadocker.virt.docker import driver as docker_driver
from novadocker.virt.docker import hostinfo
from novadocker.virt.docker import network
class DockerDriverTestCase(test_virt_drivers._VirtDriverTestCase,
test.TestCase):
driver_module = 'novadocker.virt.docker.DockerDriver'
def setUp(self):
super(DockerDriverTestCase, self).setUp()
self.mock_client = mock_client.MockClient()
self.stubs.Set(novadocker.virt.docker.driver.DockerDriver, 'docker',
self.mock_client)
def fake_plug_vifs(self, instance, network_info):
return
self.stubs.Set(novadocker.virt.docker.driver.DockerDriver,
'plug_vifs',
fake_plug_vifs)
def fake_attach_vifs(self, instance, network_info):
return
self.stubs.Set(novadocker.virt.docker.driver.DockerDriver,
'_attach_vifs',
fake_attach_vifs)
# Note: using mock.object.path on class throws
# errors in test_virt_drivers
def fake_teardown_network(container_id):
return
self.stubs.Set(network, 'teardown_network', fake_teardown_network)
self.context = context.RequestContext('fake_user', 'fake_project')
self.connection.init_host(None)
self.fixture = self.useFixture(
config_fixture.Config(novadocker.virt.docker.driver.CONF))
def test_live_migration(self):
self.skipTest('Live migration is not implemented.')
def test_driver_capabilities(self):
self.assertFalse(self.connection.capabilities['has_imagecache'])
self.assertFalse(self.connection.capabilities['supports_recreate'])
# NOTE(bcwaldon): This exists only because _get_running_instance on the
# base class will not let us set a custom disk/container_format.
def _get_running_instance(self, obj=True):
instance_ref = utils.get_test_instance(obj=obj)
network_info = utils.get_test_network_info()
network_info[0]['network']['subnets'][0]['meta']['dhcp_server'] = \
'1.1.1.1'
image_info = utils.get_test_image_object(None, instance_ref)
image_info.disk_format = 'raw'
image_info.container_format = 'docker'
self.connection.spawn(self.ctxt, instance_ref, image_info,
[], 'herp', network_info=network_info)
return instance_ref, network_info
@mock.patch.object(hostinfo, 'get_total_vcpus', return_value=1)
@mock.patch.object(hostinfo, 'get_vcpus_used', return_value=0)
def test_get_host_stats(self, mock_total, mock_used):
memory = {
'total': 4 * units.Mi,
'used': 1 * units.Mi
}
self.mox.StubOutWithMock(socket, 'gethostname')
self.mox.StubOutWithMock(hostinfo, 'get_memory_usage')
socket.gethostname().AndReturn('foo')
hostinfo.get_memory_usage().AndReturn(memory)
socket.gethostname().AndReturn('bar')
hostinfo.get_memory_usage().AndReturn(memory)
self.mox.ReplayAll()
self.assertEqual('foo',
self.connection.get_host_stats()['host_hostname'])
self.assertEqual('foo',
self.connection.get_host_stats()['host_hostname'])
def test_get_available_resource(self):
memory = {
'total': 4 * units.Mi,
'used': 1 * units.Mi
}
disk = {
'total': 50 * units.Gi,
'available': 25 * units.Gi,
'used': 25 * units.Gi
}
# create the mocks
with contextlib.nested(
mock.patch.object(hostinfo, 'get_total_vcpus',
return_value=1),
mock.patch.object(hostinfo, 'get_vcpus_used',
return_value=0),
mock.patch.object(hostinfo, 'get_memory_usage',
return_value=memory),
mock.patch.object(hostinfo, 'get_disk_usage',
return_value=disk)
) as (
get_total_vcpus,
get_vcpus_used,
get_memory_usage,
get_disk_usage
):
# run the code
stats = self.connection.get_available_resource(nodename='test')
# make our assertions
get_memory_usage.assert_called_once_with()
get_disk_usage.assert_called_once_with()
expected_stats = {
'vcpus': 1,
'vcpus_used': 0,
'memory_mb': 4,
'memory_mb_used': 1,
'local_gb': 50L,
'local_gb_used': 25L,
'disk_available_least': 25L,
'hypervisor_type': 'docker',
'hypervisor_version': 1000,
'hypervisor_hostname': 'test',
'cpu_info': '?',
'numa_topology': None,
'supported_instances': [("i686", "docker", "exe"),
("x86_64", "docker", "exe")]
}
self.assertEqual(expected_stats, stats)
def _test_start_container_with_network_events(self, neutron_failure=None):
generated_events = []
def wait_timeout():
event = mock.MagicMock()
if neutron_failure == 'timeout':
raise eventlet.timeout.Timeout()
elif neutron_failure == 'error':
event.status = 'failed'
else:
event.status = 'completed'
return event
def fake_prepare(instance, event_name):
m = mock.MagicMock()
m.instance = instance
m.event_name = event_name
m.wait.side_effect = wait_timeout
generated_events.append(m)
return m
virtapi = manager.ComputeVirtAPI(mock.MagicMock())
prepare = virtapi._compute.instance_events.prepare_for_instance_event
prepare.side_effect = fake_prepare
drvr = novadocker.virt.docker.driver.DockerDriver(virtapi)
instance_href = utils.get_test_instance()
container_id = self.connection._find_container_by_uuid(
instance_href['uuid']).get('id')
vifs = [{'id': 'vif1', 'active': False},
{'id': 'vif2', 'active': False}]
@mock.patch.object(drvr, '_extract_dns_entries')
@mock.patch.object(drvr, 'plug_vifs')
@mock.patch.object(drvr, '_attach_vifs')
@mock.patch.object(self.mock_client, 'start')
@mock.patch.object(self.mock_client, 'kill')
@mock.patch.object(self.mock_client, 'remove_container')
def test_start(remove_container, kill, start, attach_vif, plug_vifs,
extract_dns_entries):
drvr._start_container(container_id, instance_href,
vifs)
plug_vifs.assert_called_with(instance_href, vifs)
attach_vif.assert_called_with(instance_href, vifs)
if neutron_failure and cfg.CONF.vif_plugging_is_fatal:
kill.assert_called_once_with(container_id)
remove_container.assert_called_once_with(container_id,
Force=True)
test_start()
if nova.utils.is_neutron() and cfg.CONF.vif_plugging_timeout:
prepare.assert_has_calls([
mock.call(instance_href, 'network-vif-plugged-vif1'),
mock.call(instance_href, 'network-vif-plugged-vif2')])
for event in generated_events:
if neutron_failure and generated_events.index(event) != 0:
self.assertEqual(0, event.call_count)
else:
self.assertEqual(0, prepare.call_count)
@mock.patch('nova.utils.is_neutron', return_value=True)
def test_start_container_with_network_events(self, is_neutron):
self._test_start_container_with_network_events()
@mock.patch('nova.utils.is_neutron', return_value=True)
def test_start_container_with_network_events_nowait(self, is_neutron):
self.flags(vif_plugging_timeout=0)
self._test_start_container_with_network_events()
@mock.patch('nova.utils.is_neutron', return_value=True)
def test_start_container_with_network_events_failed_timeout_non_fatal(
self, is_neutron):
self.flags(vif_plugging_is_fatal=False)
self._test_start_container_with_network_events(
neutron_failure='timeout')
@mock.patch('nova.utils.is_neutron', return_value=True)
def test_start_container_with_network_events_failed_timeout_fatal(
self, is_neutron):
self.assertRaises(exception.InstanceDeployFailure,
self._test_start_container_with_network_events,
neutron_failure='timeout')
@mock.patch('nova.utils.is_neutron', return_value=True)
def test_start_container_with_network_events_failed_error_non_fatal(
self, is_neutron):
self.flags(vif_plugging_is_fatal=False)
self._test_start_container_with_network_events(
neutron_failure='error')
@mock.patch('nova.utils.is_neutron', return_value=True)
def test_start_container_with_network_events_failed_error_fatal(
self, is_neutron):
self.assertRaises(exception.InstanceDeployFailure,
self._test_start_container_with_network_events,
neutron_failure='error')
@mock.patch('nova.utils.is_neutron', return_value=False)
def test_start_container_with_network_events_non_neutron(self,
is_neutron):
self._test_start_container_with_network_events()
def test_create_container(self, image_info=None, instance_href=None,
network_info=None):
if instance_href is None:
instance_href = utils.get_test_instance()
if image_info is None:
image_info = utils.get_test_image_object(None, instance_href)
image_info.disk_format = 'raw'
image_info.container_format = 'docker'
self.connection.spawn(self.context, instance_href, image_info,
'fake_files', 'fake_password',
network_info=network_info)
self._assert_cpu_shares(instance_href)
self.assertEqual(self.mock_client.name, "nova-{0}".format(
instance_href['uuid']))
def test_create_container_empty_cmd(self, image_info=None,
instance_href=None,
network_info=None):
if instance_href is None:
instance_href = utils.get_test_instance()
if image_info is None:
image_info = utils.get_test_image_object(None, instance_href)
image_info.disk_format = 'raw'
image_info.container_format = 'docker'
with mock.patch.object(self.mock_client, 'create_container') as mc:
self.connection.spawn(self.context, instance_href, image_info,
'fake_files', 'fake_password',
network_info=network_info)
self.assertIsNone(mc.call_args[1].get('command'))
@mock.patch.object(novadocker.virt.docker.driver.DockerDriver,
'_inject_key', return_value='/tmp/.ssh')
def test_create_container_inject_key(self, mock_inject_key):
self.fixture.config(inject_key=True, group='docker')
instance_href = utils.get_test_instance()
instance_href.key_data = 'my_key'
image_info = utils.get_test_image_object(None, instance_href)
image_info.disk_format = 'raw'
image_info.container_format = 'docker'
with mock.patch.object(self.mock_client, 'create_container'):
with mock.patch.object(self.mock_client, 'start') as ms:
self.connection.spawn(self.context, instance_href, image_info,
'fake_files', 'fake_password',
network_info=None)
command = ms.call_args[1]
expected = {'binds': {'/tmp/.ssh':
{'bind': '/root/.ssh', 'ro': True}},
'dns': None,
'privileged': False}
self.assertEqual(expected, command)
def test_create_container_glance_cmd(self, image_info=None,
instance_href=None,
network_info=None):
if instance_href is None:
instance_href = utils.get_test_instance()
if image_info is None:
image_info = utils.get_test_image_object(None, instance_href)
image_info.disk_format = 'raw'
image_info.container_format = 'docker'
image_info.properties.os_command_line = 'uname'
with mock.patch.object(self.mock_client, 'create_container') as mc:
self.connection.spawn(self.context, instance_href, image_info,
'fake_files', 'fake_password',
network_info=network_info)
command = mc.call_args[1]['command']
self.assertEqual('uname', command)
def test_create_container_vcpus_2(self, image_info=None):
flavor = utils.get_test_flavor(options={
'name': 'vcpu_2',
'flavorid': 'vcpu_2',
'vcpus': 2
})
instance_href = utils.get_test_instance(flavor=flavor)
if image_info is None:
image_info = utils.get_test_image_object(None, instance_href)
image_info.disk_format = 'raw'
image_info.container_format = 'docker'
self.connection.spawn(self.context, instance_href, image_info,
'fake_files', 'fake_password')
self._assert_cpu_shares(instance_href, vcpus=2)
self.assertEqual(self.mock_client.name, "nova-{0}".format(
instance_href['uuid']))
def _assert_cpu_shares(self, instance_href, vcpus=4):
container_id = self.connection._find_container_by_uuid(
instance_href['uuid']).get('id')
container_info = self.connection.docker.inspect_container(container_id)
self.assertEqual(vcpus * 1024, container_info['Config']['CpuShares'])
@mock.patch('novadocker.virt.docker.driver.DockerDriver.plug_vifs',
side_effect=Exception)
def test_create_container_net_setup_fails(self, mock_plug_vifs):
self.assertRaises(exception.InstanceDeployFailure,
self.test_create_container,
network_info=utils.get_test_network_info())
self.assertEqual(0, len(self.mock_client.containers()))
def test_create_container_wrong_image(self):
instance_href = utils.get_test_instance()
image_info = utils.get_test_image_object(None, instance_href)
image_info.disk_format = 'raw'
image_info.container_format = 'invalid_format'
self.assertRaises(exception.InstanceDeployFailure,
self.test_create_container,
image_info, instance_href)
@mock.patch.object(novadocker.virt.docker.driver.DockerDriver,
'cleanup')
@mock.patch.object(novadocker.virt.docker.driver.DockerDriver,
'_find_container_by_uuid',
return_value={'id': 'fake_id'})
def test_destroy_container(self, byuuid_mock, cleanup_mock):
instance = utils.get_test_instance()
self.connection.destroy(self.context, instance, 'fake_networkinfo')
cleanup_mock.assert_called_with(self.context, instance,
'fake_networkinfo', None, True)
@mock.patch.object(network, 'teardown_network')
@mock.patch.object(novadocker.virt.docker.driver.DockerDriver,
'unplug_vifs')
@mock.patch.object(novadocker.virt.docker.driver.DockerDriver,
'_find_container_by_uuid',
return_value={'id': 'fake_id'})
def test_cleanup_container(self, byuuid_mock, unplug_mock, teardown_mock):
instance = utils.get_test_instance()
self.connection.cleanup(self.context, instance, 'fake_networkinfo')
byuuid_mock.assert_called_with(instance['uuid'])
teardown_mock.assert_called_with('fake_id')
@mock.patch.object(novadocker.virt.docker.driver.DockerDriver,
'unplug_vifs')
@mock.patch.object(novadocker.virt.docker.driver.DockerDriver,
'_find_container_by_uuid',
return_value={})
def test_cleanup_container_notfound(self, byuuid_mock, unplug_mock):
instance = utils.get_test_instance()
self.connection.cleanup(self.context, instance, 'fake_networkinfo')
byuuid_mock.assert_called_with(instance['uuid'])
unplug_mock.assert_called_once_with(instance, 'fake_networkinfo')
def test_soft_delete_restore_container(self):
instance_href = utils.get_test_instance()
image_info = utils.get_test_image_object(None, instance_href)
image_info.disk_format = 'raw'
image_info.container_format = 'docker'
self.connection.spawn(self.context, instance_href, image_info,
'fake_files', 'fake_password')
container_id = self.connection._find_container_by_uuid(
instance_href['uuid']).get('id')
self.connection.soft_delete(instance_href)
info = self.connection.docker.inspect_container(container_id)
self.assertFalse(info['State']['Running'])
self.connection.restore(instance_href)
info = self.connection.docker.inspect_container(container_id)
self.assertTrue(info['State']['Running'])
def test_get_memory_limit_from_sys_meta_in_object(self):
instance = utils.get_test_instance(obj=True)
limit = self.connection._get_memory_limit_bytes(instance)
self.assertEqual(512 * units.Mi, limit)
def test_get_memory_limit_from_sys_meta_in_db_instance(self):
instance = utils.get_test_instance(obj=False)
limit = self.connection._get_memory_limit_bytes(instance)
self.assertEqual(2048 * units.Mi, limit)
def test_list_instances(self):
instance_href = utils.get_test_instance()
image_info = utils.get_test_image_object(None, instance_href)
image_info.disk_format = 'raw'
image_info.container_format = 'docker'
self.connection.spawn(self.context, instance_href, image_info,
'fake_files', 'fake_password')
instances = self.connection.list_instances()
self.assertIn(instance_href.name, instances)
def test_list_instances_none(self):
instances = self.connection.list_instances()
self.assertIsInstance(instances, list)
self.assertFalse(instances)
def test_list_instances_no_inspect_race(self):
"""Assures containers that cannot be inspected are not listed."""
instance_href = utils.get_test_instance()
image_info = utils.get_test_image_object(None, instance_href)
image_info.disk_format = 'raw'
image_info.container_format = 'docker'
self.connection.spawn(self.context, instance_href, image_info,
'fake_files', 'fake_password')
with mock.patch.object(self.mock_client, 'inspect_container',
return_value={}):
instances = self.connection.list_instances()
self.assertFalse(instances)
def test_find_container_pid(self):
driver = novadocker.virt.docker.driver.DockerDriver(None)
with mock.patch.object(driver.docker,
"inspect_container") as inspect_container:
inspect_container.return_value = {'State': {'Pid': '12345'}}
pid = driver._find_container_pid("fake_container_id")
self.assertEqual(pid, '12345')
def test_get_console_output_with_no_container(self):
driver = novadocker.virt.docker.driver.DockerDriver(None)
with mock.patch.object(driver,
"_get_container_id") as get_container_id:
get_container_id.return_value = None
logs = driver.get_console_output(None, None)
self.assertEqual('', logs)
@mock.patch.object(novadocker.virt.docker.driver.DockerDriver,
'_find_container_by_uuid',
return_value={'id': 'fake_id'})
def test_snapshot(self, byuuid_mock):
# Use mix-case to test that mixed-case image names succeed.
snapshot_name = 'tEsT-SnAp'
expected_calls = [
{'args': (),
'kwargs':
{'task_state': task_states.IMAGE_PENDING_UPLOAD}},
{'args': (),
'kwargs':
{'task_state': task_states.IMAGE_UPLOADING,
'expected_state': task_states.IMAGE_PENDING_UPLOAD}}]
func_call_matcher = matchers.FunctionCallMatcher(expected_calls)
instance_ref = utils.get_test_instance()
properties = {'instance_id': instance_ref['id'],
'user_id': str(self.context.user_id)}
sent_meta = {'name': snapshot_name, 'is_public': False,
'status': 'creating', 'properties': properties}
# Because the docker driver doesn't push directly into Glance, we
# cannot check that the images are correctly configured in the
# fake image service, but we can ensuring naming and other
# conventions are accurate.
image_service = nova.tests.unit.image.fake.FakeImageService()
recv_meta = image_service.create(context, sent_meta)
with mock.patch.object(self.mock_client, 'load_image'):
with mock.patch.object(self.mock_client, 'get_image'):
self.connection.snapshot(self.context, instance_ref,
recv_meta['id'],
func_call_matcher.call)
snapshot = image_service.show(context, recv_meta['id'])
self.assertEqual(snapshot['properties']['image_state'],
'available')
self.assertEqual(snapshot['status'], 'active')
self.assertEqual(snapshot['disk_format'], 'raw')
self.assertEqual(snapshot['container_format'], 'docker')
self.assertEqual(snapshot['name'], snapshot_name)
def test_get_image_name(self):
instance_ref = utils.get_test_instance()
image_info = utils.get_test_image_object(None, instance_ref)
image_info.container_format = 'docker'
image_info.name = 'MiXeDcAsE-image'
repo = self.connection._get_image_name(self.context,
instance_ref, image_info)
# image_name = repo.split("/")[1]
self.assertEqual(image_info.name, repo)
def test_get_host_uptime_returns_exec_result(self):
result = '4294967296'
with mock.patch('nova.utils.execute',
return_value=(result, None)):
uptime = self.connection.get_host_uptime()
self.assertEqual(result, uptime)
def test_get_dns_entries(self):
driver = docker_driver.DockerDriver(object)
network_info = utils.get_test_network_info()
self.assertEqual(['0.0.0.0', '0.0.0.0'],
driver._extract_dns_entries(network_info))
@mock.patch.object(os.path, 'exists', return_value=True)
def test_pull_missing_image_with_shared_dir(self, mock_os):
self.fixture.config(shared_directory='/fake_dir', group='docker')
instance_ref = utils.get_test_instance()
image_info = utils.get_test_image_object(None, instance_ref)
image_info.name = 'fake_name'
image_info.id = 'fake_id'
with mock.patch.object(self.mock_client, 'load_repository_file') as f:
with mock.patch.object(self.mock_client, 'inspect_image') as i:
i.return_value = 'fake_image'
image = self.connection._pull_missing_image(self.context,
image_info,
instance_ref)
f.assert_called_once_with('fake_name', '/fake_dir/fake_id')
i.assert_called_once_with('fake_name')
self.assertEqual('fake_image', image)
def test_find_container_by_uuid(self):
instance_href = utils.get_test_instance()
image_info = utils.get_test_image_object(None, instance_href)
image_info.disk_format = 'raw'
image_info.container_format = 'docker'
self.connection.spawn(self.context, instance_href, image_info,
'fake_files', 'fake_password')
info = self.connection._find_container_by_uuid(instance_href['uuid'])
self.assertEqual(instance_href['name'], info['Config'].get('Hostname'))