test: add coverage to docker

Author: lpm0073

.env-example

@@ -1,5 +1,5 @@
 OPENAI_API_KEY=ADD-YOUR-OPENAI_API_KEY-HERE
-ENVIRONMENT=dev
+ENVIRONMENT=local
 DOCKERHUB_USERNAME=ADD-YOUR-DOCKERHUB_USERNAME-HERE
 DOCKERHUB_ACCESS_TOKEN=ADD-YOUR-DOCKERHUB_ACCESS_TOKEN-HERE
 LLM_TOOL_CHOICE=required

.github/actions/tests/pre-commit/action.yml

@@ -22,40 +22,40 @@ runs:
     - name: Check for pre-commit in requirements
       shell: bash
       run: |
-        if ! grep -q "pre-commit" ./requirements/dev.txt; then
-          echo "pre-commit not found in requirements/dev.txt" >&2
+        if ! grep -q "pre-commit" ./requirements/local.txt; then
+          echo "pre-commit not found in requirements/local.txt" >&2
           exit 1
         fi
 
     - name: Check for black in requirements
       shell: bash
       run: |
-        if ! grep -q "black" ./requirements/dev.txt; then
-          echo "black not found in requirements/dev.txt" >&2
+        if ! grep -q "black" ./requirements/local.txt; then
+          echo "black not found in requirements/local.txt" >&2
           exit 1
         fi
 
     - name: Check for flake8 in requirements
       shell: bash
       run: |
-        if ! grep -q "flake8" ./requirements/dev.txt; then
-          echo "flake8 not found in requirements/dev.txt" >&2
+        if ! grep -q "flake8" ./requirements/local.txt; then
+          echo "flake8 not found in requirements/local.txt" >&2
           exit 1
         fi
 
     - name: Check for flake8-coding in requirements
       shell: bash
       run: |
-        if ! grep -q "flake8-coding" ./requirements/dev.txt; then
-          echo "flake8-coding not found in requirements/dev.txt" >&2
+        if ! grep -q "flake8-coding" ./requirements/local.txt; then
+          echo "flake8-coding not found in requirements/local.txt" >&2
           exit 1
         fi
 
     - name: Cache Python dependencies
       uses: actions/cache@v3
       with:
         path: ~/.cache/pip
-        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements/dev.txt') }}
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements/local.txt') }}
         restore-keys: |
           ${{ runner.os }}-pip
 
@@ -68,7 +68,7 @@ runs:
       shell: bash
       run: |
         python -m pip install --upgrade pip
-        pip install -r ./requirements/dev.txt
+        pip install -r ./requirements/local.txt
 
     # see: https://pre-commit.ci/lite.html
     - name: pre-commit ci

.github/workflows/precommitVersionBumps.yml

@@ -66,7 +66,7 @@ jobs:
       - name: Install dependencies
         shell: bash
         run: |
-          pip install -r ./requirements/dev.txt
+          pip install -r ./requirements/local.txt
           pip install -r ./requirements/prod.txt
         env:
           SITE_PACKAGES_PATH: ${{ env.SITE_PACKAGES_PATH }}

Dockerfile

@@ -14,21 +14,31 @@ LABEL maintainer="Lawrence McDaniel <lpm0073@gmail.com>" \
   org.opencontainers.image.documentation="https://FullStackWithLawrence.github.io/agentic-ai-workflow/"
 
 
+# Environment: local, alpha, beta, next, or production
+ARG ENVIRONMENT=local
+ENV ENVIRONMENT=$ENVIRONMENT
+RUN echo "ENVIRONMENT: $ENVIRONMENT"
+
 FROM base AS requirements
 
 # Set the working directory to /app
 WORKDIR /dist
 
 # Copy the current directory contents into the container at /app
 COPY requirements/prod.txt requirements.txt
+COPY requirements/local.txt local.txt
 
 # Set environment variables
-ENV ENVIRONMENT=dev
 ENV PYTHONPATH=/dist
 
 # Install any needed packages specified in requirements.txt
 RUN pip install --no-cache-dir -r requirements.txt
 
