Read-only mirrors. Development, issues and pull requests are on GitHub.

summaryrefslogtreecommitdiffhomepage
path: root/tools/scripts/checkLicense.py
blob: 8b70b3903e8343fa1c0dd2a635eb5eaa92c03197 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
#!/usr/bin/env python3

import sys
import glob
from pathlib import Path

from scriptCommon import upstreamFiles

correct_licence = """\

//              Copyright Catch2 Authors
// Distributed under the Boost Software License, Version 1.0.
//   (See accompanying file LICENSE.txt or copy at
//        https://www.boost.org/LICENSE_1_0.txt)

// SPDX-License-Identifier: BSL-1.0
"""

progmasoft_licence = """\
// Copyright (c) 2026 Progmasoft.
// SPDX-License-Identifier: MPL-2.0 WITH AdditionRef-Progmasoft-Exception-2.0
"""

upstream_files = upstreamFiles()

def check_licence_in_file(filename: str) -> bool:
    # Files that come from Catch2 keep BSL-1.0; the fork's own source and
    # tests carry the MPL header with Progmasoft's exception.
    relative = filename.replace('\\', '/')
    progmasoft = ('Progmasoft' in Path(filename).parts
                  and relative not in upstream_files)
    expected = progmasoft_licence if progmasoft else correct_licence
    with open(filename, 'r', encoding='utf-8') as f:
        file_preamble = f.read(len(expected))

    if expected != 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
    files_to_check = glob.glob(path + '/**/*.cpp', recursive=True) \
                   + glob.glob(path + '/**/*.hpp', recursive=True)
    for file in files_to_check:
        if not check_licence_in_file(file):
            failed += 1
    return failed

def check_licences():
    failed = 0
    # Add 'extras' after the amalgamated files are regenerated with the new script (past 3.4.0)
    roots = ['src/Progmasoft', 'tests', 'examples', 'fuzzing']
    for root in roots:
        failed += check_licences_in_path(root)
    
    if failed:
        print('{} files are missing licence'.format(failed))
        sys.exit(1)

if __name__ == "__main__":
    check_licences()