feat: Add copyright hook

.pre-commit-config.yaml

@@ -1,4 +1,4 @@
-# Copyright 2023, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# Copyright 2023-2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
 #
 # Redistribution and use in source and binary forms, with or without
 # modification, are permitted provided that the following conditions
@@ -72,3 +72,13 @@ repos:
  - id: mixed-line-ending
  - id: requirements-txt-fixer
  - id: trailing-whitespace
+
+- repo: local
+ hooks:
+ - id: add-license
+ name: Add License
+ entry: python tools/add_copyright.py
+ language: python
+ stages: [pre-commit]
+ verbose: true
+ require_serial: true

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2022, NVIDIA CORPORATION. All rights reserved.
+Copyright (c) 2024, NVIDIA CORPORATION. All rights reserved.
 
 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions

tools/add_copyright.py

@@ -0,0 +1,365 @@
+# Copyright (c) 2024, NVIDIA CORPORATION & AFFILIATES. All rights reserved.
+# Redistribution and use in source and binary forms, with or without
+# modification, are permitted provided that the following conditions
+# are met:
+# * Redistributions of source code must retain the above copyright
+# notice, this list of conditions and the following disclaimer.
+# * Redistributions in binary form must reproduce the above copyright
+# notice, this list of conditions and the following disclaimer in the
+# documentation and/or other materials provided with the distribution.
+# * Neither the name of NVIDIA CORPORATION nor the names of its
+# contributors may be used to endorse or promote products derived
+# from this software without specific prior written permission.
+#
+# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS ``AS IS'' AND ANY
+# EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+# PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR
+# CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+# EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+# PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
+# PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+# OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+# (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+import argparse
+import os
+import re
+import subprocess
+import sys
+from datetime import datetime
+from typing import Callable, Dict, Optional, Sequence
+
+current_year = str(datetime.now().year)
+
+ROOT_DIR = os.path.join(os.path.dirname(__file__), os.path.pardir)
+
+LICENSE_PATH = os.path.join(ROOT_DIR, "LICENSE")
+
+COPYRIGHT_YEAR_PAT = re.compile(
+ r"Copyright( \(c\))? (\d{4})?-?(\d{4}), NVIDIA CORPORATION"
+)
+
+
+def has_copyright(content: str) -> bool:
+ return COPYRIGHT_YEAR_PAT.search(content)
+
+
+def update_copyright_year(
+ path: str, content: Optional[str] = None, disallow_range: bool = False
+) -> str:
+ """
+ Updates the copyright year in the provided file.
+ If the copyright is not present in the file, this function has no effect.
+ """
+ if content is None:
+ with open(path, "r") as f:
+ content = f.read()
+
+ match = COPYRIGHT_YEAR_PAT.search(content)
+ min_year = match.groups()[1] or match.groups()[2]
+
+ new_copyright = f"Copyright{match.groups()[0] or ''} "
+ if min_year < current_year and not disallow_range:
+ new_copyright += f"{min_year}-{current_year}"
+ else:
+ new_copyright += f"{current_year}"
+ new_copyright += ", NVIDIA CORPORATION"
+
+ updated_content = COPYRIGHT_YEAR_PAT.sub(new_copyright, content)
+
+ if content != updated_content:
+ with open(path, "w") as f:
+ f.write(updated_content)
+
+
+def update_and_get_license() -> str:
+ """
+ Updates the copyright year in the LICENSE file if necessary and then
+ returns its contents.
+ """
+ # TODO: Check if this is right - if the license file needs to have a range,
+ # we need to remove the range before returning the license text.
+ #
+ # License file should always have the current year.
+ update_copyright_year(LICENSE_PATH, disallow_range=True)
+
+ with open(LICENSE_PATH, "r") as license_file:
+ return license_file.read()
+
+
+LICENSE_TEXT = update_and_get_license()
+
+#
+# Header manipulation helpers
+#
+
+
+def prefix_lines(content: str, prefix: str) -> str:
+ # NOTE: This could have been done via `textwrap.indent`, but we're not actually indenting,
+ # so it seems semantically wrong to do that.
+ return prefix + f"\n{prefix}".join(content.splitlines())
+
+
+def insert_after(regex: str) -> Callable[[str], str]:
+ """
+ Builds a callback that will insert a provided header after
+ the specified regular expression. If the expression is not
+ found in the file contents, the header will be inserted at the
+ beginning of the file.
+
+ Args:
+ regex: The regular expression to match.
+
+ Returns:
+ A callable that can be used as the `add_header` argument to `update_or_add_header`.
+ """
+
+ def add_header(header: str, content: str) -> str:
+ match = re.match(regex, content)
+
+ if match is None:
+ return header + "\n" + content
+
+ insertion_point = match.span()[-1]
+
+ return content[:insertion_point] + f"{header}\n" + content[insertion_point:]
+
+ return add_header
+
+
+def update_or_add_header(
+ path: str, header: str, add_header: Optional[Callable[[str, str], str]] = None
+):
+ """
+ Updates in place or adds a new copyright header to the specified file.
+
+ Args:
+ path: The path of the file.
+ header: The contents of the copyright header.
+ add_header: A callback that receives the copyright header and file contents and
+ controls how the contents of the file are updated. By default, the copyright
+ header is prepended to the file.
+ """
+ with open(path, "r") as f:
+ content = f.read()
+
+ if has_copyright(content):
+ update_copyright_year(path, content)
+ return
+
+ add_header = add_header or (lambda header, content: header + "\n" + content)
+
+ content = add_header(header, content)
+
+ # As a sanity check, make sure we didn't accidentally add the copyright header
+ # twice, or add a new header when one was already present.
+ if content.count("Copyright (c)") != 1:
+ print(
+ f"WARNING: Something went wrong while processing: {path}!\n"
+ "Please check if the copyright header was included twice or wasn't added at all. "
+ )
+
+ with open(path, "w") as f:
+ f.write(content)
+
+
+# Each file type requires slightly different handling when inserting the copyright
+# header. For example, for C++ files, the header must be prefixed with `//` and for
+# shell scripts, it must be prefixed with `#` and must be inserted *after* the shebang.
+#
+# This mapping stores callables that return whether a handler wants to process a specified
+# file based on the path along with callables that will accept the file path and update
+# it with the copyright header.
+FILE_TYPE_HANDLERS: Dict[Callable[[str], bool], Callable[[str], None]] = {}
+
+
+#
+# Path matching callables
+# These allow registered functions to more easily specify what kinds of
+# paths they should be applied to.
+#
+def has_ext(exts: Sequence[str]):
+ def has_ext_impl(path: str):
+ _, ext = os.path.splitext(path)
+ return ext in exts
+
+ return has_ext_impl
+
+
+def basename_is(expected_path: str):
+ return lambda path: os.path.basename(path) == expected_path
+
+
+def path_contains(expected: str):
+ return lambda path: expected in path
+
+
+def any_of(*funcs: Sequence[Callable[[str], bool]]):
+ return lambda path: any(func(path) for func in funcs)
+
+
+#
+# File handlers for different types of files.
+# Many types of files require very similar handling - those are combined where possible.
+#
+
+
+def register(match: Callable[[str], bool]):
+ def register_impl(func):
+ FILE_TYPE_HANDLERS[match] = func
+ return func
+
+ return register_impl
+
+
+@register(
+ any_of(
+ has_ext([".py", ".sh", ".bash", ".yaml", ".pbtxt"]),
+ basename_is("CMakeLists.txt"),
+ path_contains("Dockerfile"),
+ )
+)
+def py_or_shell_like(path):
+ update_or_add_header(
+ path,
+ prefix_lines(LICENSE_TEXT, "# "),
+ # Insert the header *after* the shebang.
+ # NOTE: This could break if there is a shebang-like pattern elsewhere in the file.
+ # In that case, this could be edited to check only the first line of the file (after removing whitespace).
+ insert_after(r"#!(.*)\n"),
+ )
+
+
+@register(has_ext([".cc", ".h"]))
+def cpp(path):
+ update_or_add_header(path, prefix_lines(LICENSE_TEXT, "// "))
+
+
+@register(has_ext([".tpl"]))
+def tpl(path):
+ update_or_add_header(path, "{{/*\n" + prefix_lines(LICENSE_TEXT, "# ") + "\n*/}}")
+
+
+@register(has_ext([".html", ".md"]))
+def html_md(path):
+ update_or_add_header(path, "<!--\n" + prefix_lines(LICENSE_TEXT, "# ") + "\n-->")
+
+
+def add_copyrights(paths):
+ for path in paths:
+ for match, handler in FILE_TYPE_HANDLERS.items():
+ if match(path):
+ handler(path)
+ break
+ else:
+ print(
+ f"WARNING: No handler registered for file: {path}. Please add a new handler to {__file__}!"
+ )
+
+ subprocess.run(["git", "add"] + paths)
+
+ print(f"Processed copyright headers for {len(paths)} file(s).")
+
+
+def main() -> int:
+ parser = argparse.ArgumentParser(
+ description="Adds copyright headers to source files"
+ )
+ parser.add_argument("files", nargs="*")
+
+ args, _ = parser.parse_known_args()
+ add_copyrights(args.files)
+ return 0
+
+
+if __name__ == "__main__":
+ # sys.exit is important here to avoid the test-related imports below during normal execution.
+ sys.exit(main())
+
+
+#
+# Integration Tests
+#
+import tempfile
+
+import pytest
+
+
+# Processes provided text through the copyright hook by writing it to a temporary file.
+def process_text(content, extension):
+ with tempfile.NamedTemporaryFile("w+", suffix=extension) as f:
+ f.write(content)
+ f.flush()
+
+ add_copyrights([f.name])
+
+ f.seek(0)
+ return f.read()
+
+
+# We use this slightly weird hack to make sure the copyright hook does not do a text replacement
+# of the parameters in the test, since they look exactly like copyright headers.
+def make_copyright_text(text):
+ return f"Copyright {text}"
+
+
+@pytest.mark.parametrize(
+ "content, expected",
+ [
+ # Convert to range if the year that's already present is older than the current year.
+ (
+ make_copyright_text("(c) 2018, NVIDIA CORPORATION"),
+ make_copyright_text(f"(c) 2018-{current_year}, NVIDIA CORPORATION"),
+ ),
+ (
+ make_copyright_text("2018, NVIDIA CORPORATION"),
+ make_copyright_text(f"2018-{current_year}, NVIDIA CORPORATION"),
+ ),
+ # No effect if the year is current:
+ (
+ make_copyright_text(f"(c) {current_year}, NVIDIA CORPORATION"),
+ make_copyright_text(f"(c) {current_year}, NVIDIA CORPORATION"),
+ ),
+ (
+ make_copyright_text(f"{current_year}, NVIDIA CORPORATION"),
+ make_copyright_text(f"{current_year}, NVIDIA CORPORATION"),
+ ),
+ # If there is already a range, update the upper bound of the range:
+ (
+ make_copyright_text("(c) 2018-2023, NVIDIA CORPORATION"),
+ make_copyright_text(f"(c) 2018-{current_year}, NVIDIA CORPORATION"),
+ ),
+ ],
+)
+def test_copyright_update(content, expected):
+ # We don't really care about the extension here - just needs to be something the hook will recognize.
+ assert process_text(content, ".py") == expected
+
+
+@pytest.mark.parametrize(
+ "content, extension, expected",
+ [
+ ("", ".cc", f"// {make_copyright_text(f'(c) {current_year}')}"),
+ ("", ".h", f"// {make_copyright_text(f'(c) {current_year}')}"),
+ ("", ".py", f"# {make_copyright_text(f'(c) {current_year}')}"),
+ ("", ".sh", f"# {make_copyright_text(f'(c) {current_year}')}"),
+ # Make sure copyright comes after shebangs
+ (
+ "#!/bin/python\n",
+ ".py",
+ f"#!/bin/python\n# {make_copyright_text(f'(c) {current_year}')}",
+ ),
+ (
+ "#!/bin/bash\n",
+ ".sh",
+ f"#!/bin/bash\n# {make_copyright_text(f'(c) {current_year}')}",
+ ),
+ ],
+)
+def test_adding_new_copyrights(content, extension, expected):
+ assert process_text(content, extension).startswith(expected)
+
+
+def test_license_has_no_range():
+ assert LICENSE_TEXT.startswith(f"Copyright (c) {current_year},")