Merge pull request #497 from DeepWaterExploration/feature/ci-cd-linting

Feature/ci cd linting

Author: brandonhs

.github/ISSUE_TEMPLATE/config.yml

@@ -3,6 +3,3 @@ contact_links:
 - name: 📚 Documentation
   url: https://docs.dwe.ai/
   about: View our Setup Documentation
-- name: 💬 Community Forums
-  url: https://discuss.dwe.ai/
-  about: Join our Forums to ask questions and get help!

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,36 +1,21 @@
-# Description
+## Summary
 
-Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.
+[Explain the *what* and *why* of this PR.]
 
-Fixes #[insert issue number(s) here]
+Fixes #[issue number(s) here]
 
 ## Type of change
 
-Please select all that apply.
+- [ ] Bug fix
+- [ ] Feature / Refactor
+- [ ] Breaking change
+- [ ] Misc.
 
-- [ ] Bug fix (non-breaking change which fixes an issue)
-- [ ] New feature (non-breaking change which adds functionality)
-- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
-- [ ] This change requires a documentation update
-- [ ] Other: [describe here]
+## Quick Checklist
 
-# How Has This Been Tested?
-
-Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
-
-- [ ] Make sure code runs/builds on Linux **[REQUIRED]**
-  - [ ] Code produces no console errors upon launching the software
-- [ ] Other (add any other tests run)
-
-# Checklist:
-
-- [ ] My code follows the style guidelines of this project
-- [ ] I have performed a self-review of my own code
-- [ ] I have added 1 or more reviewers to my pull request
-  - [ ] Reviewer has run the above tests to verify
-- [ ] I have commented my code, particularly in hard-to-understand areas
-- [ ] I have made corresponding changes to the documentation
-- [ ] My changes generate no new warnings
-- [ ] Myself or a reviewer has tested my code to prove my fix is effective or that my feature works
-- [ ] New and existing unit tests pass locally with my changes (if applicable)
-- [ ] Any dependent changes have been merged and published in downstream modules
+- [ ] I have reviewed my own code.
+- [ ] I have tested these changes locally.
+- [ ] I have tested these changes on the following platforms (optional):
+  - [ ] SVC
+  - [ ] microSVC (optional)
+  - [ ] SVC Pro

.github/workflows/backend.yml

@@ -0,0 +1,51 @@
+name: Backend CI
+
+on:
+  # Commented to avoid double runs
+  push:
+    branches:
+      - main
+  #     - "feature/**"
+  #     - "fix/**"
+  #     - "bugfix/**"
+  #     - "refactor/**"
+  #   paths:
+  #     - backend_py/**
+  #     - ".github/workflows/backend.yml"
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+
+    defaults:
+      run:
+        working-directory: ./backend_py
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: | # TODO: switch to using proper dev dependencies
+          sudo apt-get install build-essential libdbus-glib-1-dev libdbus-1-dev libpython3-dev -y # For dbus-python
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install ruff bandit ty # dev dependencies
+
+      - name: Ruff linting
+        run: ruff check --output-format=github .
+
+      - name: Ruff formatting
+        run: ruff format --check .
+
+      - name: Bandit security check (high severity)
+        run: bandit -r . -lll
+
+      - name: Type checking (ty)
+        run: ty check

.github/workflows/frontend.yml

@@ -0,0 +1,47 @@
+name: Frontend CI
+
+on:
+  # Commented to avoid double runs
+  push:
+    branches:
+      - main
+  #     - "feature/**"
+  #     - "fix/**"
+  #     - "bugfix/**"
+  #     - "refactor/**"
+  #   paths:
+  #     - frontend/**
+  #     - ".github/workflows/frontend.yml"
+  pull_request:
+    branches: ["main"]
+
+jobs:
+  Frontend:
+    runs-on: ubuntu-22.04
+
+    defaults:
+      run:
+        working-directory: ./frontend
+
+    steps:
+      - name: "Checkout code"
+        uses: actions/checkout@v6
+
+      - name: "Set up Node.js"
+        uses: actions/setup-node@v6
+        with:
+          node-version: "22"
+          cache: "npm"
+          cache-dependency-path: "./frontend/package-lock.json"
+
+      - name: "Install frontend dependencies"
+        run: npm ci
+
+      - name: "Run frontend linting"
+        run: npm run lint
+
+      - name: "Security audit"
+        run: npm audit --audit-level=high
+
+      - name: "Build frontend"
+        run: npm run build

.github/workflows/main.yml .github/workflows/release.yml.github/workflows/main.yml renamed to .github/workflows/release.yml

