Skip to content

Commit b8cec3f

Browse files
committed
Use individual volumes for recreate instead of volumes_from
Signed-off-by: Daniel Nephin <dnephin@gmail.com>
1 parent 1748b0f commit b8cec3f

File tree

4 files changed

+137
-35
lines changed

4 files changed

+137
-35
lines changed

compose/container.py

+4
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ def id(self):
4444
def image(self):
4545
return self.dictionary['Image']
4646

47+
@property
48+
def image_config(self):
49+
return self.client.inspect_image(self.image)
50+
4751
@property
4852
def short_id(self):
4953
return self.id[:10]

compose/service.py

+59-15
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,10 @@
33
from collections import namedtuple
44
import logging
55
import re
6-
from operator import attrgetter
76
import sys
8-
import six
7+
from operator import attrgetter
98

9+
import six
1010
from docker.errors import APIError
1111
from docker.utils import create_host_config, LogConfig
1212

@@ -182,10 +182,10 @@ def create_container(self,
182182
Create a container for this service. If the image doesn't exist, attempt to pull
183183
it.
184184
"""
185-
override_options['volumes_from'] = self._get_volumes_from(previous_container)
186185
container_options = self._get_container_create_options(
187186
override_options,
188187
one_off=one_off,
188+
previous_container=previous_container,
189189
)
190190

191191
if (do_build and
@@ -325,7 +325,7 @@ def _get_links(self, link_to_self):
325325
links.append((external_link, link_name))
326326
return links
327327

328-
def _get_volumes_from(self, previous_container=None):
328+
def _get_volumes_from(self):
329329
volumes_from = []
330330
for volume_source in self.volumes_from:
331331
if isinstance(volume_source, Service):
@@ -338,9 +338,6 @@ def _get_volumes_from(self, previous_container=None):
338338
elif isinstance(volume_source, Container):
339339
volumes_from.append(volume_source.id)
340340

341-
if previous_container:
342-
volumes_from.append(previous_container.id)
343-
344341
return volumes_from
345342

346343
def _get_net(self):
@@ -362,7 +359,11 @@ def _get_net(self):
362359

363360
return net
364361

365-
def _get_container_create_options(self, override_options, one_off=False):
362+
def _get_container_create_options(
363+
self,
364+
override_options,
365+
one_off=False,
366+
previous_container=None):
366367
container_options = dict(
367368
(k, self.options[k])
368369
for k in DOCKER_CONFIG_KEYS if k in self.options)
@@ -395,6 +396,10 @@ def _get_container_create_options(self, override_options, one_off=False):
395396
ports.append(port)
396397
container_options['ports'] = ports
397398

399+
override_options['binds'] = merge_volume_bindings(
400+
container_options.get('volumes') or [],
401+
previous_container)
402+
398403
if 'volumes' in container_options:
399404
container_options['volumes'] = dict(
400405
(parse_volume_spec(v).internal, {})
@@ -417,11 +422,6 @@ def _get_container_host_config(self, override_options, one_off=False):
417422
options = dict(self.options, **override_options)
418423
port_bindings = build_port_bindings(options.get('ports') or [])
419424

420-
volume_bindings = dict(
421-
build_volume_binding(parse_volume_spec(volume))
422-
for volume in options.get('volumes') or []
423-
if ':' in volume)
424-
425425
privileged = options.get('privileged', False)
426426
cap_add = options.get('cap_add', None)
427427
cap_drop = options.get('cap_drop', None)
@@ -444,8 +444,8 @@ def _get_container_host_config(self, override_options, one_off=False):
444444
return create_host_config(
445445
links=self._get_links(link_to_self=one_off),
446446
port_bindings=port_bindings,
447-
binds=volume_bindings,
448-
volumes_from=options.get('volumes_from'),
447+
binds=options.get('binds'),
448+
volumes_from=self._get_volumes_from(),
449449
privileged=privileged,
450450
network_mode=self._get_net(),
451451
dns=dns,
@@ -527,6 +527,50 @@ def pull(self, insecure_registry=False):
527527
stream_output(output, sys.stdout)
528528

529529

530+
def get_container_data_volumes(container, volumes_option):
531+
"""Find the container data volumes that are in `volumes_option`, and return
532+
a mapping of volume bindings for those volumes.
533+
"""
534+
volumes = []
535+
536+
volumes_option = volumes_option or []
537+
container_volumes = container.get('Volumes') or {}
538+
image_volumes = container.image_config['ContainerConfig'].get('Volumes') or {}
539+
540+
for volume in set(volumes_option + image_volumes.keys()):
541+
volume = parse_volume_spec(volume)
542+
# No need to preserve host volumes
543+
if volume.external:
544+
continue
545+
546+
volume_path = container_volumes.get(volume.internal)
547+
# New volume, doesn't exist in the old container
548+
if not volume_path:
549+
continue
550+
551+
# Copy existing volume from old container
552+
volume = volume._replace(external=volume_path)
553+
volumes.append(build_volume_binding(volume))
554+
555+
return dict(volumes)
556+
557+
558+
def merge_volume_bindings(volumes_option, previous_container):
559+
"""Return a list of volume bindings for a container. Container data volumes
560+
are replaced by those from the previous container.
561+
"""
562+
volume_bindings = dict(
563+
build_volume_binding(parse_volume_spec(volume))
564+
for volume in volumes_option or []
565+
if ':' in volume)
566+
567+
if previous_container:
568+
volume_bindings.update(
569+
get_container_data_volumes(previous_container, volumes_option))
570+
571+
return volume_bindings
572+
573+
530574
NAME_RE = re.compile(r'^([^_]+)_([^_]+)_(run_)?(\d+)$')
531575

532576

tests/integration/service_test.py

+11-13
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ def test_create_container_with_unspecified_volume(self):
107107
service = self.create_service('db', volumes=['/var/db'])
108108
container = service.create_container()
109109
service.start_container(container)
110-
self.assertIn('/var/db', container.inspect()['Volumes'])
110+
self.assertIn('/var/db', container.get('Volumes'))
111111

112112
def test_create_container_with_cpu_shares(self):
113113
service = self.create_service('db', cpu_shares=73)
@@ -239,24 +239,24 @@ def test_recreate_containers(self):
239239
command=['300']
240240
)
241241
old_container = service.create_container()
242-
self.assertEqual(old_container.dictionary['Config']['Entrypoint'], ['sleep'])
243-
self.assertEqual(old_container.dictionary['Config']['Cmd'], ['300'])
244-
self.assertIn('FOO=1', old_container.dictionary['Config']['Env'])
242+
self.assertEqual(old_container.get('Config.Entrypoint'), ['sleep'])
243+
self.assertEqual(old_container.get('Config.Cmd'), ['300'])
244+
self.assertIn('FOO=1', old_container.get('Config.Env'))
245245
self.assertEqual(old_container.name, 'composetest_db_1')
246246
service.start_container(old_container)
247-
volume_path = old_container.inspect()['Volumes']['/etc']
247+
old_container.inspect() # reload volume data
248+
volume_path = old_container.get('Volumes')['/etc']
248249

249250
num_containers_before = len(self.client.containers(all=True))
250251

251252
service.options['environment']['FOO'] = '2'
252253
new_container, = service.recreate_containers()
253254

254-
self.assertEqual(new_container.dictionary['Config']['Entrypoint'], ['sleep'])
255-
self.assertEqual(new_container.dictionary['Config']['Cmd'], ['300'])
256-
self.assertIn('FOO=2', new_container.dictionary['Config']['Env'])
255+
self.assertEqual(new_container.get('Config.Entrypoint'), ['sleep'])
256+
self.assertEqual(new_container.get('Config.Cmd'), ['300'])
257+
self.assertIn('FOO=2', new_container.get('Config.Env'))
257258
self.assertEqual(new_container.name, 'composetest_db_1')
258-
self.assertEqual(new_container.inspect()['Volumes']['/etc'], volume_path)
259-
self.assertIn(old_container.id, new_container.dictionary['HostConfig']['VolumesFrom'])
259+
self.assertEqual(new_container.get('Volumes')['/etc'], volume_path)
260260

261261
self.assertEqual(len(self.client.containers(all=True)), num_containers_before)
262262
self.assertNotEqual(old_container.id, new_container.id)
@@ -289,9 +289,7 @@ def test_recreate_containers_with_image_declared_volume(self):
289289
self.assertEqual(old_container.get('Volumes').keys(), ['/data'])
290290
volume_path = old_container.get('Volumes')['/data']
291291

292-
service.recreate_containers()
293-
new_container = service.containers()[0]
294-
service.start_container(new_container)
292+
new_container = service.recreate_containers()[0]
295293
self.assertEqual(new_container.get('Volumes').keys(), ['/data'])
296294
self.assertEqual(new_container.get('Volumes')['/data'], volume_path)
297295

tests/unit/service_test.py

+63-7
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,9 @@
1414
ConfigError,
1515
build_port_bindings,
1616
build_volume_binding,
17+
get_container_data_volumes,
1718
get_container_name,
19+
merge_volume_bindings,
1820
parse_repository_tag,
1921
parse_volume_spec,
2022
split_port,
@@ -86,13 +88,6 @@ def test_get_volumes_from_container(self):
8688

8789
self.assertEqual(service._get_volumes_from(), [container_id])
8890

89-
def test_get_volumes_from_previous_container(self):
90-
container_id = 'aabbccddee'
91-
service = Service('test', image='foo')
92-
container = mock.Mock(id=container_id, spec=Container, image='foo')
93-
94-
self.assertEqual(service._get_volumes_from(container), [container_id])
95-
9691
def test_get_volumes_from_service_container_exists(self):
9792
container_ids = ['aabbccddee', '12345']
9893
from_service = mock.create_autospec(Service)
@@ -320,6 +315,9 @@ def test_create_container_no_build(self):
320315

321316
class ServiceVolumesTest(unittest.TestCase):
322317

318+
def setUp(self):
319+
self.mock_client = mock.create_autospec(docker.Client)
320+
323321
def test_parse_volume_spec_only_one_path(self):
324322
spec = parse_volume_spec('/the/volume')
325323
self.assertEqual(spec, (None, '/the/volume', 'rw'))
@@ -345,3 +343,61 @@ def test_build_volume_binding(self):
345343
self.assertEqual(
346344
binding,
347345
('/outside', dict(bind='/inside', ro=False)))
346+
347+
def test_get_container_data_volumes(self):
348+
options = [
349+
'/host/volume:/host/volume:ro',
350+
'/new/volume',
351+
'/existing/volume',
352+
]
353+
354+
self.mock_client.inspect_image.return_value = {
355+
'ContainerConfig': {
356+
'Volumes': {
357+
'/mnt/image/data': {},
358+
}
359+
}
360+
}
361+
container = Container(self.mock_client, {
362+
'Image': 'ababab',
363+
'Volumes': {
364+
'/host/volume': '/host/volume',
365+
'/existing/volume': '/var/lib/docker/aaaaaaaa',
366+
'/removed/volume': '/var/lib/docker/bbbbbbbb',
367+
'/mnt/image/data': '/var/lib/docker/cccccccc',
368+
},
369+
}, has_been_inspected=True)
370+
371+
expected = {
372+
'/var/lib/docker/aaaaaaaa': {'bind': '/existing/volume', 'ro': False},
373+
'/var/lib/docker/cccccccc': {'bind': '/mnt/image/data', 'ro': False},
374+
}
375+
376+
binds = get_container_data_volumes(container, options)
377+
self.assertEqual(binds, expected)
378+
379+
def test_merge_volume_bindings(self):
380+
options = [
381+
'/host/volume:/host/volume:ro',
382+
'/host/rw/volume:/host/rw/volume',
383+
'/new/volume',
384+
'/existing/volume',
385+
]
386+
387+
self.mock_client.inspect_image.return_value = {
388+
'ContainerConfig': {'Volumes': {}}
389+
}
390+
391+
intermediate_container = Container(self.mock_client, {
392+
'Image': 'ababab',
393+
'Volumes': {'/existing/volume': '/var/lib/docker/aaaaaaaa'},
394+
}, has_been_inspected=True)
395+
396+
expected = {
397+
'/host/volume': {'bind': '/host/volume', 'ro': True},
398+
'/host/rw/volume': {'bind': '/host/rw/volume', 'ro': False},
399+
'/var/lib/docker/aaaaaaaa': {'bind': '/existing/volume', 'ro': False},
400+
}
401+
402+
binds = merge_volume_bindings(options, intermediate_container)
403+
self.assertEqual(binds, expected)

0 commit comments

Comments
 (0)