test_output_spdx.py

# -*- coding: utf-8 -*-
#
# Copyright (c) nexB Inc. and others. All rights reserved.
# ScanCode is a trademark of nexB Inc.
# SPDX-License-Identifier: Apache-2.0
# See http://www.apache.org/licenses/LICENSE-2.0 for the license text.
# See https://github.com/nexB/scancode-toolkit for support or download.
# See https://aboutcode.org for more information about nexB OSS projects.
#

import io
import os
import re

import pytest
import xmltodict

from commoncode.testcase import FileDrivenTesting

from scancode.cli_test_utils import run_scan_click
from scancode.cli_test_utils import run_scan_plain
from scancode_config import REGEN_TEST_FIXTURES


test_env = FileDrivenTesting()
test_env.test_data_dir = os.path.join(os.path.dirname(__file__), 'data')


def strip_variable_text(rdf_text):
    """
    Return rdf_text stripped from variable parts such as rdf nodeids
    """

    replace_nid = re.compile('rdf:nodeID="[^\\"]*"').sub
    rdf_text = replace_nid('', rdf_text)

    replace_creation = re.compile('<ns1:creationInfo>.*</ns1:creationInfo>', re.DOTALL).sub  # NOQA
    rdf_text = replace_creation('', rdf_text)

    replace_pcc = re.compile('<ns1:packageVerificationCode>.*</ns1:packageVerificationCode>', re.DOTALL).sub  # NOQA
    rdf_text = replace_pcc('', rdf_text)
    return rdf_text


def load_and_clean_rdf(location):
    """
    Return plain Python nested data for the SPDX RDF file at location
    suitable for comparison. The file content is cleaned from variable
    parts such as dates, generated UUIDs and versions

    NOTE: we use plain dicts to avoid ordering issues in XML. the SPDX
    tool and lxml do not seem to return a consistent ordering that is
    needed for tests.
    """
    with io.open(location, encoding='utf-8') as co:
        content = co.read()
    content = strip_variable_text(content)
    data = xmltodict.parse(content, dict_constructor=dict)
    return sort_nested(data)


def sort_nested(data):
    """
    Return a new ordered and sorted mapping or sequence from a `data` mapping or
    sequence with any nested sequences or mappings sorted recursively.
    """
    seqtypes = list, tuple
    maptypes = dict, dict
    coltypes = seqtypes + maptypes

    if isinstance(data, maptypes):
        new_data = []
        for k, v in data.items():
            if isinstance(v, coltypes):
                v = sort_nested(v)
            new_data.append((k, v))
        return dict(sorted(new_data, key=_sorter))

    elif isinstance(data, seqtypes):
        new_data = []
        for v in data:
            if isinstance(v, coltypes):
                v = sort_nested(v)
            new_data.append(v)
        return sorted(new_data, key=_sorter)


def _sorter(data):
    """
    Return a tree of tuples (type, items sequence) for each items in a nested
    data structure composed of mappings and sequences. Used as a sorting key.
    """
    seqtypes = list, tuple
    maptypes = dict, dict
    coltypes = seqtypes + maptypes

    if isinstance(data, maptypes):
        new_data = []
        for k, v in data.items():
            if isinstance(v, coltypes):
                v = _sorter(v)
            new_data.append((k, v))
        return repr(tuple(sorted(new_data)))

    elif isinstance(data, seqtypes):
        new_data = []
        for v in data:
            if isinstance(v, coltypes):
                v = _sorter(v)
            new_data.append(v)
        return repr(tuple(sorted(new_data)))
    else:
        return repr(data)


def check_rdf_scan(expected_file, result_file, regen=REGEN_TEST_FIXTURES):
    """
    Check that expected and result_file are equal.
    Both are paths to SPDX RDF XML files, UTF-8 encoded.
    """
    import json
    result = load_and_clean_rdf(result_file)
    if regen:
        expected = result
        with io.open(expected_file, 'w', encoding='utf-8') as o:
            json.dump(result, o, indent=2)
    else:
        with io.open(expected_file, encoding='utf-8') as i:
            expected = json.load(i)
            expected = load_and_clean_rdf(result_file)

    assert json.dumps(result, indent=2) == json.dumps(expected, indent=2)


def load_and_clean_tv(location):
    """
    Return a mapping for the SPDX TV file at location suitable for
    comparison. The file content is cleaned from variable parts such as
    dates, generated UUIDs and versions
    """
    with io.open(location, encoding='utf-8') as co:
        content = co.read()
    lines = []
    lines_append = lines.append

    dns = 'DocumentNamespace: http://spdx.org/spdxdocs/'

    for line in content.splitlines(False):
        line = line.strip()
        if not line:
            continue
        if line.startswith('LicenseListVersion'):
            continue
        if line.startswith(('Creator: ', 'Created: ',)):
            continue
        if line.startswith(dns):
            # only keep the left side of
            # DocumentNamespace: http://spdx.org/spdxdocs/unicode-ea31be0f-16de-4eab-9fc7-4e3bafb753d3
            line, _, _ = line.partition('-')
    
        lines_append(line)

    return '\n'.join(lines)


