valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-07 08:58:59 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request #40480 from terminalmage/docker-auth-handling

Browse Source 
Improved Docker auth handling and other misc. Docker improvements
This commit is contained in:
Mike Place 2017-04-03 16:44:48 -06:00 committed by GitHub
commit 17808e7181
6 changed files with 400 additions and 528 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

698
salt/modules/dockermod.py
View File

File diff suppressed because it is too large Load Diff

42
salt/states/docker.py
View File

@ -8,7 +8,7 @@ States to manage Docker containers, images, volumes, and networks
.. important::
As of the Nitrogen release, the states in this module have been separated
into the following four modules:
into the following four state modules:
- :mod:`docker_container <salt.states.docker_container>` - States to manage
Docker containers
@ -91,8 +91,8 @@ def running(name, **kwargs):
)
msg = (
'The docker.running state has been renamed to '
'docker_container.running. Update your SLS to use the new function '
'name to get rid of this warning.'
'docker_container.running. To get rid of this warning, update your '
'SLS to use the new name.'
)
salt.utils.warn_until('Fluorine', msg)
ret.setdefault('warnings', []).append(msg)
@ -109,9 +109,9 @@ def stopped(**kwargs):
**salt.utils.clean_kwargs(**kwargs)
)
msg = (
'The docker.running state has been renamed to '
'docker_container.running. Update your SLS to use the new function '
'name to get rid of this warning.'
'The docker.stopped state has been renamed to '
'docker_container.stopped. To get rid of this warning, update your '
'SLS to use the new name.'
)
salt.utils.warn_until('Fluorine', msg)
ret.setdefault('warnings', []).append(msg)
@ -129,9 +129,9 @@ def absent(name, **kwargs):
**salt.utils.clean_kwargs(**kwargs)
)
msg = (
'The docker.running state has been renamed to '
'docker_container.running. Update your SLS to use the new function '
'name to get rid of this warning.'
'The docker.absent state has been renamed to '
'docker_container.absent. To get rid of this warning, update your '
'SLS to use the new name.'
)
salt.utils.warn_until('Fluorine', msg)
ret.setdefault('warnings', []).append(msg)
@ -150,8 +150,8 @@ def network_present(name, **kwargs):
)
msg = (
'The docker.network_present state has been renamed to '
'docker_network.present. Update your SLS to use the new function name '
'to get rid of this warning.'
'docker_network.present. To get rid of this warning, update your SLS '
'to use the new name.'
)
salt.utils.warn_until('Fluorine', msg)
ret.setdefault('warnings', []).append(msg)
@ -170,8 +170,8 @@ def network_absent(name, **kwargs):
)
msg = (
'The docker.network_absent state has been renamed to '
'docker_network.absent. Update your SLS to use the new function name '
'to get rid of this warning.'
'docker_network.absent. To get rid of this warning, update your SLS '
'to use the new name.'
)
salt.utils.warn_until('Fluorine', msg)
ret.setdefault('warnings', []).append(msg)
@ -190,8 +190,8 @@ def image_present(name, **kwargs):
)
msg = (
'The docker.image_present state has been renamed to '
'docker_image.present. Update your SLS to use the new function name '
'to get rid of this warning.'
'docker_image.present. To get rid of this warning, update your SLS '
'to use the new name.'
)
salt.utils.warn_until('Fluorine', msg)
ret.setdefault('warnings', []).append(msg)
@ -209,8 +209,8 @@ def image_absent(**kwargs):
)
msg = (
'The docker.image_absent state has been renamed to '
'docker_image.absent. Update your SLS to use the new function name '
'to get rid of this warning.'
'docker_image.absent. To get rid of this warning, update your SLS to '
'use the new name.'
)
salt.utils.warn_until('Fluorine', msg)
ret.setdefault('warnings', []).append(msg)
@ -229,8 +229,8 @@ def volume_present(name, driver=None, driver_opts=None, force=False):
force=force)
msg = (
'The docker.volume_present state has been renamed to '
'docker_volume.present. Update your SLS to use the new function name '
'to get rid of this warning.'
'docker_volume.present. To get rid of this warning, update your SLS '
'to use the new name.'
)
salt.utils.warn_until('Fluorine', msg)
ret.setdefault('warnings', []).append(msg)
@ -246,8 +246,8 @@ def volume_absent(name, driver=None):
ret = __states__['docker_volume.absent'](name, driver=driver)
msg = (
'The docker.volume_absent state has been renamed to '
'docker_volume.absent. Update your SLS to use the new function name '
'to get rid of this warning.'
'docker_volume.absent. To get rid of this warning, update your SLS '
'to use the new name.'
)
salt.utils.warn_until('Fluorine', msg)
ret.setdefault('warnings', []).append(msg)

