Merge pull request #16 from arilivigni/fix-test-run-issues

Fix test run issues

Author: arilivigni

.devcontainer/devcontainer.json

@@ -34,13 +34,11 @@
     "portAttributes": {
       "3000": { // React port attributes
       "label": "octofit-tracker",
-      "requireLocalPort": true,
-      "visibility": "public"
+      "requireLocalPort": true
       },
       "8000": { // Django port attributes
       "label": "octofit-api",
-      "requireLocalPort": true,
-      "visibility": "public"
+      "requireLocalPort": true
       }
     }
 }

.devcontainer/post_create.sh

@@ -7,4 +7,5 @@ echo "deb [ arch=amd64,arm64 ] https://repo.mongodb.org/apt/ubuntu jammy/mongodb
 sudo apt-get update
 sudo apt-get install -y python3-venv
 sudo apt-get install -y mongodb-org
+sudo apt-get install -y mongodb-clients
 sudo cp --force ./.devcontainer/welcome-message.txt /usr/local/etc/vscode-dev-containers/first-run-notice.txt

.devcontainer/post_start.sh

@@ -1,6 +1,100 @@
 #!/bin/bash
-# This script is run after the container is startup.
+# This script is run after the container starts up.
 
-# open ports for Python Django server and React app
-gh cs ports visibility 8000:public -c $CODESPACE_NAME
-gh cs ports visibility 3000:public -c $CODESPACE_NAME
+set -euo pipefail
+
+die() {
+  echo "ERROR: $@" >&2
+  exit 1
+}
+
+# Ensure CODESPACE_NAME is set
+: "${CODESPACE_NAME:?CODESPACE_NAME environment variable not set. This script should be run in a GitHub Codespace environment.}"
+
+# Port visibility setup
+echo "Setting port visibility..."
+gh cs ports visibility 8000:public -c "$CODESPACE_NAME" || die "Failed to set 8000 public"
+gh cs ports visibility 3000:public -c "$CODESPACE_NAME" || die "Failed to set 3000 public"
+
+echo "Preparing MongoDB data dir..."
+sudo mkdir -p /data/db || die "mkdir failed"
+sudo chmod 777 /data/db || die "chmod failed"
+
+LOGFILE=/tmp/mongod.log
+MAX_START_TRIES=3          # How many times to attempt (re)starting mongod
+READY_CHECK_RETRIES=15     # How many readiness checks per start attempt
+READY_CHECK_INTERVAL=1     # Seconds between readiness checks
+is_running() {
+  pgrep -x mongod >/dev/null 2>&1
+}
+
+start_mongod() {
+  if is_running; then
+    echo "mongod already running"
+    return 0
+  fi
+  # Clean old log (keep last one for inspection)
+  > "$LOGFILE"
+  echo "Launching mongod (dbpath=/data/db, log=$LOGFILE)..."
+  mongod --dbpath /data/db --fork --logpath "$LOGFILE"
+}
+
+ready_check() {
+  # Success if log shows ready OR port is open
+  if grep -q "Waiting for connections" "$LOGFILE" 2>/dev/null; then
+    return 0
+  fi
+  if command -v nc >/dev/null 2>&1; then
+    if nc -z 127.0.0.1 27017 2>/dev/null; then
+      return 0
+    fi
+  fi
+  # If mongo/mongosh client exists, try a ping (quietly)
+  if command -v mongosh >/dev/null 2>&1; then
+    mongosh --quiet --eval 'db.runCommand({ping:1})' >/dev/null 2>&1 && return 0 || true
+  elif command -v mongo >/dev/null 2>&1; then
+    mongo --quiet --eval 'db.runCommand({ping:1})' >/dev/null 2>&1 && return 0 || true
+  fi
+  return 1
+}
+
+wait_for_ready() {
+  for ((i=1; i<=READY_CHECK_RETRIES; i++)); do
+    if ready_check; then
+      echo "mongod is ready (after $i checks)."
+      return 0
+    fi
+    sleep "$READY_CHECK_INTERVAL"
+  done
+  return 1
+}
+
+echo "Starting MongoDB with retries..."
+for ((attempt=1; attempt<=MAX_START_TRIES; attempt++)); do
+  echo "Start attempt $attempt/$MAX_START_TRIES"
+  if start_mongod; then
+    if wait_for_ready; then
+      tail -20 "$LOGFILE" || true
+      echo "MongoDB started successfully."
+      break
+    else
+      echo "Readiness check failed for attempt $attempt."
+    fi
+  else
+    echo "mongod launch command failed on attempt $attempt."
+  fi
+
+  if (( attempt == MAX_START_TRIES )); then
+    tail -40 "$LOGFILE" || true
+    die "MongoDB failed to start after $MAX_START_TRIES attempts"
+  fi
+
+  echo "Cleaning up before next attempt..."
+  if is_running; then
+    pkill -x mongod || true
+    sleep 2
+  fi
+done
+
+echo "post_start.sh completed successfully."
+exit 0

