Merge pull request steam-bell-92#554 from bhavyapandiya29/feature/issue-517-python-ci

feat: Add Python CI Pipeline with automated testing infrastructure

Author: steam-bell-92

.github/workflows/python-ci.yml

@@ -0,0 +1,31 @@
+name: Python CI Pipeline
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+jobs:
+  build-and-test:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+    
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+        
+    - name: Syntax check with py_compile
+      run: |
+        find . -name "*.py" -exec python -m py_compile {} +
+        
+    - name: Run automated tests
+      run: |
+        python -m unittest discover -s tests -v

CONTRIBUTING.md

@@ -447,6 +447,27 @@ These tasks are beginner-friendly and help you understand the project structure,
 
 Once you feel comfortable, you can gradually try `level:intermediate`, `level:advanced`, and `level:critical` tasks.
 
+## 🧪 Writing Tests
+
+To maintain code quality and ensure zero external dependencies, we use the standard library's `unittest` framework.
+
+1. **Test Directory**: All tests must be placed in the `tests/` directory at the root of the project.
+2. **File Naming**: Name your test file starting with `test_` (e.g., `test_armstrong.py`).
+3. **No External Modules**: Do not use external libraries like `pytest`. Stick strictly to `unittest`.
+4. **Mocking Inputs**: For CLI projects, use `subprocess` to provide input via `stdin`, or import helper methods directly.
+
+### Running Tests Locally
+To run all tests and verify your changes:
+```bash
+python -m unittest discover -s tests -v
+```
+To run a syntax check across all files (similar to our CI):
+```bash
+find . -name "*.py" -exec python -m py_compile {} +
+```
+
+---
+
 ## 🤔 Questions?
 
 - 💬 Open an issue for questions

pyproject.toml

@@ -0,0 +1,8 @@
+[project]
+name = "python-mini-project"
+version = "0.1.0"
+description = "A collection of 40+ Python mini projects."
+requires-python = ">=3.10"
+
+[tool.unittest]
+# No special configuration needed, unittest is standard library

tests/__init__.py

@@ -0,0 +1 @@
+# Test suite for python-mini-project

tests/test_armstrong.py

@@ -0,0 +1,42 @@
+import unittest
+import subprocess
+import os
+import sys
+
+class TestArmstrongNumber(unittest.TestCase):
+    def setUp(self):
+        # Path to the Armstrong-Number.py script
+        self.script_path = os.path.join("math", "Armstrong-Number", "Armstrong-Number.py")
+
+    def run_script_with_input(self, user_input):
+        # Run the script as a subprocess and provide input via stdin
+        process = subprocess.Popen(
+            [sys.executable, self.script_path],
+            stdin=subprocess.PIPE,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            text=True
+        )
+        stdout, stderr = process.communicate(input=user_input)
+        return stdout, stderr
+
+    def test_valid_armstrong_number(self):
+        stdout, _ = self.run_script_with_input("153\n")
+        self.assertIn("153 is an Armstrong Number!", stdout)
+
+    def test_invalid_armstrong_number(self):
+        stdout, _ = self.run_script_with_input("154\n")
+        self.assertIn("154 is NOT an Armstrong Number.", stdout)
+
+    def test_invalid_input_handling(self):
+        # The script asks again if input is invalid, so we send invalid then valid
+        stdout, _ = self.run_script_with_input("abc\n153\n")
+        self.assertIn("That doesn't look like a valid number", stdout)
+        self.assertIn("153 is an Armstrong Number!", stdout)
+        
+    def test_negative_input(self):
+        stdout, _ = self.run_script_with_input("-5\n153\n")
+        self.assertIn("Please enter a positive number!", stdout)
+
+if __name__ == "__main__":
+    unittest.main()

tests/test_number_guessing.py

@@ -0,0 +1,36 @@
+import unittest
+import importlib.util
+import os
+import sys
+
+class TestNumberGuessing(unittest.TestCase):
+    def setUp(self):
+        # Load the module dynamically since it has hyphens in the name
+        module_name = "number_guessing"
+        file_path = os.path.join("games", "Number-Guessing-Game", "Number-Guessing-Game.py")
+        
+        spec = importlib.util.spec_from_file_location(module_name, file_path)
+        self.module = importlib.util.module_from_spec(spec)
+        sys.modules[module_name] = self.module
+        spec.loader.exec_module(self.module)
+
+    def test_play_round_with_guesses_win(self):
+        # Test winning exactly on the last attempt
+        won, attempts = self.module.play_round_with_guesses([10, 20, 50], number=50, max_attempts=3)
+        self.assertTrue(won)
+        self.assertEqual(attempts, 3)
+
+    def test_play_round_with_guesses_lose(self):
+        # Test running out of attempts
+        won, attempts = self.module.play_round_with_guesses([10, 20, 30], number=50, max_attempts=3)
+        self.assertFalse(won)
+        self.assertEqual(attempts, 3)
+
+    def test_play_round_with_guesses_win_early(self):
+        # Test winning before max attempts are reached
+        won, attempts = self.module.play_round_with_guesses([50, 60, 70], number=50, max_attempts=5)
+        self.assertTrue(won)
+        self.assertEqual(attempts, 1)
+
+if __name__ == "__main__":
+    unittest.main()

tests/test_typing_speed.py

@@ -0,0 +1,34 @@
+import unittest
+import subprocess
+import os
+import sys
+
+class TestTypingSpeed(unittest.TestCase):
+    def setUp(self):
+        self.script_path = os.path.join("utilities", "Typing-Speed-Tester", "Typing-Speed-Tester.py")
+
+    def run_script_with_input(self, user_input):
+        process = subprocess.Popen(
+            [sys.executable, self.script_path],
+            stdin=subprocess.PIPE,
+            stdout=subprocess.PIPE,
+            stderr=subprocess.PIPE,
+            text=True
+        )
+        stdout, stderr = process.communicate(input=user_input)
+        return stdout, stderr
+
+    def test_typing_speed_script_runs(self):
+        # The script asks to press Enter to start, then waits for the typed text.
+        # We provide a newline to start, and then a dummy text to finish.
+        dummy_input = "\nThis is a test run.\n"
+        stdout, _ = self.run_script_with_input(dummy_input)
+        
+        self.assertIn("WELCOME TO TYPING SPEED TESTER", stdout)
+        self.assertIn("TEST COMPLETED", stdout)
+        self.assertIn("Time Taken", stdout)
+        self.assertIn("Typing Speed", stdout)
+        self.assertIn("Accuracy", stdout)
+
+if __name__ == "__main__":
+    unittest.main()