Merge pull request #42 from stephenswat/ci/license_cmake

Harmonize license header in CMake files

.pre-commit-config.yaml

@@ -22,7 +22,7 @@ repos:
       name: license
       language: system
       entry: ci/check_license.py
-      files: \.(cpp|hpp|ipp|cu|cuh)$
+      files: ((CMakeLists\.txt)|(\.(cpp|hpp|ipp|cu|cuh|cmake)))$
 
   - repo: https://github.com/BlankSpruce/gersemi
     rev: "0.17.0"

CMakeLists.txt

@@ -1,6 +1,6 @@
 # This file is part of covfie, a part of the ACTS project
 #
-# Copyright (c) 2022-2023 CERN
+# Copyright (c) 2022 CERN
 #
 # This Source Code Form is subject to the terms of the Mozilla Public License,
 # v. 2.0. If a copy of the MPL was not distributed with this file, You can

benchmarks/CMakeLists.txt

@@ -1,6 +1,6 @@
 # This file is part of covfie, a part of the ACTS project
 #
-# Copyright (c) 2022-2023 CERN
+# Copyright (c) 2022 CERN
 #
 # This Source Code Form is subject to the terms of the Mozilla Public License,
 # v. 2.0. If a copy of the MPL was not distributed with this file, You can

benchmarks/cuda/CMakeLists.txt

@@ -1,6 +1,6 @@
 # This file is part of covfie, a part of the ACTS project
 #
-# Copyright (c) 2022-2023 CERN
+# Copyright (c) 2022 CERN
 #
 # This Source Code Form is subject to the terms of the Mozilla Public License,
 # v. 2.0. If a copy of the MPL was not distributed with this file, You can

ci/check_license.py

@@ -10,64 +10,38 @@
 
 EXCLUDE = []
 
-
-class bcolors:
-    HEADER = "\033[95m"
-    OKBLUE = "\033[94m"
-    OKGREEN = "\033[92m"
-    WARNING = "\033[93m"
-    FAIL = "\033[91m"
-    ENDC = "\033[0m"
-    BOLD = "\033[1m"
-    UNDERLINE = "\033[4m"
-
-
-CROSS_SYMBOL = "\u2717"
-
-
-def err(string):
-    if sys.stdout.isatty():
-        return bcolors.FAIL + bcolors.BOLD + string + bcolors.ENDC
+def get_licence_format(file):
+    if file.endswith("CMakeLists.txt") or file.endswith(".cmake"):
+        return """# This file is part of covfie, a part of the ACTS project
+#
+# Copyright (c) 2022 CERN
+#
+# This Source Code Form is subject to the terms of the Mozilla Public License,
+# v. 2.0. If a copy of the MPL was not distributed with this file, You can
+# obtain one at http://mozilla.org/MPL/2.0/.
+"""
+    elif any(file.endswith(x) for x in [".cpp",".hpp",".ipp",".cu",".cuh"]):
+        return """/*
+ * This file is part of covfie, a part of the ACTS project
+ *
+ * Copyright (c) 2022 CERN
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public License,
+ * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+ * obtain one at http://mozilla.org/MPL/2.0/.
+ */
+"""
     else:
-        return string
-
+        raise ValueError("No license known for file `{}`".format(file))
 
 def main():
     p = argparse.ArgumentParser()
     p.add_argument("input", nargs="+")
     p.add_argument("--exclude", "-e", action="append", default=EXCLUDE)
 
     args = p.parse_args()
-    extensions = ["cpp", "hpp", "ipp", "cuh", "cu", "C", "h"]
-
-    if len(args.input) == 1 and os.path.isdir(args.input[0]):
-        find_command = ["find", args.input[0]]
-        for ext in extensions:
-            find_command.extend(["-iname", f"*.{ext}", "-or"])
-        # Remove the last "-or" for a valid command
-        find_command = find_command[:-1]
-
-        srcs = (
-            str(
-                check_output(find_command),
-                "utf-8",
-            )
-            .strip()
-            .split("\n")
-        )
-        srcs = filter(lambda p: not p.startswith("./build"), srcs)
-    else:
-        srcs = args.input
 
-    raw = """/*
- * This file is part of covfie, a part of the ACTS project
- *
- * Copyright (c) 2022 CERN
- *
- * This Source Code Form is subject to the terms of the Mozilla Public License,
- * v. 2.0. If a copy of the MPL was not distributed with this file, You can
- * obtain one at http://mozilla.org/MPL/2.0/.
- */"""
+    srcs = args.input
 
     exit = 0
     srcs = list(srcs)
