Merge pull request #22 from agile-learning-institute/v2_refactor

V2 refactor

Author: FlatBallFlyer

.dockerignore

@@ -51,7 +51,6 @@ Thumbs.db
 
 # Project specific
 tests/
-docs/
 *.egg-info/
 .pytest_cache/
 .coverage

.github/workflows/docker-push.yml

@@ -35,4 +35,4 @@ jobs:
           context: .
           platforms: linux/amd64,linux/arm64
           push: true
-          tags: ghcr.io/agile-learning-institute/stage0_mongodb_api:latest
+          tags: ghcr.io/agile-learning-institute/mongodb_configurator_api:latest

CONTRIBUTING.md

@@ -1,38 +1,45 @@
-# Stage 1: Build stage
-FROM python:3.12-slim as build
+# Use Python 3.12 slim image
+FROM python:3.12-slim
 
-# Set the working directory in the container
-WORKDIR /app
+# Set the working directory
+WORKDIR /opt/mongo_configurator
 
-# Copy the entire context to the container
-COPY . .
+# Install system dependencies
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    gcc \
+    && rm -rf /var/lib/apt/lists/*
 
-# Get the current Git branch and build time
-RUN DATE=$(date +'%Y%m%d-%H%M%S') && \
-    echo "${DATE}" > /app/BUILT_AT
+# Copy dependency files first for better caching
+COPY Pipfile Pipfile.lock ./
 
-# Stage 2: Production stage
-FROM python:3.12-slim
+# Install pipenv
+RUN pip install pipenv
 
-# Set the working directory in the container
-WORKDIR /opt/stage0_mongodb_api
+# Copy application code 
+COPY . .
 
-# Copy the entire source code and the BUILT_AT file from the build stage
-COPY --from=build /app/ /opt/stage0_mongodb_api/
+# Install dependencies
+RUN pipenv install --deploy --system
 
-# Install pipenv and dependencies
-COPY Pipfile Pipfile.lock /opt/stage0_mongodb_api/
-RUN pip install pipenv && pipenv install --deploy --system
+# Create build timestamp
+RUN echo $(date +'%Y%m%d-%H%M%S') > /opt/mongo_configurator/BUILT_AT
 
-# Install Gunicorn for running the Flask app in production
+# Install Gunicorn for production
 RUN pip install gunicorn
 
-# Expose the port the app will run on
+# Create non-root user for security
+RUN useradd --create-home --shell /bin/bash app && \
+    chown -R app:app /opt/mongo_configurator
+
+# Switch to non-root user
+USER app
+
+# Expose the port
 EXPOSE 8081
 
-# Set Environment Variables
-ENV PYTHONPATH=/opt/stage0_mongodb_api/stage0_mongodb_api
-ENV MONGODB_API_PORT=8081
+# Set environment variables
+ENV PYTHONPATH=/opt/mongo_configurator/configurator
+ENV API_PORT=8081
 
-# Command to run the application using Gunicorn 
-CMD exec gunicorn --bind 0.0.0.0:${MONGODB_API_PORT} --timeout 120 --preload stage0_mongodb_api.server:app
+# Command to run the application
+CMD ["gunicorn", "--bind", "0.0.0.0:8081", "--timeout", "10", "--preload", "configurator.server:app"]

Dockerfile

@@ -4,33 +4,27 @@ verify_ssl = true
 name = "pypi"
 
 [scripts]
-local = "sh -c 'PYTHONPATH=$(pwd)/stage0_mongodb_api python3 -m server'"
-debug = "sh -c 'PYTHONPATH=$(pwd)/stage0_mongodb_api LOGGING_LEVEL=DEBUG python3 -m server'"
-batch = "sh -c 'PYTHONPATH=$(pwd)/stage0_mongodb_api AUTO_PROCESS=True EXIT_AFTER_PROCESSING=True LOAD_TEST_DATA=True python3 -m server'"
-test = "sh -c 'PYTHONPATH=$(pwd)/stage0_mongodb_api LOGGING_LEVEL=CRITICAL coverage run -m unittest discover -s ./tests -p \"test_*.py\" -v && echo \"\\n=== COVERAGE REPORT ===\" && coverage report && coverage html'"
-stepci-observability = "stepci run ./tests/stepci/observability.yaml"
-stepci-small = "stepci run ./tests/stepci/small_sample.yaml"
-stepci-large = "stepci run ./tests/stepci/large_sample.yaml"
-db-drop = "python tests/db_util.py drop"
-db-drop-silent = "python tests/db_util.py drop --passphrase DROP_DROWSSAP_YEK"
-db-compare = "python tests/db_util.py compare"
-db-harvest = "python tests/db_util.py harvest"
-build = "docker build --tag ghcr.io/agile-learning-institute/stage0_mongodb_api:latest ."
-service = "sh -c 'pipenv run down && docker compose --profile mongodb up --detach && echo `Visit http://localhost:8082/`'"
-database = "sh -c 'pipenv run down && docker compose --profile mongodb-only up --detach'"
-down = "docker compose down mongodb_spa mongodb_api mongodb"
+local = "sh -c 'PYTHONPATH=$(pwd)/configurator BUILT_AT=Local LOAD_TEST_DATA=True python3 -m server'"
+debug = "sh -c 'PYTHONPATH=$(pwd)/configurator BUILT_AT=Local LOAD_TEST_DATA=True LOGGING_LEVEL=DEBUG python3 -m server'"
+batch = "sh -c 'PYTHONPATH=$(pwd)/configurator AUTO_PROCESS=True EXIT_AFTER_PROCESSING=True LOAD_TEST_DATA=True python3 -m server'"
+test = "sh -c 'PYTHONPATH=$(pwd)/configurator LOGGING_LEVEL=CRITICAL coverage run -m unittest discover -s ./tests -p \"test_*.py\" -v && echo \"\\n=== COVERAGE REPORT ===\" && coverage report && coverage html'"
+stepci = "stepci run ./tests/stepci/workflow.yaml"
+container = "docker build --tag ghcr.io/agile-learning-institute/mongodb_configurator_api:latest ."
+database = "sh -c 'pipenv run down && docker compose --profile mongodb up --detach'"
+api = "sh -c 'pipenv run down && docker compose --profile configurator-api up --detach'"
+service = "sh -c 'pipenv run down && docker compose --profile configurator up --detach && echo `Visit http://localhost:8082/`'"
+down = "docker compose down mongodb configurator_api configurator_spa"
 
 [packages]
 python-dotenv = "*"
 flask = "*"
 prometheus-flask-exporter = "*"
 pymongo = "*"
-stage0-py-utils = "*"
 pyyaml = ">=6.0.1"
-stage0-mongodb-api = {file = ".", editable = true}
 
 [dev-packages]
 coverage = "*"
+pytest = "*"
 
 [requires]
 python_version = "3.12"