Merge branch 'devel'

Release v0.0.3

Author: fgyanz

.github/workflows/ci-cache.yml

@@ -0,0 +1,37 @@
+# @file ci-cache.yml
+---
+name: Update caches
+
+on:
+  push:
+    branches:
+      - "devel"
+
+jobs:
+  distribution-check:
+    runs-on: ubuntu-latest
+    container:
+      image: opensuse/tumbleweed:latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install git
+      run: zypper in -y git
+
+    - name: Get month
+      id: get-month
+      run: |
+        echo "month=$(date +%m)" >> $GITHUB_OUTPUT
+      shell: bash
+
+    - name: Cache kernel-source
+      id: cache-ksrc
+      uses: actions/cache@v4
+      with:
+        path: build/kernel-source
+        key: kernel-source-${{ steps.get-month.outputs.month }}
+
+    - if: ${{ steps.cache-ksrc.outputs.cache-hit != 'true' }}
+      name: Download kernel-source
+      continue-on-error: true
+      run: git clone https://github.com/SUSE/kernel-source build/kernel-source

.github/workflows/ci-tests.yml

@@ -0,0 +1,55 @@
+# @file ci-tests.yml
+---
+name: klp-build tests
+
+on:
+  pull_request:
+    branches:
+      - 'devel'
+      - 'main'
+  push:
+    branches:
+      - '*'
+      - '!devel'
+      - '!main'
+
+jobs:
+  distribution-check:
+    runs-on: ubuntu-latest
+    container:
+      image: opensuse/tumbleweed:latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Install dependencies
+      run: zypper in -y python3-devel git python3-pytest tox
+
+    - name: Get month
+      id: get-month
+      run: |
+        echo "month=$(date +%m)" >> $GITHUB_OUTPUT
+      shell: bash
+
+    - name: Cache kernel-source
+      id: cache-ksrc
+      uses: actions/cache@v4
+      with:
+        path: build/kernel-source
+        key: kernel-source-${{ steps.get-month.outputs.month }}
+
+    - if: ${{ steps.cache-ksrc.outputs.cache-hit != 'true' }}
+      # It will take around 25min to download the whole repo.
+      # Hopefully we won't have the need to do it very often.
+      name: Download kernel-source
+      continue-on-error: true
+      run: git clone https://github.com/SUSE/kernel-source build/kernel-source
+
+    - name: Run klp-build tests
+      run: |
+        mkdir -p ~/.config/klp-build &&
+        cp tests/config ~/.config/klp-build/ &&
+        mkdir -p klp/{livepatches,data} &&
+        tox -e tests -- tests/test_{scan,config,ksrc,utils,codestream}.py
+
+    - name: Run pylint
+      run: tox -e lint -- --fail-under 9.4 --fail-on F

Makefile

@@ -24,13 +24,19 @@ Generic options available for all commands:
 .B "-h, --help"
 Show command's help message and exit.
 .TP
+.B "-v, --verbose"
+Produce more verbose output.
+.TP
 .BI "-n, --name" " NAME"
 The livepatch name. This will be the directory name of the resulting
 livepatches.
 .TP
 .BI --filter " FILTER"
 List of accepted codestreams. Must be specified in regex format.
-Example: "15\.3u[0-9]+|15\.6u0"
+Example: '15\.3u[0-9]+|15\.6u0'
+.br
+You can also use a negative regex in order to filter out a specific codestream.
+Example: '^(?!12.5u12).*'
 .SH COMMANDS
 .TP
 .B scan
@@ -94,10 +100,6 @@ will be livepatched instead.
 .TP
 .BI --archs " {ppc64le,s390x,x86_64} [{ppc64le,s390x,x86_64} ...]"
 Supported architectures for this livepatch.
-.TP
-.BI --skips " SKIPS"
-List of excluded codestreams. Must be specified in regex format.
-Example: "15\.3u[0-9]+|15\.6u0"
 .RE
 .B check-inline
 .RS 7
