Merge pull request #4 from kosli-dev/tests

Add unit tests for the code-review script

Author: sami-alajrami

.github/workflows/test.yml

@@ -0,0 +1,33 @@
+name: Run Tests
+
+on:
+  push:
+    paths:
+    - 'code-review/**'
+  pull_request:
+    paths:
+    - 'code-review/**'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+      
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.11'
+        
+    - name: Install dependencies
+      run: |
+        cd code-review
+        python -m pip install --upgrade pip
+        pip install -r test_requirements.txt
+        
+    - name: Run tests
+      run: |
+        cd code-review
+        python run_tests.py 

.gitignore

@@ -1,2 +1,14 @@
 .idea/
 .vscode/
+
+# Python virtual environments
+venv/
+**/venv/
+
+# Python cache directories
+__pycache__/
+**/__pycache__/
+
+# Pytest cache
+.pytest_cache/
+**/.pytest_cache/

code-review/Makefile

@@ -0,0 +1,45 @@
+.PHONY: test clean
+
+# Default target
+test: setup-venv install-test-deps run-tests
+
+# Check if we're in a virtual environment and create one if not
+setup-venv:
+	@echo "Checking virtual environment..."
+	@if [ -z "$$VIRTUAL_ENV" ]; then \
+		echo "No virtual environment detected. Creating one..."; \
+		python3 -m venv venv; \
+		echo "Virtual environment created. Please activate it with: source venv/bin/activate"; \
+		echo "Then run 'make test' again."; \
+		exit 1; \
+	else \
+		echo "Virtual environment detected: $$VIRTUAL_ENV"; \
+	fi
+
+# Install test requirements
+install-test-deps:
+	@echo "Installing test requirements..."
+	@pip install -r test_requirements.txt
+
+# Run the tests
+run-tests:
+	@echo "Running tests..."
+	@python run_tests.py
+
+# Clean up generated files
+clean:
+	@echo "Cleaning up..."
+	@find . -type d -name "__pycache__" -exec rm -rf {} + 2>/dev/null || true
+	@find . -type d -name ".pytest_cache" -exec rm -rf {} + 2>/dev/null || true
+	@find . -name "*.pyc" -delete 2>/dev/null || true
+	@echo "Cleanup complete."
+
+# Help target
+help:
+	@echo "Available targets:"
+	@echo "  test        - Setup virtual environment, install dependencies, and run tests"
+	@echo "  setup-venv  - Check/create virtual environment"
+	@echo "  install-test-deps - Install test requirements"
+	@echo "  run-tests   - Run the test suite"
+	@echo "  clean       - Remove Python cache files"
+	@echo "  help        - Show this help message"

code-review/main.py

@@ -106,14 +106,21 @@ def evaluate_attestation(commit_hash, attestation):
         "pass": False,
         "reason": "",
         "attestation_url": attestation.get("html_url", ""),
+        "review_type": "Pull request",
     }
     pr_url = pull_requests[0].get("url", "") if pull_requests else ""
     if pr_url:
         result["pr_url"] = pr_url
-        result["pr_number"] = int(pr_url.split('/')[-1])
+        result["pr_number"] = int(pr_url.split("/")[-1])
         result["review_status"] = pull_requests[0].get("state", "")
-        result["pr_approvers"] = [approver["username"] for approver in pull_requests[0].get("approvers", [])]
-        result["review_type"] = "Pull request"
+        result["pr_approvers"] = sorted(
+            list(
+                {
+                    approver["username"].strip()
+                    for approver in pull_requests[0].get("approvers", [])
+                }
+            )
+        )
 
     git_commit_info = attestation.get("git_commit_info", "")
     if git_commit_info and git_commit_info["sha1"] == commit_hash:
@@ -128,11 +135,11 @@ def evaluate_attestation(commit_hash, attestation):
                 result["commit_timestamp"] = commit.get("timestamp", "")
                 break  # stop after finding the match
 
-
     att_type = attestation.get("attestation_type")
     is_compliant = attestation.get("is_compliant", False)
 
     if att_type == "override":
+        result["review_type"] = "Override"
         if is_compliant:
             result["pass"] = True
             result["reason"] = "Overridden as compliant"
@@ -255,7 +262,9 @@ def report_code_review_attestation(
         return response.json()
     except requests.exceptions.RequestException as e:
         print(f"Error making API request: {e}", file=sys.stderr)
-        print(f"Response: {response.text}", file=sys.stderr)
+        # Only try to access response.text if response exists
+        if "response" in locals():
+            print(f"Response: {response.text}", file=sys.stderr)
         sys.exit(1)
     finally:
         # Ensure the file is closed

code-review/run_tests.py

@@ -0,0 +1,72 @@
+#!/usr/bin/env python3
+"""
+Script to run the unit tests with specific configuration options.
+"""
+
+import subprocess
+import sys
+
+
+def run_tests():
+    """Run the unit tests with specific configuration."""
+
+    # Command line options for pytest
+    pytest_options = [
+        "python3",
+        "-m",
+        "pytest",
+        "test_main.py",  # Test file to run
+        "-v",  # verbose output
+        "--tb=short",  # short traceback format
+        "--maxfail=0",  # Run all tests (don't stop on first failure)
+        "--disable-warnings",  # Suppress warnings
+        "--no-header",  # Don't show pytest header
+        "-s",  # Don't capture output (allows print statements and full error display)
+    ]
+
+    print("Running unit tests ...")
+    print("=" * 60)
+
+    try:
+        result = subprocess.run(pytest_options, check=False)
+        return result.returncode
+    except FileNotFoundError:
+        print("Error: pytest not found. Please install it with: pip install pytest")
+        return 1
+
+
+def run_tests_with_custom_order():
+    """Run tests with explicit ordering using pytest-ordering plugin."""
+
+    pytest_options = [
+        "python3",
+        "-m",
+        "pytest",
+        "test_main.py",
+        "-v",
+        "--tb=short",
+        "--maxfail=0",
+        "--durations=10",
+    ]
+
+    try:
+        result = subprocess.run(pytest_options, check=False)
+        return result.returncode
+    except FileNotFoundError:
+        print("Error: pytest not found. Please install it with: pip install pytest")
+        return 1
+
+
+if __name__ == "__main__":
+    print("Unit Test Runner for evaluate_attestation function")
+    print("=" * 60)
+
+    # Run tests with default configuration
+    exit_code = run_tests()
+
+    if exit_code == 0:
+        print("\n✅ All tests passed!")
+    else:
+        print(f"\n❌ Some tests failed (exit code: {exit_code})")
+
+    sys.exit(exit_code)