Merge pull request #6 from PandaDoc/squawk-pg-version

Add pg_version argument for squawk

Author: wblxyxolbkhv

migration_lint/analyzer/squawk.py

@@ -19,6 +19,7 @@ class SquawkLinter(BaseLinter):
     ignored_rules = [
         "ban-drop-column",  # Backward-incompatible, checked by compatibility analyzer.
         "ban-drop-table",  # Backward-incompatible, checked by compatibility analyzer.
+        "adding-not-nullable-field",  # Backward-incompatible, checked by compatibility analyzer.
         "prefer-big-int",  # Deprecated.
         "prefer-identity",
         "prefer-timestamptz",
@@ -27,9 +28,12 @@ class SquawkLinter(BaseLinter):
         "transaction-nesting",  # TODO: Add transactions tracking.
     ]
 
-    def __init__(self, config_path: Optional[str] = None) -> None:
+    def __init__(
+        self, config_path: Optional[str] = None, pg_version: Optional[str] = None
+    ) -> None:
         bin_dir = os.path.join(migration_lint.__path__[0], "bin")
         self.config_path = config_path
+        self.pg_version = pg_version
         if sys.platform == "linux":
             self.squawk = os.path.join(bin_dir, "squawk-linux-x86")
         elif sys.platform == "darwin":
@@ -41,8 +45,9 @@ def squawk_command(self, migration_sql: str) -> str:
         """Get squawk command."""
         exclude = f"--exclude={','.join(self.ignored_rules)}"
         config = f"--config={self.config_path}" if self.config_path else ""
+        pg_version = f"--pg-version={self.pg_version}" if self.pg_version else ""
 
-        return " ".join([self.squawk, exclude, config]).strip()
+        return " ".join([self.squawk, exclude, config, pg_version]).strip()
 
     def lint(
         self,

migration_lint/django/management/commands/migration_lint.py

@@ -72,15 +72,28 @@ def add_arguments(self, parser):
             default=os.getenv("MIGRATION_LINTER_SQUAWK_CONFIG_PATH"),
             help="squawk config path",
         )
+        parser.add_argument(
+            "--squawk-pg-version",
+            dest="squawk_pg_version",
+            type=str,
+            default=os.getenv("MIGRATION_LINTER_SQUAWK_PG_VERSION"),
+            help="squawk version of PostgreSQL",
+        )
 
-    def handle(self, loader_type, squawk_config_path, **options):
+    def handle(self, loader_type, squawk_config_path, squawk_pg_version, **options):
         logger.info("Start analysis..")
 
         loader = SourceLoader.get(loader_type)(**options)
         extractor = Extractor.get("django_management")(**options)
         analyzer = Analyzer(
             loader=loader,
             extractor=extractor,
-            linters=[CompatibilityLinter(), SquawkLinter(squawk_config_path)],
+            linters=[
+                CompatibilityLinter(),
+                SquawkLinter(
+                    config_path=squawk_config_path,
+                    pg_version=squawk_pg_version,
+                ),
+            ],
         )
         analyzer.analyze()

migration_lint/main.py

@@ -64,14 +64,24 @@
     help="squawk config path",
     default=os.getenv("MIGRATION_LINTER_SQUAWK_CONFIG_PATH"),
 )
+@click.option(
+    "--squawk-pg-version",
+    "squawk_pg_version",
+    help="squawk version of PostgreSQL",
+    default=os.getenv("MIGRATION_LINTER_SQUAWK_PG_VERSION"),
+)
 @click.option(
     "--alembic-command",
     "alembic_command",
     help="command to get Alembic migrations sql",
     default=os.getenv("MIGRATION_LINTER_ALEMBIC_COMMAND"),
 )
 def main(
-    loader_type: str, extractor_type: str, squawk_config_path: str, **kwargs
+    loader_type: str,
+    extractor_type: str,
+    squawk_config_path: str,
+    squawk_pg_version: str,
+    **kwargs,
 ) -> None:
     logger.info("Start analysis..")
 
@@ -80,7 +90,13 @@ def main(
     analyzer = Analyzer(
         loader=loader,
         extractor=extractor,
-        linters=[CompatibilityLinter(), SquawkLinter(squawk_config_path)],
+        linters=[
+            CompatibilityLinter(),
+            SquawkLinter(
+                config_path=squawk_config_path,
+                pg_version=squawk_pg_version,
+            ),
+        ],
     )
     analyzer.analyze()
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "migration-lint"
-version = "0.2.8"
+version = "0.2.9"
 description = "Tool for lint operations in DB migrations SQL"
 authors = ["Alexey Nikitenko <alexey.nikitenko@pandadoc.com>"]
 readme = "README.md"

tests/test_squawk_linter.py

@@ -1,4 +1,3 @@
-from typing import Union
 from unittest.mock import patch
 
 import pytest
@@ -26,19 +25,27 @@ def test_unsupported_platform():
 
 
 @pytest.mark.parametrize(
-    "config_path, result_flags",
-    [(None, ""), (".squawk.toml", "--config=.squawk.toml")],
-    ids=["Without config", "With config"],
+    "params, result_flags",
+    [
+        ({}, ""),
+        ({"config_path": ".squawk.toml"}, "--config=.squawk.toml"),
+        ({"pg_version": "13.0"}, " --pg-version=13.0"),
+        (
+            {"config_path": ".squawk.toml", "pg_version": "13.0"},
+            "--config=.squawk.toml --pg-version=13.0",
+        ),
+    ],
+    ids=["Without params", "With config", "With pg version", "With all params"],
 )
 @patch("migration_lint.__path__", ["path"])
 @patch("sys.platform", "linux")
-def test_squawk_command(config_path: Union[str, None], result_flags: str):
+def test_squawk_command(params: dict, result_flags: str):
     ignored_rules = ["ignored-rule"]
 
     with patch.object(
         SquawkLinter, "ignored_rules", new_callable=lambda: ignored_rules
     ):
-        linter = SquawkLinter(config_path)
+        linter = SquawkLinter(**params)
 
         result = linter.squawk_command(FAKE_STATEMENT)