scripts/shac/tests/commit_msg_checker_test.py

#!/usr/bin/env fuchsia-vendored-python
# Copyright 2026 The Fuchsia Authors. All rights reserved.
# Use of this source code is governed by a BSD-style license that can be
# found in the LICENSE file.

import sys
import unittest
from pathlib import Path

# Add parent directory to path so we can import commit_msg_checker
sys.path.insert(0, str(Path(__file__).resolve().parent.parent))

import commit_msg_checker


class TestCommitMessageChecker(unittest.TestCase):
    def test_valid_message(self) -> None:
        msg = (
            "Add commit message checker\n\n"
            "This change implements a commit message checker.\n\n"
            "Bug: 12345\n"
            "Test: Added unit tests.\n"
        )
        findings = commit_msg_checker.check_commit_message(msg)
        self.assertEqual(findings, [])

    def test_subject_line_too_long(self) -> None:
        long_subject = "A" * 70
        msg = f"{long_subject}\n\nBug: 1\nTest: 1"
        findings = commit_msg_checker.check_commit_message(msg)
        self.assertTrue(
            any(
                "Subject line exceeds 65 characters" in f["message"]
                for f in findings
            )
        )

    def test_subject_line_too_long_exempt_revert(self) -> None:
        long_subject = 'Revert "Subject that is extremely long and exceeds the typical 65 character limit normally"'
        msg = f"{long_subject}\n\nBug: 1\nTest: 1"
        findings = commit_msg_checker.check_commit_message(msg)
        self.assertEqual(findings, [])

    def test_subject_line_too_long_exempt_reland(self) -> None:
        long_subject = 'Reland "Subject that is extremely long and exceeds the typical 65 character limit normally"'
        msg = f"{long_subject}\n\nBug: 1\nTest: 1"
        findings = commit_msg_checker.check_commit_message(msg)
        self.assertEqual(findings, [])

    def test_body_line_too_long_ignores_urls(self) -> None:
        long_url = "https://fuchsia.dev/" + "a" * 80
        msg = f"Subject line\n\nSee {long_url} for details.\n\nBug: 1\nTest: 1"
        findings = commit_msg_checker.check_commit_message(msg)
        self.assertEqual(findings, [])

    def test_quoted_revert_long_line_exempt(self) -> None:
        msg = (
            'Revert "Subject"\n\n' "> " + "a" * 80 + "\n\n" "Bug: 1\n" "Test: 1"
        )
        findings = commit_msg_checker.check_commit_message(msg)
        self.assertEqual(findings, [])

    def test_revert_message_quoted_change_id_allowed(self) -> None:
        msg = (
            'Revert "Some commit"\n\n'
            "This reverts commit 12345.\n\n"
            "> Change-Id: Ioldchangeid\n"
            "> Bug: 123\n\n"
            "Bug: 123\n"
            "Test: Reverting patch\n"
            "Change-Id: I1234567890123456789012345678901234567890\n"
        )
        findings = commit_msg_checker.check_commit_message(msg)
        self.assertEqual(findings, [])

    def test_multiple_change_id_errors(self) -> None:
        msg = (
            "Subject line\n\n"
            "Bug: 123\n"
            "Test: Unit test\n"
            "Change-Id: I1111111111111111111111111111111111111111\n"
            "Change-Id: I2222222222222222222222222222222222222222\n"
        )
        findings = commit_msg_checker.check_commit_message(msg)
        self.assertTrue(
            any(
                f["level"] == "error"
                and "Multiple 'Change-Id:' footers" in f["message"]
                for f in findings
            )
        )

    def test_agent_metadata_single_allowed(self) -> None:
        msg = (
            "Subject line\n\n"
            "Bug: 123\n"
            "Test: Unit test\n"
            "TAG: agy\n"
            "CONV: 6344ad16-d9ce-483d-9b98-affe2f24feac\n"
        )
        findings = commit_msg_checker.check_commit_message(msg)
        self.assertEqual(findings, [])

    def test_agent_metadata_different_tags_allowed(self) -> None:
        msg = (
            "Subject line\n\n"
            "Bug: 123\n"
            "Test: Unit test\n"
            "TAG: agy\n"
            "TAG: refactor\n"
            "CONV: 6344ad16-first\n"
            "CONV: 6344ad16-second\n"
        )
        findings = commit_msg_checker.check_commit_message(msg)
        self.assertEqual(findings, [])

    def test_agent_metadata_duplicate_warns(self) -> None:
        msg = (
            "Subject line\n\n"
            "Bug: 123\n"
            "Test: Unit test\n"
            "TAG=agy\n"
            "TAG: agy\n"
            "CONV=6344ad16-same\n"
            "CONV: 6344ad16-same\n"
        )
        findings = commit_msg_checker.check_commit_message(msg)
        self.assertTrue(
            any(
                "Duplicate 'TAG' metadata line" in f["message"]
                for f in findings
            )
        )
        self.assertTrue(
            any(
                "Duplicate 'CONV' metadata line" in f["message"]
                for f in findings
            )
        )


if __name__ == "__main__":
    unittest.main()