Added migration support
All checks were successful
buildbot/tox Build done.

This commit is contained in:
2019-12-03 16:31:46 +01:00
parent 64f7201b91
commit 6b147fb41e
4 changed files with 225 additions and 30 deletions

View File

@@ -138,6 +138,12 @@ class DjangoProject(object):
self._append_to_pythonfile(urlconf_file, text)
def add_app_settings(self, module_path, hooks_config_name=None):
try:
self.create()
except DjangoDeployError as e:
if e.code != errno.EEXIST: # pragma: no cover
raise e
hooks_config = self._get_hooks_config_from_app(module_path, hooks_config_name)
app_settings = getattr(hooks_config, 'SETTINGS', None)
@@ -160,6 +166,8 @@ class DjangoProject(object):
self._append_to_pythonfile(settings_file, text)
def install_app(self, module_path, hooks_config_name=None):
self.add_app_settings(module_path, hooks_config_name=hooks_config_name)
hooks_config = self._get_hooks_config_from_app(module_path, hooks_config_name)
installed_apps = getattr(hooks_config, 'INSTALLED_APPS', [])
@@ -169,7 +177,6 @@ class DjangoProject(object):
config[module_path]['INSTALLED_APPS'] = installed_apps
config.write()
self.add_app_settings(module_path, hooks_config_name=hooks_config_name)
def mount_app(self, module_path, route, hooks_config_name=None):
self.install_app(module_path, hooks_config_name=hooks_config_name)
@@ -193,12 +200,17 @@ class DjangoProject(object):
config[module_path]['MOUNT'] = [route, urlconf]
config.write()
def migrate_apps(self, labels=None):
def migrate_apps(self, apps=None):
project_dir = self._project_dir
management_script = os.path.join(project_dir, 'manage.py')
if labels:
for label in labels:
if not os.path.exists(management_script):
raise DjangoDeployError('No such file: {}. Have you created the django project?'.format(management_script),
code=errno.ENOENT)
if apps:
for app_name in apps:
label = app_name.rpartition('.')[2]
cmd = [management_script, 'migrate', label]
try:
subprocess.check_output(cmd, stderr=subprocess.STDOUT)

View File