@@ -81,7 +55,7 @@ def main():
         # Read the header
         with open(src, "r+") as f:
             # License could not be found in header
-            if not f.read().startswith(raw):
+            if not f.read().startswith(get_licence_format(src)):
                 print("Invalid / missing license in " + src + "")
                 exit = 1
                 continue

cmake/covfie-compiler-options-cpp.cmake

@@ -1,6 +1,6 @@
 # This file is part of covfie, a part of the ACTS project
 #
-# Copyright (c) 2023 CERN
+# Copyright (c) 2022 CERN
 #
 # This Source Code Form is subject to the terms of the Mozilla Public License,
 # v. 2.0. If a copy of the MPL was not distributed with this file, You can

cmake/covfie-compiler-options-cuda.cmake

@@ -1,6 +1,6 @@
 # This file is part of covfie, a part of the ACTS project
 #
-# Copyright (c) 2023 CERN
+# Copyright (c) 2022 CERN
 #
 # This Source Code Form is subject to the terms of the Mozilla Public License,
 # v. 2.0. If a copy of the MPL was not distributed with this file, You can

cmake/covfie-functions.cmake

@@ -1,6 +1,6 @@
 # This file is part of covfie, a part of the ACTS project
 #
-# Copyright (c) 2023 CERN
+# Copyright (c) 2022 CERN
 #
 # This Source Code Form is subject to the terms of the Mozilla Public License,
 # v. 2.0. If a copy of the MPL was not distributed with this file, You can

examples/CMakeLists.txt

@@ -1,6 +1,6 @@
 # This file is part of covfie, a part of the ACTS project
 #
-# Copyright (c) 2022-2023 CERN
+# Copyright (c) 2022 CERN
 #
 # This Source Code Form is subject to the terms of the Mozilla Public License,
 # v. 2.0. If a copy of the MPL was not distributed with this file, You can

examples/cuda/CMakeLists.txt

@@ -1,6 +1,6 @@
 # This file is part of covfie, a part of the ACTS project
 #
-# Copyright (c) 2022-2023 CERN
+# Copyright (c) 2022 CERN
 #
 # This Source Code Form is subject to the terms of the Mozilla Public License,
 # v. 2.0. If a copy of the MPL was not distributed with this file, You can

lib/core/CMakeLists.txt

@@ -1,6 +1,6 @@
 # This file is part of covfie, a part of the ACTS project
 #
-# Copyright (c) 2022-2023 CERN
+# Copyright (c) 2022 CERN
 #
 # This Source Code Form is subject to the terms of the Mozilla Public License,
 # v. 2.0. If a copy of the MPL was not distributed with this file, You can

lib/cpu/CMakeLists.txt

@@ -1,6 +1,6 @@
 # This file is part of covfie, a part of the ACTS project
 #
-# Copyright (c) 2022-2023 CERN
+# Copyright (c) 2022 CERN
 #
 # This Source Code Form is subject to the terms of the Mozilla Public License,
 # v. 2.0. If a copy of the MPL was not distributed with this file, You can

lib/cuda/CMakeLists.txt

@@ -1,6 +1,6 @@
 # This file is part of covfie, a part of the ACTS project
 #
-# Copyright (c) 2022-2023 CERN
+# Copyright (c) 2022 CERN
 #
 # This Source Code Form is subject to the terms of the Mozilla Public License,
 # v. 2.0. If a copy of the MPL was not distributed with this file, You can

tests/CMakeLists.txt

@@ -1,6 +1,6 @@
 # This file is part of covfie, a part of the ACTS project
 #
-# Copyright (c) 2022-2023 CERN
+# Copyright (c) 2022 CERN
 #
 # This Source Code Form is subject to the terms of the Mozilla Public License,
 # v. 2.0. If a copy of the MPL was not distributed with this file, You can

tests/cuda/CMakeLists.txt

@@ -1,6 +1,6 @@
 # This file is part of covfie, a part of the ACTS project
 #
-# Copyright (c) 2022-2023 CERN
+# Copyright (c) 2022 CERN
 #
 # This Source Code Form is subject to the terms of the Mozilla Public License,
 # v. 2.0. If a copy of the MPL was not distributed with this file, You can

tests/googletest/CMakeLists.txt

@@ -1,6 +1,6 @@
 # This file is part of covfie, a part of the ACTS project
 #
-# Copyright (c) 2023 CERN
+# Copyright (c) 2022 CERN
 #
 # This Source Code Form is subject to the terms of the Mozilla Public License,
 # v. 2.0. If a copy of the MPL was not distributed with this file, You can