Merge pull request #3 from swappsco/feat/smart-tests

feat: add Django smart test detection and configuration options for p…

Author: IUribeSwapps

.dev-hooks.example.yml

@@ -12,6 +12,11 @@ pre-commit:
   # Supports multiple patterns: "*.py, *.js"
   # only_for_files: "*.py"
 
+  # Django smart test detection (default: true)
+  # Warns if modified Python files don't have corresponding tests
+  # This is just a warning, it won't block the commit
+  django_check_tests: true
+
   # Commands to run before commit
   commands:
     # Example: Run linter
@@ -41,9 +46,18 @@ pre-push:
   # Supports multiple patterns separated by comma: "*.py, *.js"
   only_for_files: "*.py"
 
+  # Django smart tests (default: true)
+  # When enabled, runs tests only for modified Django apps instead of all tests
+  # Detects which apps were modified and runs: pytest <app1> <app2> ...
+  django_smart_tests: true
+
+  # Test command for Django smart tests (default: "pytest")
+  django_test_command: "pytest"
+
   # Commands to run before push
   commands:
     # Example: Run tests (only if .py files changed)
+    # Note: If django_smart_tests is enabled, this will be replaced with smart test execution
     - name: "Run Tests"
       run: "pytest"
 

CHANGELOG.md

@@ -5,6 +5,22 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [1.1.0] - 2025-12-19
+
+### Added
+- **Django Smart Tests**: Automatically run tests only for modified Django apps/modules instead of the entire test suite
+  - `pre-push.django_smart_tests`: Enable/disable smart test detection (default: true)
+  - `pre-push.django_test_command`: Configure test command (default: "pytest")
+- **Django Test Detection**: Warn about modified Python files without corresponding tests
+  - `pre-commit.django_check_tests`: Enable/disable test detection warnings (default: true)
+  - Shows warning message but doesn't block the commit
+- **Tag Push Support**: Allow pushing git tags without branch validation in pre-push hook
+- **Detached HEAD Support**: Allow push operations when in detached HEAD state
+
+### Changed
+- ClickUp ID pattern in commit-msg is now disabled by default (kept commented for future use)
+- Simplified commit message format examples (removed ClickUp references from error messages)
+
 ## [1.0.0] - 2025-12-11
 
 ### Added

README.md

@@ -4,10 +4,13 @@ Git hooks for development workflow automation.
 
 ## Features
 