+# Install Python dependencies for the local environment for cases where
+# we're going to run python unit tests in the Docker container.
+RUN if [ "$ENVIRONMENT" = "local" ] ; then pip install -r local.txt ; fi
+
+
 FROM requirements AS app
 
 WORKDIR /dist

Makefile

@@ -54,7 +54,7 @@ init-dev:
 	make init && \
 	npm install && \
 	$(ACTIVATE_VENV) && \
-	$(PIP) install -r requirements/dev.txt && \
+	$(PIP) install -r requirements/local.txt && \
 	deactivate && \
 	pre-commit install
 
@@ -72,7 +72,7 @@ clean:
 	rm -rf venv node_modules app/__pycache__ package-lock.json
 
 docker-build:
-	docker build -t ${DOCKERHUB_USERNAME}/${REPO_NAME} .
+	docker build -t ${DOCKERHUB_USERNAME}/${REPO_NAME} . --build-arg ENVIRONMENT=${ENVIRONMENT}
 
 docker-push:
 	source .env && \
@@ -81,7 +81,46 @@ docker-push:
 	docker push ${DOCKERHUB_USERNAME}/${REPO_NAME}:latest
 
 docker-run:
-	docker run -it -e OPENAI_API_KEY=${OPENAI_API_KEY} -e ENVIRONMENT=prod -e MYSQL_HOST=${MYSQL_HOST} -e MYSQL_PORT=${MYSQL_PORT} -e MYSQL_USER=${MYSQL_USER} -e MYSQL_PASSWORD=${MYSQL_PASSWORD} -e MYSQL_DATABASE=${MYSQL_DATABASE} -e MYSQL_CHARSET=${MYSQL_CHARSET} -e LOGGING_LEVEL=${LOGGING_LEVEL} -e LLM_TOOL_CHOICE=${LLM_TOOL_CHOICE} ${DOCKERHUB_USERNAME}/${REPO_NAME}:latest
+	docker run -it -e OPENAI_API_KEY=${OPENAI_API_KEY} \
+		-e ENVIRONMENT=prod \
+		-e MYSQL_HOST=${MYSQL_HOST} \
+		-e MYSQL_PORT=${MYSQL_PORT} \
+		-e MYSQL_USER=${MYSQL_USER} \
+		-e MYSQL_PASSWORD=${MYSQL_PASSWORD} \
+		-e MYSQL_DATABASE=${MYSQL_DATABASE} \
+		-e MYSQL_CHARSET=${MYSQL_CHARSET} \
+		-e LOGGING_LEVEL=${LOGGING_LEVEL} \
+		-e LLM_TOOL_CHOICE=${LLM_TOOL_CHOICE} ${DOCKERHUB_USERNAME}/${REPO_NAME}:latest
+
+docker-test:
+	docker run --rm \
+		-e OPENAI_API_KEY=${OPENAI_API_KEY} \
+		-e ENVIRONMENT=local \
+		-e MYSQL_HOST=${MYSQL_HOST} \
+		-e MYSQL_PORT=${MYSQL_PORT} \
+		-e MYSQL_USER=${MYSQL_USER} \
+		-e MYSQL_PASSWORD=${MYSQL_PASSWORD} \
+		-e MYSQL_DATABASE=${MYSQL_DATABASE} \
+		-e MYSQL_CHARSET=${MYSQL_CHARSET} \
+		-e LOGGING_LEVEL=${LOGGING_LEVEL} \
+		-e LLM_TOOL_CHOICE=${LLM_TOOL_CHOICE} \
+		${DOCKERHUB_USERNAME}/${REPO_NAME}:latest \
+		python -m unittest discover -s app/
+
+docker-coverage:
+	docker run --rm \
+		-e OPENAI_API_KEY=${OPENAI_API_KEY} \
+		-e ENVIRONMENT=local \
+		-e MYSQL_HOST=${MYSQL_HOST} \
+		-e MYSQL_PORT=${MYSQL_PORT} \
+		-e MYSQL_USER=${MYSQL_USER} \
+		-e MYSQL_PASSWORD=${MYSQL_PASSWORD} \
+		-e MYSQL_DATABASE=${MYSQL_DATABASE} \
+		-e MYSQL_CHARSET=${MYSQL_CHARSET} \
+		-e LOGGING_LEVEL=${LOGGING_LEVEL} \
+		-e LLM_TOOL_CHOICE=${LLM_TOOL_CHOICE} \
+		${DOCKERHUB_USERNAME}/${REPO_NAME}:latest \
+		/bin/bash -c "python -m coverage run --source=app -m unittest discover -s app/tests && python -m coverage report && python -m coverage xml"
 
 docker-prune:
 	@if [ "`docker ps -aq`" ]; then \
