Merge pull request #23 from LecrisUT/feat/rpmlint-distgit

Rework rpmlint to work with distgit

Author: nforro

plans/rpmlint/README.md

@@ -7,62 +7,46 @@ Run [rpmlint] on the current Copr project or Koji build
 ## Synopsis
 
 ```yaml
-discover:
-  how: fmf
-  filter: "tag: rpmlint"
-  url: https://github.com/packit/tmt-plans
-  ref: main
-execute:
-  how: tmt
+plans:
+  import:
+    url: https://github.com/packit/tmt-plans
+    ref: main
+    name: /plans/rpmlint
 ```
 
 ## Description
 
-This plan simply runs the command
+This plan simply runs `rpmlint` against the rpms and spec files provided. For specific details, see the
+[`/tests/rpmlint/run-rpmlint.py`] wrapper file.
 
-```console
-$ rpmlint ./*.rpm
-```
+Depending on the calling environment (`initiator`, `trigger` contexts) the inputs of this plan are provided
+automatically, otherwise see the [options section](#options) for the expected control parameters.
 
-The `rpm` and `srpm` artifacts are taken from the testing-farm artifacts. In order to pass a `.rpmlintrc` file, use the
-[`prepare`] step of the plan to copy the file to `TMT_PLAN_DATA`. Only the `rpmlintrc` file that matches the spec file
-is used.
+## Options
 
-:::note
+`SPEC_FILE`
 
-The rpmlint of the `.spec` file is handled automatically when running `rpmlint` against a `srpm`.
+: koji-build: Detected from dist-git (`*.spec`)
+: copr: Not supported currently
+: Spec file to check.
 
-:::
+`RPM_FILES`
 
-## Options
+: koji-build: Downloaded all rpm files from koji task
+: copr: From testing-farm artifacts (`/var/share/test-artifacts/*.rpm`)
+: RPM files to check. Can be wildcard.
 
-No options available
+`RPMLINT_RC_FILE`
 
-## Examples
+: koji-build: Detected from dist-git (`*.rpmlintrc`)
+: copr: Not supported currently
+: .rpmlintrc file.
 
-- Rpmlint the upstream packit project
-  ```yaml
-  discover:
-    how: fmf
-    filter: "tag: rpmlint"
-    url: https://github.com/packit/tmt-plans
-    ref: main
-  execute:
-    how: tmt
-  ```
-- Use `rpmlintrc` file
-  ```yaml
-  prepare:
-    - how: shell
-      script: cp ./*.rpmlintrc $TMT_PLAN_DATA/
-  discover:
-    how: fmf
-    filter: "tag: rpmlint"
-    url: https://github.com/packit/tmt-plans
-    ref: main
-  execute:
-    how: tmt
-  ```
+`RPMLINT_TOML_FILE`
+
+: koji-build: Detected from dist-git (`rpmlint.toml`)
+: copr: Not supported currently
+: Rpmlint toml file to override.
 
 ## See Also
 
@@ -71,4 +55,4 @@ No options available
 <!-- SPHINX-END -->
 
 [rpmlint]: https://github.com/rpm-software-management/rpmlint
-[`prepare`]: https://tmt.readthedocs.io/en/stable/spec/plans.html#prepare
+[`/tests/rpmlint/run-rpmlint.py`]: ../../tests/rpmlint/run-rpmlint.py

plans/rpmlint/main.fmf

@@ -3,5 +3,10 @@ summary: Run rpmlint on all rpms and spec file
 description: |
   Equivalent to zuul job running rpmlint
 
-discover+:
-  filter: "tag: rpmlint"
+provision:
+  how: container
+  image: fedora:latest
+
+discover:
+  how: fmf
+  test: /tests/rpmlint

tests/rpmlint/copr-prepare.py

@@ -0,0 +1,42 @@
+#!/usr/bin/python3
+# /// script
+# dependencies = [ ]
+# ///
+
+import argparse
+import os
+import re
+import subprocess
+from pathlib import Path
+
+
+def main(args: argparse.Namespace) -> None:
+    """
+    Prepare for rpmlint from a copr-build
+    """
+    args.env_file: Path
+
+    # TODO: Get the data from copr.
+    # For now we assume a testing-farm environment.
+    with args.env_file.open("a") as f:
+        f.write("RPM_FILES=/var/share/test-artifacts/*.rpm\n")
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--copr-project", default=os.environ.get("PACKIT_COPR_PROJECT"))
+    # TODO: Get the data from copr.
+    # TODO: Get the rpmlint that upstream passes somehow
+    parser.add_argument(
+        "--workdir",
+        type=Path,
+        default=os.environ.get("TMT_PLAN_DATA", "."),
+    )
+    parser.add_argument(
+        "--env-file",
+        type=Path,
+        default=os.environ.get("TMT_PLAN_ENVIRONMENT_FILE", ".env"),
+    )
+
+    args = parser.parse_args()
+    main(args)

tests/rpmlint/distgit-prepare.py

@@ -0,0 +1,86 @@
+#!/usr/bin/python3
+# /// script
+# dependencies = [ ]
+# ///
+
+import argparse
+import os
+import re
+import subprocess
+from pathlib import Path
+
+
+def main(args: argparse.Namespace) -> None:
+    """
+    Prepare for rpmlint from a dist-git
+    """
+    args.env_file: Path
+
+    # Get the basic build information from koji
+    task_info = subprocess.run(
+        [
+            "koji",
+            "taskinfo",
+            "-v",
+            args.koji_task_id,
+        ],
+        capture_output=True,
+        text=True,
+    ).stdout
+    source = re.search(r"Source:\s*(.*)", task_info).group(1)
+    source_match = re.search(r"git\+(?P<url>.*)#(?P<ref>.*)", source)
+    repo_url = source_match.group("url")
+    repo_ref = source_match.group("ref")
+
+    # Clone the dist-git used in the build
+    dist_git_path: Path = args.workdir / "dist-git"
+    subprocess.run(["git", "clone", repo_url, dist_git_path])
+    subprocess.run(["git", "checkout", "-d", repo_ref], cwd=dist_git_path)
+
+    # Find any rplintrc files
+    rc_files = list(dist_git_path.glob("*.rpmlintrc"))
+    if len(rc_files) > 1:
+        print("Warn: More than 1 rpmlintrc file found")
+    if rc_files:
+        print("Found rpmlintrc file")
+        with args.env_file.open("a") as f:
+            f.write(f"RPMLINT_RC_FILE={rc_files[0]}\n")
+    toml_file = dist_git_path / "rpmlint.toml"
+    if toml_file.exists():
+        print("Found rpmlint.toml file")
+        with args.env_file.open("a") as f:
+            f.write(f"RPMLINT_TOML_FILE={toml_file}\n")
+
+    # Find the files to lint
+    spec_files = list(dist_git_path.glob("*.spec"))
+    if len(spec_files) > 1:
+        print("Warn: More than 1 spec file found")
+    if spec_files:
+        with args.env_file.open("a") as f:
+            f.write(f"SPEC_FILE={spec_files[0]}\n")
+    else:
+        print("Warn: No spec file found?")
+    subprocess.run(
+        ["koji", "download-task", args.koji_task_id],
+        cwd=args.workdir,
+    )
+    with args.env_file.open("a") as f:
+        f.write(f"RPM_FILES={args.workdir}/*.rpm\n")
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser()
+    parser.add_argument("--koji-task-id", default=os.environ.get("KOJI_TASK_ID"))
+    parser.add_argument(
+        "--workdir",
+        type=Path,
+        default=os.environ.get("TMT_PLAN_DATA", "."),
+    )
+    parser.add_argument(
+        "--env-file",
+        type=Path,
+        default=os.environ.get("TMT_PLAN_ENVIRONMENT_FILE", ".env"),
+    )
+
+    args = parser.parse_args()
+    main(args)

tests/rpmlint/main.fmf

@@ -1,7 +1,37 @@
-summary: Run rpmlint
-tag: rpmlint
-require:
-  - rpmlint
-result: custom
+/:
+  inherit: false
 
-test+: rpmlint.sh
+/prepare-distgit:
+  summary: Prepare with distgit environment
+  enabled: false
+  order: 40
+  require:
+    - koji
+    - git
+  test: python3 ./distgit-prepare.py
+  adjust:
+    # TODO: For now this is only available for distgit commits
+    when: initiator == fedora-ci and trigger == commit
+    enabled: true
+
+/prepare-copr:
+  summary: Prepare with copr environment
+  enabled: false
+  order: 40
+  require:
+    - copr
+    - git
+  test: python3 ./copr-prepare.py
+  adjust:
+    when: initiator == packit
+    enabled: true
+
+/run-rpmlint:
+  summary: Run rpmlint
+  description: |
+    Requires having some environment variables predefined.
+    See documentation of the run-rpmlint script.
+  require:
+    - rpmlint
+    - rpmlint-fedora-license-data
+  test: python3 ./run-rpmlint.py