Merge branch 'flathub-infra:master' into master

TukanDev · web-flow · commit ec6755d73929 · 2025-11-19T22:14:55.000Z
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -5,6 +5,7 @@ on:
     branches: master
   pull_request:
     branches: master
+    types: [opened, edited, reopened, synchronize, ready_for_review]
   workflow_dispatch:
   # Keep an active cache
   schedule:
diff --git a/.github/workflows/janitor_exceptions.yml b/.github/workflows/janitor_exceptions.yml
@@ -0,0 +1,52 @@
+name: Janitor stale exceptions
+
+on:
+  workflow_dispatch:
+  schedule:
+    - cron: '0 0 * * 1,5'
+
+jobs:
+  janitor:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    timeout-minutes: 20
+    steps:
+        # 4.2.2
+      - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+        with:
+          persist-credentials: false
+
+      - name: Purge exceptions
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: python utils/validator.py --purge-from-issue 750
+
+      - name: Validate
+        run: python utils/validator.py
+
+      - name: Check for changes
+        id: diff
+        run: |
+          FILE="flatpak_builder_lint/staticfiles/exceptions.json"
+          if git diff --quiet -- "$FILE"; then
+            echo "changed=false" >> $GITHUB_OUTPUT
+          else
+            echo "changed=true" >> $GITHUB_OUTPUT
+          fi
+
+      - name: Create pull request
+        if: ${{ success() && steps.diff.outputs.changed == 'true' }}
+        # 7.0.8
+        uses: peter-evans/create-pull-request@271a8d0340265f705b14b6d32b9829c1cb33d45e
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          branch-suffix: "random"
+          author: "github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>"
+          commit-message: "(Automated) Purge stale exceptions"
+          title: "(Automated) Purge stale exceptions"
+          body: "(Automated) Purge stale exceptions"
+          delete-branch: true
+          sign-commits: true
+          draft: always-true
diff --git a/.github/workflows/label.yml b/.github/workflows/label.yml
@@ -5,7 +5,7 @@ name: Label pull requests
 
 on:
   pull_request_target:
-    types: [opened, edited, reopened, synchronize]
+    types: [opened, edited, reopened, synchronize, ready_for_review]
     branches:
       - master
     paths:
diff --git a/README.md b/README.md
@@ -304,6 +304,7 @@ options:
   --ref                 Override the primary ref detection with this ref
   --gha-format          Use GitHub Actions annotations in CI
   --janitor-exceptions  Enable reporting of stale exceptions to linter repository
