Function make_test

src/licensedcode_test_utils.py:189–269

Build and return a test function closing on tests arguments for a license_test LicenseTest object.

(license_test, unknown_detection=False, regen=REGEN_TEST_FIXTURES)

def make_test(license_test, unknown_detection=False, regen=REGEN_TEST_FIXTURES):
    """
    Build and return a test function closing on tests arguments for a
    license_test LicenseTest object.
    """
    test_name = license_test.get_test_method_name()

    from licensedcode import cache
    from licensedcode.tracing import get_texts

    expected_expressions = license_test.license_expressions or []

    test_file = license_test.test_file
    test_data_file = license_test.data_file
    expected_failure = license_test.expected_failure

    def closure_test_function(*args, **kwargs):
        idx = cache.get_index()
        matches = idx.match(
            location=test_file,
            min_score=0,
            unknown_licenses=unknown_detection,
        )
        if not matches:
            matches = []

        detected_expressions = [match.rule.license_expression for match in matches]

        # use detection as expected and dump test back
        if regen:
            if not expected_failure:
                license_test.license_expressions = detected_expressions
            license_test.dump()
            return

        if detected_expressions != expected_expressions:
            # On failure, we compare against more result data to get additional
            # failure details, including the test_file and full match details
            expected = expected_expressions + ['======================', '']
            results_failure_trace = (
                detected_expressions[:]
                +['======================', '']
            )

            for match in matches:
                qtext, itext = get_texts(match)
                rule_file = match.rule.rule_file()
                results_failure_trace.extend(['',
                    '======= MATCH ====', repr(match),
                    '======= Matched Query Text for:',
                    f'file://{test_file}'
                ])
                if test_data_file:
                    results_failure_trace.append(f'file://{test_data_file}')

                results_failure_trace.append('')
                results_failure_trace.append(qtext)
                results_failure_trace.extend(['',