ci: align linting with project guidelines

Adopt the Ruff-based linting and formatting baseline discussed in kernelci-project#566.

Replace the existing pycodestyle-only CI step with pre-commit-enforced Ruff checks, keep the YAML and JWT validators in place, and pin the local developer tooling used by CI.

Set a shared 80/110 line-length policy, document the project-level ignore list, allow scoped complexity exceptions for legacy entrypoints, and reformat the Python tree to establish a clean baseline.

Refs: kernelci-project#566
Signed-off-by: Denys Fedoryshchenko <denys.f@collabora.com>

Author: nuclearcat

.github/workflows/main.yml

@@ -1,21 +1,37 @@
-# This is a basic workflow to help you get started with Actions
-
 name: CI
 
-# Controls when the workflow will run
 on:
-  # Triggers the workflow on push or pull request events but only for the main branch
   push:
     branches: [ main ]
   pull_request:
     branches: [ main ]
-
-  # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
 
-# A workflow run is made up of one or more jobs that can run sequentially or in parallel
 jobs:
-  check:
+  lint:
+    runs-on: ubuntu-22.04
+
+    steps:
+      - name: Check out source code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.13'
+          cache: 'pip'
+
+      - name: Install lint tooling
+        run: |
+          python --version
+          python -m pip install --upgrade pip
+          pip install -r requirements-dev.txt
+
+      - name: Run Ruff pre-commit hooks
+        run: |
+          pre-commit run --all-files --show-diff-on-failure
+
+  validate:
     runs-on: ubuntu-22.04
     strategy:
       matrix:
@@ -25,7 +41,6 @@ jobs:
           - '3.13'
 
     steps:
-
       - name: Check out source code
         uses: actions/checkout@v4
 
@@ -35,34 +50,16 @@ jobs:
           python-version: ${{ matrix.python-version }}
           cache: 'pip'
 
-      # Override version of pycodestyle for Python 3.7 to the
-      # latest available release that can be installed on this
-      # old Python release.
-      - name: Override pycodestyle version
-        if: ${{ matrix.python-version == '3.7' }}
-        run: |
-          echo 'pycodestyle==2.10.0' > requirements-dev.txt
-
-      - name: Install Python packages
+      - name: Install validation dependencies
         run: |
           python --version
           python -m pip install --upgrade pip