.github/instructions/octofit_tracker.instructions.md

@@ -13,17 +13,35 @@ I want to build an Octofit Tracker app that will include the following:
 * Competitive leader board
 * Personalized workout suggestions
 
+## Forwarded ports
+
+- 8000: public
+- 3000: public
+- 27017: private
+
+Do not propose any other ports to forward or to make public
+
+## OctoFit Codespace variable for the API URL
+
+Always set the `OCTOFIT_API_BASE_URL` environment variable to your codespace URL. This will be used in your API endpoints.
+
+```bash
+export OCTOFIT_API_BASE_URL="$CODESPACE_NAME-8000.app.github.dev"
+```
+
 ## OctoFit Tracker App structure
 
 The section defines the OctoFit Tracker App's structure
 
 
 The directory tree for the OctoFit Tracker App
+
+```text
 octofit-tracker/
 ├── backend/
 │   ├── venv/
 └── frontend/
-
+```
 
 ## Python virtual environment and requirements
 

.github/prompts/init-populate-octofit_db.prompt.md

@@ -1,21 +1,28 @@
 ---
 mode: 'agent'
 model: GPT-4.1
-description: 'Initialize and populate the octofit_db database'
+description: 'Setup, configure, and populate the octofit_db database with test data for the Octofit Tracker Django app.'
 ---
 
-- Your task is to create the Django project in octofit-tracker/backend/octofit_tracker directory
-- Activate the Python existing virtual environment octofit_tracker/backend/venv/bin/activate.
-- mongodb-org-shell is already installed
-- use mongosh as the client tool to talk to mongodb
+# Environment Setup
+- Use the existing Python virtual environment in `octofit-tracker/backend/venv`.
+- Do not create a new Python virtual environment.
+- Activate with: `source octofit-tracker/backend/venv/bin/activate`
+- `mongodb-org-shell` is already installed; use `mongosh` to interact with MongoDB.
 
+# Database Initialization & Population
+1. Ensure the MongoDB service is running.
+2. Configure Django in `octofit-tracker/backend/octofit_tracker/settings.py` to connect to the `octofit_db` database using Djongo, with no authentication.
+3. Make sure `octofit_tracker`, `rest_framework`, and `djongo` are in `INSTALLED_APPS`.
+4. Enable CORS in `settings.py` to allow all origins, methods, and headers. Allow all hosts.
+5. Install and configure CORS middleware components.
+6. Run `makemigrations` and `migrate` in the Python virtual environment.
+7. Initialize the `octofit_db` database and create collections for users, teams, activities, leaderboard, and workouts.
+8. Ensure a unique index on the `email` field for the user collection (e.g., `db.users.createIndex({ "email": 1 }, { unique: true })`).
+9. Populate the database with test data for all collections using the Django management command in `octofit-tracker/backend/octofit_tracker/management/commands/populate_db.py` (help message: 'Populate the octofit_db database with test data').
+10. Verify the database and collections were created and populated successfully using `mongosh`.
+11. List the collections in the `octofit_db` database and show sample documents from each.
 
-To init and populate the octofit_db database follow these steps.
-1. Make sure the mongodb service is running.
-2. Initialize the mongodb octofit_db database.
-3. Create a correct table structure for users, teams, activities, leaderboard, and workouts collections.
-4. Make sure there is a unique ID for the primary key for the user collection.
-  ex. db.users.createIndex({ "email": 1 }, { unique: true })
-4. Execute the command for me to create the database.
-5. Verify that the database was created successfully.
-6. List the collections in the octofit_db database.
+# Verification
+- After population, verify with `mongosh` that the `octofit_db` database contains the correct collections and test data.
+- Confirm Django REST API endpoints are available for all collections.

.github/steps/1-preparing.md

