Merge pull request #3 from airtai/2-include-static-checks

Add files, scripts and actions for linting and static analysis

.github/workflows/test.yml

@@ -2,8 +2,29 @@ name: CI
 on:  [workflow_dispatch, pull_request, push]
 
 jobs:
-  build:
+  static_analysis:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v4
+        with:
+          python-version: 3.8
+      - name: Install Dependencies and library
+        shell: bash
+        run: |
+          set -ux
+          python -m pip install --upgrade pip
+          pip install -e ".[static-analysis]"
+      - name: Run mypy
+        shell: bash
+        run: mypy app
+
+      - name: Run bandit
+        shell: bash
+        run: bandit -c pyproject.toml -r app
 
+  test:
+    needs: [static_analysis]
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3

.gitignore

@@ -143,6 +143,9 @@ venv.bak/
 .dmypy.json
 dmypy.json
 
+# ruff
+.ruff_cache/
+
 # Pyre type checker
 .pyre/
 

app/application.py

@@ -1,19 +1,23 @@
-from pydantic import BaseModel, Field
 from faststream import FastStream, Logger
 from faststream.kafka import KafkaBroker
+from pydantic import BaseModel, Field
+
 
 class Name(BaseModel):
     name: str = Field(..., description="Name of the person")
 
+
 class Greeting(BaseModel):
     greeting: str = Field(..., description="Greeting message")
 
+
 broker = KafkaBroker("localhost:9092")
 app = FastStream(broker)
 
 to_greetings = broker.publisher("greetings")
 
-@broker.subscriber("names")
+
+@broker.subscriber("names")  # type: ignore
 async def on_names(msg: Name, logger: Logger) -> None:
     result = f"hello {msg.name}"
     greeting = Greeting(greeting=result)

pyproject.toml

@@ -11,6 +11,69 @@ dependencies = [
 ]
 
 [project.optional-dependencies]
-dev = [
+lint = [
+    "black==23.9.1",
+    "ruff==0.0.291",
+    "pyupgrade-directories",
+]
+
+static-analysis = [
+    "types-PyYAML",
+    "types-setuptools",
+    "types-ujson",
+    "mypy==1.5.1",
+    "bandit==1.7.5",
+]
+
+testing = [
     "faststream[kafka, testing]>=0.1.3",
 ]
+
+dev = ["app[lint,static-analysis,testing]"]
+
+[tool.mypy]
+strict = true
+python_version = "3.8"
+ignore_missing_imports = true
+install_types = true
+non_interactive = true
+
+# from https://blog.wolt.com/engineering/2021/09/30/professional-grade-mypy-configuration/
+disallow_untyped_defs = true
+no_implicit_optional = true
+check_untyped_defs = true
+warn_return_any = true
+show_error_codes = true
+warn_unused_ignores = true
+
+disallow_incomplete_defs = true
+disallow_untyped_decorators = true
+disallow_any_unimported = false
+
+[tool.black]
+line-length = 88
+target-version = ['py38']
+include = '\.pyi?$'
+
+[tool.ruff]
+fix = true
+line-length = 88
+target-version = "py38"
+select = [
+    "E",  # pycodestyle errors
+    "W",  # pycodestyle warnings
+    "F",  # pyflakes
+    "I",  # isort
+    "C",  # flake8-comprehensions
+    "B",  # flake8-bugbear
+    "Q",  # flake8-quotes
+]
+ignore = [
+    "E501",  # line too long, handled by black
+    "C901",  # too complex
+]
+
+[tool.ruff.pydocstyle]
+convention = "google"
+
+[tool.bandit]

scripts/lint.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+echo "Running pyup_dirs..."
+pyup_dirs --py38-plus --recursive app tests
+
+echo "Running ruff..."
+ruff app tests --fix
+
+echo "Running black..."
+black app tests

scripts/static-analysis.sh

@@ -0,0 +1,8 @@
+#!/bin/bash
+set -e
+
+echo "Running mypy..."
+mypy app
+
+echo "Running bandit..."
+bandit -c pyproject.toml -r app

tests/test_application.py

@@ -1,8 +1,7 @@
 import pytest
-
 from faststream.kafka import TestKafkaBroker
 
-from app.application import Name, Greeting, broker, on_names
+from app.application import Greeting, Name, broker, on_names
 
 
 @broker.subscriber("greetings")