mirror of
https://github.com/bitcoin/bitcoin.git
synced 2024-11-19 09:53:47 +01:00
Converted lint-tests.sh to python
Use raw string Use re.search instead of grep in check_matching_test_names Replaced bash commands in check_unique_test_names with python commands Use set and sort output Use set comprehension Use .splitlines() Call grep_boost_fixture_test_suite once splitlines() once Fixed copyright date Use check_output() instead of run() add encoding='utf8' Use clearer code for getting duplicates
This commit is contained in:
parent
38d3d0bfc4
commit
ae0e06a439
87
test/lint/lint-tests.py
Executable file
87
test/lint/lint-tests.py
Executable file
@ -0,0 +1,87 @@
|
||||
#!/usr/bin/env python3
|
||||
#
|
||||
# Copyright (c) 2018-2022 The Bitcoin Core developers
|
||||
# Distributed under the MIT software license, see the accompanying
|
||||
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||||
|
||||
"""
|
||||
Check the test suite naming conventions
|
||||
"""
|
||||
|
||||
import re
|
||||
import subprocess
|
||||
import sys
|
||||
|
||||
|
||||
def grep_boost_fixture_test_suite():
|
||||
command = [
|
||||
"git",
|
||||
"grep",
|
||||
"-E",
|
||||
r"^BOOST_FIXTURE_TEST_SUITE\(",
|
||||
"--",
|
||||
"src/test/**.cpp",
|
||||
"src/wallet/test/**.cpp",
|
||||
]
|
||||
return subprocess.check_output(command, universal_newlines=True, encoding="utf8")
|
||||
|
||||
|
||||
def check_matching_test_names(test_suite_list):
|
||||
not_matching = [
|
||||
x
|
||||
for x in test_suite_list
|
||||
if re.search(r"/(.*?)\.cpp:BOOST_FIXTURE_TEST_SUITE\(\1, .*\)", x) is None
|
||||
]
|
||||
if len(not_matching) > 0:
|
||||
not_matching = "\n".join(not_matching)
|
||||
error_msg = (
|
||||
"The test suite in file src/test/foo_tests.cpp should be named\n"
|
||||
'"foo_tests". Please make sure the following test suites follow\n'
|
||||
"that convention:\n\n"
|
||||
f"{not_matching}\n"
|
||||
)
|
||||
print(error_msg)
|
||||
return 1
|
||||
return 0
|
||||
|
||||
|
||||
def get_duplicates(input_list):
|
||||
"""
|
||||
From https://stackoverflow.com/a/9835819
|
||||
"""
|
||||
seen = set()
|
||||
dupes = set()
|
||||
for x in input_list:
|
||||
if x in seen:
|
||||
dupes.add(x)
|
||||
else:
|
||||
seen.add(x)
|
||||
return dupes
|
||||
|
||||
|
||||
def check_unique_test_names(test_suite_list):
|
||||
output = [re.search(r"\((.*?),", x) for x in test_suite_list]
|
||||
output = [x.group(1) for x in output if x is not None]
|
||||
output = get_duplicates(output)
|
||||
output = sorted(list(output))
|
||||
|
||||
if len(output) > 0:
|
||||
output = "\n".join(output)
|
||||
error_msg = (
|
||||
"Test suite names must be unique. The following test suite names\n"
|
||||
f"appear to be used more than once:\n\n{output}"
|
||||
)
|
||||
print(error_msg)
|
||||
return 1
|
||||
return 0
|
||||
|
||||
|
||||
def main():
|
||||
test_suite_list = grep_boost_fixture_test_suite().splitlines()
|
||||
exit_code = check_matching_test_names(test_suite_list)
|
||||
exit_code |= check_unique_test_names(test_suite_list)
|
||||
sys.exit(exit_code)
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
@ -1,35 +0,0 @@
|
||||
#!/usr/bin/env bash
|
||||
#
|
||||
# Copyright (c) 2018 The Bitcoin Core developers
|
||||
# Distributed under the MIT software license, see the accompanying
|
||||
# file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||||
#
|
||||
# Check the test suite naming conventions
|
||||
|
||||
export LC_ALL=C
|
||||
EXIT_CODE=0
|
||||
|
||||
NAMING_INCONSISTENCIES=$(git grep -E '^BOOST_FIXTURE_TEST_SUITE\(' -- \
|
||||
"src/test/**.cpp" "src/wallet/test/**.cpp" | \
|
||||
grep -vE '/(.*?)\.cpp:BOOST_FIXTURE_TEST_SUITE\(\1, .*\)$')
|
||||
if [[ ${NAMING_INCONSISTENCIES} != "" ]]; then
|
||||
echo "The test suite in file src/test/foo_tests.cpp should be named"
|
||||
echo "\"foo_tests\". Please make sure the following test suites follow"
|
||||
echo "that convention:"
|
||||
echo
|
||||
echo "${NAMING_INCONSISTENCIES}"
|
||||
EXIT_CODE=1
|
||||
fi
|
||||
|
||||
TEST_SUITE_NAME_COLLISSIONS=$(git grep -E '^BOOST_FIXTURE_TEST_SUITE\(' -- \
|
||||
"src/test/**.cpp" "src/wallet/test/**.cpp" | cut -f2 -d'(' | cut -f1 -d, | \
|
||||
sort | uniq -d)
|
||||
if [[ ${TEST_SUITE_NAME_COLLISSIONS} != "" ]]; then
|
||||
echo "Test suite names must be unique. The following test suite names"
|
||||
echo "appear to be used more than once:"
|
||||
echo
|
||||
echo "${TEST_SUITE_NAME_COLLISSIONS}"
|
||||
EXIT_CODE=1
|
||||
fi
|
||||
|
||||
exit ${EXIT_CODE}
|
Loading…
Reference in New Issue
Block a user