Add tests (#14)

Author: wnojopra

.github/workflows/test.yml

@@ -0,0 +1,51 @@
+# .github/workflows/python-tests.yml
+
+# A descriptive name for your workflow
+name: Run Python Tests
+
+# This section defines when the workflow will run
+on:
+  # Run on pushes to the main branch
+  push:
+    branches: [ main ]
+  # Run on pull requests that target the main branch
+  pull_request:
+    branches: [ main ]
+
+# This section defines the actual work to be done
+jobs:
+  # We define a single job called "build"
+  build:
+    # Use the latest version of Ubuntu as the operating system for our runner
+    runs-on: ubuntu-latest
+    
+    # This strategy will run the job against multiple Python versions
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+    # These are the sequential steps the job will perform
+    steps:
+      # Step 1: Check out your repository code so the workflow can access it
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      # Step 2: Set up the specific version of Python from our matrix
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      # Step 3: Install dependencies
+      # This step should mirror your local setup instructions
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+          pip install -e .
+      
+      # Step 4: Run pytest
+      # We use "python -m pytest" to ensure pathing is handled correctly
+      - name: Run tests with pytest
+        run: |
+          python -m pytest

README.md

@@ -54,6 +54,7 @@ source venv/bin/activate
 
 # This installs the project dependcies into venv Python
 pip install -r requirements.txt
+pip install -e .
 ```
 
 Once you have activated the virtual environment and installed requirements, you can run the below commands to run the simulation and backend service. 
@@ -81,6 +82,11 @@ uvicorn app.main:app --host 0.0.0.0 --port 8000 --reload
 ```
 Then open: http://localhost:8000/docs for interactive Swagger API.
 
+### 🔍 Run tests
+```bash
+pytest
+```
+
 
 ## ✅ Features
 - Character model with paranoia, goodwill, intrigue, and disallowed locations

engine/simulation.py

@@ -33,33 +33,45 @@ def simulate_day(game_state: GameState):
         print(f"🏁 Game Over — {game_state.game_result.replace('_', ' ').title()}")
     game_state.day += 1
 
-def main():
-    parser = argparse.ArgumentParser(description="Run Tragedy Looper simulation.")
-    parser.add_argument("script_name", help="Name of the script YAML file (without extension)")
-    parser.add_argument("actions_file", help="Name of the actions YAML file (without extension)")
-
-    args = parser.parse_args()
-
-    # Assuming your YAML files live in a folder like 'scripts/' and have a '.yaml' extension
-    script_path = f"scripts/{args.script_name}/script.yaml"
-    actions_path = f"scripts/{args.script_name}/{args.actions_file}.yaml"
-
+def run_full_simulation(script_path: str, actions_path: str) -> GameState:
+    """
+    Runs a full game simulation and returns the final state.
+    This function is designed to be testable.
+    """
     game_state = create_starting_game_state(script_path, actions_path)
+
     while game_state.game_result is None:
         if game_state.day > game_state.days_per_loop:
-            # We've finished a loop. Time to check for victory and reset.
-            check_victory(game_state) # Final check at loop end
+            check_victory(game_state) 
             if game_state.game_result is None:
                 if game_state.loop_count >= game_state.max_loops:
-                    # We've run out of loops, mastermind wins.
-                    print("⏰ The protagonists have run out of time!")
                     game_state.game_result = "mastermind_win"
                 else:
-                    # Reset for the next loop
                     reset_for_new_loop(game_state)
 
         if game_state.game_result is None:
             simulate_day(game_state)
+    
+    # After the loop, do one final check on the very last day's state
+    check_victory(game_state)
+    return game_state
+
+def main():
+    parser = argparse.ArgumentParser(description="Run Tragedy Looper simulation.")
+    parser.add_argument("script_name", help="Name of the script YAML file (without extension)")
+    parser.add_argument("actions_file", help="Name of the actions YAML file (without extension)")
+
+    args = parser.parse_args()
+
+    # Assuming your YAML files live in a folder like 'scripts/' and have a '.yaml' extension
+    script_path = f"scripts/{args.script_name}/script.yaml"
+    actions_path = f"scripts/{args.script_name}/{args.actions_file}.yaml"
+
+    final_state = run_full_simulation(script_path, actions_path)
+    print("\n--- Final Results ---")
+    if final_state.game_result:
+        print(f"🏁 Game Over — {final_state.game_result.replace('_', ' ').title()}")
+    final_state.print_characters()
 
 
 if __name__ == "__main__":

pyproject.toml

@@ -0,0 +1,13 @@
+# pyproject.toml
+
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "disastercycler_engine"
+version = "0.1.0"
+
+# --- ADD THIS SECTION ---
+[tool.setuptools]
+packages = ["engine", "app"]

requirements.txt

@@ -1,4 +1,5 @@
 pyyaml
 fastapi
 uvicorn
-pydantic
+pydantic
+pytest

run_tests.sh

@@ -0,0 +1,3 @@
+#!/bin/bash
+
+pytest

tests/test_scenarios.py

@@ -0,0 +1,22 @@
+from engine.simulation import run_full_simulation
+from engine.models import RoleType
+
+def test_friend_dies_at_end_of_loop():
+    """
+    Tests the scenario where the Friend dies on the last day,
+    resulting in a win for the Mastermind.
+    """
+    # 1. Arrange: Define the input files for this specific scenario
+    script_path = "scripts/testing_roles/script.yaml"
+    actions_path = "scripts/testing_roles/actions_fd.yaml" # You create this file
+    
+    # 2. Act: Run the simulation and get the final state
+    final_state = run_full_simulation(script_path, actions_path)
+    
+    # 3. Assert: Automatically check if the outcome is what we expect
+    assert final_state.game_result == "mastermind_win"
+    
+    # You can add more specific assertions too!
+    friend_char = next(c for c in final_state.characters if c.role == RoleType.FRIEND)
+    assert not friend_char.alive
+    assert RoleType.FRIEND in final_state.revealed_roles