def verify_all_combinations_with_namer(function_under_test,
input_arguments,
namer,
formatter=None,
reporter=None):
"""Run func with all possible combinations of args and verify outputs against the recorded approval file.
Args:
function_under_test (function): function under test.
input_arguments: list of values to test for each input argument. For example, a function f(product, quantity)
could be tested with the input_arguments [['water', 'cola'], [1, 4]], which would result in outputs for the
following calls being recorded and verified: f('water', 1), f('water', 4), f('cola', 1), f('cola', 4).
namer (approvaltests.Namer): A namer that defines the name of received and approved files.
formatter (function): function for formatting the function inputs/outputs before they are recorded to an
approval file for comparison.
reporter (approvaltests.reporter.Reporter): an approval reporter.
Raises:
ApprovalException: if the results to not match the approved results.
"""
if formatter is None:
formatter = args_and_result_formatter
approval_strings = []
for args in product(*input_arguments):
try:
result = function_under_test(*args)
except Exception as e:
result = e
approval_strings.append(formatter(args, result))
verify_with_namer(''.join(approval_strings),
namer=namer,
reporter=reporter)
def verify_all_combinations_with_namer(function_under_test, input_arguments, namer, formatter=None, reporter=None):
"""Run func with all possible combinations of args and verify outputs against the recorded approval file.
Args:
function_under_test (function): function under test.
input_arguments: list of values to test for each input argument. For example, a function f(product, quantity)
could be tested with the input_arguments [['water', 'cola'], [1, 4]], which would result in outputs for the
following calls being recorded and verified: f('water', 1), f('water', 4), f('cola', 1), f('cola', 4).
namer (approvaltests.Namer): A namer that defines the name of received and approved files.
formatter (function): function for formatting the function inputs/outputs before they are recorded to an
approval file for comparison.
reporter (approvaltests.reporter.Reporter): an approval reporter.
Raises:
ApprovalException: if the results to not match the approved results.
"""
if formatter is None:
formatter = args_and_result_formatter
approval_strings = []
for args in product(*input_arguments):
try:
result = function_under_test(*args)
except Exception as e:
result = e
approval_strings.append(formatter(args, result))
verify_with_namer(''.join(approval_strings), namer=namer, reporter=reporter)
def assert_against_file(actual, file_path, reporter=None):
namer = FilePathNamer(file_path)
verify_with_namer(actual, namer, reporter)
def assert_against_file(actual, file_path, reporter=None):
namer = get_default_namer()
namer.get_approved_filename = lambda self,_=None: file_path
verify_with_namer(actual, namer, reporter)
def assert_against_file(actual, file_path, reporter=None):
namer = get_default_namer()
namer.get_approved_filename = lambda self, _=None: file_path
verify_with_namer(actual, namer, reporter)
def assert_against_file(actual: str,
file_path: str,
reporter: Optional[ReporterForTesting] = None) -> None:
namer = FilePathNamer(file_path)
verify_with_namer(actual, namer, reporter)