a Sici@sdZddlmZddlZddlZddlZddlZddlZddlZddl m Z e dZ e Ze ZdZGdddeZGd d d eZd d Zd dZddZddZGddde ZddZddZddZddZddZGdd d eZd!d"Z Gd#d$d$e j!ed%Z!d&d'Z"dS)(alAdds support for parameterized tests to Python's unittest TestCase class. A parameterized test is a method in a test case that is invoked with different argument tuples. A simple example:: class AdditionExample(parameterized.TestCase): @parameterized.parameters( (1, 2, 3), (4, 5, 9), (1, 1, 3)) def testAddition(self, op1, op2, result): self.assertEqual(result, op1 + op2) Each invocation is a separate test case and properly isolated just like a normal test method, with its own setUp/tearDown cycle. In the example above, there are three separate testcases, one of which will fail due to an assertion error (1 + 1 != 3). Parameters for individual test cases can be tuples (with positional parameters) or dictionaries (with named parameters):: class AdditionExample(parameterized.TestCase): @parameterized.parameters( {'op1': 1, 'op2': 2, 'result': 3}, {'op1': 4, 'op2': 5, 'result': 9}, ) def testAddition(self, op1, op2, result): self.assertEqual(result, op1 + op2) If a parameterized test fails, the error message will show the original test name and the parameters for that test. The id method of the test, used internally by the unittest framework, is also modified to show the arguments (but note that the name reported by `id()` doesn't match the actual test name, see below). To make sure that test names stay the same across several invocations, object representations like:: >>> class Foo(object): ... pass >>> repr(Foo()) '<__main__.Foo object at 0x23d8610>' are turned into ``__main__.Foo``. When selecting a subset of test cases to run on the command-line, the test cases contain an index suffix for each argument in the order they were passed to :func:`parameters` (eg. testAddition0, testAddition1, etc.) This naming scheme is subject to change; for more reliable and stable names, especially in test logs, use :func:`named_parameters` instead. Tests using :func:`named_parameters` are similar to :func:`parameters`, except only tuples or dicts of args are supported. For tuples, the first parameter arg has to be a string (or an object that returns an apt name when converted via ``str()``). For dicts, a value for the key ``testcase_name`` must be present and must be a string (or an object that returns an apt name when converted via ``str()``):: class NamedExample(parameterized.TestCase): @parameterized.named_parameters( ('Normal', 'aa', 'aaa', True), ('EmptyPrefix', '', 'abc', True), ('BothEmpty', '', '', True)) def testStartsWith(self, prefix, string, result): self.assertEqual(result, string.startswith(prefix)) class NamedExample(parameterized.TestCase): @parameterized.named_parameters( {'testcase_name': 'Normal', 'result': True, 'string': 'aaa', 'prefix': 'aa'}, {'testcase_name': 'EmptyPrefix', 'result': True, 'string': 'abc', 'prefix': ''}, {'testcase_name': 'BothEmpty', 'result': True, 'string': '', 'prefix': ''}) def testStartsWith(self, prefix, string, result): self.assertEqual(result, string.startswith(prefix)) Named tests also have the benefit that they can be run individually from the command line:: $ testmodule.py NamedExample.testStartsWithNormal . -------------------------------------------------------------------- Ran 1 test in 0.000s OK Parameterized Classes ===================== If invocation arguments are shared across test methods in a single TestCase class, instead of decorating all test methods individually, the class itself can be decorated:: @parameterized.parameters( (1, 2, 3), (4, 5, 9)) class ArithmeticTest(parameterized.TestCase): def testAdd(self, arg1, arg2, result): self.assertEqual(arg1 + arg2, result) def testSubtract(self, arg1, arg2, result): self.assertEqual(result - arg1, arg2) Inputs from Iterables ===================== If parameters should be shared across several test cases, or are dynamically created from other sources, a single non-tuple iterable can be passed into the decorator. This iterable will be used to obtain the test cases:: class AdditionExample(parameterized.TestCase): @parameterized.parameters( c.op1, c.op2, c.result for c in testcases ) def testAddition(self, op1, op2, result): self.assertEqual(result, op1 + op2) Single-Argument Test Methods ============================ If a test method takes only one argument, the single arguments must not be wrapped into a tuple:: class NegativeNumberExample(parameterized.TestCase): @parameterized.parameters( -1, -3, -4, -5 ) def testIsNegative(self, arg): self.assertTrue(IsNegative(arg)) List/tuple as a Single Argument =============================== If a test method takes a single argument of a list/tuple, it must be wrapped inside a tuple:: class ZeroSumExample(parameterized.TestCase): @parameterized.parameters( ([-1, 0, 1], ), ([-2, 0, 2], ), ) def testSumIsZero(self, arg): self.assertEqual(0, sum(arg)) Cartesian product of Parameter Values as Parametrized Test Cases ================================================================ If required to test method over a cartesian product of parameters, `parameterized.product` may be used to facilitate generation of parameters test combinations:: class TestModuloExample(parameterized.TestCase): @parameterized.product( num=[0, 20, 80], modulo=[2, 4], expected=[0] ) def testModuloResult(self, num, modulo, expected): self.assertEqual(expected, num % modulo) This results in 6 test cases being created - one for each combination of the parameters. It is also possible to supply sequences of keyword argument dicts as elements of the cartesian product:: @parameterized.product( (dict(num=5, modulo=3, expected=2), dict(num=7, modulo=4, expected=3)), dtype=(int, float) ) def testModuloResult(self, num, modulo, expected, dtype): self.assertEqual(expected, dtype(num) % modulo) This results in 4 test cases being created - for each of the two sets of test data (supplied as kwarg dicts) and for each of the two data types (supplied as a named parameter). Multiple keyword argument dicts may be supplied if required. Async Support ============= If a test needs to call async functions, it can inherit from both parameterized.TestCase and another TestCase that supports async calls, such as [asynctest](https://github.com/Martiusweb/asynctest):: import asynctest class AsyncExample(parameterized.TestCase, asynctest.TestCase): @parameterized.parameters( ('a', 1), ('b', 2), ) async def testSomeAsyncFunction(self, arg, expected): actual = await someAsyncFunction(arg) self.assertEqual(actual, expected) )abcN)absltestz0\<([a-zA-Z0-9_\-\.]+) object at 0x[a-fA-F0-9]+\> testcase_namec@seZdZdZdS) NoTestsErrorz?Raised when parameterized decorators do not generate any tests.N)__name__ __module__ __qualname____doc__r r V/var/www/html/django/DPS/env/lib/python3.9/site-packages/absl/testing/parameterized.pyrsrcs eZdZdZfddZZS)DuplicateTestNameErrorzGRaised when a parameterized test has the same test name multiple times.cstt|d|||dS)NzDuplicate parameterized test name in {}: generated test name {!r} (generated from {!r}) already exists. Consider using named_parameters() to give your tests unique names and/or renaming the conflicting test method.)superr __init__format)selftest_class_nameZ new_test_nameZoriginal_test_name __class__r r rs  zDuplicateTestNameError.__init__)rrrr r __classcell__r r rr r sr cCstdt|S)Nz<\1>)_ADDR_REsubreprobjr r r _clean_reprsrcCs$t|tjo"t|t o"t|t SN) isinstancerIterablestrbytesrr r r _non_string_or_bytes_iterables r cCsJt|tjr$ddd|DSt|rsz)_format_parameter_list..) rrMappingjoinitemsr mapr_format_parameter_listtestcase_paramsr r r r)s  r)cstfdd}|S)Ncs|i|IdHSrr )argskwargsfuncr r wrapper sz_async_wrapped..wrapper) functoolswraps)r/r0r r.r _async_wrapped sr3c@s*eZdZdZd ddZddZddZdS) _ParameterizedTestIterz9Callable and iterable class for producing new test cases.NcCs2||_||_||_|dur |j}||_tj|_dS)aReturns concrete test functions for a test and a list of parameters. The naming_type is used to determine the name of the concrete functions as reported by the unittest framework. If naming_type is _FIRST_ARG, the testcases must be tuples, and the first element must have a string representation that is a valid Python identifier. Args: test_method: The decorated test method. testcases: (list of tuple/dict) A list of parameter tuples/dicts for individual test invocations. naming_type: The test naming type, either _NAMED or _ARGUMENT_REPR. original_name: The original test method name. When decorated on a test method, None is passed to __init__ and test_method.__name__ is used. Note test_method.__name__ might be different than the original defined test method because of the use of other decorators. A more accurate value is set by TestGeneratorMetaclass.__new__ later. N) _test_method testcases _naming_typer_original_namer4)r test_methodr6 naming_type original_namer r r rsz_ParameterizedTestIter.__init__cOs tddS)NaYou appear to be running a parameterized test case without having inherited from parameterized.TestCase. This is bad because none of your test cases are actually being run. You may also be using another decorator before the parameterized one, in which case you should reverse the order.) RuntimeError)rr,r-r r r __call__.sz_ParameterizedTestIter.__call__cs0jjfddfddjDS)Ncsdtfdd}turd|_d}ttjrftvrJtdtt}dd Dn.make_bound_param_test..bound_param_testTz*Dict for named tests must contain key "%s"cSsi|]\}}|tkr||qSr )_NAMED_DICT_KEY)r!kvr r r PszR_ParameterizedTestIter.__iter__..make_bound_param_test..rzWThe first element of named test parameters is the test name suffix and must be a stringz9Named tests must be passed a dict or non-string iterable.test__z(%s)z%s is not a valid naming type.z%s(%s)z %s)r1r2_NAMED__x_use_name__rrr%r@r<r'r rr8 startswithr_ARGUMENT_REPRtypes GeneratorTypetupler)__x_params_repr__r inspectiscoroutinefunctionr3)r+r?rtest_method_name params_repr)r:rr9r*r make_bound_param_test:s\      z>_ParameterizedTestIter.__iter__..make_bound_param_testc3s|]}|VqdSrr )r!c)rSr r r$}z2_ParameterizedTestIter.__iter__..)r5r7r6r>r )rSr:rr9r __iter__6sCz_ParameterizedTestIter.__iter__)N)rrrr rr=rVr r r r r4s r4c Cst|ddrJd|fi|_}|jD]j\}}|tjjr2t |t j r2t ||i}t |j|||t|||||D]\}}t|||qq2dS)N_test_params_reprsz{Cannot add parameters to %s. Either it already has parameterized methods, or its super class is also a parameterized class.)getattrrW__dict__copyr'rIunittest TestLoadertestMethodPrefixrrK FunctionTypedelattr&_update_class_dict_for_param_test_caserr4setattr) Z class_objectr6r:test_params_reprsnamermethods meth_namemethr r r _modify_classs&     rgcsxfdd}tdkrTtdtsTtdtjsTtdsLJddttjshtsttd|S)aImplementation of the parameterization decorators. Args: naming_type: The naming type. testcases: Testcase parameters. Raises: NoTestsError: Raised when the decorator generates no tests. Returns: A function for modifying the decorated object. cs*t|trt||St|SdSr)rtypergr4rr:r6r r _applys  z$_parameter_decorator.._applyrDrzCSingle parameter argument must be a non-string non-Mapping iterablezparameterized test decorators did not generate any tests. Make sure you specify non-empty parameters, and do not reuse generators more than once.) lenrrMrr%r Sequencelistr)r:r6rjr rir _parameter_decorators"    rncGs tt|S)aA decorator for creating parameterized tests. See the module docstring for a usage example. Args: *testcases: Parameters for the decorated method, either a single iterable, or a list of tuples/dicts/objects (for tests with only one argument). Raises: NoTestsError: Raised when the decorator generates no tests. Returns: A test generator to be handled by TestGeneratorMetaclass. )rnrJr6r r r parameterssrpcGs tt|S)aA decorator for creating parameterized tests. See the module docstring for a usage example. For every parameter tuple passed, the first element of the tuple should be a string and will be appended to the name of the test method. Each parameter dict passed must have a value for the key "testcase_name", the string representation of that value will be appended to the name of the test method. Args: *testcases: Parameters for the decorated method, either a single iterable, or a list of tuples or dicts. Raises: NoTestsError: Raised when the decorator generates no tests. Returns: A test generator to be handled by TestGeneratorMetaclass. )rnrGror r r named_parameterssrqcs2|D]*\}}t|ttfsJd|t|qt}|D]}t|ttfrbtdd|DspJd||r>t|dtfdd|DsJd||@rJdt|@|O}q>|t|@rJd t|t|@d d|D}t|t|}d d t j |D}t t |S) aA decorator for running tests over cartesian product of parameters values. See the module docstring for a usage example. The test will be run for every possible combination of the parameters. Args: *kwargs_seqs: Each positional parameter is a sequence of keyword arg dicts; every test case generated will include exactly one kwargs dict from each positional parameter; these will then be merged to form an overall list of arguments for the test case. **testgrid: A mapping of parameter names and their possible values. Possible values should given as either a list or a tuple. Raises: NoTestsError: Raised when the decorator generates no tests. Returns: A test generator to be handled by TestGeneratorMetaclass. z5Values of {} must be given as list or tuple, found {}css|]}t|tVqdSr)rdictr!r-r r r r$rUzproduct..zFPositional parameters must be a sequence of keyword argdicts, found {}rc3s|]}t|kVqdSr)setrs arg_namesr r r$ rUzVKeyword argument dicts within a single parameter must all have the same keys, found {}z\Keyword argument dict sequences must all have distinct argument names, found duplicate(s) {}zArguments supplied in kwargs dicts in positional parameters must not overlap with arguments supplied as named parameters; found duplicate argument(s) {}c3s(|] \}tfdd|DVqdS)c3s|]}|iVqdSrr )r!rBrAr r r$rUz$product...N)rM)r!vsr rwr r$rUcSs&g|]}ttjdd|DqS)css|]}|VqdSr)r')r!caser r r r$ sz%product...)rr itertoolschain from_iterable)r!casesr r r szproduct..) r'rrmrMrrhrtallsortedrzproductrnrJ)Z kwargs_seqsZtestgridrcvaluesZprior_arg_namesZ kwargs_seqr6r rur rsN    rc@seZdZdZddZdS)TestGeneratorMetaclasszAMetaclass for adding tests generated by parameterized decorators.c Cs|di}|D]P\}}|tjjrt|rt|t rF||_ t |}| |t |||||q|D]<}t|dd} | rnt|trn| D]\} } || | qqnt||||S)NrW) setdefaultrZr'rIr[r\r]r rr4r8iterpopr`rX issubclassTestCaserh__new__) cls class_namebasesdctrbrcriteratorbaseZbase_test_params_reprsr9Ztest_method_idr r r r*s$     zTestGeneratorMetaclass.__new__N)rrrr rr r r r r'src Cst|D]\}}t|s&Jd|ft|ddsNt|ddsNtd||t|ddrf|j}|}n|}d||f}||vrt||||||<t|dd||<qdS) aAdds individual test cases to a dictionary. Args: test_class_name: The name of the class tests are added to. dct: The target dictionary. test_params_reprs: The dictionary for mapping names to test IDs. name: The original name of the test case. iterator: The iterator generating the individual test cases. Raises: DuplicateTestNameError: Raised when a test name occurs multiple times. RuntimeError: If non-parameterized functions are generated. z,Test generators must yield callables, got %rrHNrNz{}.{} generated a test function without using the parameterized decorators. Only tests generated using the decorators are supported.Fz%s%d) enumeratecallablerXr<rrr ) rrrbrcridxr/r;new_namer r r r`Zs*      r`cs0eZdZdZddZddZfddZZS)rz9Base class for test cases using the parameters decorator.cCs|j|jdS)Nr)rWget_testMethodNamer>r r r _get_params_reprszTestCase._get_params_reprcCs.|}|rd|}d|j|tj|jS)N z {}{} ({}))rrrr[utilstrclassr)rrRr r r __str__s zTestCase.__str__cs.tt|}|}|r&d||S|SdS)zReturns the descriptive ID of the test. This is used internally by the unittesting framework to get a name for the test to be used in reports. Returns: The test id. z{} {}N)r ridrr)rrrRrr r rs  z TestCase.id)rrrr rrrrr r rr rsr) metaclasscCs"td|jtfi}|d|tfiS)aReturns a new base class with a cooperative metaclass base. This enables the TestCase to be used in combination with other base classes that have custom metaclasses, such as ``mox.MoxTestBase``. Only works with metaclasses that do not override ``type.__new__``. Example:: from absl.testing import parameterized class ExampleTest(parameterized.CoopTestCase(OtherTestCase)): ... Args: other_base_class: (class) A test case base class. Returns: A new class object. Z CoopMetaclass CoopTestCase)rh __metaclass__rr)Zother_base_classrr r r rsr)#r collectionsrr1rOrzrerKr[ absl.testingrcompilerobjectrGrJr@ Exceptionrr rr r)r3r4rgrnrprqrrhrr`rrr r r r s:G     p)A3'%