summaryrefslogtreecommitdiffstats
path: root/tools/find-uninstalled-headers.py
blob: e1f42e55988f31eac01fa2abef36644c04d044b1 (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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
#!/usr/bin/env python3

"""
This script checks that all source headers are installed by inspecting
Makefile.am files.

Usage: ./tools/find-uninstalled-headers.py
"""

import pathlib
import re
import sys


EXCLUDE_LIST = [
    'src/lib/dns/name_internal.h',
]


def main():
    makefile_ams = sorted(pathlib.Path('./src/lib').glob('**/Makefile.am'))
    headers = sorted(pathlib.Path('./src/lib').glob('**/*.h'))

    headers_pattern = re.compile(r'_HEADERS [+]?= (.*\.h|)(.*)')
    backslash_pattern = re.compile(r'(.*\.h) \\$')

    failure = False

    for makefile_am in makefile_ams:
        with open(makefile_am, 'r', encoding='utf-8') as f:
            lines = f.readlines()
            in_headers_block = False
            for line in lines:

                if len(line) == 0:
                    in_headers_block = False

                header = None

                backslash_matches = backslash_pattern.search(line)
                headers_matches = headers_pattern.search(line)
                if headers_matches is None:
                    if not in_headers_block:
                        continue

                    if backslash_matches is None:
                        header = line
                        in_headers_block = False
                    else:
                        header = backslash_matches.group(1)
                else:
                    in_headers_block = True
                    candidate = headers_matches.group(1)
                    if backslash_matches is None and len(candidate):
                        header = candidate

                if header is not None:
                    relative_path = makefile_am.parent / header.strip()
                    if relative_path not in headers:
                        print(f'ERROR: Header {relative_path} not in Makefile.am')
                        failure = True
                        continue
                    headers.remove(relative_path)

    first = True
    for header in headers:
        if str(header) in EXCLUDE_LIST:
            continue
        if any(i in header.parts for i in ['tests', 'testutils', 'unittests']):
            continue
        if first:
            print('The following headers are not in the _HEADERS section of '
                  'their respective Makefile.am file:')
            first = False
        print(f'- {header}')
        failure = True

    if failure:
        sys.exit(1)


if __name__ == '__main__':
    main()