From 395379178bc641f0c657271d198f84c3dc93708b Mon Sep 17 00:00:00 2001 From: David-Wobrock Date: Wed, 19 Dec 2018 22:08:44 +0100 Subject: [PATCH 1/7] Fix linting through using a raw python string --- django_migration_linter/migration_linter.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/django_migration_linter/migration_linter.py b/django_migration_linter/migration_linter.py index b2cd6aa..18ca0d1 100644 --- a/django_migration_linter/migration_linter.py +++ b/django_migration_linter/migration_linter.py @@ -166,7 +166,7 @@ class MigrationLinter(object): utils.clean_bytes_to_str, diff_process.stdout.readlines()): # Only gather lines that include added migrations if re.search( - '\/{0}\/.*\.py'.format(self.MIGRATION_FOLDER_NAME), + r'\/{0}\/.*\.py'.format(self.MIGRATION_FOLDER_NAME), line) and \ '__init__' not in line: app_name, migration_name = self._split_migration_path(line) From 357f0aebf4771a3c30432795d601649ff73d7216 Mon Sep 17 00:00:00 2001 From: Felix Date: Tue, 18 Dec 2018 16:46:50 +0100 Subject: [PATCH 2/7] Adapt tests so that not relying on undefined behaviour. The app directories can appear in any order, we need to allow that in tests. --- django_migration_linter/migration_linter.py | 3 +- tests/functional/test_cmd_line_call.py | 56 +++++++++++++++------ tests/unit/test_linter.py | 14 +++--- 3 files changed, 50 insertions(+), 23 deletions(-) diff --git a/django_migration_linter/migration_linter.py b/django_migration_linter/migration_linter.py index 18ca0d1..d952193 100644 --- a/django_migration_linter/migration_linter.py +++ b/django_migration_linter/migration_linter.py @@ -18,6 +18,7 @@ import os import re from subprocess import Popen, PIPE import sys + from . import utils from .sql_analyser import analyse_sql_statements @@ -186,7 +187,7 @@ class MigrationLinter(object): def _gather_all_migrations(self): migrations = [] for root, dirs, files in os.walk(self.django_path): - for file_name in files: + for file_name in sorted(files): if os.path.basename(root) == self.MIGRATION_FOLDER_NAME and \ file_name.endswith('.py') and \ file_name != '__init__.py': diff --git a/tests/functional/test_cmd_line_call.py b/tests/functional/test_cmd_line_call.py index a3afd33..abc9479 100644 --- a/tests/functional/test_cmd_line_call.py +++ b/tests/functional/test_cmd_line_call.py @@ -35,9 +35,14 @@ class CallLinterFromCommandLineTest(unittest.TestCase): self.assertEqual(process.returncode, 0) lines = list(map(utils.clean_bytes_to_str, process.stdout.readlines())) self.assertEqual(len(lines), 5) - self.assertTrue(lines[0].endswith('OK')) - self.assertTrue(lines[1].endswith('OK')) - self.assertTrue(lines[2].endswith('OK')) + self.assertEqual( + sorted(lines[:3]), + sorted([ + "(test_app1, 0001_initial)... OK", + "(test_app1, 0002_a_new_null_field)... OK", + "(test_app2, 0001_foo)... OK", + ]) + ) def test_call_linter_cmd_line_errors(self): cmd = '{0} {1}'.format( @@ -50,7 +55,6 @@ class CallLinterFromCommandLineTest(unittest.TestCase): self.assertNotEqual(process.returncode, 0) lines = list(map(utils.clean_bytes_to_str, process.stdout.readlines())) self.assertEqual(len(lines), 5) - print(lines) self.assertTrue(lines[0].endswith('OK')) self.assertTrue(lines[1].endswith('ERR')) self.assertTrue('RENAMING tables' in lines[2]) @@ -66,9 +70,14 @@ class CallLinterFromCommandLineTest(unittest.TestCase): self.assertEqual(process.returncode, 0) lines = list(map(utils.clean_bytes_to_str, process.stdout.readlines())) self.assertEqual(len(lines), 5) - self.assertTrue(lines[0].endswith('OK')) - self.assertTrue(lines[1].endswith('OK')) - self.assertTrue(lines[2].endswith('IGNORE')) + self.assertEqual( + sorted(lines[:3]), + sorted([ + "(test_app1, 0001_initial)... OK", + "(test_app1, 0002_a_new_null_field)... OK", + "(test_app2, 0001_foo)... IGNORE", + ]) + ) def test_call_linter_cmd_line_include_apps(self): cmd = '{0} {1} --include-apps test_app2'.format( @@ -81,9 +90,14 @@ class CallLinterFromCommandLineTest(unittest.TestCase): self.assertEqual(process.returncode, 0) lines = list(map(utils.clean_bytes_to_str, process.stdout.readlines())) self.assertEqual(len(lines), 5) - self.assertTrue(lines[0].endswith('IGNORE')) - self.assertTrue(lines[1].endswith('IGNORE')) - self.assertTrue(lines[2].endswith('OK')) + self.assertEqual( + sorted(lines[:3]), + sorted([ + "(test_app1, 0001_initial)... IGNORE", + "(test_app1, 0002_a_new_null_field)... IGNORE", + "(test_app2, 0001_foo)... OK", + ]) + ) def test_call_linter_cmd_line_ignore_name(self): cmd = '{0} {1} --ignore-name 0001_initial'.format( @@ -96,9 +110,14 @@ class CallLinterFromCommandLineTest(unittest.TestCase): self.assertEqual(process.returncode, 0) lines = list(map(utils.clean_bytes_to_str, process.stdout.readlines())) self.assertEqual(len(lines), 5) - self.assertTrue(lines[0].endswith('IGNORE')) - self.assertTrue(lines[1].endswith('OK')) - self.assertTrue(lines[2].endswith('OK')) + self.assertEqual( + sorted(lines[:3]), + sorted([ + "(test_app1, 0001_initial)... IGNORE", + "(test_app1, 0002_a_new_null_field)... OK", + "(test_app2, 0001_foo)... OK", + ]) + ) def test_call_linter_cmd_line_ignore_name_contains(self): cmd = '{0} {1} --ignore-name-contains 0001'.format( @@ -111,9 +130,14 @@ class CallLinterFromCommandLineTest(unittest.TestCase): self.assertEqual(process.returncode, 0) lines = list(map(utils.clean_bytes_to_str, process.stdout.readlines())) self.assertEqual(len(lines), 5) - self.assertTrue(lines[0].endswith('IGNORE')) - self.assertTrue(lines[1].endswith('OK')) - self.assertTrue(lines[2].endswith('IGNORE')) + self.assertEqual( + sorted(lines[:3]), + sorted([ + "(test_app1, 0001_initial)... IGNORE", + "(test_app1, 0002_a_new_null_field)... OK", + "(test_app2, 0001_foo)... IGNORE", + ]) + ) def test_call_linter_cmd_line_git_id(self): cmd = '{0} {1} d7125d5f4f0cc9623f670a66c54f131acc50032d'.format( diff --git a/tests/unit/test_linter.py b/tests/unit/test_linter.py index 0a4e47e..57e449e 100644 --- a/tests/unit/test_linter.py +++ b/tests/unit/test_linter.py @@ -99,9 +99,11 @@ class TestLinterFunctions(unittest.TestCase): linter = MigrationLinter(fixtures.CORRECT_PROJECT) migrations = linter._gather_all_migrations() self.assertEqual(len(migrations), 3) - self.assertEqual(migrations[0][0], 'test_app1') - self.assertEqual(migrations[0][1], '0001_initial') - self.assertEqual(migrations[1][0], 'test_app1') - self.assertEqual(migrations[1][1], '0002_a_new_null_field') - self.assertEqual(migrations[2][0], 'test_app2') - self.assertEqual(migrations[2][1], '0001_foo') + self.assertEqual( + sorted(migrations), + sorted([ + ("test_app1", "0001_initial"), + ("test_app1", "0002_a_new_null_field"), + ("test_app2", "0001_foo"), + ]) + ) From 9e3dbf7778e744bfbde5a3c6eddf13bb61ae2481 Mon Sep 17 00:00:00 2001 From: Felix Date: Sun, 9 Dec 2018 15:52:57 +0100 Subject: [PATCH 3/7] Mark migrations as ignored --- README.rst | 17 +++ django_migration_linter/migration_linter.py | 11 ++ django_migration_linter/sql_analyser.py | 40 ++++-- setup.py | 1 + tests/fixtures.py | 2 + tests/functional/test_migration_linter.py | 4 + .../test_project_ignore_migration/.gitignore | 3 + .../test_project_ignore_migration/manage.py | 22 ++++ .../test_app/__init__.py | 0 .../test_app/admin.py | 3 + .../test_app/apps.py | 5 + .../test_app/migrations/0001_create_table.py | 23 ++++ .../test_app/migrations/0002_rename_table.py | 22 ++++ .../test_app/migrations/__init__.py | 0 .../test_app/models.py | 4 + .../test_app/tests.py | 3 + .../test_app/views.py | 3 + .../test_project_ignore_migration/__init__.py | 0 .../test_project_ignore_migration/settings.py | 121 ++++++++++++++++++ .../test_project_ignore_migration/urls.py | 21 +++ .../test_project_ignore_migration/wsgi.py | 16 +++ tox.ini | 1 + 22 files changed, 310 insertions(+), 12 deletions(-) create mode 100644 tests/test_project_fixtures/test_project_ignore_migration/.gitignore create mode 100644 tests/test_project_fixtures/test_project_ignore_migration/manage.py create mode 100644 tests/test_project_fixtures/test_project_ignore_migration/test_app/__init__.py create mode 100644 tests/test_project_fixtures/test_project_ignore_migration/test_app/admin.py create mode 100644 tests/test_project_fixtures/test_project_ignore_migration/test_app/apps.py create mode 100644 tests/test_project_fixtures/test_project_ignore_migration/test_app/migrations/0001_create_table.py create mode 100644 tests/test_project_fixtures/test_project_ignore_migration/test_app/migrations/0002_rename_table.py create mode 100644 tests/test_project_fixtures/test_project_ignore_migration/test_app/migrations/__init__.py create mode 100644 tests/test_project_fixtures/test_project_ignore_migration/test_app/models.py create mode 100644 tests/test_project_fixtures/test_project_ignore_migration/test_app/tests.py create mode 100644 tests/test_project_fixtures/test_project_ignore_migration/test_app/views.py create mode 100644 tests/test_project_fixtures/test_project_ignore_migration/test_project_ignore_migration/__init__.py create mode 100644 tests/test_project_fixtures/test_project_ignore_migration/test_project_ignore_migration/settings.py create mode 100644 tests/test_project_fixtures/test_project_ignore_migration/test_project_ignore_migration/urls.py create mode 100644 tests/test_project_fixtures/test_project_ignore_migration/test_project_ignore_migration/wsgi.py diff --git a/README.rst b/README.rst index 2e80e6f..0c4710c 100644 --- a/README.rst +++ b/README.rst @@ -52,6 +52,23 @@ Examples 3YOURMIND is running the linter on `Bitbucket Pipelines`_ on every build getting pushed. Checkout the ``examples/`` folder to see how you could integrate the linter in your test suite. +Ignoring Migrations +------------------- + +You can also ignore migrations by adding this to your migrations: + +.. code-block:: + + from django_migration_linter import IGNORE_MIGRATION + # ... + + operations = [ + migrations.RunSQL(IGNORE_MIGRATION), + # ... + ] + # ... + + Tests ----- diff --git a/django_migration_linter/migration_linter.py b/django_migration_linter/migration_linter.py index d952193..79f25e6 100644 --- a/django_migration_linter/migration_linter.py +++ b/django_migration_linter/migration_linter.py @@ -24,6 +24,11 @@ from .sql_analyser import analyse_sql_statements logger = logging.getLogger(__name__) +# Can be used to mark ignored migrations. +# This is a noop for SQL. Comments would be better. +# But comments are stripped by RunSQL +IGNORE_MIGRATION = "SELECT 'dml-ignore'" + class MigrationLinter(object): MIGRATION_FOLDER_NAME = 'migrations' @@ -69,6 +74,12 @@ class MigrationLinter(object): analysis_result = analyse_sql_statements( sql_statements) errors = analysis_result['errors'] + + if analysis_result['ignored']: + print('IGNORE') + self.nb_ignored += 1 + return + if not errors: print('OK') self.nb_valid += 1 diff --git a/django_migration_linter/sql_analyser.py b/django_migration_linter/sql_analyser.py index 0fe3c1b..d07f544 100644 --- a/django_migration_linter/sql_analyser.py +++ b/django_migration_linter/sql_analyser.py @@ -63,29 +63,45 @@ migration_tests = ( 'code': '', 'fn': has_default, 'err_msg': '' + }, { + 'code': 'IGNORED_MIGRATION', + 'fn': lambda sql, **kw: re.search('dml-ignore', sql), + 'err_msg': '', } ) def analyse_sql_statements(sql_statements): errors = [] + ignored = False for statement in sql_statements: for test in migration_tests: if test['fn'](statement, errors=errors): - logger.info('Testing {0} -- ERROR'.format(statement)) - table_search = re.search( - 'TABLE `([^`]*)`', statement, re.IGNORECASE) - col_search = re.search( - 'COLUMN `([^`]*)`', statement, re.IGNORECASE) - err = { - 'err_msg': test['err_msg'], - 'code': test['code'], - 'table': table_search.group(1) if table_search else None, - 'column': col_search.group(1) if col_search else None - } - errors.append(err) + if test['code'] == 'IGNORED_MIGRATION': + logger.info( + 'Testing {0} -- IGNORING MIGRATION'.format(statement) + ) + ignored = True + else: + logger.info('Testing {0} -- ERROR'.format(statement)) + table_search = re.search( + 'TABLE `([^`]*)`', statement, re.IGNORECASE) + col_search = re.search( + 'COLUMN `([^`]*)`', statement, re.IGNORECASE) + err = { + 'err_msg': + test['err_msg'], + 'code': + test['code'], + 'table': + table_search.group(1) if table_search else None, + 'column': + col_search.group(1) if col_search else None + } + errors.append(err) else: logger.info('Testing {0} -- PASSED'.format(statement)) return { 'errors': errors, + 'ignored': ignored } diff --git a/setup.py b/setup.py index 79ca34d..2145545 100644 --- a/setup.py +++ b/setup.py @@ -23,6 +23,7 @@ with open(path.join(PROJECT_DIR, 'README.rst')) as f: install_requirements = [ 'django>=1.11', + 'sqlparse>=0.2.4' ] test_requirements = [ diff --git a/tests/fixtures.py b/tests/fixtures.py index 5d97a82..7f8622a 100644 --- a/tests/fixtures.py +++ b/tests/fixtures.py @@ -40,6 +40,8 @@ CORRECT_PROJECT = os.path.join( _FIXTURES_FOLDER, 'test_correct_project/') DELETED_MIGRATION_PROJECT = os.path.join( _FIXTURES_FOLDER, 'test_deleted_migration_project/') +IGNORE_MIGRATION_PROJECT = os.path.join( + _FIXTURES_FOLDER, 'test_project_ignore_migration/') NOT_DJANGO_GIT_PROJECT = os.path.join( _FIXTURES_FOLDER, 'test_git_project/') diff --git a/tests/functional/test_migration_linter.py b/tests/functional/test_migration_linter.py index 6187613..2c9acc5 100644 --- a/tests/functional/test_migration_linter.py +++ b/tests/functional/test_migration_linter.py @@ -56,6 +56,10 @@ class BackwardcompatibilityDetectionTest(unittest.TestCase): test_project_path = fixtures.RENAME_TABLE_PROJECT self._test_linter_finds_errors(test_project_path) + def test_ignore_migration(self): + test_project_path = fixtures.IGNORE_MIGRATION_PROJECT + self._test_linter_finds_no_errors(test_project_path) + def test_accept_not_null_column_followed_by_adding_default(self): test_project_path = \ fixtures.ADD_NOT_NULL_COLUMN_FOLLOWED_BY_DEFAULT_PROJECT diff --git a/tests/test_project_fixtures/test_project_ignore_migration/.gitignore b/tests/test_project_fixtures/test_project_ignore_migration/.gitignore new file mode 100644 index 0000000..63973d0 --- /dev/null +++ b/tests/test_project_fixtures/test_project_ignore_migration/.gitignore @@ -0,0 +1,3 @@ +*.pyc +__pycache__/ +*sqlite3 diff --git a/tests/test_project_fixtures/test_project_ignore_migration/manage.py b/tests/test_project_fixtures/test_project_ignore_migration/manage.py new file mode 100644 index 0000000..eba4c1f --- /dev/null +++ b/tests/test_project_fixtures/test_project_ignore_migration/manage.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +import os +import sys + +if __name__ == "__main__": + os.environ.setdefault("DJANGO_SETTINGS_MODULE", "test_project_ignore_migration.settings") + try: + from django.core.management import execute_from_command_line + except ImportError: + # The above import may fail for some other reason. Ensure that the + # issue is really that Django is missing to avoid masking other + # exceptions on Python 2. + try: + import django + except ImportError: + raise ImportError( + "Couldn't import Django. Are you sure it's installed and " + "available on your PYTHONPATH environment variable? Did you " + "forget to activate a virtual environment?" + ) + raise + execute_from_command_line(sys.argv) diff --git a/tests/test_project_fixtures/test_project_ignore_migration/test_app/__init__.py b/tests/test_project_fixtures/test_project_ignore_migration/test_app/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/test_project_fixtures/test_project_ignore_migration/test_app/admin.py b/tests/test_project_fixtures/test_project_ignore_migration/test_app/admin.py new file mode 100644 index 0000000..8c38f3f --- /dev/null +++ b/tests/test_project_fixtures/test_project_ignore_migration/test_app/admin.py @@ -0,0 +1,3 @@ +from django.contrib import admin + +# Register your models here. diff --git a/tests/test_project_fixtures/test_project_ignore_migration/test_app/apps.py b/tests/test_project_fixtures/test_project_ignore_migration/test_app/apps.py new file mode 100644 index 0000000..fc04070 --- /dev/null +++ b/tests/test_project_fixtures/test_project_ignore_migration/test_app/apps.py @@ -0,0 +1,5 @@ +from django.apps import AppConfig + + +class TestAppConfig(AppConfig): + name = 'test_app' diff --git a/tests/test_project_fixtures/test_project_ignore_migration/test_app/migrations/0001_create_table.py b/tests/test_project_fixtures/test_project_ignore_migration/test_app/migrations/0001_create_table.py new file mode 100644 index 0000000..d847af6 --- /dev/null +++ b/tests/test_project_fixtures/test_project_ignore_migration/test_app/migrations/0001_create_table.py @@ -0,0 +1,23 @@ +# -*- coding: utf-8 -*- +# Generated by Django 1.11.6 on 2017-10-25 14:15 +from __future__ import unicode_literals + +from django.db import migrations, models + + +class Migration(migrations.Migration): + + initial = True + + dependencies = [ + ] + + operations = [ + migrations.CreateModel( + name='A', + fields=[ + ('id', models.AutoField(auto_created=True, primary_key=True, serialize=False, verbose_name='ID')), + ('null_field', models.IntegerField(null=True)), + ], + ), + ] diff --git a/tests/test_project_fixtures/test_project_ignore_migration/test_app/migrations/0002_rename_table.py b/tests/test_project_fixtures/test_project_ignore_migration/test_app/migrations/0002_rename_table.py new file mode 100644 index 0000000..54fc7d9 --- /dev/null +++ b/tests/test_project_fixtures/test_project_ignore_migration/test_app/migrations/0002_rename_table.py @@ -0,0 +1,22 @@ +# -*- coding: utf-8 -*- +# Generated by Django 1.11.6 on 2017-10-25 14:15 +from __future__ import unicode_literals + +from django.db import migrations + +from django_migration_linter import IGNORE_MIGRATION + + +class Migration(migrations.Migration): + + dependencies = [ + ('test_app', '0001_create_table'), + ] + + operations = [ + migrations.RunSQL(IGNORE_MIGRATION), + migrations.RenameModel( + old_name='A', + new_name='B', + ), + ] diff --git a/tests/test_project_fixtures/test_project_ignore_migration/test_app/migrations/__init__.py b/tests/test_project_fixtures/test_project_ignore_migration/test_app/migrations/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/test_project_fixtures/test_project_ignore_migration/test_app/models.py b/tests/test_project_fixtures/test_project_ignore_migration/test_app/models.py new file mode 100644 index 0000000..2633c55 --- /dev/null +++ b/tests/test_project_fixtures/test_project_ignore_migration/test_app/models.py @@ -0,0 +1,4 @@ +from django.db import models + +class B(models.Model): + null_field = models.IntegerField(null=True) diff --git a/tests/test_project_fixtures/test_project_ignore_migration/test_app/tests.py b/tests/test_project_fixtures/test_project_ignore_migration/test_app/tests.py new file mode 100644 index 0000000..7ce503c --- /dev/null +++ b/tests/test_project_fixtures/test_project_ignore_migration/test_app/tests.py @@ -0,0 +1,3 @@ +from django.test import TestCase + +# Create your tests here. diff --git a/tests/test_project_fixtures/test_project_ignore_migration/test_app/views.py b/tests/test_project_fixtures/test_project_ignore_migration/test_app/views.py new file mode 100644 index 0000000..91ea44a --- /dev/null +++ b/tests/test_project_fixtures/test_project_ignore_migration/test_app/views.py @@ -0,0 +1,3 @@ +from django.shortcuts import render + +# Create your views here. diff --git a/tests/test_project_fixtures/test_project_ignore_migration/test_project_ignore_migration/__init__.py b/tests/test_project_fixtures/test_project_ignore_migration/test_project_ignore_migration/__init__.py new file mode 100644 index 0000000..e69de29 diff --git a/tests/test_project_fixtures/test_project_ignore_migration/test_project_ignore_migration/settings.py b/tests/test_project_fixtures/test_project_ignore_migration/test_project_ignore_migration/settings.py new file mode 100644 index 0000000..39bfb6c --- /dev/null +++ b/tests/test_project_fixtures/test_project_ignore_migration/test_project_ignore_migration/settings.py @@ -0,0 +1,121 @@ +""" +Django settings for test_project_ignore_migration project. + +Generated by 'django-admin startproject' using Django 1.11.6. + +For more information on this file, see +https://docs.djangoproject.com/en/1.11/topics/settings/ + +For the full list of settings and their values, see +https://docs.djangoproject.com/en/1.11/ref/settings/ +""" + +import os + +# Build paths inside the project like this: os.path.join(BASE_DIR, ...) +BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__))) + + +# Quick-start development settings - unsuitable for production +# See https://docs.djangoproject.com/en/1.11/howto/deployment/checklist/ + +# SECURITY WARNING: keep the secret key used in production secret! +SECRET_KEY = 'gtb+mohs%gf0+#fr89vw7e&#edmv=q8!iv+n&j_soawk$tkj3^' + +# SECURITY WARNING: don't run with debug turned on in production! +DEBUG = True + +ALLOWED_HOSTS = [] + + +# Application definition + +INSTALLED_APPS = [ + 'django.contrib.admin', + 'django.contrib.auth', + 'django.contrib.contenttypes', + 'django.contrib.sessions', + 'django.contrib.messages', + 'django.contrib.staticfiles', + 'test_app' +] + +MIDDLEWARE = [ + 'django.middleware.security.SecurityMiddleware', + 'django.contrib.sessions.middleware.SessionMiddleware', + 'django.middleware.common.CommonMiddleware', + 'django.middleware.csrf.CsrfViewMiddleware', + 'django.contrib.auth.middleware.AuthenticationMiddleware', + 'django.contrib.messages.middleware.MessageMiddleware', + 'django.middleware.clickjacking.XFrameOptionsMiddleware', +] + +ROOT_URLCONF = 'test_project_ignore_migration.urls' + +TEMPLATES = [ + { + 'BACKEND': 'django.template.backends.django.DjangoTemplates', + 'DIRS': [], + 'APP_DIRS': True, + 'OPTIONS': { + 'context_processors': [ + 'django.template.context_processors.debug', + 'django.template.context_processors.request', + 'django.contrib.auth.context_processors.auth', + 'django.contrib.messages.context_processors.messages', + ], + }, + }, +] + +WSGI_APPLICATION = 'test_project_ignore_migration.wsgi.application' + + +# Database +# https://docs.djangoproject.com/en/1.11/ref/settings/#databases + +DATABASES = { + 'default': { + 'ENGINE': 'django.db.backends.sqlite3', + 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'), + } +} + + +# Password validation +# https://docs.djangoproject.com/en/1.11/ref/settings/#auth-password-validators + +AUTH_PASSWORD_VALIDATORS = [ + { + 'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator', + }, + { + 'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator', + }, +] + + +# Internationalization +# https://docs.djangoproject.com/en/1.11/topics/i18n/ + +LANGUAGE_CODE = 'en-us' + +TIME_ZONE = 'UTC' + +USE_I18N = True + +USE_L10N = True + +USE_TZ = True + + +# Static files (CSS, JavaScript, Images) +# https://docs.djangoproject.com/en/1.11/howto/static-files/ + +STATIC_URL = '/static/' diff --git a/tests/test_project_fixtures/test_project_ignore_migration/test_project_ignore_migration/urls.py b/tests/test_project_fixtures/test_project_ignore_migration/test_project_ignore_migration/urls.py new file mode 100644 index 0000000..735de5d --- /dev/null +++ b/tests/test_project_fixtures/test_project_ignore_migration/test_project_ignore_migration/urls.py @@ -0,0 +1,21 @@ +"""linter_test_project URL Configuration + +The `urlpatterns` list routes URLs to views. For more information please see: + https://docs.djangoproject.com/en/1.11/topics/http/urls/ +Examples: +Function views + 1. Add an import: from my_app import views + 2. Add a URL to urlpatterns: url(r'^$', views.home, name='home') +Class-based views + 1. Add an import: from other_app.views import Home + 2. Add a URL to urlpatterns: url(r'^$', Home.as_view(), name='home') +Including another URLconf + 1. Import the include() function: from django.conf.urls import url, include + 2. Add a URL to urlpatterns: url(r'^blog/', include('blog.urls')) +""" +from django.conf.urls import url +from django.contrib import admin + +urlpatterns = [ + url(r'^admin/', admin.site.urls), +] diff --git a/tests/test_project_fixtures/test_project_ignore_migration/test_project_ignore_migration/wsgi.py b/tests/test_project_fixtures/test_project_ignore_migration/test_project_ignore_migration/wsgi.py new file mode 100644 index 0000000..f3abf75 --- /dev/null +++ b/tests/test_project_fixtures/test_project_ignore_migration/test_project_ignore_migration/wsgi.py @@ -0,0 +1,16 @@ +""" +WSGI config for linter_test_project project. + +It exposes the WSGI callable as a module-level variable named ``application``. + +For more information on this file, see +https://docs.djangoproject.com/en/1.11/howto/deployment/wsgi/ +""" + +import os + +from django.core.wsgi import get_wsgi_application + +os.environ.setdefault("DJANGO_SETTINGS_MODULE", "test_project_ignore_migration.settings") + +application = get_wsgi_application() diff --git a/tox.ini b/tox.ini index 7ffc655..66749df 100644 --- a/tox.ini +++ b/tox.ini @@ -11,6 +11,7 @@ pip_pre = true deps = django111: django>=1.11,<2.0 django20: django>=2.0 + sqlparse [testenv:lint] basepython = python3.6 From ff8e1b43634506b96784cf1439332e1090ec60bd Mon Sep 17 00:00:00 2001 From: Felix Date: Mon, 17 Dec 2018 16:51:31 +0100 Subject: [PATCH 4/7] Remove sqlparse --- django_migration_linter/migration_linter.py | 2 +- setup.py | 1 - tox.ini | 1 - 3 files changed, 1 insertion(+), 3 deletions(-) diff --git a/django_migration_linter/migration_linter.py b/django_migration_linter/migration_linter.py index 79f25e6..139cbe6 100644 --- a/django_migration_linter/migration_linter.py +++ b/django_migration_linter/migration_linter.py @@ -27,7 +27,7 @@ logger = logging.getLogger(__name__) # Can be used to mark ignored migrations. # This is a noop for SQL. Comments would be better. # But comments are stripped by RunSQL -IGNORE_MIGRATION = "SELECT 'dml-ignore'" +IGNORE_MIGRATION = ("SELECT 'dml-ignore'", ) class MigrationLinter(object): diff --git a/setup.py b/setup.py index 2145545..79ca34d 100644 --- a/setup.py +++ b/setup.py @@ -23,7 +23,6 @@ with open(path.join(PROJECT_DIR, 'README.rst')) as f: install_requirements = [ 'django>=1.11', - 'sqlparse>=0.2.4' ] test_requirements = [ diff --git a/tox.ini b/tox.ini index 66749df..7ffc655 100644 --- a/tox.ini +++ b/tox.ini @@ -11,7 +11,6 @@ pip_pre = true deps = django111: django>=1.11,<2.0 django20: django>=2.0 - sqlparse [testenv:lint] basepython = python3.6 From 6fe51d2e0802139c03e76ccd392c592654fe321f Mon Sep 17 00:00:00 2001 From: Felix Date: Mon, 17 Dec 2018 17:04:58 +0100 Subject: [PATCH 5/7] Remove duplication --- django_migration_linter/__init__.py | 1 + django_migration_linter/constants.py | 4 ++++ django_migration_linter/migration_linter.py | 5 ----- django_migration_linter/sql_analyser.py | 4 +++- 4 files changed, 8 insertions(+), 6 deletions(-) create mode 100644 django_migration_linter/constants.py diff --git a/django_migration_linter/__init__.py b/django_migration_linter/__init__.py index 959bac8..dd30599 100644 --- a/django_migration_linter/__init__.py +++ b/django_migration_linter/__init__.py @@ -13,3 +13,4 @@ # limitations under the License. from .migration_linter import * # noqa +from .constants import * # noqa diff --git a/django_migration_linter/constants.py b/django_migration_linter/constants.py new file mode 100644 index 0000000..b8356c6 --- /dev/null +++ b/django_migration_linter/constants.py @@ -0,0 +1,4 @@ +# Can be used to mark ignored migrations. +# This is a noop for SQL. Comments would be better. +# But comments are stripped by RunSQL +IGNORE_MIGRATION = ("SELECT 'dml-ignore'", ) diff --git a/django_migration_linter/migration_linter.py b/django_migration_linter/migration_linter.py index 139cbe6..e049ed5 100644 --- a/django_migration_linter/migration_linter.py +++ b/django_migration_linter/migration_linter.py @@ -24,11 +24,6 @@ from .sql_analyser import analyse_sql_statements logger = logging.getLogger(__name__) -# Can be used to mark ignored migrations. -# This is a noop for SQL. Comments would be better. -# But comments are stripped by RunSQL -IGNORE_MIGRATION = ("SELECT 'dml-ignore'", ) - class MigrationLinter(object): MIGRATION_FOLDER_NAME = 'migrations' diff --git a/django_migration_linter/sql_analyser.py b/django_migration_linter/sql_analyser.py index d07f544..edb655b 100644 --- a/django_migration_linter/sql_analyser.py +++ b/django_migration_linter/sql_analyser.py @@ -15,6 +15,8 @@ import re import logging +from django_migration_linter.constants import IGNORE_MIGRATION + logger = logging.getLogger(__name__) @@ -65,7 +67,7 @@ migration_tests = ( 'err_msg': '' }, { 'code': 'IGNORED_MIGRATION', - 'fn': lambda sql, **kw: re.search('dml-ignore', sql), + 'fn': lambda sql, **kw: re.search(IGNORE_MIGRATION[0], sql), 'err_msg': '', } ) From fe6433a065fb98656817c3493a8590ec02d86a56 Mon Sep 17 00:00:00 2001 From: David-Wobrock Date: Sun, 23 Dec 2018 17:04:43 +0100 Subject: [PATCH 6/7] Use a custom migration operation instead of a RunSQL statement --- django_migration_linter/__init__.py | 2 +- django_migration_linter/constants.py | 4 -- django_migration_linter/operations.py | 38 +++++++++++++++++++ django_migration_linter/sql_analyser.py | 10 +++-- .../test_app/migrations/0002_rename_table.py | 5 +-- 5 files changed, 47 insertions(+), 12 deletions(-) delete mode 100644 django_migration_linter/constants.py create mode 100644 django_migration_linter/operations.py diff --git a/django_migration_linter/__init__.py b/django_migration_linter/__init__.py index dd30599..a548f66 100644 --- a/django_migration_linter/__init__.py +++ b/django_migration_linter/__init__.py @@ -13,4 +13,4 @@ # limitations under the License. from .migration_linter import * # noqa -from .constants import * # noqa +from .operations import * # noqa diff --git a/django_migration_linter/constants.py b/django_migration_linter/constants.py deleted file mode 100644 index b8356c6..0000000 --- a/django_migration_linter/constants.py +++ /dev/null @@ -1,4 +0,0 @@ -# Can be used to mark ignored migrations. -# This is a noop for SQL. Comments would be better. -# But comments are stripped by RunSQL -IGNORE_MIGRATION = ("SELECT 'dml-ignore'", ) diff --git a/django_migration_linter/operations.py b/django_migration_linter/operations.py new file mode 100644 index 0000000..cf98135 --- /dev/null +++ b/django_migration_linter/operations.py @@ -0,0 +1,38 @@ +# Copyright 2018 3YOURMIND GmbH + +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at + +# http://www.apache.org/licenses/LICENSE-2.0 + +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +from django.db.migrations.operations.base import Operation + +IGNORE_MIGRATION_SQL = "-- dml ignores this migration" + + +class IgnoreMigration(Operation): + + reversible = True + # Must be true to be generated through the sqlmigrate command + reduces_to_sql = True + + def state_forwards(self, app_label, state): + pass + + def database_forwards( + self, app_label, schema_editor, from_state, to_state): + schema_editor.execute(IGNORE_MIGRATION_SQL) + + def database_backwards( + self, app_label, schema_editor, from_state, to_state): + schema_editor.execute(IGNORE_MIGRATION_SQL + "(reversed)") + + def describe(self): + return "The Django migration linter will ignore this migration" diff --git a/django_migration_linter/sql_analyser.py b/django_migration_linter/sql_analyser.py index edb655b..fa0a0d9 100644 --- a/django_migration_linter/sql_analyser.py +++ b/django_migration_linter/sql_analyser.py @@ -15,7 +15,9 @@ import re import logging -from django_migration_linter.constants import IGNORE_MIGRATION +from django_migration_linter.operations import IGNORE_MIGRATION_SQL + +IGNORED_MIGRATION = "IGNORED_MIGRATION" logger = logging.getLogger(__name__) @@ -66,8 +68,8 @@ migration_tests = ( 'fn': has_default, 'err_msg': '' }, { - 'code': 'IGNORED_MIGRATION', - 'fn': lambda sql, **kw: re.search(IGNORE_MIGRATION[0], sql), + 'code': IGNORED_MIGRATION, + 'fn': lambda sql, **kw: re.search(IGNORE_MIGRATION_SQL, sql), 'err_msg': '', } ) @@ -79,7 +81,7 @@ def analyse_sql_statements(sql_statements): for statement in sql_statements: for test in migration_tests: if test['fn'](statement, errors=errors): - if test['code'] == 'IGNORED_MIGRATION': + if test['code'] == IGNORED_MIGRATION: logger.info( 'Testing {0} -- IGNORING MIGRATION'.format(statement) ) diff --git a/tests/test_project_fixtures/test_project_ignore_migration/test_app/migrations/0002_rename_table.py b/tests/test_project_fixtures/test_project_ignore_migration/test_app/migrations/0002_rename_table.py index 54fc7d9..d521e87 100644 --- a/tests/test_project_fixtures/test_project_ignore_migration/test_app/migrations/0002_rename_table.py +++ b/tests/test_project_fixtures/test_project_ignore_migration/test_app/migrations/0002_rename_table.py @@ -4,8 +4,7 @@ from __future__ import unicode_literals from django.db import migrations -from django_migration_linter import IGNORE_MIGRATION - +import django_migration_linter as linter class Migration(migrations.Migration): @@ -14,7 +13,7 @@ class Migration(migrations.Migration): ] operations = [ - migrations.RunSQL(IGNORE_MIGRATION), + linter.IgnoreMigration(), migrations.RenameModel( old_name='A', new_name='B', From 95274b9a67fbbd026afa97d61797645f3960ebbf Mon Sep 17 00:00:00 2001 From: David-Wobrock Date: Sun, 23 Dec 2018 17:12:36 +0100 Subject: [PATCH 7/7] Update Readme for new linter ignore migration operation Use master for PRs. No need for a dev branch --- README.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/README.rst b/README.rst index 0c4710c..d1c5161 100644 --- a/README.rst +++ b/README.rst @@ -52,20 +52,20 @@ Examples 3YOURMIND is running the linter on `Bitbucket Pipelines`_ on every build getting pushed. Checkout the ``examples/`` folder to see how you could integrate the linter in your test suite. -Ignoring Migrations +Ignoring migrations ------------------- You can also ignore migrations by adding this to your migrations: .. code-block:: - from django_migration_linter import IGNORE_MIGRATION + import django_migration_linter as linter # ... - operations = [ - migrations.RunSQL(IGNORE_MIGRATION), - # ... - ] + operations = [ + linter.IgnoreMigration(), + # ... + ] # ... @@ -78,7 +78,7 @@ Contributing ------------ First, thank you very much if you want to contribute to the project. -Please base your work on the ``dev`` branch and also target this branch in your pull request. +Please base your work on the ``master`` branch and also target this branch in your pull request. License -------