def check_tv_scan(expected_file, result_file, regen=REGEN_TEST_FIXTURES):
    """
    Check that expected and result_file are equal.
    Both are paths to plain spdx tv text files, UTF-8 encoded.
    """
    result = load_and_clean_tv(result_file)
    if regen:
        with io.open(expected_file, 'w', encoding='utf-8') as o:
            o.write(result)

    expected = load_and_clean_tv(expected_file)
    assert result == expected


def test_spdx_rdf_basic():
    test_file = test_env.get_test_loc('spdx/simple/test.txt')
    result_file = test_env.get_temp_file('rdf')
    expected_file = test_env.get_test_loc('spdx/simple/expected.rdf')
    run_scan_click([test_file, '-clip', '--spdx-rdf', result_file])
    check_rdf_scan(expected_file, result_file)


def test_spdx_tv_basic():
    test_dir = test_env.get_test_loc('spdx/simple/test.txt')
    result_file = test_env.get_temp_file('tv')
    expected_file = test_env.get_test_loc('spdx/simple/expected.tv')
    run_scan_click([test_dir, '-clip', '--spdx-tv', result_file])
    check_tv_scan(expected_file, result_file)


@pytest.mark.scanslow
def test_spdx_rdf_with_known_licenses():
    test_dir = test_env.get_test_loc('spdx/license_known/scan')
    result_file = test_env.get_temp_file('rdf')
    expected_file = test_env.get_test_loc('spdx/license_known/expected.rdf')
    run_scan_click([test_dir, '-clip', '--spdx-rdf', result_file])
    check_rdf_scan(expected_file, result_file)


@pytest.mark.scanslow
def test_spdx_rdf_with_license_ref():
    test_dir = test_env.get_test_loc('spdx/license_ref/scan')
    result_file = test_env.get_temp_file('rdf')
    expected_file = test_env.get_test_loc('spdx/license_ref/expected.rdf')
    run_scan_click([test_dir, '-clip', '--spdx-rdf', result_file])
    check_rdf_scan(expected_file, result_file)


@pytest.mark.scanslow
def test_spdx_tv_with_known_licenses():
    test_dir = test_env.get_test_loc('spdx/license_known/scan')
    result_file = test_env.get_temp_file('tv')
    expected_file = test_env.get_test_loc('spdx/license_known/expected.tv')
    run_scan_click([test_dir, '-clip', '--spdx-tv', result_file])
    check_tv_scan(expected_file, result_file)


@pytest.mark.scanslow
def test_spdx_tv_with_license_ref():
    test_dir = test_env.get_test_loc('spdx/license_ref/scan')
    result_file = test_env.get_temp_file('tv')
    expected_file = test_env.get_test_loc('spdx/license_ref/expected.tv')
    run_scan_click([test_dir, '-clip', '--spdx-tv', result_file])
    check_tv_scan(expected_file, result_file)


@pytest.mark.scanslow
def test_spdx_rdf_with_known_licenses_with_text():
    test_dir = test_env.get_test_loc('spdx/license_known/scan')
    result_file = test_env.get_temp_file('rdf')
    expected_file = test_env.get_test_loc('spdx/license_known/expected_with_text.rdf')
    run_scan_click([ '-clip', '--license-text', test_dir, '--spdx-rdf', result_file])
    check_rdf_scan(expected_file, result_file)


@pytest.mark.scanslow
def test_spdx_rdf_with_license_ref_with_text():
    test_dir = test_env.get_test_loc('spdx/license_ref/scan')
    result_file = test_env.get_temp_file('rdf')
    expected_file = test_env.get_test_loc('spdx/license_ref/expected_with_text.rdf')
    run_scan_click(['-clip', '--license-text', test_dir, '--spdx-rdf', result_file])
    check_rdf_scan(expected_file, result_file)


@pytest.mark.scanslow
def test_spdx_tv_with_known_licenses_with_text():
    test_dir = test_env.get_test_loc('spdx/license_known/scan')
    result_file = test_env.get_temp_file('tv')
    expected_file = test_env.get_test_loc('spdx/license_known/expected_with_text.tv')
    run_scan_click(['-clip', '--license-text', test_dir, '--spdx-tv', result_file])
    check_tv_scan(expected_file, result_file)


@pytest.mark.scanslow
def test_spdx_tv_with_license_ref_with_text():
    test_dir = test_env.get_test_loc('spdx/license_ref/scan')
    result_file = test_env.get_temp_file('tv')
    expected_file = test_env.get_test_loc('spdx/license_ref/expected_with_text.tv')
    run_scan_click(['-clip', '--license-text', test_dir, '--spdx-tv', result_file])
    check_tv_scan(expected_file, result_file)


