tests.py

import subprocess
import json
import os
import pytest

TEST_DIR = os.path.abspath(os.path.dirname(__file__))


@pytest.fixture
def change_and_clean_dir():
    cmd = ';'.join(('cd {}'.format(TEST_DIR),
                    'rm -f *.json .*.json *.o *.os hello* build*/*'))
    subprocess.call(cmd, shell=True)


pytestmark = pytest.mark.usefixtures("change_and_clean_dir")


def run_scons(cmd):
    cmd = "cd {}; {}".format(TEST_DIR, cmd)
    subprocess.check_output(cmd, shell=True)


def read_compile_db(db_name='compile_commands.json'):
    db_path = '{}/{}'.format(TEST_DIR, db_name)
    if not os.path.exists(db_path):
        return None

    with open(db_path) as f:
        return json.load(f)


def test_basic():
    run_scons('scons -f sconstruct_basic')
    db = read_compile_db()
    assert db == [
        {
            'directory': TEST_DIR,
            'command': "gcc -o a.o -c -DD1 -II1 a.c",
            'file': 'a.c'
        },
        {
            'directory': TEST_DIR,
            'command': "g++ -o b.o -c -DD1 -II1 b.cpp",
            'file': 'b.cpp'
        },
    ]
    run_scons('scons -f sconstruct_basic -c')
    assert not read_compile_db()


def test_enable_with_cmdline():
    run_scons('scons -f sconstruct_cmdline')
    assert read_compile_db() is None

    run_scons('scons -f sconstruct_cmdline --compiledb=')
    assert read_compile_db() is not None


def test_config_db():
    run_scons('scons -f sconstruct_config_db')
    assert read_compile_db('compile_commands.json') is None
    assert read_compile_db('foo.json') is not None


def test_config_entry_func_simple():
    run_scons('scons -f sconstruct_config_entry_func_simple')
    db = read_compile_db()
    assert db == [
        {
            'directory': TEST_DIR,
            'command': 'clang -DD1 -DD2 -II1 -II2 -c a.c',
            'file': 'a.c'
        },
        {
            'directory': TEST_DIR,
            'command': 'clang++ -DD1 -DD2 -II1 -II2 -c b.cpp',
            'file': 'b.cpp'
        },
    ]


def test_config_entry_func_simple_with_variantdir():
    run_scons('scons -f sconstruct_variant')
    db = read_compile_db()
    assert db == [
        {
            'directory': TEST_DIR,
            'command': ("clang -DD1 -Ibuild_variant/I1 -Isrc_variant/I1 "
                        "-c src_variant/a.c"),
            'file': 'src_variant/a.c'
        },
    ]


def test_config_custom_entry_func():
    run_scons('scons -f sconstruct_config_custom_entry_func')
    db = read_compile_db()
    assert db == [
        {
            'directory': "c:",  # Changed
            'command': 'clang -DD1 -DD2 -II1 -II2 -c a.c',
            'file': 'a.c'
        }
    ]


def test_merge():
    run_scons('scons -f sconstruct_merge')
    run_scons('scons -f sconstruct_merge2')
    db = read_compile_db()
    assert db == [
        {
            'directory': TEST_DIR,
            'command': "gcc -o a.o -c -DD1 -II1 a.c",
            'file': 'a.c'
        },
        {
            'directory': TEST_DIR,
            'command': "gcc -o b.o -c -DD2 -II2 b.c",
            'file': 'b.c'
        },
    ]


def test_config_reset():
    run_scons('scons -f sconstruct_merge')
    run_scons('scons -f sconstruct_config_reset')
    db = read_compile_db()
    assert db == [
        {
            'directory': TEST_DIR,
            'command': "gcc -o b.o -c -DD2 -II2 b.c",
            'file': 'b.c'
        },
    ]


def test_same_source_compiled_multiple_times():
    run_scons('scons -f sconstruct_same_source')
    db = read_compile_db()
    assert db == [
        {
            'directory': TEST_DIR,
            'command': "gcc -o build2/a.o -c -DD2 a.c",
            'file': 'a.c'
        },
    ]


def test_config_multi():
    run_scons('scons -f sconstruct_config_multi')
    db = read_compile_db()
    assert db == [
        {
            'directory': TEST_DIR,
            'command': "gcc -o build/a.o -c -DD1 a.c",
            'file': 'a.c'
        },
        {
            'directory': TEST_DIR,
            'command': "gcc -o build2/a.o -c -DD2 a.c",
            'file': 'a.c'
        },
    ]


def test_enable_with_cmdline_with_config():
    run_scons('scons -f sconstruct_cmdline --compiledb=')
    assert read_compile_db() is not None

    run_scons('scons -f sconstruct_cmdline_config --compiledb=reset,multi')
    db = read_compile_db()
    assert db == [
        {
            'directory': TEST_DIR,
            'command': "gcc -o build/b.o -c -DD1 b.c",
            'file': 'b.c'
        },
        {
            'directory': TEST_DIR,
            'command': "gcc -o build2/b.o -c -DD2 b.c",
            'file': 'b.c'
        },
    ]