mirror of
https://git.proxmox.com/git/fwupd
synced 2025-05-26 00:47:32 +00:00
1e06c12e99
This will improve the pre-commit hook coverage. For dfu: waive pre-commit checks for internal header file This is internal to the plugin not to the library.
103 lines
3.3 KiB
Python
Executable File
103 lines
3.3 KiB
Python
Executable File
#!/usr/bin/python3
|
|
# pylint: disable=invalid-name,missing-module-docstring,missing-function-docstring
|
|
#
|
|
# Copyright (C) 2021 Richard Hughes <richard@hughsie.com>
|
|
# Copyright (C) 2021 Mario Limonciello <superm1@gmail.com>
|
|
#
|
|
# SPDX-License-Identifier: LGPL-2.1+
|
|
|
|
import glob
|
|
import sys
|
|
import os
|
|
from typing import List
|
|
|
|
|
|
def __get_includes(fn: str) -> List[str]:
|
|
includes: List[str] = []
|
|
with open(fn, "r") as f:
|
|
for line in f.read().split("\n"):
|
|
if line.find("#include") == -1:
|
|
continue
|
|
if line.find("waive-pre-commit") > 0:
|
|
continue
|
|
for char in ["<", ">", '"']:
|
|
line = line.replace(char, "")
|
|
for char in ["\t"]:
|
|
line = line.replace(char, " ")
|
|
includes.append(line.split(" ")[-1])
|
|
return includes
|
|
|
|
|
|
def test_files() -> int:
|
|
|
|
rc: int = 0
|
|
|
|
toplevel_headers = ["libfwupd/fwupd.h", "libfwupdplugin/fwupdplugin.h"]
|
|
toplevel_headers_nopath = [os.path.basename(fn) for fn in toplevel_headers]
|
|
lib_headers = glob.glob("libfwupd*/*.h")
|
|
lib_headers.remove("libfwupd/fwupd.h")
|
|
lib_headers.remove("libfwupdplugin/fwupdplugin.h")
|
|
lib_headers_nopath = [os.path.basename(fn) for fn in lib_headers]
|
|
|
|
# test all C and H files
|
|
for fn in glob.glob("**/*.[c|h]", recursive=True):
|
|
includes = __get_includes(fn)
|
|
|
|
if (
|
|
fn.startswith("plugins")
|
|
and not fn.endswith("self-test.c")
|
|
and not fn.endswith("-tool.c")
|
|
):
|
|
for include in includes:
|
|
# check for using private header use in plugins
|
|
if include.endswith("private.h"):
|
|
print("{} uses private header {}".format(fn, include))
|
|
rc = 1
|
|
continue
|
|
|
|
# check for referring to anything but top level header
|
|
if include in lib_headers or include in lib_headers_nopath:
|
|
print(
|
|
"{} contains {}, should only use top level includes".format(
|
|
fn, include
|
|
)
|
|
)
|
|
rc = 1
|
|
|
|
# check for double top level headers
|
|
for toplevel_header in toplevel_headers:
|
|
|
|
toplevel_fn = os.path.basename(toplevel_header)
|
|
toplevel_includes = __get_includes(toplevel_header)
|
|
toplevel_includes_nopath = [
|
|
os.path.basename(fn) for fn in toplevel_includes
|
|
]
|
|
|
|
# we do not need both toplevel headers
|
|
if set(toplevel_headers_nopath).issubset(set(includes)):
|
|
print(
|
|
"{} contains both {}".format(fn, ", ".join(toplevel_headers_nopath))
|
|
)
|
|
|
|
# toplevel not listed
|
|
if toplevel_fn not in includes:
|
|
continue
|
|
|
|
# includes toplevel and *also* something listed in the toplevel
|
|
for include in includes:
|
|
if include in toplevel_includes or include in toplevel_includes_nopath:
|
|
print(
|
|
"{} contains {} but also includes {}".format(
|
|
fn, toplevel_fn, include
|
|
)
|
|
)
|
|
rc = 1
|
|
|
|
return rc
|
|
|
|
|
|
if __name__ == "__main__":
|
|
|
|
# all done!
|
|
sys.exit(test_files())
|