Merge pull request #480 from riscv-software-src/pylint

Github workflow to run pylint against debug tests

2 files changed, 24 insertions, 4 deletions

diff --git a/.github/workflows/debug.yml b/.github/workflows/debug.yml
new file mode 100644
index 0000000..29ca5b2
--- /dev/null
+++ b/.github/workflows/debug.yml
@@ -0,0 +1,17 @@
+on: pull_request
+
+name: Check Code Style (checkpatch)
+
+jobs:
+  check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Code
+        uses: actions/checkout@v3
+        with:
+            fetch-depth: 0
+      - name: Install required packages (pip3)
+        run: |
+            pip3 install pylint
+      - name: Run pylint
+        run: make -C debug pylint
diff --git a/debug/testlib.py b/debug/testlib.py
index 171123d..2155e05 100644
--- a/debug/testlib.py
+++ b/debug/testlib.py
@@ -952,14 +952,17 @@ def load_excluded_tests(excluded_tests_file, target_name):
         return result
 
     target_excludes = {}
-    with open(excluded_tests_file) as file:
+    with open(excluded_tests_file, encoding="utf-8") as file:
         raw_data = yaml.safe_load(file)
         for (target, test_list) in raw_data.items():
             if not isinstance(test_list, list):
-                raise ValueError(f"Target {target!r} does not contain a test list", excluded_tests_file, test_list)
+                raise ValueError(
+                        f"Target {target!r} does not contain a test list",
+                        excluded_tests_file, test_list)
             if not all(isinstance(s, str) for s in test_list):
-                raise ValueError(f"Not every element in the target test list {target!r} is a string",
-                                 excluded_tests_file, test_list)
+                raise ValueError(
+                        f"Not every element in the target test list {target!r} "
+                        "is a string", excluded_tests_file, test_list)
 
         target_excludes.update(raw_data)