config_test.py 28 KB

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