linux-firmware/check_whence.py
Ben Hutchings 7d88736093 Add a metadata consistency check script
The script compares the files listed in WHENCE (or otherwise expected)
and the files known to git, and reports all differences as errors.

Add a 'check' rule to the Makefile that runs this.

Signed-off-by: Ben Hutchings <ben@decadent.org.uk>
2016-09-26 01:28:45 +01:00

57 lines
2.0 KiB
Python
Executable File

#!/usr/bin/python
import os, re, sys
def list_whence():
with open('WHENCE') as whence:
for line in whence:
match = re.match(r'(?:File|Link|Source):\s*(\S*)', line)
if match:
yield match.group(1)
continue
match = re.match(r'Licen[cs]e: (?:.*\bSee (.*) for details\.?|(\S*))\n',
line)
if match:
if match.group(1):
for name in re.split(r', | and ', match.group(1)):
yield name
continue
if match.group(2):
# Just one word - may or may not be a filename
if not re.search(r'unknown|distributable', match.group(2),
re.IGNORECASE):
yield match.group(2)
continue
def list_git():
with os.popen('git ls-files') as git_files:
for line in git_files:
yield line.rstrip('\n')
def main():
whence_list = list(list_whence())
known_files = set(name for name in whence_list if not name.endswith('/')) | \
set(['check_whence.py', 'configure', 'Makefile',
'README', 'WHENCE'])
known_prefixes = set(name for name in whence_list if name.endswith('/'))
git_files = set(list_git())
for name in sorted(list(known_files - git_files)):
sys.stderr.write('E: %s listed in WHENCE does not exist\n' % name)
for name in sorted(list(git_files - known_files)):
# Ignore subdirectory changelogs and GPG detached signatures
if (name.endswith('/ChangeLog') or
(name.endswith('.asc') and name[:-4] in known_files)):
continue
# Ignore unknown files in known directories
for prefix in known_prefixes:
if name.startswith(prefix):
break
else:
sys.stderr.write('E: %s not listed in WHENCE\n' % name)
if __name__ == '__main__':
main()