123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842 |
- # -*- coding: utf-8 -*-
- from __future__ import absolute_import
- from __future__ import unicode_literals
- import datetime
- import json
- import os
- import signal
- import subprocess
- import time
- from collections import Counter
- from collections import namedtuple
- from operator import attrgetter
- import py
- import six
- import yaml
- from docker import errors
- from .. import mock
- from compose.cli.command import get_project
- from compose.container import Container
- from compose.project import OneOffFilter
- from tests.integration.testcases import DockerClientTestCase
- from tests.integration.testcases import get_links
- from tests.integration.testcases import pull_busybox
- from tests.integration.testcases import v2_1_only
- from tests.integration.testcases import v2_only
- ProcessResult = namedtuple('ProcessResult', 'stdout stderr')
- BUILD_CACHE_TEXT = 'Using cache'
- BUILD_PULL_TEXT = 'Status: Image is up to date for busybox:latest'
- def start_process(base_dir, options):
- proc = subprocess.Popen(
- ['docker-compose'] + options,
- stdout=subprocess.PIPE,
- stderr=subprocess.PIPE,
- cwd=base_dir)
- print("Running process: %s" % proc.pid)
- return proc
- def wait_on_process(proc, returncode=0):
- stdout, stderr = proc.communicate()
- if proc.returncode != returncode:
- print("Stderr: {}".format(stderr))
- print("Stdout: {}".format(stdout))
- assert proc.returncode == returncode
- return ProcessResult(stdout.decode('utf-8'), stderr.decode('utf-8'))
- def wait_on_condition(condition, delay=0.1, timeout=40):
- start_time = time.time()
- while not condition():
- if time.time() - start_time > timeout:
- raise AssertionError("Timeout: %s" % condition)
- time.sleep(delay)
- def kill_service(service):
- for container in service.containers():
- container.kill()
- class ContainerCountCondition(object):
- def __init__(self, project, expected):
- self.project = project
- self.expected = expected
- def __call__(self):
- return len(self.project.containers()) == self.expected
- def __str__(self):
- return "waiting for counter count == %s" % self.expected
- class ContainerStateCondition(object):
- def __init__(self, client, name, status):
- self.client = client
- self.name = name
- self.status = status
- def __call__(self):
- try:
- container = self.client.inspect_container(self.name)
- return container['State']['Status'] == self.status
- except errors.APIError:
- return False
- def __str__(self):
- return "waiting for container to be %s" % self.status
- class CLITestCase(DockerClientTestCase):
- def setUp(self):
- super(CLITestCase, self).setUp()
- self.base_dir = 'tests/fixtures/simple-composefile'
- def tearDown(self):
- if self.base_dir:
- self.project.kill()
- self.project.remove_stopped()
- for container in self.project.containers(stopped=True, one_off=OneOffFilter.only):
- container.remove(force=True)
- networks = self.client.networks()
- for n in networks:
- if n['Name'].startswith('{}_'.format(self.project.name)):
- self.client.remove_network(n['Name'])
- if hasattr(self, '_project'):
- del self._project
- super(CLITestCase, self).tearDown()
- @property
- def project(self):
- # Hack: allow project to be overridden
- if not hasattr(self, '_project'):
- self._project = get_project(self.base_dir)
- return self._project
- def dispatch(self, options, project_options=None, returncode=0):
- project_options = project_options or []
- proc = start_process(self.base_dir, project_options + options)
- return wait_on_process(proc, returncode=returncode)
- def execute(self, container, cmd):
- # Remove once Hijack and CloseNotifier sign a peace treaty
- self.client.close()
- exc = self.client.exec_create(container.id, cmd)
- self.client.exec_start(exc)
- return self.client.exec_inspect(exc)['ExitCode']
- def lookup(self, container, hostname):
- return self.execute(container, ["nslookup", hostname]) == 0
- def test_help(self):
- self.base_dir = 'tests/fixtures/no-composefile'
- result = self.dispatch(['help', 'up'], returncode=0)
- assert 'Usage: up [options] [SERVICE...]' in result.stdout
- # Prevent tearDown from trying to create a project
- self.base_dir = None
- def test_shorthand_host_opt(self):
- self.dispatch(
- ['-H={0}'.format(os.environ.get('DOCKER_HOST', 'unix://')),
- 'up', '-d'],
- returncode=0
- )
- def test_host_not_reachable(self):
- result = self.dispatch(['-H=tcp://doesnotexist:8000', 'ps'], returncode=1)
- assert "Couldn't connect to Docker daemon" in result.stderr
- def test_host_not_reachable_volumes_from_container(self):
- self.base_dir = 'tests/fixtures/volumes-from-container'
- container = self.client.create_container('busybox', 'true', name='composetest_data_container')
- self.addCleanup(self.client.remove_container, container)
- result = self.dispatch(['-H=tcp://doesnotexist:8000', 'ps'], returncode=1)
- assert "Couldn't connect to Docker daemon" in result.stderr
- def test_config_list_services(self):
- self.base_dir = 'tests/fixtures/v2-full'
- result = self.dispatch(['config', '--services'])
- assert set(result.stdout.rstrip().split('\n')) == {'web', 'other'}
- def test_config_quiet_with_error(self):
- self.base_dir = None
- result = self.dispatch([
- '-f', 'tests/fixtures/invalid-composefile/invalid.yml',
- 'config', '-q'
- ], returncode=1)
- assert "'notaservice' must be a mapping" in result.stderr
- def test_config_quiet(self):
- self.base_dir = 'tests/fixtures/v2-full'
- assert self.dispatch(['config', '-q']).stdout == ''
- def test_config_default(self):
- self.base_dir = 'tests/fixtures/v2-full'
- result = self.dispatch(['config'])
- # assert there are no python objects encoded in the output
- assert '!!' not in result.stdout
- output = yaml.load(result.stdout)
- expected = {
- 'version': '2.0',
- 'volumes': {'data': {'driver': 'local'}},
- 'networks': {'front': {}},
- 'services': {
- 'web': {
- 'build': {
- 'context': os.path.abspath(self.base_dir),
- },
- 'networks': {'front': None, 'default': None},
- 'volumes_from': ['service:other:rw'],
- },
- 'other': {
- 'image': 'busybox:latest',
- 'command': 'top',
- 'volumes': ['/data:rw'],
- },
- },
- }
- assert output == expected
- def test_config_restart(self):
- self.base_dir = 'tests/fixtures/restart'
- result = self.dispatch(['config'])
- assert yaml.load(result.stdout) == {
- 'version': '2.0',
- 'services': {
- 'never': {
- 'image': 'busybox',
- 'restart': 'no',
- },
- 'always': {
- 'image': 'busybox',
- 'restart': 'always',
- },
- 'on-failure': {
- 'image': 'busybox',
- 'restart': 'on-failure',
- },
- 'on-failure-5': {
- 'image': 'busybox',
- 'restart': 'on-failure:5',
- },
- 'restart-null': {
- 'image': 'busybox',
- 'restart': ''
- },
- },
- 'networks': {},
- 'volumes': {},
- }
- def test_config_external_network(self):
- self.base_dir = 'tests/fixtures/networks'
- result = self.dispatch(['-f', 'external-networks.yml', 'config'])
- json_result = yaml.load(result.stdout)
- assert 'networks' in json_result
- assert json_result['networks'] == {
- 'networks_foo': {
- 'external': True # {'name': 'networks_foo'}
- },
- 'bar': {
- 'external': {'name': 'networks_bar'}
- }
- }
- def test_config_v1(self):
- self.base_dir = 'tests/fixtures/v1-config'
- result = self.dispatch(['config'])
- assert yaml.load(result.stdout) == {
- 'version': '2.1',
- 'services': {
- 'net': {
- 'image': 'busybox',
- 'network_mode': 'bridge',
- },
- 'volume': {
- 'image': 'busybox',
- 'volumes': ['/data:rw'],
- 'network_mode': 'bridge',
- },
- 'app': {
- 'image': 'busybox',
- 'volumes_from': ['service:volume:rw'],
- 'network_mode': 'service:net',
- },
- },
- 'networks': {},
- 'volumes': {},
- }
- def test_config_v3(self):
- self.base_dir = 'tests/fixtures/v3-full'
- result = self.dispatch(['config'])
- assert yaml.load(result.stdout) == {
- 'version': '3.0',
- 'networks': {},
- 'volumes': {},
- 'services': {
- 'web': {
- 'image': 'busybox',
- 'deploy': {
- 'mode': 'replicated',
- 'replicas': 6,
- 'labels': ['FOO=BAR'],
- 'update_config': {
- 'parallelism': 3,
- 'delay': '10s',
- 'failure_action': 'continue',
- 'monitor': '60s',
- 'max_failure_ratio': 0.3,
- },
- 'resources': {
- 'limits': {
- 'cpus': '0.001',
- 'memory': '50M',
- },
- 'reservations': {
- 'cpus': '0.0001',
- 'memory': '20M',
- },
- },
- 'restart_policy': {
- 'condition': 'on_failure',
- 'delay': '5s',
- 'max_attempts': 3,
- 'window': '120s',
- },
- 'placement': {
- 'constraints': ['node=foo'],
- },
- },
- 'healthcheck': {
- 'command': 'cat /etc/passwd',
- 'interval': '10s',
- 'timeout': '1s',
- 'retries': 5,
- },
- 'stop_grace_period': '20s',
- },
- },
- }
- def test_ps(self):
- self.project.get_service('simple').create_container()
- result = self.dispatch(['ps'])
- assert 'simplecomposefile_simple_1' in result.stdout
- def test_ps_default_composefile(self):
- self.base_dir = 'tests/fixtures/multiple-composefiles'
- self.dispatch(['up', '-d'])
- result = self.dispatch(['ps'])
- self.assertIn('multiplecomposefiles_simple_1', result.stdout)
- self.assertIn('multiplecomposefiles_another_1', result.stdout)
- self.assertNotIn('multiplecomposefiles_yetanother_1', result.stdout)
- def test_ps_alternate_composefile(self):
- config_path = os.path.abspath(
- 'tests/fixtures/multiple-composefiles/compose2.yml')
- self._project = get_project(self.base_dir, [config_path])
- self.base_dir = 'tests/fixtures/multiple-composefiles'
- self.dispatch(['-f', 'compose2.yml', 'up', '-d'])
- result = self.dispatch(['-f', 'compose2.yml', 'ps'])
- self.assertNotIn('multiplecomposefiles_simple_1', result.stdout)
- self.assertNotIn('multiplecomposefiles_another_1', result.stdout)
- self.assertIn('multiplecomposefiles_yetanother_1', result.stdout)
- def test_pull(self):
- result = self.dispatch(['pull'])
- assert sorted(result.stderr.split('\n'))[1:] == [
- 'Pulling another (busybox:latest)...',
- 'Pulling simple (busybox:latest)...',
- ]
- def test_pull_with_digest(self):
- result = self.dispatch(['-f', 'digest.yml', 'pull'])
- assert 'Pulling simple (busybox:latest)...' in result.stderr
- assert ('Pulling digest (busybox@'
- 'sha256:38a203e1986cf79639cfb9b2e1d6e773de84002feea2d4eb006b520'
- '04ee8502d)...') in result.stderr
- def test_pull_with_ignore_pull_failures(self):
- result = self.dispatch([
- '-f', 'ignore-pull-failures.yml',
- 'pull', '--ignore-pull-failures']
- )
- assert 'Pulling simple (busybox:latest)...' in result.stderr
- assert 'Pulling another (nonexisting-image:latest)...' in result.stderr
- assert ('repository nonexisting-image not found' in result.stderr or
- 'image library/nonexisting-image:latest not found' in result.stderr)
- def test_build_plain(self):
- self.base_dir = 'tests/fixtures/simple-dockerfile'
- self.dispatch(['build', 'simple'])
- result = self.dispatch(['build', 'simple'])
- assert BUILD_CACHE_TEXT in result.stdout
- assert BUILD_PULL_TEXT not in result.stdout
- def test_build_no_cache(self):
- self.base_dir = 'tests/fixtures/simple-dockerfile'
- self.dispatch(['build', 'simple'])
- result = self.dispatch(['build', '--no-cache', 'simple'])
- assert BUILD_CACHE_TEXT not in result.stdout
- assert BUILD_PULL_TEXT not in result.stdout
- def test_build_pull(self):
- # Make sure we have the latest busybox already
- pull_busybox(self.client)
- self.base_dir = 'tests/fixtures/simple-dockerfile'
- self.dispatch(['build', 'simple'], None)
- result = self.dispatch(['build', '--pull', 'simple'])
- assert BUILD_CACHE_TEXT in result.stdout
- assert BUILD_PULL_TEXT in result.stdout
- def test_build_no_cache_pull(self):
- # Make sure we have the latest busybox already
- pull_busybox(self.client)
- self.base_dir = 'tests/fixtures/simple-dockerfile'
- self.dispatch(['build', 'simple'])
- result = self.dispatch(['build', '--no-cache', '--pull', 'simple'])
- assert BUILD_CACHE_TEXT not in result.stdout
- assert BUILD_PULL_TEXT in result.stdout
- def test_build_failed(self):
- self.base_dir = 'tests/fixtures/simple-failing-dockerfile'
- self.dispatch(['build', 'simple'], returncode=1)
- labels = ["com.docker.compose.test_failing_image=true"]
- containers = [
- Container.from_ps(self.project.client, c)
- for c in self.project.client.containers(
- all=True,
- filters={"label": labels})
- ]
- assert len(containers) == 1
- def test_build_failed_forcerm(self):
- self.base_dir = 'tests/fixtures/simple-failing-dockerfile'
- self.dispatch(['build', '--force-rm', 'simple'], returncode=1)
- labels = ["com.docker.compose.test_failing_image=true"]
- containers = [
- Container.from_ps(self.project.client, c)
- for c in self.project.client.containers(
- all=True,
- filters={"label": labels})
- ]
- assert not containers
- def test_bundle_with_digests(self):
- self.base_dir = 'tests/fixtures/bundle-with-digests/'
- tmpdir = py.test.ensuretemp('cli_test_bundle')
- self.addCleanup(tmpdir.remove)
- filename = str(tmpdir.join('example.dab'))
- self.dispatch(['bundle', '--output', filename])
- with open(filename, 'r') as fh:
- bundle = json.load(fh)
- assert bundle == {
- 'Version': '0.1',
- 'Services': {
- 'web': {
- 'Image': ('dockercloud/hello-world@sha256:fe79a2cfbd17eefc3'
- '44fb8419420808df95a1e22d93b7f621a7399fd1e9dca1d'),
- 'Networks': ['default'],
- },
- 'redis': {
- 'Image': ('redis@sha256:a84cb8f53a70e19f61ff2e1d5e73fb7ae62d'
- '374b2b7392de1e7d77be26ef8f7b'),
- 'Networks': ['default'],
- }
- },
- }
- def test_create(self):
- self.dispatch(['create'])
- service = self.project.get_service('simple')
- another = self.project.get_service('another')
- self.assertEqual(len(service.containers()), 0)
- self.assertEqual(len(another.containers()), 0)
- self.assertEqual(len(service.containers(stopped=True)), 1)
- self.assertEqual(len(another.containers(stopped=True)), 1)
- def test_create_with_force_recreate(self):
- self.dispatch(['create'], None)
- service = self.project.get_service('simple')
- self.assertEqual(len(service.containers()), 0)
- self.assertEqual(len(service.containers(stopped=True)), 1)
- old_ids = [c.id for c in service.containers(stopped=True)]
- self.dispatch(['create', '--force-recreate'], None)
- self.assertEqual(len(service.containers()), 0)
- self.assertEqual(len(service.containers(stopped=True)), 1)
- new_ids = [c.id for c in service.containers(stopped=True)]
- self.assertNotEqual(old_ids, new_ids)
- def test_create_with_no_recreate(self):
- self.dispatch(['create'], None)
- service = self.project.get_service('simple')
- self.assertEqual(len(service.containers()), 0)
- self.assertEqual(len(service.containers(stopped=True)), 1)
- old_ids = [c.id for c in service.containers(stopped=True)]
- self.dispatch(['create', '--no-recreate'], None)
- self.assertEqual(len(service.containers()), 0)
- self.assertEqual(len(service.containers(stopped=True)), 1)
- new_ids = [c.id for c in service.containers(stopped=True)]
- self.assertEqual(old_ids, new_ids)
- def test_create_with_force_recreate_and_no_recreate(self):
- self.dispatch(
- ['create', '--force-recreate', '--no-recreate'],
- returncode=1)
- def test_down_invalid_rmi_flag(self):
- result = self.dispatch(['down', '--rmi', 'bogus'], returncode=1)
- assert '--rmi flag must be' in result.stderr
- @v2_only()
- def test_down(self):
- self.base_dir = 'tests/fixtures/v2-full'
- self.dispatch(['up', '-d'])
- wait_on_condition(ContainerCountCondition(self.project, 2))
- self.dispatch(['run', 'web', 'true'])
- self.dispatch(['run', '-d', 'web', 'tail', '-f', '/dev/null'])
- assert len(self.project.containers(one_off=OneOffFilter.only, stopped=True)) == 2
- result = self.dispatch(['down', '--rmi=local', '--volumes'])
- assert 'Stopping v2full_web_1' in result.stderr
- assert 'Stopping v2full_other_1' in result.stderr
- assert 'Stopping v2full_web_run_2' in result.stderr
- assert 'Removing v2full_web_1' in result.stderr
- assert 'Removing v2full_other_1' in result.stderr
- assert 'Removing v2full_web_run_1' in result.stderr
- assert 'Removing v2full_web_run_2' in result.stderr
- assert 'Removing volume v2full_data' in result.stderr
- assert 'Removing image v2full_web' in result.stderr
- assert 'Removing image busybox' not in result.stderr
- assert 'Removing network v2full_default' in result.stderr
- assert 'Removing network v2full_front' in result.stderr
- def test_up_detached(self):
- self.dispatch(['up', '-d'])
- service = self.project.get_service('simple')
- another = self.project.get_service('another')
- self.assertEqual(len(service.containers()), 1)
- self.assertEqual(len(another.containers()), 1)
- # Ensure containers don't have stdin and stdout connected in -d mode
- container, = service.containers()
- self.assertFalse(container.get('Config.AttachStderr'))
- self.assertFalse(container.get('Config.AttachStdout'))
- self.assertFalse(container.get('Config.AttachStdin'))
- def test_up_attached(self):
- self.base_dir = 'tests/fixtures/echo-services'
- result = self.dispatch(['up', '--no-color'])
- assert 'simple_1 | simple' in result.stdout
- assert 'another_1 | another' in result.stdout
- assert 'simple_1 exited with code 0' in result.stdout
- assert 'another_1 exited with code 0' in result.stdout
- @v2_only()
- def test_up(self):
- self.base_dir = 'tests/fixtures/v2-simple'
- self.dispatch(['up', '-d'], None)
- services = self.project.get_services()
- network_name = self.project.networks.networks['default'].full_name
- networks = self.client.networks(names=[network_name])
- self.assertEqual(len(networks), 1)
- self.assertEqual(networks[0]['Driver'], 'bridge')
- assert 'com.docker.network.bridge.enable_icc' not in networks[0]['Options']
- network = self.client.inspect_network(networks[0]['Id'])
- for service in services:
- containers = service.containers()
- self.assertEqual(len(containers), 1)
- container = containers[0]
- self.assertIn(container.id, network['Containers'])
- networks = container.get('NetworkSettings.Networks')
- self.assertEqual(list(networks), [network['Name']])
- self.assertEqual(
- sorted(networks[network['Name']]['Aliases']),
- sorted([service.name, container.short_id]))
- for service in services:
- assert self.lookup(container, service.name)
- @v2_only()
- def test_up_with_default_network_config(self):
- filename = 'default-network-config.yml'
- self.base_dir = 'tests/fixtures/networks'
- self._project = get_project(self.base_dir, [filename])
- self.dispatch(['-f', filename, 'up', '-d'], None)
- network_name = self.project.networks.networks['default'].full_name
- networks = self.client.networks(names=[network_name])
- assert networks[0]['Options']['com.docker.network.bridge.enable_icc'] == 'false'
- @v2_only()
- def test_up_with_network_aliases(self):
- filename = 'network-aliases.yml'
- self.base_dir = 'tests/fixtures/networks'
- self.dispatch(['-f', filename, 'up', '-d'], None)
- back_name = '{}_back'.format(self.project.name)
- front_name = '{}_front'.format(self.project.name)
- networks = [
- n for n in self.client.networks()
- if n['Name'].startswith('{}_'.format(self.project.name))
- ]
- # Two networks were created: back and front
- assert sorted(n['Name'] for n in networks) == [back_name, front_name]
- web_container = self.project.get_service('web').containers()[0]
- back_aliases = web_container.get(
- 'NetworkSettings.Networks.{}.Aliases'.format(back_name)
- )
- assert 'web' in back_aliases
- front_aliases = web_container.get(
- 'NetworkSettings.Networks.{}.Aliases'.format(front_name)
- )
- assert 'web' in front_aliases
- assert 'forward_facing' in front_aliases
- assert 'ahead' in front_aliases
- @v2_only()
- def test_up_with_network_internal(self):
- self.require_api_version('1.23')
- filename = 'network-internal.yml'
- self.base_dir = 'tests/fixtures/networks'
- self.dispatch(['-f', filename, 'up', '-d'], None)
- internal_net = '{}_internal'.format(self.project.name)
- networks = [
- n for n in self.client.networks()
- if n['Name'].startswith('{}_'.format(self.project.name))
- ]
- # One network was created: internal
- assert sorted(n['Name'] for n in networks) == [internal_net]
- assert networks[0]['Internal'] is True
- @v2_only()
- def test_up_with_network_static_addresses(self):
- filename = 'network-static-addresses.yml'
- ipv4_address = '172.16.100.100'
- ipv6_address = 'fe80::1001:100'
- self.base_dir = 'tests/fixtures/networks'
- self.dispatch(['-f', filename, 'up', '-d'], None)
- static_net = '{}_static_test'.format(self.project.name)
- networks = [
- n for n in self.client.networks()
- if n['Name'].startswith('{}_'.format(self.project.name))
- ]
- # One networks was created: front
- assert sorted(n['Name'] for n in networks) == [static_net]
- web_container = self.project.get_service('web').containers()[0]
- ipam_config = web_container.get(
- 'NetworkSettings.Networks.{}.IPAMConfig'.format(static_net)
- )
- assert ipv4_address in ipam_config.values()
- assert ipv6_address in ipam_config.values()
- @v2_only()
- def test_up_with_networks(self):
- self.base_dir = 'tests/fixtures/networks'
- self.dispatch(['up', '-d'], None)
- back_name = '{}_back'.format(self.project.name)
- front_name = '{}_front'.format(self.project.name)
- networks = [
- n for n in self.client.networks()
- if n['Name'].startswith('{}_'.format(self.project.name))
- ]
- # Two networks were created: back and front
- assert sorted(n['Name'] for n in networks) == [back_name, front_name]
- back_network = [n for n in networks if n['Name'] == back_name][0]
- front_network = [n for n in networks if n['Name'] == front_name][0]
- web_container = self.project.get_service('web').containers()[0]
- app_container = self.project.get_service('app').containers()[0]
- db_container = self.project.get_service('db').containers()[0]
- for net_name in [front_name, back_name]:
- links = app_container.get('NetworkSettings.Networks.{}.Links'.format(net_name))
- assert '{}:database'.format(db_container.name) in links
- # db and app joined the back network
- assert sorted(back_network['Containers']) == sorted([db_container.id, app_container.id])
- # web and app joined the front network
- assert sorted(front_network['Containers']) == sorted([web_container.id, app_container.id])
- # web can see app but not db
- assert self.lookup(web_container, "app")
- assert not self.lookup(web_container, "db")
- # app can see db
- assert self.lookup(app_container, "db")
- # app has aliased db to "database"
- assert self.lookup(app_container, "database")
- @v2_only()
- def test_up_missing_network(self):
- self.base_dir = 'tests/fixtures/networks'
- result = self.dispatch(
- ['-f', 'missing-network.yml', 'up', '-d'],
- returncode=1)
- assert 'Service "web" uses an undefined network "foo"' in result.stderr
- @v2_only()
- def test_up_with_network_mode(self):
- c = self.client.create_container('busybox', 'top', name='composetest_network_mode_container')
- self.addCleanup(self.client.remove_container, c, force=True)
- self.client.start(c)
- container_mode_source = 'container:{}'.format(c['Id'])
- filename = 'network-mode.yml'
- self.base_dir = 'tests/fixtures/networks'
- self._project = get_project(self.base_dir, [filename])
- self.dispatch(['-f', filename, 'up', '-d'], None)
- networks = [
- n for n in self.client.networks()
- if n['Name'].startswith('{}_'.format(self.project.name))
- ]
- assert not networks
- for name in ['bridge', 'host', 'none']:
- container = self.project.get_service(name).containers()[0]
- assert list(container.get('NetworkSettings.Networks')) == [name]
- assert container.get('HostConfig.NetworkMode') == name
- service_mode_source = 'container:{}'.format(
- self.project.get_service('bridge').containers()[0].id)
- service_mode_container = self.project.get_service('service').containers()[0]
- assert not service_mode_container.get('NetworkSettings.Networks')
- assert service_mode_container.get('HostConfig.NetworkMode') == service_mode_source
- container_mode_container = self.project.get_service('container').containers()[0]
- assert not container_mode_container.get('NetworkSettings.Networks')
- assert container_mode_container.get('HostConfig.NetworkMode') == container_mode_source
- @v2_only()
- def test_up_external_networks(self):
- filename = 'external-networks.yml'
- self.base_dir = 'tests/fixtures/networks'
- self._project = get_project(self.base_dir, [filename])
- result = self.dispatch(['-f', filename, 'up', '-d'], returncode=1)
- assert 'declared as external, but could not be found' in result.stderr
- networks = [
- n['Name'] for n in self.client.networks()
- if n['Name'].startswith('{}_'.format(self.project.name))
- ]
- assert not networks
- network_names = ['{}_{}'.format(self.project.name, n) for n in ['foo', 'bar']]
- for name in network_names:
- self.client.create_network(name)
- self.dispatch(['-f', filename, 'up', '-d'])
- container = self.project.containers()[0]
- assert sorted(list(container.get('NetworkSettings.Networks'))) == sorted(network_names)
- @v2_only()
- def test_up_with_external_default_network(self):
- filename = 'external-default.yml'
- self.base_dir = 'tests/fixtures/networks'
- self._project = get_project(self.base_dir, [filename])
- result = self.dispatch(['-f', filename, 'up', '-d'], returncode=1)
- assert 'declared as external, but could not be found' in result.stderr
- networks = [
- n['Name'] for n in self.client.networks()
- if n['Name'].startswith('{}_'.format(self.project.name))
- ]
- assert not networks
- network_name = 'composetest_external_network'
- self.client.create_network(network_name)
- self.dispatch(['-f', filename, 'up', '-d'])
- container = self.project.containers()[0]
- assert list(container.get('NetworkSettings.Networks')) == [network_name]
- @v2_1_only()
- def test_up_with_network_labels(self):
- filename = 'network-label.yml'
- self.base_dir = 'tests/fixtures/networks'
- self._project = get_project(self.base_dir, [filename])
- self.dispatch(['-f', filename, 'up', '-d'], returncode=0)
- network_with_label = '{}_network_with_label'.format(self.project.name)
- networks = [
- n for n in self.client.networks()
- if n['Name'].startswith('{}_'.format(self.project.name))
- ]
- assert [n['Name'] for n in networks] == [network_with_label]
- assert networks[0]['Labels'] == {'label_key': 'label_val'}
- @v2_1_only()
- def test_up_with_volume_labels(self):
- filename = 'volume-label.yml'
- self.base_dir = 'tests/fixtures/volumes'
- self._project = get_project(self.base_dir, [filename])
- self.dispatch(['-f', filename, 'up', '-d'], returncode=0)
- volume_with_label = '{}_volume_with_label'.format(self.project.name)
- volumes = [
- v for v in self.client.volumes().get('Volumes', [])
- if v['Name'].startswith('{}_'.format(self.project.name))
- ]
- assert [v['Name'] for v in volumes] == [volume_with_label]
- assert volumes[0]['Labels'] == {'label_key': 'label_val'}
- @v2_only()
- def test_up_no_services(self):
- self.base_dir = 'tests/fixtures/no-services'
- self.dispatch(['up', '-d'], None)
- network_names = [
- n['Name'] for n in self.client.networks()
- if n['Name'].startswith('{}_'.format(self.project.name))
- ]
- assert network_names == []
- def test_up_with_links_v1(self):
- self.base_dir = 'tests/fixtures/links-composefile'
- self.dispatch(['up', '-d', 'web'], None)
- # No network was created
- network_name = self.project.networks.networks['default'].full_name
- networks = self.client.networks(names=[network_name])
- assert networks == []
- web = self.project.get_service('web')
- db = self.project.get_service('db')
- console = self.project.get_service('console')
- # console was not started
- self.assertEqual(len(web.containers()), 1)
- self.assertEqual(len(db.containers()), 1)
- self.assertEqual(len(console.containers()), 0)
- # web has links
- web_container = web.containers()[0]
- self.assertTrue(web_container.get('HostConfig.Links'))
- def test_up_with_net_is_invalid(self):
- self.base_dir = 'tests/fixtures/net-container'
- result = self.dispatch(
- ['-f', 'v2-invalid.yml', 'up', '-d'],
- returncode=1)
- assert "Unsupported config option for services.bar: 'net'" in result.stderr
- def test_up_with_net_v1(self):
- self.base_dir = 'tests/fixtures/net-container'
- self.dispatch(['up', '-d'], None)
- bar = self.project.get_service('bar')
- bar_container = bar.containers()[0]
- foo = self.project.get_service('foo')
- foo_container = foo.containers()[0]
- assert foo_container.get('HostConfig.NetworkMode') == \
- 'container:{}'.format(bar_container.id)
- def test_up_with_no_deps(self):
- self.base_dir = 'tests/fixtures/links-composefile'
- self.dispatch(['up', '-d', '--no-deps', 'web'], None)
- web = self.project.get_service('web')
- db = self.project.get_service('db')
- console = self.project.get_service('console')
- self.assertEqual(len(web.containers()), 1)
- self.assertEqual(len(db.containers()), 0)
- self.assertEqual(len(console.containers()), 0)
- def test_up_with_force_recreate(self):
- self.dispatch(['up', '-d'], None)
- service = self.project.get_service('simple')
- self.assertEqual(len(service.containers()), 1)
- old_ids = [c.id for c in service.containers()]
- self.dispatch(['up', '-d', '--force-recreate'], None)
- self.assertEqual(len(service.containers()), 1)
- new_ids = [c.id for c in service.containers()]
- self.assertNotEqual(old_ids, new_ids)
- def test_up_with_no_recreate(self):
- self.dispatch(['up', '-d'], None)
- service = self.project.get_service('simple')
- self.assertEqual(len(service.containers()), 1)
- old_ids = [c.id for c in service.containers()]
- self.dispatch(['up', '-d', '--no-recreate'], None)
- self.assertEqual(len(service.containers()), 1)
- new_ids = [c.id for c in service.containers()]
- self.assertEqual(old_ids, new_ids)
- def test_up_with_force_recreate_and_no_recreate(self):
- self.dispatch(
- ['up', '-d', '--force-recreate', '--no-recreate'],
- returncode=1)
- def test_up_with_timeout(self):
- self.dispatch(['up', '-d', '-t', '1'])
- service = self.project.get_service('simple')
- another = self.project.get_service('another')
- self.assertEqual(len(service.containers()), 1)
- self.assertEqual(len(another.containers()), 1)
- # Ensure containers don't have stdin and stdout connected in -d mode
- config = service.containers()[0].inspect()['Config']
- self.assertFalse(config['AttachStderr'])
- self.assertFalse(config['AttachStdout'])
- self.assertFalse(config['AttachStdin'])
- def test_up_handles_sigint(self):
- proc = start_process(self.base_dir, ['up', '-t', '2'])
- wait_on_condition(ContainerCountCondition(self.project, 2))
- os.kill(proc.pid, signal.SIGINT)
- wait_on_condition(ContainerCountCondition(self.project, 0))
- def test_up_handles_sigterm(self):
- proc = start_process(self.base_dir, ['up', '-t', '2'])
- wait_on_condition(ContainerCountCondition(self.project, 2))
- os.kill(proc.pid, signal.SIGTERM)
- wait_on_condition(ContainerCountCondition(self.project, 0))
- @v2_only()
- def test_up_handles_force_shutdown(self):
- self.base_dir = 'tests/fixtures/sleeps-composefile'
- proc = start_process(self.base_dir, ['up', '-t', '200'])
- wait_on_condition(ContainerCountCondition(self.project, 2))
- os.kill(proc.pid, signal.SIGTERM)
- time.sleep(0.1)
- os.kill(proc.pid, signal.SIGTERM)
- wait_on_condition(ContainerCountCondition(self.project, 0))
- def test_up_handles_abort_on_container_exit(self):
- start_process(self.base_dir, ['up', '--abort-on-container-exit'])
- wait_on_condition(ContainerCountCondition(self.project, 2))
- self.project.stop(['simple'])
- wait_on_condition(ContainerCountCondition(self.project, 0))
- def test_exec_without_tty(self):
- self.base_dir = 'tests/fixtures/links-composefile'
- self.dispatch(['up', '-d', 'console'])
- self.assertEqual(len(self.project.containers()), 1)
- stdout, stderr = self.dispatch(['exec', '-T', 'console', 'ls', '-1d', '/'])
- self.assertEquals(stdout, "/\n")
- self.assertEquals(stderr, "")
- def test_exec_custom_user(self):
- self.base_dir = 'tests/fixtures/links-composefile'
- self.dispatch(['up', '-d', 'console'])
- self.assertEqual(len(self.project.containers()), 1)
- stdout, stderr = self.dispatch(['exec', '-T', '--user=operator', 'console', 'whoami'])
- self.assertEquals(stdout, "operator\n")
- self.assertEquals(stderr, "")
- def test_run_service_without_links(self):
- self.base_dir = 'tests/fixtures/links-composefile'
- self.dispatch(['run', 'console', '/bin/true'])
- self.assertEqual(len(self.project.containers()), 0)
- # Ensure stdin/out was open
- container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
- config = container.inspect()['Config']
- self.assertTrue(config['AttachStderr'])
- self.assertTrue(config['AttachStdout'])
- self.assertTrue(config['AttachStdin'])
- def test_run_service_with_links(self):
- self.base_dir = 'tests/fixtures/links-composefile'
- self.dispatch(['run', 'web', '/bin/true'], None)
- db = self.project.get_service('db')
- console = self.project.get_service('console')
- self.assertEqual(len(db.containers()), 1)
- self.assertEqual(len(console.containers()), 0)
- @v2_only()
- def test_run_service_with_dependencies(self):
- self.base_dir = 'tests/fixtures/v2-dependencies'
- self.dispatch(['run', 'web', '/bin/true'], None)
- db = self.project.get_service('db')
- console = self.project.get_service('console')
- self.assertEqual(len(db.containers()), 1)
- self.assertEqual(len(console.containers()), 0)
- def test_run_with_no_deps(self):
- self.base_dir = 'tests/fixtures/links-composefile'
- self.dispatch(['run', '--no-deps', 'web', '/bin/true'])
- db = self.project.get_service('db')
- self.assertEqual(len(db.containers()), 0)
- def test_run_does_not_recreate_linked_containers(self):
- self.base_dir = 'tests/fixtures/links-composefile'
- self.dispatch(['up', '-d', 'db'])
- db = self.project.get_service('db')
- self.assertEqual(len(db.containers()), 1)
- old_ids = [c.id for c in db.containers()]
- self.dispatch(['run', 'web', '/bin/true'], None)
- self.assertEqual(len(db.containers()), 1)
- new_ids = [c.id for c in db.containers()]
- self.assertEqual(old_ids, new_ids)
- def test_run_without_command(self):
- self.base_dir = 'tests/fixtures/commands-composefile'
- self.check_build('tests/fixtures/simple-dockerfile', tag='composetest_test')
- self.dispatch(['run', 'implicit'])
- service = self.project.get_service('implicit')
- containers = service.containers(stopped=True, one_off=OneOffFilter.only)
- self.assertEqual(
- [c.human_readable_command for c in containers],
- [u'/bin/sh -c echo "success"'],
- )
- self.dispatch(['run', 'explicit'])
- service = self.project.get_service('explicit')
- containers = service.containers(stopped=True, one_off=OneOffFilter.only)
- self.assertEqual(
- [c.human_readable_command for c in containers],
- [u'/bin/true'],
- )
- def test_run_service_with_dockerfile_entrypoint(self):
- self.base_dir = 'tests/fixtures/entrypoint-dockerfile'
- self.dispatch(['run', 'test'])
- container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
- assert container.get('Config.Entrypoint') == ['printf']
- assert container.get('Config.Cmd') == ['default', 'args']
- def test_run_service_with_dockerfile_entrypoint_overridden(self):
- self.base_dir = 'tests/fixtures/entrypoint-dockerfile'
- self.dispatch(['run', '--entrypoint', 'echo', 'test'])
- container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
- assert container.get('Config.Entrypoint') == ['echo']
- assert not container.get('Config.Cmd')
- def test_run_service_with_dockerfile_entrypoint_and_command_overridden(self):
- self.base_dir = 'tests/fixtures/entrypoint-dockerfile'
- self.dispatch(['run', '--entrypoint', 'echo', 'test', 'foo'])
- container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
- assert container.get('Config.Entrypoint') == ['echo']
- assert container.get('Config.Cmd') == ['foo']
- def test_run_service_with_compose_file_entrypoint(self):
- self.base_dir = 'tests/fixtures/entrypoint-composefile'
- self.dispatch(['run', 'test'])
- container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
- assert container.get('Config.Entrypoint') == ['printf']
- assert container.get('Config.Cmd') == ['default', 'args']
- def test_run_service_with_compose_file_entrypoint_overridden(self):
- self.base_dir = 'tests/fixtures/entrypoint-composefile'
- self.dispatch(['run', '--entrypoint', 'echo', 'test'])
- container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
- assert container.get('Config.Entrypoint') == ['echo']
- assert not container.get('Config.Cmd')
- def test_run_service_with_compose_file_entrypoint_and_command_overridden(self):
- self.base_dir = 'tests/fixtures/entrypoint-composefile'
- self.dispatch(['run', '--entrypoint', 'echo', 'test', 'foo'])
- container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
- assert container.get('Config.Entrypoint') == ['echo']
- assert container.get('Config.Cmd') == ['foo']
- def test_run_service_with_compose_file_entrypoint_and_empty_string_command(self):
- self.base_dir = 'tests/fixtures/entrypoint-composefile'
- self.dispatch(['run', '--entrypoint', 'echo', 'test', ''])
- container = self.project.containers(stopped=True, one_off=OneOffFilter.only)[0]
- assert container.get('Config.Entrypoint') == ['echo']
- assert container.get('Config.Cmd') == ['']
- def test_run_service_with_user_overridden(self):
- self.base_dir = 'tests/fixtures/user-composefile'
- name = 'service'
- user = 'sshd'
- self.dispatch(['run', '--user={user}'.format(user=user), name], returncode=1)
- service = self.project.get_service(name)
- container = service.containers(stopped=True, one_off=OneOffFilter.only)[0]
- self.assertEqual(user, container.get('Config.User'))
- def test_run_service_with_user_overridden_short_form(self):
- self.base_dir = 'tests/fixtures/user-composefile'
- name = 'service'
- user = 'sshd'
- self.dispatch(['run', '-u', user, name], returncode=1)
- service = self.project.get_service(name)
- container = service.containers(stopped=True, one_off=OneOffFilter.only)[0]
- self.assertEqual(user, container.get('Config.User'))
- def test_run_service_with_environement_overridden(self):
- name = 'service'
- self.base_dir = 'tests/fixtures/environment-composefile'
- self.dispatch([
- 'run', '-e', 'foo=notbar',
- '-e', 'allo=moto=bobo',
- '-e', 'alpha=beta',
- name,
- '/bin/true',
- ])
- service = self.project.get_service(name)
- container = service.containers(stopped=True, one_off=OneOffFilter.only)[0]
- # env overriden
- self.assertEqual('notbar', container.environment['foo'])
- # keep environement from yaml
- self.assertEqual('world', container.environment['hello'])
- # added option from command line
- self.assertEqual('beta', container.environment['alpha'])
- # make sure a value with a = don't crash out
- self.assertEqual('moto=bobo', container.environment['allo'])
- def test_run_service_without_map_ports(self):
- # create one off container
- self.base_dir = 'tests/fixtures/ports-composefile'
- self.dispatch(['run', '-d', 'simple'])
- container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
- # get port information
- port_random = container.get_local_port(3000)
- port_assigned = container.get_local_port(3001)
- # close all one off containers we just created
- container.stop()
- # check the ports
- self.assertEqual(port_random, None)
- self.assertEqual(port_assigned, None)
- def test_run_service_with_map_ports(self):
- # create one off container
- self.base_dir = 'tests/fixtures/ports-composefile'
- self.dispatch(['run', '-d', '--service-ports', 'simple'])
- container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
- # get port information
- port_random = container.get_local_port(3000)
- port_assigned = container.get_local_port(3001)
- port_range = container.get_local_port(3002), container.get_local_port(3003)
- # close all one off containers we just created
- container.stop()
- # check the ports
- self.assertNotEqual(port_random, None)
- self.assertIn("0.0.0.0", port_random)
- self.assertEqual(port_assigned, "0.0.0.0:49152")
- self.assertEqual(port_range[0], "0.0.0.0:49153")
- self.assertEqual(port_range[1], "0.0.0.0:49154")
- def test_run_service_with_explicitly_maped_ports(self):
- # create one off container
- self.base_dir = 'tests/fixtures/ports-composefile'
- self.dispatch(['run', '-d', '-p', '30000:3000', '--publish', '30001:3001', 'simple'])
- container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
- # get port information
- port_short = container.get_local_port(3000)
- port_full = container.get_local_port(3001)
- # close all one off containers we just created
- container.stop()
- # check the ports
- self.assertEqual(port_short, "0.0.0.0:30000")
- self.assertEqual(port_full, "0.0.0.0:30001")
- def test_run_service_with_explicitly_maped_ip_ports(self):
- # create one off container
- self.base_dir = 'tests/fixtures/ports-composefile'
- self.dispatch([
- 'run', '-d',
- '-p', '127.0.0.1:30000:3000',
- '--publish', '127.0.0.1:30001:3001',
- 'simple'
- ])
- container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
- # get port information
- port_short = container.get_local_port(3000)
- port_full = container.get_local_port(3001)
- # close all one off containers we just created
- container.stop()
- # check the ports
- self.assertEqual(port_short, "127.0.0.1:30000")
- self.assertEqual(port_full, "127.0.0.1:30001")
- def test_run_with_expose_ports(self):
- # create one off container
- self.base_dir = 'tests/fixtures/expose-composefile'
- self.dispatch(['run', '-d', '--service-ports', 'simple'])
- container = self.project.get_service('simple').containers(one_off=OneOffFilter.only)[0]
- ports = container.ports
- self.assertEqual(len(ports), 9)
- # exposed ports are not mapped to host ports
- assert ports['3000/tcp'] is None
- assert ports['3001/tcp'] is None
- assert ports['3001/udp'] is None
- assert ports['3002/tcp'] is None
- assert ports['3003/tcp'] is None
- assert ports['3004/tcp'] is None
- assert ports['3005/tcp'] is None
- assert ports['3006/udp'] is None
- assert ports['3007/udp'] is None
- # close all one off containers we just created
- container.stop()
- def test_run_with_custom_name(self):
- self.base_dir = 'tests/fixtures/environment-composefile'
- name = 'the-container-name'
- self.dispatch(['run', '--name', name, 'service', '/bin/true'])
- service = self.project.get_service('service')
- container, = service.containers(stopped=True, one_off=OneOffFilter.only)
- self.assertEqual(container.name, name)
- def test_run_service_with_workdir_overridden(self):
- self.base_dir = 'tests/fixtures/run-workdir'
- name = 'service'
- workdir = '/var'
- self.dispatch(['run', '--workdir={workdir}'.format(workdir=workdir), name])
- service = self.project.get_service(name)
- container = service.containers(stopped=True, one_off=True)[0]
- self.assertEqual(workdir, container.get('Config.WorkingDir'))
- def test_run_service_with_workdir_overridden_short_form(self):
- self.base_dir = 'tests/fixtures/run-workdir'
- name = 'service'
- workdir = '/var'
- self.dispatch(['run', '-w', workdir, name])
- service = self.project.get_service(name)
- container = service.containers(stopped=True, one_off=True)[0]
- self.assertEqual(workdir, container.get('Config.WorkingDir'))
- @v2_only()
- def test_run_interactive_connects_to_network(self):
- self.base_dir = 'tests/fixtures/networks'
- self.dispatch(['up', '-d'])
- self.dispatch(['run', 'app', 'nslookup', 'app'])
- self.dispatch(['run', 'app', 'nslookup', 'db'])
- containers = self.project.get_service('app').containers(
- stopped=True, one_off=OneOffFilter.only)
- assert len(containers) == 2
- for container in containers:
- networks = container.get('NetworkSettings.Networks')
- assert sorted(list(networks)) == [
- '{}_{}'.format(self.project.name, name)
- for name in ['back', 'front']
- ]
- for _, config in networks.items():
- # TODO: once we drop support for API <1.24, this can be changed to:
- # assert config['Aliases'] == [container.short_id]
- aliases = set(config['Aliases'] or []) - set([container.short_id])
- assert not aliases
- @v2_only()
- def test_run_detached_connects_to_network(self):
- self.base_dir = 'tests/fixtures/networks'
- self.dispatch(['up', '-d'])
- self.dispatch(['run', '-d', 'app', 'top'])
- container = self.project.get_service('app').containers(one_off=OneOffFilter.only)[0]
- networks = container.get('NetworkSettings.Networks')
- assert sorted(list(networks)) == [
- '{}_{}'.format(self.project.name, name)
- for name in ['back', 'front']
- ]
- for _, config in networks.items():
- # TODO: once we drop support for API <1.24, this can be changed to:
- # assert config['Aliases'] == [container.short_id]
- aliases = set(config['Aliases'] or []) - set([container.short_id])
- assert not aliases
- assert self.lookup(container, 'app')
- assert self.lookup(container, 'db')
- def test_run_handles_sigint(self):
- proc = start_process(self.base_dir, ['run', '-T', 'simple', 'top'])
- wait_on_condition(ContainerStateCondition(
- self.project.client,
- 'simplecomposefile_simple_run_1',
- 'running'))
- os.kill(proc.pid, signal.SIGINT)
- wait_on_condition(ContainerStateCondition(
- self.project.client,
- 'simplecomposefile_simple_run_1',
- 'exited'))
- def test_run_handles_sigterm(self):
- proc = start_process(self.base_dir, ['run', '-T', 'simple', 'top'])
- wait_on_condition(ContainerStateCondition(
- self.project.client,
- 'simplecomposefile_simple_run_1',
- 'running'))
- os.kill(proc.pid, signal.SIGTERM)
- wait_on_condition(ContainerStateCondition(
- self.project.client,
- 'simplecomposefile_simple_run_1',
- 'exited'))
- @mock.patch.dict(os.environ)
- def test_run_unicode_env_values_from_system(self):
- value = 'ą, ć, ę, ł, ń, ó, ś, ź, ż'
- if six.PY2: # os.environ doesn't support unicode values in Py2
- os.environ['BAR'] = value.encode('utf-8')
- else: # ... and doesn't support byte values in Py3
- os.environ['BAR'] = value
- self.base_dir = 'tests/fixtures/unicode-environment'
- result = self.dispatch(['run', 'simple'])
- if six.PY2: # Can't retrieve output on Py3. See issue #3670
- assert value == result.stdout.strip()
- container = self.project.containers(one_off=OneOffFilter.only, stopped=True)[0]
- environment = container.get('Config.Env')
- assert 'FOO={}'.format(value) in environment
- @mock.patch.dict(os.environ)
- def test_run_env_values_from_system(self):
- os.environ['FOO'] = 'bar'
- os.environ['BAR'] = 'baz'
- self.dispatch(['run', '-e', 'FOO', 'simple', 'true'], None)
- container = self.project.containers(one_off=OneOffFilter.only, stopped=True)[0]
- environment = container.get('Config.Env')
- assert 'FOO=bar' in environment
- assert 'BAR=baz' not in environment
- def test_rm(self):
- service = self.project.get_service('simple')
- service.create_container()
- kill_service(service)
- self.assertEqual(len(service.containers(stopped=True)), 1)
- self.dispatch(['rm', '--force'], None)
- self.assertEqual(len(service.containers(stopped=True)), 0)
- service = self.project.get_service('simple')
- service.create_container()
- kill_service(service)
- self.assertEqual(len(service.containers(stopped=True)), 1)
- self.dispatch(['rm', '-f'], None)
- self.assertEqual(len(service.containers(stopped=True)), 0)
- def test_rm_all(self):
- service = self.project.get_service('simple')
- service.create_container(one_off=False)
- service.create_container(one_off=True)
- kill_service(service)
- self.assertEqual(len(service.containers(stopped=True)), 1)
- self.assertEqual(len(service.containers(stopped=True, one_off=OneOffFilter.only)), 1)
- self.dispatch(['rm', '-f'], None)
- self.assertEqual(len(service.containers(stopped=True)), 0)
- self.assertEqual(len(service.containers(stopped=True, one_off=OneOffFilter.only)), 0)
- service.create_container(one_off=False)
- service.create_container(one_off=True)
- kill_service(service)
- self.assertEqual(len(service.containers(stopped=True)), 1)
- self.assertEqual(len(service.containers(stopped=True, one_off=OneOffFilter.only)), 1)
- self.dispatch(['rm', '-f', '--all'], None)
- self.assertEqual(len(service.containers(stopped=True)), 0)
- self.assertEqual(len(service.containers(stopped=True, one_off=OneOffFilter.only)), 0)
- def test_stop(self):
- self.dispatch(['up', '-d'], None)
- service = self.project.get_service('simple')
- self.assertEqual(len(service.containers()), 1)
- self.assertTrue(service.containers()[0].is_running)
- self.dispatch(['stop', '-t', '1'], None)
- self.assertEqual(len(service.containers(stopped=True)), 1)
- self.assertFalse(service.containers(stopped=True)[0].is_running)
- def test_stop_signal(self):
- self.base_dir = 'tests/fixtures/stop-signal-composefile'
- self.dispatch(['up', '-d'], None)
- service = self.project.get_service('simple')
- self.assertEqual(len(service.containers()), 1)
- self.assertTrue(service.containers()[0].is_running)
- self.dispatch(['stop', '-t', '1'], None)
- self.assertEqual(len(service.containers(stopped=True)), 1)
- self.assertFalse(service.containers(stopped=True)[0].is_running)
- self.assertEqual(service.containers(stopped=True)[0].exit_code, 0)
- def test_start_no_containers(self):
- result = self.dispatch(['start'], returncode=1)
- assert 'No containers to start' in result.stderr
- @v2_only()
- def test_up_logging(self):
- self.base_dir = 'tests/fixtures/logging-composefile'
- self.dispatch(['up', '-d'])
- simple = self.project.get_service('simple').containers()[0]
- log_config = simple.get('HostConfig.LogConfig')
- self.assertTrue(log_config)
- self.assertEqual(log_config.get('Type'), 'none')
- another = self.project.get_service('another').containers()[0]
- log_config = another.get('HostConfig.LogConfig')
- self.assertTrue(log_config)
- self.assertEqual(log_config.get('Type'), 'json-file')
- self.assertEqual(log_config.get('Config')['max-size'], '10m')
- def test_up_logging_legacy(self):
- self.base_dir = 'tests/fixtures/logging-composefile-legacy'
- self.dispatch(['up', '-d'])
- simple = self.project.get_service('simple').containers()[0]
- log_config = simple.get('HostConfig.LogConfig')
- self.assertTrue(log_config)
- self.assertEqual(log_config.get('Type'), 'none')
- another = self.project.get_service('another').containers()[0]
- log_config = another.get('HostConfig.LogConfig')
- self.assertTrue(log_config)
- self.assertEqual(log_config.get('Type'), 'json-file')
- self.assertEqual(log_config.get('Config')['max-size'], '10m')
- def test_pause_unpause(self):
- self.dispatch(['up', '-d'], None)
- service = self.project.get_service('simple')
- self.assertFalse(service.containers()[0].is_paused)
- self.dispatch(['pause'], None)
- self.assertTrue(service.containers()[0].is_paused)
- self.dispatch(['unpause'], None)
- self.assertFalse(service.containers()[0].is_paused)
- def test_pause_no_containers(self):
- result = self.dispatch(['pause'], returncode=1)
- assert 'No containers to pause' in result.stderr
- def test_unpause_no_containers(self):
- result = self.dispatch(['unpause'], returncode=1)
- assert 'No containers to unpause' in result.stderr
- def test_logs_invalid_service_name(self):
- self.dispatch(['logs', 'madeupname'], returncode=1)
- def test_logs_follow(self):
- self.base_dir = 'tests/fixtures/echo-services'
- self.dispatch(['up', '-d'])
- result = self.dispatch(['logs', '-f'])
- assert result.stdout.count('\n') == 5
- assert 'simple' in result.stdout
- assert 'another' in result.stdout
- assert 'exited with code 0' in result.stdout
- def test_logs_follow_logs_from_new_containers(self):
- self.base_dir = 'tests/fixtures/logs-composefile'
- self.dispatch(['up', '-d', 'simple'])
- proc = start_process(self.base_dir, ['logs', '-f'])
- self.dispatch(['up', '-d', 'another'])
- wait_on_condition(ContainerStateCondition(
- self.project.client,
- 'logscomposefile_another_1',
- 'exited'))
- self.dispatch(['kill', 'simple'])
- result = wait_on_process(proc)
- assert 'hello' in result.stdout
- assert 'test' in result.stdout
- assert 'logscomposefile_another_1 exited with code 0' in result.stdout
- assert 'logscomposefile_simple_1 exited with code 137' in result.stdout
- def test_logs_default(self):
- self.base_dir = 'tests/fixtures/logs-composefile'
- self.dispatch(['up', '-d'])
- result = self.dispatch(['logs'])
- assert 'hello' in result.stdout
- assert 'test' in result.stdout
- assert 'exited with' not in result.stdout
- def test_logs_on_stopped_containers_exits(self):
- self.base_dir = 'tests/fixtures/echo-services'
- self.dispatch(['up'])
- result = self.dispatch(['logs'])
- assert 'simple' in result.stdout
- assert 'another' in result.stdout
- assert 'exited with' not in result.stdout
- def test_logs_timestamps(self):
- self.base_dir = 'tests/fixtures/echo-services'
- self.dispatch(['up', '-d'])
- result = self.dispatch(['logs', '-f', '-t'])
- self.assertRegexpMatches(result.stdout, '(\d{4})-(\d{2})-(\d{2})T(\d{2})\:(\d{2})\:(\d{2})')
- def test_logs_tail(self):
- self.base_dir = 'tests/fixtures/logs-tail-composefile'
- self.dispatch(['up'])
- result = self.dispatch(['logs', '--tail', '2'])
- assert result.stdout.count('\n') == 3
- def test_kill(self):
- self.dispatch(['up', '-d'], None)
- service = self.project.get_service('simple')
- self.assertEqual(len(service.containers()), 1)
- self.assertTrue(service.containers()[0].is_running)
- self.dispatch(['kill'], None)
- self.assertEqual(len(service.containers(stopped=True)), 1)
- self.assertFalse(service.containers(stopped=True)[0].is_running)
- def test_kill_signal_sigstop(self):
- self.dispatch(['up', '-d'], None)
- service = self.project.get_service('simple')
- self.assertEqual(len(service.containers()), 1)
- self.assertTrue(service.containers()[0].is_running)
- self.dispatch(['kill', '-s', 'SIGSTOP'], None)
- self.assertEqual(len(service.containers()), 1)
- # The container is still running. It has only been paused
- self.assertTrue(service.containers()[0].is_running)
- def test_kill_stopped_service(self):
- self.dispatch(['up', '-d'], None)
- service = self.project.get_service('simple')
- self.dispatch(['kill', '-s', 'SIGSTOP'], None)
- self.assertTrue(service.containers()[0].is_running)
- self.dispatch(['kill', '-s', 'SIGKILL'], None)
- self.assertEqual(len(service.containers(stopped=True)), 1)
- self.assertFalse(service.containers(stopped=True)[0].is_running)
- def test_restart(self):
- service = self.project.get_service('simple')
- container = service.create_container()
- service.start_container(container)
- started_at = container.dictionary['State']['StartedAt']
- self.dispatch(['restart', '-t', '1'], None)
- container.inspect()
- self.assertNotEqual(
- container.dictionary['State']['FinishedAt'],
- '0001-01-01T00:00:00Z',
- )
- self.assertNotEqual(
- container.dictionary['State']['StartedAt'],
- started_at,
- )
- def test_restart_stopped_container(self):
- service = self.project.get_service('simple')
- container = service.create_container()
- container.start()
- container.kill()
- self.assertEqual(len(service.containers(stopped=True)), 1)
- self.dispatch(['restart', '-t', '1'], None)
- self.assertEqual(len(service.containers(stopped=False)), 1)
- def test_restart_no_containers(self):
- result = self.dispatch(['restart'], returncode=1)
- assert 'No containers to restart' in result.stderr
- def test_scale(self):
- project = self.project
- self.dispatch(['scale', 'simple=1'])
- self.assertEqual(len(project.get_service('simple').containers()), 1)
- self.dispatch(['scale', 'simple=3', 'another=2'])
- self.assertEqual(len(project.get_service('simple').containers()), 3)
- self.assertEqual(len(project.get_service('another').containers()), 2)
- self.dispatch(['scale', 'simple=1', 'another=1'])
- self.assertEqual(len(project.get_service('simple').containers()), 1)
- self.assertEqual(len(project.get_service('another').containers()), 1)
- self.dispatch(['scale', 'simple=1', 'another=1'])
- self.assertEqual(len(project.get_service('simple').containers()), 1)
- self.assertEqual(len(project.get_service('another').containers()), 1)
- self.dispatch(['scale', 'simple=0', 'another=0'])
- self.assertEqual(len(project.get_service('simple').containers()), 0)
- self.assertEqual(len(project.get_service('another').containers()), 0)
- def test_port(self):
- self.base_dir = 'tests/fixtures/ports-composefile'
- self.dispatch(['up', '-d'], None)
- container = self.project.get_service('simple').get_container()
- def get_port(number):
- result = self.dispatch(['port', 'simple', str(number)])
- return result.stdout.rstrip()
- self.assertEqual(get_port(3000), container.get_local_port(3000))
- self.assertEqual(get_port(3001), "0.0.0.0:49152")
- self.assertEqual(get_port(3002), "0.0.0.0:49153")
- def test_port_with_scale(self):
- self.base_dir = 'tests/fixtures/ports-composefile-scale'
- self.dispatch(['scale', 'simple=2'], None)
- containers = sorted(
- self.project.containers(service_names=['simple']),
- key=attrgetter('name'))
- def get_port(number, index=None):
- if index is None:
- result = self.dispatch(['port', 'simple', str(number)])
- else:
- result = self.dispatch(['port', '--index=' + str(index), 'simple', str(number)])
- return result.stdout.rstrip()
- self.assertEqual(get_port(3000), containers[0].get_local_port(3000))
- self.assertEqual(get_port(3000, index=1), containers[0].get_local_port(3000))
- self.assertEqual(get_port(3000, index=2), containers[1].get_local_port(3000))
- self.assertEqual(get_port(3002), "")
- def test_events_json(self):
- events_proc = start_process(self.base_dir, ['events', '--json'])
- self.dispatch(['up', '-d'])
- wait_on_condition(ContainerCountCondition(self.project, 2))
- os.kill(events_proc.pid, signal.SIGINT)
- result = wait_on_process(events_proc, returncode=1)
- lines = [json.loads(line) for line in result.stdout.rstrip().split('\n')]
- assert Counter(e['action'] for e in lines) == {'create': 2, 'start': 2}
- def test_events_human_readable(self):
- def has_timestamp(string):
- str_iso_date, str_iso_time, container_info = string.split(' ', 2)
- try:
- return isinstance(datetime.datetime.strptime(
- '%s %s' % (str_iso_date, str_iso_time),
- '%Y-%m-%d %H:%M:%S.%f'),
- datetime.datetime)
- except ValueError:
- return False
- events_proc = start_process(self.base_dir, ['events'])
- self.dispatch(['up', '-d', 'simple'])
- wait_on_condition(ContainerCountCondition(self.project, 1))
- os.kill(events_proc.pid, signal.SIGINT)
- result = wait_on_process(events_proc, returncode=1)
- lines = result.stdout.rstrip().split('\n')
- assert len(lines) == 2
- container, = self.project.containers()
- expected_template = (
- ' container {} {} (image=busybox:latest, '
- 'name=simplecomposefile_simple_1)')
- assert expected_template.format('create', container.id) in lines[0]
- assert expected_template.format('start', container.id) in lines[1]
- assert has_timestamp(lines[0])
- def test_env_file_relative_to_compose_file(self):
- config_path = os.path.abspath('tests/fixtures/env-file/docker-compose.yml')
- self.dispatch(['-f', config_path, 'up', '-d'], None)
- self._project = get_project(self.base_dir, [config_path])
- containers = self.project.containers(stopped=True)
- self.assertEqual(len(containers), 1)
- self.assertIn("FOO=1", containers[0].get('Config.Env'))
- @mock.patch.dict(os.environ)
- def test_home_and_env_var_in_volume_path(self):
- os.environ['VOLUME_NAME'] = 'my-volume'
- os.environ['HOME'] = '/tmp/home-dir'
- self.base_dir = 'tests/fixtures/volume-path-interpolation'
- self.dispatch(['up', '-d'], None)
- container = self.project.containers(stopped=True)[0]
- actual_host_path = container.get_mount('/container-path')['Source']
- components = actual_host_path.split('/')
- assert components[-2:] == ['home-dir', 'my-volume']
- def test_up_with_default_override_file(self):
- self.base_dir = 'tests/fixtures/override-files'
- self.dispatch(['up', '-d'], None)
- containers = self.project.containers()
- self.assertEqual(len(containers), 2)
- web, db = containers
- self.assertEqual(web.human_readable_command, 'top')
- self.assertEqual(db.human_readable_command, 'top')
- def test_up_with_multiple_files(self):
- self.base_dir = 'tests/fixtures/override-files'
- config_paths = [
- 'docker-compose.yml',
- 'docker-compose.override.yml',
- 'extra.yml',
- ]
- self._project = get_project(self.base_dir, config_paths)
- self.dispatch(
- [
- '-f', config_paths[0],
- '-f', config_paths[1],
- '-f', config_paths[2],
- 'up', '-d',
- ],
- None)
- containers = self.project.containers()
- self.assertEqual(len(containers), 3)
- web, other, db = containers
- self.assertEqual(web.human_readable_command, 'top')
- self.assertTrue({'db', 'other'} <= set(get_links(web)))
- self.assertEqual(db.human_readable_command, 'top')
- self.assertEqual(other.human_readable_command, 'top')
- def test_up_with_extends(self):
- self.base_dir = 'tests/fixtures/extends'
- self.dispatch(['up', '-d'], None)
- self.assertEqual(
- set([s.name for s in self.project.services]),
- set(['mydb', 'myweb']),
- )
- # Sort by name so we get [db, web]
- containers = sorted(
- self.project.containers(stopped=True),
- key=lambda c: c.name,
- )
- self.assertEqual(len(containers), 2)
- web = containers[1]
- self.assertEqual(
- set(get_links(web)),
- set(['db', 'mydb_1', 'extends_mydb_1']))
- expected_env = set([
- "FOO=1",
- "BAR=2",
- "BAZ=2",
- ])
- self.assertTrue(expected_env <= set(web.get('Config.Env')))
|