@pytest.mark.scanslow
def test_spdx_tv_tree():
    test_dir = test_env.get_test_loc('spdx/tree/scan')
    result_file = test_env.get_temp_file('tv')
    expected_file = test_env.get_test_loc('spdx/tree/expected.tv')
    run_scan_click(['-clip', test_dir, '--spdx-tv', result_file])
    check_tv_scan(expected_file, result_file)


@pytest.mark.scanslow
def test_spdx_rdf_tree():
    test_dir = test_env.get_test_loc('spdx/tree/scan')
    result_file = test_env.get_temp_file('rdf')
    expected_file = test_env.get_test_loc('spdx/tree/expected.rdf')
    run_scan_click(['-clip', test_dir, '--spdx-rdf', result_file])
    check_rdf_scan(expected_file, result_file)


@pytest.mark.scanslow
def test_spdx_tv_with_unicode_license_text_does_not_fail():
    test_file = test_env.get_test_loc('spdx/unicode/et131x.h')
    result_file = test_env.get_temp_file('tv')
    expected_file = test_env.get_test_loc('spdx/unicode/expected.tv')
    args = ['--license', '--copyright', '--info', '--strip-root', '--license-text',
            test_file, '--spdx-tv', result_file]
    run_scan_plain(args)
    check_tv_scan(expected_file, result_file)


@pytest.mark.scanslow
def test_spdx_rdf_with_unicode_license_text_does_not_fail():
    test_file = test_env.get_test_loc('spdx/unicode/et131x.h')
    result_file = test_env.get_temp_file('rdf')
    expected_file = test_env.get_test_loc('spdx/unicode/expected.rdf')
    args = ['--license', '--copyright', '--info', '--strip-root',
            '--license-text', test_file, '--spdx-rdf', result_file]
    run_scan_plain(args)
    check_rdf_scan(expected_file, result_file)


@pytest.mark.scanslow
def test_spdx_rdf_with_or_later_license_does_not_fail():
    test_file = test_env.get_test_loc('spdx/or_later/test.java')
    result_file = test_env.get_temp_file('rdf')
    expected_file = test_env.get_test_loc('spdx/or_later/expected.rdf')
    args = ['--license', '--copyright', '--info', '--strip-root',
            '--license-text', test_file, '--spdx-rdf', result_file]
    run_scan_plain(args)
    check_rdf_scan(expected_file, result_file)


@pytest.mark.scanslow
def test_spdx_tv_with_empty_scan():
    test_file = test_env.get_test_loc('spdx/empty/scan')
    result_file = test_env.get_temp_file('spdx.tv')
    expected_file = test_env.get_test_loc('spdx/empty/expected.tv')
    args = ['--license', '--strip-root', '--info', '--only-findings', test_file, '--spdx-tv', result_file]
    run_scan_plain(args)
    check_tv_scan(expected_file, result_file, regen=REGEN_TEST_FIXTURES)


@pytest.mark.scanslow
def test_spdx_rdf_with_empty_scan():
    test_file = test_env.get_test_loc('spdx/empty/scan')
    result_file = test_env.get_temp_file('spdx.rdf')
    args = ['--license', '--strip-root', '--info', '--only-findings', test_file, '--spdx-rdf', result_file]
    run_scan_plain(args)
    expected = "<!-- No results for package 'scan'. -->\n"
    results = open(result_file).read()
    assert results == expected


@pytest.mark.scanslow
def test_output_spdx_rdf_can_handle_non_ascii_paths():
    test_file = test_env.get_test_loc('spdx/unicode.json')
    result_file = test_env.get_temp_file(extension='spdx', file_name='test_spdx')
    run_scan_click(['--from-json', test_file, '--spdx-rdf', result_file])
    with io.open(result_file, encoding='utf-8') as res:
        results = res.read()
    assert 'han/据.svg' in results

def test_output_spdx_tv_can_handle_non_ascii_paths():
    test_file = test_env.get_test_loc('spdx/unicode.json')
    result_file = test_env.get_temp_file(extension='spdx', file_name='test_spdx')
    run_scan_click(['--from-json', test_file, '--spdx-tv', result_file])
    with io.open(result_file, encoding='utf-8') as res:
        results = res.read()
    assert 'han/据.svg' in results

def test_output_spdx_tv_sh1_of_empty_file():
    test_dir = test_env.get_test_loc('spdx/empty/scan/somefile')
    result_file = test_env.get_temp_file(extension='spdx', file_name='test_spdx')
    run_scan_click([test_dir, '-clip', '--spdx-tv', result_file])
    with io.open(result_file, encoding='utf-8') as res:
        results = res.read()
    assert 'FileChecksum: SHA1: da39a3ee5e6b4b0d3255bfef95601890afd80709' in results