feat: make linter return violations

[ci skip]

Author: benfdking

examples/multi/repo_1/linter/user.py

@@ -12,4 +12,4 @@ class NoMissingDescription(Rule):
     """All models should be documented."""
 
     def check_model(self, model: Model) -> t.Optional[RuleViolation]:
-        return self.violation() if not model.description else None
+        return self.violation(model) if not model.description else None

examples/sushi/linter/user.py

@@ -10,4 +10,4 @@ class NoMissingOwner(Rule):
     """All models should have an owner specified."""
 
     def check_model(self, model: Model) -> t.Optional[RuleViolation]:
-        return self.violation() if not model.owner else None
+        return self.violation(model) if not model.owner else None

sqlmesh/core/context.py

@@ -75,6 +75,7 @@
 )
 from sqlmesh.core.engine_adapter import EngineAdapter
 from sqlmesh.core.environment import Environment, EnvironmentNamingInfo, EnvironmentStatements
+from sqlmesh.core.linter.rule import RuleViolation
 from sqlmesh.core.loader import Loader
 from sqlmesh.core.linter.definition import Linter
 from sqlmesh.core.linter.rules import BUILTIN_RULES
@@ -2460,7 +2461,12 @@ def _get_models_for_interval_end(
     def lint_models(
         self,
         models: t.Optional[t.Iterable[t.Union[str, Model]]] = None,
-    ) -> None:
+        raise_error_on_error: bool = True,
+    ) -> t.List[RuleViolation]:
+        """
+        Lint models and raise an error if any errors are found, optionally the error can be ignored and the violations can be returned.
+        """
+        violations = []
         found_error = False
 
         model_list = (
@@ -2471,7 +2477,7 @@ def lint_models(
             if linter := self._linters.get(model.project):
                 found_error = linter.lint_model(model, console=self.console) or found_error
 
-        if found_error:
+        if raise_error_on_error and found_error:
             raise LinterError(
                 "Linter detected errors in the code. Please fix them before proceeding."
             )

sqlmesh/core/linter/definition.py

@@ -8,7 +8,7 @@
 
 from sqlmesh.utils.errors import raise_config_error
 from sqlmesh.core.console import LinterConsole, get_console, Console
-from sqlmesh.core.linter.rule import RuleSet
+from sqlmesh.core.linter.rule import RuleSet, RuleViolation
 
 
 def select_rules(all_rules: RuleSet, rule_names: t.Set[str]) -> RuleSet:
@@ -50,7 +50,12 @@ def from_rules(cls, all_rules: RuleSet, config: LinterConfig) -> Linter:
 
         return Linter(config.enabled, all_rules, rules, warn_rules)
 
-    def lint_model(self, model: Model, console: LinterConsole = get_console()) -> bool:
+    def lint_model(self, model: Model, console: LinterConsole = get_console()) -> t.Tuple[
+        bool, t.List[RuleViolation]
+    ]:
+        """
+        Lint a model and return a boolean indicating whether the model has any error violations. It also returns a list of violations.
+        """
         if not self.enabled:
             return False
 

sqlmesh/core/linter/rule.py

@@ -33,18 +33,20 @@ def summary(self) -> str:
         """A summary of what this rule checks for."""
         return self.__doc__ or ""
 
-    def violation(self, violation_msg: t.Optional[str] = None) -> RuleViolation:
+    def violation(self, model: Model, violation_type: t.Literal["error", "warning"], violation_msg: t.Optional[str] = None, ) -> RuleViolation:
         """Create a RuleViolation instance for this rule"""
-        return RuleViolation(rule=self, violation_msg=violation_msg or self.summary)
+        return RuleViolation(rule=self, violation_msg=violation_msg or self.summary, model=model, violation_type=violation_type)
 
     def __repr__(self) -> str:
         return self.name
 
 
 class RuleViolation:
-    def __init__(self, rule: Rule, violation_msg: str) -> None:
+    def __init__(self, rule: Rule, violation_msg: str, model: Model, violation_type: t.Literal["error", "warning"]) -> None:
         self.rule = rule
+        self.violation_type: t.Literal["error", "warning"] = violation_type
         self.violation_msg = violation_msg
+        self.model = model
 
     def __repr__(self) -> str:
         return f"{self.rule.name}: {self.violation_msg}"

sqlmesh/core/linter/rules/builtin.py

@@ -17,7 +17,7 @@ def check_model(self, model: Model) -> t.Optional[RuleViolation]:
         if not isinstance(model, SqlModel):
             return None
 
-        return self.violation() if model.query.is_star else None
+        return self.violation(model) if model.query.is_star else None
 
 
 class InvalidSelectStarExpansion(Rule):
@@ -32,7 +32,7 @@ def check_model(self, model: Model) -> t.Optional[RuleViolation]:
             f"'{model.fqn}' can be rendered at parse time."
         )
 
-        return self.violation(violation_msg)
+        return self.violation(model, violation_msg)
 
 
 class AmbiguousOrInvalidColumn(Rule):
@@ -45,14 +45,14 @@ def check_model(self, model: Model) -> t.Optional[RuleViolation]:
             f"{sqlglot_err} for model '{model.fqn}', the column may not exist or is ambiguous."
         )
 
-        return self.violation(violation_msg)
+        return self.violation(model, violation_msg)
 
 
 class NoMissingAudits(Rule):
     """Model `audits` must be configured to test data quality."""
 
     def check_model(self, model: Model) -> t.Optional[RuleViolation]:
-        return self.violation() if not model.audits and not model.kind.is_symbolic else None
+        return self.violation(model) if not model.audits and not model.kind.is_symbolic else None
 
 
 BUILTIN_RULES = RuleSet(subclasses(__name__, Rule, (Rule,)))