Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 1 | #!/usr/bin/env python3 |
| 2 | |
Andrzej Kurek | 629c412 | 2022-10-17 08:34:40 -0400 | [diff] [blame] | 3 | # Copyright (c) 2022, Arm Limited, All Rights Reserved. |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 4 | # SPDX-License-Identifier: Apache-2.0 |
| 5 | # |
| 6 | # Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 7 | # not use this file except in compliance with the License. |
| 8 | # You may obtain a copy of the License at |
| 9 | # |
| 10 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | # |
| 12 | # Unless required by applicable law or agreed to in writing, software |
| 13 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 14 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 15 | # See the License for the specific language governing permissions and |
| 16 | # limitations under the License. |
| 17 | # |
| 18 | # This file is part of Mbed TLS (https://tls.mbed.org) |
| 19 | |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 20 | """ |
Andrzej Kurek | 01af84a | 2022-10-09 05:29:44 -0400 | [diff] [blame] | 21 | Test Mbed TLS with a subset of algorithms. |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 22 | |
Andrzej Kurek | 01af84a | 2022-10-09 05:29:44 -0400 | [diff] [blame] | 23 | This script can be divided into several steps: |
| 24 | |
| 25 | First, include/mbedtls/mbedtls_config.h or a different config file passed |
| 26 | in the arguments is parsed to extract any configuration options (collect_config_symbols). |
| 27 | |
| 28 | Then, test domains (groups of jobs, tests) are built based on predefined data |
| 29 | collected in the DomainData class. Here, each domain has five major traits: |
Andrzej Kurek | 629c412 | 2022-10-17 08:34:40 -0400 | [diff] [blame] | 30 | - domain name, can be used to run only specific tests via command-line; |
Andrzej Kurek | 01af84a | 2022-10-09 05:29:44 -0400 | [diff] [blame] | 31 | - configuration building method, described in detail below; |
| 32 | - list of symbols passed to the configuration building method; |
| 33 | - commands to be run on each job (only build, build and test, or any other custom); |
| 34 | - optional list of symbols to be excluded from testing. |
| 35 | |
| 36 | The configuration building method can be one of the three following: |
| 37 | |
| 38 | - ComplementaryDomain - build a job for each passed symbol by disabling a single |
| 39 | symbol and its reverse dependencies (defined in REVERSE_DEPENDENCIES); |
| 40 | |
| 41 | - ExclusiveDomain - build a job where, for each passed symbol, only this particular |
| 42 | one is defined and other symbols from the list are unset. For each job look for |
| 43 | any non-standard symbols to set/unset in EXCLUSIVE_GROUPS. These are usually not |
| 44 | direct dependencies, but rather non-trivial results of other configs missing. Then |
| 45 | look for any unset symbols and handle their reverse dependencies. |
| 46 | Examples of EXCLUSIVE_GROUPS usage: |
Andrzej Kurek | 01af84a | 2022-10-09 05:29:44 -0400 | [diff] [blame] | 47 | - MBEDTLS_SHA512_C job turns off all hashes except SHA512. MBEDTLS_SSL_COOKIE_C |
| 48 | requires either SHA256 or SHA384 to work, so it also has to be disabled. |
| 49 | This is not a dependency on SHA512_C, but a result of an exclusive domain |
| 50 | config building method. Relevant field: |
Andrzej Kurek | 629c412 | 2022-10-17 08:34:40 -0400 | [diff] [blame] | 51 | 'MBEDTLS_SHA512_C': ['-MBEDTLS_SSL_COOKIE_C'], |
Andrzej Kurek | 01af84a | 2022-10-09 05:29:44 -0400 | [diff] [blame] | 52 | |
| 53 | - DualDomain - combination of the two above - both complementary and exclusive domain |
| 54 | job generation code will be run. Currently only used for hashes. |
| 55 | |
| 56 | Lastly, the collected jobs are executed and (optionally) tested, with |
| 57 | error reporting and coloring as configured in options. Each test starts with |
| 58 | a full config without a couple of slowing down or unnecessary options |
| 59 | (see set_reference_config), then the specific job config is derived. |
| 60 | """ |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 61 | import argparse |
| 62 | import os |
| 63 | import re |
| 64 | import shutil |
| 65 | import subprocess |
| 66 | import sys |
| 67 | import traceback |
| 68 | |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 69 | class Colors: # pylint: disable=too-few-public-methods |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 70 | """Minimalistic support for colored output. |
| 71 | Each field of an object of this class is either None if colored output |
| 72 | is not possible or not desired, or a pair of strings (start, stop) such |
| 73 | that outputting start switches the text color to the desired color and |
| 74 | stop switches the text color back to the default.""" |
| 75 | red = None |
| 76 | green = None |
| 77 | bold_red = None |
| 78 | bold_green = None |
| 79 | def __init__(self, options=None): |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 80 | """Initialize color profile according to passed options.""" |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 81 | if not options or options.color in ['no', 'never']: |
| 82 | want_color = False |
| 83 | elif options.color in ['yes', 'always']: |
| 84 | want_color = True |
| 85 | else: |
| 86 | want_color = sys.stderr.isatty() |
| 87 | if want_color: |
| 88 | # Assume ANSI compatible terminal |
| 89 | normal = '\033[0m' |
| 90 | self.red = ('\033[31m', normal) |
| 91 | self.green = ('\033[32m', normal) |
| 92 | self.bold_red = ('\033[1;31m', normal) |
| 93 | self.bold_green = ('\033[1;32m', normal) |
| 94 | NO_COLORS = Colors(None) |
| 95 | |
| 96 | def log_line(text, prefix='depends.py:', suffix='', color=None): |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 97 | """Print a status message.""" |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 98 | if color is not None: |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 99 | prefix = color[0] + prefix |
| 100 | suffix = suffix + color[1] |
| 101 | sys.stderr.write(prefix + ' ' + text + suffix + '\n') |
Gilles Peskine | 46c8256 | 2019-01-29 18:42:55 +0100 | [diff] [blame] | 102 | sys.stderr.flush() |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 103 | |
Gilles Peskine | 54aa5c6 | 2019-01-29 18:46:34 +0100 | [diff] [blame] | 104 | def log_command(cmd): |
| 105 | """Print a trace of the specified command. |
| 106 | cmd is a list of strings: a command name and its arguments.""" |
| 107 | log_line(' '.join(cmd), prefix='+') |
| 108 | |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 109 | def backup_config(options): |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 110 | """Back up the library configuration file (mbedtls_config.h). |
Gilles Peskine | bf7537d | 2019-01-29 18:52:16 +0100 | [diff] [blame] | 111 | If the backup file already exists, it is presumed to be the desired backup, |
| 112 | so don't make another backup.""" |
| 113 | if os.path.exists(options.config_backup): |
| 114 | options.own_backup = False |
| 115 | else: |
| 116 | options.own_backup = True |
| 117 | shutil.copy(options.config, options.config_backup) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 118 | |
Gilles Peskine | bf7537d | 2019-01-29 18:52:16 +0100 | [diff] [blame] | 119 | def restore_config(options): |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 120 | """Restore the library configuration file (mbedtls_config.h). |
Gilles Peskine | bf7537d | 2019-01-29 18:52:16 +0100 | [diff] [blame] | 121 | Remove the backup file if it was saved earlier.""" |
| 122 | if options.own_backup: |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 123 | shutil.move(options.config_backup, options.config) |
| 124 | else: |
| 125 | shutil.copy(options.config_backup, options.config) |
Gilles Peskine | bf7537d | 2019-01-29 18:52:16 +0100 | [diff] [blame] | 126 | |
Andrzej Kurek | a44c5bc | 2022-10-16 12:52:20 -0400 | [diff] [blame] | 127 | def run_config_py(options, args): |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 128 | """Run scripts/config.py with the specified arguments.""" |
| 129 | cmd = ['scripts/config.py'] |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 130 | if options.config != 'include/mbedtls/mbedtls_config.h': |
Gilles Peskine | 54aa5c6 | 2019-01-29 18:46:34 +0100 | [diff] [blame] | 131 | cmd += ['--file', options.config] |
| 132 | cmd += args |
| 133 | log_command(cmd) |
| 134 | subprocess.check_call(cmd) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 135 | |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 136 | def set_reference_config(options): |
| 137 | """Change the library configuration file (mbedtls_config.h) to the reference state. |
| 138 | The reference state is the one from which the tested configurations are |
| 139 | derived.""" |
Andrzej Kurek | a0cb4fa | 2022-10-14 07:06:43 -0400 | [diff] [blame] | 140 | # Turn off options that are not relevant to the tests and slow them down. |
Andrzej Kurek | a44c5bc | 2022-10-16 12:52:20 -0400 | [diff] [blame] | 141 | run_config_py(options, ['full']) |
Andrzej Kurek | a44c5bc | 2022-10-16 12:52:20 -0400 | [diff] [blame] | 142 | run_config_py(options, ['unset', 'MBEDTLS_TEST_HOOKS']) |
Andrzej Kurek | 2c7993c | 2022-10-24 10:41:20 -0400 | [diff] [blame] | 143 | if options.unset_use_psa: |
| 144 | run_config_py(options, ['unset', 'MBEDTLS_USE_PSA_CRYPTO']) |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 145 | |
| 146 | def collect_config_symbols(options): |
| 147 | """Read the list of settings from mbedtls_config.h. |
| 148 | Return them in a generator.""" |
| 149 | with open(options.config, encoding="utf-8") as config_file: |
| 150 | rx = re.compile(r'\s*(?://\s*)?#define\s+(\w+)\s*(?:$|/[/*])') |
| 151 | for line in config_file: |
| 152 | m = re.match(rx, line) |
| 153 | if m: |
| 154 | yield m.group(1) |
| 155 | |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 156 | class Job: |
| 157 | """A job builds the library in a specific configuration and runs some tests.""" |
| 158 | def __init__(self, name, config_settings, commands): |
| 159 | """Build a job object. |
| 160 | The job uses the configuration described by config_settings. This is a |
| 161 | dictionary where the keys are preprocessor symbols and the values are |
| 162 | booleans or strings. A boolean indicates whether or not to #define the |
| 163 | symbol. With a string, the symbol is #define'd to that value. |
| 164 | After setting the configuration, the job runs the programs specified by |
| 165 | commands. This is a list of lists of strings; each list of string is a |
| 166 | command name and its arguments and is passed to subprocess.call with |
| 167 | shell=False.""" |
| 168 | self.name = name |
| 169 | self.config_settings = config_settings |
| 170 | self.commands = commands |
| 171 | |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 172 | def announce(self, colors, what): |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 173 | '''Announce the start or completion of a job. |
| 174 | If what is None, announce the start of the job. |
| 175 | If what is True, announce that the job has passed. |
| 176 | If what is False, announce that the job has failed.''' |
| 177 | if what is True: |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 178 | log_line(self.name + ' PASSED', color=colors.green) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 179 | elif what is False: |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 180 | log_line(self.name + ' FAILED', color=colors.red) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 181 | else: |
| 182 | log_line('starting ' + self.name) |
| 183 | |
Gilles Peskine | 54aa5c6 | 2019-01-29 18:46:34 +0100 | [diff] [blame] | 184 | def configure(self, options): |
Andrzej Kurek | a0cb4fa | 2022-10-14 07:06:43 -0400 | [diff] [blame] | 185 | '''Set library configuration options as required for the job.''' |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 186 | set_reference_config(options) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 187 | for key, value in sorted(self.config_settings.items()): |
| 188 | if value is True: |
| 189 | args = ['set', key] |
| 190 | elif value is False: |
| 191 | args = ['unset', key] |
| 192 | else: |
| 193 | args = ['set', key, value] |
Andrzej Kurek | a44c5bc | 2022-10-16 12:52:20 -0400 | [diff] [blame] | 194 | run_config_py(options, args) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 195 | |
| 196 | def test(self, options): |
| 197 | '''Run the job's build and test commands. |
| 198 | Return True if all the commands succeed and False otherwise. |
| 199 | If options.keep_going is false, stop as soon as one command fails. Otherwise |
| 200 | run all the commands, except that if the first command fails, none of the |
| 201 | other commands are run (typically, the first command is a build command |
| 202 | and subsequent commands are tests that cannot run if the build failed).''' |
| 203 | built = False |
| 204 | success = True |
| 205 | for command in self.commands: |
Gilles Peskine | 54aa5c6 | 2019-01-29 18:46:34 +0100 | [diff] [blame] | 206 | log_command(command) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 207 | ret = subprocess.call(command) |
| 208 | if ret != 0: |
| 209 | if command[0] not in ['make', options.make_command]: |
| 210 | log_line('*** [{}] Error {}'.format(' '.join(command), ret)) |
| 211 | if not options.keep_going or not built: |
| 212 | return False |
| 213 | success = False |
| 214 | built = True |
| 215 | return success |
| 216 | |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 217 | # If the configuration option A requires B, make sure that |
Andrzej Kurek | 202932f | 2022-10-04 16:22:22 -0400 | [diff] [blame] | 218 | # B in REVERSE_DEPENDENCIES[A]. |
Gilles Peskine | 584c24a | 2019-01-29 19:30:40 +0100 | [diff] [blame] | 219 | # All the information here should be contained in check_config.h. This |
| 220 | # file includes a copy because it changes rarely and it would be a pain |
| 221 | # to extract automatically. |
Andrzej Kurek | 202932f | 2022-10-04 16:22:22 -0400 | [diff] [blame] | 222 | REVERSE_DEPENDENCIES = { |
Gilles Peskine | 34a1557 | 2019-01-29 23:12:28 +0100 | [diff] [blame] | 223 | 'MBEDTLS_AES_C': ['MBEDTLS_CTR_DRBG_C', |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 224 | 'MBEDTLS_NIST_KW_C'], |
Gilles Peskine | 34a1557 | 2019-01-29 23:12:28 +0100 | [diff] [blame] | 225 | 'MBEDTLS_CHACHA20_C': ['MBEDTLS_CHACHAPOLY_C'], |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 226 | 'MBEDTLS_ECDSA_C': ['MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED', |
| 227 | 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED'], |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 228 | 'MBEDTLS_ECP_C': ['MBEDTLS_ECDSA_C', |
| 229 | 'MBEDTLS_ECDH_C', |
| 230 | 'MBEDTLS_ECJPAKE_C', |
Manuel Pégourié-Gonnard | ad45c4d | 2022-12-06 13:20:06 +0100 | [diff] [blame] | 231 | 'MBEDTLS_ECP_RESTARTABLE', |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 232 | 'MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED', |
| 233 | 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED', |
| 234 | 'MBEDTLS_KEY_EXCHANGE_ECDHE_PSK_ENABLED', |
| 235 | 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED', |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 236 | 'MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED', |
Ronald Cron | d8d2ea5 | 2022-10-04 15:48:06 +0200 | [diff] [blame] | 237 | 'MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED', |
| 238 | 'MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_EPHEMERAL_ENABLED', |
| 239 | 'MBEDTLS_SSL_TLS1_3_KEY_EXCHANGE_MODE_PSK_EPHEMERAL_ENABLED'], |
Gilles Peskine | 584c24a | 2019-01-29 19:30:40 +0100 | [diff] [blame] | 240 | 'MBEDTLS_ECP_DP_SECP256R1_ENABLED': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'], |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 241 | 'MBEDTLS_PKCS1_V21': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT'], |
| 242 | 'MBEDTLS_PKCS1_V15': ['MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED', |
| 243 | 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED', |
| 244 | 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED', |
| 245 | 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED'], |
| 246 | 'MBEDTLS_RSA_C': ['MBEDTLS_X509_RSASSA_PSS_SUPPORT', |
| 247 | 'MBEDTLS_KEY_EXCHANGE_DHE_RSA_ENABLED', |
| 248 | 'MBEDTLS_KEY_EXCHANGE_ECDHE_RSA_ENABLED', |
| 249 | 'MBEDTLS_KEY_EXCHANGE_RSA_PSK_ENABLED', |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 250 | 'MBEDTLS_KEY_EXCHANGE_RSA_ENABLED', |
| 251 | 'MBEDTLS_KEY_EXCHANGE_ECDH_RSA_ENABLED'], |
Gilles Peskine | 584c24a | 2019-01-29 19:30:40 +0100 | [diff] [blame] | 252 | 'MBEDTLS_SHA256_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED', |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 253 | 'MBEDTLS_ENTROPY_FORCE_SHA256', |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 254 | 'MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT', |
Andrzej Kurek | 22b959d | 2022-10-16 12:51:41 -0400 | [diff] [blame] | 255 | 'MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY', |
| 256 | 'MBEDTLS_LMS_C', |
| 257 | 'MBEDTLS_LMS_PRIVATE'], |
Valerio Setti | e7221a2 | 2022-12-16 11:53:45 +0100 | [diff] [blame] | 258 | 'MBEDTLS_SHA512_C': ['MBEDTLS_SHA512_USE_A64_CRYPTO_IF_PRESENT', |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 259 | 'MBEDTLS_SHA512_USE_A64_CRYPTO_ONLY'], |
| 260 | 'MBEDTLS_SHA224_C': ['MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED', |
| 261 | 'MBEDTLS_ENTROPY_FORCE_SHA256', |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 262 | 'MBEDTLS_SHA256_USE_A64_CRYPTO_IF_PRESENT', |
| 263 | 'MBEDTLS_SHA256_USE_A64_CRYPTO_ONLY'], |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 264 | 'MBEDTLS_X509_RSASSA_PSS_SUPPORT': [] |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 265 | } |
| 266 | |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 267 | # If an option is tested in an exclusive test, alter the following defines. |
Andrzej Kurek | 01af84a | 2022-10-09 05:29:44 -0400 | [diff] [blame] | 268 | # These are not necessarily dependencies, but just minimal required changes |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 269 | # if a given define is the only one enabled from an exclusive group. |
Andrzej Kurek | 202932f | 2022-10-04 16:22:22 -0400 | [diff] [blame] | 270 | EXCLUSIVE_GROUPS = { |
Andrzej Kurek | 65b2ac1 | 2022-10-14 08:09:16 -0400 | [diff] [blame] | 271 | 'MBEDTLS_SHA512_C': ['-MBEDTLS_SSL_COOKIE_C', |
| 272 | '-MBEDTLS_SSL_PROTO_TLS1_3'], |
| 273 | 'MBEDTLS_ECP_DP_CURVE448_ENABLED': ['-MBEDTLS_ECDSA_C', |
| 274 | '-MBEDTLS_ECDSA_DETERMINISTIC', |
| 275 | '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED', |
| 276 | '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED', |
| 277 | '-MBEDTLS_ECJPAKE_C', |
| 278 | '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'], |
| 279 | 'MBEDTLS_ECP_DP_CURVE25519_ENABLED': ['-MBEDTLS_ECDSA_C', |
| 280 | '-MBEDTLS_ECDSA_DETERMINISTIC', |
| 281 | '-MBEDTLS_KEY_EXCHANGE_ECDHE_ECDSA_ENABLED', |
| 282 | '-MBEDTLS_KEY_EXCHANGE_ECDH_ECDSA_ENABLED', |
| 283 | '-MBEDTLS_ECJPAKE_C', |
| 284 | '-MBEDTLS_KEY_EXCHANGE_ECJPAKE_ENABLED'], |
| 285 | 'MBEDTLS_ARIA_C': ['-MBEDTLS_CMAC_C'], |
| 286 | 'MBEDTLS_CAMELLIA_C': ['-MBEDTLS_CMAC_C'], |
| 287 | 'MBEDTLS_CHACHA20_C': ['-MBEDTLS_CMAC_C', '-MBEDTLS_CCM_C', '-MBEDTLS_GCM_C'], |
| 288 | 'MBEDTLS_DES_C': ['-MBEDTLS_CCM_C', |
| 289 | '-MBEDTLS_GCM_C', |
| 290 | '-MBEDTLS_SSL_TICKET_C', |
| 291 | '-MBEDTLS_SSL_CONTEXT_SERIALIZATION'], |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 292 | } |
| 293 | def handle_exclusive_groups(config_settings, symbol): |
| 294 | """For every symbol tested in an exclusive group check if there are other |
| 295 | defines to be altered. """ |
Andrzej Kurek | 202932f | 2022-10-04 16:22:22 -0400 | [diff] [blame] | 296 | for dep in EXCLUSIVE_GROUPS.get(symbol, []): |
Andrzej Kurek | 65b2ac1 | 2022-10-14 08:09:16 -0400 | [diff] [blame] | 297 | unset = dep.startswith('-') |
| 298 | dep = dep[1:] |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 299 | config_settings[dep] = not unset |
| 300 | |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 301 | def turn_off_dependencies(config_settings): |
| 302 | """For every option turned off config_settings, also turn off what depends on it. |
| 303 | An option O is turned off if config_settings[O] is False.""" |
| 304 | for key, value in sorted(config_settings.items()): |
| 305 | if value is not False: |
| 306 | continue |
Andrzej Kurek | 202932f | 2022-10-04 16:22:22 -0400 | [diff] [blame] | 307 | for dep in REVERSE_DEPENDENCIES.get(key, []): |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 308 | config_settings[dep] = False |
| 309 | |
Andrzej Kurek | 228b12c | 2022-10-06 18:52:44 -0400 | [diff] [blame] | 310 | class BaseDomain: # pylint: disable=too-few-public-methods, unused-argument |
| 311 | """A base class for all domains.""" |
| 312 | def __init__(self, symbols, commands, exclude): |
| 313 | """Initialize the jobs container""" |
| 314 | self.jobs = [] |
| 315 | |
| 316 | class ExclusiveDomain(BaseDomain): # pylint: disable=too-few-public-methods |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 317 | """A domain consisting of a set of conceptually-equivalent settings. |
| 318 | Establish a list of configuration symbols. For each symbol, run a test job |
Andrzej Kurek | fe46949 | 2022-10-06 16:57:38 -0400 | [diff] [blame] | 319 | with this symbol set and the others unset.""" |
Gilles Peskine | b1284cf | 2019-01-29 18:56:03 +0100 | [diff] [blame] | 320 | def __init__(self, symbols, commands, exclude=None): |
| 321 | """Build a domain for the specified list of configuration symbols. |
Andrzej Kurek | fe46949 | 2022-10-06 16:57:38 -0400 | [diff] [blame] | 322 | The domain contains a set of jobs that enable one of the elements |
| 323 | of symbols and disable the others. |
Gilles Peskine | b1284cf | 2019-01-29 18:56:03 +0100 | [diff] [blame] | 324 | Each job runs the specified commands. |
| 325 | If exclude is a regular expression, skip generated jobs whose description |
| 326 | would match this regular expression.""" |
Andrzej Kurek | 228b12c | 2022-10-06 18:52:44 -0400 | [diff] [blame] | 327 | super().__init__(symbols, commands, exclude) |
Andrzej Kurek | fe46949 | 2022-10-06 16:57:38 -0400 | [diff] [blame] | 328 | base_config_settings = {} |
| 329 | for symbol in symbols: |
| 330 | base_config_settings[symbol] = False |
| 331 | for symbol in symbols: |
| 332 | description = symbol |
| 333 | if exclude and re.match(exclude, description): |
| 334 | continue |
| 335 | config_settings = base_config_settings.copy() |
| 336 | config_settings[symbol] = True |
| 337 | handle_exclusive_groups(config_settings, symbol) |
| 338 | turn_off_dependencies(config_settings) |
| 339 | job = Job(description, config_settings, commands) |
| 340 | self.jobs.append(job) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 341 | |
Andrzej Kurek | 228b12c | 2022-10-06 18:52:44 -0400 | [diff] [blame] | 342 | class ComplementaryDomain(BaseDomain): # pylint: disable=too-few-public-methods |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 343 | """A domain consisting of a set of loosely-related settings. |
| 344 | Establish a list of configuration symbols. For each symbol, run a test job |
Andrzej Kurek | a0cb4fa | 2022-10-14 07:06:43 -0400 | [diff] [blame] | 345 | with this symbol unset. |
| 346 | If exclude is a regular expression, skip generated jobs whose description |
| 347 | would match this regular expression.""" |
Andrzej Kurek | 228b12c | 2022-10-06 18:52:44 -0400 | [diff] [blame] | 348 | def __init__(self, symbols, commands, exclude=None): |
Gilles Peskine | b1284cf | 2019-01-29 18:56:03 +0100 | [diff] [blame] | 349 | """Build a domain for the specified list of configuration symbols. |
| 350 | Each job in the domain disables one of the specified symbols. |
| 351 | Each job runs the specified commands.""" |
Andrzej Kurek | 228b12c | 2022-10-06 18:52:44 -0400 | [diff] [blame] | 352 | super().__init__(symbols, commands, exclude) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 353 | for symbol in symbols: |
| 354 | description = '!' + symbol |
Andrzej Kurek | 228b12c | 2022-10-06 18:52:44 -0400 | [diff] [blame] | 355 | if exclude and re.match(exclude, description): |
| 356 | continue |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 357 | config_settings = {symbol: False} |
| 358 | turn_off_dependencies(config_settings) |
| 359 | job = Job(description, config_settings, commands) |
| 360 | self.jobs.append(job) |
| 361 | |
Andrzej Kurek | 228b12c | 2022-10-06 18:52:44 -0400 | [diff] [blame] | 362 | class DualDomain(ExclusiveDomain, ComplementaryDomain): # pylint: disable=too-few-public-methods |
Andrzej Kurek | a0cb4fa | 2022-10-14 07:06:43 -0400 | [diff] [blame] | 363 | """A domain that contains both the ExclusiveDomain and BaseDomain tests. |
Andrzej Kurek | f4b1867 | 2022-10-14 07:57:00 -0400 | [diff] [blame] | 364 | Both parent class __init__ calls are performed in any order and |
Andrzej Kurek | a0cb4fa | 2022-10-14 07:06:43 -0400 | [diff] [blame] | 365 | each call adds respective jobs. The job array initialization is done once in |
| 366 | BaseDomain, before the parent __init__ calls.""" |
Andrzej Kurek | 228b12c | 2022-10-06 18:52:44 -0400 | [diff] [blame] | 367 | |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 368 | class CipherInfo: # pylint: disable=too-few-public-methods |
Gilles Peskine | 34a1557 | 2019-01-29 23:12:28 +0100 | [diff] [blame] | 369 | """Collect data about cipher.h.""" |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 370 | def __init__(self): |
Gilles Peskine | 34a1557 | 2019-01-29 23:12:28 +0100 | [diff] [blame] | 371 | self.base_symbols = set() |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 372 | with open('include/mbedtls/cipher.h', encoding="utf-8") as fh: |
Gilles Peskine | 34a1557 | 2019-01-29 23:12:28 +0100 | [diff] [blame] | 373 | for line in fh: |
| 374 | m = re.match(r' *MBEDTLS_CIPHER_ID_(\w+),', line) |
| 375 | if m and m.group(1) not in ['NONE', 'NULL', '3DES']: |
| 376 | self.base_symbols.add('MBEDTLS_' + m.group(1) + '_C') |
| 377 | |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 378 | class DomainData: |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 379 | """A container for domains and jobs, used to structurize testing.""" |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 380 | def config_symbols_matching(self, regexp): |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 381 | """List the mbedtls_config.h settings matching regexp.""" |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 382 | return [symbol for symbol in self.all_config_symbols |
| 383 | if re.match(regexp, symbol)] |
| 384 | |
| 385 | def __init__(self, options): |
| 386 | """Gather data about the library and establish a list of domains to test.""" |
| 387 | build_command = [options.make_command, 'CFLAGS=-Werror'] |
| 388 | build_and_test = [build_command, [options.make_command, 'test']] |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 389 | self.all_config_symbols = set(collect_config_symbols(options)) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 390 | # Find hash modules by name. |
| 391 | hash_symbols = self.config_symbols_matching(r'MBEDTLS_(MD|RIPEMD|SHA)[0-9]+_C\Z') |
| 392 | # Find elliptic curve enabling macros by name. |
| 393 | curve_symbols = self.config_symbols_matching(r'MBEDTLS_ECP_DP_\w+_ENABLED\Z') |
| 394 | # Find key exchange enabling macros by name. |
| 395 | key_exchange_symbols = self.config_symbols_matching(r'MBEDTLS_KEY_EXCHANGE_\w+_ENABLED\Z') |
Gilles Peskine | 34a1557 | 2019-01-29 23:12:28 +0100 | [diff] [blame] | 396 | # Find cipher IDs (block permutations and stream ciphers --- chaining |
| 397 | # and padding modes are exercised separately) information by parsing |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 398 | # cipher.h, as the information is not readily available in mbedtls_config.h. |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 399 | cipher_info = CipherInfo() |
Gilles Peskine | 34a1557 | 2019-01-29 23:12:28 +0100 | [diff] [blame] | 400 | # Find block cipher chaining and padding mode enabling macros by name. |
| 401 | cipher_chaining_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_MODE_\w+\Z') |
| 402 | cipher_padding_symbols = self.config_symbols_matching(r'MBEDTLS_CIPHER_PADDING_\w+\Z') |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 403 | self.domains = { |
Gilles Peskine | 34a1557 | 2019-01-29 23:12:28 +0100 | [diff] [blame] | 404 | # Cipher IDs, chaining modes and padding modes. Run the test suites. |
| 405 | 'cipher_id': ExclusiveDomain(cipher_info.base_symbols, |
| 406 | build_and_test), |
| 407 | 'cipher_chaining': ExclusiveDomain(cipher_chaining_symbols, |
| 408 | build_and_test), |
| 409 | 'cipher_padding': ExclusiveDomain(cipher_padding_symbols, |
| 410 | build_and_test), |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 411 | # Elliptic curves. Run the test suites. |
| 412 | 'curves': ExclusiveDomain(curve_symbols, build_and_test), |
Valerio Setti | ea8c88f | 2022-12-29 11:08:35 +0100 | [diff] [blame] | 413 | # Hash algorithms. Excluding exclusive domains of MD, RIPEMD, SHA1, |
| 414 | # SHA224 and SHA384 because MBEDTLS_ENTROPY_C is extensively used |
| 415 | # across various modules, but it depends on either SHA256 or SHA512. |
| 416 | # As a consequence an "exclusive" test of anything other than SHA256 |
| 417 | # or SHA512 with MBEDTLS_ENTROPY_C enabled is not possible. |
Andrzej Kurek | 228b12c | 2022-10-06 18:52:44 -0400 | [diff] [blame] | 418 | 'hashes': DualDomain(hash_symbols, build_and_test, |
Andrzej Kurek | a0cb4fa | 2022-10-14 07:06:43 -0400 | [diff] [blame] | 419 | exclude=r'MBEDTLS_(MD|RIPEMD|SHA1_)' \ |
Valerio Setti | b6bf7dc | 2022-12-22 14:28:03 +0100 | [diff] [blame] | 420 | '|MBEDTLS_SHA224_' \ |
Pol Henarejos | aa426e0 | 2023-02-08 12:52:10 +0100 | [diff] [blame^] | 421 | '|MBEDTLS_SHA384_' \ |
| 422 | '|MBEDTLS_SHA3_'), |
Andrzej Kurek | 98682b5 | 2023-01-23 06:16:23 -0500 | [diff] [blame] | 423 | # Key exchange types. |
Andrzej Kurek | 1ff7336 | 2022-11-02 04:50:16 -0400 | [diff] [blame] | 424 | 'kex': ExclusiveDomain(key_exchange_symbols, build_and_test), |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 425 | 'pkalgs': ComplementaryDomain(['MBEDTLS_ECDSA_C', |
| 426 | 'MBEDTLS_ECP_C', |
| 427 | 'MBEDTLS_PKCS1_V21', |
| 428 | 'MBEDTLS_PKCS1_V15', |
| 429 | 'MBEDTLS_RSA_C', |
| 430 | 'MBEDTLS_X509_RSASSA_PSS_SUPPORT'], |
| 431 | build_and_test), |
| 432 | } |
| 433 | self.jobs = {} |
| 434 | for domain in self.domains.values(): |
| 435 | for job in domain.jobs: |
| 436 | self.jobs[job.name] = job |
| 437 | |
| 438 | def get_jobs(self, name): |
| 439 | """Return the list of jobs identified by the given name. |
| 440 | A name can either be the name of a domain or the name of one specific job.""" |
| 441 | if name in self.domains: |
| 442 | return sorted(self.domains[name].jobs, key=lambda job: job.name) |
| 443 | else: |
| 444 | return [self.jobs[name]] |
| 445 | |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 446 | def run(options, job, colors=NO_COLORS): |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 447 | """Run the specified job (a Job instance).""" |
| 448 | subprocess.check_call([options.make_command, 'clean']) |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 449 | job.announce(colors, None) |
Gilles Peskine | 54aa5c6 | 2019-01-29 18:46:34 +0100 | [diff] [blame] | 450 | job.configure(options) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 451 | success = job.test(options) |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 452 | job.announce(colors, success) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 453 | return success |
| 454 | |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 455 | def run_tests(options, domain_data): |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 456 | """Run the desired jobs. |
| 457 | domain_data should be a DomainData instance that describes the available |
| 458 | domains and jobs. |
Andrzej Kurek | b8a97e7 | 2022-10-17 08:39:09 -0400 | [diff] [blame] | 459 | Run the jobs listed in options.tasks.""" |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 460 | if not hasattr(options, 'config_backup'): |
| 461 | options.config_backup = options.config + '.bak' |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 462 | colors = Colors(options) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 463 | jobs = [] |
| 464 | failures = [] |
| 465 | successes = [] |
Andrzej Kurek | b8a97e7 | 2022-10-17 08:39:09 -0400 | [diff] [blame] | 466 | for name in options.tasks: |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 467 | jobs += domain_data.get_jobs(name) |
| 468 | backup_config(options) |
| 469 | try: |
| 470 | for job in jobs: |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 471 | success = run(options, job, colors=colors) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 472 | if not success: |
| 473 | if options.keep_going: |
| 474 | failures.append(job.name) |
| 475 | else: |
| 476 | return False |
| 477 | else: |
| 478 | successes.append(job.name) |
Gilles Peskine | bf7537d | 2019-01-29 18:52:16 +0100 | [diff] [blame] | 479 | restore_config(options) |
| 480 | except: |
| 481 | # Restore the configuration, except in stop-on-error mode if there |
| 482 | # was an error, where we leave the failing configuration up for |
| 483 | # developer convenience. |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 484 | if options.keep_going: |
Gilles Peskine | bf7537d | 2019-01-29 18:52:16 +0100 | [diff] [blame] | 485 | restore_config(options) |
| 486 | raise |
Gilles Peskine | e85163b | 2019-01-29 18:50:03 +0100 | [diff] [blame] | 487 | if successes: |
| 488 | log_line('{} passed'.format(' '.join(successes)), color=colors.bold_green) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 489 | if failures: |
Gilles Peskine | e85163b | 2019-01-29 18:50:03 +0100 | [diff] [blame] | 490 | log_line('{} FAILED'.format(' '.join(failures)), color=colors.bold_red) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 491 | return False |
| 492 | else: |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 493 | return True |
| 494 | |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 495 | def main(): |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 496 | try: |
Andrzej Kurek | 01af84a | 2022-10-09 05:29:44 -0400 | [diff] [blame] | 497 | parser = argparse.ArgumentParser( |
| 498 | formatter_class=argparse.RawDescriptionHelpFormatter, |
| 499 | description= |
| 500 | "Test Mbed TLS with a subset of algorithms.\n\n" |
| 501 | "Example usage:\n" |
Andrzej Kurek | 629c412 | 2022-10-17 08:34:40 -0400 | [diff] [blame] | 502 | r"./tests/scripts/depends.py \!MBEDTLS_SHA1_C MBEDTLS_SHA256_C""\n" |
Andrzej Kurek | 01af84a | 2022-10-09 05:29:44 -0400 | [diff] [blame] | 503 | "./tests/scripts/depends.py MBEDTLS_AES_C hashes\n" |
| 504 | "./tests/scripts/depends.py cipher_id cipher_chaining\n") |
Gilles Peskine | 0fa7cbe | 2019-01-29 18:48:48 +0100 | [diff] [blame] | 505 | parser.add_argument('--color', metavar='WHEN', |
| 506 | help='Colorize the output (always/auto/never)', |
| 507 | choices=['always', 'auto', 'never'], default='auto') |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 508 | parser.add_argument('-c', '--config', metavar='FILE', |
| 509 | help='Configuration file to modify', |
Andrzej Kurek | e05b17f | 2022-09-28 03:17:56 -0400 | [diff] [blame] | 510 | default='include/mbedtls/mbedtls_config.h') |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 511 | parser.add_argument('-C', '--directory', metavar='DIR', |
| 512 | help='Change to this directory before anything else', |
| 513 | default='.') |
| 514 | parser.add_argument('-k', '--keep-going', |
| 515 | help='Try all configurations even if some fail (default)', |
| 516 | action='store_true', dest='keep_going', default=True) |
| 517 | parser.add_argument('-e', '--no-keep-going', |
| 518 | help='Stop as soon as a configuration fails', |
| 519 | action='store_false', dest='keep_going') |
| 520 | parser.add_argument('--list-jobs', |
| 521 | help='List supported jobs and exit', |
| 522 | action='append_const', dest='list', const='jobs') |
| 523 | parser.add_argument('--list-domains', |
| 524 | help='List supported domains and exit', |
| 525 | action='append_const', dest='list', const='domains') |
| 526 | parser.add_argument('--make-command', metavar='CMD', |
| 527 | help='Command to run instead of make (e.g. gmake)', |
| 528 | action='store', default='make') |
Andrzej Kurek | 2c7993c | 2022-10-24 10:41:20 -0400 | [diff] [blame] | 529 | parser.add_argument('--unset-use-psa', |
| 530 | help='Unset MBEDTLS_USE_PSA_CRYPTO before any test', |
| 531 | action='store_true', dest='unset_use_psa') |
Andrzej Kurek | b8a97e7 | 2022-10-17 08:39:09 -0400 | [diff] [blame] | 532 | parser.add_argument('tasks', metavar='TASKS', nargs='*', |
| 533 | help='The domain(s) or job(s) to test (default: all).', |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 534 | default=True) |
| 535 | options = parser.parse_args() |
| 536 | os.chdir(options.directory) |
| 537 | domain_data = DomainData(options) |
Andrzej Kurek | b8a97e7 | 2022-10-17 08:39:09 -0400 | [diff] [blame] | 538 | if options.tasks is True: |
| 539 | options.tasks = sorted(domain_data.domains.keys()) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 540 | if options.list: |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 541 | for arg in options.list: |
| 542 | for domain_name in sorted(getattr(domain_data, arg).keys()): |
| 543 | print(domain_name) |
| 544 | sys.exit(0) |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 545 | else: |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 546 | sys.exit(0 if run_tests(options, domain_data) else 1) |
| 547 | except Exception: # pylint: disable=broad-except |
Gilles Peskine | b39e3ec | 2019-01-29 08:50:20 +0100 | [diff] [blame] | 548 | traceback.print_exc() |
Andrzej Kurek | 3322c22 | 2022-10-04 15:02:41 -0400 | [diff] [blame] | 549 | sys.exit(3) |
| 550 | |
| 551 | if __name__ == '__main__': |
| 552 | main() |