Merge bitcoin/bitcoin#24815: lint: convert lint-tests.sh to python

ae0e06a439e09a7e24dd6198591a588c8df2d529 Converted lint-tests.sh to python (TakeshiMusgrave)

Pull request description:

  Reference issue: https://github.com/bitcoin/bitcoin/issues/24783

ACKs for top commit:
  laanwj:
    Tested ACK ae0e06a439e09a7e24dd6198591a588c8df2d529

Tree-SHA512: a118295b5b6b5199b52d46b54de871d88dd544112e7dd5001a9575d65b093af0aea390f9ad223462a4fc6a201bd8c4debe5e26bfa4860a90c97cfe300477c04a
This commit is contained in:
laanwj 2022-04-25 19:21:38 +02:00 committed by pasta
parent 710ea6e114
commit 89c1e775c5
No known key found for this signature in database
GPG Key ID: 52527BEDABE87984
2 changed files with 87 additions and 35 deletions

87
test/lint/lint-tests.py Executable file
View 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()

View File

@ -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}