blob: 6ee6ab39ada33922a531b06cadb23bdb4b8b8be9 [file] [log] [blame]
Werner Lewis8b2df742022-07-08 13:54:57 +01001#!/usr/bin/env python3
2"""Generate test data for bignum functions.
3
4With no arguments, generate all test data. With non-option arguments,
5generate only the specified files.
Werner Lewis169034a2022-08-23 16:07:37 +01006
7Class structure:
8
Gilles Peskine64f2efd2022-09-16 21:41:47 +02009Child classes of test_data_generation.BaseTarget (file targets) represent an output
Werner Lewis6ef54362022-08-25 12:29:46 +010010file. These indicate where test cases will be written to, for all subclasses of
Werner Lewis52ae3262022-09-14 16:26:54 +010011this target. Multiple file targets should not reuse a `target_basename`.
Werner Lewis169034a2022-08-23 16:07:37 +010012
Werner Lewis52ae3262022-09-14 16:26:54 +010013Each subclass derived from a file target can either be:
Werner Lewis169034a2022-08-23 16:07:37 +010014 - A concrete class, representing a test function, which generates test cases.
15 - An abstract class containing shared methods and attributes, not associated
Werner Lewis6ef54362022-08-25 12:29:46 +010016 with a test function. An example is BignumOperation, which provides
17 common features used for bignum binary operations.
18
19Both concrete and abstract subclasses can be derived from, to implement
20additional test cases (see BignumCmp and BignumCmpAbs for examples of deriving
21from abstract and concrete classes).
Werner Lewis169034a2022-08-23 16:07:37 +010022
23
Werner Lewis6ef54362022-08-25 12:29:46 +010024Adding test case generation for a function:
Werner Lewis169034a2022-08-23 16:07:37 +010025
26A subclass representing the test function should be added, deriving from a
Werner Lewis52ae3262022-09-14 16:26:54 +010027file target such as BignumTarget. This test class must set/implement the
Werner Lewis81f24442022-08-25 16:27:05 +010028following:
Werner Lewis169034a2022-08-23 16:07:37 +010029 - test_function: the function name from the associated .function file.
Werner Lewis6ef54362022-08-25 12:29:46 +010030 - test_name: a descriptive name or brief summary to refer to the test
31 function.
32 - arguments(): a method to generate the list of arguments required for the
33 test_function.
Gilles Peskine22514eb2022-09-21 23:13:04 +020034 - generate_function_tests(): a method to generate TestCases for the function.
Werner Lewis6ef54362022-08-25 12:29:46 +010035 This should create instances of the class with required input data, and
36 call `.create_test_case()` to yield the TestCase.
Werner Lewis169034a2022-08-23 16:07:37 +010037
38Additional details and other attributes/methods are given in the documentation
Gilles Peskine64f2efd2022-09-16 21:41:47 +020039of BaseTarget in test_data_generation.py.
Werner Lewis8b2df742022-07-08 13:54:57 +010040"""
41
42# Copyright The Mbed TLS Contributors
43# SPDX-License-Identifier: Apache-2.0
44#
45# Licensed under the Apache License, Version 2.0 (the "License"); you may
46# not use this file except in compliance with the License.
47# You may obtain a copy of the License at
48#
49# http://www.apache.org/licenses/LICENSE-2.0
50#
51# Unless required by applicable law or agreed to in writing, software
52# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
53# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
54# See the License for the specific language governing permissions and
55# limitations under the License.
56
Werner Lewis8b2df742022-07-08 13:54:57 +010057import sys
Werner Lewis169034a2022-08-23 16:07:37 +010058
Werner Lewis99e81782022-09-30 16:28:43 +010059from abc import ABCMeta
Janos Follath351e6882022-11-09 16:04:41 +000060from typing import List
Werner Lewis8b2df742022-07-08 13:54:57 +010061
62import scripts_path # pylint: disable=unused-import
Gilles Peskine64f2efd2022-09-16 21:41:47 +020063from mbedtls_dev import test_data_generation
Werner Lewis99e81782022-09-30 16:28:43 +010064from mbedtls_dev import bignum_common
65# Import modules containing additional test classes
66# Test function classes in these modules will be registered by
67# the framework
Werner Lewisc84b7312022-11-30 14:43:31 +000068from mbedtls_dev import bignum_core, bignum_mod_raw, bignum_mod # pylint: disable=unused-import
Werner Lewis8b2df742022-07-08 13:54:57 +010069
Janos Follath0cd89672022-11-09 12:14:14 +000070class BignumTarget(test_data_generation.BaseTarget):
Janos Follath351e6882022-11-09 16:04:41 +000071 #pylint: disable=too-few-public-methods
Gilles Peskinece220662022-10-21 18:54:43 +020072 """Target for bignum (legacy) test case generation."""
73 target_basename = 'test_suite_bignum.generated'
Werner Lewis8b2df742022-07-08 13:54:57 +010074
75
Janos Follath0cd89672022-11-09 12:14:14 +000076class BignumOperation(bignum_common.OperationCommon, BignumTarget,
77 metaclass=ABCMeta):
Werner Lewis99e81782022-09-30 16:28:43 +010078 #pylint: disable=abstract-method
79 """Common features for bignum operations in legacy tests."""
Janos Follathf4579762022-11-20 13:32:54 +000080 unique_combinations_only = True
Werner Lewis55e638c2022-08-23 14:21:53 +010081 input_values = [
Gilles Peskine35af0212022-11-15 20:43:33 +010082 "", "0", "-", "-0",
83 "7b", "-7b",
Werner Lewis8b2df742022-07-08 13:54:57 +010084 "0000000000000000123", "-0000000000000000123",
85 "1230000000000000000", "-1230000000000000000"
Werner Lewis99e81782022-09-30 16:28:43 +010086 ]
Werner Lewis8b2df742022-07-08 13:54:57 +010087
Gilles Peskine35af0212022-11-15 20:43:33 +010088 def description_suffix(self) -> str:
Gilles Peskineb9b90262022-11-10 09:15:21 +010089 #pylint: disable=no-self-use # derived classes need self
Gilles Peskine35af0212022-11-15 20:43:33 +010090 """Text to add at the end of the test case description."""
91 return ""
92
Werner Lewis6300b4f2022-08-24 17:46:22 +010093 def description(self) -> str:
Werner Lewis169034a2022-08-23 16:07:37 +010094 """Generate a description for the test case.
95
96 If not set, case_description uses the form A `symbol` B, where symbol
97 is used to represent the operation. Descriptions of each value are
98 generated to provide some context to the test case.
99 """
Werner Lewis55e638c2022-08-23 14:21:53 +0100100 if not self.case_description:
101 self.case_description = "{} {} {}".format(
Werner Lewis3dc45192022-09-12 17:35:27 +0100102 self.value_description(self.arg_a),
Werner Lewis55e638c2022-08-23 14:21:53 +0100103 self.symbol,
Werner Lewis3dc45192022-09-12 17:35:27 +0100104 self.value_description(self.arg_b)
Werner Lewis55e638c2022-08-23 14:21:53 +0100105 )
Gilles Peskine35af0212022-11-15 20:43:33 +0100106 description_suffix = self.description_suffix()
107 if description_suffix:
108 self.case_description += " " + description_suffix
Werner Lewis55e638c2022-08-23 14:21:53 +0100109 return super().description()
Werner Lewis8b2df742022-07-08 13:54:57 +0100110
Werner Lewis8b2df742022-07-08 13:54:57 +0100111 @staticmethod
Werner Lewis55e638c2022-08-23 14:21:53 +0100112 def value_description(val) -> str:
Werner Lewis169034a2022-08-23 16:07:37 +0100113 """Generate a description of the argument val.
114
Werner Lewis81f24442022-08-25 16:27:05 +0100115 This produces a simple description of the value, which is used in test
116 case naming to add context.
Werner Lewis169034a2022-08-23 16:07:37 +0100117 """
Werner Lewis8b2df742022-07-08 13:54:57 +0100118 if val == "":
119 return "0 (null)"
Gilles Peskine35af0212022-11-15 20:43:33 +0100120 if val == "-":
121 return "negative 0 (null)"
Werner Lewis8b2df742022-07-08 13:54:57 +0100122 if val == "0":
123 return "0 (1 limb)"
124
125 if val[0] == "-":
126 tmp = "negative"
127 val = val[1:]
128 else:
129 tmp = "positive"
130 if val[0] == "0":
131 tmp += " with leading zero limb"
132 elif len(val) > 10:
133 tmp = "large " + tmp
134 return tmp
135
Werner Lewis8b2df742022-07-08 13:54:57 +0100136
137class BignumCmp(BignumOperation):
Werner Lewis6ef54362022-08-25 12:29:46 +0100138 """Test cases for bignum value comparison."""
Werner Lewis8b2df742022-07-08 13:54:57 +0100139 count = 0
Tom Cosgrove119eae22022-09-21 12:19:18 +0100140 test_function = "mpi_cmp_mpi"
Werner Lewis55e638c2022-08-23 14:21:53 +0100141 test_name = "MPI compare"
Werner Lewis8b2df742022-07-08 13:54:57 +0100142 input_cases = [
143 ("-2", "-3"),
144 ("-2", "-2"),
145 ("2b4", "2b5"),
146 ("2b5", "2b6")
147 ]
148
Werner Lewis3dc45192022-09-12 17:35:27 +0100149 def __init__(self, val_a, val_b) -> None:
150 super().__init__(val_a, val_b)
151 self._result = int(self.int_a > self.int_b) - int(self.int_a < self.int_b)
Werner Lewis55e638c2022-08-23 14:21:53 +0100152 self.symbol = ["<", "==", ">"][self._result + 1]
Werner Lewis8b2df742022-07-08 13:54:57 +0100153
Werner Lewis1b20e7e2022-10-12 14:53:17 +0100154 def result(self) -> List[str]:
155 return [str(self._result)]
Werner Lewis8b2df742022-07-08 13:54:57 +0100156
157
Werner Lewis69a92ce2022-07-18 15:49:43 +0100158class BignumCmpAbs(BignumCmp):
Werner Lewis6ef54362022-08-25 12:29:46 +0100159 """Test cases for absolute bignum value comparison."""
Werner Lewis69a92ce2022-07-18 15:49:43 +0100160 count = 0
Tom Cosgrove119eae22022-09-21 12:19:18 +0100161 test_function = "mpi_cmp_abs"
Werner Lewis55e638c2022-08-23 14:21:53 +0100162 test_name = "MPI compare (abs)"
Werner Lewis69a92ce2022-07-18 15:49:43 +0100163
Werner Lewis3dc45192022-09-12 17:35:27 +0100164 def __init__(self, val_a, val_b) -> None:
165 super().__init__(val_a.strip("-"), val_b.strip("-"))
Werner Lewis69a92ce2022-07-18 15:49:43 +0100166
167
Werner Lewis86caf852022-07-18 17:22:58 +0100168class BignumAdd(BignumOperation):
Werner Lewis6ef54362022-08-25 12:29:46 +0100169 """Test cases for bignum value addition."""
Werner Lewis86caf852022-07-18 17:22:58 +0100170 count = 0
Werner Lewis1fade8a2022-09-12 17:34:15 +0100171 symbol = "+"
Tom Cosgrove119eae22022-09-21 12:19:18 +0100172 test_function = "mpi_add_mpi"
Werner Lewis55e638c2022-08-23 14:21:53 +0100173 test_name = "MPI add"
Werner Lewis99e81782022-09-30 16:28:43 +0100174 input_cases = bignum_common.combination_pairs(
Werner Lewisac446c82022-09-14 15:12:46 +0100175 [
176 "1c67967269c6", "9cde3",
177 "-1c67967269c6", "-9cde3",
178 ]
Werner Lewis9990b302022-08-24 18:03:30 +0100179 )
Werner Lewis86caf852022-07-18 17:22:58 +0100180
Gilles Peskine35af0212022-11-15 20:43:33 +0100181 def __init__(self, val_a: str, val_b: str) -> None:
182 super().__init__(val_a, val_b)
183 self._result = self.int_a + self.int_b
Werner Lewis99e81782022-09-30 16:28:43 +0100184
Gilles Peskine35af0212022-11-15 20:43:33 +0100185 def description_suffix(self) -> str:
186 if (self.int_a >= 0 and self.int_b >= 0):
187 return "" # obviously positive result or 0
188 if (self.int_a <= 0 and self.int_b <= 0):
189 return "" # obviously negative result or 0
190 # The sign of the result is not obvious, so indicate it
191 return ", result{}0".format('>' if self._result > 0 else
192 '<' if self._result < 0 else '=')
193
194 def result(self) -> List[str]:
195 return [bignum_common.quote_str("{:x}".format(self._result))]
Werner Lewis86caf852022-07-18 17:22:58 +0100196
Werner Lewis8b2df742022-07-08 13:54:57 +0100197if __name__ == '__main__':
Werner Lewisc2fb5402022-09-16 17:03:54 +0100198 # Use the section of the docstring relevant to the CLI as description
Gilles Peskine64f2efd2022-09-16 21:41:47 +0200199 test_data_generation.main(sys.argv[1:], "\n".join(__doc__.splitlines()[:4]))