Merge pull request #761 from veselypeta/petr/verify-license-files

[UR] Verify that every source file includes an appropriate license

Author: veselypeta

.github/workflows/cmake.yml

@@ -81,6 +81,9 @@ jobs:
     - name: Generate source from spec, check for uncommitted diff
       if: matrix.os == 'ubuntu-22.04'
       run: cmake --build ${{github.workspace}}/build --target check-generated
+    
+    - name: Verify that each source file contains a license
+      run: cmake --build ${{github.workspace}}/build --target verify-licenses
 
     - name: Build
       run: cmake --build ${{github.workspace}}/build -j $(nproc)

CMakeLists.txt

@@ -157,6 +157,7 @@ endif()
 
 # Obtain files for clang-format
 set(format_glob)
+set(license_glob)
 foreach(dir examples include source test tools)
     list(APPEND format_glob
         "${dir}/*.h"
@@ -167,8 +168,26 @@ foreach(dir examples include source test tools)
         "${dir}/**/*.hpp"
         "${dir}/**/*.c"
         "${dir}/**/*.cpp")
+    list(APPEND license_glob
+        "${dir}/*.yml"
+        "${dir}/**/*.yml"
+        "${dir}/*.py"
+        "${dir}/**/*.py"
+        "${dir}/**/CMakeLists.txt"
+        "${dir}/CMakeLists.txt"
+    )
 endforeach()
 file(GLOB_RECURSE format_src ${format_glob})
+file(GLOB_RECURSE license_src ${license_glob})
+
+# check for licence
+list(FILTER license_src EXCLUDE REGEX "registry.yml")
+add_custom_target(verify-licenses
+    COMMAND ${Python3_EXECUTABLE}
+        "${PROJECT_SOURCE_DIR}/scripts/verify_license.py"
+        "--files" ${format_src} ${license_src}
+    COMMENT "Verify all files contain a license."
+)
 
 # Add code formatter target
 add_custom_target(cppformat)

scripts/core/exp-bindless-images.yml

@@ -1,3 +1,12 @@
+#
+# Copyright (C) 2023 Intel Corporation
+#
+# Part of the Unified-Runtime Project, under the Apache License v2.0 with LLVM Exceptions.
+# See LICENSE.TXT
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+#
+# See YaML.md for syntax definition
+#
 --- #--------------------------------------------------------------------------
 type: header
 desc: "Bindless Images Extension APIs"

scripts/core/exp-usm-import-release.yml

@@ -1,3 +1,12 @@
+#
+# Copyright (C) 2023 Intel Corporation
+#
+# Part of the Unified-Runtime Project, under the Apache License v2.0 with LLVM Exceptions.
+# See LICENSE.TXT
+# SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+#
+# See YaML.md for syntax definition
+#
 --- #--------------------------------------------------------------------------
 type: header
 desc: "Intel $OneApi USM Import/Release Extension APIs"

scripts/templates/__init__.py

@@ -0,0 +1,8 @@
+"""
+ Copyright (C) 2023 Intel Corporation
+
+ Part of the Unified-Runtime Project, under the Apache License v2.0 with LLVM Exceptions.
+ See LICENSE.TXT
+ SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+"""

scripts/verify_license.py

@@ -0,0 +1,28 @@
+"""
+ Copyright (C) 2023 Intel Corporation
+
+ Part of the Unified-Runtime Project, under the Apache License v2.0 with LLVM Exceptions.
+ See LICENSE.TXT
+ SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
+
+"""
+
+import sys
+import argparse
+
+def verify_file_has_license(file):
+    with open(file, 'r') as in_file:
+        contents = in_file.read(300)
+        if "SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception" not in contents:
+            raise Exception(f"{file} does not contain a license!")
+
+def main():
+    parser = argparse.ArgumentParser()
+    parser.add_argument('-f', '--files', nargs='+', default=[])
+    args = parser.parse_args()
+    for file in args.files:
+        verify_file_has_license(file)
+
+
+if __name__ == "__main__":
+    sys.exit(main())