Merge branch 'main' into doc/known-issues-design

.github/workflows/checks.yml

@@ -68,7 +68,9 @@ jobs:
         uses: actions/[email protected]
         with:
           name: lint-python${{ matrix.python-version }}
-          path: .lint.txt
+          path: |
+            .lint.txt
+            .lint.json
           include-hidden-files: true
 
   Type-Check:

.github/workflows/report.yml

@@ -31,8 +31,10 @@ jobs:
         working-directory: ./artifacts
         run: |
           poetry run coverage combine --keep coverage-python3.9*/.coverage
+          # Errors during copying are ignored because they are checked in the next step
           cp .coverage ../ || true
           cp lint-python3.9/.lint.txt ../ || true
+          cp lint-python3.9/.lint.json ../ || true
           cp security-python3.9/.security.json ../ || true
 
       - name: Validate Artifacts
@@ -53,6 +55,5 @@ jobs:
           poetry run nox -s project:report -- -- --format markdown >> $GITHUB_STEP_SUMMARY
           echo -e "\n\n# Coverage\n" >> $GITHUB_STEP_SUMMARY
           poetry run coverage report -- --format markdown >> $GITHUB_STEP_SUMMARY
-          echo  -e "\n\n# Static Code Analysis\n" >> $GITHUB_STEP_SUMMARY
-          cat .lint.txt >> $GITHUB_STEP_SUMMARY
+          poetry run tbx lint pretty-print >> $GITHUB_STEP_SUMMARY
           poetry run tbx security pretty-print .security.json >> $GITHUB_STEP_SUMMARY

doc/changes/unreleased.md

@@ -1,5 +1,9 @@
 # Unreleased
 
+## ✨ Added
+
+* added tbx task for markdown formating of .lint.json
+
 ## 🐞 Fixed
 * Fixed an issue in the CI workflow that caused it to be executed twice on the initial push of a PR if the PR branch was on the repo itself.
 

exasol/toolbox/nox/_artifacts.py

@@ -23,6 +23,8 @@ def check_artifacts(session: Session) -> None:
     error = False
     if msg := _validate_lint_txt(Path(PROJECT_CONFIG.root, ".lint.txt")):
         print(f"error in [.lint.txt]: {msg}")
+    if msg := _validate_lint_json(Path(PROJECT_CONFIG.root, ".lint.json")):
+        print(f"error in [.lint.json]: {msg}")
     if msg := _validate_security_json(Path(PROJECT_CONFIG.root, ".security.json")):
         print(f"error in [.security.json]: {msg}")
         error = True

exasol/toolbox/templates/github/workflows/checks.yml

@@ -74,7 +74,9 @@ jobs:
         uses: actions/[email protected]
         with:
           name: lint-python${{ matrix.python-version }}
-          path: .lint.txt
+          path: |
+            .lint.txt
+            .lint.json
           include-hidden-files: true
 
   Type-Check:

exasol/toolbox/templates/github/workflows/report.yml

@@ -31,9 +31,14 @@ jobs:
         working-directory: ./artifacts
         run: |
           poetry run coverage combine --keep coverage-python3.9*/.coverage
-          cp .coverage ../
-          cp lint-python3.9/.lint.txt ../
-          cp security-python3.9/.security.json ../
+          # Errors during copying are ignored because they are checked in the next step
+          cp .coverage ../ || true
+          cp lint-python3.9/.lint.txt ../ || true
+          cp lint-python3.9/.lint.txt ../ || true
+          cp security-python3.9/.security.json ../ || true
+
+      - name: Validate Artifacts
+        run: poetry run nox -s artifacts:validate
 
       - name: Generate Report
         run: poetry run nox -s project:report -- -- --format json | tee metrics.json
@@ -50,6 +55,5 @@ jobs:
           poetry run nox -s project:report -- -- --format markdown >> $GITHUB_STEP_SUMMARY
           echo -e "\n\n# Coverage\n" >> $GITHUB_STEP_SUMMARY
           poetry run coverage report -- --format markdown >> $GITHUB_STEP_SUMMARY
-          echo  -e "\n\n# Static Code Analysis\n" >> $GITHUB_STEP_SUMMARY
-          cat .lint.txt >> $GITHUB_STEP_SUMMARY
+          poetry run tbx security pretty-print >> $GITHUB_STEP_SUMMARY
           poetry run tbx security pretty-print .security.json >> $GITHUB_STEP_SUMMARY

exasol/toolbox/tools/lint.py

@@ -0,0 +1,80 @@
+import json
+from collections.abc import Iterable
+from dataclasses import dataclass
+from inspect import cleandoc
+from pathlib import Path
+
+import typer
+
+CLI = typer.Typer()
+
+
+@dataclass(frozen=True)
+class Finding:
+    type: str
+    module: str
+    obj: str
+    line: int
+    column: int
+    endLine: int
+    endColumn: int
+    path: str
+    symbol: str
+    message: str
+    message_id: str
+
+
+def lint_issue_from_json(data: str) -> Iterable[Finding]:
+    issues = json.loads(data)
+    for issue in issues:
+        yield Finding(
+            type=issue["type"],
+            module=issue["module"],
+            obj=issue["obj"],
+            line=issue["line"],
+            column=issue["column"],
+            endLine=issue["endLine"],
+            endColumn=issue["endColumn"],
+            path=issue["path"],
+            symbol=issue["symbol"],
+            message=issue["message"],
+            message_id=issue["message-id"],
+        )
+
+
+def lint_issue_to_markdown(lint_issues: Iterable[Finding]) -> str:
+    def _header() -> str:
+        header = "# Static Code Analysis\n\n"
+        header += "|File|line/<br>column|id|message|\n"
+        header += "|---|:-:|:-:|---|\n"
+        return header
+
+    def _rows(findings: Iterable[Finding]) -> str:
+        rows = ""
+        for finding in findings:
+            rows += f"|{finding.path}"
+            rows += f"|line: {finding.line}/<br>column: {finding.column}"
+            rows += f"|{finding.message_id}"
+            rows += f"|{finding.message}|\n"
+        return rows
+
+    template = cleandoc(
+        """
+        {header}{rows}
+        """
+    )
+    lint_issues = sorted(lint_issues, key=lambda i: (i.path, i.message_id, i.line))
+    return template.format(header=_header(), rows=_rows(lint_issues))
+
+
+@CLI.command(name="pretty-print")
+def lint_json_to_markdown(
+    path: Path = typer.Argument(default=Path(".lint.json"), help="path to lint.json"),
+) -> None:
+    """converts the lint json to a Markdown table"""
+    issues = lint_issue_from_json(path.read_text())
+    print(lint_issue_to_markdown(issues))
+
+
+if __name__ == "__main__":
+    CLI()

exasol/toolbox/tools/tbx.py

@@ -2,6 +2,7 @@
 
 from exasol.toolbox.tools import (
     issue,
+    lint,
     security,
     workflow,
 )
@@ -10,6 +11,7 @@
 CLI.add_typer(workflow.CLI, name="workflow", help="Manage github workflows")
 CLI.add_typer(security.CLI, name="security", help="Security related helpers")
 CLI.add_typer(issue.CLI, name="issue", help="Manage issue templates")
+CLI.add_typer(lint.CLI, name="lint", help="linting related helpers")
 
 if __name__ == "__main__":
     CLI()