Merge branch 'charles/textual-gs-cli' of github.com:UWOrbital/OBC-firmware into charles/textual-gs-cli

Author: c4bae

.github/workflows/milestone_manager.yml

@@ -0,0 +1,62 @@
+name: Auto Milestone Management
+on:
+  pull_request:
+    branches:
+      - main
+    types:
+      - closed
+
+permissions:
+  issues: write
+  pull-requests: write
+
+jobs:
+  add-milestone:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Add milestone on PR merge
+        if: github.event.pull_request.merged == true
+        uses: actions/github-script@v8
+        with:
+          script: |
+            const date = new Date();
+            const month = date.getMonth() + 1;
+            const year = date.getFullYear();
+            const yy = String(year % 100);
+
+            let term;
+            if (month <= 4) term = "W";
+            else if (month >= 9) term = "F";
+            else term = "S";
+
+            const format = yy + term;
+
+            const { data: milestones } = await github.rest.issues.listMilestones({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              state: "open"
+            });
+
+            let milestone = null;
+            for (let i = 0; i < milestones.length; i++) {
+              if (milestones[i].title == format) {
+                milestone = milestones[i];
+                break;
+              }
+            }
+
+            if (!milestone) {
+              const { data: new_milestone } = await github.rest.issues.createMilestone({
+                owner: context.repo.owner,
+                repo: context.repo.repo,
+                title: format
+              });
+              milestone = new_milestone;
+            }
+
+            await github.rest.issues.update({
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              issue_number: context.payload.pull_request.number,
+              milestone: milestone.number
+            });

.github/workflows/pr_stats.yml

@@ -11,7 +11,7 @@ jobs:
         with:
           token: ${{ secrets.ADD_A_PERSONAL_ACCESS_TOKEN }}
           period: 120
-          chats: true
+          charts: true
           disable-links: false
           sort-by: 'REVIEWS'
           organization: 'UWOrbital'

.github/workflows/pytest.yml

@@ -30,6 +30,26 @@ jobs:
         pip install -r requirements.txt
         pip install -e .
 
+    - name: Set up PostgreSQL database
+      run: |
+        sudo service postgresql start
+        sudo -u postgres psql -c "CREATE USER ci_user WITH PASSWORD 'ci_password' SUPERUSER;"
+        sudo -u postgres psql -c "CREATE DATABASE gs;"
+
+    - name: Create CI .env file
+      run: |
+        cat > .env << EOF
+        GS_DATABASE_USER=ci_user
+        GS_DATABASE_PASSWORD=ci_password
+        GS_DATABASE_LOCATION=localhost
+        GS_DATABASE_PORT=5432
+        GS_DATABASE_NAME=gs
+        EOF
+
+    - name: Run Alembic migrations
+      run: |
+        alembic upgrade head
+
     - name: Create binary directory
       run: |
         mkdir build_gs
@@ -42,5 +62,11 @@ jobs:
         cmake --build .
 
     - name: Run pytest
+      env:
+        GS_DATABASE_USER: ci_user
+        GS_DATABASE_PASSWORD: ci_password
+        GS_DATABASE_LOCATION: localhost
+        GS_DATABASE_PORT: 5432
+        GS_DATABASE_NAME: gs
       run: |
         python -m pytest

.gitignore

@@ -64,6 +64,7 @@ compile_commands.json
 *.sw?
 
 .env
+.*.env
 *.db
 
 /build*
@@ -102,3 +103,5 @@ lerna-debug.log*
 *dist-ssr
 *.local
 *.vite
+
+.DS_Store

.pre-commit-config.yaml

@@ -9,7 +9,7 @@ repos:
       - id: end-of-file-fixer
         exclude: '((libs|hal)/.*|\.(ts|tsx|css|html|json|md|yaml|yml|ipynb)$)'
       - id: check-added-large-files
-        exclude: "(libs|hal)/.*"
+        exclude: "(libs|hal)/.*|gs/backend/data/resources/callsigns\\.csv$"
   - repo: https://github.com/pre-commit/mirrors-clang-format
     rev: v17.0.6
     hooks:

