Extend checkLicense.py to also check tests

This commit is contained in:
Martin Hořeňovský 2022-01-29 13:10:54 +01:00
parent 79e4cd1af4
commit 7a2f9f4633
No known key found for this signature in database
GPG Key ID: DE48307B8B0D381A
2 changed files with 35 additions and 21 deletions

View File

@ -1,3 +1,4 @@
// Copyright Catch2 Authors // Copyright Catch2 Authors
// Distributed under the Boost Software License, Version 1.0. // Distributed under the Boost Software License, Version 1.0.
// (See accompanying file LICENSE_1_0.txt or copy at // (See accompanying file LICENSE_1_0.txt or copy at

View File

@ -1,32 +1,45 @@
#!/usr/bin/env python3 #!/usr/bin/env python3
import os
import sys import sys
import glob
correct_licence = """\
def get_license(): // Copyright Catch2 Authors
with open("src/catch2/catch_all.hpp", "r") as f: // Distributed under the Boost Software License, Version 1.0.
license = f.readlines()[0:7] // (See accompanying file LICENSE_1_0.txt or copy at
// https://www.boost.org/LICENSE_1_0.txt)
return license // SPDX-License-Identifier: BSL-1.0
"""
def check_licence_in_file(filename: str) -> bool:
with open(filename, 'r') as f:
file_preamble = ''.join(f.readlines()[:7])
def check_license(license): if correct_licence != file_preamble:
print('File {} does not have proper licence'.format(filename))
return False
return True
def check_licences_in_path(path: str) -> int:
failed = 0 failed = 0
base_dir = "src/catch2/" files_to_check = glob.glob(path + '/**/*.cpp', recursive=True) \
+ glob.glob(path + '/**/*.hpp', recursive=True)
# The _ represents the list of directories in base_dir for file in files_to_check:
for root, _, files in os.walk(base_dir): if not check_licence_in_file(file):
for file in files: failed += 1
with open(root + "/" + file, "r") as f:
file_license = f.readlines()[0:7]
if file_license != license:
print("File %s does not have license" % file)
failed = 1
return failed return failed
def check_licences():
failed = 0
roots = ['src/catch2', 'tests']
for root in roots:
failed += check_licences_in_path(root)
license = get_license() if failed:
status = check_license(license) print('{} files are missing licence'.format(failed))
sys.exit(status) sys.exit(1)
if __name__ == "__main__":
check_licences()