switch to ruff as linter (#113)

* switch to ruff as linter

* fix licenses and error out in scripts

* align scripts with template

* add timeout

* fix tests, reset changes in generated files

* tests

* fix

Author: MP91

.devcontainer/devcontainer.json

@@ -13,14 +13,21 @@
 		"vscode": {
 			// Set *default* container specific settings.json values on container create.
 			"settings": {
-				"python.pythonPath": "/usr/bin/python3",
 				"python.defaultInterpreterPath": "/usr/bin/python3",
-				"python.disableInstallationCheck": true,
-				"python.linting.enabled": true,
-				"python.formatting.provider": "black",
-				"python.linting.banditEnabled": true,
-				"python.linting.flake8Enabled": true,
-				"editor.defaultFormatter": "ms-python.black-formatter",
+				"python.analysis.typeCheckingMode": "basic",
+				// Strong Type Checker
+				"mypy.enabled": true,
+				"mypy.runUsingActiveInterpreter": true,
+				"python.testing.unittestEnabled": false,
+				"python.testing.pytestEnabled": true,
+				"[python]": {
+					"editor.formatOnSave": true,
+					"editor.codeActionsOnSave": {
+						"source.fixAll": true,
+						"source.organizeImports": true
+					},
+					"editor.defaultFormatter": "charliermarsh.ruff"
+				},
 				"terminal.integrated.defaultProfile.linux": "zsh",
 				"terminal.integrated.profiles.linux": {
 					"zsh": {
@@ -31,17 +38,15 @@
 			// Add the IDs of extensions you want installed when the container is created.
 			"extensions": [
 				"ms-python.python",
-				"dbaeumer.vscode-eslint",
 				"ms-azuretools.vscode-dapr",
 				"ms-azuretools.vscode-docker",
 				"rpdswtk.vsmqtt",
 				"dotjoshjohnson.xml",
 				"ms-kubernetes-tools.vscode-kubernetes-tools",
 				"matangover.mypy",
 				"anweber.vscode-httpyac",
-				"ms-python.black-formatter",
-				"ms-python.isort",
-				"ms-python.flake8"
+				"ms-python.mypy-type-checker",
+				"charliermarsh.ruff"
 			]
 		}
 	},

.pre-commit-config.yaml

@@ -34,7 +34,6 @@ repos:
               .*_pb2_grpc.py
           )$
       - id: check-yaml
-      - id: check-toml
       - id: check-added-large-files
         exclude: >
           (?x)^(
@@ -45,60 +44,16 @@ repos:
           )$
       - id: check-merge-conflict
 
-  - repo: https://github.com/PyCQA/isort
-    rev: 5.12.0
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.1.13
     hooks:
-      - id: isort
-        exclude: >
-          (?x)^(
-              .*_pb2.py|
-              .*_pb2.pyi|
-              .*_pb2_grpc.py|
-              examples/.*|
-              .project-creation/.skeleton/.*
-          )$
-
-  - repo: https://github.com/psf/black
-    rev: 23.9.1
-    hooks:
-      - id: black
-        exclude: >
-          (?x)^(
-              .*_pb2.py|
-              .*_pb2.pyi|
-              .*_pb2_grpc.py|
-              examples/.*
-          )$
-
-  - repo: https://github.com/PyCQA/flake8
-    rev: 6.1.0
-    hooks:
-      - id: flake8
-        exclude: >
-          (?x)^(
-              .*_pb2.py|
-              .*_pb2.pyi|
-              .*_pb2_grpc.py
-          )$
-        additional_dependencies:
-          - flake8-bugbear
-          - flake8-unused-arguments
-
-  - repo: https://github.com/PyCQA/bandit
-    rev: 1.7.5
-    hooks:
-      - id: bandit
-        exclude: >
-            (?x)^(
-                .*_pb2.py|
-                .*_pb2.pyi|
-                .*_pb2_grpc.py
-            )$
-        args: ["--skip=B101"]
-        types_or: [python]
+      - id: ruff
+        args: [--fix, --exclude, "*_pb2.py,*_pb2.pyi,*_pb2_grpc.py,*.log"]
+      - id: ruff-format
+        args: [--exclude, "*_pb2.py,*_pb2.pyi,*_pb2_grpc.py,*.log"]
 
   - repo: https://github.com/pre-commit/mirrors-mypy
-    rev: v1.5.1
+    rev: v1.8.0
     hooks:
       - id: mypy
         exclude: >
@@ -111,17 +66,6 @@ repos:
         language: system
         pass_filenames: false
 
-  - repo: https://github.com/pycqa/pydocstyle
-    rev: 6.3.0
-    hooks:
-      - id: pydocstyle
-        exclude: >
-          (?x)^(
-              .*_pb2.py|
-              .*_pb2.pyi|
-              .*_pb2_grpc.py
-          )$
-
   - repo: https://github.com/Lucas-C/pre-commit-hooks
     rev: v1.5.4
     hooks:

.project-creation/templates/setup.cfg

@@ -1,8 +1,3 @@
-[flake8]
-max-line-length = 88
-max-complexity = 18
-select = B,C,E,F,W,T4,B9,B950
-
 [mypy]
 python_version = 3.10
 warn_unused_configs = True
@@ -18,12 +13,3 @@ files =
 
 [mypy-vehicle_model.proto.*]
 ignore_errors = True
-
-[pydocstyle]
-match = '(?!test_).*\.py'
-
-[isort]
-profile = black
-
-[tool.bandit]
-skips = ["B101"]

.vscode/scripts/ensure-dapr.sh

@@ -12,6 +12,7 @@
 # under the License.
 #
 # SPDX-License-Identifier: Apache-2.0
+set -e
 
 if [ $1 != "DAPR" ]; then
       echo "Don't install dapr ..."

.vscode/scripts/exec-check.sh

@@ -12,6 +12,7 @@
 # under the License.
 #
 # SPDX-License-Identifier: Apache-2.0
+set -e
 
 if [[ "$#" -eq 1 ]]; then
     tput setaf 1; echo "ERROR: To execute script, use VSCODE Tasks: [CTRL+SHIFT+P -> Tasks: Run Tasks -> $1]."

.vscode/scripts/run-feedercan.sh

@@ -12,6 +12,7 @@
 # under the License.
 #
 # SPDX-License-Identifier: Apache-2.0
+set -e
 
 echo "#######################################################"
 echo "### Running FeederCan                               ###"

.vscode/scripts/run-hvacservice.sh

@@ -12,6 +12,7 @@
 # under the License.
 #
 # SPDX-License-Identifier: Apache-2.0
+set -e
 
 echo "#######################################################"
 echo "### Running HVAC Service                            ###"

.vscode/scripts/run-mosquitto.sh

@@ -12,6 +12,7 @@
 # under the License.
 #
 # SPDX-License-Identifier: Apache-2.0
+set -e
 
 echo "#######################################################"
 echo "### Running MQTT Broker                             ###"
@@ -30,4 +31,4 @@ then
     docker container stop $RUNNING_CONTAINER
 fi
 
-docker run -p 1883:1883 -p 9001:9001 $MOSQUITTO_IMAGE:$MOSQUITTO_TAG mosquitto -c /mosquitto-no-auth.conf
+docker run --rm --init --name mqtt-broker -p 1883:1883 -p 9001:9001 --network host $MOSQUITTO_IMAGE:$MOSQUITTO_TAG mosquitto -c /mosquitto-no-auth.conf

.vscode/scripts/run-seatservice.sh

@@ -12,6 +12,7 @@
 # under the License.
 #
 # SPDX-License-Identifier: Apache-2.0
+set -e
 
 echo "#######################################################"
 echo "### Running Seat Service                            ###"

.vscode/scripts/run-vehicledatabroker-cli.sh

@@ -12,6 +12,7 @@
 # under the License.
 #
 # SPDX-License-Identifier: Apache-2.0
+set -e
 
 echo "#######################################################"
 echo "### Running VehicleDataBroker CLI                   ###"