test/test_frmwrk.py

import fileinput
import os
import subprocess
import pathlib
import pytest
import shutil
from utils import *


# Need a possibility to remove tools from PATH, otherwise we can't test
def get_path_without_sims():
    paths = os.environ['PATH'].split(os.path.pathsep)
    xrun = shutil.which('xrun')
    if xrun:
        paths = list(filter(lambda p: p != os.path.dirname(xrun), paths))
    return os.path.pathsep.join(paths)


def fake_tool(name):
    executable = pathlib.Path(name)
    executable.write_text('echo "{} called" > fake_tool.log'.format(name))
    executable.chmod(0o700)
    return executable


@all_files_in_dir('frmwrk_0')
def test_frmwrk_0(datafiles):
    with datafiles.as_cwd():
        create_unit_test('test.sv')
        subprocess.check_call(['buildSVUnit'])

        golden_class_unit_test('test', 'test')
        golden_testsuite_with_1_unittest('test')
        golden_testrunner_with_1_testsuite()

        verify_file('test_unit_test.gold', 'test_unit_test.sv')
        verify_testsuite('testsuite.gold')
        verify_testrunner('testrunner.gold', '_')


@all_files_in_dir('frmwrk_1')
def test_frmwrk_1(datafiles):
    with datafiles.as_cwd():
        create_unit_test('test.sv')

        golden_class_unit_test('test', 'test0')

        verify_file('test_unit_test.gold', 'test_unit_test.sv')


@all_files_in_dir('frmwrk_2')
def test_frmwrk_2(datafiles):
    with datafiles.as_cwd():
        create_unit_test('test.sv')

        golden_class_unit_test('test', 'virtual_test')

        verify_file('test_unit_test.gold', 'test_unit_test.sv')


@all_files_in_dir('frmwrk_3')
def test_frmwrk_3(datafiles):
    with datafiles.as_cwd():
        create_unit_test('test.sv')
        subprocess.check_call(['buildSVUnit'])

        verify_file('test_unit_test.gold', 'test_unit_test.sv')
        verify_testsuite('testsuite.gold')


@all_files_in_dir('frmwrk_4')
def test_frmwrk_4(datafiles):
    with datafiles.as_cwd():
        create_unit_test('test.sv')
        with (datafiles / 'another_test').as_cwd():
            create_unit_test('test0.sv')
        subprocess.check_call(['buildSVUnit'])

        golden_testrunner_with_2_testsuites()

        verify_testrunner('testrunner.gold', '__another_test', '_')


@all_files_in_dir('frmwrk_6')
def test_frmwrk_6(datafiles):
    with datafiles.as_cwd():
        subprocess.check_call(['create_unit_test.pl', '-overwrite', '-out', './test_unit_test.sv', 'test.sv'])
        subprocess.check_call(['create_unit_test.pl', '-overwrite', '-out', './subdir0/subdir0_unit_test.sv', './subdir0/subdir0.sv'])
        subprocess.check_call(['create_unit_test.pl', '-overwrite', '-out', './subdir1/subdir1_unit_test.sv', './subdir1/subdir1.sv'])
        subprocess.check_call(['create_unit_test.pl', '-overwrite', '-out', './subdir1/subdir1a/subdir1a_unit_test.sv', './subdir1/subdir1a/subdir1a.sv'])

        subprocess.check_call(['buildSVUnit'])

        golden_testrunner_with_4_testsuites()

        verify_testrunner('testrunner.gold', '__subdir0', '__subdir1_subdir1a', '__subdir1', '_')


def test_frmwrk_7(tmpdir):
    with tmpdir.as_cwd():
        return_code = subprocess.call(['buildSVUnit'])
        assert return_code == 1

        # verify no new files were created
        assert not tmpdir.listdir()


@all_files_in_dir('frmwrk_8')
def test_frmwrk_8(datafiles):
    with datafiles.as_cwd():
        subprocess.check_call(['create_unit_test.pl', '-overwrite', '-out', './subdir0/subdir0_unit_test.sv', './subdir0/subdir0.sv'])
        subprocess.check_call(['create_unit_test.pl', '-overwrite', '-out', './subdir1/subdir1_unit_test.sv', './subdir1/subdir1.sv'])
        subprocess.check_call(['create_unit_test.pl', '-overwrite', '-out', './subdir1/subdir1a/subdir1a_unit_test.sv', './subdir1/subdir1a/subdir1a.sv'])

        subprocess.check_call(['buildSVUnit'])

        golden_testrunner_with_3_testsuites()

        verify_testrunner('testrunner.gold', '__subdir0', '__subdir1_subdir1a', '__subdir1')