16
salt/states/docker_container.py
View File

@ -137,9 +137,9 @@ def running(name,
the image needs to be built from a Dockerfile or loaded from a
saved image, or if you would like to use requisites to trigger a
replacement of the container when the image is updated, then the
:py:func:`docker.image_present
<salt.modules.docker.image_present>` should be used to manage the
image.
:py:func:`docker_image.present
<salt.states.dockermod.image_present>` state should be used to
manage the image.
.. _docker-container-running-skip-translate:
@ -248,9 +248,9 @@ def running(name,
shutdown_timeout : 10
If the container needs to be replaced, the container will be stopped
using :py:func:`docker.stop <salt.modules.docker.stop>`. The value
using :py:func:`docker.stop <salt.modules.dockermod.stop>`. The value
of this parameter will be passed to :py:func:`docker.stop
<salt.modules.docker.stop>` as the ``timeout`` value, telling Docker
<salt.modules.dockermod.stop>` as the ``timeout`` value, telling Docker
how long to wait for a graceful shutdown before killing the container.
.. versionchanged:: Nitrogen
@ -1677,7 +1677,7 @@ def running(name,
return result
# If we're not skipping the comparison, then the assumption is that
# temp_container will be discared, unless the comparison reveals
# temp_container will be discarded, unless the comparison reveals
# differences, in which case we'll set cleanup_temp = False to prevent it
# from being cleaned.
cleanup_temp = not skip_comparison
@ -1773,6 +1773,10 @@ def running(name,
# were detected, so the the temp container was discarded
if not cleanup_temp and (not exists or (exists and start)) \
or (start and cleanup_temp and pre_state != 'running'):
if __opts__['test']:
ret['result'] = None
comments.append('Container would be started')
return _format_comments(ret, comments)
try:
post_state = __salt__['docker.start'](name)['state']['new']
except Exception as exc:

4
salt/states/docker_image.py
View File

@ -105,12 +105,12 @@ def present(name,
.. versionadded:: 2016.11.0
The image will be built using :py:func:`docker.build
<salt.modules.docker.build>` and the specified image name and tag
<salt.modules.dockermod.build>` and the specified image name and tag
will be applied to it.
load
Loads a tar archive created with :py:func:`docker.load
<salt.modules.docker.load>` (or the ``docker load`` Docker CLI
<salt.modules.dockermod.load>` (or the ``docker load`` Docker CLI
command), and assigns it the specified repo and tag.
.. code-block:: yaml

4
salt/utils/docker/__init__.py
View File

@ -158,6 +158,10 @@ def get_repo_tag(image, default_tag='latest'):
'Assuming tag \'%s\' for repo \'%s\'', default_tag, image
)
r_tag = default_tag
elif '/' in r_tag:
# Public registry notation with no tag specified
# (e.g. foo.bar.com:5000/imagename)
return image, default_tag
return r_name, r_tag

164
tests/unit/modules/test_dockermod.py
View File

@ -46,16 +46,25 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
except AttributeError:
docker_version = 0,
def setUp(self):
'''
Ensure we aren't persisting context dunders between tests
'''
docker_mod.__context__.pop('docker.client', None)
def test_ps_with_host_true(self):
'''
Check that docker.ps called with host is ``True``,
include resutlt of ``network.interfaces`` command in returned result.
'''
client = Mock()
client.containers = MagicMock(return_value=[])
get_client_mock = MagicMock(return_value=client)
network_interfaces = Mock(return_value={'mocked': None})
with patch.dict(docker_mod.__salt__,
{'network.interfaces': network_interfaces}):
with patch.dict(docker_mod.__context__,
{'docker.client': MagicMock()}):
with patch.object(docker_mod, '_get_client', get_client_mock):
ret = docker_mod.ps_(host=True)
self.assertEqual(ret,
{'host': {'interfaces': {'mocked': None}}})
@ -64,9 +73,11 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
'''
Check that docker.ps accept filters parameter.
'''
client = MagicMock()
with patch.dict(docker_mod.__context__,
{'docker.client': client}):
client = Mock()
client.containers = MagicMock(return_value=[])
get_client_mock = MagicMock(return_value=client)
with patch.object(docker_mod, '_get_client', get_client_mock):
docker_mod.ps_(filters={'label': 'KEY'})
client.containers.assert_called_once_with(
all=True,
@ -120,15 +131,14 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
):
mine_send = Mock()
command = getattr(docker_mod, command_name)
docker_client = MagicMock()
docker_client.api_version = '1.12'
client = MagicMock()
client.api_version = '1.12'
with patch.dict(docker_mod.__salt__,
{'mine.send': mine_send,
'container_resource.run': MagicMock(),
'cp.cache_file': MagicMock(return_value=False),
'docker.get_client_args': client_args_mock}):
with patch.dict(docker_mod.__context__,
{'docker.client': docker_client}):
with patch.object(docker_mod, '_get_client', client):
command('container', *args)
mine_send.assert_called_with('docker.ps', verbose=True, all=True,
host=True)
@ -146,18 +156,13 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
host_config = {}
client = Mock()
client.api_version = '1.21'
get_client_mock = MagicMock(return_value=client)
with patch.dict(docker_mod.__dict__,
{'__salt__': __salt__}):
with patch.dict(docker_mod.__context__,
{'docker.client': client}):
docker_mod.networks(
names=['foo'],
ids=['01234'],
)
client.networks.assert_called_once_with(
names=['foo'],
ids=['01234'],
)
with patch.object(docker_mod, '_get_client', get_client_mock):
docker_mod.networks(names=['foo'], ids=['01234'])
client.networks.assert_called_once_with(names=['foo'], ids=['01234'])
@skipIf(docker_version < (1, 5, 0),
'docker module must be installed to run this test or is too old. >=1.5.0')
@ -172,18 +177,13 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
host_config = {}
client = Mock()
client.api_version = '1.21'
get_client_mock = MagicMock(return_value=client)
with patch.dict(docker_mod.__dict__,
{'__salt__': __salt__}):
with patch.dict(docker_mod.__context__,
{'docker.client': client}):
docker_mod.create_network(
'foo',
driver='bridge',
)
client.create_network.assert_called_once_with(
'foo',
driver='bridge',
)
with patch.object(docker_mod, '_get_client', get_client_mock):
docker_mod.create_network('foo', driver='bridge')
client.create_network.assert_called_once_with('foo', driver='bridge')
@skipIf(docker_version < (1, 5, 0),
'docker module must be installed to run this test or is too old. >=1.5.0')
@ -198,10 +198,11 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
host_config = {}
client = Mock()
client.api_version = '1.21'
get_client_mock = MagicMock(return_value=client)
with patch.dict(docker_mod.__dict__,
{'__salt__': __salt__}):
with patch.dict(docker_mod.__context__,
{'docker.client': client}):
with patch.object(docker_mod, '_get_client', get_client_mock):
docker_mod.remove_network('foo')
client.remove_network.assert_called_once_with('foo')
@ -218,10 +219,11 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
host_config = {}
client = Mock()
client.api_version = '1.21'
get_client_mock = MagicMock(return_value=client)
with patch.dict(docker_mod.__dict__,
{'__salt__': __salt__}):
with patch.dict(docker_mod.__context__,
{'docker.client': client}):
with patch.object(docker_mod, '_get_client', get_client_mock):
docker_mod.inspect_network('foo')
client.inspect_network.assert_called_once_with('foo')
@ -229,7 +231,7 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
'docker module must be installed to run this test or is too old. >=1.5.0')
def test_connect_container_to_network(self, *args):
'''
test inspect network.
test connect_container_to_network
'''
__salt__ = {
'config.get': Mock(),
@ -238,14 +240,15 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
host_config = {}
client = Mock()
client.api_version = '1.21'
get_client_mock = MagicMock(return_value=client)
context = {'docker.client': client,
'docker.exec_driver': 'docker-exec'}
context = {'docker.exec_driver': 'docker-exec'}
with patch.dict(docker_mod.__dict__,
{'__salt__': __salt__}):
with patch.dict(docker_mod.__context__, context):
docker_mod.connect_container_to_network('container', 'foo')
with patch.object(docker_mod, '_get_client', get_client_mock):
docker_mod.connect_container_to_network('container', 'foo')
client.connect_container_to_network.assert_called_once_with(
'container', 'foo', None)
@ -253,7 +256,7 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
'docker module must be installed to run this test or is too old. >=1.5.0')
def test_disconnect_container_from_network(self, *args):
'''
test inspect network.
test disconnect_container_from_network
'''
__salt__ = {
'config.get': Mock(),
@ -262,10 +265,11 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
host_config = {}
client = Mock()
client.api_version = '1.21'
get_client_mock = MagicMock(return_value=client)
with patch.dict(docker_mod.__dict__,
{'__salt__': __salt__}):
with patch.dict(docker_mod.__context__,
{'docker.client': client}):
with patch.object(docker_mod, '_get_client', get_client_mock):
docker_mod.disconnect_container_from_network('container', 'foo')
client.disconnect_container_from_network.assert_called_once_with(
'container', 'foo')
@ -282,10 +286,11 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
}
client = Mock()
client.api_version = '1.21'
get_client_mock = MagicMock(return_value=client)
with patch.dict(docker_mod.__dict__,
{'__salt__': __salt__}):
with patch.dict(docker_mod.__context__,
{'docker.client': client}):
with patch.object(docker_mod, '_get_client', get_client_mock):
docker_mod.volumes(
filters={'dangling': [True]},
)
@ -305,10 +310,11 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
}
client = Mock()
client.api_version = '1.21'
get_client_mock = MagicMock(return_value=client)
with patch.dict(docker_mod.__dict__,
{'__salt__': __salt__}):
with patch.dict(docker_mod.__context__,
{'docker.client': client}):
with patch.object(docker_mod, '_get_client', get_client_mock):
docker_mod.create_volume(
'foo',
driver='bridge',
@ -332,10 +338,11 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
}
client = Mock()
client.api_version = '1.21'
get_client_mock = MagicMock(return_value=client)
with patch.dict(docker_mod.__dict__,
{'__salt__': __salt__}):
with patch.dict(docker_mod.__context__,
{'docker.client': client}):
with patch.object(docker_mod, '_get_client', get_client_mock):
docker_mod.remove_volume('foo')
client.remove_volume.assert_called_once_with('foo')
@ -351,10 +358,11 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
}
client = Mock()
client.api_version = '1.21'
get_client_mock = MagicMock(return_value=client)
with patch.dict(docker_mod.__dict__,
{'__salt__': __salt__}):
with patch.dict(docker_mod.__context__,
{'docker.client': client}):
with patch.object(docker_mod, '_get_client', get_client_mock):
docker_mod.inspect_volume('foo')
client.inspect_volume.assert_called_once_with('foo')
@ -362,13 +370,14 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
client = Mock()
client.api_version = '1.21'
client.wait = Mock(return_value=0)
get_client_mock = MagicMock(return_value=client)
docker_inspect_container = Mock(side_effect=[
{'State': {'Running': True}},
{'State': {'Stopped': True}}])
with patch.object(docker_mod, 'inspect_container',
docker_inspect_container):
with patch.dict(docker_mod.__context__,
{'docker.client': client}):
with patch.object(docker_mod, '_get_client', get_client_mock):
docker_mod._clear_context()
result = docker_mod.wait('foo')
self.assertEqual(result, {'result': True,
@ -380,14 +389,15 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
client = Mock()
client.api_version = '1.21'
client.wait = Mock(return_value=0)
get_client_mock = MagicMock(return_value=client)
docker_inspect_container = Mock(side_effect=[
{'State': {'Stopped': True}},
{'State': {'Stopped': True}},
])
with patch.object(docker_mod, 'inspect_container',
docker_inspect_container):
with patch.dict(docker_mod.__context__,
{'docker.client': client}):
with patch.object(docker_mod, '_get_client', get_client_mock):
docker_mod._clear_context()
result = docker_mod.wait('foo')
self.assertEqual(result, {'result': False,
@ -400,14 +410,15 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
client = Mock()
client.api_version = '1.21'
client.wait = Mock(return_value=0)
get_client_mock = MagicMock(return_value=client)
docker_inspect_container = Mock(side_effect=[
{'State': {'Stopped': True}},
{'State': {'Stopped': True}},
])
with patch.object(docker_mod, 'inspect_container',
docker_inspect_container):
with patch.dict(docker_mod.__context__,
{'docker.client': client}):
with patch.object(docker_mod, '_get_client', get_client_mock):
docker_mod._clear_context()
result = docker_mod.wait('foo', ignore_already_stopped=True)
self.assertEqual(result, {'result': True,
@ -419,11 +430,12 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
def test_wait_success_absent_container(self):
client = Mock()
client.api_version = '1.21'
get_client_mock = MagicMock(return_value=client)
docker_inspect_container = Mock(side_effect=CommandExecutionError)
with patch.object(docker_mod, 'inspect_container',
docker_inspect_container):
with patch.dict(docker_mod.__context__,
{'docker.client': client}):
with patch.object(docker_mod, '_get_client', get_client_mock):
docker_mod._clear_context()
result = docker_mod.wait('foo', ignore_already_stopped=True)
self.assertEqual(result, {'result': True,
@ -433,13 +445,14 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
client = Mock()
client.api_version = '1.21'
client.wait = Mock(return_value=1)
get_client_mock = MagicMock(return_value=client)
docker_inspect_container = Mock(side_effect=[
{'State': {'Running': True}},
{'State': {'Stopped': True}}])
with patch.object(docker_mod, 'inspect_container',
docker_inspect_container):
with patch.dict(docker_mod.__context__,
{'docker.client': client}):
with patch.object(docker_mod, '_get_client', get_client_mock):
docker_mod._clear_context()
result = docker_mod.wait('foo', fail_on_exit_status=True)
self.assertEqual(result, {'result': False,
@ -451,13 +464,14 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
client = Mock()
client.api_version = '1.21'
client.wait = Mock(return_value=1)
get_client_mock = MagicMock(return_value=client)
docker_inspect_container = Mock(side_effect=[
{'State': {'Stopped': True}},
{'State': {'Stopped': True}}])
with patch.object(docker_mod, 'inspect_container',
docker_inspect_container):
with patch.dict(docker_mod.__context__,
{'docker.client': client}):
with patch.object(docker_mod, '_get_client', get_client_mock):
docker_mod._clear_context()
result = docker_mod.wait('foo',
ignore_already_stopped=True,
@ -624,23 +638,24 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
)
client = Mock()
client.put_archive = Mock()
get_client_mock = MagicMock(return_value=client)
context = {'docker.client': client,
'docker.exec_driver': 'docker-exec'}
context = {'docker.exec_driver': 'docker-exec'}
salt_dunder = {'config.option': docker_config_mock}
with patch.object(docker_mod, 'run_all', docker_run_all_mock):
with patch.object(docker_mod, 'copy_to', docker_copy_to_mock):
with patch.dict(docker_mod.__opts__, {'cachedir': '/tmp'}):
with patch.dict(docker_mod.__salt__, salt_dunder):
with patch.dict(docker_mod.__context__, context):
# call twice to verify tmp path later
for i in range(2):
ret = docker_mod.call(
'ID',
'test.arg',
1, 2,
arg1='val1')
with patch.object(docker_mod, '_get_client', get_client_mock):
with patch.dict(docker_mod.__opts__, {'cachedir': '/tmp'}):
with patch.dict(docker_mod.__salt__, salt_dunder):
with patch.dict(docker_mod.__context__, context):
# call twice to verify tmp path later
for i in range(2):
ret = docker_mod.call(
'ID',
'test.arg',
1, 2,
arg1='val1')
# Check that the directory is different each time
# [ call(name, [args]), ...
@ -674,8 +689,9 @@ class DockerTestCase(TestCase, LoaderModuleMockMixin):
{'Id': 'sha256:abcdef'},
{'Id': 'sha256:abcdefg',
'RepoTags': ['image:latest']}])
with patch.dict(docker_mod.__context__,
{'docker.client': client}):
get_client_mock = MagicMock(return_value=client)
with patch.object(docker_mod, '_get_client', get_client_mock):
docker_mod._clear_context()
result = docker_mod.images()
self.assertEqual(result,