tapps-agents 3.5.40__py3-none-any.whl → 3.6.0__py3-none-any.whl

tapps_agents/experts/knowledge/testing/test-maintenance.md

@@ -1,236 +1,236 @@
-# Test Maintenance Strategies
-
-## Overview
-
-Maintaining tests is crucial for long-term test suite health. This guide covers strategies for keeping tests maintainable, reliable, and valuable.
-
-## Test Maintenance Challenges
-
-### Common Issues
-
-**Test Problems:**
-- Brittle tests that break easily
-- Slow test execution
-- Flaky tests
-- Outdated tests
-- Duplicate tests
-
-### Maintenance Costs
-
-**Factors:**
-- Test execution time
-- Test maintenance effort
-- False positives/negatives
-- Test complexity
-
-## Test Stability
-
-### Reduce Brittleness
-
-**Stable Tests:**
-- Use stable selectors
-- Avoid implementation details
-- Test behavior, not implementation
-- Use abstractions
-
-**Example:**
-```python
-# Brittle: Tests implementation
-def test_user_creation():
-    assert len(User.objects.all()) == 1
-
-# Stable: Tests behavior
-def test_user_creation():
-    user = create_user()
-    assert user.email is not None
-    assert user.is_active is True
-```
-
-### Avoid Flaky Tests
-
-**Common Causes:**
-- Timing issues
-- Race conditions
-- External dependencies
-- Shared state
-
-**Solutions:**
-- Use timeouts appropriately
-- Mock external services
-- Isolate tests
-- Use test doubles
-
-## Test Organization
-
-### Structure Tests
-
-**Organize by Feature:**
-```
-tests/
-├── unit/
-│   ├── test_user.py
-│   └── test_order.py
-├── integration/
-│   ├── test_api.py
-│   └── test_database.py
-└── e2e/
-    └── test_checkout.py
-```
-
-### Test Naming
-
-**Clear Names:**
-```python
-# Good: Clear purpose
-def test_calculate_total_returns_sum_of_items():
-    pass
-
-# Bad: Unclear
-def test_calculate():
-    pass
-```
-
-## Test Refactoring
-
-### Remove Duplication
-
-**DRY Principle:**
-```python
-# Duplicated
-def test_user_login():
-    user = User(email="test@example.com", password="pass")
-    assert login(user.email, "pass") is True
-
-def test_user_logout():
-    user = User(email="test@example.com", password="pass")
-    assert logout(user.id) is True
-
-# Refactored
-@pytest.fixture
-def user():
-    return User(email="test@example.com", password="pass")
-
-def test_user_login(user):
-    assert login(user.email, "pass") is True
-
-def test_user_logout(user):
-    assert logout(user.id) is True
-```
-
-### Simplify Tests
-
-**Keep Tests Simple:**
-```python
-# Complex: Hard to understand
-def test_user_operations():
-    user = User(email="test@example.com")
-    user.save()
-    user.activate()
-    user.add_role("admin")
-    user.save()
-    assert user.is_active is True
-    assert "admin" in user.roles
-
-# Simple: Clear purpose
-def test_user_activation():
-    user = create_user()
-    user.activate()
-    assert user.is_active is True
-```
-
-## Test Performance
-
-### Optimize Slow Tests
-
-**Strategies:**
-- Use test doubles
-- Parallel execution
-- Optimize setup/teardown
-- Separate slow tests
-
-**Example:**
-```python
-# Slow: Real database
-def test_user_operations():
-    user = User.objects.create(email="test@example.com")
-    # ... operations
-
-# Fast: Mock database
-@patch('database.query')
-def test_user_operations(mock_query):
-    mock_query.return_value = User(email="test@example.com")
-    # ... operations
-```
-
-## Test Documentation
-
-### Document Tests
-
-**Clear Documentation:**
-```python
-def test_calculate_total_with_discount():
-    """
-    Test that calculate_total applies discount correctly.
-    
-    Given: Items with total 100 and 10% discount
-    When: calculate_total is called
-    Then: Result should be 90
-    """
-    items = [50, 50]
-    discount = 0.1
-    result = calculate_total(items, discount)
-    assert result == 90
-```
-
-## Test Review
-
-### Regular Reviews
-
-**Review Process:**
-- Review new tests
-- Identify duplicates
-- Find flaky tests
-- Remove obsolete tests
-
-### Test Metrics
-
-**Track:**
-- Test execution time
-- Pass/fail rates
-- Coverage metrics
-- Flaky test detection
-
-## Best Practices
-
-1. **Keep Tests Simple**: One concept per test
-2. **Isolate Tests**: No shared state
-3. **Use Fixtures**: Reusable test data
-4. **Mock External Dependencies**: Isolate units
-5. **Document Tests**: Clear test purpose
-6. **Refactor Regularly**: Remove duplication
-7. **Monitor Performance**: Track test execution time
-8. **Review Tests**: Regular test reviews
-
-## Common Maintenance Tasks
-
-### Regular Tasks
-
-**Ongoing Maintenance:**
-- Update tests with code changes
-- Remove obsolete tests
-- Fix flaky tests
-- Optimize slow tests
-- Improve test coverage
-
-### Test Cleanup
-
-**Remove:**
-- Duplicate tests
-- Obsolete tests
-- Unused fixtures
-- Dead test code
-
-## References
-
-- [Test Maintenance Best Practices](https://www.oreilly.com/library/view/the-art-of-unit/9781449361211/)
-
+# Test Maintenance Strategies
+
+## Overview
+
+Maintaining tests is crucial for long-term test suite health. This guide covers strategies for keeping tests maintainable, reliable, and valuable.
+
+## Test Maintenance Challenges
+
+### Common Issues
+
+**Test Problems:**
+- Brittle tests that break easily
+- Slow test execution
+- Flaky tests
+- Outdated tests
+- Duplicate tests
+
+### Maintenance Costs
+
+**Factors:**
+- Test execution time
+- Test maintenance effort
+- False positives/negatives
+- Test complexity
+
+## Test Stability
+
+### Reduce Brittleness
+
+**Stable Tests:**
+- Use stable selectors
+- Avoid implementation details
+- Test behavior, not implementation
+- Use abstractions
+
+**Example:**
+```python
+# Brittle: Tests implementation
+def test_user_creation():
+    assert len(User.objects.all()) == 1
+
+# Stable: Tests behavior
+def test_user_creation():
+    user = create_user()
+    assert user.email is not None
+    assert user.is_active is True
+```
+
+### Avoid Flaky Tests
+
+**Common Causes:**
+- Timing issues
+- Race conditions
+- External dependencies
+- Shared state
+
+**Solutions:**
+- Use timeouts appropriately
+- Mock external services
+- Isolate tests
+- Use test doubles
+
+## Test Organization
+
+### Structure Tests
+
+**Organize by Feature:**
+```
+tests/
+├── unit/
+│   ├── test_user.py
+│   └── test_order.py
+├── integration/
+│   ├── test_api.py
+│   └── test_database.py
+└── e2e/
+    └── test_checkout.py
+```
+
+### Test Naming
+
+**Clear Names:**
+```python
+# Good: Clear purpose
+def test_calculate_total_returns_sum_of_items():
+    pass
+
+# Bad: Unclear
+def test_calculate():
+    pass
+```
+
+## Test Refactoring
+
+### Remove Duplication
+
+**DRY Principle:**
+```python
+# Duplicated
+def test_user_login():
+    user = User(email="test@example.com", password="pass")
+    assert login(user.email, "pass") is True
+
+def test_user_logout():
+    user = User(email="test@example.com", password="pass")
+    assert logout(user.id) is True
+
+# Refactored
+@pytest.fixture
+def user():
+    return User(email="test@example.com", password="pass")
+
+def test_user_login(user):
+    assert login(user.email, "pass") is True
+
+def test_user_logout(user):
+    assert logout(user.id) is True
+```
+
+### Simplify Tests
+
+**Keep Tests Simple:**
+```python
+# Complex: Hard to understand
+def test_user_operations():
+    user = User(email="test@example.com")
+    user.save()
+    user.activate()
+    user.add_role("admin")
+    user.save()
+    assert user.is_active is True
+    assert "admin" in user.roles
+
+# Simple: Clear purpose
+def test_user_activation():
+    user = create_user()
+    user.activate()
+    assert user.is_active is True
+```
+
+## Test Performance
+
+### Optimize Slow Tests
+
+**Strategies:**
+- Use test doubles
+- Parallel execution
+- Optimize setup/teardown
+- Separate slow tests
+
+**Example:**
+```python
+# Slow: Real database
+def test_user_operations():
+    user = User.objects.create(email="test@example.com")
+    # ... operations
+
+# Fast: Mock database
+@patch('database.query')
+def test_user_operations(mock_query):
+    mock_query.return_value = User(email="test@example.com")
+    # ... operations
+```
+
+## Test Documentation
+
+### Document Tests
+
+**Clear Documentation:**
+```python
+def test_calculate_total_with_discount():
+    """
+    Test that calculate_total applies discount correctly.
+    
+    Given: Items with total 100 and 10% discount
+    When: calculate_total is called
+    Then: Result should be 90
+    """
+    items = [50, 50]
+    discount = 0.1
+    result = calculate_total(items, discount)
+    assert result == 90
+```
+
+## Test Review
+
+### Regular Reviews
+
+**Review Process:**
+- Review new tests
+- Identify duplicates
+- Find flaky tests
+- Remove obsolete tests
+
+### Test Metrics
+
+**Track:**
+- Test execution time
+- Pass/fail rates
+- Coverage metrics
+- Flaky test detection
+
+## Best Practices
+
+1. **Keep Tests Simple**: One concept per test
+2. **Isolate Tests**: No shared state
+3. **Use Fixtures**: Reusable test data
+4. **Mock External Dependencies**: Isolate units
+5. **Document Tests**: Clear test purpose
+6. **Refactor Regularly**: Remove duplication
+7. **Monitor Performance**: Track test execution time
+8. **Review Tests**: Regular test reviews
+
+## Common Maintenance Tasks
+
+### Regular Tasks
+
+**Ongoing Maintenance:**
+- Update tests with code changes
+- Remove obsolete tests
+- Fix flaky tests
+- Optimize slow tests
+- Improve test coverage
+
+### Test Cleanup
+
+**Remove:**
+- Duplicate tests
+- Obsolete tests
+- Unused fixtures
+- Dead test code
+
+## References
+
+- [Test Maintenance Best Practices](https://www.oreilly.com/library/view/the-art-of-unit/9781449361211/)
+