@@ -0,0 +1,27 @@
+[tool.ruff]
+line-length = 88
+indent-width = 4
+exclude = ["v4l2.py"] # exclude v4l2.py, since it's included as a lib directly
+
+[tool.ruff.lint]
+select = [
+  # pycodestyle
+  "E",
+  # Pyflakes
+  "F",
+  # pyupgrade
+  "UP",
+  # flake8-bugbear
+  "B",
+  # flake8-simplify
+  "SIM",
+  # isort
+  "I",
+  "ANN2",
+]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"
+
+[tool.ty.rules]

backend_py/pyproject.toml

@@ -1,30 +1,37 @@
-# run.py runs the backend, creating a async socketio server and a FastAPI web framework, then
-# both are passed into a Server instance to handle logic, and a combination of the two is hosted
-# as a uvicorn server, which handles traffic
+# run.py runs the backend, creating a async socketio server and a FastAPI web
+# framework, then
+# both are passed into a Server instance to handle logic, and a combination of the
+# two is hosted as a uvicorn server, which handles traffic
+
+import asyncio
+import logging
+from contextlib import asynccontextmanager
 
-from src import Server, FeatureSupport
 import socketio
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
-import asyncio
-from contextlib import asynccontextmanager
-import logging
+
+from src import FeatureSupport, Server
 
 # TODO: narrow
 ORIGINS = ["*"]
 
 # Use AsyncServer
 sio = socketio.AsyncServer(
-    cors_allowed_origins='*', async_mode="asgi", transports=["websocket"]
+    cors_allowed_origins="*", async_mode="asgi", transports=["websocket"]
 )
 
 
 # Define events
 @asynccontextmanager
-async def lifespan(app: FastAPI):
-    server.serve()
+async def lifespan(app: FastAPI):  # noqa: ANN201
+    await server.serve()
     yield
     print("Shutting down server...")
+    try:
+        server.shutdown()
+    except Exception as e:
+        print(f"Error during shutdown: {e}")
 
 
 # FastAPI application
@@ -44,7 +51,12 @@ async def lifespan(app: FastAPI):
 # Server instance
 # server = Server(FeatureSupport.none(), sio, app, settings_path='.')
 server = Server(
-    FeatureSupport(ttyd=True, wifi=True, serial=True), sio, app, settings_path=".", log_level=logging.DEBUG, is_dev_mode=True
+    FeatureSupport(ttyd=True, wifi=True, serial=True),
+    sio,
+    app,
+    settings_path=".",
+    log_level=logging.DEBUG,
+    is_dev_mode=True,
 )
 
 # Combine FastAPI and Socket.IO ASGI apps
@@ -54,9 +66,8 @@ async def lifespan(app: FastAPI):
 if __name__ == "__main__":
     import uvicorn
 
-    async def main():
-        config = uvicorn.Config(app, host="0.0.0.0",
-                                port=5000, log_level="warning")
+    async def main() -> None:
+        config = uvicorn.Config(app, host="0.0.0.0", port=5000, log_level="warning")
         server = uvicorn.Server(config)
         await server.serve()
 

backend_py/run.py

@@ -1 +1,3 @@
-from .server import *
+from .server import FeatureSupport, Server
+
+__all__ = ["Server", "FeatureSupport"]

backend_py/src/__init__.py

@@ -1,2 +1,4 @@
-from .log_handler import *
-from .log_schemas import *
+from .log_handler import LogHandler
+from .log_schemas import LogSchema
+
+__all__ = ["LogHandler", "LogSchema"]

backend_py/src/logging/__init__.py

@@ -1,27 +1,23 @@
 import logging
+
 import socketio
-from typing import List
+
 from .log_schemas import LogSchema
-import datetime
 
 
 class LogHandler(logging.Handler):
     def __init__(self, sio: socketio.AsyncServer, level: int | str = 0) -> None:
         super().__init__(level)
         self.sio = sio
-        self.logs: List[LogSchema] = []
-        self.to_emit: List[LogSchema] = []
-        self.file_path = self._create_path()
-
-    def _create_path(self):
-        datetime.datetime.now().strftime("%Y-%m-%d--%H-%M-%S.log")
+        self.logs: list[LogSchema] = []
+        self.to_emit: list[LogSchema] = []
 
-    def pop_logs(self):
+    def pop_logs(self) -> list[LogSchema]:
         logs = self.to_emit
         self.to_emit = []
         return logs
 
-    def emit(self, record):
+    def emit(self, record) -> None:
         log = {
             "timestamp": record.asctime,
             "level": record.levelname,