Merge pull request #94 from vmezzela/format-patches-next

Convert format-patches to plugins

Author: fgyanz

klpbuild/klplib/cmd.py

@@ -88,12 +88,6 @@ def create_parser() -> argparse.ArgumentParser:
     add_arg_lp_name(diff_opts)
     add_arg_lp_filter(diff_opts)
 
-    fmt = sub.add_parser(
-        "format-patches", help="SLE specific. Extract patches from kgraft-patches"
-    )
-    add_arg_lp_name(fmt)
-    add_arg_lp_filter(fmt)
-    fmt.add_argument("-v", "--version", type=int, required=True, help="Version to be added, like vX")
 
     patches = sub.add_parser("get-patches")
     add_arg_lp_name(patches)

klpbuild/klplib/ksrc.py

@@ -5,7 +5,6 @@
 
 import logging
 import re
-import shutil
 import subprocess
 import sys
 from datetime import datetime
@@ -47,65 +46,6 @@ def __init__(self, lp_filter):
 
         self.lp_filter = lp_filter
 
-    def format_patches(self, lp_name, version):
-        ver = f"v{version}"
-        # index 1 will be the test file
-        index = 2
-
-        kgr_patches = get_user_path('kgr_patches_dir')
-        if not kgr_patches:
-            logging.warning("kgr_patches_dir not found, patches will be incomplete")
-
-        # Remove dir to avoid leftover patches with different names
-        patches_dir = utils.get_workdir(lp_name)/"patches"
-        shutil.rmtree(patches_dir, ignore_errors=True)
-
-        test_src = utils.get_tests_path(lp_name)
-        subprocess.check_output(
-            [
-                "/usr/bin/git",
-                "-C",
-                str(get_user_path('kgr_patches_tests_dir')),
-                "format-patch",
-                "-1",
-                f"{test_src}",
-                "--cover-letter",
-                "--start-number",
-                "1",
-                "--subject-prefix",
-                f"PATCH {ver}",
-                "--output-directory",
-                f"{patches_dir}",
-            ]
-        )
-
-        # Filter only the branches related to this BSC
-        for branch in utils.get_lp_branches(lp_name, kgr_patches):
-            logging.info(branch)
-            bname = branch.replace(lp_name + "_", "")
-            bs = " ".join(bname.split("_"))
-            bsc = lp_name.replace("bsc", "bsc#")
-
-            prefix = f"PATCH {ver} {bsc} {bs}"
-
-            subprocess.check_output(
-                [
-                    "/usr/bin/git",
-                    "-C",
-                    str(kgr_patches),
-                    "format-patch",
-                    "-1",
-                    branch,
-                    "--start-number",
-                    f"{index}",
-                    "--subject-prefix",
-                    f"{prefix}",
-                    "--output-directory",
-                    f"{patches_dir}",
-                ]
-            )
-
-            index += 1
 
     # Currently this function returns the date of the patch and it's subject
     @staticmethod

klpbuild/klplib/plugins.py

@@ -28,7 +28,8 @@ def try_run_plugin(name, args):
     """
     logging.debug("Trying to run plugin %s", name)
 
-    module = __get_plugin(name)
+    real_name = name.replace("-", "_")
+    module = __get_plugin(real_name)
     assert hasattr(module, "run"), f"Module {name} is not a plugin!"
 
     run_func = getattr(module, "run")

klpbuild/main.py

@@ -50,9 +50,6 @@ def main():
     elif args.cmd == "get-patches":
         GitHelper(args.lp_filter).get_commits(args.cve, get_workdir(args.lp_name))
 
-    elif args.cmd == "format-patches":
-        GitHelper(args.lp_filter).format_patches(args.lp_name, args.version)
-
     elif args.cmd == "status":
         IBS(args.lp_name, args.lp_filter).status(args.wait)
 

klpbuild/plugins/format_patches.py

@@ -0,0 +1,82 @@
+# SPDX-License-Identifier: GPL-2.0-only
+#
+# Copyright (C) 2021-2025 SUSE
+# Author: Marcos Paulo de Souza <[email protected]>
+
+import logging
+import shutil
+import subprocess
+
+from klpbuild.klplib import utils
+from klpbuild.klplib.cmd import add_arg_lp_name
+from klpbuild.klplib.config import get_user_path
+
+PLUGIN_CMD = "format-patches"
+
+def register_argparser(subparser):
+    fmt = subparser.add_parser(
+        "format-patches", help="SLE specific. Extract patches from kgraft-patches"
+    )
+    add_arg_lp_name(fmt)
+    fmt.add_argument("-v", "--version", type=int, required=True, help="Version to be added, like vX")
+
+
+def run(lp_name, version):
+    ver = f"v{version}"
+    # index 1 will be the test file
+    index = 2
+
+    kgr_patches = get_user_path('kgr_patches_dir')
+    if not kgr_patches:
+        logging.warning("kgr_patches_dir not found, patches will be incomplete")
+
+    # Remove dir to avoid leftover patches with different names
+    patches_dir = utils.get_workdir(lp_name)/"patches"
+    shutil.rmtree(patches_dir, ignore_errors=True)
+
+    test_src = utils.get_tests_path(lp_name)
+    subprocess.check_output(
+        [
+            "/usr/bin/git",
+            "-C",
+            str(get_user_path('kgr_patches_tests_dir')),
+            "format-patch",
+            "-1",
+            f"{test_src}",
+            "--cover-letter",
+            "--start-number",
+            "1",
+            "--subject-prefix",
+            f"PATCH {ver}",
+            "--output-directory",
+            f"{patches_dir}",
+        ]
+    )
+
+    # Filter only the branches related to this BSC
+    for branch in utils.get_lp_branches(lp_name, kgr_patches):
+        logging.info(branch)
+        bname = branch.replace(lp_name + "_", "")
+        bs = " ".join(bname.split("_"))
+        bsc = lp_name.replace("bsc", "bsc#")
+
+        prefix = f"PATCH {ver} {bsc} {bs}"
+
+        subprocess.check_output(
+            [
+                "/usr/bin/git",
+                "-C",
+                str(kgr_patches),
+                "format-patch",
+                "-1",
+                branch,
+                "--start-number",
+                f"{index}",
+                "--subject-prefix",
+                f"{prefix}",
+                "--output-directory",
+                f"{patches_dir}",
+            ]
+        )
+
+        index += 1