+  --debug               Enable debug logging
 
 Please report any issues at https://github.com/flathub-infra/flatpak-builder-lint
 ```
diff --git a/flatpak_builder_lint/checks/appid.py b/flatpak_builder_lint/checks/appid.py
@@ -1,5 +1,6 @@
 import os
 import re
+from collections.abc import Mapping
 from typing import Any
 
 from .. import builddir, config, domainutils
@@ -84,7 +85,7 @@ def _validate(self, appid: str | None, is_extension: bool) -> None:
                         message += f" | {resp}"
                     self.info.add(message)
 
-    def check_manifest(self, manifest: dict[str, Any]) -> None:
+    def check_manifest(self, manifest: Mapping[str, Any]) -> None:
         appid = manifest.get("id")
         is_extension = manifest.get("build-extension", False)
 
diff --git a/flatpak_builder_lint/checks/elfarch.py b/flatpak_builder_lint/checks/elfarch.py
@@ -1,19 +1,23 @@
 import glob
+import logging
 import os
 import struct
 import tempfile
 
 from .. import builddir, ostree
 from . import Check
 
+logger = logging.getLogger(__name__)
+
 
 def is_elf(fname: str) -> bool:
     if not os.path.isfile(fname):
         return False
     try:
         with open(fname, "br") as f:
             return f.read(4) == b"\x7fELF"
-    except OSError:
+    except OSError as e:
+        logger.debug("Failed to read file %s: %s: %s", fname, type(e).__name__, e)
         return False
 
 
@@ -33,8 +37,12 @@ def get_elf_arch(fname: str) -> str | None:
                     0xF3: "riscv64",
                 }
                 return arch_map.get(e_machine)
-        except struct.error:
-            pass
+        except struct.error as e:
+            logger.debug(
+                "Failed to unpack ELF architecture from %s: %s: %s", fname, type(e).__name__, e
+            )
+        except OSError as e:
+            logger.debug("Failed to read ELF file %s: %s: %s", fname, type(e).__name__, e)
     return None
 
 
diff --git a/flatpak_builder_lint/checks/eolruntime.py b/flatpak_builder_lint/checks/eolruntime.py
@@ -1,4 +1,5 @@
 import tempfile
+from collections.abc import Mapping
 from typing import Any
 
 from .. import builddir, domainutils, ostree
@@ -14,7 +15,7 @@ def _validate(self, runtime_ref: str) -> None:
         if decomp_ref in eols_runtimes:
             self.warnings.add(f"runtime-is-eol-{splits[0]}-{splits[2]}")
 
-    def check_manifest(self, manifest: dict[str, Any]) -> None:
+    def check_manifest(self, manifest: Mapping[str, Any]) -> None:
         runtime_id = manifest.get("runtime")
         runtime_br = manifest.get("runtime-version")
 
diff --git a/flatpak_builder_lint/checks/finish_args.py b/flatpak_builder_lint/checks/finish_args.py
@@ -1,6 +1,7 @@
 import re
 import tempfile
 from collections import defaultdict
+from collections.abc import Mapping
 from typing import Any
 
 import gi
@@ -505,7 +506,7 @@ def _validate(self, appid: str | None, finish_args: dict[str, set[str]]) -> None
                 + " full system or session bus"
             )
 
-    def check_manifest(self, manifest: dict[str, Any]) -> None:
+    def check_manifest(self, manifest: Mapping[str, Any]) -> None:
         appid = manifest.get("id")
 
         is_baseapp = bool(
diff --git a/flatpak_builder_lint/checks/flathub_json.py b/flatpak_builder_lint/checks/flathub_json.py
@@ -1,4 +1,5 @@
 import tempfile
+from collections.abc import Mapping
 from typing import Any
 
 from .. import builddir, config, ostree
@@ -54,7 +55,7 @@ def _validate(
         ):
             self.errors.add("flathub-json-excluded-all-arches")
 
-    def check_manifest(self, manifest: dict[str, Any]) -> None:
+    def check_manifest(self, manifest: Mapping[str, Any]) -> None:
         flathub_json = manifest.get("x-flathub")
         appid = manifest.get("id")
         if not (flathub_json and appid):
diff --git a/flatpak_builder_lint/checks/jsonschema.py b/flatpak_builder_lint/checks/jsonschema.py
@@ -1,5 +1,6 @@
 import importlib.resources
 import json
+from collections.abc import Mapping
 from typing import Any
 
 import jsonschema
@@ -10,7 +11,7 @@
 
 
 class JSONSchemaCheck(Check):
-    def check_manifest(self, manifest: dict[str, Any]) -> None:
+    def check_manifest(self, manifest: Mapping[str, Any]) -> None:
         with (
             importlib.resources.files(staticfiles)
             .joinpath("flatpak-manifest.schema.json")
@@ -19,7 +20,7 @@ def check_manifest(self, manifest: dict[str, Any]) -> None:
             schema = json.load(f)
 
         try:
-            jsonschema.validate(manifest, schema)
+            jsonschema.validate(dict(manifest), schema)
         except jsonschema.exceptions.SchemaError:
             self.errors.add("jsonschema-schema-error")
         except jsonschema.exceptions.ValidationError as exc:
diff --git a/flatpak_builder_lint/checks/modules.py b/flatpak_builder_lint/checks/modules.py
@@ -1,4 +1,5 @@
 import re
+from collections.abc import Mapping
 from typing import Any
 
 from .. import config
@@ -9,7 +10,7 @@ def _is_git_commit_hash(s: str) -> bool:
     return re.match(r"[a-f0-9]{4,40}", s) is not None
 
 
-def _get_bundled_extensions_not_prefixed_with_appid(manifest: dict[str, Any]) -> list[str]:
+def _get_bundled_extensions_not_prefixed_with_appid(manifest: Mapping[str, Any]) -> list[str]:
     appid = manifest.get("id", "")
     extensions = manifest.get("add-extensions", {})
     return [
@@ -82,7 +83,7 @@ def check_module(self, module: dict[str, Any]) -> None:
             for nested_module in nested_modules:
                 self.check_module(nested_module)
 
-    def check_manifest(self, manifest: dict[str, Any]) -> None:
+    def check_manifest(self, manifest: Mapping[str, Any]) -> None:
         if manifest:
             for ext in _get_bundled_extensions_not_prefixed_with_appid(manifest):
                 self.errors.add(f"appid-unprefixed-bundled-extension-{ext}")
diff --git a/flatpak_builder_lint/checks/reposize.py b/flatpak_builder_lint/checks/reposize.py
@@ -1,21 +1,31 @@
+import logging
 import os
 
 from .. import config
 from . import Check
 
+logger = logging.getLogger(__name__)
+
 
 class RepoSizeCheck(Check):
     @staticmethod
     def get_dir_size(path: str) -> int:
         size = 0
-        for dirpath, _, filenames in os.walk(path, onerror=lambda _: None):
+        for dirpath, _, filenames in os.walk(
+            path,
+            onerror=lambda e: logger.debug(
+                "os.walk error for %s: %s: %s", path, type(e).__name__, e
+            ),
+        ):
             for f in filenames:
                 fp = os.path.join(dirpath, f)
                 try:
                     if not os.path.islink(fp):
                         size += os.path.getsize(fp)
-                except (FileNotFoundError, PermissionError):
+                except (FileNotFoundError, PermissionError) as e:
+                    logger.debug("Failed to get size of %s: %s: %s", fp, type(e).__name__, e)
                     continue
+        logger.debug("Directory size for %s: %s bytes", path, size)
         return size
 
     def _validate(self, path: str, primary_ref_count: int = 1) -> None:
diff --git a/flatpak_builder_lint/checks/toplevel.py b/flatpak_builder_lint/checks/toplevel.py
@@ -1,11 +1,12 @@
+from collections.abc import Mapping
 from typing import Any
 
 from .. import config
 from . import Check
 
 
 class TopLevelCheck(Check):
-    def check_manifest(self, manifest: dict[str, Any]) -> None:
+    def check_manifest(self, manifest: Mapping[str, Any]) -> None:
         yaml_failed = manifest.get("x-manifest-yaml-failed")
         if yaml_failed:
             self.errors.add("manifest-invalid-yaml")
diff --git a/flatpak_builder_lint/cli.py b/flatpak_builder_lint/cli.py
@@ -2,10 +2,12 @@
 import importlib
 import importlib.resources
 import json
+import logging
 import os
 import pkgutil
 import sys
 import textwrap
+from types import MappingProxyType
 from typing import Any
 
 import sentry_sdk
@@ -30,6 +32,14 @@
     importlib.import_module(f".{plugin_info.name}", package=checks.__name__)
 
 
+def setup_logging(debug: bool = False) -> None:
+    if debug:
+        logging.basicConfig(level=logging.CRITICAL + 1, format="%(levelname)s: %(message)s")
+        logging.getLogger("flatpak_builder_lint").setLevel(logging.DEBUG)
+    else:
+        logging.disable(logging.CRITICAL)
+
+
 def _filter(info: set[str], excepts: set[str]) -> list[str]:
     final = set()
     for i in info:
@@ -100,7 +110,7 @@ def run_checks(
         case "manifest":
             check_method_name = "check_manifest"
             infer_appid_func = manifest.infer_appid
-            check_method_arg: str | dict[str, Any] = manifest.show_manifest(path)
+            check_method_arg: str | MappingProxyType[str, Any] = manifest.show_manifest(path)
         case "builddir":
             check_method_name = "check_build"
             infer_appid_func = builddir.infer_appid
@@ -274,8 +284,18 @@ def main() -> int:
         help="Enable reporting of stale exceptions to linter repository",
         action="store_true",
     )
+    parser.add_argument(
+        "--debug",
+        help="Enable debug logging",
+        action="store_true",
+    )
 
     args = parser.parse_args()
+    setup_logging(args.debug)
+
+    logger = logging.getLogger(__name__)
+    logger.debug("flatpak-builder-lint version: %s", __version__)
+
     exit_code = 0
 
     path = os.getcwd() if args.cwd else args.path[0]
diff --git a/flatpak_builder_lint/domainutils.py b/flatpak_builder_lint/domainutils.py
@@ -1,3 +1,4 @@
+import logging
 import os
 from functools import cache
 from importlib.resources import files
@@ -13,6 +14,8 @@
 gi.require_version("OSTree", "1.0")
 from gi.repository import GLib, OSTree  # noqa: E402
 
+logger = logging.getLogger(__name__)
+
 CODE_HOSTS = (
     "io.github.",
     "io.frama.",
@@ -50,8 +53,14 @@ def fetch_summary_bytes(url: str) -> bytes:
         r = session.get(url, allow_redirects=False, timeout=REQUEST_TIMEOUT)
         if r.status_code == 200 and r.headers.get("Content-Type") == "application/octet-stream":
             return r.content
-    except requests.exceptions.RequestException:
-        pass
+        logger.debug(
+            "Failed to fetch summary from %s. Status: %s, Content-Type: %s",
+            url,
+            r.status_code,
+            r.headers.get("Content-Type"),
+        )
+    except requests.exceptions.RequestException as e:
+        logger.debug("Request exception when fetching %s: %s: %s", url, type(e).__name__, e)
 
     if url.startswith(config.FLATHUB_BETA_REPO_URL):
         local_summary_file = "flathub-beta.summary"
@@ -63,8 +72,8 @@ def fetch_summary_bytes(url: str) -> bytes:
         if resource_path.is_file():
             with resource_path.open("rb") as f:
                 return f.read()
-    except (OSError, FileNotFoundError):
-        pass
+    except (OSError, FileNotFoundError) as e:
+        logger.debug("Exception loading local summary file: %s: %s", type(e).__name__, e)
 
     raise Exception("Failed to load fallback local summary file")
 
@@ -192,7 +201,8 @@ def check_url(url: str, strict: bool = False) -> tuple[bool, str | None]:
                 ]
             )
             return False, resp_info
-    except requests.exceptions.RequestException:
+    except requests.exceptions.RequestException as e:
+        logger.debug("Request exception when fetching %s: %s: %s", url, type(e).__name__, e)
         return False, None
 
 
@@ -207,8 +217,10 @@ def get_remote_exceptions(appid: str) -> set[str]:
         )
         if r.status_code == 200 and r.headers.get("Content-Type") == "application/json":
             return set(r.json())
-    except requests.exceptions.RequestException:
-        pass
+    except requests.exceptions.RequestException as e:
+        logger.debug(
+            "Request exception when fetching exceptions for %s: %s: %s", appid, type(e).__name__, e
+        )
 
     return set()
 
diff --git a/flatpak_builder_lint/exceptions_janitor.py b/flatpak_builder_lint/exceptions_janitor.py
diff --git a/flatpak_builder_lint/gitutils.py b/flatpak_builder_lint/gitutils.py
diff --git a/flatpak_builder_lint/manifest.py b/flatpak_builder_lint/manifest.py
diff --git a/flatpak_builder_lint/staticfiles/exceptions.json b/flatpak_builder_lint/staticfiles/exceptions.json
diff --git a/tests/test_manifest.py b/tests/test_manifest.py
diff --git a/utils/validator.py b/utils/validator.py
