test_conventional.py

Go to the documentation of this file.

#!/usr/bin/env python3
# -*- coding: utf-8 -*-
# tests/tests_git/test_conventional.py
 
"""
Purpose
-------
Unit tests for ``oct.git.conventional`` (Phase 4D — G-D1, G-D2, G-D5).
 
Responsibilities
----------------
- Verify Conventional Commits parsing (type, scope, subject, body, footer).
- Verify commit message validation rules.
- Verify validation error formatting.
- Verify diagnostics impact analysis on diffs.
 
Diagnostics
-----------
Domain: GIT-TESTS
Levels:
    L2 — test lifecycle
    L3 — assertion details
    L4 — deep tracing
 
Contracts
---------
- All tests are pure unit tests (no filesystem or git needed).
"""
 
import textwrap
 
import pytest
 
from oct.git.conventional import (
    COMMIT_TYPES,
    MAX_SUBJECT_LENGTH,
    ConventionalCommit,
    analyse_diagnostics_impact,
    format_validation_errors,
    parse_commit_message,
    validate_commit_message,
)
 
 
# =====================================================================
# Parsing
# =====================================================================
 
 
class TestParse:
 
    def test_simple_feat(self):
        c = parse_commit_message("feat: add login page")
        assert c is not None
        assert c.type == "feat"
        assert c.scope is None
        assert c.subject == "add login page"
        assert c.breaking is False
 
    def test_with_scope(self):
        c = parse_commit_message("fix(auth): patch null pointer")
        assert c is not None
        assert c.type == "fix"
        assert c.scope == "auth"
        assert c.subject == "patch null pointer"
 
    def test_docs_with_scope(self):
        c = parse_commit_message("docs(readme): update install section")
        assert c is not None
        assert c.type == "docs"
        assert c.scope == "readme"
        assert c.subject == "update install section"
 
    def test_breaking_bang(self):
        c = parse_commit_message("feat!: breaking change")
        assert c is not None
        assert c.breaking is True
 
    def test_breaking_footer(self):
        msg = "feat: add thing\n\nBREAKING CHANGE: old API removed"
        c = parse_commit_message(msg)
        assert c is not None
        assert c.breaking is True
 
    def test_garbage_returns_none(self):
        assert parse_commit_message("random garbage") is None
 
    def test_empty_returns_none(self):
        assert parse_commit_message("") is None
 
    def test_whitespace_only_returns_none(self):
        assert parse_commit_message("   \n  ") is None
 
    def test_multiline_body(self):
        msg = "fix: patch bug\n\nThis fixes the null pointer\nin the auth module."
        c = parse_commit_message(msg)
        assert c is not None
        assert c.subject == "patch bug"
        assert "null pointer" in c.body
 
    def test_all_valid_types_parse(self):
        for t in COMMIT_TYPES:
            c = parse_commit_message(f"{t}: do something")
            assert c is not None, f"Failed to parse type '{t}'"
            assert c.type == t
 
    def test_scope_with_hyphen(self):
        c = parse_commit_message("feat(core-git): add function")
        assert c is not None
        assert c.scope == "core-git"
 
    def test_colon_spacing_flexible(self):
        c = parse_commit_message("fix:patch bug")
        assert c is not None
        assert c.subject == "patch bug"
 
    def test_extra_space_after_colon(self):
        c = parse_commit_message("fix:   lots of spaces")
        assert c is not None
        assert c.subject == "lots of spaces"
 
 
# =====================================================================
# Validation
# =====================================================================
 
 
class TestValidate:
 
    def test_valid_message(self):
        errors = validate_commit_message("feat(auth): add token validation")
        assert errors == []
 
    def test_valid_minimal(self):
        errors = validate_commit_message("fix: patch bug")
        assert errors == []
 
    def test_unknown_type(self):
        errors = validate_commit_message("update: change stuff")
        assert any("update" in e and "not valid" in e for e in errors)
        # Should mention available types.
        assert any("feat" in e for e in errors)
 
    def test_subject_too_long(self):
        long_subject = "a" * 80
        errors = validate_commit_message(f"feat: {long_subject}")
        assert any("exceeds" in e or "72" in e for e in errors)
 
    def test_uppercase_first_char(self):
        errors = validate_commit_message("feat: Add something")
        assert any("lowercase" in e for e in errors)
 
    def test_trailing_period(self):
        errors = validate_commit_message("feat: add something.")
        assert any("period" in e for e in errors)
 
    def test_empty_message(self):
        errors = validate_commit_message("")
        assert len(errors) > 0
        assert any("empty" in e.lower() for e in errors)
 
    def test_not_conventional_format(self):
        errors = validate_commit_message("just a plain message")
        assert len(errors) > 0
        assert any("Conventional Commits" in e for e in errors)
 
    def test_multiple_errors(self):
        errors = validate_commit_message("update: Add something.")
        # Should have at least: unknown type, uppercase, trailing period.
        assert len(errors) >= 2
 
    def test_exactly_72_chars_ok(self):
        # "feat: " is 6 chars, so subject can be 66 chars for total 72.
        subject = "a" * 66
        errors = validate_commit_message(f"feat: {subject}")
        assert not any("exceeds" in e or "72" in e for e in errors)
 
    def test_sec_type_valid(self):
        errors = validate_commit_message("sec: patch vulnerability")
        assert errors == []
 
    def test_breaking_valid(self):
        errors = validate_commit_message("feat!: breaking api change")
        assert errors == []
 
 
