Merge pull request #1643 from aanand/warn-about-legacy-one-off-containers
Show an error on 'run' when there are legacy one-off containers
(cherry picked from commit 81707ef1ad)
Signed-off-by: Aanand Prasad <aanand.prasad@gmail.com>
This commit is contained in:
parent
4911c77134
commit
4bc4d273ac
6 changed files with 221 additions and 38 deletions
|
|
@ -1,3 +1,5 @@
|
|||
import unittest
|
||||
|
||||
from docker.errors import APIError
|
||||
|
||||
from compose import legacy
|
||||
|
|
@ -5,6 +7,64 @@ from compose.project import Project
|
|||
from .testcases import DockerClientTestCase
|
||||
|
||||
|
||||
class UtilitiesTestCase(unittest.TestCase):
|
||||
def test_has_container(self):
|
||||
self.assertTrue(
|
||||
legacy.has_container("composetest", "web", "composetest_web_1", one_off=False),
|
||||
)
|
||||
self.assertFalse(
|
||||
legacy.has_container("composetest", "web", "composetest_web_run_1", one_off=False),
|
||||
)
|
||||
|
||||
def test_has_container_one_off(self):
|
||||
self.assertFalse(
|
||||
legacy.has_container("composetest", "web", "composetest_web_1", one_off=True),
|
||||
)
|
||||
self.assertTrue(
|
||||
legacy.has_container("composetest", "web", "composetest_web_run_1", one_off=True),
|
||||
)
|
||||
|
||||
def test_has_container_different_project(self):
|
||||
self.assertFalse(
|
||||
legacy.has_container("composetest", "web", "otherapp_web_1", one_off=False),
|
||||
)
|
||||
self.assertFalse(
|
||||
legacy.has_container("composetest", "web", "otherapp_web_run_1", one_off=True),
|
||||
)
|
||||
|
||||
def test_has_container_different_service(self):
|
||||
self.assertFalse(
|
||||
legacy.has_container("composetest", "web", "composetest_db_1", one_off=False),
|
||||
)
|
||||
self.assertFalse(
|
||||
legacy.has_container("composetest", "web", "composetest_db_run_1", one_off=True),
|
||||
)
|
||||
|
||||
def test_is_valid_name(self):
|
||||
self.assertTrue(
|
||||
legacy.is_valid_name("composetest_web_1", one_off=False),
|
||||
)
|
||||
self.assertFalse(
|
||||
legacy.is_valid_name("composetest_web_run_1", one_off=False),
|
||||
)
|
||||
|
||||
def test_is_valid_name_one_off(self):
|
||||
self.assertFalse(
|
||||
legacy.is_valid_name("composetest_web_1", one_off=True),
|
||||
)
|
||||
self.assertTrue(
|
||||
legacy.is_valid_name("composetest_web_run_1", one_off=True),
|
||||
)
|
||||
|
||||
def test_is_valid_name_invalid(self):
|
||||
self.assertFalse(
|
||||
legacy.is_valid_name("foo"),
|
||||
)
|
||||
self.assertFalse(
|
||||
legacy.is_valid_name("composetest_web_lol_1", one_off=True),
|
||||
)
|
||||
|
||||
|
||||
class LegacyTestCase(DockerClientTestCase):
|
||||
|
||||
def setUp(self):
|
||||
|
|
@ -30,7 +90,7 @@ class LegacyTestCase(DockerClientTestCase):
|
|||
|
||||
# Create a single one-off legacy container
|
||||
self.containers.append(self.client.create_container(
|
||||
name='{}_{}_run_1'.format(self.project.name, self.services[0].name),
|
||||
name='{}_{}_run_1'.format(self.project.name, db.name),
|
||||
**self.services[0].options
|
||||
))
|
||||
|
||||
|
|
@ -47,27 +107,84 @@ class LegacyTestCase(DockerClientTestCase):
|
|||
pass
|
||||
|
||||
def get_legacy_containers(self, **kwargs):
|
||||
return list(legacy.get_legacy_containers(
|
||||
return legacy.get_legacy_containers(
|
||||
self.client,
|
||||
self.project.name,
|
||||
[s.name for s in self.services],
|
||||
**kwargs
|
||||
))
|
||||
)
|
||||
|
||||
def test_get_legacy_container_names(self):
|
||||
self.assertEqual(len(self.get_legacy_containers()), len(self.services))
|
||||
|
||||
def test_get_legacy_container_names_one_off(self):
|
||||
self.assertEqual(len(self.get_legacy_containers(stopped=True, one_off=True)), 1)
|
||||
self.assertEqual(len(self.get_legacy_containers(one_off=True)), 1)
|
||||
|
||||
def test_migration_to_labels(self):
|
||||
# Trying to get the container list raises an exception
|
||||
|
||||
with self.assertRaises(legacy.LegacyContainersError) as cm:
|
||||
self.assertEqual(self.project.containers(stopped=True), [])
|
||||
self.project.containers(stopped=True)
|
||||
|
||||
self.assertEqual(
|
||||
set(cm.exception.names),
|
||||
set(['composetest_db_1', 'composetest_web_1', 'composetest_nginx_1']),
|
||||
)
|
||||
|
||||
self.assertEqual(
|
||||
set(cm.exception.one_off_names),
|
||||
set(['composetest_db_run_1']),
|
||||
)
|
||||
|
||||
# Migrate the containers
|
||||
|
||||
legacy.migrate_project_to_labels(self.project)
|
||||
self.assertEqual(len(self.project.containers(stopped=True)), len(self.services))
|
||||
|
||||
# Getting the list no longer raises an exception
|
||||
|
||||
containers = self.project.containers(stopped=True)
|
||||
self.assertEqual(len(containers), len(self.services))
|
||||
|
||||
def test_migration_one_off(self):
|
||||
# We've already migrated
|
||||
|
||||
legacy.migrate_project_to_labels(self.project)
|
||||
|
||||
# Trying to create a one-off container results in a Docker API error
|
||||
|
||||
with self.assertRaises(APIError) as cm:
|
||||
self.project.get_service('db').create_container(one_off=True)
|
||||
|
||||
# Checking for legacy one-off containers raises an exception
|
||||
|
||||
with self.assertRaises(legacy.LegacyOneOffContainersError) as cm:
|
||||
legacy.check_for_legacy_containers(
|
||||
self.client,
|
||||
self.project.name,
|
||||
['db'],
|
||||
allow_one_off=False,
|
||||
)
|
||||
|
||||
self.assertEqual(
|
||||
set(cm.exception.one_off_names),
|
||||
set(['composetest_db_run_1']),
|
||||
)
|
||||
|
||||
# Remove the old one-off container
|
||||
|
||||
c = self.client.inspect_container('composetest_db_run_1')
|
||||
self.client.remove_container(c)
|
||||
|
||||
# Checking no longer raises an exception
|
||||
|
||||
legacy.check_for_legacy_containers(
|
||||
self.client,
|
||||
self.project.name,
|
||||
['db'],
|
||||
allow_one_off=False,
|
||||
)
|
||||
|
||||
# Creating a one-off container no longer results in an API error
|
||||
|
||||
self.project.get_service('db').create_container(one_off=True)
|
||||
self.assertIsInstance(self.client.inspect_container('composetest_db_run_1'), dict)
|
||||
|
|
|
|||
|
|
@ -127,7 +127,7 @@ class CLITestCase(unittest.TestCase):
|
|||
def test_run_with_environment_merged_with_options_list(self, mock_dockerpty):
|
||||
command = TopLevelCommand()
|
||||
mock_client = mock.create_autospec(docker.Client)
|
||||
mock_project = mock.Mock()
|
||||
mock_project = mock.Mock(client=mock_client)
|
||||
mock_project.get_service.return_value = Service(
|
||||
'service',
|
||||
client=mock_client,
|
||||
|
|
@ -156,7 +156,7 @@ class CLITestCase(unittest.TestCase):
|
|||
def test_run_service_with_restart_always(self):
|
||||
command = TopLevelCommand()
|
||||
mock_client = mock.create_autospec(docker.Client)
|
||||
mock_project = mock.Mock()
|
||||
mock_project = mock.Mock(client=mock_client)
|
||||
mock_project.get_service.return_value = Service(
|
||||
'service',
|
||||
client=mock_client,
|
||||
|
|
@ -180,7 +180,7 @@ class CLITestCase(unittest.TestCase):
|
|||
|
||||
command = TopLevelCommand()
|
||||
mock_client = mock.create_autospec(docker.Client)
|
||||
mock_project = mock.Mock()
|
||||
mock_project = mock.Mock(client=mock_client)
|
||||
mock_project.get_service.return_value = Service(
|
||||
'service',
|
||||
client=mock_client,
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue