Skip to content

TESTING.md

Latest commit

 

History

History
124 lines (98 loc) · 3.95 KB

TESTING.md

File metadata and controls

124 lines (98 loc) · 3.95 KB
Raw

Testing Documentation

Overview

This document describes the testing strategy and coverage for the Good First Issues project. We use pytest as our testing framework and aim to maintain 100% test coverage across all components.

Test Coverage

Current coverage status (as of latest update):

Name                              Stmts   Miss  Cover
-----------------------------------------------------
app/__init__.py                       0      0   100%
app/core/__init__.py                  0      0   100%
app/core/api_handler.py             112      0   100%
app/core/config.py                   12      0   100%
app/core/custom_exceptions.py        11      0   100%
app/tests/__init__.py                 0      0   100%
app/tests/conftest.py                10      0   100%
app/tests/test_api_handler.py       164      0   100%
app/tests/test_update_issues.py      54      0   100%
app/update_issues.py                 34      0   100%
-----------------------------------------------------
TOTAL                               397      0   100%

Test Structure

1. Core Components Tests (test_api_handler.py)

RepoManager Tests

  • test_extract_number_of_repos: Tests successful repository count extraction
  • test_extract_repos: Tests repository list extraction with pagination
  • test_extract_number_of_repos_error: Tests error handling for missing data
  • test_extract_repos_error: Tests error handling for invalid responses

IssueManager Tests

  • test_extract_issue_data: Tests issue data extraction and formatting
  • test_extract_language: Tests repository language detection
  • test_extract_issues: Tests issue extraction with labels
  • Error handling tests for each method

Utils Tests

  • test_utils_divide_and_round_up: Tests pagination calculation
  • test_utils_create_list_from_lists: Tests list flattening functionality

APIClient Tests

  • test_apiclient_make_request_success: Tests successful API requests
  • test_apiclient_make_request_error: Tests HTTP error handling
  • test_apiclient_make_request_general_error: Tests general error handling

TemplateManager Tests

  • test_format_response: Tests issue grouping by language
  • test_render_template: Tests template rendering with Jinja2

2. Main Script Tests (test_update_issues.py)

  • test_main_flow: Tests the complete workflow
  • test_main_with_no_repos: Tests behavior with no repositories
  • test_main_with_no_issues: Tests behavior with no issues
  • test_main_script_execution: Tests script runtime measurement

Running Tests

To run the test suite:

python -m pytest app/tests/ -v --cov=app

For detailed coverage report:

python -m pytest app/tests/ -v --cov=app --cov-report term-missing

Test Fixtures

Key fixtures (defined in conftest.py):

  • mock_session: Mocks requests.Session for API calls
  • mock_env_vars: Sets up environment variables for testing

Error Testing Strategy

We test various error scenarios:

  1. API errors (404, rate limits, etc.)
  2. Missing or malformed data
  3. File system errors
  4. Environment configuration errors

Maintenance Guidelines

When adding new features:

  1. Maintain 100% coverage for new code
  2. Add tests for both success and error cases
  3. Mock external dependencies
  4. Test edge cases and boundary conditions

When modifying existing code:

  1. Run the test suite to ensure no regressions
  2. Update tests if behavior changes
  3. Add new test cases for bug fixes

Common Testing Patterns

  1. API Mocking:
@patch('app.core.api_handler.APIClient')
def test_function(self, mock_api_client):
    mock_api_instance = MagicMock()
    mock_api_client.return_value = mock_api_instance
    # Test implementation
  1. File Operations:
def test_file_operations(self, tmp_path):
    # Use tmp_path for temporary file creation
    temp_file = tmp_path / "test.txt"
    # Test implementation
  1. Error Handling:
with pytest.raises(ExpectedError):
    # Code that should raise ExpectedError