Skip to content

Commit

Permalink
added support for propagation (with flake conformity)
Browse files Browse the repository at this point in the history
Signed-off-by: Janne Jakob Fleischer <janne.fleischer@ils-forschung.de>
  • Loading branch information
jannefleischer committed Aug 15, 2023
1 parent 84414e3 commit 52ad769
Show file tree
Hide file tree
Showing 3 changed files with 52 additions and 3 deletions.
8 changes: 7 additions & 1 deletion docker/api/container.py
Original file line number Diff line number Diff line change
Expand Up @@ -317,6 +317,11 @@ def create_container(self, image, command=None, hostname=None, user=None,
'/var/www': {
'bind': '/mnt/vol1',
'mode': 'ro',
},
'/autofs/user1': {
'bind': '/mnt/vol3',
'mode': 'rw',
'propagation': 'shared'
}
})
)
Expand All @@ -327,10 +332,11 @@ def create_container(self, image, command=None, hostname=None, user=None,
.. code-block:: python
container_id = client.api.create_container(
'busybox', 'ls', volumes=['/mnt/vol1', '/mnt/vol2'],
'busybox', 'ls', volumes=['/mnt/vol1', '/mnt/vol2', '/mnt/vol3'],
host_config=client.api.create_host_config(binds=[
'/home/user1/:/mnt/vol2',
'/var/www:/mnt/vol1:ro',
'/autofs/user1:/mnt/vol3:rw,shared',
])
)
Expand Down
9 changes: 8 additions & 1 deletion docker/utils/utils.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@

from urllib.parse import urlparse, urlunparse


URLComponents = collections.namedtuple(
'URLComponents',
'scheme netloc url params query fragment',
Expand Down Expand Up @@ -116,6 +115,7 @@ def convert_port_bindings(port_bindings):


def convert_volume_binds(binds):

if isinstance(binds, list):
return binds

Expand All @@ -141,6 +141,13 @@ def convert_volume_binds(binds):
mode = v['mode']
else:
mode = 'rw'

#this is only relevant for linux-hosts; doesn't work in Docker Desktop
if 'propagation' in v and v['propagation'] in ('rshared','shared','rslave','slave','rprivate','private'):
if mode:
mode = ','.join([mode, v['propagation']])
else:
mode = v['propagation']

result.append(
f'{k}:{bind}:{mode}'
Expand Down
38 changes: 37 additions & 1 deletion tests/integration/api_container_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -542,6 +542,24 @@ def test_create_with_binds_ro(self):
inspect_data = self.client.inspect_container(container)
self.check_container_data(inspect_data, False)

def test_create_with_binds_rw_rshared(self):
self.run_with_volume_propagation(
False,
'rshared',
TEST_IMG,
['touch', os.path.join(self.mount_dest, self.filename)],
)
container = self.run_with_volume_propagation(
True,
'rshared',
TEST_IMG,
['ls', self.mount_dest],
)
logs = self.client.logs(container).decode('utf-8')
assert self.filename in logs
inspect_data = self.client.inspect_container(container)
self.check_container_data(inspect_data, True, 'rshared')

@requires_api_version('1.30')
def test_create_with_mounts(self):
mount = docker.types.Mount(
Expand Down Expand Up @@ -597,7 +615,7 @@ def test_create_with_volume_mount(self):
assert mount['Source'] == mount_data['Name']
assert mount_data['RW'] is True

def check_container_data(self, inspect_data, rw):
def check_container_data(self, inspect_data, rw, propagation='rprivate'):
assert 'Mounts' in inspect_data
filtered = list(filter(
lambda x: x['Destination'] == self.mount_dest,
Expand All @@ -607,6 +625,7 @@ def check_container_data(self, inspect_data, rw):
mount_data = filtered[0]
assert mount_data['Source'] == self.mount_origin
assert mount_data['RW'] == rw
assert mount_data['Propagation'] == propagation

def run_with_volume(self, ro, *args, **kwargs):
return self.run_container(
Expand All @@ -624,6 +643,23 @@ def run_with_volume(self, ro, *args, **kwargs):
**kwargs
)

def run_with_volume_propagation(self, ro, propagation, *args, **kwargs):
return self.run_container(
*args,
volumes={self.mount_dest: {}},
host_config=self.client.create_host_config(
binds={
self.mount_origin: {
'bind': self.mount_dest,
'ro': ro,
'propagation': propagation
},
},
network_mode='none'
),
**kwargs
)


class ArchiveTest(BaseAPIIntegrationTest):
def test_get_file_archive_from_container(self):
Expand Down

0 comments on commit 52ad769

Please sign in to comment.