u-boot/test/py/tests/test_suite.py
Simon Glass 63adc40d4c test: Leave out the prefix when printing test names
When tests are all in the same suite it is annoying to have to read all
the common text after each name. Skip this to help the user.

Signed-off-by: Simon Glass <sjg@chromium.org>
2025-02-11 20:10:58 -06:00

189 lines
6.5 KiB
Python

# SPDX-License-Identifier: GPL-2.0
# Copyright 2024 Google LLC
import pytest
import re
# List of test suites we expect to find with 'ut info' and 'ut all'
EXPECTED_SUITES = [
'addrmap', 'bdinfo', 'bloblist', 'bootm', 'bootstd',
'cmd', 'common', 'dm', 'env', 'exit',
'fdt', 'font', 'hush', 'lib',
'loadm', 'log', 'mbr', 'measurement', 'mem',
'overlay', 'pci_mps', 'setexpr', 'upl',
]
# Set this to True to aid debugging of tests
DEBUG_ME = False
def collect_info(cons, output):
"""Process the output from 'ut all'
Args:
cons: U-Boot console object
output: Output from running 'ut all'
Returns:
tuple:
set: suite names that were found in output
set: test names that were found in output
dict: test count for each suite:
key: suite name
value: number of tests for the suite found in output
set: missing suites (compared to EXPECTED_SUITES)
set: extra suites (compared to EXPECTED_SUITES)
"""
suites = set()
tests = set()
cur_suite = None
test_count = None
exp_test_count = {}
# Collect suites{}
for line in output.splitlines():
line = line.rstrip()
if DEBUG_ME:
cons.log.info(f'line: {line}')
m = re.search('----Running ([^ ]*) tests----', line)
if m:
if DEBUG_ME and cur_suite and cur_suite != 'info':
cons.log.info(f'suite: {cur_suite} expected {exp_test_count[cur_suite]} found {test_count}')
cur_suite = m.group(1)
if DEBUG_ME:
cons.log.info(f'cur_suite: {cur_suite}')
suites.add(cur_suite)
test_count = 0
m = re.match(rf'Running (\d+) {cur_suite} tests', line)
if m:
exp_test_count[cur_suite] = int(m.group(1))
m = re.search(r'Test: (\w*): ([-a-z0-9_]*\.c)?( .*)?', line)
if m:
test_name = m.group(1)
msg = m.group(3)
if DEBUG_ME:
cons.log.info(f"test_name {test_name} msg '{msg}'")
full_name = f'{cur_suite}.{test_name}'
if msg == ' (flat tree)' and full_name not in tests:
tests.add(full_name)
test_count += 1
if not msg or 'skipped as it is manual' in msg:
tests.add(full_name)
test_count += 1
if DEBUG_ME:
cons.log.info(f'test_count {test_count}')
if DEBUG_ME:
cons.log.info(f'suite: {cur_suite} expected {exp_test_count[cur_suite]} found {test_count}')
cons.log.info(f"Tests: {' '.join(sorted(list(tests)))}")
# Figure out what is missing, or extra
missing = set()
extra = set(suites)
for suite in EXPECTED_SUITES:
if suite in extra:
extra.remove(suite)
else:
missing.add(suite)
return suites, tests, exp_test_count, missing, extra
def process_ut_info(cons, output):
"""Process the output of the 'ut info' command
Args:
cons: U-Boot console object
output: Output from running 'ut all'
Returns:
tuple:
int: Number of suites reported
int: Number of tests reported
dict: test count for each suite:
key: suite name
value: number of tests reported for the suite
"""
suite_count = None
total_test_count = None
test_count = {}
for line in output.splitlines():
line = line.rstrip()
if DEBUG_ME:
cons.log.info(f'line: {line}')
m = re.match(r'Test suites: (.*)', line)
if m:
suite_count = int(m.group(1))
m = re.match(r'Total tests: (.*)', line)
if m:
total_test_count = int(m.group(1))
m = re.match(r' *([0-9?]*) (\w*)', line)
if m:
test_count[m.group(2)] = m.group(1)
return suite_count, total_test_count, test_count
@pytest.mark.buildconfigspec('sandbox')
@pytest.mark.notbuildconfigspec('sandbox_spl')
@pytest.mark.notbuildconfigspec('sandbox64')
# This test is disabled since it fails; remove the leading 'x' to try it
def xtest_suite(u_boot_console, u_boot_config):
"""Perform various checks on the unit tests, including:
- The number of suites matches that reported by the 'ut info'
- Where available, the number of tests is each suite matches that
reported by 'ut info -s'
- The total number of tests adds up to the total that are actually run
with 'ut all'
- All suites are run with 'ut all'
- The expected set of suites is run (the list is hard-coded in this test)
"""
cons = u_boot_console
buildconfig = u_boot_config.buildconfig
with cons.log.section('Run all unit tests'):
# ut hush hush_test_simple_dollar prints "Unknown command" on purpose.
with u_boot_console.disable_check('unknown_command'):
output = cons.run_command('ut all')
# Process the output from the run
with cons.log.section('Check output'):
suites, all_tests, exp_test_count, missing, extra = collect_info(cons,
output)
cons.log.info(f'missing {missing}')
cons.log.info(f'extra {extra}')
# Make sure we got a test count for each suite
assert not (suites - exp_test_count.keys())
# Deal with missing suites
with cons.log.section('Check missing suites'):
if 'config_cmd_seama' not in buildconfig:
cons.log.info("CMD_SEAMA not enabled: Ignoring suite 'seama'")
missing.discard('seama')
# Run 'ut info' and compare with the log results
with cons.log.section('Check suite test-counts'):
output = cons.run_command('ut info -s')
suite_count, total_test_count, test_count = process_ut_info(cons,
output)
if missing or extra:
cons.log.info(f"suites: {' '.join(sorted(list(suites)))}")
cons.log.error(f'missing: {sorted(list(missing))}')
cons.log.error(f'extra: {sorted(list(extra))}')
assert not missing, f'Missing suites {missing}'
assert not extra, f'Extra suites {extra}'
cons.log.info(str(exp_test_count))
for suite in EXPECTED_SUITES:
assert test_count[suite] in ['?', str(exp_test_count[suite])], \
f'suite {suite} expected {exp_test_count[suite]}'
assert suite_count == len(EXPECTED_SUITES)
assert total_test_count == len(all_tests)