@@ -97,13 +136,14 @@ docker-prune:
 
 help:
 	@echo '===================================================================='
-	@echo 'analyze         - generate code analysis report'
-	@echo 'release         - force a new GitHub release'
-	@echo 'init            - create a Python virtual environment and install prod dependencies'
-	@echo 'init-dev        - install dev dependencies'
-	@echo 'test            - run Python unit tests'
-	@echo 'lint            - run Python linting'
-	@echo 'clean           - destroy the Python virtual environment'
+	@echo 'analyze		 - generate code analysis report'
+	@echo 'release		 - force a new GitHub release'
+	@echo 'init		    - create a Python virtual environment and install prod dependencies'
+	@echo 'init-dev		- install dev dependencies'
+	@echo 'test		    - run Python unit tests'
+	@echo 'lint		    - run Python linting'
+	@echo 'clean		   - destroy the Python virtual environment'
 	@echo 'docker-build    - build the Docker image'
 	@echo 'docker-push     - push the Docker image to DockerHub'
 	@echo 'docker-run      - run the Docker image'
+	@echo 'docker-test     - run the Docker image for testing'

README.md

@@ -44,9 +44,11 @@ python -m app.agent
 This application can also run as a Docker container.
 
 ```console
-make                # initializes a .env file for OPENAI_API_KEY and DOCKERHUB_ACCESS_TOKEN
-make docker-build   # run Docker compose to containerize your application
-make docker-run     # run the application as a Docker container
+make                 # initializes a .env file for OPENAI_API_KEY and DOCKERHUB_ACCESS_TOKEN
+make docker-build    # run Docker compose to containerize your application
+make docker-test     # run all unit tests
+make docker-coverage # run coverage analysis
+make docker-run      # run the application as a Docker container
 ```
 
 Other Docker commands

doc/CONTRIBUTING.md

@@ -27,7 +27,7 @@ A typical pull request will look like the following:
 
 This project uses pre-commit as a first-pass automated code review / QC process. pre-commit runs a multitude of utilities and checks for code formatting, linting, syntax checking, and ensuring that you don't accidentally push something to GitHub which you'd later regret. Broadly speaking, these checks are aimed at minimizing the extent of commits that contain various kinds of defects and stylistic imperfections that don't belong on the main branch of the project.
 
-Note that many of the pre-commit commands are actually executed by Python which in turn is calling pip-installed packages listed in ./requirements/dev.txt located in the root of the repo. It therefore is important that you first create the Python virtual environment using `make api-init`. It also is a good idea to do a complete 'dry run' of pre-commit, to ensure that your developer environment is correctly setup:
+Note that many of the pre-commit commands are actually executed by Python which in turn is calling pip-installed packages listed in ./requirements/local.txt located in the root of the repo. It therefore is important that you first create the Python virtual environment using `make api-init`. It also is a good idea to do a complete 'dry run' of pre-commit, to ensure that your developer environment is correctly setup:
 
 ```console
 git pull

requirements/dev.txt requirements/local.txtrequirements/dev.txt renamed to requirements/local.txt

@@ -19,3 +19,4 @@ bandit==1.8.6
 pydocstringformatter==0.7.5
 tox==4.30.2
 codespell==2.4.1
+coverage==7.11.0

tox.ini

@@ -18,7 +18,7 @@ python =
     3.13: gitlint,py313,flake8,mypy,black,pylint
 
 [testenv]
-deps = -rrequirements/dev.txt
+deps = -rrequirements/local.txt
 commands = pytest
 
 [testenv:flake8]