tests/format/include_composition.py

import os
from buildstream._context import Context
from buildstream._project import Project
from buildstream._includes import Includes
from buildstream import _yaml


def make_includes(basedir):
    _yaml.roundtrip_dump({'name': 'test'}, os.path.join(basedir, 'project.conf'))
    context = Context()
    project = Project(basedir, context)
    loader = project.loader
    return Includes(loader)


def test_main_has_priority(tmpdir):
    includes = make_includes(str(tmpdir))

    _yaml.roundtrip_dump({'(@)': ['a.yml'], 'test': ['main']},
                         str(tmpdir.join('main.yml')))

    main = _yaml.load(str(tmpdir.join('main.yml')))

    _yaml.roundtrip_dump({'test': ['a']}, str(tmpdir.join('a.yml')))

    includes.process(main)

    assert main.get_sequence('test').as_str_list() == ['main']


def test_include_cannot_append(tmpdir):
    includes = make_includes(str(tmpdir))

    _yaml.roundtrip_dump({'(@)': ['a.yml'], 'test': ['main']},
                         str(tmpdir.join('main.yml')))
    main = _yaml.load(str(tmpdir.join('main.yml')))

    _yaml.roundtrip_dump({'test': {'(>)': ['a']}},
                         str(tmpdir.join('a.yml')))

    includes.process(main)

    assert main.get_sequence('test').as_str_list() == ['main']


def test_main_can_append(tmpdir):
    includes = make_includes(str(tmpdir))

    _yaml.roundtrip_dump({'(@)': ['a.yml'], 'test': {'(>)': ['main']}},
                         str(tmpdir.join('main.yml')))
    main = _yaml.load(str(tmpdir.join('main.yml')))

    _yaml.roundtrip_dump({'test': ['a']}, str(tmpdir.join('a.yml')))

    includes.process(main)

    assert main.get_sequence('test').as_str_list() == ['a', 'main']


def test_sibling_cannot_append_backward(tmpdir):
    includes = make_includes(str(tmpdir))

    _yaml.roundtrip_dump({'(@)': ['a.yml', 'b.yml']},
                         str(tmpdir.join('main.yml')))
    main = _yaml.load(str(tmpdir.join('main.yml')))

    _yaml.roundtrip_dump({'test': {'(>)': ['a']}},
                         str(tmpdir.join('a.yml')))
    _yaml.roundtrip_dump({'test': ['b']},
                         str(tmpdir.join('b.yml')))

    includes.process(main)

    assert main.get_sequence('test').as_str_list() == ['b']


def test_sibling_can_append_forward(tmpdir):
    includes = make_includes(str(tmpdir))

    _yaml.roundtrip_dump({'(@)': ['a.yml', 'b.yml']},
                         str(tmpdir.join('main.yml')))
    main = _yaml.load(str(tmpdir.join('main.yml')))

    _yaml.roundtrip_dump({'test': ['a']},
                         str(tmpdir.join('a.yml')))
    _yaml.roundtrip_dump({'test': {'(>)': ['b']}},
                         str(tmpdir.join('b.yml')))

    includes.process(main)

    assert main.get_sequence('test').as_str_list() == ['a', 'b']


def test_lastest_sibling_has_priority(tmpdir):
    includes = make_includes(str(tmpdir))

    _yaml.roundtrip_dump({'(@)': ['a.yml', 'b.yml']},
                         str(tmpdir.join('main.yml')))
    main = _yaml.load(str(tmpdir.join('main.yml')))

    _yaml.roundtrip_dump({'test': ['a']},
                         str(tmpdir.join('a.yml')))
    _yaml.roundtrip_dump({'test': ['b']},
                         str(tmpdir.join('b.yml')))

    includes.process(main)

    assert main.get_sequence('test').as_str_list() == ['b']


def test_main_keeps_keys(tmpdir):
    includes = make_includes(str(tmpdir))

    _yaml.roundtrip_dump({'(@)': ['a.yml'], 'something': 'else'},
                         str(tmpdir.join('main.yml')))
    main = _yaml.load(str(tmpdir.join('main.yml')))

    _yaml.roundtrip_dump({'test': ['a']}, str(tmpdir.join('a.yml')))

    includes.process(main)

    assert main.get_sequence('test').as_str_list() == ['a']
    assert main.get_str('something') == 'else'


def test_overwrite_directive_on_later_composite(tmpdir):
    includes = make_includes(str(tmpdir))

    _yaml.roundtrip_dump({'(@)': ['a.yml', 'b.yml'], 'test': {'(=)': ['Overwritten']}},
                         str(tmpdir.join('main.yml')))

    main = _yaml.load(str(tmpdir.join('main.yml')))

    # a.yml
    _yaml.roundtrip_dump({'test': ['some useless', 'list', 'to be overwritten'],
                          'foo': 'should not be present'},
                         str(tmpdir.join('a.yml')))

    # b.yaml isn't going to have a 'test' node to overwrite
    _yaml.roundtrip_dump({'foo': 'should be present'},
                         str(tmpdir.join('b.yml')))

    includes.process(main)

    assert main.get_sequence('test').as_str_list() == ['Overwritten']
    assert main.get_str('foo') == 'should be present'