Mark migrations as ignored

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
 -----
 

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

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
     }

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 = [

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/')

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

tests/test_project_fixtures/test_project_ignore_migration/.gitignore

@@ -0,0 +1,3 @@
+*.pyc
+__pycache__/
+*sqlite3

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)

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.

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'

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)),
+            ],
+        ),
+    ]

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',
+        ),
+    ]

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)

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.

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.

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/'

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),
+]

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()

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