@all_files_in_dir('frmwrk_9')
def test_frmwrk_9(datafiles):
    with datafiles.as_cwd():
        subprocess.check_call(['create_unit_test.pl', '-overwrite', '-out', './test_unit_test.sv', 'test.sv'])
        subprocess.check_call(['create_unit_test.pl', '-overwrite', '-out', './subdir1/subdir1a/subdir1a_unit_test.sv', './subdir1/subdir1a/subdir1a.sv'])

        subprocess.check_call(['buildSVUnit'])

        golden_testrunner_with_2_testsuites()

        verify_testrunner('testrunner.gold', '__subdir1_subdir1a', '_')


@all_files_in_dir('frmwrk_10')
def test_frmwrk_10(datafiles):
    with datafiles.as_cwd():
        subprocess.check_call(['create_unit_test.pl', 'test.sv'])

        golden_module_unit_test('test', 'test')

        verify_file('test_unit_test.gold', 'test_unit_test.sv')


@all_files_in_dir('frmwrk_11')
def test_frmwrk_11(datafiles):
    with datafiles.as_cwd():
        subprocess.check_call(['create_unit_test.pl', '-overwrite', 'test_if.sv'])

        golden_if_unit_test('test_if', 'test_if')

        verify_file('test_if_unit_test.gold', 'test_if_unit_test.sv')


@all_files_in_dir('frmwrk_12')
def test_frmwrk_12(datafiles):
    with datafiles.as_cwd():
        for file in datafiles.listdir():
            subprocess.check_call(['create_unit_test.pl', file])
            assert pathlib.Path(file.purebasename + '_unit_test.sv').is_file()


@all_files_in_dir('frmwrk_13')
def test_frmwrk_13(datafiles):
    with datafiles.as_cwd():
        for file in (datafiles / 'second_dir').listdir():
            if not file.check(file=1):
                continue
            subprocess.check_call(['create_unit_test.pl', file])
            assert pathlib.Path(file.purebasename + '_unit_test.sv').is_file()

    with (datafiles / 'second_dir').as_cwd():
        for file in datafiles.listdir():
            if not file.check(file=1):
                continue
            subprocess.check_call(['create_unit_test.pl', file])
            assert pathlib.Path(file.purebasename + '_unit_test.sv').is_file()


@all_files_in_dir('frmwrk_14')
@all_available_simulators()
def test_frmwrk_14(datafiles, simulator):
    new_env = os.environ.copy()
    path_entries = new_env['PATH'].split(':')
    new_path_entries = [path_entry for path_entry in path_entries if not 'svunit-code' in path_entry]
    new_env['PATH'] = ':'.join(new_path_entries)
    new_env['SVUNIT_ROOT'] = get_svunit_root()

    with datafiles.as_cwd():
        subprocess.check_call(['csh', 'run.csh', simulator], env=new_env)
        subprocess.check_call(['tcsh', 'run.csh', simulator], env=new_env)


@all_files_in_dir('frmwrk_15')
def test_frmwrk_15(datafiles):
    with datafiles.as_cwd():
        os.mkdir('third_dir')
        for file in (datafiles / 'second_dir').listdir():
            if not file.check(file=1):
                continue
            destfile = os.path.join('third_dir', file.purebasename + '_unit_test.sv')
            subprocess.check_call(['create_unit_test.pl', file, '-out', destfile])
            assert pathlib.Path(destfile).is_file()

    with (datafiles / 'second_dir').as_cwd():
        for file in (datafiles / 'second_dir').listdir():
            if not file.check(file=1):
                continue
            destfile = os.path.join('..', file.purebasename + '_unit_test.sv')
            subprocess.check_call(['create_unit_test.pl', file, '-out', destfile])
            assert pathlib.Path(destfile).is_file()

    with datafiles.as_cwd():
        subprocess.check_call(['create_unit_test.pl', '-out', 'dud_unit_test.v', 'test2.sv'])
        assert not pathlib.Path('dud_unit_test.v').is_file()

        subprocess.check_call(['create_unit_test.pl', '-out', 'dud.v', 'test2.sv'])
        assert not pathlib.Path('dud.v').is_file()


@all_files_in_dir('frmwrk_16')
def test_frmwrk_16(datafiles):
    with datafiles.as_cwd():
        subprocess.check_call(['create_unit_test.pl', 'test_if.sv'])
        subprocess.check_call(['create_unit_test.pl', 'test_if2.sv'])

        golden_if_unit_test('test_if', 'test_if')
        golden_if_unit_test('test_if2', 'test_if2')

        verify_file('test_if_unit_test.gold', 'test_if_unit_test.sv')
        verify_file('test_if2_unit_test.gold', 'test_if2_unit_test.sv')


def test_frmwrk_17(tmpdir):
    with tmpdir.as_cwd():
        subprocess.check_call(['create_unit_test.pl', '-class_name', 'class_under_test'])

        golden_class_unit_test('class_under_test', 'class_under_test')

        verify_file('class_under_test_unit_test.gold', 'class_under_test_unit_test.sv')


