openstack
/
magnum
Code Issues Proposed changes
magnum/magnum/tests/unit/common/test_docker_utils.py

293 lines
12 KiB
Python
Raw Blame History

# Copyright 2015 Huawei Technologies Co.,LTD.
#
# 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.
from docker import client as docker_py_client
import mock
from oslo_config import cfg
from magnum.common import docker_utils
from magnum.tests import base
CONF = cfg.CONF
CONF.import_opt('docker_remote_api_version', 'magnum.common.docker_utils',
group='docker')
CONF.import_opt('default_timeout', 'magnum.common.docker_utils',
group='docker')
class TestDockerUtils(base.BaseTestCase):
@mock.patch('magnum.common.docker_utils.DockerHTTPClient')
@mock.patch.object(docker_utils, 'cert_manager')
@mock.patch.object(docker_utils.objects.BayModel, 'get_by_uuid')
@mock.patch.object(docker_utils.objects.Bay, 'get_by_name')
def test_docker_for_container(self, mock_get_bay_by_name,
mock_get_baymodel_by_uuid,
mock_cert_manager,
mock_docker_client):
mock_container = mock.MagicMock()
mock_bay = mock.MagicMock()
mock_bay.api_address = 'https://1.2.3.4:2376'
mock_get_bay_by_name.return_value = mock_bay
mock_baymodel = mock.MagicMock()
mock_baymodel.tls_disabled = False
mock_get_baymodel_by_uuid.return_value = mock_baymodel
mock_ca_cert = mock.MagicMock()
mock_magnum_key = mock.MagicMock()
mock_magnum_cert = mock.MagicMock()
mock_cert_manager.create_client_files.return_value = (
mock_ca_cert, mock_magnum_key, mock_magnum_cert
)
mock_docker = mock.MagicMock()
mock_docker_client.return_value = mock_docker
with docker_utils.docker_for_container(mock.sentinel.context,
mock_container) as docker:
self.assertEqual(mock_docker, docker)
mock_get_bay_by_name.assert_called_once_with(mock.sentinel.context,
mock_container.bay_uuid)
mock_get_baymodel_by_uuid.assert_called_once_with(
mock.sentinel.context, mock_bay.baymodel_id)
mock_docker_client.assert_called_once_with(
'https://1.2.3.4:2376',
CONF.docker.docker_remote_api_version,
CONF.docker.default_timeout,
ca_cert=mock_ca_cert.name,
client_key=mock_magnum_key.name,
client_cert=mock_magnum_cert.name)
@mock.patch('magnum.common.docker_utils.DockerHTTPClient')
@mock.patch.object(docker_utils, 'cert_manager')
@mock.patch.object(docker_utils.objects.BayModel, 'get_by_uuid')
@mock.patch.object(docker_utils.objects.Bay, 'get_by_name')
@mock.patch.object(docker_utils.objects.Container, 'get_by_uuid')
def test_docker_for_container_uuid(self, mock_get_container_by_uuid,
mock_get_bay_by_name,
mock_get_baymodel_by_uuid,
mock_cert_manager,
mock_docker_client):
mock_container = mock.MagicMock()
mock_container.uuid = '8e48ffb1-754d-4f21-bdd0-1a39bf796389'
mock_get_container_by_uuid.return_value = mock_container
mock_bay = mock.MagicMock()
mock_bay.api_address = 'https://1.2.3.4:2376'
mock_get_bay_by_name.return_value = mock_bay
mock_baymodel = mock.MagicMock()
mock_baymodel.tls_disabled = False
mock_get_baymodel_by_uuid.return_value = mock_baymodel
mock_ca_cert = mock.MagicMock()
mock_magnum_key = mock.MagicMock()
mock_magnum_cert = mock.MagicMock()
mock_cert_manager.create_client_files.return_value = (
mock_ca_cert, mock_magnum_key, mock_magnum_cert
)
mock_docker = mock.MagicMock()
mock_docker_client.return_value = mock_docker
with docker_utils.docker_for_container(
mock.sentinel.context, mock_container.uuid) as docker:
self.assertEqual(mock_docker, docker)
mock_get_container_by_uuid.assert_called_once_with(
mock.sentinel.context, mock_container.uuid
)
mock_get_bay_by_name.assert_called_once_with(mock.sentinel.context,
mock_container.bay_uuid)
mock_get_baymodel_by_uuid.assert_called_once_with(
mock.sentinel.context, mock_bay.baymodel_id)
mock_docker_client.assert_called_once_with(
'https://1.2.3.4:2376',
CONF.docker.docker_remote_api_version,
CONF.docker.default_timeout,
ca_cert=mock_ca_cert.name,
client_key=mock_magnum_key.name,
client_cert=mock_magnum_cert.name)
@mock.patch('magnum.common.docker_utils.DockerHTTPClient')
@mock.patch.object(docker_utils.objects.BayModel, 'get_by_uuid')
@mock.patch.object(docker_utils.objects.Bay, 'get_by_name')
def test_docker_for_container_tls_disabled(self, mock_get_bay_by_name,
mock_get_baymodel_by_uuid,
mock_docker_client):
mock_container = mock.MagicMock()
mock_bay = mock.MagicMock()
mock_bay.api_address = 'tcp://1.2.3.4:2376'
mock_get_bay_by_name.return_value = mock_bay
mock_baymodel = mock.MagicMock()
mock_baymodel.tls_disabled = True
mock_get_baymodel_by_uuid.return_value = mock_baymodel
mock_docker = mock.MagicMock()
mock_docker_client.return_value = mock_docker
with docker_utils.docker_for_container(mock.sentinel.context,
mock_container) as docker:
self.assertEqual(mock_docker, docker)
mock_get_bay_by_name.assert_called_once_with(mock.sentinel.context,
mock_container.bay_uuid)
mock_get_baymodel_by_uuid.assert_called_once_with(
mock.sentinel.context, mock_bay.baymodel_id)
mock_docker_client.assert_called_once_with(
'tcp://1.2.3.4:2376',
CONF.docker.docker_remote_api_version,
CONF.docker.default_timeout)
def test_is_docker_api_version_atleast(self):
def fake_version():
return {'ApiVersion': '1.18'}
docker = mock.MagicMock()
docker.version.side_effect = fake_version
res = docker_utils.is_docker_api_version_atleast(docker, '1.19')
self.assertFalse(res)
class DockerClientTestCase(base.BaseTestCase):
def test_docker_client_init(self):
client = docker_utils.DockerHTTPClient()
self.assertEqual(CONF.docker.docker_remote_api_version,
client.api_version)
self.assertEqual(CONF.docker.default_timeout,
client.timeout)
def test_docker_client_init_timeout(self):
expected_timeout = 300
client = docker_utils.DockerHTTPClient(timeout=expected_timeout)
self.assertEqual(CONF.docker.docker_remote_api_version,
client.api_version)
self.assertEqual(expected_timeout, client.timeout)
def test_docker_client_init_url(self):
expected_url = 'http://127.0.0.1:2375'
client = docker_utils.DockerHTTPClient(url=expected_url)
self.assertEqual(expected_url,
client.base_url)
self.assertEqual(CONF.docker.docker_remote_api_version,
client.api_version)
self.assertEqual(CONF.docker.default_timeout,
client.timeout)
def test_docker_client_init_version(self):
expected_version = '1.16'
client = docker_utils.DockerHTTPClient(ver=expected_version)
self.assertEqual(expected_version,
client.api_version)
self.assertEqual(CONF.docker.default_timeout,
client.timeout)
@mock.patch.object(docker_py_client.Client, 'inspect_container')
@mock.patch.object(docker_py_client.Client, 'containers')
def test_list_instances(self, mock_containers, mock_inspect):
client = docker_utils.DockerHTTPClient()
containers = [dict(Id=x) for x in range(0, 3)]
inspect_results = [dict(Config=dict(Hostname=x)) for x in range(0, 3)]
mock_containers.return_value = containers
mock_inspect.side_effect = inspect_results
instances = client.list_instances()
self.assertEqual([0, 1, 2], instances)
mock_containers.assert_called_once_with(all=True)
mock_inspect.assert_has_calls([mock.call(x) for x in range(0, 3)])
@mock.patch.object(docker_py_client.Client, 'inspect_container')
@mock.patch.object(docker_py_client.Client, 'containers')
def test_list_instances_inspect(self, mock_containers, mock_inspect):
client = docker_utils.DockerHTTPClient()
containers = [dict(Id=x) for x in range(0, 3)]
inspect_results = [dict(Config=dict(Hostname=x)) for x in range(0, 3)]
mock_containers.return_value = containers
mock_inspect.side_effect = inspect_results
instances = client.list_instances(inspect=True)
self.assertEqual(inspect_results, instances)
mock_containers.assert_called_once_with(all=True)
mock_inspect.assert_has_calls([mock.call(x) for x in range(0, 3)])
@mock.patch.object(docker_py_client.Client, '_raise_for_status')
@mock.patch.object(docker_py_client.Client, '_post')
@mock.patch.object(docker_py_client.Client, '_url')
def test_pause(self, mock_url, mock_post, mock_raise_for_status):
client = docker_utils.DockerHTTPClient()
client.pause('someid')
mock_url.assert_called_once_with('/containers/someid/pause')
mock_post.assert_called_once_with(mock_url.return_value)
mock_raise_for_status.assert_called_once_with(
mock_post.return_value)
@mock.patch.object(docker_py_client.Client, '_raise_for_status')
@mock.patch.object(docker_py_client.Client, '_post')
@mock.patch.object(docker_py_client.Client, '_url')
def test_pause_container_dict(self, mock_url, mock_post,
mock_raise_for_status):
client = docker_utils.DockerHTTPClient()
client.pause(dict(Id='someid'))
mock_url.assert_called_once_with('/containers/someid/pause')
mock_post.assert_called_once_with(mock_url.return_value)
mock_raise_for_status.assert_called_once_with(
mock_post.return_value)
@mock.patch.object(docker_py_client.Client, '_raise_for_status')
@mock.patch.object(docker_py_client.Client, '_post')
@mock.patch.object(docker_py_client.Client, '_url')
def test_unpause(self, mock_url, mock_post, mock_raise_for_status):
client = docker_utils.DockerHTTPClient()
client.unpause('someid')
mock_url.assert_called_once_with('/containers/someid/unpause')
mock_post.assert_called_once_with(mock_url.return_value)
mock_raise_for_status.assert_called_once_with(
mock_post.return_value)
@mock.patch.object(docker_py_client.Client, '_raise_for_status')
@mock.patch.object(docker_py_client.Client, '_post')
@mock.patch.object(docker_py_client.Client, '_url')
def test_unpause_container_dict(self, mock_url, mock_post,
mock_raise_for_status):
client = docker_utils.DockerHTTPClient()
client.unpause(dict(Id='someid'))
mock_url.assert_called_once_with('/containers/someid/unpause')
mock_post.assert_called_once_with(mock_url.return_value)
mock_raise_for_status.assert_called_once_with(
mock_post.return_value)
@mock.patch.object(docker_py_client.Client, 'logs')
def test_get_container_logs(self, mock_logs):
client = docker_utils.DockerHTTPClient()
client.get_container_logs('someid')
mock_logs.assert_called_once_with('someid')
View Git Blame Copy Permalink