This directory contains unit and integration tests for Socket Basics using pytest.

# Setup (first time only)
python3 -m venv venv
source venv/bin/activate
pip install -e ".[dev]"

# Run all tests
pytest

# Run with coverage
pytest --cov=socket_basics

Notes:

• Tests are lightweight and should not require external services.
• Use the local config-wiring script for Jira setup validation: ./venv/bin/python scripts/verify_jira_dashboard_config.py

tests/
├── test_github_helpers.py    # Helper functions for GitHub PR comments
├── test_pr_formatters.py     # PR comment formatter output structure
└── ...                        # Other unit tests

• Test files: test_*.py
• Test functions: test_*
• Test classes: Test*

import pytest
from socket_basics.module import function_to_test

def test_basic_functionality():
    """Test basic functionality with valid input."""
    result = function_to_test("input")
    assert result == "expected_output"

def test_edge_case():
    """Test edge case handling."""
    result = function_to_test("")
    assert result == ""

def test_error_handling():
    """Test error handling."""
    with pytest.raises(ValueError):
        function_to_test(None)

Use test classes to group related tests:

class TestGitHubHelpers:
    """Tests for GitHub helper functions."""

    def test_url_building(self):
        url = build_github_file_url("owner/repo", "abc123", "file.py", 10)
        assert "github.com" in url

    def test_language_detection(self):
        lang = detect_language_from_filename("app.js")
        assert lang == "javascript"

pytest

pytest tests/test_github_helpers.py

pytest tests/test_github_helpers.py::test_detect_language_from_filename

pytest tests/test_github_helpers.py::TestDetectLanguageFromFilename

pytest -v

# Terminal coverage report
pytest --cov=socket_basics tests/

# HTML coverage report
pytest --cov=socket_basics --cov-report=html tests/
open htmlcov/index.html

# Run only fast tests
pytest -m "not slow"

# Run only integration tests
pytest -m integration

Purpose: Test individual functions in isolation Speed: Fast (milliseconds) Dependencies: None (use mocks) Location: tests/test_*.py

Example:

def test_detect_language_from_filename():
    assert detect_language_from_filename('app.js') == 'javascript'
    assert detect_language_from_filename('main.py') == 'python'

Purpose: Test multiple components together Speed: Moderate (seconds) Dependencies: Real configs, but mocked external APIs Location: tests/integration/test_*.py

Example:

def test_formatter_with_config():
    config = create_test_config()
    result = format_notifications(components, config)
    assert len(result) > 0

Use pytest fixtures for common test data:

@pytest.fixture
def mock_config():
    """Provide a mock configuration object."""
    return {
        'repo': 'owner/repo',
        'commit_hash': 'abc123',
        'pr_comment_links_enabled': True
    }

def test_with_config(mock_config):
    result = format_with_config(mock_config)
    assert result is not None

• Keep tests fast and isolated
• Test one thing per test function
• Use descriptive test names
• Test both success and error cases
• Use fixtures for common test data
• Run tests before committing

• Make external API calls (mock them)
• Depend on test execution order
• Use hardcoded paths (use fixtures)
• Test implementation details
• Skip error case testing

Tests run automatically on:

• Every pull request
• Every commit to main branch
• Before releases

GitHub Actions Example:

- name: Run Tests
  run: |
    pip install -e ".[dev]"
    pytest --cov=socket_basics tests/

pytest tests/test_github_helpers.py::test_name -vv -s

pytest --pdb

def test_example():
    result = function()
    print(f"Debug: result = {result}")  # Use -s flag to see output
    assert result == expected

• Target: 80%+ code coverage for new features
• Critical paths: 100% coverage (authentication, security logic)
• Helper functions: 90%+ coverage

Check coverage:

pytest --cov=socket_basics --cov-report=term-missing

For end-to-end testing with real vulnerable applications, see:

• ../app_tests/ - Deliberately vulnerable apps for scanner validation
• ../app_tests/README.md - E2E testing documentation (if it exists)

Test fixtures and sample data should be:

• Small - Minimal data needed for the test
• Realistic - Representative of actual usage
• Self-contained - No external dependencies

Example:

SAMPLE_TRACE = """owasp-goat - server.js 72:12-75:6
  -> express routes/auth.js 45:2"""

def test_trace_parsing():
    result = parse_trace(SAMPLE_TRACE)
    assert len(result) == 2

• See main README.md for project overview
• See docs/ for detailed documentation
• Check existing tests for examples