[COM-724] update to python 3.10 (#647)

Author: tolkamps1

.github/workflows/api-ci.yml

@@ -21,13 +21,13 @@ jobs:
       - uses: actions/checkout@v2
       - run: "true"
 
-  linting:
+  api-linting:
     needs: setup-job
     runs-on: ubuntu-24.04
 
     strategy:
       matrix:
-        python-version: [3.9]
+        python-version: ["3.10"]
 
     steps:
       - uses: actions/checkout@v2
@@ -56,7 +56,7 @@ jobs:
         run: |
           make pylint
 
-  testing:
+  api-testing:
     needs: setup-job
     env:
       FLASK_ENV: "testing"
@@ -70,7 +70,7 @@ jobs:
 
     strategy:
       matrix:
-        python-version: [3.9]
+        python-version: ["3.10"]
 
     services:
       postgres:
@@ -81,7 +81,6 @@ jobs:
           POSTGRES_DB: postgres
         ports:
           - 5432:5432
-        # needed because the postgres container does not provide a healthcheck
         options: --health-cmd pg_isready --health-interval 10s --health-timeout 5s --health-retries 5
 
     steps:
@@ -107,26 +106,11 @@ jobs:
         run: |
           make test
 
-      # - name: Sets Codecov branch name
-      #   run: |
-      #     echo "CODECOV_BRANCH=PR_${{github.head_ref}}" >> $GITHUB_ENV
-      #   if: github.event_name == 'pull_request'
-
-      # - name: Upload coverage to Codecov
-      #   uses: codecov/codecov-action@v4
-      #   with:
-      #     flags: compliance-api
-      #     name: codecov-compliance-api
-      #     fail_ci_if_error: true
-      #     verbose: true
-      #     token: ${{ secrets.CODECOV_TOKEN }}
-      #     override_branch: ${{ env.CODECOV_BRANCH }}
-
-  build:
+  api-build:
     runs-on: ubuntu-24.04
     strategy:
       matrix:
-        python-version: [3.9]
+        python-version: ["3.10"]
     name: Build
     steps:
       - uses: actions/checkout@v2

README.md

@@ -4,8 +4,8 @@ This document outlines the setup instructions for both the backend and front-end
 
 ## Backend Setup in WSL
 
-### 1. Install Python 3.12.4
-Ensure Python 3.12.4 is installed in your WSL environment. Download it from the [official Python website](https://www.python.org/downloads/release/python-3124/).
+### 1. Install Python 3.10
+Ensure Python 3.10 is installed in your WSL environment. Download it from the [official Python website](https://www.python.org/downloads/release/python-3124/).
 
 ### 2. Set Up PYTHONPATH
 Add the following line to your `.bashrc` or `.zshrc` file to set the `PYTHONPATH` environment variable:
@@ -29,7 +29,7 @@ make run
 
 ## Backend Setup on Windows
 
-## Step 1: Download the Latest Python Version
+## Step 1: Download the Python 3.10 Version
 
 1. Visit the official Python website: [Python Downloads](https://www.python.org/downloads/)
 2. Download and install the latest version of Python for your operating system.
@@ -79,11 +79,14 @@ make run
 Change to the front-end directory:
 cd compliance-web
 
-### 2. Install Dependencies
+### 2. Requirements
+- [Node.js](https://nodejs.org/en/) 18
+
+### 3. Install Dependencies
 Install necessary npm packages:
 npm install
 
-### 3. Run Development Server
+### 4. Run Development Server
 Launch the development server:
 npm run dev
 

compliance-api/.pylintrc

@@ -53,7 +53,7 @@ persistent=yes
 
 # Minimum Python version to use for version dependent checks. Will default to
 # the version used to run pylint.
-py-version=3.9
+py-version=3.10
 
 # Discover python modules and packages in the file system subtree.
 recursive=yes

compliance-api/Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.9-buster
+FROM python:3.10-buster
 
 USER root
 

compliance-api/README.md

@@ -6,7 +6,7 @@ A compliance Python flask API application to be used as a template.
 
 ### Development Environment
 * Install the following:
-    - [Python](https://www.python.org/)
+    - [Python 3.10](https://www.python.org/)
     - [Docker](https://www.docker.com/)
     - [Docker-Compose](https://docs.docker.com/compose/install/)
 * Install Dependencies
@@ -20,6 +20,33 @@ The development scripts for this application allow customization via an environm
 
 ## Commands
 
+### Database Data
+#### Docker
+1. Get the postgres db backup `.dump` from current `dev` in OpenShift.
+2. Connect to the docker postgres db
+```bash
+psql -h localhost -p <DOCKER_POSTGRES_PORT> -U compliance -d compliance-db
+```
+3. Create the required roles app and doggen:
+```sql
+CREATE ROLE postgres;
+CREATE ROLE docgen;
+CREATE ROLE app WITH
+  LOGIN
+  SUPERUSER
+  CREATEDB
+  CREATEROLE
+  REPLICATION
+  BYPASSRLS;
+```
+4. Restore the db dump
+```bash
+pg_restore -h localhost -U compliance -p <DOCKER_POSTGRES_PORT> -d compliance-db -v <DEV_DB_BACKUP.DUMP>
+```
+
+You should now be able to query the table with the restored data.
+
+
 ### Development
 
 The following commands support various development scenarios and needs.

compliance-api/requirements.txt

@@ -2,7 +2,7 @@
 -r prod.txt
 
 coverage
-pylint==v2.13.8
+pylint==2.13.8
 pylint-flask
 pytest
 pytest-cov

compliance-api/requirements/dev.txt

@@ -12,14 +12,15 @@ python-dotenv
 psycopg2-binary
 marshmallow-sqlalchemy==1.0.0
 marshmallow_enum
+marshmallow==3.18.0
 jsonschema
 requests
 itsdangerous
 werkzeug
 sqlalchemy-utils
 Flask-Caching
 sqlalchemy
-secure
+secure>=1.0.0
 python-dotenv
 requests
 flask_cors

compliance-api/requirements/prod.txt

@@ -64,16 +64,20 @@ good-names=
     id
 
 [pylint]
-ignore=migrations,test
+ignore=migrations,test,venv,htmlcov,.pytest_cache,__pycache__
 max_line_length=120
 notes=FIXME,XXX,TODO
 ignored-modules=flask_sqlalchemy,sqlalchemy,SQLAlchemy,alembic,scoped_session
 ignored-classes=scoped_session
-generated-members=Error # allows dynamically generated member references
+generated-members=Error
 min-similarity-lines=15
-disable=C0301,W0511
+disable=C0301,W0511,R0801,C0114,C0115,C0116,R0902,R0913,R0914,R0915
 load-plugins=pylint_flask
 min-public-methods=1
+jobs=5
+persistent=yes
+reports=no
+score=no
 
 [isort]
 line_length = 120

compliance-api/setup.cfg

@@ -24,22 +24,21 @@
 
 
 # Security Response headers
-csp = (
-    secure.ContentSecurityPolicy()
+secure_headers = secure.Secure(
+    csp=secure.ContentSecurityPolicy()
     .default_src("'self'")
     .script_src("'self' 'unsafe-inline'")
     .style_src("'self' 'unsafe-inline'")
     .img_src("'self' data:")
     .object_src("'self'")
-    .connect_src("'self'")
-)
-
-hsts = secure.StrictTransportSecurity().include_subdomains().preload().max_age(31536000)
-referrer = secure.ReferrerPolicy().no_referrer()
-cache_value = secure.CacheControl().no_store().max_age(0)
-xfo_value = secure.XFrameOptions().deny()
-secure_headers = secure.Secure(
-    csp=csp, hsts=hsts, referrer=referrer, cache=cache_value, xfo=xfo_value
+    .connect_src("'self'"),
+    hsts=secure.StrictTransportSecurity()
+    .include_subdomains()
+    .preload()
+    .max_age(31536000),
+    referrer=secure.ReferrerPolicy().no_referrer(),
+    cache=secure.CacheControl().no_store().max_age(0),
+    xfo=secure.XFrameOptions().deny()
 )
 
 
@@ -111,7 +110,7 @@ def set_secure_headers(response):
         """Set CORS headers for security."""
         # if random.random() < 0.1:  # Only run GC 10% of the time
         #     gc.collect()
-        secure_headers.framework.flask(response)
+        secure_headers.set_headers(response)
         response.headers.add("Cross-Origin-Resource-Policy", "*")
         response.headers["Cross-Origin-Opener-Policy"] = "*"
         response.headers["Cross-Origin-Embedder-Policy"] = "unsafe-none"