Fix errors detected by sqlfluff (#6170)

* Fix errors detected by sqlfluff

Fixes #2784

* ml

* fix

Author: nvuillam

.automation/test/sql/sql_fix_1.sql

@@ -0,0 +1,3 @@
+SELECT   name,email,   age FROM users
+WHERE   age>18 AND    status='active'
+order by name   asc;

.automation/test/sql/sql_fix_2.sql

@@ -0,0 +1,4 @@
+insert    into products (name,price,category_id) 
+VALUES('laptop',999.99,1),
+  ('mouse',  29.99, 2),
+     ('keyboard',79.99,2   );

CHANGELOG.md

@@ -37,6 +37,7 @@ Note: Can be used with `oxsecurity/megalinter@beta` in your GitHub Action mega-l
   - PHP-CS-Fixer is able to run on PHP 8.4 without error (change default configuration) by @llaville
   - [cspell](https://megalinter.io/latest/descriptors/spell_cspell/): Filter output lines that do not contain found issues
   - [hadolint](https://megalinter.io/latest/descriptors/docker_hadolint/): Extend DOCKERFILE_HADOLINT_FILE_NAMES_REGEX to include the `purpose.Dockerfile` convention eg service.Dockerfile.
+  - [sqlfluff](https://megalinter.io/beta/descriptors/sql_sqlfluff/): Handle fixing of issues
 
 - Fixes
   - When linter is docker based, force `--platform=linux/amd64` so it works when running locally on Mac

megalinter/descriptors/sql.megalinter-descriptor.yml

@@ -8,6 +8,7 @@ file_extensions:
 linters:
   # SQLFLUFF
   - linter_name: sqlfluff
+    class: SqlFluffLinter
     linter_text: |
       **SQLFluff** is a dialect-flexible and configurable SQL linter designed for ELT applications that works with Jinja templating and dbt. It provides comprehensive SQL code analysis including syntax checking, style validation, and formatting with support for multiple SQL dialects.
 
@@ -32,6 +33,9 @@ linters:
     active_only_if_file_found:
       - .sqlfluff
     cli_lint_mode: list_of_files
+    cli_lint_fix_arg_name: fix
+    cli_lint_fix_remove_args:
+      - lint
     cli_lint_errors_count: regex_count
     cli_lint_errors_regex: "L:(.*)P:(.*)"
     cli_lint_extra_args:

megalinter/linters/SqlFluffLinter.py

@@ -0,0 +1,29 @@
+#!/usr/bin/env python3
+"""
+Use SqlFluff to lint any type of file according to local config
+"""
+
+import logging
+
+from megalinter import Linter
+
+
+class SqlFluffLinter(Linter):
+
+    # Manage case when we want semgrep rulesets to be selected related to security
+    def build_lint_command(self, file=None):
+        cmd = super().build_lint_command(file)
+        # if fix arg is in the arguments, add --show-lint-violations just after
+        if (
+            self.apply_fixes is True
+            and self.cli_lint_fix_arg_name is not None
+            and self.cli_lint_fix_arg_name in cmd
+        ):
+            fix_index = cmd.index(self.cli_lint_fix_arg_name)
+            cmd = (
+                cmd[: fix_index + 1]
+                + ["--show-lint-violations"]
+                + cmd[fix_index + 1 :]  # noqa: E203
+            )
+            logging.debug("[SqlFluffLinter] Added --show-lint-violations argument")
+        return cmd