@@ -65,7 +65,7 @@ Great work! Let's ask copilot for help starting a branch so we can do some custo
    > ![Static Badge](https://img.shields.io/badge/-Prompt-text?style=flat-square&logo=github%20copilot&labelColor=512a97&color=ecd8ff)
    >
    > ```prompt
-   > Create and publish a new Git branch called build-octofit-app?
+   > Please create and publish a new Git branch called build-octofit-app
    > ```
 
    Copilot agent mode will respond and prompt you to **continue** to execute the command.<br/>

.github/steps/2-application-initial-setup.md

@@ -29,18 +29,6 @@ In this step, we will accomplish the following:
 > - Install the Python requirements from the file created
 >```
 
-### :keyboard: Activity: Let's start and verify MongoDB is running
-
-> ![Static Badge](https://img.shields.io/badge/-Prompt-text?style=flat-square&logo=github%20copilot&labelColor=512a97&color=ecd8ff)
->
-> ```prompt
-> Let's install, start, and verify mongodb-org service for Ubuntu 22.
-> 
-> 1. Start mongo db manually
-> 2. Verify mongodb is running manually
->
->```
-
 1. Now that we have created the app directory structure, setup a Python virtual environment, and Copilot agent mode helped write a `requirements.txt` to install all project dependencies, let's check our changes in to our `build-octofit-app` branch.
 
 1. With our new changes complete, please **commit** and **push** the changes to branch `build-octofit-app`.

.github/steps/3-django-project-setup.md

@@ -33,7 +33,7 @@ In this activity we will leverage a feature in vscode called prompt files. A pro
 > [!IMPORTANT]
 > - Don't start the Python Django app in the way that GitHub Copilot agent mode suggests hit **cancel**.
 
-### :keyboard: Activity: Initialize and create the octofit_db MongoDB database
+### :keyboard: Activity: Initialize, create, and populate the octofit_db MongoDB database
 
 Let's continue to leverage a prompt file that has been created by the IT department for us to initialize and create the octofit_db MongoDB database. Copy/paste the following prompt in the GitHub Copilot Chat and select the "Agent" instead of "Ask" or "Edit" from the drop down where you are inserting the prompt.
 
@@ -53,26 +53,10 @@ Now let's create a prompt file of our own that we can share with other staff to
 > ```prompt
 > Let's add the following to a prompt file called `update-octofit-tracker-app.prompt.md` in the `.github/prompts` directory and add mode: 'agent' and model: GPT-4.1 to the prompt file.
 >
-> ## Use the existing Python virtual environment
->
->  - Use the existing Python virtual environment we already created in directory octofit-tracker/backend/venv.
-> - Do not create a new Python virtual environment as part of this process.
-> source octofit-tracker/backend/venv/bin/activate
->
-> ## Update octofit-tracker/backend/octofit_tracker app files
->
-> 1. Update the octofit-tracker/backend/octofit_tracker/settings.py file to include the MongoDB database connections for octofit_db and djongo with no authentication.
-> 2. Update the octofit-tracker/backend/octofit_tracker/models.py file to include the models for users, teams, activities, leaderboard, and workouts collections.
-> 3. Update the octofit-tracker/backend/octofit_tracker/serializers.py file to include the serializers for users, teams, activities, leaderboard, and workouts collections.
-> 4. Update the octofit-tracker/backend/octofit_tracker/urls.py file to include the URLs for users, teams, activities, leaderboard, and workouts collections.
-> 5. Update the octofit-tracker/backend/octofit_tracker/views.py file to include the views for users, teams, activities, leaderboard, and workouts collections.
-> 6. Update the octofit-tracker/backend/octofit_tracker/tests.py file to include the tests for users, teams, activities, leaderboard, and workouts collections.
-> 7. Update the octofit-tracker/backend/octofit_tracker/admin.py file to include the admin for users, teams, activities, leaderboard, and workouts collections.
-> 8. Make sure api_root is in octofit-tracker/backend/octofit_tracker/urls.py
-> 9. Enable CORS in the octofit-tracker/backend/octofit_tracker/settings.py file to allow cross-origin requests from the frontend React app and allow all origins, methods, and headers.
-> 10. Allow all hosts in the settings.py file.
-> 11. Install CORS middleware components.
-> 12. Make sure there are apps for octofit_tracker, rest_framework, and djongo in the INSTALLED_APPS setting.
+> # Django App Updates
+> 1. Update `settings.py` for MongoDB connection and CORS.
+> 2. Update `models.py`, `serializers.py`, `urls.py`, `views.py`, `tests.py`, and `admin.py` to support users, teams, activities, leaderboard, and workouts collections.
+> 3. Ensure `api_root` is present in `urls.py`.
 > ```
 
 > [!TIP]
@@ -95,29 +79,6 @@ Copy/paste the following prompt in the GitHub Copilot Chat and select the "Agent
 
 > ❕ **Important:** Don't start the Python Django app in the way that GitHub Copilot agent mode suggests hit **cancel**.
 
-### :keyboard: Activity: Populate the octofit_db database with test data from Django project/app files
-
-> ![Static Badge](https://img.shields.io/badge/-Prompt-text?style=flat-square&logo=github%20copilot&labelColor=512a97&color=ecd8ff)
->
-> ```prompt
-> Let's populate the octofit_db database with test data.
->
-> - Create test data for users, teams, activities, leaderboard, and workouts collections.
->
-> - Activate the Python existing virtual environment octofit-tracker/backend/venv/bin/activate.
-> 
-> 1. Run makemigrations and migrate the database in a Python virtual environment.
-> 2. Populate the octofit_db database with test data for users, teams, activities, leaderboard, and workouts collections based on test data in our instructions to octofit-tracker/backend/octofit_tracker/management/commands/populate_db.py.
-> 3. Help message in populate_db.py contains 'Populate the octofit_db database with test data'
-> 4. Verify the test data is populated in the octofit_db database.
->
-> ```
-
-> ❕ **Important:**
-- Don't start the Python Django app in the way that GitHub Copilot agent mode suggests hit **cancel**.
-- If there is no `Continue` button, just pull the left side of the GitHub Copilot Chat panel over to the left, and it should appear.
-- If this doesn't work, you may need to copy and paste the response in the terminal if there is no `Continue` button.
-
 1. Now that we have created the database structure, updated our Django project files, and populated the database, let's check our changes into our `build-octofit-app` branch.
 
 1. With our new changes complete, please **commit** and **push** the changes to GitHub.

.github/steps/4-setup-django-rest-framework.md

@@ -14,20 +14,15 @@ Copy and paste the following prompt(s) in the GitHub Copilot Chat and select the
 > - Keep files created and updated by Copilot agent mode until it is finished.
 > - Agent mode has the ability to evaluate your code base and execute commands and add/refactor/delete parts of your code base and automatically self heal if it or you makes a mistake in the process.
 
-### :keyboard: Activity: Setup Django REST Framework, restart the server, and test the API
-
-> [!NOTE]
-> - Make sure to replace [REPLACE-THIS-WITH-YOUR-CODESPACE-NAME] with your codespace name.
->   - ex. redesigned-spork-g6pj46rr9hpp6x
-> - You can get the codespace name by running the following command in the terminal: `echo $CODESPACE_NAME`.
+### :keyboard: Activity: Setup Django REST Framework and test the REST API endpoints
 
 > ![Static Badge](https://img.shields.io/badge/-Prompt-text?style=flat-square&logo=github%20copilot&labelColor=512a97&color=ecd8ff)
 >
 > ```prompt
 > Let's setup codespace for the URL, start the server via VS Code launch.json, and test the API.
-> 
-> 1. Create an environment variable `OCTOFIT_API_BASE_URL` with the value `[REPLACE-THIS-WITH-YOUR-CODESPACE-NAME]-8000.app.github.dev` for use in your API endpoints in `settings.py`, `urls.py`, and `views.py`.
-> 2. Update `urls.py` to use the value of the environment variable `OCTOFIT_API_BASE_URL` in your REST API URL endpoints (e.g., `https://${OCTOFIT_API_BASE_URL}`) for Django, to avoid certificate HTTPS issues.
+>
+> 1. Create an environment variable OCTOFIT_API_BASE_URL by executing this command in your terminal: `export OCTOFIT_API_BASE_URL="$CODESPACE_NAME-8000.app.github.dev"`
+> 2. Update views.py and urls.py to replace the return for the REST API URL endpoints with the environment variable OCTOFIT_API_BASE_URL https://$OCTOFIT_API_BASE_URL for Django and avoid certificate HTTPS issues.
 > 3. Make sure the Django backend works on your codespace URL (i.e., the value of `OCTOFIT_API_BASE_URL`) by updating `ALLOWED_HOSTS` in `octofit-tracker/backend/octofit_tracker/settings.py`.
 > 4. Test the API endpoints using curl command.
 >```

.github/steps/5-setup-frontend-react-framework.md

@@ -49,7 +49,8 @@ Copy and paste the following prompt(s) in the GitHub Copilot Chat and select the
 > ```prompt
 > Let's update the octofit-tracker frontend React components.
 >
-> - Update the following components to include the React framework to point to the backend API:
+> - Create an environment variable OCTOFIT_API_BASE_URL by executing this command in your terminal: `export OCTOFIT_API_BASE_URL="$CODESPACE_NAME-8000.app.github.dev"`
+> - Update the following components to include the React framework to point to the backend REST API:
 >   - src/App.js
 >   - src/index.js
 >   - src/components/Activities.js
@@ -58,7 +59,7 @@ Copy and paste the following prompt(s) in the GitHub Copilot Chat and select the
 >   - src/components/Users.js
 >   - src/components/Workouts.js
 > - In each component replace the fetch url with the codespace url
->   https://[REPLACE-THIS-WITH-YOUR-CODESPACE-NAME]-8000.app.github.dev/api/<component>
+>   https://{OCTOFIT_API_BASE_URL}/api/<component>
 >   for the Django rest framework backend.
 > - Make sure to use the correct port and protocol http or https.
 > - Update src/App.js to include the main navigation for all components.