-- **commit-msg**: Validates commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) format (with optional ClickUp ID)
+- **commit-msg**: Validates commit messages follow [Conventional Commits](https://www.conventionalcommits.org/) format
 - **pre-commit**: Runs custom commands (lint, type check, format) from config file
 - **pre-push**: Validates branch naming + runs custom commands (tests) from config file
+- **Django Smart Tests**: Run tests only for modified apps/modules instead of all tests
+- **Test Detection**: Warns about modified files without corresponding tests
 - **File filtering**: Only run commands when specific file types are changed
+- **Tag Support**: Allows pushing git tags without validation
 
 ## Installation
 
@@ -23,6 +26,7 @@ pip install -e .
 
 ## Usage
 
+
 ### Install hooks in your repository
 
 ```bash
@@ -63,32 +67,35 @@ Validates that commit messages follow Conventional Commits format:
 
 ```
 <type>(<optional-scope>): <description>
-CU-xxxxxxxxx - <type>(<optional-scope>): <description>
 ```
 
 Valid types: `feat`, `fix`, `docs`, `style`, `refactor`, `perf`, `test`, `build`, `ci`, `chore`, `revert`
 
 Examples:
 - `feat: add user authentication`
 - `fix(api): resolve timeout issue`
-- `CU-86b7kybxx - feat: add git hooks`
-- `CU-86b7kybxx - fix(auth): resolve login bug`
+- `docs: update README`
 
 ### pre-commit
 
 Runs custom commands defined in `.dev-hooks.yml` before each commit:
 - Lint checks
 - Type checking
 - Format validation
+- **Django test detection**: Warns if modified Python files don't have corresponding tests (configurable)
 
 ### pre-push
 
-1. **Branch validation** - Validates branch names follow one of these formats:
+1. **Tag support** - Allows pushing git tags without any validation
+
+2. **Branch validation** - Validates branch names follow one of these formats:
    - ClickUp ID: `CU-xxxxxxxxx`
    - Conventional: `<type>/<description>` (e.g., `feat/user-login`, `fix/header-bug`)
    - Special branches: `master`, `main`, `develop`, `staging`, `production`
 
-2. **Custom commands** - Runs commands defined in `.dev-hooks.yml` (tests, build, etc.)
+3. **Django Smart Tests** - Runs tests only for modified apps/modules (configurable)
+
+4. **Custom commands** - Runs commands defined in `.dev-hooks.yml` (tests, build, etc.)
 
 ## Configuration File
 
@@ -147,6 +154,45 @@ If no matching files are found, commands are skipped with a message:
 Skipping pre-push commands (no matching files: *.py)
 ```
 
+### Django Smart Tests
+
+For Django/Python projects, enable smart test features:
+
+```yaml
+pre-commit:
+  # Warn about modified files without tests (default: true)
+  django_check_tests: true
+
+pre-push:
+  # Run tests only for modified apps (default: true)
+  django_smart_tests: true
+  # Test command (default: "pytest")
+  django_test_command: "pytest"
+```
+
+**How it works:**
+
+1. **pre-commit**: Analyzes staged Python files and warns if they don't have corresponding test files (e.g., `test_<filename>.py`). This is just a warning and won't block the commit.
+
+2. **pre-push**: Detects which Django apps/modules were modified and runs tests only for those apps instead of the entire test suite:
+   ```bash
+   # Instead of: pytest
+   # Runs: pytest app1 app2
+   ```
+
+Example output:
+```
+┌──────────────────────────────────────────────────────────────┐
+│  Running Django Smart Tests...                               │
+└──────────────────────────────────────────────────────────────┘
+
+Modified apps: users api payments
+
+▶ Smart Tests
+  pytest users api payments
+  ✔ Passed
+```
+
 ### Docker Support
 
 For dockerized projects, enable docker execution:

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "dev-tools-hooks"
-version = "1.0.0"
+version = "1.1.0"
 description = "Git hooks for development workflow - Conventional Commits, branch naming, and custom commands"
 readme = "README.md"
 license = {text = "MIT"}

src/dev_tools_hooks/hooks/commit-msg

@@ -2,7 +2,6 @@
 
 # Conventional Commits validation hook
 # Valid prefixes: feat, fix, docs, style, refactor, perf, test, build, ci, chore, revert
-# Supports ClickUp ID prefix: CU-xxxxxxxxx - type: description
 
 commit_msg_file=$1
 commit_msg=$(cat "$commit_msg_file")
@@ -14,9 +13,9 @@ types="feat|fix|docs|style|refactor|perf|test|build|ci|chore|revert"
 # Format: type(optional-scope): description
 pattern="^($types)(\(.+\))?: .+"
 
-# Pattern with ClickUp ID prefix
+# Pattern with ClickUp ID prefix (disabled - kept for future use if needed)
 # Format: CU-xxxxxxxxx - type(optional-scope): description
-clickup_pattern="^CU-[a-zA-Z0-9]+ - ($types)(\(.+\))?: .+"
+# clickup_pattern="^CU-[a-zA-Z0-9]+ - ($types)(\(.+\))?: .+"
 
 # Allow merge commits
 merge_pattern="^Merge (branch|pull request|remote-tracking branch) .+"
@@ -29,9 +28,10 @@ if echo "$commit_msg" | grep -qE "$pattern"; then
     exit 0
 fi
 
-if echo "$commit_msg" | grep -qE "$clickup_pattern"; then
-    exit 0
-fi
+# ClickUp pattern validation disabled
+# if echo "$commit_msg" | grep -qE "$clickup_pattern"; then
+#     exit 0
+# fi
 
 # Colors optimized for macOS Terminal
 RED='\x1b[31m'
@@ -53,15 +53,10 @@ echo ""
 echo -e "${WHITE}${BOLD}Your message:${NC}"
 echo -e "  ${DIM}\"${commit_msg}\"${NC}"
 echo ""
-echo -e "${CYAN}${BOLD}Expected formats:${NC}"
-echo ""
-echo -e "  ${WHITE}1. Conventional Commit:${NC}"
-echo -e "     ${GREEN}<type>${NC}${DIM}:${NC} ${WHITE}<description>${NC}"
-echo -e "     ${GREEN}<type>${NC}${DIM}(${NC}${YELLOW}scope${NC}${DIM}):${NC} ${WHITE}<description>${NC}"
+echo -e "${CYAN}${BOLD}Expected format:${NC}"
 echo ""
-echo -e "  ${WHITE}2. With ClickUp ID:${NC}"
-echo -e "     ${MAGENTA}CU-xxxxxxxxx${NC} ${DIM}-${NC} ${GREEN}<type>${NC}${DIM}:${NC} ${WHITE}<description>${NC}"
-echo -e "     ${MAGENTA}CU-xxxxxxxxx${NC} ${DIM}-${NC} ${GREEN}<type>${NC}${DIM}(${NC}${YELLOW}scope${NC}${DIM}):${NC} ${WHITE}<description>${NC}"
+echo -e "  ${GREEN}<type>${NC}${DIM}:${NC} ${WHITE}<description>${NC}"
+echo -e "  ${GREEN}<type>${NC}${DIM}(${NC}${YELLOW}scope${NC}${DIM}):${NC} ${WHITE}<description>${NC}"
 echo ""
 echo -e "${CYAN}${BOLD}Valid types:${NC}"
 echo -e "  ${GREEN}feat${NC}      ${DIM}A new feature${NC}"
@@ -79,7 +74,5 @@ echo ""
 echo -e "${CYAN}${BOLD}Examples:${NC}"
 echo -e "  ${DIM}\$${NC} git commit -m \"${GREEN}feat${NC}: add user authentication\""
 echo -e "  ${DIM}\$${NC} git commit -m \"${GREEN}fix${NC}(${YELLOW}api${NC}): resolve timeout issue\""
-echo -e "  ${DIM}\$${NC} git commit -m \"${MAGENTA}CU-86b7kybxx${NC} - ${GREEN}feat${NC}: add git hooks\""
-echo -e "  ${DIM}\$${NC} git commit -m \"${MAGENTA}CU-86b7kybxx${NC} - ${GREEN}fix${NC}(${YELLOW}auth${NC}): resolve login bug\""
 echo ""
 exit 1

src/dev_tools_hooks/hooks/pre-commit

@@ -124,6 +124,71 @@ has_matching_staged_files() {
     return 1
 }
 
+# ============================================================================
+# Django Test Detection
+# ============================================================================
+
+check_django_tests() {
+    local check_enabled=$(yaml_get "pre-commit.django_check_tests" "$CONFIG_FILE")
+
+    # Default to true if not specified
+    if [ "$check_enabled" = "false" ]; then
+        return 0
+    fi
+
+    # Get staged Python files (excluding tests, migrations, __init__.py)
+    local staged_py_files=$(git diff --cached --name-only --diff-filter=ACMR | grep '\.py$' | grep -v 'test' | grep -v 'migrations' | grep -v '__init__.py' | grep -v 'conftest.py' | grep -v 'setup.py' | grep -v 'manage.py')
+
+    if [ -z "$staged_py_files" ]; then
+        return 0
+    fi
+
+    local missing_tests=()
+
+    while IFS= read -r file; do
+        [ -z "$file" ] && continue
+
+        # Get the directory and filename
+        local dir=$(dirname "$file")
+        local filename=$(basename "$file" .py)
+
+        # Skip if it's already a test file
+        if [[ "$filename" == test_* ]] || [[ "$filename" == *_test ]]; then
+            continue
+        fi
+
+        # Look for corresponding test file
+        local test_file_1="${dir}/test_${filename}.py"
+        local test_file_2="${dir}/tests/test_${filename}.py"
+        local test_file_3="${dir}/${filename}_test.py"
+        local test_file_4="${dir}/tests.py"
+
+        # Check if any test file exists
+        if [ ! -f "$PROJECT_ROOT/$test_file_1" ] && \
+           [ ! -f "$PROJECT_ROOT/$test_file_2" ] && \
+           [ ! -f "$PROJECT_ROOT/$test_file_3" ] && \
+           [ ! -f "$PROJECT_ROOT/$test_file_4" ]; then
+            missing_tests+=("$file")
+        fi
+    done <<< "$staged_py_files"
+
+    if [ ${#missing_tests[@]} -gt 0 ]; then
+        echo ""
+        echo -e "${YELLOW}${BOLD}┌──────────────────────────────────────────────────────────────┐${NC}"
+        echo -e "${YELLOW}${BOLD}│  ⚠ WARNING: Modified files without corresponding tests      │${NC}"
+        echo -e "${YELLOW}${BOLD}└──────────────────────────────────────────────────────────────┘${NC}"
+        echo ""
+        for file in "${missing_tests[@]}"; do
+            echo -e "  ${DIM}•${NC} ${WHITE}${file}${NC}"
+        done
+        echo ""
+        echo -e "${DIM}Consider adding tests for these files.${NC}"
+        echo ""
+    fi
+
+    return 0
+}
+
 # ============================================================================
 # Run Commands from .dev-hooks.yml
 # ============================================================================
@@ -218,5 +283,8 @@ run_commands() {
 # Main
 # ============================================================================
 
+# Check for missing tests (warning only)
+check_django_tests
+
 run_commands
 exit 0