@@ -185,11 +187,11 @@ Wait until all codestreams builds are finished.
 Get build logs from SUSE'S Build Service.
 .RS 7
 .TP
-.BI --cs " CS"
-The codestream to get the log from.
-.TP
 .BI --arch " {ppc64le,s390x,x86_64}"
 Build architecture.
+.TP
+.BI --filter
+Required. Needs to specify only specific codestream.
 .RE
 .SH FILES
 .TP

klp-build.1

@@ -0,0 +1,30 @@
+# SPDX-License-Identifier: GPL-2.0-only
+#
+# Copyright (C) 2021-2025 SUSE
+# Authors: Fernando Gonzalez
+#          Marcos Paulo de Souza <[email protected]>
+
+import bugzilla
+from klpbuild.klplib.config import get_user_settings
+
+
+def get_bug_data(bsc):
+    bz_key = get_user_settings("bugzilla_api_key", True)
+    if 'changeit' in bz_key:
+        raise RuntimeError("Change the bugzilla_api_key to a valid key.")
+
+    bzapi = bugzilla.Bugzilla("https://bugzilla.suse.com", api_key=bz_key)
+
+    return bzapi.getbug(bsc)
+
+
+def get_bug_title(bsc):
+    """
+    The bug description usually is after the "kernel live patch" message. Return a fixes message
+    if the livepatch name is not an ID from a bug on bugzilla.
+    """
+    if not bsc.isnumeric():
+        return "Change me!"
+
+    data = str(get_bug_data(int(bsc)).summary)
+    return data.split("kernel live patch: ")[1].strip()

klpbuild/klplib/bugzilla.py

@@ -6,24 +6,47 @@
 import argparse
 
 from klpbuild.klplib.utils import ARCHS
+from klpbuild.klplib.plugins import register_plugins_argparser
 
-
-def create_parser() -> argparse.ArgumentParser:
-    parentparser = argparse.ArgumentParser(add_help=False)
+def add_arg_lp_name(parentparser, mandatory=True):
     parentparser.add_argument(
         "-n",
         "--name",
         type=str,
-        required=True,
+        required=mandatory,
         help="The livepatch name. This will be the directory name of the "
         "resulting livepatches.",
     )
-    parentparser.add_argument("--filter", type=str, help=r"Filter out codestreams using a regex. Example: 15\.3u[0-9]+")
 
-    parser = argparse.ArgumentParser(add_help=False)
-    sub = parser.add_subparsers(dest="cmd")
 
-    setup = sub.add_parser("setup", parents=[parentparser])
+def add_arg_lp_filter(parentparser, mandatory=False):
+    parentparser.add_argument(
+        "--filter",
+        type=str,
+        required=mandatory,
+        dest="lp_filter",
+        help=r"Filter out codestreams using a regex. Example: 15\.3u[0-9]+"
+    )
+
+
+def create_parser() -> argparse.ArgumentParser:
+    parentparser = argparse.ArgumentParser(add_help=True)
+    sub = parentparser.add_subparsers(dest="cmd")
+
+    parentparser.add_argument(
+        "-v",
+        "--verbose",
+        action="store_true",
+        help="Produce more verbose output"
+    )
+
+    register_plugins_argparser(sub)
+
+    # NOTE: all the code below should be gone when all the module will be
+    # converted into plugins
+    setup = sub.add_parser("setup")
+    add_arg_lp_name(setup)
+    add_arg_lp_filter(setup)
     setup.add_argument("--cve", type=str, help="SLE specific. The CVE assigned to this livepatch")
     setup.add_argument("--conf", type=str, required=True, help="The kernel CONFIG used to be build the livepatch")
     setup.add_argument(
@@ -71,9 +94,10 @@ def create_parser() -> argparse.ArgumentParser:
         nargs="+",
         help="SLE specific. Supported architectures for this livepatch",
     )
-    setup.add_argument("--skips", help="List of codestreams to filter out")
 
