sn-testing

Testing Standards

Analyze Protocol

Before writing tests, evaluate each change with the 3 YES criteria — at least one must be met:

1. Business Logic: Does the change affect business logic?
2. Regression Risk: Is it prone to regression?
3. Complexity: Is it complex enough to benefit from tests?

Do not write useless tests. Quality over quantity.

Testing Strategy by Layer

A. Tool Business Logic (sn_mcp_server/tools/<feature>.py)

• Type: Unit. Isolation: Mock SignNowAPIClient via MagicMock. Mock fastmcp.Context via AsyncMock when function accepts ctx.
• Focus: Data transformation, curated response fields, edge cases (empty data, missing optionals), error propagation, status normalization.

class TestFeatureName:
    """Test cases for _feature_function."""

    @pytest.fixture
    def mock_client(self):
        """Create a mock SignNowAPIClient."""
        return MagicMock()

    def test_feature_happy_path(self, mock_client):
        """Test successful execution with valid data."""
        mock_client.api_method.return_value = SampleModel(...)

        result = _feature_function(mock_client, "test_token", "param_value")

        assert isinstance(result, ExpectedResponseModel)
        assert result.field == "expected_value"
        mock_client.api_method.assert_called_once_with("test_token", "param_value")

B. Tool Response Models (sn_mcp_server/tools/models.py)

• Type: Unit. Focus: Construction, defaults, from_* factories, status normalization, edge cases.

class TestResponseModel:
    """Test cases for ResponseModel."""

    def test_model_construction_with_defaults(self):
        """Test model handles missing optional fields."""
        model = ResponseModel(id="test123", name="Test")
        assert model.optional_field is None

    @pytest.mark.parametrize("raw_status,expected", [
        ("sent", "pending"),
        ("fulfilled", "completed"),
    ])
    def test_status_normalization(self, raw_status, expected):
        """Test raw API status maps to unified status."""
        result = InviteStatusValues.from_raw_status(raw_status)
        assert result == expected