config_test.py 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814
  1. import mock
  2. import os
  3. import shutil
  4. import tempfile
  5. from .. import unittest
  6. from compose.config import config
  7. def make_service_dict(name, service_dict, working_dir):
  8. """
  9. Test helper function to contruct a ServiceLoader
  10. """
  11. return config.ServiceLoader(working_dir=working_dir).make_service_dict(name, service_dict)
  12. class ConfigTest(unittest.TestCase):
  13. def test_load(self):
  14. service_dicts = config.load(
  15. config.ConfigDetails(
  16. {
  17. 'foo': {'image': 'busybox'},
  18. 'bar': {'image': 'busybox', 'environment': ['FOO=1']},
  19. },
  20. 'tests/fixtures/extends',
  21. 'common.yml'
  22. )
  23. )
  24. self.assertEqual(
  25. sorted(service_dicts, key=lambda d: d['name']),
  26. sorted([
  27. {
  28. 'name': 'bar',
  29. 'image': 'busybox',
  30. 'environment': {'FOO': '1'},
  31. },
  32. {
  33. 'name': 'foo',
  34. 'image': 'busybox',
  35. }
  36. ], key=lambda d: d['name'])
  37. )
  38. def test_load_throws_error_when_not_dict(self):
  39. with self.assertRaises(config.ConfigurationError):
  40. config.load(
  41. config.ConfigDetails(
  42. {'web': 'busybox:latest'},
  43. 'working_dir',
  44. 'filename.yml'
  45. )
  46. )
  47. def test_config_validation(self):
  48. self.assertRaises(
  49. config.ConfigurationError,
  50. lambda: make_service_dict('foo', {'port': ['8000']}, 'tests/')
  51. )
  52. make_service_dict('foo', {'ports': ['8000']}, 'tests/')
  53. def test_config_invalid_service_names(self):
  54. with self.assertRaises(config.ConfigurationError):
  55. for invalid_name in ['?not?allowed', ' ', '', '!', '/', '\xe2']:
  56. config.load(
  57. config.ConfigDetails(
  58. {invalid_name: {'image': 'busybox'}},
  59. 'working_dir',
  60. 'filename.yml'
  61. )
  62. )
  63. def test_config_valid_service_names(self):
  64. for valid_name in ['_', '-', '.__.', '_what-up.', 'what_.up----', 'whatup']:
  65. config.load(
  66. config.ConfigDetails(
  67. {valid_name: {'image': 'busybox'}},
  68. 'tests/fixtures/extends',
  69. 'common.yml'
  70. )
  71. )
  72. class InterpolationTest(unittest.TestCase):
  73. @mock.patch.dict(os.environ)
  74. def test_config_file_with_environment_variable(self):
  75. os.environ.update(
  76. IMAGE="busybox",
  77. HOST_PORT="80",
  78. LABEL_VALUE="myvalue",
  79. )
  80. service_dicts = config.load(
  81. config.find('tests/fixtures/environment-interpolation', None),
  82. )
  83. self.assertEqual(service_dicts, [
  84. {
  85. 'name': 'web',
  86. 'image': 'busybox',
  87. 'ports': ['80:8000'],
  88. 'labels': {'mylabel': 'myvalue'},
  89. 'hostname': 'host-',
  90. 'command': '${ESCAPED}',
  91. }
  92. ])
  93. @mock.patch.dict(os.environ)
  94. def test_invalid_interpolation(self):
  95. with self.assertRaises(config.ConfigurationError) as cm:
  96. config.load(
  97. config.ConfigDetails(
  98. {'web': {'image': '${'}},
  99. 'working_dir',
  100. 'filename.yml'
  101. )
  102. )
  103. self.assertIn('Invalid', cm.exception.msg)
  104. self.assertIn('for "image" option', cm.exception.msg)
  105. self.assertIn('in service "web"', cm.exception.msg)
  106. self.assertIn('"${"', cm.exception.msg)
  107. @mock.patch.dict(os.environ)
  108. def test_volume_binding_with_environment_variable(self):
  109. os.environ['VOLUME_PATH'] = '/host/path'
  110. d = config.load(
  111. config.ConfigDetails(
  112. config={'foo': {'volumes': ['${VOLUME_PATH}:/container/path']}},
  113. working_dir='.',
  114. filename=None,
  115. )
  116. )[0]
  117. self.assertEqual(d['volumes'], ['/host/path:/container/path'])
  118. @mock.patch.dict(os.environ)
  119. def test_volume_binding_with_home(self):
  120. os.environ['HOME'] = '/home/user'
  121. d = make_service_dict('foo', {'volumes': ['~:/container/path']}, working_dir='.')
  122. self.assertEqual(d['volumes'], ['/home/user:/container/path'])
  123. def test_named_volume_with_driver_does_not_expand(self):
  124. d = make_service_dict('foo', {
  125. 'volumes': ['namedvolume:/data'],
  126. 'volume_driver': 'foodriver',
  127. }, working_dir='.')
  128. self.assertEqual(d['volumes'], ['namedvolume:/data'])
  129. @mock.patch.dict(os.environ)
  130. def test_home_directory_with_driver_does_not_expand(self):
  131. os.environ['NAME'] = 'surprise!'
  132. d = make_service_dict('foo', {
  133. 'volumes': ['~:/data'],
  134. 'volume_driver': 'foodriver',
  135. }, working_dir='.')
  136. self.assertEqual(d['volumes'], ['~:/data'])
  137. class MergePathMappingTest(object):
  138. def config_name(self):
  139. return ""
  140. def test_empty(self):
  141. service_dict = config.merge_service_dicts({}, {})
  142. self.assertNotIn(self.config_name(), service_dict)
  143. def test_no_override(self):
  144. service_dict = config.merge_service_dicts(
  145. {self.config_name(): ['/foo:/code', '/data']},
  146. {},
  147. )
  148. self.assertEqual(set(service_dict[self.config_name()]), set(['/foo:/code', '/data']))
  149. def test_no_base(self):
  150. service_dict = config.merge_service_dicts(
  151. {},
  152. {self.config_name(): ['/bar:/code']},
  153. )
  154. self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code']))
  155. def test_override_explicit_path(self):
  156. service_dict = config.merge_service_dicts(
  157. {self.config_name(): ['/foo:/code', '/data']},
  158. {self.config_name(): ['/bar:/code']},
  159. )
  160. self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))
  161. def test_add_explicit_path(self):
  162. service_dict = config.merge_service_dicts(
  163. {self.config_name(): ['/foo:/code', '/data']},
  164. {self.config_name(): ['/bar:/code', '/quux:/data']},
  165. )
  166. self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/quux:/data']))
  167. def test_remove_explicit_path(self):
  168. service_dict = config.merge_service_dicts(
  169. {self.config_name(): ['/foo:/code', '/quux:/data']},
  170. {self.config_name(): ['/bar:/code', '/data']},
  171. )
  172. self.assertEqual(set(service_dict[self.config_name()]), set(['/bar:/code', '/data']))
  173. class MergeVolumesTest(unittest.TestCase, MergePathMappingTest):
  174. def config_name(self):
  175. return 'volumes'
  176. class MergeDevicesTest(unittest.TestCase, MergePathMappingTest):
  177. def config_name(self):
  178. return 'devices'
  179. class BuildOrImageMergeTest(unittest.TestCase):
  180. def test_merge_build_or_image_no_override(self):
  181. self.assertEqual(
  182. config.merge_service_dicts({'build': '.'}, {}),
  183. {'build': '.'},
  184. )
  185. self.assertEqual(
  186. config.merge_service_dicts({'image': 'redis'}, {}),
  187. {'image': 'redis'},
  188. )
  189. def test_merge_build_or_image_override_with_same(self):
  190. self.assertEqual(
  191. config.merge_service_dicts({'build': '.'}, {'build': './web'}),
  192. {'build': './web'},
  193. )
  194. self.assertEqual(
  195. config.merge_service_dicts({'image': 'redis'}, {'image': 'postgres'}),
  196. {'image': 'postgres'},
  197. )
  198. def test_merge_build_or_image_override_with_other(self):
  199. self.assertEqual(
  200. config.merge_service_dicts({'build': '.'}, {'image': 'redis'}),
  201. {'image': 'redis'}
  202. )
  203. self.assertEqual(
  204. config.merge_service_dicts({'image': 'redis'}, {'build': '.'}),
  205. {'build': '.'}
  206. )
  207. class MergeListsTest(unittest.TestCase):
  208. def test_empty(self):
  209. service_dict = config.merge_service_dicts({}, {})
  210. self.assertNotIn('ports', service_dict)
  211. def test_no_override(self):
  212. service_dict = config.merge_service_dicts(
  213. {'ports': ['10:8000', '9000']},
  214. {},
  215. )
  216. self.assertEqual(set(service_dict['ports']), set(['10:8000', '9000']))
  217. def test_no_base(self):
  218. service_dict = config.merge_service_dicts(
  219. {},
  220. {'ports': ['10:8000', '9000']},
  221. )
  222. self.assertEqual(set(service_dict['ports']), set(['10:8000', '9000']))
  223. def test_add_item(self):
  224. service_dict = config.merge_service_dicts(
  225. {'ports': ['10:8000', '9000']},
  226. {'ports': ['20:8000']},
  227. )
  228. self.assertEqual(set(service_dict['ports']), set(['10:8000', '9000', '20:8000']))
  229. class MergeStringsOrListsTest(unittest.TestCase):
  230. def test_no_override(self):
  231. service_dict = config.merge_service_dicts(
  232. {'dns': '8.8.8.8'},
  233. {},
  234. )
  235. self.assertEqual(set(service_dict['dns']), set(['8.8.8.8']))
  236. def test_no_base(self):
  237. service_dict = config.merge_service_dicts(
  238. {},
  239. {'dns': '8.8.8.8'},
  240. )
  241. self.assertEqual(set(service_dict['dns']), set(['8.8.8.8']))
  242. def test_add_string(self):
  243. service_dict = config.merge_service_dicts(
  244. {'dns': ['8.8.8.8']},
  245. {'dns': '9.9.9.9'},
  246. )
  247. self.assertEqual(set(service_dict['dns']), set(['8.8.8.8', '9.9.9.9']))
  248. def test_add_list(self):
  249. service_dict = config.merge_service_dicts(
  250. {'dns': '8.8.8.8'},
  251. {'dns': ['9.9.9.9']},
  252. )
  253. self.assertEqual(set(service_dict['dns']), set(['8.8.8.8', '9.9.9.9']))
  254. class MergeLabelsTest(unittest.TestCase):
  255. def test_empty(self):
  256. service_dict = config.merge_service_dicts({}, {})
  257. self.assertNotIn('labels', service_dict)
  258. def test_no_override(self):
  259. service_dict = config.merge_service_dicts(
  260. make_service_dict('foo', {'labels': ['foo=1', 'bar']}, 'tests/'),
  261. make_service_dict('foo', {}, 'tests/'),
  262. )
  263. self.assertEqual(service_dict['labels'], {'foo': '1', 'bar': ''})
  264. def test_no_base(self):
  265. service_dict = config.merge_service_dicts(
  266. make_service_dict('foo', {}, 'tests/'),
  267. make_service_dict('foo', {'labels': ['foo=2']}, 'tests/'),
  268. )
  269. self.assertEqual(service_dict['labels'], {'foo': '2'})
  270. def test_override_explicit_value(self):
  271. service_dict = config.merge_service_dicts(
  272. make_service_dict('foo', {'labels': ['foo=1', 'bar']}, 'tests/'),
  273. make_service_dict('foo', {'labels': ['foo=2']}, 'tests/'),
  274. )
  275. self.assertEqual(service_dict['labels'], {'foo': '2', 'bar': ''})
  276. def test_add_explicit_value(self):
  277. service_dict = config.merge_service_dicts(
  278. make_service_dict('foo', {'labels': ['foo=1', 'bar']}, 'tests/'),
  279. make_service_dict('foo', {'labels': ['bar=2']}, 'tests/'),
  280. )
  281. self.assertEqual(service_dict['labels'], {'foo': '1', 'bar': '2'})
  282. def test_remove_explicit_value(self):
  283. service_dict = config.merge_service_dicts(
  284. make_service_dict('foo', {'labels': ['foo=1', 'bar=2']}, 'tests/'),
  285. make_service_dict('foo', {'labels': ['bar']}, 'tests/'),
  286. )
  287. self.assertEqual(service_dict['labels'], {'foo': '1', 'bar': ''})
  288. class MemoryOptionsTest(unittest.TestCase):
  289. def test_validation_fails_with_just_memswap_limit(self):
  290. """
  291. When you set a 'memswap_limit' it is invalid config unless you also set
  292. a mem_limit
  293. """
  294. with self.assertRaisesRegexp(config.ConfigurationError, "u'mem_limit' is a dependency of u'memswap_limit'"):
  295. config.load(
  296. config.ConfigDetails(
  297. {
  298. 'foo': {'image': 'busybox', 'memswap_limit': 2000000},
  299. },
  300. 'tests/fixtures/extends',
  301. 'filename.yml'
  302. )
  303. )
  304. def test_validation_with_correct_memswap_values(self):
  305. service_dict = config.load(
  306. config.ConfigDetails(
  307. {'foo': {'image': 'busybox', 'mem_limit': 1000000, 'memswap_limit': 2000000}},
  308. 'tests/fixtures/extends',
  309. 'common.yml'
  310. )
  311. )
  312. self.assertEqual(service_dict[0]['memswap_limit'], 2000000)
  313. class EnvTest(unittest.TestCase):
  314. def test_parse_environment_as_list(self):
  315. environment = [
  316. 'NORMAL=F1',
  317. 'CONTAINS_EQUALS=F=2',
  318. 'TRAILING_EQUALS=',
  319. ]
  320. self.assertEqual(
  321. config.parse_environment(environment),
  322. {'NORMAL': 'F1', 'CONTAINS_EQUALS': 'F=2', 'TRAILING_EQUALS': ''},
  323. )
  324. def test_parse_environment_as_dict(self):
  325. environment = {
  326. 'NORMAL': 'F1',
  327. 'CONTAINS_EQUALS': 'F=2',
  328. 'TRAILING_EQUALS': None,
  329. }
  330. self.assertEqual(config.parse_environment(environment), environment)
  331. def test_parse_environment_invalid(self):
  332. with self.assertRaises(config.ConfigurationError):
  333. config.parse_environment('a=b')
  334. def test_parse_environment_empty(self):
  335. self.assertEqual(config.parse_environment(None), {})
  336. @mock.patch.dict(os.environ)
  337. def test_resolve_environment(self):
  338. os.environ['FILE_DEF'] = 'E1'
  339. os.environ['FILE_DEF_EMPTY'] = 'E2'
  340. os.environ['ENV_DEF'] = 'E3'
  341. service_dict = make_service_dict(
  342. 'foo', {
  343. 'environment': {
  344. 'FILE_DEF': 'F1',
  345. 'FILE_DEF_EMPTY': '',
  346. 'ENV_DEF': None,
  347. 'NO_DEF': None
  348. },
  349. },
  350. 'tests/'
  351. )
  352. self.assertEqual(
  353. service_dict['environment'],
  354. {'FILE_DEF': 'F1', 'FILE_DEF_EMPTY': '', 'ENV_DEF': 'E3', 'NO_DEF': ''},
  355. )
  356. def test_env_from_file(self):
  357. service_dict = make_service_dict(
  358. 'foo',
  359. {'env_file': 'one.env'},
  360. 'tests/fixtures/env',
  361. )
  362. self.assertEqual(
  363. service_dict['environment'],
  364. {'ONE': '2', 'TWO': '1', 'THREE': '3', 'FOO': 'bar'},
  365. )
  366. def test_env_from_multiple_files(self):
  367. service_dict = make_service_dict(
  368. 'foo',
  369. {'env_file': ['one.env', 'two.env']},
  370. 'tests/fixtures/env',
  371. )
  372. self.assertEqual(
  373. service_dict['environment'],
  374. {'ONE': '2', 'TWO': '1', 'THREE': '3', 'FOO': 'baz', 'DOO': 'dah'},
  375. )
  376. def test_env_nonexistent_file(self):
  377. options = {'env_file': 'nonexistent.env'}
  378. self.assertRaises(
  379. config.ConfigurationError,
  380. lambda: make_service_dict('foo', options, 'tests/fixtures/env'),
  381. )
  382. @mock.patch.dict(os.environ)
  383. def test_resolve_environment_from_file(self):
  384. os.environ['FILE_DEF'] = 'E1'
  385. os.environ['FILE_DEF_EMPTY'] = 'E2'
  386. os.environ['ENV_DEF'] = 'E3'
  387. service_dict = make_service_dict(
  388. 'foo',
  389. {'env_file': 'resolve.env'},
  390. 'tests/fixtures/env',
  391. )
  392. self.assertEqual(
  393. service_dict['environment'],
  394. {'FILE_DEF': 'F1', 'FILE_DEF_EMPTY': '', 'ENV_DEF': 'E3', 'NO_DEF': ''},
  395. )
  396. @mock.patch.dict(os.environ)
  397. def test_resolve_path(self):
  398. os.environ['HOSTENV'] = '/tmp'
  399. os.environ['CONTAINERENV'] = '/host/tmp'
  400. service_dict = config.load(
  401. config.ConfigDetails(
  402. config={'foo': {'volumes': ['$HOSTENV:$CONTAINERENV']}},
  403. working_dir="tests/fixtures/env",
  404. filename=None,
  405. )
  406. )[0]
  407. self.assertEqual(set(service_dict['volumes']), set(['/tmp:/host/tmp']))
  408. service_dict = config.load(
  409. config.ConfigDetails(
  410. config={'foo': {'volumes': ['/opt${HOSTENV}:/opt${CONTAINERENV}']}},
  411. working_dir="tests/fixtures/env",
  412. filename=None,
  413. )
  414. )[0]
  415. self.assertEqual(set(service_dict['volumes']), set(['/opt/tmp:/opt/host/tmp']))
  416. def load_from_filename(filename):
  417. return config.load(config.find('.', filename))
  418. class ExtendsTest(unittest.TestCase):
  419. def test_extends(self):
  420. service_dicts = load_from_filename('tests/fixtures/extends/docker-compose.yml')
  421. service_dicts = sorted(
  422. service_dicts,
  423. key=lambda sd: sd['name'],
  424. )
  425. self.assertEqual(service_dicts, [
  426. {
  427. 'name': 'mydb',
  428. 'image': 'busybox',
  429. 'command': 'top',
  430. },
  431. {
  432. 'name': 'myweb',
  433. 'image': 'busybox',
  434. 'command': 'top',
  435. 'links': ['mydb:db'],
  436. 'environment': {
  437. "FOO": "1",
  438. "BAR": "2",
  439. "BAZ": "2",
  440. },
  441. }
  442. ])
  443. def test_nested(self):
  444. service_dicts = load_from_filename('tests/fixtures/extends/nested.yml')
  445. self.assertEqual(service_dicts, [
  446. {
  447. 'name': 'myweb',
  448. 'image': 'busybox',
  449. 'command': '/bin/true',
  450. 'environment': {
  451. "FOO": "2",
  452. "BAR": "2",
  453. },
  454. },
  455. ])
  456. def test_self_referencing_file(self):
  457. """
  458. We specify a 'file' key that is the filename we're already in.
  459. """
  460. service_dicts = load_from_filename('tests/fixtures/extends/specify-file-as-self.yml')
  461. self.assertEqual(service_dicts, [
  462. {
  463. 'environment':
  464. {
  465. 'YEP': '1', 'BAR': '1', 'BAZ': '3'
  466. },
  467. 'image': 'busybox',
  468. 'name': 'myweb'
  469. },
  470. {
  471. 'environment':
  472. {'YEP': '1'},
  473. 'image': 'busybox',
  474. 'name': 'otherweb'
  475. },
  476. {
  477. 'environment':
  478. {'YEP': '1', 'BAZ': '3'},
  479. 'image': 'busybox',
  480. 'name': 'web'
  481. }
  482. ])
  483. def test_circular(self):
  484. try:
  485. load_from_filename('tests/fixtures/extends/circle-1.yml')
  486. raise Exception("Expected config.CircularReference to be raised")
  487. except config.CircularReference as e:
  488. self.assertEqual(
  489. [(os.path.basename(filename), service_name) for (filename, service_name) in e.trail],
  490. [
  491. ('circle-1.yml', 'web'),
  492. ('circle-2.yml', 'web'),
  493. ('circle-1.yml', 'web'),
  494. ],
  495. )
  496. def test_extends_validation_empty_dictionary(self):
  497. with self.assertRaisesRegexp(config.ConfigurationError, 'service'):
  498. config.load(
  499. config.ConfigDetails(
  500. {
  501. 'web': {'image': 'busybox', 'extends': {}},
  502. },
  503. 'tests/fixtures/extends',
  504. 'filename.yml'
  505. )
  506. )
  507. def test_extends_validation_missing_service_key(self):
  508. with self.assertRaisesRegexp(config.ConfigurationError, "u'service' is a required property"):
  509. config.load(
  510. config.ConfigDetails(
  511. {
  512. 'web': {'image': 'busybox', 'extends': {'file': 'common.yml'}},
  513. },
  514. 'tests/fixtures/extends',
  515. 'filename.yml'
  516. )
  517. )
  518. def test_extends_validation_invalid_key(self):
  519. with self.assertRaisesRegexp(config.ConfigurationError, "'rogue_key' was unexpected"):
  520. config.load(
  521. config.ConfigDetails(
  522. {
  523. 'web': {
  524. 'image': 'busybox',
  525. 'extends': {
  526. 'file': 'common.yml',
  527. 'service': 'web',
  528. 'rogue_key': 'is not allowed'
  529. }
  530. },
  531. },
  532. 'tests/fixtures/extends',
  533. 'filename.yml'
  534. )
  535. )
  536. def test_extends_validation_no_file_key_no_filename_set(self):
  537. dictionary = {'extends': {'service': 'web'}}
  538. def load_config():
  539. return make_service_dict('myweb', dictionary, working_dir='tests/fixtures/extends')
  540. self.assertRaisesRegexp(config.ConfigurationError, 'file', load_config)
  541. def test_extends_validation_valid_config(self):
  542. service = config.load(
  543. config.ConfigDetails(
  544. {
  545. 'web': {'image': 'busybox', 'extends': {'service': 'web', 'file': 'common.yml'}},
  546. },
  547. 'tests/fixtures/extends',
  548. 'common.yml'
  549. )
  550. )
  551. self.assertEquals(len(service), 1)
  552. self.assertIsInstance(service[0], dict)
  553. def test_extends_file_defaults_to_self(self):
  554. """
  555. Test not specifying a file in our extends options that the
  556. config is valid and correctly extends from itself.
  557. """
  558. service_dicts = load_from_filename('tests/fixtures/extends/no-file-specified.yml')
  559. self.assertEqual(service_dicts, [
  560. {
  561. 'name': 'myweb',
  562. 'image': 'busybox',
  563. 'environment': {
  564. "BAR": "1",
  565. "BAZ": "3",
  566. }
  567. },
  568. {
  569. 'name': 'web',
  570. 'image': 'busybox',
  571. 'environment': {
  572. "BAZ": "3",
  573. }
  574. }
  575. ])
  576. def test_blacklisted_options(self):
  577. def load_config():
  578. return make_service_dict('myweb', {
  579. 'extends': {
  580. 'file': 'whatever',
  581. 'service': 'web',
  582. }
  583. }, '.')
  584. with self.assertRaisesRegexp(config.ConfigurationError, 'links'):
  585. other_config = {'web': {'links': ['db']}}
  586. with mock.patch.object(config, 'load_yaml', return_value=other_config):
  587. print load_config()
  588. with self.assertRaisesRegexp(config.ConfigurationError, 'volumes_from'):
  589. other_config = {'web': {'volumes_from': ['db']}}
  590. with mock.patch.object(config, 'load_yaml', return_value=other_config):
  591. print load_config()
  592. with self.assertRaisesRegexp(config.ConfigurationError, 'net'):
  593. other_config = {'web': {'net': 'container:db'}}
  594. with mock.patch.object(config, 'load_yaml', return_value=other_config):
  595. print load_config()
  596. other_config = {'web': {'net': 'host'}}
  597. with mock.patch.object(config, 'load_yaml', return_value=other_config):
  598. print load_config()
  599. def test_volume_path(self):
  600. dicts = load_from_filename('tests/fixtures/volume-path/docker-compose.yml')
  601. paths = [
  602. '%s:/foo' % os.path.abspath('tests/fixtures/volume-path/common/foo'),
  603. '%s:/bar' % os.path.abspath('tests/fixtures/volume-path/bar'),
  604. ]
  605. self.assertEqual(set(dicts[0]['volumes']), set(paths))
  606. def test_parent_build_path_dne(self):
  607. child = load_from_filename('tests/fixtures/extends/nonexistent-path-child.yml')
  608. self.assertEqual(child, [
  609. {
  610. 'name': 'dnechild',
  611. 'image': 'busybox',
  612. 'command': '/bin/true',
  613. 'environment': {
  614. "FOO": "1",
  615. "BAR": "2",
  616. },
  617. },
  618. ])
  619. class BuildPathTest(unittest.TestCase):
  620. def setUp(self):
  621. self.abs_context_path = os.path.join(os.getcwd(), 'tests/fixtures/build-ctx')
  622. def test_nonexistent_path(self):
  623. with self.assertRaises(config.ConfigurationError):
  624. config.load(
  625. config.ConfigDetails(
  626. {
  627. 'foo': {'build': 'nonexistent.path'},
  628. },
  629. 'working_dir',
  630. 'filename.yml'
  631. )
  632. )
  633. def test_relative_path(self):
  634. relative_build_path = '../build-ctx/'
  635. service_dict = make_service_dict(
  636. 'relpath',
  637. {'build': relative_build_path},
  638. working_dir='tests/fixtures/build-path'
  639. )
  640. self.assertEquals(service_dict['build'], self.abs_context_path)
  641. def test_absolute_path(self):
  642. service_dict = make_service_dict(
  643. 'abspath',
  644. {'build': self.abs_context_path},
  645. working_dir='tests/fixtures/build-path'
  646. )
  647. self.assertEquals(service_dict['build'], self.abs_context_path)
  648. def test_from_file(self):
  649. service_dict = load_from_filename('tests/fixtures/build-path/docker-compose.yml')
  650. self.assertEquals(service_dict, [{'name': 'foo', 'build': self.abs_context_path}])
  651. class GetConfigPathTestCase(unittest.TestCase):
  652. files = [
  653. 'docker-compose.yml',
  654. 'docker-compose.yaml',
  655. 'fig.yml',
  656. 'fig.yaml',
  657. ]
  658. def test_get_config_path_default_file_in_basedir(self):
  659. files = self.files
  660. self.assertEqual('docker-compose.yml', get_config_filename_for_files(files[0:]))
  661. self.assertEqual('docker-compose.yaml', get_config_filename_for_files(files[1:]))
  662. self.assertEqual('fig.yml', get_config_filename_for_files(files[2:]))
  663. self.assertEqual('fig.yaml', get_config_filename_for_files(files[3:]))
  664. with self.assertRaises(config.ComposeFileNotFound):
  665. get_config_filename_for_files([])
  666. def test_get_config_path_default_file_in_parent_dir(self):
  667. """Test with files placed in the subdir"""
  668. files = self.files
  669. def get_config_in_subdir(files):
  670. return get_config_filename_for_files(files, subdir=True)
  671. self.assertEqual('docker-compose.yml', get_config_in_subdir(files[0:]))
  672. self.assertEqual('docker-compose.yaml', get_config_in_subdir(files[1:]))
  673. self.assertEqual('fig.yml', get_config_in_subdir(files[2:]))
  674. self.assertEqual('fig.yaml', get_config_in_subdir(files[3:]))
  675. with self.assertRaises(config.ComposeFileNotFound):
  676. get_config_in_subdir([])
  677. def get_config_filename_for_files(filenames, subdir=None):
  678. def make_files(dirname, filenames):
  679. for fname in filenames:
  680. with open(os.path.join(dirname, fname), 'w') as f:
  681. f.write('')
  682. project_dir = tempfile.mkdtemp()
  683. try:
  684. make_files(project_dir, filenames)
  685. if subdir:
  686. base_dir = tempfile.mkdtemp(dir=project_dir)
  687. else:
  688. base_dir = project_dir
  689. return os.path.basename(config.get_config_path(base_dir))
  690. finally:
  691. shutil.rmtree(project_dir)