Containerization working!

Author: Mike Storey

.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

Dockerfile

@@ -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"]

Pipfile

@@ -8,12 +8,11 @@ local = "sh -c 'PYTHONPATH=$(pwd)/configurator BUILT_AT=Local LOAD_TEST_DATA=Tru
 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-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"
-build = "docker build --tag ghcr.io/agile-learning-institute/mongodb_configurator_api:latest ."
-service = "sh -c 'pipenv run down && docker compose --profile configurator up --detach && echo `Visit http://localhost:8082/`'"
+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]
@@ -22,7 +21,6 @@ flask = "*"
 prometheus-flask-exporter = "*"
 pymongo = "*"
 pyyaml = ">=6.0.1"
-configurator = {file = ".", editable = true}
 
 [dev-packages]
 coverage = "*"

Pipfile.lock

@@ -9,7 +9,7 @@ This project builds a the [MongoDB Configurator](https://github.com/agile-learni
 - [Python](https://www.python.org/downloads/) 3.12 or later
 - [Pipenv](https://pipenv.pypa.io/en/latest/installation.html)
 - [Docker Desktop](https://github.com/agile-learning-institute/stage0/tree/main/developer_edition)
-- [MongoDB Compass]() *optional*
+- [MongoDB Compass](https://www.mongodb.com/products/compass) *optional*
 
 ### Quick Start
 ```bash
@@ -47,16 +47,16 @@ pipenv install --dev
 # Run Unit Tests and generate coverage report
 pipenv run test
 
-# Drop the Testing Database - Live - Real Drop Database!!!
-pipenv run drop
-
 #####################
 # Running test server  - uses INPUT_FOLDER setting# 
 pipenv run database     # Start the backing mongo database
 pipenv run local        # Start the server locally
 pipenv run debug        # Start locally with DEBUG logging
 pipenv run batch        # Run locally in Batch mode (process and exit)
 
+# Drop the Testing Database - Live - Real Drop Database!!!
+pipenv run drop
+
 #####################
 # Building and Testing the container (before a PR)
 pipenv run build        # Build the container
@@ -65,10 +65,11 @@ pipenv run service      # Run the DB, API, and SPA containers
 
 pipenv run down         # Stops all testing containers
 
-#####################
-# Black Box Testing #
-pipenv run stepci-observe   # Observability endpoints
-pipenv run stepci-<type>    # [configurations, dictionaries, types, test_data, enumerators]
+################################
+# Black Box Testing with StepCI 
+# https://github.com/stepci/stepci/blob/main/README.md 
+export INPUT_FOLDER=./tests/test_cases/stepci
+pipenv run stepci
 
 ```
 
@@ -116,16 +117,17 @@ tests/
 ├── test_cases/             # Test data 
 │   ├── small_sample/       # Simple test configuration
 │   ├── large_sample/       # Complex test configuration
-│   ├── empty_input/        # Load Error testing
+│   ├── stepci/             # For step ci testing
 │   ├── sample_template/    # Configuration for Template
-│   ├── playground/         # Served with Stack for UI testing
+│   ├── playground/         # Served with Stack for interactive UI testing
 │   ├── .../                # Additional test cases
 ```
-the unit tests TestConfigurationIntegration and TestTypeRendering are integration tests that use the input folders in test_cases. 
+the unit tests TestConfigurationIntegration and TestTypeRendering are integration tests that use the small_sample and large_sample input folders in test_cases. 
 
 ## API Documentation
 
 The complete API documentation with interactive testing is available:
+- [API Server docs/index.html](http://localhost:8081/docs/index.html) if the API is running
 - GoLive on [index.html](./docs/index.html)
 
 The Swagger UI provides:
@@ -149,7 +151,7 @@ curl -X GET http://localhost:8081/api/configurations/
 # Process all configurations
 curl -X POST http://localhost:8081/api/configurations/
 
-# Clean all types
+# Lock all types
 curl -X PATCH http://localhost:8081/api/types/
 ```
 ---

README.md

@@ -11,12 +11,12 @@ services:
     extra_hosts:
       - "mongodb:127.0.0.1"
     healthcheck:
-      test: echo "try { rs.status() } catch (err) { rs.initiate({_id:'rs0',members:[{_id:0,host:'mongodb:27017'}]}) }" | mongosh --port 27017 --quiet
+      test: echo "db.runCommand('ping')" | mongosh --port 27017 --quiet
       interval: 5s
       timeout: 30s
       start_period: 0s
-      retries: 30
-    command: ["--replSet", "rs0", "--bind_ip_all", "--port", "27017"]
+      retries: 3
+    command: ["--bind_ip_all", "--port", "27017"]
     profiles:
       - mongodb
       - configurator
@@ -38,7 +38,7 @@ services:
       API_PORT: 8081
       SPA_PORT: 8082
     volumes:
-      - ${INPUT_FOLDER:-./tests/test_cases/large_sample}:/input
+      - ${INPUT_FOLDER:-./tests/test_cases/playground}:/input
     depends_on:
       mongodb:
         condition: service_healthy

docker-compose.yaml

@@ -0,0 +1 @@
+Local

tests/test_cases/stepci/api_config/BUILT_AT

@@ -0,0 +1 @@
+true

tests/test_cases/stepci/api_config/ENABLE_DROP_DATABASE

@@ -0,0 +1 @@
+true