cr_checker: add exclusion list feature

.bazelversion

@@ -0,0 +1 @@
+8.3.1

cr_checker/cr_checker.bzl

@@ -21,6 +21,7 @@ def copyright_checker(
         visibility,
         template,
         config,
+        exclusion = None,
         extensions = [],
         offset = 0,
         remove_offset = 0,
@@ -40,6 +41,8 @@ def copyright_checker(
                                   Defaults to "//tools/cr_checker/resources:templates".
         config (str, optional): Path to the config resource used for project variables.
                                 Defaults to "//tools/cr_checker/resources:config".
+        exclusion (str, optional): Path to a text file listing files to be excluded from the copyright check.
+                                   File format: one path per line, relative to the repository root.
         extensions (list, optional): A list of file extensions to filter the source files.
                                      Defaults to an empty list, meaning all files are checked.
         offset (int, optional): The line offset for applying checks or modifications.
@@ -65,12 +68,14 @@ def copyright_checker(
         "-t $(location {})".format(template),
         "-c $(location {})".format(config),
     ]
-    data = []
     if len(extensions):
         args.append("-e {exts}".format(
             exts = " ".join([exts for exts in extensions]),
         ))
 
+    if exclusion:
+        args.append("--exclusion-file $(location {})".format(exclusion))
+
     if offset:
         args.append("--offset {}".format(offset))
 
@@ -89,17 +94,20 @@ def copyright_checker(
             if remove_offset:
                 args.append("--remove_offset {}".format(remove_offset))
 
+        data = srcs[:]
+        data.append(template)
+        data.append(config)
+        if exclusion:
+            data.append(exclusion)
+
         py_binary(
             name = t_name,
             main = "cr_checker.py",
             srcs = [
                 "@score_tooling//cr_checker/tool:cr_checker_lib",
             ],
             args = args,
-            data = srcs + [
-                template,
-                config,
-            ],
+            data = data,
             visibility = visibility,
         )
 

cr_checker/tests/.bazelversion

@@ -0,0 +1 @@
+../../.bazelversion

cr_checker/tests/BUILD

@@ -14,9 +14,9 @@
 load("@score_tooling//python_basics:defs.bzl", "score_py_pytest")
 
 score_py_pytest(
-    name = "shebang_unit_tests",
+    name = "unit_tests",
     srcs = [
-        "test_shebang_handling.py",
+        "test_cr_checker.py",
     ],
     deps = [
         "@score_tooling//cr_checker/tool:cr_checker_lib",

cr_checker/tests/test_shebang_handling.py → cr_checker/tests/test_cr_checker.py

@@ -15,6 +15,7 @@
 
 import importlib.util
 import json
+import pytest
 from datetime import datetime
 from pathlib import Path
 
@@ -32,15 +33,15 @@ def load_cr_checker_module():
 
 
 # load the license template
-def load_py_template() -> str:
+def load_template(extension: str) -> str:
     cr_checker = load_cr_checker_module()
     template_file = Path(__file__).resolve().parents[1] / "resources" / "templates.ini"
     templates = cr_checker.load_templates(template_file)
-    return templates["py"]
+    return templates[extension]
 
 
 # write the config file here so that the year is always up to date with the year
-# written in the mock "script.py" file
+# written in the test file
 def write_config(path: Path, author: str) -> Path:
     config_path = path / "config.json"
     config_path.write_text(json.dumps({"author": author}), encoding="utf-8")
@@ -61,11 +62,145 @@ def test_detect_shebang_offset_counts_trailing_newlines(tmp_path):
     assert offset == len("#!/usr/bin/env python3\n\n".encode("utf-8"))
 
 
+@pytest.fixture(
+    params=[
+        "cpp",
+        "c",
+        "h",
+        "hpp",
+        "py",
+        "sh",
+        "bzl",
+        "ini",
+        "yml",
+        "BUILD",
+        "bazel",
+        "rs",
+        "rst",
+    ]
+)
+def prepare_test_with_header(request: SubRequest, tmp_path: PosixPath) -> tuple:
+    extension = request.param
+    test_file = tmp_path / ("file." + extension)
+    header_template = load_template(extension)
+    current_year = datetime.now().year
+    header = header_template.format(year=current_year, author="Author")
+    test_file.write_text(
+        header + "some content\n",
+        encoding="utf-8",
+    )
+    return test_file, extension, header_template
+
+
+@pytest.fixture(
+    params=[
+        "cpp",
+        "c",
+        "h",
+        "hpp",
+        "py",
+        "sh",
+        "bzl",
+        "ini",
+        "yml",
+        "BUILD",
+        "bazel",
+        "rs",
+        "rst",
+    ]
+)
+def prepare_test_no_header(request: SubRequest, tmp_path: PosixPath) -> tuple:
+    extension = request.param
+    test_file = tmp_path / ("file." + extension)
+    header_template = load_template(extension)
+    current_year = datetime.now().year
+    test_file.write_text(
+        "some content\n",
+        encoding="utf-8",
+    )
+    return test_file, extension, header_template, tmp_path
+
+
+def test_process_files_detects_header(prepare_test_with_header):
+    cr_checker = load_cr_checker_module()
+    test_file, extension, header_template = prepare_test_with_header
+
+    results = cr_checker.process_files(
+        [test_file],
+        {extension: header_template},
+        False,
+        use_mmap=False,
+        encoding="utf-8",
+        offset=0,
+        remove_offset=0,
+    )
+
+    assert results["no_copyright"] == 0
+
+
+def test_process_files_detects_missing_header(prepare_test_no_header):
+    cr_checker = load_cr_checker_module()
+    test_file, extension, header_template, tmp_path = prepare_test_no_header
+
+    results = cr_checker.process_files(
+        [test_file],
+        {extension: header_template},
+        False,
+        use_mmap=False,
+        encoding="utf-8",
+        offset=0,
+        remove_offset=0,
+    )
+
+    assert results["no_copyright"] == 1
+
+
+def test_process_files_inserts_missing_header(prepare_test_no_header):
+    cr_checker = load_cr_checker_module()
+    test_file, extension, header_template, tmp_path = prepare_test_no_header
+    author = "Author"
+    config = write_config(tmp_path, author)
+
+    results = cr_checker.process_files(
+        [test_file],
+        {extension: header_template},
+        True,
+        config=config,
+        use_mmap=False,
+        encoding="utf-8",
+        offset=0,
+        remove_offset=0,
+    )
+
+    assert results["no_copyright"] == 1
+    assert results["fixed"] == 1
+    expected_header = header_template.format(year=datetime.now().year, author="Author")
+    assert test_file.read_text(encoding="utf-8").startswith(expected_header)
+
+
+def test_process_files_skips_exclusion_with_missing_header(prepare_test_no_header):
+    cr_checker = load_cr_checker_module()
+    test_file, extension, header_template, tmp_path = prepare_test_no_header
+
+    results = cr_checker.process_files(
+        [test_file],
+        {extension: header_template},
+        False,
+        [str(test_file)],
+        use_mmap=False,
+        encoding="utf-8",
+        offset=0,
+        remove_offset=0,
+    )
+
+    assert results["no_copyright"] == 0
+
+
 # test that process_files function validates a license header after the shebang line
 def test_process_files_accepts_header_after_shebang(tmp_path):
     cr_checker = load_cr_checker_module()
     script = tmp_path / "script.py"
-    header_template = load_py_template()
+    header_template = load_template("py")
     current_year = datetime.now().year
     header = header_template.format(year=current_year, author="Author")
     script.write_text(
@@ -94,7 +229,7 @@ def test_process_files_fix_inserts_header_after_shebang(tmp_path):
         "#!/usr/bin/env python3\nprint('hi')\n",
         encoding="utf-8",
     )
-    header_template = load_py_template()
+    header_template = load_template("py")
     current_year = datetime.now().year
     author = "Author"
     config = write_config(tmp_path, author)
@@ -103,7 +238,7 @@ def test_process_files_fix_inserts_header_after_shebang(tmp_path):
         [script],
         {"py": header_template},
         True,
-        config,
+        config=config,
         use_mmap=False,
         encoding="utf-8",
         offset=0,
@@ -122,7 +257,7 @@ def test_process_files_fix_inserts_header_after_shebang(tmp_path):
 def test_process_files_accepts_header_without_shebang(tmp_path):
     cr_checker = load_cr_checker_module()
     script = tmp_path / "script.py"
-    header_template = load_py_template()
+    header_template = load_template("py")
     current_year = datetime.now().year
     header = header_template.format(year=current_year, author="Author")
     script.write_text(header + "print('hi')\n", encoding="utf-8")
@@ -145,7 +280,7 @@ def test_process_files_fix_inserts_header_without_shebang(tmp_path):
     cr_checker = load_cr_checker_module()
     script = tmp_path / "script.py"
     script.write_text("print('hi')\n", encoding="utf-8")
-    header_template = load_py_template()
+    header_template = load_template("py")
     current_year = datetime.now().year
     author = "Author"
     config = write_config(tmp_path, author)
@@ -154,7 +289,7 @@ def test_process_files_fix_inserts_header_without_shebang(tmp_path):
         [script],
         {"py": header_template},
         True,
-        config,
+        config=config,
         use_mmap=False,
         encoding="utf-8",
         offset=0,