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('-o', '--output', type=Optional[Path], default=None, help='Output file to write test') 28 parser.add_argument('-b', '--junit-batch', type=str, default='', help='Name of JUnit batch for output file') 29 parser.add_argument('-np', '--pool-size', type=int, default=1, help='Number of test cases to run in parallel') 30 parser.add_argument('-s', '--smartredis_dir', type=str, default='', help='path to SmartSim library, if present') 31 parser.add_argument('--has_torch', type=bool, default=False, help='Whether to build with torch') 32 parser.add_argument('test', help='Test executable', nargs='?') 33 34 return parser 35 36 37def diff_csv_comment_function(test_line: str, true_line: str) -> Optional[str]: 38 test_line_split = test_line.split(':')[0] 39 true_line_split = true_line.split(':')[0] 40 diff_output = ''.join(difflib.unified_diff([test_line_split + '\n'], 41 [true_line_split + '\n'], 42 tofile='test created file', 43 fromfile='expected output')) 44 return diff_output if diff_output else None 45 46 47class HoneeSuiteSpec(SuiteSpec): 48 def __init__(self, has_torch: bool): 49 self.has_torch: bool = has_torch 50 self.diff_csv_kwargs: dict = {'comment_func': diff_csv_comment_function, 'rel_tol': 1e-9} 51 52 def get_source_path(self, test: str) -> Path: 53 """Compute path to test source file 54 55 Args: 56 test (str): Name of test 57 58 Returns: 59 Path: Path to source file 60 """ 61 if test.startswith('navierstokes'): 62 return (Path('examples') / 'navierstokes').with_suffix('.c') 63 else: 64 return (Path('tests') / test).with_suffix('.c') 65 66 # get path to executable 67 def get_run_path(self, test: str) -> Path: 68 """Compute path to built test executable file 69 70 Args: 71 test (str): Name of test 72 73 Returns: 74 Path: Path to test executable 75 """ 76 return Path('build') / test 77 78 def get_output_path(self, test: str, output_file: str) -> Path: 79 """Compute path to expected output file 80 81 Args: 82 test (str): Name of test 83 output_file (str): File name of output file 84 85 Returns: 86 Path: Path to expected output file 87 """ 88 return Path('tests') / 'output' / output_file 89 90 def check_pre_skip(self, test: str, spec: TestSpec, resource: str, nproc: int) -> Optional[str]: 91 """Check if a test case should be skipped prior to running, returning the reason for skipping 92 93 Args: 94 test (str): Name of test 95 spec (TestSpec): Test case specification 96 resource (str): libCEED backend 97 nproc (int): Number of MPI processes to use when running test case 98 99 Returns: 100 Optional[str]: Skip reason, or `None` if test case should not be skipped 101 """ 102 if contains_any(resource, ['occa']) and startswith_any( 103 test, ['t4', 't5', 'ex', 'mfem', 'nek', 'petsc', 'fluids', 'solids']): 104 return 'OCCA mode not supported' 105 if test.startswith('t318') and contains_any(resource, ['/gpu/cuda/ref']): 106 return 'CUDA ref backend not supported' 107 if test.startswith('t506') and contains_any(resource, ['/gpu/cuda/shared']): 108 return 'CUDA shared backend not supported' 109 for condition in spec.only: 110 if (condition == 'cpu') and ('gpu' in resource): 111 return 'CPU only test with GPU backend' 112 if condition == 'torch' and not self.has_torch: 113 return 'PyTorch only test without USE_TORCH=1' 114 115 def check_post_skip(self, test: str, spec: TestSpec, resource: str, stderr: str) -> Optional[str]: 116 """Check if a test case should be allowed to fail, based on its stderr output 117 118 Args: 119 test (str): Name of test 120 spec (TestSpec): Test case specification 121 resource (str): libCEED backend 122 stderr (str): Standard error output from test case execution 123 124 Returns: 125 Optional[str]: Skip reason, or `None` if unexpeced error 126 """ 127 if 'OCCA backend failed to use' in stderr: 128 return f'OCCA mode not supported' 129 elif 'Backend does not implement' in stderr: 130 return f'Backend does not implement' 131 elif 'Can only provide HOST memory for this backend' in stderr: 132 return f'Device memory not supported' 133 elif 'Can only set HOST memory for this backend' in stderr: 134 return f'Device memory not supported' 135 elif 'Test not implemented in single precision' in stderr: 136 return f'Test not implemented in single precision' 137 elif 'No SYCL devices of the requested type are available' in stderr: 138 return f'SYCL device type not available' 139 elif 'You may need to add --download-ctetgen or --download-tetgen' in stderr: 140 return f'Tet mesh generator not installed for {test}, {spec.name}' 141 return None 142 143 def check_required_failure(self, test: str, spec: TestSpec, resource: str, stderr: str) -> Tuple[str, bool]: 144 """Check whether a test case is expected to fail and if it failed expectedly 145 146 Args: 147 test (str): Name of test 148 spec (TestSpec): Test case specification 149 resource (str): libCEED backend 150 stderr (str): Standard error output from test case execution 151 152 Returns: 153 tuple[str, bool]: Tuple of the expected failure string and whether it was present in `stderr` 154 """ 155 test_id: str = test[:4] 156 fail_str: str = '' 157 if test_id in ['t006', 't007']: 158 fail_str = 'No suitable backend:' 159 elif test_id in ['t008']: 160 fail_str = 'Available backend resources:' 161 elif test_id in ['t110', 't111', 't112', 't113', 't114']: 162 fail_str = 'Cannot grant CeedVector array access' 163 elif test_id in ['t115']: 164 fail_str = 'Cannot grant CeedVector read-only array access, the access lock is already in use' 165 elif test_id in ['t116']: 166 fail_str = 'Cannot destroy CeedVector, the writable access lock is in use' 167 elif test_id in ['t117']: 168 fail_str = 'Cannot restore CeedVector array access, access was not granted' 169 elif test_id in ['t118']: 170 fail_str = 'Cannot sync CeedVector, the access lock is already in use' 171 elif test_id in ['t215']: 172 fail_str = 'Cannot destroy CeedElemRestriction, a process has read access to the offset data' 173 elif test_id in ['t303']: 174 fail_str = 'Length of input/output vectors incompatible with basis dimensions' 175 elif test_id in ['t408']: 176 fail_str = 'CeedQFunctionContextGetData(): Cannot grant CeedQFunctionContext data access, a process has read access' 177 elif test_id in ['t409'] and contains_any(resource, ['memcheck']): 178 fail_str = 'Context data changed while accessed in read-only mode' 179 180 return fail_str, fail_str in stderr 181 182 def check_allowed_stdout(self, test: str) -> bool: 183 """Check whether a test is allowed to print console output 184 185 Args: 186 test (str): Name of test 187 188 Returns: 189 bool: True if the test is allowed to print console output 190 """ 191 return test[:4] in ['t003'] 192 193 194if __name__ == '__main__': 195 args = create_argparser().parse_args() 196 197 # run tests 198 if 'smartsim' in args.test: 199 has_smartsim: bool = args.smartredis_dir and Path(args.smartredis_dir).is_dir() 200 test_cases = [] 201 202 if args.mode is RunMode.TAP: 203 print(f'1..1') 204 if has_smartsim: 205 from smartsim_regression_framework import SmartSimTest 206 207 test_framework = SmartSimTest(Path(__file__).parent / 'smartsim_test_dir') 208 test_framework.setup() 209 210 is_new_subtest = True 211 subtest_ok = True 212 for i, backend in enumerate(args.ceed_backends): 213 test_cases.append(test_framework.test_junit(backend)) 214 if is_new_subtest and args.mode == RunMode.TAP: 215 is_new_subtest = False 216 print(f'# Subtest: {test_cases[0].category}') 217 print(f' 1..{len(args.ceed_backends)}') 218 print(test_case_output_string(test_cases[i], TestSpec("SmartSim Tests"), args.mode, backend, '', i)) 219 if args.mode == RunMode.TAP: 220 print(f'{"" if subtest_ok else "not "}ok 1 - {test_cases[0].category}') 221 test_framework.teardown() 222 elif args.mode is RunMode.TAP: 223 print(f'ok 1 - # SKIP SmartSim not installed') 224 result: TestSuite = TestSuite('SmartSim Tests', test_cases) 225 else: 226 result: TestSuite = run_tests( 227 args.test, 228 args.ceed_backends, 229 args.mode, 230 args.nproc, 231 HoneeSuiteSpec(args.has_torch), 232 args.pool_size) 233 234 # write output and check for failures 235 if args.mode is RunMode.JUNIT: 236 write_junit_xml(result, args.output, args.junit_batch) 237 if has_failures(result): 238 sys.exit(1) 239