Dockerfile

@@ -3,7 +3,9 @@ FROM python:3.11-slim
 WORKDIR /app
 COPY requirements.txt /app/
 COPY /gs/backend /app/
+RUN apt-get update && apt-get install -y gcc build-essential
 RUN pip install -r requirements.txt
 EXPOSE 8000
 
-CMD ["fastapi", "run", "gs/backend/main.py"]
+#CMD ["fastapi", "run", "gs/backend/main.py"]
+CMD ["uvicorn", "gs.backend.main:app", "--host", "0.0.0.0", "--port", "8000"]

alembic.ini

@@ -0,0 +1,110 @@
+# A generic, single database configuration.
+
+[alembic]
+# path to migration scripts
+script_location = migrations
+
+# template used to generate migration file names; The default value is %%(rev)s_%%(slug)s
+# Uncomment the line below if you want the files to be prepended with date and time
+# see https://alembic.sqlalchemy.org/en/latest/tutorial.html#editing-the-ini-file
+# for all available tokens
+# file_template = %%(year)d_%%(month).2d_%%(day).2d_%%(hour).2d%%(minute).2d-%%(rev)s_%%(slug)s
+
+# sys.path path, will be prepended to sys.path if present.
+# defaults to the current working directory.
+prepend_sys_path = .
+
+# timezone to use when rendering the date within the migration file
+# as well as the filename.
+# If specified, requires the python-dateutil library that can be
+# installed by adding `alembic[tz]` to the pip requirements
+# string value is passed to dateutil.tz.gettz()
+# leave blank for localtime
+# timezone =
+
+# max length of characters to apply to the
+# "slug" field
+# truncate_slug_length = 40
+
+# set to 'true' to run the environment during
+# the 'revision' command, regardless of autogenerate
+# revision_environment = false
+
+# set to 'true' to allow .pyc and .pyo files without
+# a source .py file to be detected as revisions in the
+# versions/ directory
+# sourceless = false
+
+# version location specification; This defaults
+# to migrations/versions.  When using multiple version
+# directories, initial revisions must be specified with --version-path.
+# The path separator used here should be the separator specified by "version_path_separator" below.
+# version_locations = %(here)s/bar:%(here)s/bat:migrations/versions
+
+# version path separator; As mentioned above, this is the character used to split
+# version_locations. The default within new alembic.ini files is "os", which uses os.pathsep.
+# If this key is omitted entirely, it falls back to the legacy behavior of splitting on spaces and/or commas.
+# Valid values for version_path_separator are:
+#
+# version_path_separator = :
+# version_path_separator = ;
+# version_path_separator = space
+version_path_separator = os  # Use os.pathsep. Default configuration used for new projects.
+
+# set to 'true' to search source files recursively
+# in each "version_locations" directory
+# new in Alembic version 1.10
+# recursive_version_locations = false
+
+# the output encoding used when revision files
+# are written from script.py.mako
+# output_encoding = utf-8
+
+sqlalchemy.url = driver://user:pass@localhost/dbname
+
+
+[post_write_hooks]
+# post_write_hooks defines scripts or Python functions that are run
+# on newly generated revision scripts.  See the documentation for further
+# detail and examples
+
+# format using "black" - use the console_scripts runner, against the "black" entrypoint
+# hooks = black
+# black.type = console_scripts
+# black.entrypoint = black
+# black.options = -l 79 REVISION_SCRIPT_FILENAME
+
+# Logging configuration
+[loggers]
+keys = root,sqlalchemy,alembic
+
+[handlers]
+keys = console
+
+[formatters]
+keys = generic
+
+[logger_root]
+level = WARN
+handlers = console
+qualname =
+
+[logger_sqlalchemy]
+level = WARN
+handlers =
+qualname = sqlalchemy.engine
+
+[logger_alembic]
+level = INFO
+handlers =
+qualname = alembic
+
+[handler_console]
+class = StreamHandler
+args = (sys.stderr,)
+level = NOTSET
+formatter = generic
+
+[formatter_generic]
+format = %(levelname)-5.5s [%(name)s] %(message)s
+datefmt = %H:%M:%S

