valitydev/salt
14
0
Fork 0
mirror of https://github.com/valitydev/salt.git synced 2024-11-08 17:33:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
b42b762c57
salt/tests/unit/states/test_docker_network.py

217 lines
9.5 KiB
Python
Raw Normal View History

Overhaul Docker support This does the following: - Splits states for container/volume/image/network management into four separate state modules. - Preserves backward compatibility by making ``docker.image_present`` invoke ``docker_image.present``, etc. - Changes how Salt detects that a container needs to be replaced. Instead of comparing each passed argument to the named container's configuration, it creates a temporary container, and compares that container to the named container. If the two differ, then the older container is removed, and the new one is renamed and started, becoming the named container. - Removes the unit tests for container management and replaces them with integration tests. - Adds unit tests for the new salt.utils.docker
2017-03-13 20:34:28 +00:00
# -*- coding: utf-8 -*-
'''
Unit tests for the docker state
'''
# Import Python Libs
from __future__ import absolute_import
# Import Salt Testing Libs
Proper mocking.
2017-03-22 16:42:17 +00:00
from tests.support.mixins import LoaderModuleMockMixin
Overhaul Docker support This does the following: - Splits states for container/volume/image/network management into four separate state modules. - Preserves backward compatibility by making ``docker.image_present`` invoke ``docker_image.present``, etc. - Changes how Salt detects that a container needs to be replaced. Instead of comparing each passed argument to the named container's configuration, it creates a temporary container, and compares that container to the named container. If the two differ, then the older container is removed, and the new one is renamed and started, becoming the named container. - Removes the unit tests for container management and replaces them with integration tests. - Adds unit tests for the new salt.utils.docker
2017-03-13 20:34:28 +00:00
from tests.support.unit import skipIf, TestCase
from tests.support.mock import (
Mock,
NO_MOCK,
NO_MOCK_REASON,
patch
)
# Import Salt Libs
Rename docker execution module to avoid shadowing in the loader With the merging of #39996, salt/modules/docker.py now imports salt.utils.docker. However, our loader appends the module dir (in this case salt/modules/) to sys.path temporarily for the length of the loading process. So, as the docker execution module tries to import salt.utils.docker, when salt.utils.docker attempts to do an "import docker", and docker-py is *not* installed, this results in salt/modules/docker.py (the docker execution module) being loaded in its place, which results in tracebacks in the minion log. Renaming the docker execution module keeps this import shadowing from occurring. Note that we don't need to do this for the placeholder salt/states/docker.py as it does not import salt.utils.docker.
2017-03-23 20:33:56 +00:00
import salt.modules.dockermod as docker_mod
Overhaul Docker support This does the following: - Splits states for container/volume/image/network management into four separate state modules. - Preserves backward compatibility by making ``docker.image_present`` invoke ``docker_image.present``, etc. - Changes how Salt detects that a container needs to be replaced. Instead of comparing each passed argument to the named container's configuration, it creates a temporary container, and compares that container to the named container. If the two differ, then the older container is removed, and the new one is renamed and started, becoming the named container. - Removes the unit tests for container management and replaces them with integration tests. - Adds unit tests for the new salt.utils.docker
2017-03-13 20:34:28 +00:00
import salt.states.docker_network as docker_state
@skipIf(NO_MOCK, NO_MOCK_REASON)
Proper mocking.
2017-03-22 16:42:17 +00:00
class DockerNetworkTestCase(TestCase, LoaderModuleMockMixin):
Overhaul Docker support This does the following: - Splits states for container/volume/image/network management into four separate state modules. - Preserves backward compatibility by making ``docker.image_present`` invoke ``docker_image.present``, etc. - Changes how Salt detects that a container needs to be replaced. Instead of comparing each passed argument to the named container's configuration, it creates a temporary container, and compares that container to the named container. If the two differ, then the older container is removed, and the new one is renamed and started, becoming the named container. - Removes the unit tests for container management and replaces them with integration tests. - Adds unit tests for the new salt.utils.docker
2017-03-13 20:34:28 +00:00
'''
Test docker_network states
'''
Proper mocking.
2017-03-22 16:42:17 +00:00
def setup_loader_modules(self):
return {
docker_mod: {
'__context__': {'docker.docker_version': ''}
},
docker_state: {
'__opts__': {'test': False}
}
}
Overhaul Docker support This does the following: - Splits states for container/volume/image/network management into four separate state modules. - Preserves backward compatibility by making ``docker.image_present`` invoke ``docker_image.present``, etc. - Changes how Salt detects that a container needs to be replaced. Instead of comparing each passed argument to the named container's configuration, it creates a temporary container, and compares that container to the named container. If the two differ, then the older container is removed, and the new one is renamed and started, becoming the named container. - Removes the unit tests for container management and replaces them with integration tests. - Adds unit tests for the new salt.utils.docker
2017-03-13 20:34:28 +00:00
def test_present(self):
'''
Test docker_network.present
'''
docker_create_network = Mock(return_value='created')
docker_connect_container_to_network = Mock(return_value='connected')
Re-use container connection logic on net creation Re-factoring a little following the previous commit, so that the same container connection logic can be used in both places, rather than it being repeated.
2017-08-18 12:20:16 +00:00
docker_inspect_container = Mock(return_value={'Id': 'abcd', 'Name': 'container_bar'})
Add regression tests for #41982 These test the scenarios where another network with a similar name already exists, verifying that absent doesn't attempt to remove a network which isn't specified, and present still attempts to create the specified network despite a similarly named network already being present.
2017-07-28 09:41:44 +00:00
# Get docker.networks to return a network with a name which is a superset of the name of
# the network which is to be created, despite this network existing we should still expect
# that the new network will be created.
# Regression test for #41982.
docker_networks = Mock(return_value=[{
'Name': 'network_foobar',
'Containers': {'container': {}}
}])
Overhaul Docker support This does the following: - Splits states for container/volume/image/network management into four separate state modules. - Preserves backward compatibility by making ``docker.image_present`` invoke ``docker_image.present``, etc. - Changes how Salt detects that a container needs to be replaced. Instead of comparing each passed argument to the named container's configuration, it creates a temporary container, and compares that container to the named container. If the two differ, then the older container is removed, and the new one is renamed and started, becoming the named container. - Removes the unit tests for container management and replaces them with integration tests. - Adds unit tests for the new salt.utils.docker
2017-03-13 20:34:28 +00:00
__salt__ = {'docker.create_network': docker_create_network,
'docker.inspect_container': docker_inspect_container,
'docker.connect_container_to_network': docker_connect_container_to_network,
Add regression tests for #41982 These test the scenarios where another network with a similar name already exists, verifying that absent doesn't attempt to remove a network which isn't specified, and present still attempts to create the specified network despite a similarly named network already being present.
2017-07-28 09:41:44 +00:00
'docker.networks': docker_networks,
Overhaul Docker support This does the following: - Splits states for container/volume/image/network management into four separate state modules. - Preserves backward compatibility by making ``docker.image_present`` invoke ``docker_image.present``, etc. - Changes how Salt detects that a container needs to be replaced. Instead of comparing each passed argument to the named container's configuration, it creates a temporary container, and compares that container to the named container. If the two differ, then the older container is removed, and the new one is renamed and started, becoming the named container. - Removes the unit tests for container management and replaces them with integration tests. - Adds unit tests for the new salt.utils.docker
2017-03-13 20:34:28 +00:00
}
with patch.dict(docker_state.__dict__,
{'__salt__': __salt__}):
ret = docker_state.present(
'network_foo',
containers=['container'],
Add support for IPAM config in Docker networks Fixes #43047
2017-08-17 06:26:08 +00:00
gateway='192.168.0.1',
ip_range='192.168.0.128/25',
subnet='192.168.0.0/24'
Overhaul Docker support This does the following: - Splits states for container/volume/image/network management into four separate state modules. - Preserves backward compatibility by making ``docker.image_present`` invoke ``docker_image.present``, etc. - Changes how Salt detects that a container needs to be replaced. Instead of comparing each passed argument to the named container's configuration, it creates a temporary container, and compares that container to the named container. If the two differ, then the older container is removed, and the new one is renamed and started, becoming the named container. - Removes the unit tests for container management and replaces them with integration tests. - Adds unit tests for the new salt.utils.docker
2017-03-13 20:34:28 +00:00
)
dockerng: avoid network duplication and add driver_opts
2017-04-18 18:25:46 +00:00
docker_create_network.assert_called_with('network_foo',
driver=None,
Add support for IPAM config in Docker networks Fixes #43047
2017-08-17 06:26:08 +00:00
driver_opts=None,
gateway='192.168.0.1',
ip_range='192.168.0.128/25',
subnet='192.168.0.0/24')
Overhaul Docker support This does the following: - Splits states for container/volume/image/network management into four separate state modules. - Preserves backward compatibility by making ``docker.image_present`` invoke ``docker_image.present``, etc. - Changes how Salt detects that a container needs to be replaced. Instead of comparing each passed argument to the named container's configuration, it creates a temporary container, and compares that container to the named container. If the two differ, then the older container is removed, and the new one is renamed and started, becoming the named container. - Removes the unit tests for container management and replaces them with integration tests. - Adds unit tests for the new salt.utils.docker
2017-03-13 20:34:28 +00:00
docker_connect_container_to_network.assert_called_with('abcd',
'network_foo')
self.assertEqual(ret, {'name': 'network_foo',
'comment': '',
Re-use container connection logic on net creation Re-factoring a little following the previous commit, so that the same container connection logic can be used in both places, rather than it being repeated.
2017-08-18 12:20:16 +00:00
'changes': {'connected': ['container_bar'],
Overhaul Docker support This does the following: - Splits states for container/volume/image/network management into four separate state modules. - Preserves backward compatibility by making ``docker.image_present`` invoke ``docker_image.present``, etc. - Changes how Salt detects that a container needs to be replaced. Instead of comparing each passed argument to the named container's configuration, it creates a temporary container, and compares that container to the named container. If the two differ, then the older container is removed, and the new one is renamed and started, becoming the named container. - Removes the unit tests for container management and replaces them with integration tests. - Adds unit tests for the new salt.utils.docker
2017-03-13 20:34:28 +00:00
'created': 'created'},
'result': True})
Add ability to re-configure docker networks Previously any changes to network states wouldn't result in any change to the network when the state was applied. This was less of an issue the only attributes you could set for a network were its name and driver, but with the recent support for driver options and now IPAM config being added, it's useful for the state to be able to modify the network if it needs to. The Docker API doesn't provide any facility to modify an existing network, so the only option is to recreate it with the new options, which means disconnecting and reconnecting all containers. Fixes #43047
2017-08-18 11:52:23 +00:00
def test_present_with_change(self):
'''
Test docker_network.present when the specified network has properties differing from the already present network
'''
network_details = {
'Id': 'abcd',
'Name': 'network_foo',
'Driver': 'macvlan',
'Containers': {
'abcd': {}
},
'Options': {
'parent': 'eth0'
},
'IPAM': {
'Config': [
{
'Subnet': '192.168.0.0/24',
'Gateway': '192.168.0.1'
}
]
}
}
docker_networks = Mock(return_value=[network_details])
network_details['Containers'] = {'abcd': {'Id': 'abcd', 'Name': 'container_bar'}}
docker_inspect_network = Mock(return_value=network_details)
docker_inspect_container = Mock(return_value={'Id': 'abcd', 'Name': 'container_bar'})
docker_disconnect_container_from_network = Mock(return_value='disconnected')
docker_remove_network = Mock(return_value='removed')
docker_create_network = Mock(return_value='created')
docker_connect_container_to_network = Mock(return_value='connected')
__salt__ = {'docker.networks': docker_networks,
'docker.inspect_network': docker_inspect_network,
'docker.inspect_container': docker_inspect_container,
'docker.disconnect_container_from_network': docker_disconnect_container_from_network,
'docker.remove_network': docker_remove_network,
'docker.create_network': docker_create_network,
'docker.connect_container_to_network': docker_connect_container_to_network,
}
with patch.dict(docker_state.__dict__,
{'__salt__': __salt__}):
ret = docker_state.present(
'network_foo',
driver='macvlan',
gateway='192.168.1.1',
subnet='192.168.1.0/24',
driver_opts={'parent': 'eth1'},
containers=['abcd']
)
docker_disconnect_container_from_network.assert_called_with('abcd', 'network_foo')
docker_remove_network.assert_called_with('network_foo')
docker_create_network.assert_called_with('network_foo',
driver='macvlan',
driver_opts={'parent': 'eth1'},
gateway='192.168.1.1',
ip_range=None,
subnet='192.168.1.0/24')
docker_connect_container_to_network.assert_called_with('abcd', 'network_foo')
self.assertEqual(ret, {'name': 'network_foo',
'comment': 'Network \'network_foo\' was replaced with updated config',
'changes': {
'updated': {'network_foo': {
'old': {
'driver_opts': {'parent': 'eth0'},
'gateway': '192.168.0.1',
'subnet': '192.168.0.0/24'
},
'new': {
'driver_opts': {'parent': 'eth1'},
'gateway': '192.168.1.1',
'subnet': '192.168.1.0/24'
}
}},
'reconnected': ['container_bar']
},
'result': True})
Overhaul Docker support This does the following: - Splits states for container/volume/image/network management into four separate state modules. - Preserves backward compatibility by making ``docker.image_present`` invoke ``docker_image.present``, etc. - Changes how Salt detects that a container needs to be replaced. Instead of comparing each passed argument to the named container's configuration, it creates a temporary container, and compares that container to the named container. If the two differ, then the older container is removed, and the new one is renamed and started, becoming the named container. - Removes the unit tests for container management and replaces them with integration tests. - Adds unit tests for the new salt.utils.docker
2017-03-13 20:34:28 +00:00
def test_absent(self):
'''
Test docker_network.absent
'''
docker_remove_network = Mock(return_value='removed')
docker_disconnect_container_from_network = Mock(return_value='disconnected')
Fix broken unit test test_network_absent This started failing following commit 515c612, which relied on the 'Name' key being present in the return value of docker.networks - as the mock didn't have this set the test started failing.
2017-07-28 08:57:45 +00:00
docker_networks = Mock(return_value=[{
'Name': 'network_foo',
'Containers': {'container': {}}
}])
Overhaul Docker support This does the following: - Splits states for container/volume/image/network management into four separate state modules. - Preserves backward compatibility by making ``docker.image_present`` invoke ``docker_image.present``, etc. - Changes how Salt detects that a container needs to be replaced. Instead of comparing each passed argument to the named container's configuration, it creates a temporary container, and compares that container to the named container. If the two differ, then the older container is removed, and the new one is renamed and started, becoming the named container. - Removes the unit tests for container management and replaces them with integration tests. - Adds unit tests for the new salt.utils.docker
2017-03-13 20:34:28 +00:00
__salt__ = {
'docker.remove_network': docker_remove_network,
'docker.disconnect_container_from_network': docker_disconnect_container_from_network,
Fix broken unit test test_network_absent This started failing following commit 515c612, which relied on the 'Name' key being present in the return value of docker.networks - as the mock didn't have this set the test started failing.
2017-07-28 08:57:45 +00:00
'docker.networks': docker_networks,
Overhaul Docker support This does the following: - Splits states for container/volume/image/network management into four separate state modules. - Preserves backward compatibility by making ``docker.image_present`` invoke ``docker_image.present``, etc. - Changes how Salt detects that a container needs to be replaced. Instead of comparing each passed argument to the named container's configuration, it creates a temporary container, and compares that container to the named container. If the two differ, then the older container is removed, and the new one is renamed and started, becoming the named container. - Removes the unit tests for container management and replaces them with integration tests. - Adds unit tests for the new salt.utils.docker
2017-03-13 20:34:28 +00:00
}
with patch.dict(docker_state.__dict__,
{'__salt__': __salt__}):
ret = docker_state.absent('network_foo')
docker_disconnect_container_from_network.assert_called_with('container',
'network_foo')
docker_remove_network.assert_called_with('network_foo')
self.assertEqual(ret, {'name': 'network_foo',
'comment': '',
'changes': {'disconnected': 'disconnected',
'removed': 'removed'},
'result': True})
Add regression tests for #41982 These test the scenarios where another network with a similar name already exists, verifying that absent doesn't attempt to remove a network which isn't specified, and present still attempts to create the specified network despite a similarly named network already being present.
2017-07-28 09:41:44 +00:00
def test_absent_with_matching_network(self):
'''
Test docker_network.absent when the specified network does not exist,
but another network with a name which is a superset of the specified
name does exist. In this case we expect there to be no attempt to remove
any network.
Regression test for #41982.
'''
docker_remove_network = Mock(return_value='removed')
docker_disconnect_container_from_network = Mock(return_value='disconnected')
docker_networks = Mock(return_value=[{
'Name': 'network_foobar',
'Containers': {'container': {}}
}])
__salt__ = {
'docker.remove_network': docker_remove_network,
'docker.disconnect_container_from_network': docker_disconnect_container_from_network,
'docker.networks': docker_networks,
}
with patch.dict(docker_state.__dict__,
{'__salt__': __salt__}):
ret = docker_state.absent('network_foo')
docker_disconnect_container_from_network.assert_not_called()
docker_remove_network.assert_not_called()
self.assertEqual(ret, {'name': 'network_foo',
'comment': 'Network \'network_foo\' already absent',
'changes': {},
'result': True})
Reference in New Issue Copy Permalink