def test_frmwrk_18(tmpdir):
    with tmpdir.as_cwd():
        subprocess.check_call(['create_unit_test.pl', '-module_name', 'module_under_test'])

        golden_module_unit_test('module_under_test', 'module_under_test')

        verify_file('module_under_test_unit_test.gold', 'module_under_test_unit_test.sv')


def test_frmwrk_19(tmpdir):
    with tmpdir.as_cwd():
        subprocess.check_call(['create_unit_test.pl', '-if_name', 'if_under_test'])

        golden_if_unit_test('if_under_test', 'if_under_test')

        verify_file('if_under_test_unit_test.gold', 'if_under_test_unit_test.sv')


@all_files_in_dir('frmwrk_20')
def test_frmwrk_20(datafiles):
    with datafiles.as_cwd():
        subprocess.check_call(['create_unit_test.pl', 'test_automatic.sv'])
        subprocess.check_call(['create_unit_test.pl', 'test_static.sv'])

        golden_if_unit_test('test_automatic', 'test_automatic')
        verify_file('test_automatic_unit_test.gold', 'test_automatic_unit_test.sv')

        golden_if_unit_test('test_static', 'test_static')
        verify_file('test_static_unit_test.gold', 'test_static_unit_test.sv')


@pytest.mark.skip(reason="create_svunit.pl doesn't exist. The original test still passes, though.")
@all_files_in_dir('frmwrk_22')
def test_frmwrk_22(datafiles):
    with datafiles.as_cwd():
        subprocess.check_call(['create_svunit.pl'])

        subprocess.check_call(['make', '.testrunner.sv'])

        golden_testsuite_with_1_unittest('test')
        golden_testrunner_with_1_testsuite()

        verify_testsuite('testsuite.gold')
        verify_testrunner('testrunner.gold', '.')


@all_files_in_dir('frmwrk_23')
def test_frmwrk_23(datafiles):
    with datafiles.as_cwd():
        subprocess.check_call(['create_unit_test.pl', '-overwrite', '-out', './test_unit_test.sv', 'test.sv'])
        subprocess.check_call(['create_unit_test.pl', '-overwrite', '-out', './subdir0/subdir0_unit_test.sv', './subdir0/subdir0.sv'])
        subprocess.check_call(['create_unit_test.pl', '-overwrite', '-out', './subdir1/subdir1_unit_test.sv', './subdir1/subdir1.sv'])
        subprocess.check_call(['create_unit_test.pl', '-overwrite', '-out', './subdir1/subdir1a/subdir1a_unit_test.sv', './subdir1/subdir1a/subdir1a.sv'])

        subprocess.check_call(['buildSVUnit', '-o', '/tmp/rundir'])

        golden_testrunner_with_4_testsuites()

        verify_testrunner('testrunner.gold', '__subdir0', '__subdir1_subdir1a', '__subdir1', '_', '/tmp/rundir/.testrunner.sv')


@all_files_in_dir('frmwrk_24')
def test_frmwrk_24(datafiles):
    with datafiles.as_cwd():
        subprocess.check_call(['buildSVUnit', '-t', 'test_unit_test.sv'])

        golden_testsuite_with_1_unittest('test')
        golden_testrunner_with_1_testsuite()

        verify_testsuite('testsuite.gold')
        verify_testrunner('testrunner.gold', '_', '.')


@all_files_in_dir('frmwrk_25')
def test_frmwrk_25(datafiles):
    with datafiles.as_cwd():
        subprocess.check_call(['buildSVUnit', '-t', 'test_unit_test.sv', '-t', 'test2_unit_test.sv'])

        golden_testsuite_with_2_unittests('test', 'test2')
        golden_testrunner_with_1_testsuite()

        verify_testsuite('testsuite.gold')
        verify_testrunner('testrunner.gold', '_', '.')


@all_files_in_dir('frmwrk_26')
def test_frmwrk_26(datafiles):
    with datafiles.as_cwd():
        subprocess.check_call(['buildSVUnit', '-t', 'test_unit_test.sv'])

        golden_testsuite_with_1_unittest('test')
        golden_testrunner_with_1_testsuite()

        verify_testsuite('testsuite.gold')
        verify_testrunner('testrunner.gold', '_', '.')


@all_files_in_dir('frmwrk_27')
def test_frmwrk_27(datafiles):
    with datafiles.as_cwd():
        subprocess.check_call(['buildSVUnit', '-t', 'subdir/test3_unit_test.sv'])

        golden_testsuite_with_1_unittest('test3')
        golden_testrunner_with_1_testsuite()

        verify_testsuite('testsuite.gold')
        verify_testrunner('testrunner.gold', '_', '.')


