Merge pull request #3711 from reubenmiller/chore-rf-framework-linting

test: fix system test formatting and linting

Author: reubenmiller

tests/RobotFramework/.pylintrc

@@ -1,3 +1,4 @@
 """thin-edge.io library for Robot Framework"""
+
 # pylint: disable=invalid-name
 from .ThinEdgeIO import ThinEdgeIO

tests/RobotFramework/libraries/ThinEdgeIO/ThinEdgeIO.py

@@ -1 +1 @@
-robotframework-devicelibrary[docker] @ git+https://github.com/thin-edge/robotframework-devicelibrary.git@1.18.0
+robotframework-devicelibrary[docker] @ git+https://github.com/thin-edge/robotframework-devicelibrary.git@1.20.0

tests/RobotFramework/libraries/ThinEdgeIO/__init__.py

@@ -1 +1 @@
-robotframework-devicelibrary[local] @ git+https://github.com/thin-edge/robotframework-devicelibrary.git@1.18.0
+robotframework-devicelibrary[local] @ git+https://github.com/thin-edge/robotframework-devicelibrary.git@1.20.0

tests/RobotFramework/requirements/requirements.adapter-docker.txt

@@ -1,2 +1,2 @@
-robotframework-devicelibrary[ssh] @ git+https://github.com/thin-edge/robotframework-devicelibrary.git@1.18.0
+robotframework-devicelibrary[ssh] @ git+https://github.com/thin-edge/robotframework-devicelibrary.git@1.20.0
 robotframework-sshlibrary~=3.8.0

tests/RobotFramework/requirements/requirements.adapter-local.txt

@@ -1,4 +1,4 @@
-black~=24.4.2
+black~=25.1.0
 invoke~=2.2.0
-pylint~=3.1.0
-robotframework-robocop~=6.1.1
+pylint~=3.3.7
+robotframework-robocop~=6.5.0

tests/RobotFramework/requirements/requirements.adapter-ssh.txt

@@ -1,8 +1,7 @@
-dateparser~=1.2.0
 paho-mqtt~=1.6.1
 python-dotenv~=1.0.0
 robotframework~=7.0.0
-robotframework-c8y @ git+https://github.com/thin-edge/robotframework-c8y.git@0.43.1
+robotframework-c8y @ git+https://github.com/thin-edge/robotframework-c8y.git@0.45.0
 robotframework-aws @ git+https://github.com/thin-edge/robotframework-aws.git@0.0.10
 robotframework-debuglibrary~=2.5.0
 robotframework-jsonlibrary~=0.5

tests/RobotFramework/requirements/requirements.dev.txt

@@ -10,13 +10,14 @@
 import subprocess
 import time
 import datetime
+from typing import Any
 
 import invoke
-from invoke import task
+from invoke.tasks import task
 from dotenv import load_dotenv
 
 
-def using_buildx(c: any, binary: str) -> bool:
+def using_buildx(c: Any, binary: str) -> bool:
     """Detect if docker buildx is being used
 
     Args:
@@ -40,14 +41,14 @@ class ColourFormatter(logging.Formatter):
     red = "\x1b[31;20m"
     bold_red = "\x1b[31;1m"
     reset = "\x1b[0m"
-    format = "%(levelname)-8s %(message)s (%(filename)s:%(lineno)d)"
+    template = "%(levelname)-8s %(message)s (%(filename)s:%(lineno)d)"
 
     FORMATS = {
-        logging.DEBUG: grey + format + reset,
-        logging.INFO: grey + format + reset,
-        logging.WARNING: yellow + format + reset,
-        logging.ERROR: red + format + reset,
-        logging.CRITICAL: bold_red + format + reset,
+        logging.DEBUG: grey + template + reset,
+        logging.INFO: grey + template + reset,
+        logging.WARNING: yellow + template + reset,
+        logging.ERROR: red + template + reset,
+        logging.CRITICAL: bold_red + template + reset,
     }
 
     def format(self, record):
@@ -138,12 +139,7 @@ def is_ci():
     return bool(os.getenv("CI"))
 
 
-@task
-def lint(c):
-    """Run linter"""
-    c.run(f"{sys.executable} -m pylint libraries")
-
-@task
+@task(aliases=["lint"])
 def lint_tests(c, threshold="W"):
     """Run RobotFramework Test Linter and Formatter check
 
@@ -154,18 +150,20 @@ def lint_tests(c, threshold="W"):
     print("Checking formatting of RobotFramework tests...", file=sys.stderr)
     c.run(f"{sys.executable} -m robocop check --threshold {threshold}")
 
-@task(name="format")
-def formatcode(c):
-    """Format python code"""
-    c.run(f"{sys.executable} -m black libraries")
+    print("Checking linting of RobotFramework libraries...", file=sys.stderr)
+    c.run(f"{sys.executable} -m pylint libraries")
 
-@task
+
+@task(aliases=["format"])
 def format_tests(c):
-    """Format RobotFramework tests
-    """
+    """Format RobotFramework tests"""
     print("Formatting of RobotFramework tests...", file=sys.stderr)
     c.run(f"{sys.executable} -m robocop format")
 
+    print("Formatting of RobotFramework libraries...", file=sys.stderr)
+    c.run(f"{sys.executable} -m black .")
+
+
 @task(name="reports")
 def start_server(c, port=9000):
     """Start simple webserver used to display the test reports"""
@@ -281,7 +279,13 @@ def use_local(c, arch="", package_type="deb"):
     },
 )
 def build(
-    c, name="debian-systemd", cache=True, local=True, binary=None, arch="", build_options=""
+    c,
+    name="debian-systemd",
+    cache=True,
+    local=True,
+    binary=None,
+    arch="",
+    build_options="",
 ):
     """Build the container integration test image
 
@@ -394,8 +398,7 @@ def flake_finder(
 
     if os.path.exists(outputdir):
         if not clean:
-            # sys.exit(1)
-            raise invoke.Exit(
+            raise invoke.exceptions.Exit(
                 (
                     "ERROR: Output directory already exists. "
                     f"Please use --clean if you want to remove it. dir={outputdir}"
@@ -425,7 +428,7 @@ def flake_finder(
                 exclude=exclude,
             )
             passed.append(i)
-        except invoke.exceptions.Failure as ex:
+        except invoke.exceptions.Failure:
             failed.append(i)
 
     duration_sec = time.monotonic() - duration_start