@@ -31,6 +31,15 @@ class Program(object): # pylint: disable=too-few-public-methods
help='Merge settings from django app MODULE into django project settings'
'. Can be used multiple times')
parser.add_argument('--migrate',
action='store_true', dest='migrate_all',
help='Migrate database')
parser.add_argument('--migrate-app',
action='append', dest='migrate_apps', metavar='APP',
help='Migrate database up to the newest migration from app'
'. Can be used multiple times')
parser.add_argument('-m', '--mount-app',
nargs=2,
action='append', dest='mount_apps', metavar=('MODULE', 'ROUTE'),
@@ -66,6 +75,14 @@ class Program(object): # pylint: disable=too-few-public-methods
project = DjangoProject(project_dir)
project.install_app(module_path)
@staticmethod
def _migrate(project_dir, module_path=None):
project = DjangoProject(project_dir)
if module_path is not None:
project.migrate_apps([module_path])
else:
project.migrate_apps([])
@staticmethod
def _mount_app(project_dir, module_path, route):
project = DjangoProject(project_dir)
@@ -94,6 +111,11 @@ class Program(object): # pylint: disable=too-few-public-methods
exceptions.append(e)
continue
raise # pragma: no cover
if cmd_args.migrate_all:
self._migrate(cmd_args.project_dir)
elif cmd_args.migrate_apps:
for app in cmd_args.migrate_apps:
self._migrate(cmd_args.project_dir, app)
if cmd_args.mount_apps:
for app, route in cmd_args.mount_apps:
try:
@@ -108,7 +130,10 @@ class Program(object): # pylint: disable=too-few-public-methods
for e in exceptions:
if e.message:
sys.stderr.write('{}\n'.format(e.message))
msg = str(e.message)
if not msg.endswith('\n'):
msg += '\n'
sys.stderr.write(msg)
elif e.code: # pragma: no cover
sys.stderr.write('{}\n'.format(os.strerror(e.code)))
exitval = e.exitval or os.EX_SOFTWARE

View File

@@ -1,5 +1,6 @@
import errno
import os
import django
from ..api import DjangoProjectHooksConfig, DjangoProject
from ..exceptions import DjangoDeployError
@@ -127,7 +128,7 @@ class DjangoProjectInstallHooksTestCase(AbstractDjangoProjectTestCase):
class DjangoProjectAddAppSettingsTestCase(AbstractDjangoProjectTestCase):
def test_add_app_settings(self):
def test_add_app_settings_with_create(self):
project_dir = self._tmp_dir
project = DjangoProject(project_dir)
project.create()
@@ -141,12 +142,24 @@ class DjangoProjectAddAppSettingsTestCase(AbstractDjangoProjectTestCase):
self.assert_settings_from_apps(project_dir, apps)
def test_add_app_settings_without_create(self):
project_dir = self._tmp_dir
project = DjangoProject(project_dir)
apps = [
'django_deploy.tests.fake_app1',
'django_deploy.tests.fake_app2',
'django_deploy',
]
for app in apps:
project.add_app_settings(app)
self.assert_settings_from_apps(project_dir, apps)
class DjangoProjectInstallAppTestCase(AbstractDjangoProjectTestCase):
def test_install_app(self):
project_dir = self._tmp_dir
project = DjangoProject(project_dir)
project.create()
app = 'django_deploy.tests.fake_app1'
@@ -156,7 +169,6 @@ class DjangoProjectInstallAppTestCase(AbstractDjangoProjectTestCase):
def test_install_apps(self):
project_dir = self._tmp_dir
project = DjangoProject(project_dir)
project.create()
apps = [
'django_deploy.tests.fake_app1',
@@ -177,7 +189,6 @@ class DjangoProjectInstallAppTestCase(AbstractDjangoProjectTestCase):
def test_install_nonexisting_app(self):
project_dir = self._tmp_dir
project = DjangoProject(project_dir)
project.create()
try:
project.install_app('django_deploy.tests.fake_app0')
except DjangoDeployError as e:
@@ -188,7 +199,6 @@ class DjangoProjectInstallAppTestCase(AbstractDjangoProjectTestCase):
def test_install_nonconforming_app(self):
project_dir = self._tmp_dir
project = DjangoProject(project_dir)
project.create()
try:
project.install_app('django_deploy.tests.fake_app1', hooks_config_name='non_existing_submodule')
except DjangoDeployError as e:
@@ -201,7 +211,6 @@ class DjangoProjectMountAppTestCase(AbstractDjangoProjectTestCase):
def test_mount_app(self):
project_dir = self._tmp_dir
project = DjangoProject(project_dir)
project.create()
project.mount_app('django_deploy.tests.fake_app1', '')
expected_urlpatterns = [
@@ -212,7 +221,6 @@ class DjangoProjectMountAppTestCase(AbstractDjangoProjectTestCase):
def test_mount_apps(self):
project_dir = self._tmp_dir
project = DjangoProject(project_dir)
project.create()
project.mount_app('django_deploy.tests.fake_app1', 'app1')
project.mount_app('django_deploy.tests.fake_app1', 'app1')
project.mount_app('django_deploy.tests.fake_app2', 'app2/')
@@ -232,7 +240,6 @@ class DjangoProjectMountAppTestCase(AbstractDjangoProjectTestCase):
def test_mount_unmountable_app(self):
project_dir = self._tmp_dir
project = DjangoProject(project_dir)
project.create()
try:
project.mount_app('django_deploy', '/')
@@ -243,33 +250,67 @@ class DjangoProjectMountAppTestCase(AbstractDjangoProjectTestCase):
class DjangoProjectMigrateAppTestCase(AbstractDjangoProjectTestCase):
def test_migrate_app(self):
project_dir = self._tmp_dir
project = DjangoProject(project_dir)
project.create()
project.install_app('django_deploy.tests.fake_app1')
project.migrate_apps(['fake_app1'])
self.assert_django_database_migration(project_dir, 'fake_app1')
def test_migrate_all_apps(self):
project_dir = self._tmp_dir
project = DjangoProject(project_dir)
project.create()
project.install_app('django_deploy.tests.fake_app1')
project.install_app('django_deploy.tests.fake_app2')
project.migrate_apps([])
self.assert_django_database_migration(project_dir)
def test_migrate_app_without_migrations(self):
def test_migrate_app_by_app_name(self):
project_dir = self._tmp_dir
project = DjangoProject(project_dir)
project.install_app('django_deploy.tests.fake_app1')
project.migrate_apps(['django_deploy.tests.fake_app1'])
self.assert_django_database_migration(project_dir, 'fake_app1')
def test_migrate_app_by_app_label(self):
project_dir = self._tmp_dir
project = DjangoProject(project_dir)
project.install_app('django_deploy.tests.fake_app1')
project.migrate_apps(['fake_app1'])
self.assert_django_database_migration(project_dir, 'fake_app1')
def test_migrate_app_not_installed(self):
project_dir = self._tmp_dir
project = DjangoProject(project_dir)
project.create()
try:
project.migrate_apps(['django_deploy.tests.fake_app1'])
except DjangoDeployError as e:
if django.VERSION[0] < 2: # pragma: no cover
expected_msg = "CommandError: App 'fake_app1' does not have migrations.\n"
else: # pragma: no cover
expected_msg = "CommandError: No installed app with label 'fake_app1'.\n"
self.assertEqual(expected_msg, e.message)
else: # pragma: no cover
self.fail('DjangoDeployError not raised')
def test_migrate_app_without_create(self):
project_dir = self._tmp_dir
project = DjangoProject(project_dir)
try:
project.migrate_apps(['fake_app1'])
except DjangoDeployError as e:
self.assertTrue(e.message.startswith('No such file: '))
self.assertTrue(e.message.endswith('Have you created the django project?'))
self.assertEqual(errno.ENOENT, e.code)
else: # pragma: no cover
self.fail('DjangoDeployError not raised')
def test_migrate_app_without_migrations(self):
project_dir = self._tmp_dir
project = DjangoProject(project_dir)
project.install_app('django_deploy.tests.fake_app2')
try:
project.migrate_apps(['fake_app2'])
project.migrate_apps(['django_deploy.tests.fake_app2'])
except DjangoDeployError as e:
self.assertEqual(e.message, "CommandError: App 'fake_app2' does not have migrations.\n")
else: # pragma: no cover

View File

@@ -1,4 +1,6 @@
import os
import django
import pytest
from ..config import DJANGO_SETTINGS_DIR
from ..program import Program
@@ -6,11 +8,17 @@ from ..program import Program
from .generic import DjangoDeployTestCase
class ProgramTestCase(DjangoDeployTestCase):
class AbstractProgramTestCase(DjangoDeployTestCase):
@pytest.fixture(autouse=True)
def capsys(self, capsys): # pylint: disable=method-hidden
self.capsys = capsys
def setUp(self):
self._program = Program()
self._tmp_dir = str(self.tmpdir)
class ProgramCreateTestCase(AbstractProgramTestCase):
def test_create(self):
project_dir = os.path.join(self._tmp_dir, 'new')
exitval = self._program(argv=['--create', project_dir])
@@ -66,10 +74,11 @@ class ProgramTestCase(DjangoDeployTestCase):
exitval = self._program(argv=['--install-hooks', project_dir])
self.assertEqual(os.EX_SOFTWARE, exitval)
class ProgramInstallTestCase(AbstractProgramTestCase):
def test_install_apps(self):
project_dir = self._tmp_dir
argv = [
'-c',
'--install-app', 'django_deploy.tests.fake_app1',
'--install-app', 'django_deploy.tests.fake_app1',
'-a', 'django_deploy.tests.fake_app2',
@@ -87,10 +96,19 @@ class ProgramTestCase(DjangoDeployTestCase):
self.assert_installed_apps(project_dir, installed_apps)
self.assert_urlpatterns(project_dir, [])
def test_install_apps_with_error(self):
def test_install_with_explicit_create(self):
project_dir = self._tmp_dir
argv = [
'-c',
'--install-app', 'django_deploy.tests.fake_app1',
project_dir
]
exitval = self._program(argv=argv)
self.assertEqual(os.EX_OK, exitval)
def test_install_apps_with_error(self):
project_dir = self._tmp_dir
argv = [
'-a', 'django_deploy.tests.fake_app1',
'-a', 'django_deploy.tests.fake_app0',
'-a', 'django_deploy.tests.fake_app2',
@@ -106,10 +124,11 @@ class ProgramTestCase(DjangoDeployTestCase):
self.assert_installed_apps(project_dir, installed_apps)
class ProgramMountTestCase(AbstractProgramTestCase):
def test_mount_apps(self):
project_dir = self._tmp_dir
argv = [
'-c',
'--mount-app', 'django_deploy.tests.fake_app1', 'app1',
'--mount-app', 'django_deploy.tests.fake_app1', 'app1',
'-m', 'django_deploy.tests.fake_app2', 'app2/',
@@ -136,7 +155,6 @@ class ProgramTestCase(DjangoDeployTestCase):
def test_mount_apps_with_errors(self):
project_dir = self._tmp_dir
self._program(argv=['-c', project_dir])
argv = [
'-m', 'django_deploy.tests.fake_app1', '/',
'-m', 'django_deploy.tests.fake_app0', 'app0',
@@ -153,3 +171,102 @@ class ProgramTestCase(DjangoDeployTestCase):
]
self.assert_urlpatterns(project_dir, expected_urlpatterns)
class ProgramMigrateTestCase(AbstractProgramTestCase):
def test_migrate_all(self):
project_dir = self._tmp_dir
argv = [
'--install-app', 'django_deploy.tests.fake_app1',
'--install-app', 'django_deploy.tests.fake_app2',
'--migrate',
project_dir
]
exitval = self._program(argv=argv)
self.assertEqual(os.EX_OK, exitval)
self.assert_django_database_migration(project_dir)
def test_migrate_app_by_app_name(self):
project_dir = self._tmp_dir
argv = [
'--install-app', 'django_deploy.tests.fake_app1',
'--migrate-app', 'django_deploy.tests.fake_app1',
project_dir
]
exitval = self._program(argv=argv)
self.assertEqual(os.EX_OK, exitval)
self.assert_django_database_migration(project_dir, 'fake_app1')
def test_migrate_app_by_app_label(self):
project_dir = self._tmp_dir
argv = [
'--install-app', 'django_deploy.tests.fake_app1',
'--migrate-app', 'fake_app1',
project_dir
]
exitval = self._program(argv=argv)
self.assertEqual(os.EX_OK, exitval)
self.assert_django_database_migration(project_dir, 'fake_app1')
def test_migrate_app_not_installed(self):
project_dir = self._tmp_dir
argv = [
'-c',
'--migrate-app', 'django_deploy.tests.fake_app1',
project_dir
]
exitval = self._program(argv=argv)
self.assertNotEqual(os.EX_OK, exitval)
captured = self.capsys.readouterr()
if django.VERSION[0] < 2: # pragma: no cover
expected_msg = "CommandError: App 'fake_app1' does not have migrations.\n"
else: # pragma: no cover
expected_msg = "CommandError: No installed app with label 'fake_app1'.\n"
self.assertEqual(expected_msg, captured.err)
def test_migrate_app_without_create(self):
project_dir = self._tmp_dir
argv = [
'--migrate-app', 'django_deploy.tests.fake_app1',
project_dir
]
exitval = self._program(argv=argv)
self.assertNotEqual(os.EX_OK, exitval)
captured = self.capsys.readouterr()
self.assertTrue(captured.err.endswith('Have you created the django project?\n'))
def test_migrate_app_without_migrations(self):
project_dir = self._tmp_dir
argv = [
'--install-app', 'django_deploy.tests.fake_app1',
'--install-app', 'django_deploy.tests.fake_app2',
'--migrate-app', 'fake_app2',
'--migrate-app', 'fake_app1',
project_dir
]
exitval = self._program(argv=argv)
self.assertNotEqual(os.EX_OK, exitval)
captured = self.capsys.readouterr()
self.assertEqual("CommandError: App 'fake_app2' does not have migrations.\n", captured.err)
def test_migrate_app_stop_on_first_error(self):
project_dir = self._tmp_dir
argv = [
'--install-app', 'django_deploy.tests.fake_app1',
'--install-app', 'django_deploy.tests.fake_app2',
'--migrate-app', 'fake_app2',
'--migrate-app', 'fake_app1',
'--migrate-app', 'django_deploy',
project_dir
]
exitval = self._program(argv=argv)
self.assertNotEqual(os.EX_OK, exitval)
captured = self.capsys.readouterr()
self.assertEqual("CommandError: App 'fake_app2' does not have migrations.\n", captured.err)
try:
self.assert_django_database_migration(project_dir, 'fake_app1')
except AssertionError:
pass
else: # pragma: no cover
self.fail('Unexcepted migrations done')