-    check_inline = sub.add_parser("check-inline", parents=[parentparser])
+    check_inline = sub.add_parser("check-inline")
+    add_arg_lp_name(check_inline)
+    add_arg_lp_filter(check_inline)
     check_inline.add_argument(
         "--codestream",
         type=str,
@@ -94,7 +118,9 @@ def create_parser() -> argparse.ArgumentParser:
         help="Symbol to be found",
     )
 
-    extract_opts = sub.add_parser("extract", parents=[parentparser])
+    extract_opts = sub.add_parser("extract")
+    add_arg_lp_name(extract_opts)
+    add_arg_lp_filter(extract_opts)
     extract_opts.add_argument(
         "--avoid-ext",
         nargs="+",
@@ -107,49 +133,52 @@ def create_parser() -> argparse.ArgumentParser:
     extract_opts.add_argument(
         "--apply-patches", action="store_true", help="Apply patches found by get-patches subcommand, if they exist"
     )
-    diff_opts = sub.add_parser("cs-diff", parents=[parentparser])
-    diff_opts.add_argument(
-        "--cs", nargs=2, type=str, required=True, help="SLE specific. Apply diff on two different codestreams"
-    )
+
+    diff_opts = sub.add_parser("cs-diff")
+    add_arg_lp_name(diff_opts)
+    add_arg_lp_filter(diff_opts)
 
     fmt = sub.add_parser(
-        "format-patches", parents=[parentparser], help="SLE specific. Extract patches from kgraft-patches"
+        "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", parents=[parentparser])
+    patches = sub.add_parser("get-patches")
+    add_arg_lp_name(patches)
+    add_arg_lp_filter(patches)
     patches.add_argument(
         "--cve", required=True, help="SLE specific. CVE number to search for related backported patches"
     )
 
-    scan = sub.add_parser("scan")
-    scan.add_argument(
-        "--cve", required=True, help="SLE specific. Shows which codestreams are vulnerable to the CVE"
-    )
-    scan.add_argument(
-        "--conf", required=False, help="SLE specific. Helps to check only the codestreams that have this config set."
-    )
 
-    sub.add_parser("cleanup", parents=[parentparser], help="SLE specific. Remove livepatch packages from IBS")
+    cleanup =sub.add_parser("cleanup", help="SLE specific. Remove livepatch packages from IBS")
+    add_arg_lp_name(cleanup)
+    add_arg_lp_filter(cleanup)
 
-    sub.add_parser(
+    test = sub.add_parser(
         "prepare-tests",
-        parents=[parentparser],
         help="SLE specific. Download the built tests and check for LP dependencies",
     )
+    add_arg_lp_name(test)
+    add_arg_lp_filter(test)
 
     push = sub.add_parser(
-        "push", parents=[parentparser], help="SLE specific. Push livepatch packages to IBS to be built"
+        "push", help="SLE specific. Push livepatch packages to IBS to be built"
     )
+    add_arg_lp_name(push)
+    add_arg_lp_filter(push)
     push.add_argument("--wait", action="store_true", help="Wait until all codestreams builds are finished")
 
-    status = sub.add_parser("status", parents=[parentparser], help="SLE specific. Check livepatch build status on IBS")
+    status = sub.add_parser("status", help="SLE specific. Check livepatch build status on IBS")
+    add_arg_lp_name(status)
+    add_arg_lp_filter(status)
     status.add_argument("--wait", action="store_true", help="Wait until all codestreams builds are finished")
 
-    log = sub.add_parser("log", parents=[parentparser], help="SLE specific. Get build log from IBS")
-    log.add_argument("--cs", type=str, required=True, help="The codestream to get the log from")
+    log = sub.add_parser("log", help="SLE specific. Get build log from IBS")
+    add_arg_lp_name(log)
+    add_arg_lp_filter(log, mandatory=True)
     log.add_argument("--arch", type=str, default="x86_64", choices=ARCHS, help="Build architecture")
 
-    return parser
-
-
+    return parentparser