Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1 | """Test case implementation""" |
| 2 | |
| 3 | import sys |
| 4 | import functools |
| 5 | import difflib |
Antoine Pitrou | 0715b9f | 2013-09-14 19:45:47 +0200 | [diff] [blame] | 6 | import logging |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 7 | import pprint |
| 8 | import re |
| 9 | import warnings |
Raymond Hettinger | 6e165b3 | 2010-11-27 09:31:37 +0000 | [diff] [blame] | 10 | import collections |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 11 | import contextlib |
Antoine Pitrou | 9681022 | 2014-04-29 01:23:50 +0200 | [diff] [blame] | 12 | import traceback |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 13 | |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 14 | from . import result |
Florent Xicluna | c53ae58 | 2011-11-04 08:25:54 +0100 | [diff] [blame] | 15 | from .util import (strclass, safe_repr, _count_diff_all_purpose, |
Serhiy Storchaka | 77622f5 | 2013-09-23 23:07:00 +0300 | [diff] [blame] | 16 | _count_diff_hashable, _common_shorten_repr) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 17 | |
Benjamin Peterson | dccc1fc | 2010-03-22 00:15:53 +0000 | [diff] [blame] | 18 | __unittest = True |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 19 | |
Berker Peksag | 16ea19f | 2016-09-21 19:34:15 +0300 | [diff] [blame] | 20 | _subtest_msg_sentinel = object() |
Michael Foord | 9dad32e | 2010-06-05 13:49:56 +0000 | [diff] [blame] | 21 | |
| 22 | DIFF_OMITTED = ('\nDiff is %s characters long. ' |
| 23 | 'Set self.maxDiff to None to see it.') |
| 24 | |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 25 | class SkipTest(Exception): |
| 26 | """ |
| 27 | Raise this exception in a test to skip it. |
| 28 | |
Ezio Melotti | 265281a | 2013-03-27 20:11:55 +0200 | [diff] [blame] | 29 | Usually you can use TestCase.skipTest() or one of the skipping decorators |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 30 | instead of raising this directly. |
| 31 | """ |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 32 | |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 33 | class _ShouldStop(Exception): |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 34 | """ |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 35 | The test should stop. |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 36 | """ |
| 37 | |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 38 | class _UnexpectedSuccess(Exception): |
| 39 | """ |
| 40 | The test was supposed to fail, but it didn't! |
| 41 | """ |
Michael Foord | b3468f7 | 2010-12-19 03:19:47 +0000 | [diff] [blame] | 42 | |
| 43 | |
| 44 | class _Outcome(object): |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 45 | def __init__(self, result=None): |
| 46 | self.expecting_failure = False |
| 47 | self.result = result |
| 48 | self.result_supports_subtests = hasattr(result, "addSubTest") |
Michael Foord | b3468f7 | 2010-12-19 03:19:47 +0000 | [diff] [blame] | 49 | self.success = True |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 50 | self.skipped = [] |
Michael Foord | b3468f7 | 2010-12-19 03:19:47 +0000 | [diff] [blame] | 51 | self.expectedFailure = None |
| 52 | self.errors = [] |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 53 | |
| 54 | @contextlib.contextmanager |
| 55 | def testPartExecutor(self, test_case, isTest=False): |
| 56 | old_success = self.success |
| 57 | self.success = True |
| 58 | try: |
| 59 | yield |
| 60 | except KeyboardInterrupt: |
| 61 | raise |
| 62 | except SkipTest as e: |
| 63 | self.success = False |
| 64 | self.skipped.append((test_case, str(e))) |
| 65 | except _ShouldStop: |
| 66 | pass |
| 67 | except: |
| 68 | exc_info = sys.exc_info() |
| 69 | if self.expecting_failure: |
| 70 | self.expectedFailure = exc_info |
| 71 | else: |
| 72 | self.success = False |
| 73 | self.errors.append((test_case, exc_info)) |
Victor Stinner | 031bd53 | 2013-12-09 01:52:50 +0100 | [diff] [blame] | 74 | # explicitly break a reference cycle: |
| 75 | # exc_info -> frame -> exc_info |
| 76 | exc_info = None |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 77 | else: |
| 78 | if self.result_supports_subtests and self.success: |
| 79 | self.errors.append((test_case, None)) |
| 80 | finally: |
| 81 | self.success = self.success and old_success |
Michael Foord | b3468f7 | 2010-12-19 03:19:47 +0000 | [diff] [blame] | 82 | |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 83 | |
| 84 | def _id(obj): |
| 85 | return obj |
| 86 | |
| 87 | def skip(reason): |
| 88 | """ |
| 89 | Unconditionally skip a test. |
| 90 | """ |
| 91 | def decorator(test_item): |
Antoine Pitrou | b05ac86 | 2012-04-25 14:56:46 +0200 | [diff] [blame] | 92 | if not isinstance(test_item, type): |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 93 | @functools.wraps(test_item) |
| 94 | def skip_wrapper(*args, **kwargs): |
| 95 | raise SkipTest(reason) |
| 96 | test_item = skip_wrapper |
| 97 | |
| 98 | test_item.__unittest_skip__ = True |
| 99 | test_item.__unittest_skip_why__ = reason |
| 100 | return test_item |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 101 | return decorator |
| 102 | |
| 103 | def skipIf(condition, reason): |
| 104 | """ |
| 105 | Skip a test if the condition is true. |
| 106 | """ |
| 107 | if condition: |
| 108 | return skip(reason) |
| 109 | return _id |
| 110 | |
| 111 | def skipUnless(condition, reason): |
| 112 | """ |
| 113 | Skip a test unless the condition is true. |
| 114 | """ |
| 115 | if not condition: |
| 116 | return skip(reason) |
| 117 | return _id |
| 118 | |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 119 | def expectedFailure(test_item): |
| 120 | test_item.__unittest_expecting_failure__ = True |
| 121 | return test_item |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 122 | |
Serhiy Storchaka | 041dd8e | 2015-05-21 20:15:40 +0300 | [diff] [blame] | 123 | def _is_subtype(expected, basetype): |
| 124 | if isinstance(expected, tuple): |
| 125 | return all(_is_subtype(e, basetype) for e in expected) |
| 126 | return isinstance(expected, type) and issubclass(expected, basetype) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 127 | |
Antoine Pitrou | 0715b9f | 2013-09-14 19:45:47 +0200 | [diff] [blame] | 128 | class _BaseTestCaseContext: |
| 129 | |
| 130 | def __init__(self, test_case): |
| 131 | self.test_case = test_case |
| 132 | |
| 133 | def _raiseFailure(self, standardMsg): |
| 134 | msg = self.test_case._formatMessage(self.msg, standardMsg) |
| 135 | raise self.test_case.failureException(msg) |
| 136 | |
Antoine Pitrou | 0715b9f | 2013-09-14 19:45:47 +0200 | [diff] [blame] | 137 | class _AssertRaisesBaseContext(_BaseTestCaseContext): |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 138 | |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 139 | def __init__(self, expected, test_case, expected_regex=None): |
Antoine Pitrou | 0715b9f | 2013-09-14 19:45:47 +0200 | [diff] [blame] | 140 | _BaseTestCaseContext.__init__(self, test_case) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 141 | self.expected = expected |
Ezio Melotti | b4dc250 | 2011-05-06 15:01:41 +0300 | [diff] [blame] | 142 | self.test_case = test_case |
R David Murray | ef1c267 | 2014-03-25 15:31:50 -0400 | [diff] [blame] | 143 | if expected_regex is not None: |
Ezio Melotti | ed3a7d2 | 2010-12-01 02:32:32 +0000 | [diff] [blame] | 144 | expected_regex = re.compile(expected_regex) |
| 145 | self.expected_regex = expected_regex |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 146 | self.obj_name = None |
Ezio Melotti | b4dc250 | 2011-05-06 15:01:41 +0300 | [diff] [blame] | 147 | self.msg = None |
| 148 | |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 149 | def handle(self, name, args, kwargs): |
Ezio Melotti | b4dc250 | 2011-05-06 15:01:41 +0300 | [diff] [blame] | 150 | """ |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 151 | If args is empty, assertRaises/Warns is being used as a |
Ezio Melotti | b4dc250 | 2011-05-06 15:01:41 +0300 | [diff] [blame] | 152 | context manager, so check for a 'msg' kwarg and return self. |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 153 | If args is not empty, call a callable passing positional and keyword |
| 154 | arguments. |
Ezio Melotti | b4dc250 | 2011-05-06 15:01:41 +0300 | [diff] [blame] | 155 | """ |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 156 | try: |
Victor Stinner | bbd3cf8 | 2017-03-28 00:56:28 +0200 | [diff] [blame] | 157 | if not _is_subtype(self.expected, self._base_type): |
| 158 | raise TypeError('%s() arg 1 must be %s' % |
| 159 | (name, self._base_type_str)) |
| 160 | if args and args[0] is None: |
| 161 | warnings.warn("callable is None", |
| 162 | DeprecationWarning, 3) |
| 163 | args = () |
| 164 | if not args: |
| 165 | self.msg = kwargs.pop('msg', None) |
| 166 | if kwargs: |
| 167 | warnings.warn('%r is an invalid keyword argument for ' |
| 168 | 'this function' % next(iter(kwargs)), |
| 169 | DeprecationWarning, 3) |
| 170 | return self |
| 171 | |
| 172 | callable_obj, *args = args |
| 173 | try: |
| 174 | self.obj_name = callable_obj.__name__ |
| 175 | except AttributeError: |
| 176 | self.obj_name = str(callable_obj) |
| 177 | with self: |
| 178 | callable_obj(*args, **kwargs) |
| 179 | finally: |
| 180 | # bpo-23890: manually break a reference cycle |
| 181 | self = None |
Ezio Melotti | b4dc250 | 2011-05-06 15:01:41 +0300 | [diff] [blame] | 182 | |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 183 | |
Antoine Pitrou | 4bc12ef | 2010-09-06 19:25:46 +0000 | [diff] [blame] | 184 | class _AssertRaisesContext(_AssertRaisesBaseContext): |
| 185 | """A context manager used to implement TestCase.assertRaises* methods.""" |
| 186 | |
Serhiy Storchaka | 041dd8e | 2015-05-21 20:15:40 +0300 | [diff] [blame] | 187 | _base_type = BaseException |
| 188 | _base_type_str = 'an exception type or tuple of exception types' |
| 189 | |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 190 | def __enter__(self): |
Ezio Melotti | 4900823 | 2010-02-08 21:57:48 +0000 | [diff] [blame] | 191 | return self |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 192 | |
| 193 | def __exit__(self, exc_type, exc_value, tb): |
| 194 | if exc_type is None: |
| 195 | try: |
| 196 | exc_name = self.expected.__name__ |
| 197 | except AttributeError: |
| 198 | exc_name = str(self.expected) |
| 199 | if self.obj_name: |
Ezio Melotti | b4dc250 | 2011-05-06 15:01:41 +0300 | [diff] [blame] | 200 | self._raiseFailure("{} not raised by {}".format(exc_name, |
| 201 | self.obj_name)) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 202 | else: |
Ezio Melotti | b4dc250 | 2011-05-06 15:01:41 +0300 | [diff] [blame] | 203 | self._raiseFailure("{} not raised".format(exc_name)) |
Antoine Pitrou | 9681022 | 2014-04-29 01:23:50 +0200 | [diff] [blame] | 204 | else: |
| 205 | traceback.clear_frames(tb) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 206 | if not issubclass(exc_type, self.expected): |
| 207 | # let unexpected exceptions pass through |
| 208 | return False |
Ezio Melotti | 4900823 | 2010-02-08 21:57:48 +0000 | [diff] [blame] | 209 | # store exception, without traceback, for later retrieval |
| 210 | self.exception = exc_value.with_traceback(None) |
Ezio Melotti | ed3a7d2 | 2010-12-01 02:32:32 +0000 | [diff] [blame] | 211 | if self.expected_regex is None: |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 212 | return True |
| 213 | |
Ezio Melotti | ed3a7d2 | 2010-12-01 02:32:32 +0000 | [diff] [blame] | 214 | expected_regex = self.expected_regex |
| 215 | if not expected_regex.search(str(exc_value)): |
Ezio Melotti | b4dc250 | 2011-05-06 15:01:41 +0300 | [diff] [blame] | 216 | self._raiseFailure('"{}" does not match "{}"'.format( |
| 217 | expected_regex.pattern, str(exc_value))) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 218 | return True |
| 219 | |
| 220 | |
Antoine Pitrou | 4bc12ef | 2010-09-06 19:25:46 +0000 | [diff] [blame] | 221 | class _AssertWarnsContext(_AssertRaisesBaseContext): |
| 222 | """A context manager used to implement TestCase.assertWarns* methods.""" |
| 223 | |
Serhiy Storchaka | 041dd8e | 2015-05-21 20:15:40 +0300 | [diff] [blame] | 224 | _base_type = Warning |
| 225 | _base_type_str = 'a warning type or tuple of warning types' |
| 226 | |
Antoine Pitrou | 4bc12ef | 2010-09-06 19:25:46 +0000 | [diff] [blame] | 227 | def __enter__(self): |
| 228 | # The __warningregistry__'s need to be in a pristine state for tests |
| 229 | # to work properly. |
| 230 | for v in sys.modules.values(): |
| 231 | if getattr(v, '__warningregistry__', None): |
| 232 | v.__warningregistry__ = {} |
| 233 | self.warnings_manager = warnings.catch_warnings(record=True) |
| 234 | self.warnings = self.warnings_manager.__enter__() |
| 235 | warnings.simplefilter("always", self.expected) |
| 236 | return self |
| 237 | |
| 238 | def __exit__(self, exc_type, exc_value, tb): |
| 239 | self.warnings_manager.__exit__(exc_type, exc_value, tb) |
| 240 | if exc_type is not None: |
| 241 | # let unexpected exceptions pass through |
| 242 | return |
| 243 | try: |
| 244 | exc_name = self.expected.__name__ |
| 245 | except AttributeError: |
| 246 | exc_name = str(self.expected) |
| 247 | first_matching = None |
| 248 | for m in self.warnings: |
| 249 | w = m.message |
| 250 | if not isinstance(w, self.expected): |
| 251 | continue |
| 252 | if first_matching is None: |
| 253 | first_matching = w |
Ezio Melotti | ed3a7d2 | 2010-12-01 02:32:32 +0000 | [diff] [blame] | 254 | if (self.expected_regex is not None and |
| 255 | not self.expected_regex.search(str(w))): |
Antoine Pitrou | 4bc12ef | 2010-09-06 19:25:46 +0000 | [diff] [blame] | 256 | continue |
| 257 | # store warning for later retrieval |
| 258 | self.warning = w |
| 259 | self.filename = m.filename |
| 260 | self.lineno = m.lineno |
| 261 | return |
| 262 | # Now we simply try to choose a helpful failure message |
| 263 | if first_matching is not None: |
Ezio Melotti | b4dc250 | 2011-05-06 15:01:41 +0300 | [diff] [blame] | 264 | self._raiseFailure('"{}" does not match "{}"'.format( |
| 265 | self.expected_regex.pattern, str(first_matching))) |
Antoine Pitrou | 4bc12ef | 2010-09-06 19:25:46 +0000 | [diff] [blame] | 266 | if self.obj_name: |
Ezio Melotti | b4dc250 | 2011-05-06 15:01:41 +0300 | [diff] [blame] | 267 | self._raiseFailure("{} not triggered by {}".format(exc_name, |
| 268 | self.obj_name)) |
Antoine Pitrou | 4bc12ef | 2010-09-06 19:25:46 +0000 | [diff] [blame] | 269 | else: |
Ezio Melotti | b4dc250 | 2011-05-06 15:01:41 +0300 | [diff] [blame] | 270 | self._raiseFailure("{} not triggered".format(exc_name)) |
Antoine Pitrou | 4bc12ef | 2010-09-06 19:25:46 +0000 | [diff] [blame] | 271 | |
| 272 | |
Antoine Pitrou | 0715b9f | 2013-09-14 19:45:47 +0200 | [diff] [blame] | 273 | |
| 274 | _LoggingWatcher = collections.namedtuple("_LoggingWatcher", |
| 275 | ["records", "output"]) |
| 276 | |
| 277 | |
| 278 | class _CapturingHandler(logging.Handler): |
| 279 | """ |
| 280 | A logging handler capturing all (raw and formatted) logging output. |
| 281 | """ |
| 282 | |
| 283 | def __init__(self): |
| 284 | logging.Handler.__init__(self) |
| 285 | self.watcher = _LoggingWatcher([], []) |
| 286 | |
| 287 | def flush(self): |
| 288 | pass |
| 289 | |
| 290 | def emit(self, record): |
| 291 | self.watcher.records.append(record) |
| 292 | msg = self.format(record) |
| 293 | self.watcher.output.append(msg) |
| 294 | |
| 295 | |
| 296 | |
| 297 | class _AssertLogsContext(_BaseTestCaseContext): |
| 298 | """A context manager used to implement TestCase.assertLogs().""" |
| 299 | |
| 300 | LOGGING_FORMAT = "%(levelname)s:%(name)s:%(message)s" |
| 301 | |
| 302 | def __init__(self, test_case, logger_name, level): |
| 303 | _BaseTestCaseContext.__init__(self, test_case) |
| 304 | self.logger_name = logger_name |
| 305 | if level: |
| 306 | self.level = logging._nameToLevel.get(level, level) |
| 307 | else: |
| 308 | self.level = logging.INFO |
| 309 | self.msg = None |
| 310 | |
| 311 | def __enter__(self): |
| 312 | if isinstance(self.logger_name, logging.Logger): |
| 313 | logger = self.logger = self.logger_name |
| 314 | else: |
| 315 | logger = self.logger = logging.getLogger(self.logger_name) |
| 316 | formatter = logging.Formatter(self.LOGGING_FORMAT) |
| 317 | handler = _CapturingHandler() |
| 318 | handler.setFormatter(formatter) |
| 319 | self.watcher = handler.watcher |
| 320 | self.old_handlers = logger.handlers[:] |
| 321 | self.old_level = logger.level |
| 322 | self.old_propagate = logger.propagate |
| 323 | logger.handlers = [handler] |
| 324 | logger.setLevel(self.level) |
| 325 | logger.propagate = False |
| 326 | return handler.watcher |
| 327 | |
| 328 | def __exit__(self, exc_type, exc_value, tb): |
| 329 | self.logger.handlers = self.old_handlers |
| 330 | self.logger.propagate = self.old_propagate |
| 331 | self.logger.setLevel(self.old_level) |
| 332 | if exc_type is not None: |
| 333 | # let unexpected exceptions pass through |
| 334 | return False |
| 335 | if len(self.watcher.records) == 0: |
| 336 | self._raiseFailure( |
| 337 | "no logs of level {} or higher triggered on {}" |
| 338 | .format(logging.getLevelName(self.level), self.logger.name)) |
| 339 | |
| 340 | |
Serhiy Storchaka | 48fbe52 | 2017-06-23 21:47:39 +0300 | [diff] [blame] | 341 | class _OrderedChainMap(collections.ChainMap): |
| 342 | def __iter__(self): |
| 343 | seen = set() |
| 344 | for mapping in self.maps: |
| 345 | for k in mapping: |
| 346 | if k not in seen: |
| 347 | seen.add(k) |
| 348 | yield k |
| 349 | |
| 350 | |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 351 | class TestCase(object): |
| 352 | """A class whose instances are single test cases. |
| 353 | |
| 354 | By default, the test code itself should be placed in a method named |
| 355 | 'runTest'. |
| 356 | |
| 357 | If the fixture may be used for many test cases, create as |
| 358 | many test methods as are needed. When instantiating such a TestCase |
| 359 | subclass, specify in the constructor arguments the name of the test method |
| 360 | that the instance is to execute. |
| 361 | |
| 362 | Test authors should subclass TestCase for their own tests. Construction |
| 363 | and deconstruction of the test's environment ('fixture') can be |
| 364 | implemented by overriding the 'setUp' and 'tearDown' methods respectively. |
| 365 | |
| 366 | If it is necessary to override the __init__ method, the base class |
| 367 | __init__ method must always be called. It is important that subclasses |
| 368 | should not change the signature of their __init__ method, since instances |
| 369 | of the classes are instantiated automatically by parts of the framework |
| 370 | in order to be run. |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 371 | |
Ezio Melotti | 31797e5 | 2013-03-29 03:42:29 +0200 | [diff] [blame] | 372 | When subclassing TestCase, you can set these attributes: |
| 373 | * failureException: determines which exception will be raised when |
| 374 | the instance's assertion methods fail; test methods raising this |
| 375 | exception will be deemed to have 'failed' rather than 'errored'. |
| 376 | * longMessage: determines whether long messages (including repr of |
| 377 | objects used in assert methods) will be printed on failure in *addition* |
| 378 | to any explicit message passed. |
| 379 | * maxDiff: sets the maximum length of a diff in failure messages |
| 380 | by assert methods using difflib. It is looked up as an instance |
| 381 | attribute so can be configured by individual tests if required. |
| 382 | """ |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 383 | |
| 384 | failureException = AssertionError |
| 385 | |
Michael Foord | 5074df6 | 2010-12-03 00:53:09 +0000 | [diff] [blame] | 386 | longMessage = True |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 387 | |
Michael Foord | 085dfd3 | 2010-06-05 12:17:02 +0000 | [diff] [blame] | 388 | maxDiff = 80*8 |
| 389 | |
Ezio Melotti | edd117f | 2011-04-27 10:20:38 +0300 | [diff] [blame] | 390 | # If a string is longer than _diffThreshold, use normal comparison instead |
| 391 | # of difflib. See #11763. |
| 392 | _diffThreshold = 2**16 |
| 393 | |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 394 | # Attribute used by TestSuite for classSetUp |
| 395 | |
| 396 | _classSetupFailed = False |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 397 | |
| 398 | def __init__(self, methodName='runTest'): |
| 399 | """Create an instance of the class that will use the named test |
| 400 | method when executed. Raises a ValueError if the instance does |
| 401 | not have a method with the specified name. |
| 402 | """ |
| 403 | self._testMethodName = methodName |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 404 | self._outcome = None |
Michael Foord | 32e1d83 | 2011-01-03 17:00:11 +0000 | [diff] [blame] | 405 | self._testMethodDoc = 'No test' |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 406 | try: |
| 407 | testMethod = getattr(self, methodName) |
| 408 | except AttributeError: |
Michael Foord | 32e1d83 | 2011-01-03 17:00:11 +0000 | [diff] [blame] | 409 | if methodName != 'runTest': |
| 410 | # we allow instantiation with no explicit method name |
| 411 | # but not an *incorrect* or missing method name |
| 412 | raise ValueError("no such test method in %s: %s" % |
| 413 | (self.__class__, methodName)) |
| 414 | else: |
| 415 | self._testMethodDoc = testMethod.__doc__ |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 416 | self._cleanups = [] |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 417 | self._subtest = None |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 418 | |
| 419 | # Map types to custom assertEqual functions that will compare |
| 420 | # instances of said type in more detail to generate a more useful |
| 421 | # error message. |
Benjamin Peterson | 34b2b26 | 2011-07-12 19:21:42 -0500 | [diff] [blame] | 422 | self._type_equality_funcs = {} |
Michael Foord | 8ca6d98 | 2010-11-20 15:34:26 +0000 | [diff] [blame] | 423 | self.addTypeEqualityFunc(dict, 'assertDictEqual') |
| 424 | self.addTypeEqualityFunc(list, 'assertListEqual') |
| 425 | self.addTypeEqualityFunc(tuple, 'assertTupleEqual') |
| 426 | self.addTypeEqualityFunc(set, 'assertSetEqual') |
| 427 | self.addTypeEqualityFunc(frozenset, 'assertSetEqual') |
| 428 | self.addTypeEqualityFunc(str, 'assertMultiLineEqual') |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 429 | |
| 430 | def addTypeEqualityFunc(self, typeobj, function): |
| 431 | """Add a type specific assertEqual style function to compare a type. |
| 432 | |
| 433 | This method is for use by TestCase subclasses that need to register |
| 434 | their own type equality functions to provide nicer error messages. |
| 435 | |
| 436 | Args: |
| 437 | typeobj: The data type to call this function on when both values |
| 438 | are of the same type in assertEqual(). |
| 439 | function: The callable taking two arguments and an optional |
| 440 | msg= argument that raises self.failureException with a |
| 441 | useful error message when the two arguments are not equal. |
| 442 | """ |
Benjamin Peterson | 8f326b2 | 2009-12-13 02:10:36 +0000 | [diff] [blame] | 443 | self._type_equality_funcs[typeobj] = function |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 444 | |
| 445 | def addCleanup(self, function, *args, **kwargs): |
| 446 | """Add a function, with arguments, to be called when the test is |
| 447 | completed. Functions added are called on a LIFO basis and are |
| 448 | called after tearDown on test failure or success. |
| 449 | |
| 450 | Cleanup items are called even if setUp fails (unlike tearDown).""" |
| 451 | self._cleanups.append((function, args, kwargs)) |
| 452 | |
| 453 | def setUp(self): |
| 454 | "Hook method for setting up the test fixture before exercising it." |
| 455 | pass |
| 456 | |
| 457 | def tearDown(self): |
| 458 | "Hook method for deconstructing the test fixture after testing it." |
| 459 | pass |
| 460 | |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 461 | @classmethod |
| 462 | def setUpClass(cls): |
| 463 | "Hook method for setting up class fixture before running tests in the class." |
| 464 | |
| 465 | @classmethod |
| 466 | def tearDownClass(cls): |
| 467 | "Hook method for deconstructing the class fixture after running all tests in the class." |
| 468 | |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 469 | def countTestCases(self): |
| 470 | return 1 |
| 471 | |
| 472 | def defaultTestResult(self): |
| 473 | return result.TestResult() |
| 474 | |
| 475 | def shortDescription(self): |
Michael Foord | 34c9462 | 2010-02-10 15:51:42 +0000 | [diff] [blame] | 476 | """Returns a one-line description of the test, or None if no |
| 477 | description has been provided. |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 478 | |
Michael Foord | 34c9462 | 2010-02-10 15:51:42 +0000 | [diff] [blame] | 479 | The default implementation of this method returns the first line of |
| 480 | the specified test method's docstring. |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 481 | """ |
Michael Foord | 34c9462 | 2010-02-10 15:51:42 +0000 | [diff] [blame] | 482 | doc = self._testMethodDoc |
| 483 | return doc and doc.split("\n")[0].strip() or None |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 484 | |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 485 | |
| 486 | def id(self): |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 487 | return "%s.%s" % (strclass(self.__class__), self._testMethodName) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 488 | |
| 489 | def __eq__(self, other): |
| 490 | if type(self) is not type(other): |
| 491 | return NotImplemented |
| 492 | |
| 493 | return self._testMethodName == other._testMethodName |
| 494 | |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 495 | def __hash__(self): |
| 496 | return hash((type(self), self._testMethodName)) |
| 497 | |
| 498 | def __str__(self): |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 499 | return "%s (%s)" % (self._testMethodName, strclass(self.__class__)) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 500 | |
| 501 | def __repr__(self): |
| 502 | return "<%s testMethod=%s>" % \ |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 503 | (strclass(self.__class__), self._testMethodName) |
| 504 | |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 505 | def _addSkip(self, result, test_case, reason): |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 506 | addSkip = getattr(result, 'addSkip', None) |
| 507 | if addSkip is not None: |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 508 | addSkip(test_case, reason) |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 509 | else: |
| 510 | warnings.warn("TestResult has no addSkip method, skips not reported", |
| 511 | RuntimeWarning, 2) |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 512 | result.addSuccess(test_case) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 513 | |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 514 | @contextlib.contextmanager |
Berker Peksag | 16ea19f | 2016-09-21 19:34:15 +0300 | [diff] [blame] | 515 | def subTest(self, msg=_subtest_msg_sentinel, **params): |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 516 | """Return a context manager that will return the enclosed block |
| 517 | of code in a subtest identified by the optional message and |
| 518 | keyword parameters. A failure in the subtest marks the test |
| 519 | case as failed but resumes execution at the end of the enclosed |
| 520 | block, allowing further test code to be executed. |
| 521 | """ |
| 522 | if not self._outcome.result_supports_subtests: |
| 523 | yield |
| 524 | return |
| 525 | parent = self._subtest |
| 526 | if parent is None: |
Serhiy Storchaka | 48fbe52 | 2017-06-23 21:47:39 +0300 | [diff] [blame] | 527 | params_map = _OrderedChainMap(params) |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 528 | else: |
| 529 | params_map = parent.params.new_child(params) |
| 530 | self._subtest = _SubTest(self, msg, params_map) |
Michael Foord | b3468f7 | 2010-12-19 03:19:47 +0000 | [diff] [blame] | 531 | try: |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 532 | with self._outcome.testPartExecutor(self._subtest, isTest=True): |
| 533 | yield |
| 534 | if not self._outcome.success: |
| 535 | result = self._outcome.result |
| 536 | if result is not None and result.failfast: |
| 537 | raise _ShouldStop |
| 538 | elif self._outcome.expectedFailure: |
| 539 | # If the test is expecting a failure, we really want to |
| 540 | # stop now and register the expected failure. |
| 541 | raise _ShouldStop |
| 542 | finally: |
| 543 | self._subtest = parent |
| 544 | |
| 545 | def _feedErrorsToResult(self, result, errors): |
| 546 | for test, exc_info in errors: |
| 547 | if isinstance(test, _SubTest): |
| 548 | result.addSubTest(test.test_case, test, exc_info) |
| 549 | elif exc_info is not None: |
| 550 | if issubclass(exc_info[0], self.failureException): |
| 551 | result.addFailure(test, exc_info) |
| 552 | else: |
| 553 | result.addError(test, exc_info) |
| 554 | |
| 555 | def _addExpectedFailure(self, result, exc_info): |
| 556 | try: |
| 557 | addExpectedFailure = result.addExpectedFailure |
| 558 | except AttributeError: |
| 559 | warnings.warn("TestResult has no addExpectedFailure method, reporting as passes", |
| 560 | RuntimeWarning) |
| 561 | result.addSuccess(self) |
| 562 | else: |
| 563 | addExpectedFailure(self, exc_info) |
| 564 | |
| 565 | def _addUnexpectedSuccess(self, result): |
| 566 | try: |
| 567 | addUnexpectedSuccess = result.addUnexpectedSuccess |
| 568 | except AttributeError: |
| 569 | warnings.warn("TestResult has no addUnexpectedSuccess method, reporting as failure", |
| 570 | RuntimeWarning) |
| 571 | # We need to pass an actual exception and traceback to addFailure, |
| 572 | # otherwise the legacy result can choke. |
| 573 | try: |
| 574 | raise _UnexpectedSuccess from None |
| 575 | except _UnexpectedSuccess: |
| 576 | result.addFailure(self, sys.exc_info()) |
| 577 | else: |
| 578 | addUnexpectedSuccess(self) |
Michael Foord | b3468f7 | 2010-12-19 03:19:47 +0000 | [diff] [blame] | 579 | |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 580 | def run(self, result=None): |
| 581 | orig_result = result |
| 582 | if result is None: |
| 583 | result = self.defaultTestResult() |
| 584 | startTestRun = getattr(result, 'startTestRun', None) |
| 585 | if startTestRun is not None: |
| 586 | startTestRun() |
| 587 | |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 588 | result.startTest(self) |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 589 | |
| 590 | testMethod = getattr(self, self._testMethodName) |
| 591 | if (getattr(self.__class__, "__unittest_skip__", False) or |
| 592 | getattr(testMethod, "__unittest_skip__", False)): |
| 593 | # If the class or method was skipped. |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 594 | try: |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 595 | skip_why = (getattr(self.__class__, '__unittest_skip_why__', '') |
| 596 | or getattr(testMethod, '__unittest_skip_why__', '')) |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 597 | self._addSkip(result, self, skip_why) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 598 | finally: |
| 599 | result.stopTest(self) |
| 600 | return |
Robert Collins | ed599b7 | 2015-08-28 10:34:51 +1200 | [diff] [blame] | 601 | expecting_failure_method = getattr(testMethod, |
| 602 | "__unittest_expecting_failure__", False) |
| 603 | expecting_failure_class = getattr(self, |
| 604 | "__unittest_expecting_failure__", False) |
| 605 | expecting_failure = expecting_failure_class or expecting_failure_method |
Victor Stinner | 031bd53 | 2013-12-09 01:52:50 +0100 | [diff] [blame] | 606 | outcome = _Outcome(result) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 607 | try: |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 608 | self._outcome = outcome |
Michael Foord | b3468f7 | 2010-12-19 03:19:47 +0000 | [diff] [blame] | 609 | |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 610 | with outcome.testPartExecutor(self): |
| 611 | self.setUp() |
Michael Foord | b3468f7 | 2010-12-19 03:19:47 +0000 | [diff] [blame] | 612 | if outcome.success: |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 613 | outcome.expecting_failure = expecting_failure |
| 614 | with outcome.testPartExecutor(self, isTest=True): |
| 615 | testMethod() |
| 616 | outcome.expecting_failure = False |
| 617 | with outcome.testPartExecutor(self): |
| 618 | self.tearDown() |
Michael Foord | b3468f7 | 2010-12-19 03:19:47 +0000 | [diff] [blame] | 619 | |
| 620 | self.doCleanups() |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 621 | for test, reason in outcome.skipped: |
| 622 | self._addSkip(result, test, reason) |
| 623 | self._feedErrorsToResult(result, outcome.errors) |
Michael Foord | b3468f7 | 2010-12-19 03:19:47 +0000 | [diff] [blame] | 624 | if outcome.success: |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 625 | if expecting_failure: |
| 626 | if outcome.expectedFailure: |
| 627 | self._addExpectedFailure(result, outcome.expectedFailure) |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 628 | else: |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 629 | self._addUnexpectedSuccess(result) |
| 630 | else: |
| 631 | result.addSuccess(self) |
Michael Foord | 1341bb0 | 2011-03-14 19:01:46 -0400 | [diff] [blame] | 632 | return result |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 633 | finally: |
| 634 | result.stopTest(self) |
| 635 | if orig_result is None: |
| 636 | stopTestRun = getattr(result, 'stopTestRun', None) |
| 637 | if stopTestRun is not None: |
| 638 | stopTestRun() |
| 639 | |
Victor Stinner | 031bd53 | 2013-12-09 01:52:50 +0100 | [diff] [blame] | 640 | # explicitly break reference cycles: |
| 641 | # outcome.errors -> frame -> outcome -> outcome.errors |
| 642 | # outcome.expectedFailure -> frame -> outcome -> outcome.expectedFailure |
| 643 | outcome.errors.clear() |
| 644 | outcome.expectedFailure = None |
| 645 | |
| 646 | # clear the outcome, no more needed |
| 647 | self._outcome = None |
| 648 | |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 649 | def doCleanups(self): |
| 650 | """Execute all cleanup functions. Normally called for you after |
| 651 | tearDown.""" |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 652 | outcome = self._outcome or _Outcome() |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 653 | while self._cleanups: |
Michael Foord | b3468f7 | 2010-12-19 03:19:47 +0000 | [diff] [blame] | 654 | function, args, kwargs = self._cleanups.pop() |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 655 | with outcome.testPartExecutor(self): |
| 656 | function(*args, **kwargs) |
Michael Foord | b3468f7 | 2010-12-19 03:19:47 +0000 | [diff] [blame] | 657 | |
| 658 | # return this for backwards compatibility |
| 659 | # even though we no longer us it internally |
| 660 | return outcome.success |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 661 | |
| 662 | def __call__(self, *args, **kwds): |
| 663 | return self.run(*args, **kwds) |
| 664 | |
| 665 | def debug(self): |
| 666 | """Run the test without collecting errors in a TestResult""" |
| 667 | self.setUp() |
| 668 | getattr(self, self._testMethodName)() |
| 669 | self.tearDown() |
Michael Foord | b874874 | 2010-06-10 16:16:08 +0000 | [diff] [blame] | 670 | while self._cleanups: |
| 671 | function, args, kwargs = self._cleanups.pop(-1) |
| 672 | function(*args, **kwargs) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 673 | |
| 674 | def skipTest(self, reason): |
| 675 | """Skip this test.""" |
| 676 | raise SkipTest(reason) |
| 677 | |
| 678 | def fail(self, msg=None): |
| 679 | """Fail immediately, with the given message.""" |
| 680 | raise self.failureException(msg) |
| 681 | |
| 682 | def assertFalse(self, expr, msg=None): |
Ezio Melotti | 3044fa7 | 2010-12-18 17:31:58 +0000 | [diff] [blame] | 683 | """Check that the expression is false.""" |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 684 | if expr: |
Ezio Melotti | 3044fa7 | 2010-12-18 17:31:58 +0000 | [diff] [blame] | 685 | msg = self._formatMessage(msg, "%s is not false" % safe_repr(expr)) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 686 | raise self.failureException(msg) |
| 687 | |
| 688 | def assertTrue(self, expr, msg=None): |
Ezio Melotti | 3044fa7 | 2010-12-18 17:31:58 +0000 | [diff] [blame] | 689 | """Check that the expression is true.""" |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 690 | if not expr: |
Ezio Melotti | 3044fa7 | 2010-12-18 17:31:58 +0000 | [diff] [blame] | 691 | msg = self._formatMessage(msg, "%s is not true" % safe_repr(expr)) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 692 | raise self.failureException(msg) |
| 693 | |
| 694 | def _formatMessage(self, msg, standardMsg): |
| 695 | """Honour the longMessage attribute when generating failure messages. |
| 696 | If longMessage is False this means: |
| 697 | * Use only an explicit message if it is provided |
| 698 | * Otherwise use the standard message for the assert |
| 699 | |
| 700 | If longMessage is True: |
| 701 | * Use the standard message |
| 702 | * If an explicit message is provided, plus ' : ' and the explicit message |
| 703 | """ |
| 704 | if not self.longMessage: |
| 705 | return msg or standardMsg |
| 706 | if msg is None: |
| 707 | return standardMsg |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 708 | try: |
| 709 | # don't switch to '{}' formatting in Python 2.X |
| 710 | # it changes the way unicode input is handled |
| 711 | return '%s : %s' % (standardMsg, msg) |
| 712 | except UnicodeDecodeError: |
| 713 | return '%s : %s' % (safe_repr(standardMsg), safe_repr(msg)) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 714 | |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 715 | def assertRaises(self, expected_exception, *args, **kwargs): |
| 716 | """Fail unless an exception of class expected_exception is raised |
| 717 | by the callable when invoked with specified positional and |
| 718 | keyword arguments. If a different type of exception is |
Andrew Svetlov | 737fb89 | 2012-12-18 21:14:22 +0200 | [diff] [blame] | 719 | raised, it will not be caught, and the test case will be |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 720 | deemed to have suffered an error, exactly as for an |
| 721 | unexpected exception. |
| 722 | |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 723 | If called with the callable and arguments omitted, will return a |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 724 | context object used like this:: |
| 725 | |
Michael Foord | 1c42b12 | 2010-02-05 22:58:21 +0000 | [diff] [blame] | 726 | with self.assertRaises(SomeException): |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 727 | do_something() |
Michael Foord | 1c42b12 | 2010-02-05 22:58:21 +0000 | [diff] [blame] | 728 | |
Ezio Melotti | b4dc250 | 2011-05-06 15:01:41 +0300 | [diff] [blame] | 729 | An optional keyword argument 'msg' can be provided when assertRaises |
| 730 | is used as a context object. |
| 731 | |
Michael Foord | 1c42b12 | 2010-02-05 22:58:21 +0000 | [diff] [blame] | 732 | The context manager keeps a reference to the exception as |
Ezio Melotti | 4900823 | 2010-02-08 21:57:48 +0000 | [diff] [blame] | 733 | the 'exception' attribute. This allows you to inspect the |
Michael Foord | 1c42b12 | 2010-02-05 22:58:21 +0000 | [diff] [blame] | 734 | exception after the assertion:: |
| 735 | |
| 736 | with self.assertRaises(SomeException) as cm: |
| 737 | do_something() |
Ezio Melotti | 4900823 | 2010-02-08 21:57:48 +0000 | [diff] [blame] | 738 | the_exception = cm.exception |
Michael Foord | b57ac6d | 2010-02-05 23:26:29 +0000 | [diff] [blame] | 739 | self.assertEqual(the_exception.error_code, 3) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 740 | """ |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 741 | context = _AssertRaisesContext(expected_exception, self) |
Victor Stinner | bbd3cf8 | 2017-03-28 00:56:28 +0200 | [diff] [blame] | 742 | try: |
| 743 | return context.handle('assertRaises', args, kwargs) |
| 744 | finally: |
| 745 | # bpo-23890: manually break a reference cycle |
| 746 | context = None |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 747 | |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 748 | def assertWarns(self, expected_warning, *args, **kwargs): |
Antoine Pitrou | 4bc12ef | 2010-09-06 19:25:46 +0000 | [diff] [blame] | 749 | """Fail unless a warning of class warnClass is triggered |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 750 | by the callable when invoked with specified positional and |
| 751 | keyword arguments. If a different type of warning is |
Antoine Pitrou | 4bc12ef | 2010-09-06 19:25:46 +0000 | [diff] [blame] | 752 | triggered, it will not be handled: depending on the other |
| 753 | warning filtering rules in effect, it might be silenced, printed |
| 754 | out, or raised as an exception. |
| 755 | |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 756 | If called with the callable and arguments omitted, will return a |
Antoine Pitrou | 4bc12ef | 2010-09-06 19:25:46 +0000 | [diff] [blame] | 757 | context object used like this:: |
| 758 | |
| 759 | with self.assertWarns(SomeWarning): |
| 760 | do_something() |
| 761 | |
Ezio Melotti | b4dc250 | 2011-05-06 15:01:41 +0300 | [diff] [blame] | 762 | An optional keyword argument 'msg' can be provided when assertWarns |
| 763 | is used as a context object. |
| 764 | |
Antoine Pitrou | 4bc12ef | 2010-09-06 19:25:46 +0000 | [diff] [blame] | 765 | The context manager keeps a reference to the first matching |
| 766 | warning as the 'warning' attribute; similarly, the 'filename' |
| 767 | and 'lineno' attributes give you information about the line |
| 768 | of Python code from which the warning was triggered. |
| 769 | This allows you to inspect the warning after the assertion:: |
| 770 | |
| 771 | with self.assertWarns(SomeWarning) as cm: |
| 772 | do_something() |
| 773 | the_warning = cm.warning |
| 774 | self.assertEqual(the_warning.some_attribute, 147) |
| 775 | """ |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 776 | context = _AssertWarnsContext(expected_warning, self) |
| 777 | return context.handle('assertWarns', args, kwargs) |
Antoine Pitrou | 4bc12ef | 2010-09-06 19:25:46 +0000 | [diff] [blame] | 778 | |
Antoine Pitrou | 0715b9f | 2013-09-14 19:45:47 +0200 | [diff] [blame] | 779 | def assertLogs(self, logger=None, level=None): |
| 780 | """Fail unless a log message of level *level* or higher is emitted |
| 781 | on *logger_name* or its children. If omitted, *level* defaults to |
| 782 | INFO and *logger* defaults to the root logger. |
| 783 | |
| 784 | This method must be used as a context manager, and will yield |
| 785 | a recording object with two attributes: `output` and `records`. |
| 786 | At the end of the context manager, the `output` attribute will |
| 787 | be a list of the matching formatted log messages and the |
| 788 | `records` attribute will be a list of the corresponding LogRecord |
| 789 | objects. |
| 790 | |
| 791 | Example:: |
| 792 | |
| 793 | with self.assertLogs('foo', level='INFO') as cm: |
| 794 | logging.getLogger('foo').info('first message') |
| 795 | logging.getLogger('foo.bar').error('second message') |
| 796 | self.assertEqual(cm.output, ['INFO:foo:first message', |
| 797 | 'ERROR:foo.bar:second message']) |
| 798 | """ |
| 799 | return _AssertLogsContext(self, logger, level) |
| 800 | |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 801 | def _getAssertEqualityFunc(self, first, second): |
| 802 | """Get a detailed comparison function for the types of the two args. |
| 803 | |
| 804 | Returns: A callable accepting (first, second, msg=None) that will |
| 805 | raise a failure exception if first != second with a useful human |
| 806 | readable error message for those types. |
| 807 | """ |
| 808 | # |
| 809 | # NOTE(gregory.p.smith): I considered isinstance(first, type(second)) |
| 810 | # and vice versa. I opted for the conservative approach in case |
| 811 | # subclasses are not intended to be compared in detail to their super |
| 812 | # class instances using a type equality func. This means testing |
| 813 | # subtypes won't automagically use the detailed comparison. Callers |
| 814 | # should use their type specific assertSpamEqual method to compare |
| 815 | # subclasses if the detailed comparison is desired and appropriate. |
| 816 | # See the discussion in http://bugs.python.org/issue2578. |
| 817 | # |
| 818 | if type(first) is type(second): |
| 819 | asserter = self._type_equality_funcs.get(type(first)) |
| 820 | if asserter is not None: |
Benjamin Peterson | 34b2b26 | 2011-07-12 19:21:42 -0500 | [diff] [blame] | 821 | if isinstance(asserter, str): |
| 822 | asserter = getattr(self, asserter) |
Benjamin Peterson | 8f326b2 | 2009-12-13 02:10:36 +0000 | [diff] [blame] | 823 | return asserter |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 824 | |
| 825 | return self._baseAssertEqual |
| 826 | |
| 827 | def _baseAssertEqual(self, first, second, msg=None): |
| 828 | """The default assertEqual implementation, not type specific.""" |
| 829 | if not first == second: |
Serhiy Storchaka | 77622f5 | 2013-09-23 23:07:00 +0300 | [diff] [blame] | 830 | standardMsg = '%s != %s' % _common_shorten_repr(first, second) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 831 | msg = self._formatMessage(msg, standardMsg) |
| 832 | raise self.failureException(msg) |
| 833 | |
| 834 | def assertEqual(self, first, second, msg=None): |
| 835 | """Fail if the two objects are unequal as determined by the '==' |
| 836 | operator. |
| 837 | """ |
| 838 | assertion_func = self._getAssertEqualityFunc(first, second) |
| 839 | assertion_func(first, second, msg=msg) |
| 840 | |
| 841 | def assertNotEqual(self, first, second, msg=None): |
Ezio Melotti | 90eea97 | 2012-11-08 11:08:39 +0200 | [diff] [blame] | 842 | """Fail if the two objects are equal as determined by the '!=' |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 843 | operator. |
| 844 | """ |
| 845 | if not first != second: |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 846 | msg = self._formatMessage(msg, '%s == %s' % (safe_repr(first), |
| 847 | safe_repr(second))) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 848 | raise self.failureException(msg) |
| 849 | |
Michael Foord | 321d059 | 2010-11-02 13:44:51 +0000 | [diff] [blame] | 850 | def assertAlmostEqual(self, first, second, places=None, msg=None, |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 851 | delta=None): |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 852 | """Fail if the two objects are unequal as determined by their |
| 853 | difference rounded to the given number of decimal places |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 854 | (default 7) and comparing to zero, or by comparing that the |
| 855 | between the two objects is more than the given delta. |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 856 | |
| 857 | Note that decimal places (from zero) are usually not the same |
Martin Panter | eb99570 | 2016-07-28 01:11:04 +0000 | [diff] [blame] | 858 | as significant digits (measured from the most significant digit). |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 859 | |
| 860 | If the two objects compare equal then they will automatically |
| 861 | compare almost equal. |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 862 | """ |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 863 | if first == second: |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 864 | # shortcut |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 865 | return |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 866 | if delta is not None and places is not None: |
| 867 | raise TypeError("specify delta or places not both") |
| 868 | |
Giampaolo Rodola | 5d7a8d0 | 2017-05-01 18:18:56 +0200 | [diff] [blame] | 869 | diff = abs(first - second) |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 870 | if delta is not None: |
Giampaolo Rodola | 5d7a8d0 | 2017-05-01 18:18:56 +0200 | [diff] [blame] | 871 | if diff <= delta: |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 872 | return |
| 873 | |
Giampaolo Rodola | 5d7a8d0 | 2017-05-01 18:18:56 +0200 | [diff] [blame] | 874 | standardMsg = '%s != %s within %s delta (%s difference)' % ( |
| 875 | safe_repr(first), |
| 876 | safe_repr(second), |
| 877 | safe_repr(delta), |
| 878 | safe_repr(diff)) |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 879 | else: |
| 880 | if places is None: |
| 881 | places = 7 |
| 882 | |
Giampaolo Rodola | 5d7a8d0 | 2017-05-01 18:18:56 +0200 | [diff] [blame] | 883 | if round(diff, places) == 0: |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 884 | return |
| 885 | |
Giampaolo Rodola | 5d7a8d0 | 2017-05-01 18:18:56 +0200 | [diff] [blame] | 886 | standardMsg = '%s != %s within %r places (%s difference)' % ( |
| 887 | safe_repr(first), |
| 888 | safe_repr(second), |
| 889 | places, |
| 890 | safe_repr(diff)) |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 891 | msg = self._formatMessage(msg, standardMsg) |
| 892 | raise self.failureException(msg) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 893 | |
Michael Foord | 321d059 | 2010-11-02 13:44:51 +0000 | [diff] [blame] | 894 | def assertNotAlmostEqual(self, first, second, places=None, msg=None, |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 895 | delta=None): |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 896 | """Fail if the two objects are equal as determined by their |
| 897 | difference rounded to the given number of decimal places |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 898 | (default 7) and comparing to zero, or by comparing that the |
| 899 | between the two objects is less than the given delta. |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 900 | |
| 901 | Note that decimal places (from zero) are usually not the same |
Martin Panter | eb99570 | 2016-07-28 01:11:04 +0000 | [diff] [blame] | 902 | as significant digits (measured from the most significant digit). |
Benjamin Peterson | 4ac9ce4 | 2009-10-04 14:49:41 +0000 | [diff] [blame] | 903 | |
| 904 | Objects that are equal automatically fail. |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 905 | """ |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 906 | if delta is not None and places is not None: |
| 907 | raise TypeError("specify delta or places not both") |
Giampaolo Rodola | 5d7a8d0 | 2017-05-01 18:18:56 +0200 | [diff] [blame] | 908 | diff = abs(first - second) |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 909 | if delta is not None: |
Giampaolo Rodola | 5d7a8d0 | 2017-05-01 18:18:56 +0200 | [diff] [blame] | 910 | if not (first == second) and diff > delta: |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 911 | return |
Giampaolo Rodola | 5d7a8d0 | 2017-05-01 18:18:56 +0200 | [diff] [blame] | 912 | standardMsg = '%s == %s within %s delta (%s difference)' % ( |
| 913 | safe_repr(first), |
| 914 | safe_repr(second), |
| 915 | safe_repr(delta), |
| 916 | safe_repr(diff)) |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 917 | else: |
| 918 | if places is None: |
| 919 | places = 7 |
Giampaolo Rodola | 5d7a8d0 | 2017-05-01 18:18:56 +0200 | [diff] [blame] | 920 | if not (first == second) and round(diff, places) != 0: |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 921 | return |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 922 | standardMsg = '%s == %s within %r places' % (safe_repr(first), |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 923 | safe_repr(second), |
| 924 | places) |
| 925 | |
| 926 | msg = self._formatMessage(msg, standardMsg) |
| 927 | raise self.failureException(msg) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 928 | |
Michael Foord | 085dfd3 | 2010-06-05 12:17:02 +0000 | [diff] [blame] | 929 | def assertSequenceEqual(self, seq1, seq2, msg=None, seq_type=None): |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 930 | """An equality assertion for ordered sequences (like lists and tuples). |
| 931 | |
R. David Murray | ad13f22 | 2010-01-29 22:17:58 +0000 | [diff] [blame] | 932 | For the purposes of this function, a valid ordered sequence type is one |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 933 | which can be indexed, has a length, and has an equality operator. |
| 934 | |
| 935 | Args: |
| 936 | seq1: The first sequence to compare. |
| 937 | seq2: The second sequence to compare. |
| 938 | seq_type: The expected datatype of the sequences, or None if no |
| 939 | datatype should be enforced. |
| 940 | msg: Optional message to use on failure instead of a list of |
| 941 | differences. |
| 942 | """ |
Benjamin Peterson | b29614e | 2012-10-09 11:16:03 -0400 | [diff] [blame] | 943 | if seq_type is not None: |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 944 | seq_type_name = seq_type.__name__ |
| 945 | if not isinstance(seq1, seq_type): |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 946 | raise self.failureException('First sequence is not a %s: %s' |
| 947 | % (seq_type_name, safe_repr(seq1))) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 948 | if not isinstance(seq2, seq_type): |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 949 | raise self.failureException('Second sequence is not a %s: %s' |
| 950 | % (seq_type_name, safe_repr(seq2))) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 951 | else: |
| 952 | seq_type_name = "sequence" |
| 953 | |
| 954 | differing = None |
| 955 | try: |
| 956 | len1 = len(seq1) |
| 957 | except (TypeError, NotImplementedError): |
| 958 | differing = 'First %s has no length. Non-sequence?' % ( |
| 959 | seq_type_name) |
| 960 | |
| 961 | if differing is None: |
| 962 | try: |
| 963 | len2 = len(seq2) |
| 964 | except (TypeError, NotImplementedError): |
| 965 | differing = 'Second %s has no length. Non-sequence?' % ( |
| 966 | seq_type_name) |
| 967 | |
| 968 | if differing is None: |
| 969 | if seq1 == seq2: |
| 970 | return |
| 971 | |
Serhiy Storchaka | 77622f5 | 2013-09-23 23:07:00 +0300 | [diff] [blame] | 972 | differing = '%ss differ: %s != %s\n' % ( |
| 973 | (seq_type_name.capitalize(),) + |
| 974 | _common_shorten_repr(seq1, seq2)) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 975 | |
| 976 | for i in range(min(len1, len2)): |
| 977 | try: |
| 978 | item1 = seq1[i] |
| 979 | except (TypeError, IndexError, NotImplementedError): |
| 980 | differing += ('\nUnable to index element %d of first %s\n' % |
| 981 | (i, seq_type_name)) |
| 982 | break |
| 983 | |
| 984 | try: |
| 985 | item2 = seq2[i] |
| 986 | except (TypeError, IndexError, NotImplementedError): |
| 987 | differing += ('\nUnable to index element %d of second %s\n' % |
| 988 | (i, seq_type_name)) |
| 989 | break |
| 990 | |
| 991 | if item1 != item2: |
| 992 | differing += ('\nFirst differing element %d:\n%s\n%s\n' % |
Serhiy Storchaka | 685fbed | 2016-04-25 08:58:25 +0300 | [diff] [blame] | 993 | ((i,) + _common_shorten_repr(item1, item2))) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 994 | break |
| 995 | else: |
| 996 | if (len1 == len2 and seq_type is None and |
| 997 | type(seq1) != type(seq2)): |
| 998 | # The sequences are the same, but have differing types. |
| 999 | return |
| 1000 | |
| 1001 | if len1 > len2: |
| 1002 | differing += ('\nFirst %s contains %d additional ' |
| 1003 | 'elements.\n' % (seq_type_name, len1 - len2)) |
| 1004 | try: |
| 1005 | differing += ('First extra element %d:\n%s\n' % |
Serhiy Storchaka | 685fbed | 2016-04-25 08:58:25 +0300 | [diff] [blame] | 1006 | (len2, safe_repr(seq1[len2]))) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1007 | except (TypeError, IndexError, NotImplementedError): |
| 1008 | differing += ('Unable to index element %d ' |
| 1009 | 'of first %s\n' % (len2, seq_type_name)) |
| 1010 | elif len1 < len2: |
| 1011 | differing += ('\nSecond %s contains %d additional ' |
| 1012 | 'elements.\n' % (seq_type_name, len2 - len1)) |
| 1013 | try: |
| 1014 | differing += ('First extra element %d:\n%s\n' % |
Serhiy Storchaka | 685fbed | 2016-04-25 08:58:25 +0300 | [diff] [blame] | 1015 | (len1, safe_repr(seq2[len1]))) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1016 | except (TypeError, IndexError, NotImplementedError): |
| 1017 | differing += ('Unable to index element %d ' |
| 1018 | 'of second %s\n' % (len1, seq_type_name)) |
Michael Foord | 2034d9a | 2010-06-05 11:27:52 +0000 | [diff] [blame] | 1019 | standardMsg = differing |
| 1020 | diffMsg = '\n' + '\n'.join( |
Benjamin Peterson | 6e8c757 | 2009-10-04 20:19:21 +0000 | [diff] [blame] | 1021 | difflib.ndiff(pprint.pformat(seq1).splitlines(), |
| 1022 | pprint.pformat(seq2).splitlines())) |
Michael Foord | 085dfd3 | 2010-06-05 12:17:02 +0000 | [diff] [blame] | 1023 | |
| 1024 | standardMsg = self._truncateMessage(standardMsg, diffMsg) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1025 | msg = self._formatMessage(msg, standardMsg) |
| 1026 | self.fail(msg) |
| 1027 | |
Michael Foord | 085dfd3 | 2010-06-05 12:17:02 +0000 | [diff] [blame] | 1028 | def _truncateMessage(self, message, diff): |
| 1029 | max_diff = self.maxDiff |
| 1030 | if max_diff is None or len(diff) <= max_diff: |
| 1031 | return message + diff |
Michael Foord | 9dad32e | 2010-06-05 13:49:56 +0000 | [diff] [blame] | 1032 | return message + (DIFF_OMITTED % len(diff)) |
Michael Foord | 085dfd3 | 2010-06-05 12:17:02 +0000 | [diff] [blame] | 1033 | |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1034 | def assertListEqual(self, list1, list2, msg=None): |
| 1035 | """A list-specific equality assertion. |
| 1036 | |
| 1037 | Args: |
| 1038 | list1: The first list to compare. |
| 1039 | list2: The second list to compare. |
| 1040 | msg: Optional message to use on failure instead of a list of |
| 1041 | differences. |
| 1042 | |
| 1043 | """ |
| 1044 | self.assertSequenceEqual(list1, list2, msg, seq_type=list) |
| 1045 | |
| 1046 | def assertTupleEqual(self, tuple1, tuple2, msg=None): |
| 1047 | """A tuple-specific equality assertion. |
| 1048 | |
| 1049 | Args: |
| 1050 | tuple1: The first tuple to compare. |
| 1051 | tuple2: The second tuple to compare. |
| 1052 | msg: Optional message to use on failure instead of a list of |
| 1053 | differences. |
| 1054 | """ |
| 1055 | self.assertSequenceEqual(tuple1, tuple2, msg, seq_type=tuple) |
| 1056 | |
| 1057 | def assertSetEqual(self, set1, set2, msg=None): |
| 1058 | """A set-specific equality assertion. |
| 1059 | |
| 1060 | Args: |
| 1061 | set1: The first set to compare. |
| 1062 | set2: The second set to compare. |
| 1063 | msg: Optional message to use on failure instead of a list of |
| 1064 | differences. |
| 1065 | |
Michael Foord | 91c9da3 | 2010-03-20 17:21:27 +0000 | [diff] [blame] | 1066 | assertSetEqual uses ducktyping to support different types of sets, and |
| 1067 | is optimized for sets specifically (parameters must support a |
| 1068 | difference method). |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1069 | """ |
| 1070 | try: |
| 1071 | difference1 = set1.difference(set2) |
| 1072 | except TypeError as e: |
| 1073 | self.fail('invalid type when attempting set difference: %s' % e) |
| 1074 | except AttributeError as e: |
| 1075 | self.fail('first argument does not support set difference: %s' % e) |
| 1076 | |
| 1077 | try: |
| 1078 | difference2 = set2.difference(set1) |
| 1079 | except TypeError as e: |
| 1080 | self.fail('invalid type when attempting set difference: %s' % e) |
| 1081 | except AttributeError as e: |
| 1082 | self.fail('second argument does not support set difference: %s' % e) |
| 1083 | |
| 1084 | if not (difference1 or difference2): |
| 1085 | return |
| 1086 | |
| 1087 | lines = [] |
| 1088 | if difference1: |
| 1089 | lines.append('Items in the first set but not the second:') |
| 1090 | for item in difference1: |
| 1091 | lines.append(repr(item)) |
| 1092 | if difference2: |
| 1093 | lines.append('Items in the second set but not the first:') |
| 1094 | for item in difference2: |
| 1095 | lines.append(repr(item)) |
| 1096 | |
| 1097 | standardMsg = '\n'.join(lines) |
| 1098 | self.fail(self._formatMessage(msg, standardMsg)) |
| 1099 | |
| 1100 | def assertIn(self, member, container, msg=None): |
| 1101 | """Just like self.assertTrue(a in b), but with a nicer default message.""" |
| 1102 | if member not in container: |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 1103 | standardMsg = '%s not found in %s' % (safe_repr(member), |
| 1104 | safe_repr(container)) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1105 | self.fail(self._formatMessage(msg, standardMsg)) |
| 1106 | |
| 1107 | def assertNotIn(self, member, container, msg=None): |
| 1108 | """Just like self.assertTrue(a not in b), but with a nicer default message.""" |
| 1109 | if member in container: |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 1110 | standardMsg = '%s unexpectedly found in %s' % (safe_repr(member), |
| 1111 | safe_repr(container)) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1112 | self.fail(self._formatMessage(msg, standardMsg)) |
| 1113 | |
| 1114 | def assertIs(self, expr1, expr2, msg=None): |
| 1115 | """Just like self.assertTrue(a is b), but with a nicer default message.""" |
| 1116 | if expr1 is not expr2: |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 1117 | standardMsg = '%s is not %s' % (safe_repr(expr1), |
| 1118 | safe_repr(expr2)) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1119 | self.fail(self._formatMessage(msg, standardMsg)) |
| 1120 | |
| 1121 | def assertIsNot(self, expr1, expr2, msg=None): |
| 1122 | """Just like self.assertTrue(a is not b), but with a nicer default message.""" |
| 1123 | if expr1 is expr2: |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 1124 | standardMsg = 'unexpectedly identical: %s' % (safe_repr(expr1),) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1125 | self.fail(self._formatMessage(msg, standardMsg)) |
| 1126 | |
| 1127 | def assertDictEqual(self, d1, d2, msg=None): |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1128 | self.assertIsInstance(d1, dict, 'First argument is not a dictionary') |
| 1129 | self.assertIsInstance(d2, dict, 'Second argument is not a dictionary') |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1130 | |
| 1131 | if d1 != d2: |
Serhiy Storchaka | 77622f5 | 2013-09-23 23:07:00 +0300 | [diff] [blame] | 1132 | standardMsg = '%s != %s' % _common_shorten_repr(d1, d2) |
Michael Foord | 085dfd3 | 2010-06-05 12:17:02 +0000 | [diff] [blame] | 1133 | diff = ('\n' + '\n'.join(difflib.ndiff( |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1134 | pprint.pformat(d1).splitlines(), |
| 1135 | pprint.pformat(d2).splitlines()))) |
Michael Foord | cb11b25 | 2010-06-05 13:14:43 +0000 | [diff] [blame] | 1136 | standardMsg = self._truncateMessage(standardMsg, diff) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1137 | self.fail(self._formatMessage(msg, standardMsg)) |
| 1138 | |
Ezio Melotti | 0f53501 | 2011-04-03 18:02:13 +0300 | [diff] [blame] | 1139 | def assertDictContainsSubset(self, subset, dictionary, msg=None): |
| 1140 | """Checks whether dictionary is a superset of subset.""" |
| 1141 | warnings.warn('assertDictContainsSubset is deprecated', |
| 1142 | DeprecationWarning) |
| 1143 | missing = [] |
| 1144 | mismatched = [] |
| 1145 | for key, value in subset.items(): |
| 1146 | if key not in dictionary: |
| 1147 | missing.append(key) |
| 1148 | elif value != dictionary[key]: |
| 1149 | mismatched.append('%s, expected: %s, actual: %s' % |
| 1150 | (safe_repr(key), safe_repr(value), |
| 1151 | safe_repr(dictionary[key]))) |
| 1152 | |
| 1153 | if not (missing or mismatched): |
| 1154 | return |
| 1155 | |
| 1156 | standardMsg = '' |
| 1157 | if missing: |
| 1158 | standardMsg = 'Missing: %s' % ','.join(safe_repr(m) for m in |
| 1159 | missing) |
| 1160 | if mismatched: |
| 1161 | if standardMsg: |
| 1162 | standardMsg += '; ' |
| 1163 | standardMsg += 'Mismatched values: %s' % ','.join(mismatched) |
| 1164 | |
| 1165 | self.fail(self._formatMessage(msg, standardMsg)) |
| 1166 | |
| 1167 | |
Raymond Hettinger | 57bd00a | 2010-12-24 21:51:48 +0000 | [diff] [blame] | 1168 | def assertCountEqual(self, first, second, msg=None): |
| 1169 | """An unordered sequence comparison asserting that the same elements, |
| 1170 | regardless of order. If the same element occurs more than once, |
| 1171 | it verifies that the elements occur the same number of times. |
Michael Foord | 8442a60 | 2010-03-20 16:58:04 +0000 | [diff] [blame] | 1172 | |
Raymond Hettinger | 57bd00a | 2010-12-24 21:51:48 +0000 | [diff] [blame] | 1173 | self.assertEqual(Counter(list(first)), |
| 1174 | Counter(list(second))) |
Michael Foord | 8442a60 | 2010-03-20 16:58:04 +0000 | [diff] [blame] | 1175 | |
Raymond Hettinger | 57bd00a | 2010-12-24 21:51:48 +0000 | [diff] [blame] | 1176 | Example: |
Michael Foord | 8442a60 | 2010-03-20 16:58:04 +0000 | [diff] [blame] | 1177 | - [0, 1, 1] and [1, 0, 1] compare equal. |
| 1178 | - [0, 0, 1] and [0, 1] compare unequal. |
Raymond Hettinger | 57bd00a | 2010-12-24 21:51:48 +0000 | [diff] [blame] | 1179 | |
Michael Foord | 8442a60 | 2010-03-20 16:58:04 +0000 | [diff] [blame] | 1180 | """ |
Michael Foord | e180d39 | 2011-01-28 19:51:48 +0000 | [diff] [blame] | 1181 | first_seq, second_seq = list(first), list(second) |
Michael Foord | 8442a60 | 2010-03-20 16:58:04 +0000 | [diff] [blame] | 1182 | try: |
Michael Foord | e180d39 | 2011-01-28 19:51:48 +0000 | [diff] [blame] | 1183 | first = collections.Counter(first_seq) |
| 1184 | second = collections.Counter(second_seq) |
Michael Foord | 8442a60 | 2010-03-20 16:58:04 +0000 | [diff] [blame] | 1185 | except TypeError: |
Raymond Hettinger | 6518f5e | 2010-12-24 00:52:54 +0000 | [diff] [blame] | 1186 | # Handle case with unhashable elements |
Michael Foord | e180d39 | 2011-01-28 19:51:48 +0000 | [diff] [blame] | 1187 | differences = _count_diff_all_purpose(first_seq, second_seq) |
Michael Foord | 8442a60 | 2010-03-20 16:58:04 +0000 | [diff] [blame] | 1188 | else: |
Michael Foord | e180d39 | 2011-01-28 19:51:48 +0000 | [diff] [blame] | 1189 | if first == second: |
Raymond Hettinger | 6e165b3 | 2010-11-27 09:31:37 +0000 | [diff] [blame] | 1190 | return |
Michael Foord | e180d39 | 2011-01-28 19:51:48 +0000 | [diff] [blame] | 1191 | differences = _count_diff_hashable(first_seq, second_seq) |
Michael Foord | 8442a60 | 2010-03-20 16:58:04 +0000 | [diff] [blame] | 1192 | |
Raymond Hettinger | 93e233d | 2010-12-24 10:02:22 +0000 | [diff] [blame] | 1193 | if differences: |
| 1194 | standardMsg = 'Element counts were not equal:\n' |
Raymond Hettinger | 57bd00a | 2010-12-24 21:51:48 +0000 | [diff] [blame] | 1195 | lines = ['First has %d, Second has %d: %r' % diff for diff in differences] |
Raymond Hettinger | 93e233d | 2010-12-24 10:02:22 +0000 | [diff] [blame] | 1196 | diffMsg = '\n'.join(lines) |
| 1197 | standardMsg = self._truncateMessage(standardMsg, diffMsg) |
| 1198 | msg = self._formatMessage(msg, standardMsg) |
| 1199 | self.fail(msg) |
Michael Foord | 8442a60 | 2010-03-20 16:58:04 +0000 | [diff] [blame] | 1200 | |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1201 | def assertMultiLineEqual(self, first, second, msg=None): |
| 1202 | """Assert that two multi-line strings are equal.""" |
Ezio Melotti | b3aedd4 | 2010-11-20 19:04:17 +0000 | [diff] [blame] | 1203 | self.assertIsInstance(first, str, 'First argument is not a string') |
| 1204 | self.assertIsInstance(second, str, 'Second argument is not a string') |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1205 | |
| 1206 | if first != second: |
Ezio Melotti | edd117f | 2011-04-27 10:20:38 +0300 | [diff] [blame] | 1207 | # don't use difflib if the strings are too long |
| 1208 | if (len(first) > self._diffThreshold or |
| 1209 | len(second) > self._diffThreshold): |
| 1210 | self._baseAssertEqual(first, second, msg) |
Ezio Melotti | d8b509b | 2011-09-28 17:37:55 +0300 | [diff] [blame] | 1211 | firstlines = first.splitlines(keepends=True) |
| 1212 | secondlines = second.splitlines(keepends=True) |
Michael Foord | c653ce3 | 2010-07-10 13:52:22 +0000 | [diff] [blame] | 1213 | if len(firstlines) == 1 and first.strip('\r\n') == first: |
| 1214 | firstlines = [first + '\n'] |
| 1215 | secondlines = [second + '\n'] |
Serhiy Storchaka | 77622f5 | 2013-09-23 23:07:00 +0300 | [diff] [blame] | 1216 | standardMsg = '%s != %s' % _common_shorten_repr(first, second) |
Michael Foord | c653ce3 | 2010-07-10 13:52:22 +0000 | [diff] [blame] | 1217 | diff = '\n' + ''.join(difflib.ndiff(firstlines, secondlines)) |
Michael Foord | cb11b25 | 2010-06-05 13:14:43 +0000 | [diff] [blame] | 1218 | standardMsg = self._truncateMessage(standardMsg, diff) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1219 | self.fail(self._formatMessage(msg, standardMsg)) |
| 1220 | |
| 1221 | def assertLess(self, a, b, msg=None): |
| 1222 | """Just like self.assertTrue(a < b), but with a nicer default message.""" |
| 1223 | if not a < b: |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 1224 | standardMsg = '%s not less than %s' % (safe_repr(a), safe_repr(b)) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1225 | self.fail(self._formatMessage(msg, standardMsg)) |
| 1226 | |
| 1227 | def assertLessEqual(self, a, b, msg=None): |
| 1228 | """Just like self.assertTrue(a <= b), but with a nicer default message.""" |
| 1229 | if not a <= b: |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 1230 | standardMsg = '%s not less than or equal to %s' % (safe_repr(a), safe_repr(b)) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1231 | self.fail(self._formatMessage(msg, standardMsg)) |
| 1232 | |
| 1233 | def assertGreater(self, a, b, msg=None): |
| 1234 | """Just like self.assertTrue(a > b), but with a nicer default message.""" |
| 1235 | if not a > b: |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 1236 | standardMsg = '%s not greater than %s' % (safe_repr(a), safe_repr(b)) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1237 | self.fail(self._formatMessage(msg, standardMsg)) |
| 1238 | |
| 1239 | def assertGreaterEqual(self, a, b, msg=None): |
| 1240 | """Just like self.assertTrue(a >= b), but with a nicer default message.""" |
| 1241 | if not a >= b: |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 1242 | standardMsg = '%s not greater than or equal to %s' % (safe_repr(a), safe_repr(b)) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1243 | self.fail(self._formatMessage(msg, standardMsg)) |
| 1244 | |
| 1245 | def assertIsNone(self, obj, msg=None): |
| 1246 | """Same as self.assertTrue(obj is None), with a nicer default message.""" |
| 1247 | if obj is not None: |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 1248 | standardMsg = '%s is not None' % (safe_repr(obj),) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1249 | self.fail(self._formatMessage(msg, standardMsg)) |
| 1250 | |
| 1251 | def assertIsNotNone(self, obj, msg=None): |
| 1252 | """Included for symmetry with assertIsNone.""" |
| 1253 | if obj is None: |
| 1254 | standardMsg = 'unexpectedly None' |
| 1255 | self.fail(self._formatMessage(msg, standardMsg)) |
| 1256 | |
Benjamin Peterson | 6e8c757 | 2009-10-04 20:19:21 +0000 | [diff] [blame] | 1257 | def assertIsInstance(self, obj, cls, msg=None): |
| 1258 | """Same as self.assertTrue(isinstance(obj, cls)), with a nicer |
| 1259 | default message.""" |
| 1260 | if not isinstance(obj, cls): |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 1261 | standardMsg = '%s is not an instance of %r' % (safe_repr(obj), cls) |
Benjamin Peterson | 6e8c757 | 2009-10-04 20:19:21 +0000 | [diff] [blame] | 1262 | self.fail(self._formatMessage(msg, standardMsg)) |
| 1263 | |
| 1264 | def assertNotIsInstance(self, obj, cls, msg=None): |
| 1265 | """Included for symmetry with assertIsInstance.""" |
| 1266 | if isinstance(obj, cls): |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 1267 | standardMsg = '%s is an instance of %r' % (safe_repr(obj), cls) |
Benjamin Peterson | 6e8c757 | 2009-10-04 20:19:21 +0000 | [diff] [blame] | 1268 | self.fail(self._formatMessage(msg, standardMsg)) |
| 1269 | |
Ezio Melotti | ed3a7d2 | 2010-12-01 02:32:32 +0000 | [diff] [blame] | 1270 | def assertRaisesRegex(self, expected_exception, expected_regex, |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 1271 | *args, **kwargs): |
Ezio Melotti | ed3a7d2 | 2010-12-01 02:32:32 +0000 | [diff] [blame] | 1272 | """Asserts that the message in a raised exception matches a regex. |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1273 | |
| 1274 | Args: |
| 1275 | expected_exception: Exception class expected to be raised. |
Ezio Melotti | ed3a7d2 | 2010-12-01 02:32:32 +0000 | [diff] [blame] | 1276 | expected_regex: Regex (re pattern object or string) expected |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1277 | to be found in error message. |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 1278 | args: Function to be called and extra positional args. |
| 1279 | kwargs: Extra kwargs. |
Ezio Melotti | b4dc250 | 2011-05-06 15:01:41 +0300 | [diff] [blame] | 1280 | msg: Optional message used in case of failure. Can only be used |
| 1281 | when assertRaisesRegex is used as a context manager. |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1282 | """ |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 1283 | context = _AssertRaisesContext(expected_exception, self, expected_regex) |
| 1284 | return context.handle('assertRaisesRegex', args, kwargs) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1285 | |
Ezio Melotti | ed3a7d2 | 2010-12-01 02:32:32 +0000 | [diff] [blame] | 1286 | def assertWarnsRegex(self, expected_warning, expected_regex, |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 1287 | *args, **kwargs): |
Antoine Pitrou | 4bc12ef | 2010-09-06 19:25:46 +0000 | [diff] [blame] | 1288 | """Asserts that the message in a triggered warning matches a regexp. |
| 1289 | Basic functioning is similar to assertWarns() with the addition |
| 1290 | that only warnings whose messages also match the regular expression |
| 1291 | are considered successful matches. |
| 1292 | |
| 1293 | Args: |
| 1294 | expected_warning: Warning class expected to be triggered. |
Ezio Melotti | ed3a7d2 | 2010-12-01 02:32:32 +0000 | [diff] [blame] | 1295 | expected_regex: Regex (re pattern object or string) expected |
Antoine Pitrou | 4bc12ef | 2010-09-06 19:25:46 +0000 | [diff] [blame] | 1296 | to be found in error message. |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 1297 | args: Function to be called and extra positional args. |
| 1298 | kwargs: Extra kwargs. |
Ezio Melotti | b4dc250 | 2011-05-06 15:01:41 +0300 | [diff] [blame] | 1299 | msg: Optional message used in case of failure. Can only be used |
| 1300 | when assertWarnsRegex is used as a context manager. |
Antoine Pitrou | 4bc12ef | 2010-09-06 19:25:46 +0000 | [diff] [blame] | 1301 | """ |
Serhiy Storchaka | df573d6 | 2015-05-16 16:29:50 +0300 | [diff] [blame] | 1302 | context = _AssertWarnsContext(expected_warning, self, expected_regex) |
| 1303 | return context.handle('assertWarnsRegex', args, kwargs) |
Antoine Pitrou | 4bc12ef | 2010-09-06 19:25:46 +0000 | [diff] [blame] | 1304 | |
Ezio Melotti | ed3a7d2 | 2010-12-01 02:32:32 +0000 | [diff] [blame] | 1305 | def assertRegex(self, text, expected_regex, msg=None): |
Michael Foord | e3ef5f1 | 2010-05-08 16:46:14 +0000 | [diff] [blame] | 1306 | """Fail the test unless the text matches the regular expression.""" |
Ezio Melotti | ed3a7d2 | 2010-12-01 02:32:32 +0000 | [diff] [blame] | 1307 | if isinstance(expected_regex, (str, bytes)): |
Gregory P. Smith | ed16bf4 | 2010-12-16 19:23:05 +0000 | [diff] [blame] | 1308 | assert expected_regex, "expected_regex must not be empty." |
Ezio Melotti | ed3a7d2 | 2010-12-01 02:32:32 +0000 | [diff] [blame] | 1309 | expected_regex = re.compile(expected_regex) |
| 1310 | if not expected_regex.search(text): |
Robert Collins | be6caca | 2015-08-20 11:13:09 +1200 | [diff] [blame] | 1311 | standardMsg = "Regex didn't match: %r not found in %r" % ( |
| 1312 | expected_regex.pattern, text) |
| 1313 | # _formatMessage ensures the longMessage option is respected |
| 1314 | msg = self._formatMessage(msg, standardMsg) |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1315 | raise self.failureException(msg) |
| 1316 | |
Ezio Melotti | 8f77630 | 2010-12-10 02:32:05 +0000 | [diff] [blame] | 1317 | def assertNotRegex(self, text, unexpected_regex, msg=None): |
Michael Foord | e3ef5f1 | 2010-05-08 16:46:14 +0000 | [diff] [blame] | 1318 | """Fail the test if the text matches the regular expression.""" |
Ezio Melotti | ed3a7d2 | 2010-12-01 02:32:32 +0000 | [diff] [blame] | 1319 | if isinstance(unexpected_regex, (str, bytes)): |
| 1320 | unexpected_regex = re.compile(unexpected_regex) |
| 1321 | match = unexpected_regex.search(text) |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 1322 | if match: |
Robert Collins | be6caca | 2015-08-20 11:13:09 +1200 | [diff] [blame] | 1323 | standardMsg = 'Regex matched: %r matches %r in %r' % ( |
| 1324 | text[match.start() : match.end()], |
| 1325 | unexpected_regex.pattern, |
| 1326 | text) |
| 1327 | # _formatMessage ensures the longMessage option is respected |
| 1328 | msg = self._formatMessage(msg, standardMsg) |
Benjamin Peterson | b48af54 | 2010-04-11 20:43:16 +0000 | [diff] [blame] | 1329 | raise self.failureException(msg) |
| 1330 | |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1331 | |
Ezio Melotti | ed3a7d2 | 2010-12-01 02:32:32 +0000 | [diff] [blame] | 1332 | def _deprecate(original_func): |
| 1333 | def deprecated_func(*args, **kwargs): |
| 1334 | warnings.warn( |
| 1335 | 'Please use {0} instead.'.format(original_func.__name__), |
| 1336 | DeprecationWarning, 2) |
| 1337 | return original_func(*args, **kwargs) |
| 1338 | return deprecated_func |
| 1339 | |
Ezio Melotti | 361467e | 2011-04-03 17:37:58 +0300 | [diff] [blame] | 1340 | # see #9424 |
Ezio Melotti | 0f53501 | 2011-04-03 18:02:13 +0300 | [diff] [blame] | 1341 | failUnlessEqual = assertEquals = _deprecate(assertEqual) |
| 1342 | failIfEqual = assertNotEquals = _deprecate(assertNotEqual) |
| 1343 | failUnlessAlmostEqual = assertAlmostEquals = _deprecate(assertAlmostEqual) |
| 1344 | failIfAlmostEqual = assertNotAlmostEquals = _deprecate(assertNotAlmostEqual) |
| 1345 | failUnless = assert_ = _deprecate(assertTrue) |
| 1346 | failUnlessRaises = _deprecate(assertRaises) |
| 1347 | failIf = _deprecate(assertFalse) |
Ezio Melotti | ed3a7d2 | 2010-12-01 02:32:32 +0000 | [diff] [blame] | 1348 | assertRaisesRegexp = _deprecate(assertRaisesRegex) |
| 1349 | assertRegexpMatches = _deprecate(assertRegex) |
Robert Collins | be6caca | 2015-08-20 11:13:09 +1200 | [diff] [blame] | 1350 | assertNotRegexpMatches = _deprecate(assertNotRegex) |
Ezio Melotti | ed3a7d2 | 2010-12-01 02:32:32 +0000 | [diff] [blame] | 1351 | |
| 1352 | |
| 1353 | |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1354 | class FunctionTestCase(TestCase): |
| 1355 | """A test case that wraps a test function. |
| 1356 | |
| 1357 | This is useful for slipping pre-existing test functions into the |
| 1358 | unittest framework. Optionally, set-up and tidy-up functions can be |
| 1359 | supplied. As with TestCase, the tidy-up ('tearDown') function will |
| 1360 | always be called if the set-up ('setUp') function ran successfully. |
| 1361 | """ |
| 1362 | |
| 1363 | def __init__(self, testFunc, setUp=None, tearDown=None, description=None): |
| 1364 | super(FunctionTestCase, self).__init__() |
| 1365 | self._setUpFunc = setUp |
| 1366 | self._tearDownFunc = tearDown |
| 1367 | self._testFunc = testFunc |
| 1368 | self._description = description |
| 1369 | |
| 1370 | def setUp(self): |
| 1371 | if self._setUpFunc is not None: |
| 1372 | self._setUpFunc() |
| 1373 | |
| 1374 | def tearDown(self): |
| 1375 | if self._tearDownFunc is not None: |
| 1376 | self._tearDownFunc() |
| 1377 | |
| 1378 | def runTest(self): |
| 1379 | self._testFunc() |
| 1380 | |
| 1381 | def id(self): |
| 1382 | return self._testFunc.__name__ |
| 1383 | |
| 1384 | def __eq__(self, other): |
| 1385 | if not isinstance(other, self.__class__): |
| 1386 | return NotImplemented |
| 1387 | |
| 1388 | return self._setUpFunc == other._setUpFunc and \ |
| 1389 | self._tearDownFunc == other._tearDownFunc and \ |
| 1390 | self._testFunc == other._testFunc and \ |
| 1391 | self._description == other._description |
| 1392 | |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1393 | def __hash__(self): |
| 1394 | return hash((type(self), self._setUpFunc, self._tearDownFunc, |
| 1395 | self._testFunc, self._description)) |
| 1396 | |
| 1397 | def __str__(self): |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 1398 | return "%s (%s)" % (strclass(self.__class__), |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1399 | self._testFunc.__name__) |
| 1400 | |
| 1401 | def __repr__(self): |
Benjamin Peterson | 847a411 | 2010-03-14 15:04:17 +0000 | [diff] [blame] | 1402 | return "<%s tec=%s>" % (strclass(self.__class__), |
Benjamin Peterson | bed7d04 | 2009-07-19 21:01:52 +0000 | [diff] [blame] | 1403 | self._testFunc) |
| 1404 | |
| 1405 | def shortDescription(self): |
| 1406 | if self._description is not None: |
| 1407 | return self._description |
| 1408 | doc = self._testFunc.__doc__ |
| 1409 | return doc and doc.split("\n")[0].strip() or None |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 1410 | |
| 1411 | |
| 1412 | class _SubTest(TestCase): |
| 1413 | |
| 1414 | def __init__(self, test_case, message, params): |
| 1415 | super().__init__() |
| 1416 | self._message = message |
| 1417 | self.test_case = test_case |
| 1418 | self.params = params |
| 1419 | self.failureException = test_case.failureException |
| 1420 | |
| 1421 | def runTest(self): |
| 1422 | raise NotImplementedError("subtests cannot be run directly") |
| 1423 | |
| 1424 | def _subDescription(self): |
| 1425 | parts = [] |
Berker Peksag | 16ea19f | 2016-09-21 19:34:15 +0300 | [diff] [blame] | 1426 | if self._message is not _subtest_msg_sentinel: |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 1427 | parts.append("[{}]".format(self._message)) |
| 1428 | if self.params: |
| 1429 | params_desc = ', '.join( |
| 1430 | "{}={!r}".format(k, v) |
Serhiy Storchaka | 48fbe52 | 2017-06-23 21:47:39 +0300 | [diff] [blame] | 1431 | for (k, v) in self.params.items()) |
Antoine Pitrou | c9b3ef2 | 2013-03-20 20:16:47 +0100 | [diff] [blame] | 1432 | parts.append("({})".format(params_desc)) |
| 1433 | return " ".join(parts) or '(<subtest>)' |
| 1434 | |
| 1435 | def id(self): |
| 1436 | return "{} {}".format(self.test_case.id(), self._subDescription()) |
| 1437 | |
| 1438 | def shortDescription(self): |
| 1439 | """Returns a one-line description of the subtest, or None if no |
| 1440 | description has been provided. |
| 1441 | """ |
| 1442 | return self.test_case.shortDescription() |
| 1443 | |
| 1444 | def __str__(self): |
| 1445 | return "{} {}".format(self.test_case, self._subDescription()) |