project scaffold changes

.github/workflows/strr-api-ci.yaml

@@ -3,18 +3,18 @@ name: STRR API CI
 on:
   pull_request:
     paths:
-      - "api/**"
+      - "strr-api/**"
   workflow_dispatch:
 
 defaults:
   run:
     shell: bash
-    working-directory: ./api
+    working-directory: ./strr-api
 
 jobs:
   strr-api-ci:
     uses: bcgov/bcregistry-sre/.github/workflows/backend-ci.yaml@main
     with:
       app_name: "strr-api"
-      working_directory: "./api"
+      working_directory: "./strr-api"
       codecov_flag: "strrapi"

.gitignore

@@ -156,3 +156,5 @@ htmlcov/
 **/bods_csvs/*
 
 run.sh
+lint.sh
+unit-tests.sh

docker-compose.yml

@@ -27,7 +27,7 @@ services:
           - db
 
   db:
-    image: postgres:latest
+    image: postgres:16
     restart: unless-stopped
     volumes:
       - postgres-data:/var/lib/postgresql/data

strr-api/.env.local

@@ -28,8 +28,8 @@ APP_SETTINGS=dev
 DATABASE_USERNAME=postgres
 DATABASE_PASSWORD=postgres
 DATABASE_NAME=postgres
-DATABASE_HOST=localhost
-DATABASE_PORT=15432
+DATABASE_HOST=db
+DATABASE_PORT=5432
 
 ## TEST DB
 DATABASE_TEST_USERNAME=postgres

strr-api/gunicorn_config.py

@@ -17,8 +17,8 @@
 
 import os
 
-workers = int(os.environ.get('GUNICORN_PROCESSES', '1'))  # pylint: disable=invalid-name
-threads = int(os.environ.get('GUNICORN_THREADS', '1'))  # pylint: disable=invalid-name
+workers = int(os.environ.get("GUNICORN_PROCESSES", "1"))  # pylint: disable=invalid-name
+threads = int(os.environ.get("GUNICORN_THREADS", "1"))  # pylint: disable=invalid-name
 
-forwarded_allow_ips = '*'  # pylint: disable=invalid-name
-secure_scheme_headers = {'X-Forwarded-Proto': 'https'}  # pylint: disable=invalid-name
+forwarded_allow_ips = "*"  # pylint: disable=invalid-name
+secure_scheme_headers = {"X-Forwarded-Proto": "https"}  # pylint: disable=invalid-name

strr-api/pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "strr-api"
-version = "0.2.1"
+version = "0.0.1"
 description = ""
 authors = ["thorwolpert <[email protected]>"]
 license = "BSD 3-Clause"
@@ -18,13 +18,14 @@ sql-versioning = { git = "https://github.com/bcgov/lear.git", subdirectory = "py
 sentry-sdk = "^1.24.0"
 flask-babel = "^4.0.0"
 flask-cors = "^4.0.0"
-flask-jwt-oidc = "^0.3.0"
+flask-jwt-oidc = "0.6.0"
 gunicorn = "^21.2.0"
 jsonschema = {extras = ["format"], version = "^4.20.0"}
 pycountry = "^23.12.11"
 psycopg2-binary = "^2.9.9"
 flask-restx = "^1.3.0"
 pytest-env = "^1.1.3"
+coloredlogs = "^15.0.1"
 
 [tool.poetry.group.test.dependencies]
 freezegun = "^1.2.2"

strr-api/src/strr_api/__init__.py

@@ -35,69 +35,89 @@
 
 This module is the API for the Legal Entity system.
 """
+import logging
+import logging.config
 import os
 
+import coloredlogs
 import sentry_sdk
+from flask import Flask
 from flask_cors import CORS
+from flask_migrate import Migrate, upgrade
 from sentry_sdk.integrations.flask import FlaskIntegration
-from flask import Flask
 
 from .common.auth import jwt
 from .common.flags import Flags
 from .common.run_version import get_run_version
 from .config import Config, Production
-from .logging import set_log_level_by_flag, setup_logging
 from .models import db
 from .resources import register_endpoints
-from .services import strr_entity, strr_pay
+from .services import strr_pay
 from .translations import babel
 
-setup_logging(os.path.join(os.path.abspath(os.path.dirname(__file__)), 'logging.conf'))  # important to do this first
+# logging.config.fileConfig(fname=os.path.join(os.path.abspath(os.path.dirname(__file__)), 'logging.conf'))
+logging.basicConfig(level=logging.DEBUG)
+coloredlogs.install()
+logger = logging.getLogger("api")
 
 
 def create_app(environment: Config = Production, **kwargs) -> Flask:
     """Return a configured Flask App using the Factory method."""
     app = Flask(__name__)
     CORS(app)
     app.config.from_object(environment)
+    app.logger.setLevel(logging.DEBUG)
 
     # Configure Sentry
-    if dsn := app.config.get('SENTRY_DSN', None):
+    if dsn := app.config.get("SENTRY_DSN", None):
         sentry_sdk.init(
             dsn=dsn,
             integrations=[FlaskIntegration()],
-            release=f'strr-api@{get_run_version()}',
+            release=f"strr-api@{get_run_version()}",
             send_default_pii=False,
-            environment=app.config.get('POD_NAMESPACE', 'unknown')
+            environment=app.config.get("POD_NAMESPACE", "unknown"),
         )
 
     db.init_app(app)
+
+    if not app.config.get("TESTING", False):
+        Migrate(app, db)
+        logger.info("Running migration upgrade.")
+        with app.app_context():
+            upgrade(directory="migrations", revision="head", sql=False, tag=None)
+
     strr_pay.init_app(app)
-    strr_entity.init_app(app)
     # td is testData instance passed in to support testing
-    td = kwargs.get('ld_test_data', None)
+    td = kwargs.get("ld_test_data", None)
     Flags().init_app(app, td)
     babel.init_app(app)
     register_endpoints(app)
     setup_jwt_manager(app, jwt)
 
     @app.before_request
     def before_request():  # pylint: disable=unused-variable
-        set_log_level_by_flag()
+        flag_name = os.getenv("OPS_LOGGER_LEVEL_FLAG", None)
+        if flag_name:
+            flag_value = Flags.value(flag_name)
+            if (level_name := logging.getLevelName(logging.getLogger().level)) and flag_value != level_name:
+                logger.error("Logger level is %s, setting to %s", level_name, flag_value)
+                logging.getLogger().setLevel(level=flag_value)
 
     @app.after_request
     def add_version(response):  # pylint: disable=unused-variable
         version = get_run_version()
-        response.headers['API'] = f'strr-api/{version}'
+        response.headers["API"] = f"strr-api/{version}"
         return response
 
     return app
 
 
 def setup_jwt_manager(app, jwt_manager):
     """Use flask app to configure the JWTManager to work for a particular Realm."""
+
     def get_roles(a_dict):
-        return a_dict['realm_access']['roles']  # pragma: no cover
-    app.config['JWT_ROLE_CALLBACK'] = get_roles
+        return a_dict["realm_access"]["roles"]  # pragma: no cover
+
+    app.config["JWT_ROLE_CALLBACK"] = get_roles
 
     jwt_manager.init_app(app)

strr-api/src/strr_api/common/auth.py

@@ -34,5 +34,4 @@
 """Bring in the common JWT Manager."""
 from flask_jwt_oidc import JwtManager
 
-
 jwt = JwtManager()  # pylint: disable=invalid-name; lower case name as used by convention in most Flask apps

strr-api/src/strr_api/common/enum.py

@@ -33,8 +33,7 @@
 # POSSIBILITY OF SUCH DAMAGE.
 """Enum Utilities."""
 from enum import auto  # noqa: F401 pylint: disable=W0611
-from enum import Enum
-from enum import EnumMeta
+from enum import Enum, EnumMeta
 from typing import Optional
 
 

strr-api/src/strr_api/common/error.py

@@ -44,8 +44,7 @@
 from werkzeug.exceptions import HTTPException
 from werkzeug.routing import RoutingException
 
-
-logger = logging.getLogger(__name__)
+logger = logging.getLogger("api")
 
 
 def init_app(app):