Added devices configuration option

Signed-off-by: Dan Elbert <dan.elbert@gmail.com>

Author: delbert-umn

compose/config.py

@@ -10,6 +10,7 @@
 'cpuset',
 'command',
 'detach',
+'devices',
 'dns',
 'dns_search',
 'domainname',
@@ -50,6 +51,7 @@
 'add_host': 'extra_hosts',
 'hosts': 'extra_hosts',
 'extra_host': 'extra_hosts',
+'device': 'devices',
 'link': 'links',
 'port': 'ports',
 'privilege': 'privileged',
@@ -200,11 +202,14 @@ def merge_service_dicts(base, override):
 override.get('environment'),
  )
 
-if'volumes'inbaseor'volumes'inoverride:
-d['volumes'] =merge_volumes(
-base.get('volumes'),
-override.get('volumes'),
- )
+path_mapping_keys= ['volumes', 'devices']
+
+forkeyinpath_mapping_keys:
+ifkeyinbaseorkeyinoverride:
+d[key] =merge_path_mappings(
+base.get(key),
+override.get(key),
+ )
 
 if'labels'inbaseor'labels'inoverride:
 d['labels'] =merge_labels(
@@ -230,7 +235,7 @@ def merge_service_dicts(base, override):
 ifkeyinbaseorkeyinoverride:
 d[key] =to_list(base.get(key)) +to_list(override.get(key))
 
-already_merged_keys= ['environment', 'volumes', 'labels'] +list_keys+list_or_string_keys
+already_merged_keys= ['environment', 'labels']+path_mapping_keys+list_keys+list_or_string_keys
 
 forkinset(ALLOWED_KEYS) -set(already_merged_keys):
 ifkinoverride:
@@ -346,7 +351,7 @@ def resolve_host_paths(volumes, working_dir=None):
 
 
 defresolve_host_path(volume, working_dir):
-container_path, host_path=split_volume(volume)
+container_path, host_path=split_path_mapping(volume)
 ifhost_pathisnotNone:
 host_path=os.path.expanduser(host_path)
 host_path=os.path.expandvars(host_path)
@@ -368,32 +373,32 @@ def validate_paths(service_dict):
 raiseConfigurationError("build path %s either does not exist or is not accessible."%build_path)
 
 
-defmerge_volumes(base, override):
-d=dict_from_volumes(base)
-d.update(dict_from_volumes(override))
-returnvolumes_from_dict(d)
+defmerge_path_mappings(base, override):
+d=dict_from_path_mappings(base)
+d.update(dict_from_path_mappings(override))
+returnpath_mappings_from_dict(d)
 
 
-defdict_from_volumes(volumes):
-ifvolumes:
-returndict(split_volume(v) forvinvolumes)
+defdict_from_path_mappings(path_mappings):
+ifpath_mappings:
+returndict(split_path_mapping(v) forvinpath_mappings)
 else:
 return {}
 
 
-defvolumes_from_dict(d):
-return [join_volume(v) forvind.items()]
+defpath_mappings_from_dict(d):
+return [join_path_mapping(v) forvind.items()]
 
 
-defsplit_volume(string):
+defsplit_path_mapping(string):
 if':'instring:
  (host, container) =string.split(':', 1)
 return (container, host)
 else:
 return (string, None)
 
 
-defjoin_volume(pair):
+defjoin_path_mapping(pair):
  (container, host) =pair
 ifhostisNone:
 returncontainer

compose/service.py

@@ -20,6 +20,7 @@
 DOCKER_START_KEYS= [
 'cap_add',
 'cap_drop',
+'devices',
 'dns',
 'dns_search',
 'env_file',
@@ -441,13 +442,16 @@ def _get_container_host_config(self, override_options, one_off=False):
 extra_hosts=build_extra_hosts(options.get('extra_hosts', None))
 read_only=options.get('read_only', None)
 
+devices=options.get('devices', None)
+
 returncreate_host_config(
 links=self._get_links(link_to_self=one_off),
 port_bindings=port_bindings,
 binds=volume_bindings,
 volumes_from=options.get('volumes_from'),
 privileged=privileged,
 network_mode=self._get_net(),
+devices=devices,
 dns=dns,
 dns_search=dns_search,
 restart_policy=restart,

docs/extends.md

@@ -342,8 +342,8 @@ environment:
  - BAZ=local
 ```
 
-Finally, for `volumes`, Compose "merges" entries together with locally-defined
-bindings taking precedence:
+Finally, for `volumes` and `devices`, Compose "merges" entries together with
+locally-defined bindings taking precedence:
 
 ```yaml
 # original service
@@ -361,4 +361,4 @@ volumes:
  - /original-dir/foo:/foo
  - /local-dir/bar:/bar
  - /local-dir/baz/:baz
-```
+```

docs/yml.md

@@ -29,8 +29,8 @@ image: a4bc65fd
 
 ### build
 
-Path to a directory containing a Dockerfile. When the value supplied is a
-relative path, it is interpreted as relative to the location of the yml file
+Path to a directory containing a Dockerfile. When the value supplied is a
+relative path, it is interpreted as relative to the location of the yml file
 itself. This directory is also the build context that is sent to the Docker daemon.
 
 Compose will build and tag it with a generated name, and use that image thereafter.
@@ -342,6 +342,16 @@ dns_search:
  - dc2.example.com
 ```
 
+### devices
+
+List of device mappings. Uses the same format as the `--device` docker 
+client create option.
+
+```
+devices:
+ - "/dev/ttyUSB0:/dev/ttyUSB0"
+```
+
 ### working\_dir, entrypoint, user, hostname, domainname, mem\_limit, privileged, restart, stdin\_open, tty, cpu\_shares, cpuset, read\_only
 
 Each of these is a single value, analogous to its

tests/integration/service_test.py

@@ -669,3 +669,16 @@ def test_log_drive_none(self):
 
 self.assertEqual('none', log_config['Type'])
 self.assertFalse(log_config['Config'])
+
+deftest_devices(self):
+service=self.create_service('web', devices=["/dev/random:/dev/mapped-random"])
+device_config=create_and_start_container(service).get('HostConfig.Devices')
+
+device_dict= {
+'PathOnHost': '/dev/random',
+'CgroupPermissions': 'rwm',
+'PathInContainer': '/dev/mapped-random'
+ }
+
+self.assertEqual(1, len(device_config))
+self.assertDictEqual(device_dict, device_config[0])

tests/unit/config_test.py

@@ -54,46 +54,61 @@ def test_volume_binding_with_home(self):
 self.assertEqual(d['volumes'], ['/home/user:/container/path'])
 
 
-classMergeVolumesTest(unittest.TestCase):
+classMergePathMappingTest(object):
+defconfig_name(self):
+return""
+
 deftest_empty(self):
 service_dict=config.merge_service_dicts({}, {})
-self.assertNotIn('volumes', service_dict)
+self.assertNotIn(self.config_name(), service_dict)
 
 deftest_no_override(self):
 service_dict=config.merge_service_dicts(
- {'volumes': ['/foo:/code', '/data']},
+ {self.config_name(): ['/foo:/code', '/data']},
  {},
  )
-self.assertEqual(set(service_dict['volumes']), set(['/foo:/code', '/data']))
+self.assertEqual(set(service_dict[self.config_name()]), set(['/foo:/code', '/data']))
 
 deftest_no_base(self):
 service_dict=config.merge_service_dicts(
  {},
- {'volumes': ['/bar:/code']},
+ {self.config_name(): ['/bar:/code']},
  )
-self.assertEqual(set(service_dict['volumes']), set(['/bar:/code']))
+self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code']))
 
 deftest_override_explicit_path(self):
 service_dict=config.merge_service_dicts(
- {'volumes': ['/foo:/code', '/data']},
- {'volumes': ['/bar:/code']},
+ {self.config_name(): ['/foo:/code', '/data']},
+ {self.config_name(): ['/bar:/code']},
  )
-self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/data']))
+self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))
 
 deftest_add_explicit_path(self):
 service_dict=config.merge_service_dicts(
- {'volumes': ['/foo:/code', '/data']},
- {'volumes': ['/bar:/code', '/quux:/data']},
+ {self.config_name(): ['/foo:/code', '/data']},
+ {self.config_name(): ['/bar:/code', '/quux:/data']},
  )
-self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/quux:/data']))
+self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/quux:/data']))
 
 deftest_remove_explicit_path(self):
 service_dict=config.merge_service_dicts(
- {'volumes': ['/foo:/code', '/quux:/data']},
- {'volumes': ['/bar:/code', '/data']},
+ {self.config_name(): ['/foo:/code', '/quux:/data']},
+ {self.config_name(): ['/bar:/code', '/data']},
  )
-self.assertEqual(set(service_dict['volumes']), set(['/bar:/code', '/data']))
+self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))
+
+
+classMergeVolumesTest(unittest.TestCase, MergePathMappingTest):
+defconfig_name(self):
+return'volumes'
+
+
+classMergeDevicesTest(unittest.TestCase, MergePathMappingTest):
+defconfig_name(self):
+return'devices'
+
 
+classBuildOrImageMergeTest(unittest.TestCase):
 deftest_merge_build_or_image_no_override(self):
 self.assertEqual(
 config.merge_service_dicts({'build': '.'}, {}),