1#!/usr/bin/env python3 2from junit_common import * 3 4 5def create_argparser() -> argparse.ArgumentParser: 6 """Creates argument parser to read command line arguments 7 8 Returns: 9 argparse.ArgumentParser: Created `ArgumentParser` 10 """ 11 parser = argparse.ArgumentParser('Test runner with JUnit and TAP output') 12 parser.add_argument( 13 '-c', 14 '--ceed-backends', 15 type=str, 16 nargs='*', 17 default=['/cpu/self'], 18 help='libCEED backend to use with convergence tests') 19 parser.add_argument( 20 '-m', 21 '--mode', 22 type=RunMode, 23 action=CaseInsensitiveEnumAction, 24 help='Output mode, junit or tap', 25 default=RunMode.JUNIT) 26 parser.add_argument('-n', '--nproc', type=int, default=1, help='number of MPI processes') 27 parser.add_argument('-b', '--junit-batch', type=str, default='', help='Name of JUnit batch for output file') 28 parser.add_argument('-np', '--pool-size', type=int, default=1, help='Number of test cases to run in parallel') 29 parser.add_argument('-s', '--search', type=str, default='.*', 30 help='Search string to filter tests, using `re` package format') 31 parser.add_argument('-v', '--verbose', action='store_true', default=False, 32 help='print details for all runs, not just failures') 33 parser.add_argument('test', help='Test executable', nargs='?') 34 35 return parser 36 37 38# Necessary functions for running tests 39class CeedSuiteSpec(SuiteSpec): 40 def __init__(self): 41 pass 42 43 def get_source_path(self, test: str) -> Path: 44 """Compute path to test source file 45 46 Args: 47 test (str): Name of test 48 49 Returns: 50 Path: Path to source file 51 """ 52 prefix, rest = test.split('-', 1) 53 if prefix == 'rustqfunctions': 54 return (Path('examples') / 'rust-qfunctions' / rest).with_suffix('.c') 55 if prefix == 'petsc': 56 return (Path('examples') / 'petsc' / rest).with_suffix('.c') 57 elif prefix == 'mfem': 58 return (Path('examples') / 'mfem' / rest).with_suffix('.cpp') 59 elif prefix == 'nek': 60 return (Path('examples') / 'nek' / 'bps' / rest).with_suffix('.usr') 61 elif prefix == 'dealii': 62 return (Path('examples') / 'deal.II' / rest).with_suffix('.cc') 63 elif prefix == 'fluids': 64 return (Path('examples') / 'fluids' / rest).with_suffix('.c') 65 elif prefix == 'solids': 66 return (Path('examples') / 'solids' / rest).with_suffix('.c') 67 elif test.startswith('ex'): 68 return (Path('examples') / 'ceed' / test).with_suffix('.c') 69 elif test.endswith('-f'): 70 return (Path('tests') / test).with_suffix('.f90') 71 else: 72 return (Path('tests') / test).with_suffix('.c') 73 74 # get path to executable 75 def get_run_path(self, test: str) -> Path: 76 """Compute path to built test executable file 77 78 Args: 79 test (str): Name of test 80 81 Returns: 82 Path: Path to test executable 83 """ 84 return Path('build') / test 85 86 def get_output_path(self, test: str, output_file: str) -> Path: 87 """Compute path to expected output file 88 89 Args: 90 test (str): Name of test 91 output_file (str): File name of output file 92 93 Returns: 94 Path: Path to expected output file 95 """ 96 return Path('tests') / 'output' / output_file 97 98 def check_pre_skip(self, test: str, spec: TestSpec, resource: str, nproc: int) -> Optional[str]: 99 """Check if a test case should be skipped prior to running, returning the reason for skipping 100 101 Args: 102 test (str): Name of test 103 spec (TestSpec): Test case specification 104 resource (str): libCEED backend 105 nproc (int): Number of MPI processes to use when running test case 106 107 Returns: 108 Optional[str]: Skip reason, or `None` if test case should not be skipped 109 """ 110 if test.startswith('t318') and contains_any(resource, ['/gpu/cuda/ref']): 111 return 'CUDA ref backend not supported' 112 if test.startswith('t506') and contains_any(resource, ['/gpu/cuda/shared']): 113 return 'CUDA shared backend not supported' 114 for condition in spec.only: 115 if (condition == 'cpu') and ('gpu' in resource): 116 return 'CPU only test with GPU backend' 117 118 def check_post_skip(self, test: str, spec: TestSpec, resource: str, stderr: str) -> Optional[str]: 119 """Check if a test case should be allowed to fail, based on its stderr output 120 121 Args: 122 test (str): Name of test 123 spec (TestSpec): Test case specification 124 resource (str): libCEED backend 125 stderr (str): Standard error output from test case execution 126 127 Returns: 128 Optional[str]: Skip reason, or `None` if unexpeced error 129 """ 130 if 'Backend does not implement' in stderr: 131 return f'Backend does not implement' 132 elif 'Can only provide HOST memory for this backend' in stderr: 133 return f'Device memory not supported' 134 elif 'Can only set HOST memory for this backend' in stderr: 135 return f'Device memory not supported' 136 elif 'Test not implemented in single precision' in stderr: 137 return f'Test not implemented in single precision' 138 elif 'No SYCL devices of the requested type are available' in stderr: 139 return f'SYCL device type not available' 140 elif 'You may need to add --download-ctetgen or --download-tetgen' in stderr: 141 return f'Tet mesh generator not installed for {test}, {spec.name}' 142 return None 143 144 def check_required_failure(self, test: str, spec: TestSpec, resource: str, stderr: str) -> Tuple[str, bool]: 145 """Check whether a test case is expected to fail and if it failed expectedly 146 147 Args: 148 test (str): Name of test 149 spec (TestSpec): Test case specification 150 resource (str): libCEED backend 151 stderr (str): Standard error output from test case execution 152 153 Returns: 154 tuple[str, bool]: Tuple of the expected failure string and whether it was present in `stderr` 155 """ 156 test_id: str = test[:4] 157 fail_str: str = '' 158 if test_id in ['t006', 't007']: 159 fail_str = 'No suitable backend:' 160 elif test_id in ['t008']: 161 fail_str = 'Available backend resources:' 162 elif test_id in ['t110', 't111', 't112', 't113', 't114']: 163 fail_str = 'Cannot grant CeedVector array access' 164 elif test_id in ['t115']: 165 fail_str = 'Cannot grant CeedVector read-only array access, the access lock is already in use' 166 elif test_id in ['t116']: 167 fail_str = 'Cannot destroy CeedVector, the writable access lock is in use' 168 elif test_id in ['t117']: 169 fail_str = 'Cannot restore CeedVector array access, access was not granted' 170 elif test_id in ['t118']: 171 fail_str = 'Cannot sync CeedVector, the access lock is already in use' 172 elif test_id in ['t215']: 173 fail_str = 'Cannot destroy CeedElemRestriction, a process has read access to the offset data' 174 elif test_id in ['t303']: 175 fail_str = 'Input/output vectors too short for basis and evaluation mode' 176 elif test_id in ['t408']: 177 fail_str = 'CeedQFunctionContextGetData(): Cannot grant CeedQFunctionContext data access, a process has read access' 178 elif test_id in ['t409'] and contains_any(resource, ['memcheck']): 179 fail_str = 'Context data changed while accessed in read-only mode' 180 181 return fail_str, fail_str in stderr 182 183 def check_allowed_stdout(self, test: str) -> bool: 184 """Check whether a test is allowed to print console output 185 186 Args: 187 test (str): Name of test 188 189 Returns: 190 bool: True if the test is allowed to print console output 191 """ 192 return test[:4] in ['t003'] 193 194 195if __name__ == '__main__': 196 args = create_argparser().parse_args() 197 198 result: TestSuite = run_tests( 199 args.test, 200 args.ceed_backends, 201 args.mode, 202 args.nproc, 203 CeedSuiteSpec(), 204 args.pool_size, 205 search=args.search, 206 verbose=args.verbose) 207 208 # write output and check for failures 209 if args.mode is RunMode.JUNIT: 210 write_junit_xml(result, args.junit_batch) 211 if has_failures(result): 212 sys.exit(1) 213