@all_files_in_dir('frmwrk_28')
def test_frmwrk_28(datafiles):
    '''Test that the 'runSVUnit' script passes a '-t' argument to 'buildSVUnit.'''
    with datafiles.as_cwd():
        subprocess.check_call(['runSVUnit', '-s', 'questa', '-t', 'test_unit_test.sv'])

        golden_testsuite_with_1_unittest('test')
        golden_testrunner_with_1_testsuite()

        verify_testsuite('testsuite.gold')
        verify_testrunner('testrunner.gold', '_', '.')


@all_files_in_dir('frmwrk_29')
def test_frmwrk_29(datafiles):
    '''Test that the 'runSVUnit' script passes all '-t' arguments to 'buildSVUnit.'''
    with datafiles.as_cwd():
        subprocess.check_call(['runSVUnit', '-s', 'questa', '-t', 'test_unit_test.sv', '-t', 'test2_unit_test.sv'])

        golden_testsuite_with_2_unittests('test', 'test2')
        golden_testrunner_with_1_testsuite()

        verify_testsuite('testsuite.gold')
        verify_testrunner('testrunner.gold', '_', '.')


@all_files_in_dir('frmwrk_30')
def test_frmwrk_30(datafiles):
    with datafiles.as_cwd():
        subprocess.check_call(['create_unit_test.pl', '-p', 'a_pkg::*', 'test.sv'])

        golden_class_unit_test('test', 'test')
        for line in fileinput.input(files=('test_unit_test.gold'), inplace=True):
            print(line.replace('`include "test.sv"', 'import a_pkg::*;'), end='')

        verify_file('test_unit_test.gold', 'test_unit_test.sv')


# TODO Remove as this is the same as 'frmwrk_29'. Left in to make review easier
@all_files_in_dir('frmwrk_31')
def test_frmwrk_31(datafiles):
    '''Test that the 'runSVUnit' script passes all '-t' arguments to 'buildSVUnit.'''
    with datafiles.as_cwd():
        subprocess.check_call(['runSVUnit', '-s', 'questa', '-t', 'test_unit_test.sv', '-t', 'test2_unit_test.sv'])

        golden_testsuite_with_2_unittests('test', 'test2')
        golden_testrunner_with_1_testsuite()

        verify_testsuite('testsuite.gold')
        verify_testrunner('testrunner.gold', '_', '.')


def test_frmwrk_32(tmpdir):
    with tmpdir.as_cwd():
        return_code = subprocess.call(['runSVUnit', '-s', 'questa', 'blunt_object_unit_test.sv'])
        assert return_code == 255


@pytest.mark.parametrize("sim", ["xrun", "irun", "vsim", "vcs"])
def test_called_without_simulator__extract_sim_if_on_path(sim, tmpdir, monkeypatch):
    with tmpdir.as_cwd():
        fake_tool(sim)
        monkeypatch.setenv('PATH', get_path_without_sims())
        monkeypatch.setenv('PATH', '.', prepend=os.pathsep)

        pathlib.Path('dummy_unit_test.sv').write_text('dummy')

        subprocess.check_call(['runSVUnit'])

        assert pathlib.Path('fake_tool.log').is_file()
        assert 'called' in pathlib.Path('fake_tool.log').read_text()


def test_called_without_simulator__extract_xrun_even_if_irun_also_on_path(tmpdir, monkeypatch):
    with tmpdir.as_cwd():
        fake_tool('xrun')
        fake_tool('irun')

        monkeypatch.setenv('PATH', get_path_without_sims())
        monkeypatch.setenv('PATH', '.', prepend=os.pathsep)

        pathlib.Path('dummy_unit_test.sv').write_text('dummy')

        subprocess.check_call(['runSVUnit'])

        assert pathlib.Path('fake_tool.log').is_file()
        assert 'xrun called' in pathlib.Path('fake_tool.log').read_text()


def test_called_with_simulator__override_simulator_extracted_from_path(tmpdir, monkeypatch):
    with tmpdir.as_cwd():
        fake_tool('xrun')
        fake_tool('irun')

        monkeypatch.setenv('PATH', get_path_without_sims())
        monkeypatch.setenv('PATH', '.', prepend=os.pathsep)

        pathlib.Path('dummy_unit_test.sv').write_text('dummy')

        subprocess.check_call(['runSVUnit', '-s', 'irun'])

        assert pathlib.Path('fake_tool.log').is_file()
        assert 'irun called' in pathlib.Path('fake_tool.log').read_text()


def test_called_without_simulator__nothing_on_path(tmpdir, monkeypatch):
    with tmpdir.as_cwd():
        monkeypatch.setenv('PATH', get_path_without_sims())

        pathlib.Path('dummy_unit_test.sv').write_text('dummy')

        proc = subprocess.run(['runSVUnit'], stdout=subprocess.PIPE, universal_newlines=True)

        assert proc.returncode != 0
        assert "Could not determine simulator" in proc.stdout