gs/backend/api/backend_setup.py

@@ -1,4 +1,7 @@
+import logging
+
 from fastapi import FastAPI
+from loguru import logger
 
 from gs.backend.api.middleware.auth_middleware import AuthMiddleware
 from gs.backend.api.middleware.cors_middleware import add_cors_middleware
@@ -9,6 +12,7 @@
 from gs.backend.api.v1.mcc.endpoints.commands import commands_router
 from gs.backend.api.v1.mcc.endpoints.main_commands import main_commands_router
 from gs.backend.api.v1.mcc.endpoints.telemetry import telemetry_router
+from gs.backend.config.config import backend_config
 
 
 def setup_routes(app: FastAPI) -> None:
@@ -32,4 +36,22 @@ def setup_middlewares(app: FastAPI) -> None:
     """Adds the middlewares to the app"""
     add_cors_middleware(app)  # Cors middleware should be added first
     app.add_middleware(AuthMiddleware)
-    app.add_middleware(LoggerMiddleware, excluded_endpoints=[])
+    app.add_middleware(
+        LoggerMiddleware,
+        excluded_endpoints=backend_config.logger_config.excluded_endpoints,
+    )
+
+
+def setup_logging() -> None:
+    """Sets all logs from SQLAlchemy to the custom logger level VERBOSE"""
+    verbose_level = 15  # DEBUG=10, INFO=20
+    logger.level("VERBOSE", no=verbose_level, color="<blue>")
+
+    class SQLAlchemyHandler(logging.Handler):
+        def emit(self, record: logging.LogRecord) -> None:
+            logger.log("VERBOSE", record.getMessage())
+
+    sqlalchemy_logger = logging.getLogger("sqlalchemy.engine")
+    sqlalchemy_logger.setLevel(logging.INFO)
+    sqlalchemy_logger.addHandler(SQLAlchemyHandler())
+    sqlalchemy_logger.propagate = False

gs/backend/api/lifespan.py

@@ -2,16 +2,22 @@
 from contextlib import asynccontextmanager
 
 from fastapi import FastAPI
+from fastapi_cache import FastAPICache
+from fastapi_cache.backends.inmemory import InMemoryBackend
 
 from gs.backend.data.database.engine import get_db_session, setup_database
-from gs.backend.data.resources.utils import add_main_commands
+from gs.backend.data.resources.utils import add_callsigns, add_main_commands
 
 
 @asynccontextmanager
 async def lifespan(_: FastAPI) -> AsyncGenerator[None, None]:
     """Lifecycle event for the FastAPI app."""
+    # Initialize FastAPI Cache (in memory cache)
+    FastAPICache.init(InMemoryBackend())
+
     # Must all the get_db_session each time when pass it into a separate function.
     # Otherwise, will get transaction is inactive error
     setup_database(get_db_session())
     add_main_commands(get_db_session())
+    add_callsigns(get_db_session())
     yield

gs/backend/api/middleware/cors_middleware.py

@@ -1,6 +1,8 @@
 from fastapi import FastAPI
 from fastapi.middleware.cors import CORSMiddleware
 
+from gs.backend.config.config import backend_config
+
 
 def add_cors_middleware(app: FastAPI) -> None:
     """
@@ -10,8 +12,8 @@ def add_cors_middleware(app: FastAPI) -> None:
     """
     app.add_middleware(
         CORSMiddleware,
-        allow_origins=["http://localhost:5173"],
-        allow_credentials=True,
-        allow_methods=["*"],
-        allow_headers=["*"],
+        allow_origins=backend_config.cors_config.allow_origins,
+        allow_credentials=backend_config.cors_config.allow_credentials,
+        allow_methods=backend_config.cors_config.allow_methods,
+        allow_headers=backend_config.cors_config.allow_headers,
     )