-          pip install -r requirements-dev.txt
-
-      - name: Run pycodestyle
-        run: |
-          pycodestyle --ignore=E501,W503,W504 src/*.py
-
-      - name: Install Python YAML package
-        run: |
-          pip install pyyaml
+          pip install pyyaml PyJWT toml
 
       - name: Run basic YAML validation
         run: |
           python tests/validate_yaml.py
 
       - name: Run basic JWT test
         run: |
-          pip install PyJWT
-          pip install toml
           python tests/validate_jwt.py

.pre-commit-config.yaml

@@ -0,0 +1,13 @@
+repos:
+  - repo: local
+    hooks:
+      - id: ruff-check
+        name: ruff check
+        entry: ruff check --fix
+        language: system
+        types_or: [python, pyi]
+      - id: ruff-format
+        name: ruff format
+        entry: ruff format
+        language: system
+        types_or: [python, pyi]

pyproject.toml

@@ -0,0 +1,25 @@
+[tool.ruff]
+target-version = "py37"
+src = ["src", "tests", "tools"]
+line-length = 80
+
+[tool.ruff.lint]
+select = ["C901", "E", "F", "I", "W"]
+ignore = [
+    "E203",  # Formatter-compatible slicing whitespace.
+]
+
+[tool.ruff.lint.pycodestyle]
+max-line-length = 110
+
+[tool.ruff.lint.per-file-ignores]
+# Legacy or high-churn entrypoints are allowed incremental complexity cleanup.
+"src/job_retry.py" = ["C901"]
+"src/lava_callback.py" = ["C901", "E501"]
+"src/scheduler.py" = ["C901"]
+"src/send_kcidb.py" = ["C901"]
+"src/trigger.py" = ["C901"]
+"tests/hw_reg_checker.py" = ["C901"]
+"tests/validate_yaml.py" = ["C901"]
+"tools/example_pull_lab.py" = ["C901"]
+"tools/example_pull_lab_pytest.py" = ["C901"]

requirements-dev.txt

@@ -1 +1,2 @@
-pycodestyle==2.14.0
+pre-commit==4.5.1
+ruff==0.15.9

setup.cfg

@@ -1,2 +1,2 @@
 [pycodestyle]
-max-line-length = 100
+max-line-length = 110

src/base.py

@@ -7,14 +7,14 @@
 
 import logging
 import os
-import requests
 
 import kernelci
+import requests
 from kernelci.api.helper import APIHelper
 
 from logger import Logger
 
-SERVICE_PIPELINE = 'service:pipeline'
+SERVICE_PIPELINE = "service:pipeline"
 
 
 class Service:
@@ -23,8 +23,8 @@ class Service:
     def __init__(self, configs, args, name):
         self._name = name
         self._logger = Logger("config/logger.conf", name)
-        self._api_config = configs['api'][args.api_config]
-        api_token = os.getenv('KCI_API_TOKEN')
+        self._api_config = configs["api"][args.api_config]
+        api_token = os.getenv("KCI_API_TOKEN")
         self._api = kernelci.api.get_api(self._api_config, api_token)
         self._api_helper = APIHelper(self._api)
 
@@ -82,20 +82,20 @@ def run(self, args=None):
 
 
 def validate_url(url, timeout=5):
-    '''
+    """
     Validate URL by:
     - checking if it's not empty
     - checking if it starts with HTTP* scheme
     - requesting HEAD to see if it can be accessed
-    '''
+    """
     if not url:
         return False
-    if not url.startswith('http'):
+    if not url.startswith("http"):
         return False
     try:
         r = requests.head(url, allow_redirects=True, timeout=timeout)
         r.raise_for_status()
     except requests.exceptions.RequestException as e:
-        logging.error(f'Error accessing URL: {e}')
+        logging.error(f"Error accessing URL: {e}")
         return False
     return True

src/job_retry.py

@@ -6,37 +6,39 @@
 # Author: Jeny Sadadia <jeny.sadadia@collabora.com>
 
 import sys
+
 import kernelci.config
 from kernelci.legacy.cli import Args, Command, parse_opts
 
 from base import Service
 
 
 class JobRetry(Service):
-
     def __init__(self, configs, args):
-        super().__init__(configs, args, 'job_retry')
+        super().__init__(configs, args, "job_retry")
 
     def _setup(self, args):
-        return self._api_helper.subscribe_filters({
-            "state": "done",
-            "result": ("incomplete", "fail"),
-            "kind": ("kbuild", "job"),
-        })
+        return self._api_helper.subscribe_filters(
+            {
+                "state": "done",
+                "result": ("incomplete", "fail"),
+                "kind": ("kbuild", "job"),
+            }
+        )
 
     def _stop(self, sub_id):
         if sub_id:
             self._api_helper.unsubscribe_filters(sub_id)
         sys.stdout.flush()
 
     def _find_parent_kind(self, node, api_helper, kind):
-        parent_id = node.get('parent')
+        parent_id = node.get("parent")
         if not parent_id:
             return None
         parent_node = api_helper.api.node.get(parent_id)
         if not parent_node:
             return None
-        if parent_node.get('kind') == kind:
+        if parent_node.get("kind") == kind:
             return parent_node
         return self._find_parent_kind(parent_node, api_helper, kind)
 
@@ -59,10 +61,14 @@ def _run(self, sub_id):
 
             # Check retry count before submitting a retry
             retry_counter = node.get("retry_counter", 0)
-            self.log.debug(f"{node['id']}: Node current retry_counter: {retry_counter}")
+            self.log.debug(
+                f"{node['id']}: Node current retry_counter: {retry_counter}"
+            )
             if retry_counter >= 3:
-                self.log.info(f"{node['id']} Job has already retried 3 times. \
-Not submitting a retry.")
+                self.log.info(
+                    f"{node['id']} Job has already retried 3 times. \
+Not submitting a retry."
+                )
                 continue
 
             parent_kind = None
@@ -71,27 +77,39 @@ def _run(self, sub_id):
             if node.get("kind") == "kbuild":
                 parent_kind = "checkout"
             if parent_kind:
-                event_data = self._find_parent_kind(node, self._api_helper, parent_kind)
+                event_data = self._find_parent_kind(
+                    node, self._api_helper, parent_kind
+                )
                 if not event_data:
-                    self.log.error(f"Not able to find parent node for {node['id']}")
+                    self.log.error(
+                        f"Not able to find parent node for {node['id']}"
+                    )
                     continue
                 if node["kind"] == "kbuild":
-                    event_data["jobfilter"] = [f'{node["name"]}+']
+                    event_data["jobfilter"] = [f"{node['name']}+"]
                 else:
                     event_data["jobfilter"] = [node["name"]]
                 # Change event data state to available to trigger jobs based on scheduler configs
                 event_data["state"] = "available"
                 if node["kind"] == "job":
-                    event_data["platform_filter"] = [node["data"].get("platform")]
+                    event_data["platform_filter"] = [
+                        node["data"].get("platform")
+                    ]
                 event_data["retry_counter"] = retry_counter + 1
                 event_data["debug"] = {"retry_by": str(node["id"])}
-                self.log.debug(f"{node['id']}:Event data retry_counter: {event_data['retry_counter']}")
-                event = {'data': event_data}
-                self._api_helper.api.send_event('retry', event)
-                self.log.info(f"Job retry for node {node['id']} submitted. Parent node: {event_data['id']}")
+                self.log.debug(
+                    f"{node['id']}:Event data retry_counter: {event_data['retry_counter']}"
+                )
+                event = {"data": event_data}
+                self._api_helper.api.send_event("retry", event)
+                self.log.info(
+                    f"Job retry for node {node['id']} submitted. Parent node: {event_data['id']}"
+                )
                 self.log.debug(f"Event:{event}")
             else:
-                self.log.error(f"Not able to retry the job as parent kind is unknown: {node['id']}")
+                self.log.error(
+                    f"Not able to retry the job as parent kind is unknown: {node['id']}"
+                )
         return True
 
 
@@ -103,9 +121,9 @@ def __call__(self, configs, args):
         return JobRetry(configs, args).run(args)
 
 
-if __name__ == '__main__':
-    opts = parse_opts('job_retry', globals())
-    yaml_configs = opts.get_yaml_configs() or 'config'
+if __name__ == "__main__":
+    opts = parse_opts("job_retry", globals())
+    yaml_configs = opts.get_yaml_configs() or "config"
     configs = kernelci.config.load(yaml_configs)
     status = opts.command(configs, opts)
     sys.exit(0 if status is True else 1)

src/kernelci_pipeline/email_sender.py

@@ -7,22 +7,23 @@
 
 """SMTP Email Sender module"""
 
-from email.mime.multipart import MIMEMultipart
 import email
 import email.mime.text
 import os
 import smtplib
+from email.mime.multipart import MIMEMultipart
 
 
 class EmailSender:
     """Class to send email report using SMTP"""
+
     def __init__(self, smtp_host, smtp_port, email_sender, email_recipient):
         self._smtp_host = smtp_host
         self._smtp_port = smtp_port
         self._email_sender = email_sender
         self._email_recipient = email_recipient
-        self._email_user = os.getenv('EMAIL_USER')
-        self._email_pass = os.getenv('EMAIL_PASSWORD')
+        self._email_user = os.getenv("EMAIL_USER")
+        self._email_pass = os.getenv("EMAIL_PASSWORD")
 
     def _smtp_connect(self):
         """Method to create a connection with SMTP server"""
@@ -39,15 +40,15 @@ def _create_email(self, email_subject, email_content):
         sender, and receiver"""
         email_msg = MIMEMultipart()
         email_text = email.mime.text.MIMEText(email_content, "plain", "utf-8")
-        email_text.replace_header('Content-Transfer-Encoding', 'quopri')
-        email_text.set_payload(email_content, 'utf-8')
+        email_text.replace_header("Content-Transfer-Encoding", "quopri")
+        email_text.set_payload(email_content, "utf-8")
         email_msg.attach(email_text)
         if isinstance(self._email_recipient, list):
-            email_msg['To'] = ','.join(self._email_recipient)
+            email_msg["To"] = ",".join(self._email_recipient)
         else:
-            email_msg['To'] = self._email_recipient
-        email_msg['From'] = self._email_sender
-        email_msg['Subject'] = email_subject
+            email_msg["To"] = self._email_recipient
+        email_msg["From"] = self._email_sender
+        email_msg["Subject"] = email_subject
         return email_msg
 
     def _send_email(self, email_msg):
@@ -59,7 +60,5 @@ def _send_email(self, email_msg):
 
     def create_and_send_email(self, email_subject, email_content):
         """Method to create and send email"""
-        email_msg = self._create_email(
-            email_subject, email_content
-        )
+        email_msg = self._create_email(email_subject, email_content)
         self._send_email(email_msg)