# =====================================================================
# Error formatting
# =====================================================================
 
 
class TestFormatErrors:
 
    def test_single_error(self):
        result = format_validation_errors(["Type is invalid."])
        assert "Commit message validation failed:" in result
        assert "- Type is invalid." in result
        assert "Example:" in result
 
    def test_multiple_errors(self):
        errors = ["Error one.", "Error two."]
        result = format_validation_errors(errors)
        assert "- Error one." in result
        assert "- Error two." in result
 
    def test_includes_example(self):
        result = format_validation_errors(["bad"])
        assert "fix(auth):" in result
 
 
# =====================================================================
# Diagnostics impact analysis
# =====================================================================
 
 
class TestDiagnosticsImpact:
 
    def test_added_domain(self):
        diff = textwrap.dedent("""\
            --- a/src/module.py
            +++ b/src/module.py
            @@ -1,3 +1,4 @@
            +    _dbg("GIT", func, "starting", 2)
        """)
        impact = analyse_diagnostics_impact(diff)
        assert any("+ Added: GIT" in line for line in impact)
 
    def test_removed_domain(self):
        diff = textwrap.dedent("""\
            --- a/src/module.py
            +++ b/src/module.py
            @@ -1,4 +1,3 @@
            -    _dbg("AUTH", func, "checking", 3)
        """)
        impact = analyse_diagnostics_impact(diff)
        assert any("- Removed: AUTH" in line for line in impact)
 
    def test_modified_domain(self):
        diff = textwrap.dedent("""\
            --- a/src/module.py
            +++ b/src/module.py
            @@ -1,4 +1,4 @@
            -    _dbg("AUTH", func, "old", 2)
            +    _dbg("AUTH", func, "new", 3)
        """)
        impact = analyse_diagnostics_impact(diff)
        assert any("~ Modified: AUTH" in line for line in impact)
 
    def test_no_dbg_changes(self):
        diff = textwrap.dedent("""\
            --- a/src/module.py
            +++ b/src/module.py
            @@ -1,3 +1,3 @@
            -    x = 1
            +    x = 2
        """)
        impact = analyse_diagnostics_impact(diff)
        assert impact == []
 
    def test_empty_diff(self):
        assert analyse_diagnostics_impact("") == []
 
    def test_mixed_changes(self):
        diff = textwrap.dedent("""\
            +    _dbg("GIT", func, "new", 2)
            -    _dbg("CACHE", func, "old", 1)
        """)
        impact = analyse_diagnostics_impact(diff)
        assert any("+ Added: GIT" in line for line in impact)
        assert any("- Removed: CACHE" in line for line in impact)
 
    def test_malformed_diff_no_crash(self):
        impact = analyse_diagnostics_impact("not a real diff\ngarbage\n+++---")
        assert isinstance(impact, list)
 
 
# =====================================================================
# OI-526 — _FOOTER_RE stability (regex compiled once at module scope)
# =====================================================================
 
 
class TestFooterRegexAtModuleScope:
    """Verify _FOOTER_RE is defined at module scope and not recompiled per call."""
 
    def test_footer_regex_is_module_attribute(self):
        from oct.git import conventional
        assert hasattr(conventional, "_FOOTER_RE")
        import re as _re
        assert isinstance(conventional._FOOTER_RE, _re.Pattern)
 
    def test_footer_regex_identity_preserved_across_calls(self):
        from oct.git import conventional
        before = conventional._FOOTER_RE
        parse_commit_message("feat: first call\n\nbody\n\nRefs: #1")
        parse_commit_message("fix: second call\n\nSigned-off-by: x <x@y>")
        after = conventional._FOOTER_RE
        assert before is after