docker
/
docker-py
mirror of https://github.com/docker/docker-py.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

More sanity checking of EndpointConfig params 

Signed-off-by: Mariano Scazzariello <marianoscazzariello@gmail.com>
This commit is contained in:
Mariano Scazzariello 2023-05-07 12:40:08 +02:00
parent 7870503c52
commit e011ff5be8
No known key found for this signature in database
GPG Key ID: 95C376C0221294BF
3 changed files with 157 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docker/models/containers.py
View File

@ -703,6 +703,8 @@ class ContainerCollection(Collection):
(IPv4/IPv6) addresses.
- ``driver_opt`` (dict): A dictionary of options to provide to
the network driver. Defaults to ``None``.
- ``mac_address`` (str): MAC Address to assign to the network
interface. Defaults to ``None``. Requires API >= 1.25.
Used in conjuction with ``network``.
Incompatible with ``network_mode``.
@ -1122,6 +1124,17 @@ RUN_HOST_CONFIG_KWARGS = [
]
NETWORKING_CONFIG_ARGS = [
'aliases',
'links',
'ipv4_address',
'ipv6_address',
'link_local_ips',
'driver_opt',
'mac_address'
]
def _create_container_args(kwargs):
"""
Convert arguments to create() to arguments to create_container().
@ -1148,10 +1161,18 @@ def _create_container_args(kwargs):
network = kwargs.pop('network', None)
network_config = kwargs.pop('network_config', None)
if network:
endpoint_config = EndpointConfig(
host_config_kwargs['version'],
**network_config
) if network_config else None
endpoint_config = None
if network_config:
clean_endpoint_args = {}
for arg_name in NETWORKING_CONFIG_ARGS:
if arg_name in network_config:
clean_endpoint_args[arg_name] = network_config[arg_name]
if clean_endpoint_args:
endpoint_config = EndpointConfig(
host_config_kwargs['version'], **clean_endpoint_args
)
create_kwargs['networking_config'] = NetworkingConfig(
{network: endpoint_config}

57
tests/integration/models_containers_test.py
View File

@ -104,6 +104,63 @@ class ContainerCollectionTest(BaseIntegrationTest):
assert 'Networks' in attrs['NetworkSettings']
assert list(attrs['NetworkSettings']['Networks'].keys()) == [net_name]
def test_run_with_network_config(self):
net_name = random_name()
client = docker.from_env(version=TEST_API_VERSION)
client.networks.create(net_name)
self.tmp_networks.append(net_name)
test_aliases = ['hello']
test_driver_opt = {'key1': 'a'}
container = client.containers.run(
'alpine', 'echo hello world', network=net_name,
network_config={'aliases': test_aliases,
'driver_opt': test_driver_opt},
detach=True
)
self.tmp_containers.append(container.id)
attrs = container.attrs
assert 'NetworkSettings' in attrs
assert 'Networks' in attrs['NetworkSettings']
assert list(attrs['NetworkSettings']['Networks'].keys()) == [net_name]
assert attrs['NetworkSettings']['Networks'][net_name]['Aliases'] == \
test_aliases
assert attrs['NetworkSettings']['Networks'][net_name]['DriverOpts'] \
== test_driver_opt
def test_run_with_network_config_undeclared_params(self):
net_name = random_name()
client = docker.from_env(version=TEST_API_VERSION)
client.networks.create(net_name)
self.tmp_networks.append(net_name)
test_aliases = ['hello']
test_driver_opt = {'key1': 'a'}
container = client.containers.run(
'alpine', 'echo hello world', network=net_name,
network_config={'aliases': test_aliases,
'driver_opt': test_driver_opt,
'undeclared_param': 'random_value'},
detach=True
)
self.tmp_containers.append(container.id)
attrs = container.attrs
assert 'NetworkSettings' in attrs
assert 'Networks' in attrs['NetworkSettings']
assert list(attrs['NetworkSettings']['Networks'].keys()) == [net_name]
assert attrs['NetworkSettings']['Networks'][net_name]['Aliases'] == \
test_aliases
assert attrs['NetworkSettings']['Networks'][net_name]['DriverOpts'] \
== test_driver_opt
assert 'undeclared_param' not in \
attrs['NetworkSettings']['Networks'][net_name]
def test_run_with_none_driver(self):
client = docker.from_env(version=TEST_API_VERSION)

75
tests/unit/models_containers_test.py
View File

@ -390,6 +390,44 @@ class ContainerCollectionTest(unittest.TestCase):
host_config={'NetworkMode': 'foo'}
)
def test_run_network_config_undeclared_params(self):
client = make_fake_client()
client.containers.run(
image='alpine',
network='foo',
network_config={'aliases': ['test'],
'driver_opt': {'key1': 'a'},
'undeclared_param': 'random_value'}
)
client.api.create_container.assert_called_with(
detach=False,
image='alpine',
command=None,
networking_config={'EndpointsConfig': {
'foo': {'Aliases': ['test'], 'DriverOpts': {'key1': 'a'}}}
},
host_config={'NetworkMode': 'foo'}
)
def test_run_network_config_only_undeclared_params(self):
client = make_fake_client()
client.containers.run(
image='alpine',
network='foo',
network_config={'undeclared_param': 'random_value'}
)
client.api.create_container.assert_called_with(
detach=False,
image='alpine',
command=None,
networking_config={'foo': None},
host_config={'NetworkMode': 'foo'}
)
def test_create(self):
client = make_fake_client()
container = client.containers.create(
@ -467,6 +505,43 @@ class ContainerCollectionTest(unittest.TestCase):
host_config={'NetworkMode': 'foo'}
)
def test_create_network_config_undeclared_params(self):
client = make_fake_client()
client.containers.create(
image='alpine',
network='foo',
network_config={'aliases': ['test'],
'driver_opt': {'key1': 'a'},
'undeclared_param': 'random_value'}
)
client.api.create_container.assert_called_with(
image='alpine',
command=None,
networking_config={'EndpointsConfig': {
'foo': {'Aliases': ['test'], 'DriverOpts': {'key1': 'a'}}}
},
host_config={'NetworkMode': 'foo'}
)
def test_create_network_config_only_undeclared_params(self):
client = make_fake_client()
client.containers.create(
image='alpine',
network='foo',
network_config={'undeclared_param': 'random_value'}
)
client.api.create_container.assert_called_with(
image='alpine',
command=None,
networking_config={'foo': None},
host_config={'NetworkMode': 'foo'}
)
def test_get(self):
client = make_fake_client()
container = client.containers.get(FAKE_CONTAINER_ID)