config_test.py 27 KB

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