blob: 43cf95ed5aacc5ab8208c294dca630499043c5de [file] [log] [blame]
#
# Copyright (C) 2018 Codethink Limited
# Copyright (C) 2018 Bloomberg Finance LP
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2 of the License, or (at your option) any later version.
#
# This library is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library. If not, see <http://www.gnu.org/licenses/>.
#
# Authors: Tristan Van Berkom <tristan.vanberkom@codethink.co.uk>
# Jonathan Maw <jonathan.maw@codethink.co.uk>
# William Salmon <will.salmon@codethink.co.uk>
#
# Pylint doesn't play well with fixtures and dependency injection from pytest
# pylint: disable=redefined-outer-name
import os
import subprocess
import shutil
import pytest
from buildstream._exceptions import ErrorDomain
from buildstream import _yaml
from buildstream.plugin import CoreWarnings
from buildstream.testing import cli # pylint: disable=unused-import
from buildstream.testing import create_repo
from buildstream.utils import url_directory_name
from tests.testutils.site import HAVE_GIT, HAVE_OLD_GIT
DATA_DIR = os.path.join(
os.path.dirname(os.path.realpath(__file__)),
'git',
)
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
def test_fetch_bad_ref(cli, tmpdir, datafiles):
project = str(datafiles)
# Create the repo from 'repofiles' subdir
repo = create_repo('git', str(tmpdir))
repo.create(os.path.join(project, 'repofiles'))
# Write out our test target with a bad ref
element = {
'kind': 'import',
'sources': [
repo.source_config(ref='5')
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
# Assert that fetch raises an error here
result = cli.run(project=project, args=[
'source', 'fetch', 'target.bst'
])
result.assert_main_error(ErrorDomain.STREAM, None)
result.assert_task_error(ErrorDomain.SOURCE, None)
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
def test_submodule_fetch_checkout(cli, tmpdir, datafiles):
project = str(datafiles)
checkoutdir = os.path.join(str(tmpdir), "checkout")
# Create the submodule first from the 'subrepofiles' subdir
subrepo = create_repo('git', str(tmpdir), 'subrepo')
subrepo.create(os.path.join(project, 'subrepofiles'))
# Create the repo from 'repofiles' subdir
repo = create_repo('git', str(tmpdir))
repo.create(os.path.join(project, 'repofiles'))
# Add a submodule pointing to the one we created
ref = repo.add_submodule('subdir', 'file://' + subrepo.repo)
# Write out our test target
element = {
'kind': 'import',
'sources': [
repo.source_config(ref=ref)
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
# Fetch, build, checkout
result = cli.run(project=project, args=['source', 'fetch', 'target.bst'])
result.assert_success()
result = cli.run(project=project, args=['build', 'target.bst'])
result.assert_success()
result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkoutdir])
result.assert_success()
# Assert we checked out both files at their expected location
assert os.path.exists(os.path.join(checkoutdir, 'file.txt'))
assert os.path.exists(os.path.join(checkoutdir, 'subdir', 'ponyfile.txt'))
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
def test_submodule_fetch_source_enable_explicit(cli, tmpdir, datafiles):
project = str(datafiles)
checkoutdir = os.path.join(str(tmpdir), "checkout")
# Create the submodule first from the 'subrepofiles' subdir
subrepo = create_repo('git', str(tmpdir), 'subrepo')
subrepo.create(os.path.join(project, 'subrepofiles'))
# Create the repo from 'repofiles' subdir
repo = create_repo('git', str(tmpdir))
repo.create(os.path.join(project, 'repofiles'))
# Add a submodule pointing to the one we created
ref = repo.add_submodule('subdir', 'file://' + subrepo.repo)
# Write out our test target
element = {
'kind': 'import',
'sources': [
repo.source_config(ref=ref, checkout_submodules=True)
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
# Fetch, build, checkout
result = cli.run(project=project, args=['source', 'fetch', 'target.bst'])
result.assert_success()
result = cli.run(project=project, args=['build', 'target.bst'])
result.assert_success()
result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkoutdir])
result.assert_success()
# Assert we checked out both files at their expected location
assert os.path.exists(os.path.join(checkoutdir, 'file.txt'))
assert os.path.exists(os.path.join(checkoutdir, 'subdir', 'ponyfile.txt'))
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
def test_submodule_fetch_source_disable(cli, tmpdir, datafiles):
project = str(datafiles)
checkoutdir = os.path.join(str(tmpdir), "checkout")
# Create the submodule first from the 'subrepofiles' subdir
subrepo = create_repo('git', str(tmpdir), 'subrepo')
subrepo.create(os.path.join(project, 'subrepofiles'))
# Create the repo from 'repofiles' subdir
repo = create_repo('git', str(tmpdir))
repo.create(os.path.join(project, 'repofiles'))
# Add a submodule pointing to the one we created
ref = repo.add_submodule('subdir', 'file://' + subrepo.repo)
# Write out our test target
element = {
'kind': 'import',
'sources': [
repo.source_config(ref=ref, checkout_submodules=False)
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
# Fetch, build, checkout
result = cli.run(project=project, args=['source', 'fetch', 'target.bst'])
result.assert_success()
result = cli.run(project=project, args=['build', 'target.bst'])
result.assert_success()
result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkoutdir])
result.assert_success()
# Assert we checked out both files at their expected location
assert os.path.exists(os.path.join(checkoutdir, 'file.txt'))
assert not os.path.exists(os.path.join(checkoutdir, 'subdir', 'ponyfile.txt'))
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
def test_submodule_fetch_submodule_does_override(cli, tmpdir, datafiles):
project = str(datafiles)
checkoutdir = os.path.join(str(tmpdir), "checkout")
# Create the submodule first from the 'subrepofiles' subdir
subrepo = create_repo('git', str(tmpdir), 'subrepo')
subrepo.create(os.path.join(project, 'subrepofiles'))
# Create the repo from 'repofiles' subdir
repo = create_repo('git', str(tmpdir))
repo.create(os.path.join(project, 'repofiles'))
# Add a submodule pointing to the one we created
ref = repo.add_submodule('subdir', 'file://' + subrepo.repo, checkout=True)
# Write out our test target
element = {
'kind': 'import',
'sources': [
repo.source_config(ref=ref, checkout_submodules=False)
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
# Fetch, build, checkout
result = cli.run(project=project, args=['source', 'fetch', 'target.bst'])
result.assert_success()
result = cli.run(project=project, args=['build', 'target.bst'])
result.assert_success()
result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkoutdir])
result.assert_success()
# Assert we checked out both files at their expected location
assert os.path.exists(os.path.join(checkoutdir, 'file.txt'))
assert os.path.exists(os.path.join(checkoutdir, 'subdir', 'ponyfile.txt'))
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
def test_submodule_fetch_submodule_individual_checkout(cli, tmpdir, datafiles):
project = str(datafiles)
checkoutdir = os.path.join(str(tmpdir), "checkout")
# Create the submodule first from the 'subrepofiles' subdir
subrepo = create_repo('git', str(tmpdir), 'subrepo')
subrepo.create(os.path.join(project, 'subrepofiles'))
# Create another submodule from the 'othersubrepofiles' subdir
other_subrepo = create_repo('git', str(tmpdir), 'othersubrepo')
other_subrepo.create(os.path.join(project, 'othersubrepofiles'))
# Create the repo from 'repofiles' subdir
repo = create_repo('git', str(tmpdir))
repo.create(os.path.join(project, 'repofiles'))
# Add a submodule pointing to the one we created
repo.add_submodule('subdir', 'file://' + subrepo.repo, checkout=False)
ref = repo.add_submodule('othersubdir', 'file://' + other_subrepo.repo)
# Write out our test target
element = {
'kind': 'import',
'sources': [
repo.source_config(ref=ref, checkout_submodules=True)
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
# Fetch, build, checkout
result = cli.run(project=project, args=['source', 'fetch', 'target.bst'])
result.assert_success()
result = cli.run(project=project, args=['build', 'target.bst'])
result.assert_success()
result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkoutdir])
result.assert_success()
# Assert we checked out files at their expected location
assert os.path.exists(os.path.join(checkoutdir, 'file.txt'))
assert not os.path.exists(os.path.join(checkoutdir, 'subdir', 'ponyfile.txt'))
assert os.path.exists(os.path.join(checkoutdir, 'othersubdir', 'unicornfile.txt'))
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
def test_submodule_fetch_submodule_individual_checkout_explicit(cli, tmpdir, datafiles):
project = str(datafiles)
checkoutdir = os.path.join(str(tmpdir), "checkout")
# Create the submodule first from the 'subrepofiles' subdir
subrepo = create_repo('git', str(tmpdir), 'subrepo')
subrepo.create(os.path.join(project, 'subrepofiles'))
# Create another submodule from the 'othersubrepofiles' subdir
other_subrepo = create_repo('git', str(tmpdir), 'othersubrepo')
other_subrepo.create(os.path.join(project, 'othersubrepofiles'))
# Create the repo from 'repofiles' subdir
repo = create_repo('git', str(tmpdir))
repo.create(os.path.join(project, 'repofiles'))
# Add a submodule pointing to the one we created
repo.add_submodule('subdir', 'file://' + subrepo.repo, checkout=False)
ref = repo.add_submodule('othersubdir', 'file://' + other_subrepo.repo, checkout=True)
# Write out our test target
element = {
'kind': 'import',
'sources': [
repo.source_config(ref=ref, checkout_submodules=True)
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
# Fetch, build, checkout
result = cli.run(project=project, args=['source', 'fetch', 'target.bst'])
result.assert_success()
result = cli.run(project=project, args=['build', 'target.bst'])
result.assert_success()
result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkoutdir])
result.assert_success()
# Assert we checked out files at their expected location
assert os.path.exists(os.path.join(checkoutdir, 'file.txt'))
assert not os.path.exists(os.path.join(checkoutdir, 'subdir', 'ponyfile.txt'))
assert os.path.exists(os.path.join(checkoutdir, 'othersubdir', 'unicornfile.txt'))
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'project-override'))
def test_submodule_fetch_project_override(cli, tmpdir, datafiles):
project = str(datafiles)
checkoutdir = os.path.join(str(tmpdir), "checkout")
# Create the submodule first from the 'subrepofiles' subdir
subrepo = create_repo('git', str(tmpdir), 'subrepo')
subrepo.create(os.path.join(project, 'subrepofiles'))
# Create the repo from 'repofiles' subdir
repo = create_repo('git', str(tmpdir))
repo.create(os.path.join(project, 'repofiles'))
# Add a submodule pointing to the one we created
ref = repo.add_submodule('subdir', 'file://' + subrepo.repo)
# Write out our test target
element = {
'kind': 'import',
'sources': [
repo.source_config(ref=ref)
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
# Fetch, build, checkout
result = cli.run(project=project, args=['source', 'fetch', 'target.bst'])
result.assert_success()
result = cli.run(project=project, args=['build', 'target.bst'])
result.assert_success()
result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkoutdir])
result.assert_success()
# Assert we checked out both files at their expected location
assert os.path.exists(os.path.join(checkoutdir, 'file.txt'))
assert not os.path.exists(os.path.join(checkoutdir, 'subdir', 'ponyfile.txt'))
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
def test_submodule_track_ignore_inconsistent(cli, tmpdir, datafiles):
project = str(datafiles)
# Create the repo from 'repofiles' subdir
repo = create_repo('git', str(tmpdir))
ref = repo.create(os.path.join(project, 'repofiles'))
# Write out our test target
element = {
'kind': 'import',
'sources': [
repo.source_config(ref=ref)
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
# Now add a .gitmodules file with an inconsistent submodule,
# we are calling this inconsistent because the file was created
# but `git submodule add` was never called, so there is no reference
# associated to the submodule.
#
repo.add_file(os.path.join(project, 'inconsistent-submodule', '.gitmodules'))
# Fetch should work, we're not yet at the offending ref
result = cli.run(project=project, args=['source', 'fetch', 'target.bst'])
result.assert_success()
# Track will encounter an inconsistent submodule without any ref
result = cli.run(project=project, args=['source', 'track', 'target.bst'])
result.assert_success()
# Assert that we are just fine without it, and emit a warning to the user.
assert "Ignoring inconsistent submodule" in result.stderr
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
def test_submodule_track_no_ref_or_track(cli, tmpdir, datafiles):
project = str(datafiles)
# Create the repo from 'repofiles' subdir
repo = create_repo('git', str(tmpdir))
repo.create(os.path.join(project, 'repofiles'))
# Write out our test target
gitsource = repo.source_config(ref=None)
gitsource.pop('track')
element = {
'kind': 'import',
'sources': [
gitsource
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
# Track will encounter an inconsistent submodule without any ref
result = cli.run(project=project, args=['show', 'target.bst'])
result.assert_main_error(ErrorDomain.SOURCE, "missing-track-and-ref")
result.assert_task_error(None, None)
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
@pytest.mark.parametrize("fail", ['warn', 'error'])
def test_ref_not_in_track(cli, tmpdir, datafiles, fail):
project = str(datafiles)
# Make the warning an error if we're testing errors
if fail == 'error':
project_template = {
"name": "foo",
"fatal-warnings": [CoreWarnings.REF_NOT_IN_TRACK]
}
_yaml.dump(project_template, os.path.join(project, 'project.conf'))
# Create the repo from 'repofiles', create a branch without latest commit
repo = create_repo('git', str(tmpdir))
ref = repo.create(os.path.join(project, 'repofiles'))
gitsource = repo.source_config(ref=ref)
# Overwrite the track value to the added branch
gitsource['track'] = 'foo'
# Write out our test target
element = {
'kind': 'import',
'sources': [
gitsource
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
result = cli.run(project=project, args=['build', 'target.bst'])
# Assert a warning or an error depending on what we're checking
if fail == 'error':
result.assert_main_error(ErrorDomain.STREAM, None)
result.assert_task_error(ErrorDomain.PLUGIN, CoreWarnings.REF_NOT_IN_TRACK)
else:
result.assert_success()
assert "ref-not-in-track" in result.stderr
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
@pytest.mark.parametrize("fail", ['warn', 'error'])
def test_unlisted_submodule(cli, tmpdir, datafiles, fail):
project = str(datafiles)
# Make the warning an error if we're testing errors
if fail == 'error':
project_template = {
"name": "foo",
"fatal-warnings": ['git:unlisted-submodule']
}
_yaml.dump(project_template, os.path.join(project, 'project.conf'))
# Create the submodule first from the 'subrepofiles' subdir
subrepo = create_repo('git', str(tmpdir), 'subrepo')
subrepo.create(os.path.join(project, 'subrepofiles'))
# Create the repo from 'repofiles' subdir
repo = create_repo('git', str(tmpdir))
repo.create(os.path.join(project, 'repofiles'))
# Add a submodule pointing to the one we created
ref = repo.add_submodule('subdir', 'file://' + subrepo.repo)
# Create the source, and delete the explicit configuration
# of the submodules.
#
# We expect this to cause an unlisted submodule warning
# after the source has been fetched.
#
gitsource = repo.source_config(ref=ref)
del gitsource['submodules']
# Write out our test target
element = {
'kind': 'import',
'sources': [
gitsource
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
# We will not see the warning or error before the first fetch, because
# we don't have the repository yet and so we have no knowledge of
# the unlisted submodule.
result = cli.run(project=project, args=['show', 'target.bst'])
result.assert_success()
assert "git:unlisted-submodule" not in result.stderr
# We will notice this directly in fetch, as it will try to fetch
# the submodules it discovers as a result of fetching the primary repo.
result = cli.run(project=project, args=['source', 'fetch', 'target.bst'])
# Assert a warning or an error depending on what we're checking
if fail == 'error':
result.assert_main_error(ErrorDomain.STREAM, None)
result.assert_task_error(ErrorDomain.PLUGIN, 'git:unlisted-submodule')
else:
result.assert_success()
assert "git:unlisted-submodule" in result.stderr
# Now that we've fetched it, `bst show` will discover the unlisted submodule too
result = cli.run(project=project, args=['show', 'target.bst'])
# Assert a warning or an error depending on what we're checking
if fail == 'error':
result.assert_main_error(ErrorDomain.PLUGIN, 'git:unlisted-submodule')
else:
result.assert_success()
assert "git:unlisted-submodule" in result.stderr
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
@pytest.mark.parametrize("fail", ['warn', 'error'])
def test_track_unlisted_submodule(cli, tmpdir, datafiles, fail):
project = str(datafiles)
# Make the warning an error if we're testing errors
if fail == 'error':
project_template = {
"name": "foo",
"fatal-warnings": ['git:unlisted-submodule']
}
_yaml.dump(project_template, os.path.join(project, 'project.conf'))
# Create the submodule first from the 'subrepofiles' subdir
subrepo = create_repo('git', str(tmpdir), 'subrepo')
subrepo.create(os.path.join(project, 'subrepofiles'))
# Create the repo from 'repofiles' subdir
repo = create_repo('git', str(tmpdir))
ref = repo.create(os.path.join(project, 'repofiles'))
# Add a submodule pointing to the one we created, but use
# the original ref, let the submodules appear after tracking
repo.add_submodule('subdir', 'file://' + subrepo.repo)
# Create the source, and delete the explicit configuration
# of the submodules.
gitsource = repo.source_config(ref=ref)
del gitsource['submodules']
# Write out our test target
element = {
'kind': 'import',
'sources': [
gitsource
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
# Fetch the repo, we will not see the warning because we
# are still pointing to a ref which predates the submodules
result = cli.run(project=project, args=['source', 'fetch', 'target.bst'])
result.assert_success()
assert "git:unlisted-submodule" not in result.stderr
# We won't get a warning/error when tracking either, the source
# has not become Consistency.CACHED so the opportunity to check
# for the warning has not yet arisen.
result = cli.run(project=project, args=['source', 'track', 'target.bst'])
result.assert_success()
assert "git:unlisted-submodule" not in result.stderr
# Fetching the repo at the new ref will finally reveal the warning
result = cli.run(project=project, args=['source', 'fetch', 'target.bst'])
if fail == 'error':
result.assert_main_error(ErrorDomain.STREAM, None)
result.assert_task_error(ErrorDomain.PLUGIN, 'git:unlisted-submodule')
else:
result.assert_success()
assert "git:unlisted-submodule" in result.stderr
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
@pytest.mark.parametrize("fail", ['warn', 'error'])
def test_invalid_submodule(cli, tmpdir, datafiles, fail):
project = str(datafiles)
# Make the warning an error if we're testing errors
if fail == 'error':
project_template = {
"name": "foo",
"fatal-warnings": ['git:invalid-submodule']
}
_yaml.dump(project_template, os.path.join(project, 'project.conf'))
# Create the repo from 'repofiles' subdir
repo = create_repo('git', str(tmpdir))
ref = repo.create(os.path.join(project, 'repofiles'))
# Create the source without any submodules, and add
# an invalid submodule configuration to it.
#
# We expect this to cause an invalid submodule warning
# after the source has been fetched and we know what
# the real submodules actually are.
#
gitsource = repo.source_config(ref=ref)
gitsource['submodules'] = {
'subdir': {
'url': 'https://pony.org/repo.git'
}
}
# Write out our test target
element = {
'kind': 'import',
'sources': [
gitsource
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
# We will not see the warning or error before the first fetch, because
# we don't have the repository yet and so we have no knowledge of
# the unlisted submodule.
result = cli.run(project=project, args=['show', 'target.bst'])
result.assert_success()
assert "git:invalid-submodule" not in result.stderr
# We will notice this directly in fetch, as it will try to fetch
# the submodules it discovers as a result of fetching the primary repo.
result = cli.run(project=project, args=['source', 'fetch', 'target.bst'])
# Assert a warning or an error depending on what we're checking
if fail == 'error':
result.assert_main_error(ErrorDomain.STREAM, None)
result.assert_task_error(ErrorDomain.PLUGIN, 'git:invalid-submodule')
else:
result.assert_success()
assert "git:invalid-submodule" in result.stderr
# Now that we've fetched it, `bst show` will discover the unlisted submodule too
result = cli.run(project=project, args=['show', 'target.bst'])
# Assert a warning or an error depending on what we're checking
if fail == 'error':
result.assert_main_error(ErrorDomain.PLUGIN, 'git:invalid-submodule')
else:
result.assert_success()
assert "git:invalid-submodule" in result.stderr
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.skipif(HAVE_OLD_GIT, reason="old git rm does not update .gitmodules")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
@pytest.mark.parametrize("fail", ['warn', 'error'])
def test_track_invalid_submodule(cli, tmpdir, datafiles, fail):
project = str(datafiles)
# Make the warning an error if we're testing errors
if fail == 'error':
project_template = {
"name": "foo",
"fatal-warnings": ['git:invalid-submodule']
}
_yaml.dump(project_template, os.path.join(project, 'project.conf'))
# Create the submodule first from the 'subrepofiles' subdir
subrepo = create_repo('git', str(tmpdir), 'subrepo')
subrepo.create(os.path.join(project, 'subrepofiles'))
# Create the repo from 'repofiles' subdir
repo = create_repo('git', str(tmpdir))
repo.create(os.path.join(project, 'repofiles'))
# Add a submodule pointing to the one we created
ref = repo.add_submodule('subdir', 'file://' + subrepo.repo)
# Add a commit beyond the ref which *removes* the submodule we've added
repo.remove_path('subdir')
# Create the source, this will keep the submodules so initially
# the configuration is valid for the ref we're using
gitsource = repo.source_config(ref=ref)
# Write out our test target
element = {
'kind': 'import',
'sources': [
gitsource
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
# Fetch the repo, we will not see the warning because we
# are still pointing to a ref which predates the submodules
result = cli.run(project=project, args=['source', 'fetch', 'target.bst'])
result.assert_success()
assert "git:invalid-submodule" not in result.stderr
# In this case, we will get the error directly after tracking,
# since the new HEAD does not require any submodules which are
# not locally cached, the Source will be CACHED directly after
# tracking and the validations will occur as a result.
#
result = cli.run(project=project, args=['source', 'track', 'target.bst'])
if fail == 'error':
result.assert_main_error(ErrorDomain.STREAM, None)
result.assert_task_error(ErrorDomain.PLUGIN, 'git:invalid-submodule')
else:
result.assert_success()
assert "git:invalid-submodule" in result.stderr
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
@pytest.mark.parametrize("ref_format", ['sha1', 'git-describe'])
@pytest.mark.parametrize("tag,extra_commit", [(False, False), (True, False), (True, True)])
def test_track_fetch(cli, tmpdir, datafiles, ref_format, tag, extra_commit):
project = str(datafiles)
# Create the repo from 'repofiles' subdir
repo = create_repo('git', str(tmpdir))
repo.create(os.path.join(project, 'repofiles'))
if tag:
repo.add_tag('tag')
if extra_commit:
repo.add_commit()
# Write out our test target
element = {
'kind': 'import',
'sources': [
repo.source_config()
]
}
element['sources'][0]['ref-format'] = ref_format
element_path = os.path.join(project, 'target.bst')
_yaml.dump(element, element_path)
# Track it
result = cli.run(project=project, args=['source', 'track', 'target.bst'])
result.assert_success()
element = _yaml.load(element_path)
new_ref = _yaml.node_get(_yaml.node_get(element, dict, 'sources', [0]), str, 'ref')
if ref_format == 'git-describe' and tag:
# Check and strip prefix
prefix = 'tag-{}-g'.format(0 if not extra_commit else 1)
assert new_ref.startswith(prefix)
new_ref = new_ref[len(prefix):]
# 40 chars for SHA-1
assert len(new_ref) == 40
# Fetch it
result = cli.run(project=project, args=['source', 'fetch', 'target.bst'])
result.assert_success()
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.skipif(HAVE_OLD_GIT, reason="old git describe lacks --first-parent")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
@pytest.mark.parametrize("ref_storage", [('inline'), ('project.refs')])
@pytest.mark.parametrize("tag_type", [('annotated'), ('lightweight')])
def test_git_describe(cli, tmpdir, datafiles, ref_storage, tag_type):
project = str(datafiles)
project_config = _yaml.load(os.path.join(project, 'project.conf'))
_yaml.node_set(project_config, 'ref-storage', ref_storage)
_yaml.dump(_yaml.node_sanitize(project_config), os.path.join(project, 'project.conf'))
repofiles = os.path.join(str(tmpdir), 'repofiles')
os.makedirs(repofiles, exist_ok=True)
file0 = os.path.join(repofiles, 'file0')
with open(file0, 'w') as f:
f.write('test\n')
repo = create_repo('git', str(tmpdir))
def tag(name):
if tag_type == 'annotated':
repo.add_annotated_tag(name, name)
else:
repo.add_tag(name)
repo.create(repofiles)
tag('uselesstag')
file1 = os.path.join(str(tmpdir), 'file1')
with open(file1, 'w') as f:
f.write('test\n')
repo.add_file(file1)
tag('tag1')
file2 = os.path.join(str(tmpdir), 'file2')
with open(file2, 'w') as f:
f.write('test\n')
repo.branch('branch2')
repo.add_file(file2)
tag('tag2')
repo.checkout('master')
file3 = os.path.join(str(tmpdir), 'file3')
with open(file3, 'w') as f:
f.write('test\n')
repo.add_file(file3)
repo.merge('branch2')
config = repo.source_config()
config['track'] = repo.latest_commit()
config['track-tags'] = True
# Write out our test target
element = {
'kind': 'import',
'sources': [
config
],
}
element_path = os.path.join(project, 'target.bst')
_yaml.dump(element, element_path)
if ref_storage == 'inline':
result = cli.run(project=project, args=['source', 'track', 'target.bst'])
result.assert_success()
else:
result = cli.run(project=project, args=['source', 'track', 'target.bst', '--deps', 'all'])
result.assert_success()
if ref_storage == 'inline':
element = _yaml.load(element_path)
tags = _yaml.node_get(_yaml.node_get(element, dict, 'sources', [0]), list, 'tags')
assert len(tags) == 2
for tag in tags:
assert 'tag' in tag
assert 'commit' in tag
assert 'annotated' in tag
assert _yaml.node_get(tag, bool, 'annotated') == (tag_type == 'annotated')
assert {(_yaml.node_get(tag, str, 'tag'),
_yaml.node_get(tag, str, 'commit'))
for tag in tags} == {('tag1', repo.rev_parse('tag1^{commit}')),
('tag2', repo.rev_parse('tag2^{commit}'))}
checkout = os.path.join(str(tmpdir), 'checkout')
result = cli.run(project=project, args=['build', 'target.bst'])
result.assert_success()
result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkout])
result.assert_success()
if tag_type == 'annotated':
options = []
else:
options = ['--tags']
describe = subprocess.check_output(['git', 'describe', *options],
cwd=checkout, universal_newlines=True)
assert describe.startswith('tag2-2-')
describe_fp = subprocess.check_output(['git', 'describe', '--first-parent', *options],
cwd=checkout, universal_newlines=True)
assert describe_fp.startswith('tag1-2-')
tags = subprocess.check_output(['git', 'tag'],
cwd=checkout, universal_newlines=True)
tags = set(tags.splitlines())
assert tags == set(['tag1', 'tag2'])
p = subprocess.run(['git', 'log', repo.rev_parse('uselesstag')],
cwd=checkout)
assert p.returncode != 0
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
@pytest.mark.parametrize("ref_storage", [('inline'), ('project.refs')])
@pytest.mark.parametrize("tag_type", [('annotated'), ('lightweight')])
def test_git_describe_head_is_tagged(cli, tmpdir, datafiles, ref_storage, tag_type):
project = str(datafiles)
project_config = _yaml.load(os.path.join(project, 'project.conf'))
_yaml.node_set(project_config, 'ref-storage', ref_storage)
_yaml.dump(_yaml.node_sanitize(project_config), os.path.join(project, 'project.conf'))
repofiles = os.path.join(str(tmpdir), 'repofiles')
os.makedirs(repofiles, exist_ok=True)
file0 = os.path.join(repofiles, 'file0')
with open(file0, 'w') as f:
f.write('test\n')
repo = create_repo('git', str(tmpdir))
def tag(name):
if tag_type == 'annotated':
repo.add_annotated_tag(name, name)
else:
repo.add_tag(name)
repo.create(repofiles)
tag('uselesstag')
file1 = os.path.join(str(tmpdir), 'file1')
with open(file1, 'w') as f:
f.write('test\n')
repo.add_file(file1)
file2 = os.path.join(str(tmpdir), 'file2')
with open(file2, 'w') as f:
f.write('test\n')
repo.branch('branch2')
repo.add_file(file2)
repo.checkout('master')
file3 = os.path.join(str(tmpdir), 'file3')
with open(file3, 'w') as f:
f.write('test\n')
repo.add_file(file3)
tagged_ref = repo.merge('branch2')
tag('tag')
config = repo.source_config()
config['track'] = repo.latest_commit()
config['track-tags'] = True
# Write out our test target
element = {
'kind': 'import',
'sources': [
config
],
}
element_path = os.path.join(project, 'target.bst')
_yaml.dump(element, element_path)
if ref_storage == 'inline':
result = cli.run(project=project, args=['source', 'track', 'target.bst'])
result.assert_success()
else:
result = cli.run(project=project, args=['source', 'track', 'target.bst', '--deps', 'all'])
result.assert_success()
if ref_storage == 'inline':
element = _yaml.load(element_path)
source = _yaml.node_get(element, dict, 'sources', indices=[0])
tags = _yaml.node_get(source, list, 'tags')
assert len(tags) == 1
tag = _yaml.node_get(source, dict, 'tags', indices=[0])
assert 'tag' in tag
assert 'commit' in tag
assert 'annotated' in tag
assert _yaml.node_get(tag, bool, 'annotated') == (tag_type == 'annotated')
tag_name = _yaml.node_get(tag, str, 'tag')
commit = _yaml.node_get(tag, str, 'commit')
assert (tag_name, commit) == ('tag', repo.rev_parse('tag^{commit}'))
checkout = os.path.join(str(tmpdir), 'checkout')
result = cli.run(project=project, args=['build', 'target.bst'])
result.assert_success()
result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkout])
result.assert_success()
if tag_type == 'annotated':
options = []
else:
options = ['--tags']
describe = subprocess.check_output(['git', 'describe', *options],
cwd=checkout, universal_newlines=True)
assert describe.startswith('tag')
tags = subprocess.check_output(['git', 'tag'],
cwd=checkout,
universal_newlines=True)
tags = set(tags.splitlines())
assert tags == set(['tag'])
rev_list = subprocess.check_output(['git', 'rev-list', '--all'],
cwd=checkout,
universal_newlines=True)
assert set(rev_list.splitlines()) == set([tagged_ref])
p = subprocess.run(['git', 'log', repo.rev_parse('uselesstag')],
cwd=checkout)
assert p.returncode != 0
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
def test_git_describe_relevant_history(cli, tmpdir, datafiles):
project = str(datafiles)
project_config = _yaml.load(os.path.join(project, 'project.conf'))
_yaml.node_set(project_config, 'ref-storage', 'project.refs')
_yaml.dump(_yaml.node_sanitize(project_config), os.path.join(project, 'project.conf'))
repofiles = os.path.join(str(tmpdir), 'repofiles')
os.makedirs(repofiles, exist_ok=True)
file0 = os.path.join(repofiles, 'file0')
with open(file0, 'w') as f:
f.write('test\n')
repo = create_repo('git', str(tmpdir))
repo.create(repofiles)
file1 = os.path.join(str(tmpdir), 'file1')
with open(file1, 'w') as f:
f.write('test\n')
repo.add_file(file1)
repo.branch('branch')
repo.checkout('master')
file2 = os.path.join(str(tmpdir), 'file2')
with open(file2, 'w') as f:
f.write('test\n')
repo.add_file(file2)
file3 = os.path.join(str(tmpdir), 'file3')
with open(file3, 'w') as f:
f.write('test\n')
branch_boundary = repo.add_file(file3)
repo.checkout('branch')
file4 = os.path.join(str(tmpdir), 'file4')
with open(file4, 'w') as f:
f.write('test\n')
tagged_ref = repo.add_file(file4)
repo.add_annotated_tag('tag1', 'tag1')
head = repo.merge('master')
config = repo.source_config()
config['track'] = head
config['track-tags'] = True
# Write out our test target
element = {
'kind': 'import',
'sources': [
config
],
}
element_path = os.path.join(project, 'target.bst')
_yaml.dump(element, element_path)
result = cli.run(project=project, args=['source', 'track', 'target.bst', '--deps', 'all'])
result.assert_success()
checkout = os.path.join(str(tmpdir), 'checkout')
result = cli.run(project=project, args=['build', 'target.bst'])
result.assert_success()
result = cli.run(project=project, args=['artifact', 'checkout', 'target.bst', '--directory', checkout])
result.assert_success()
describe = subprocess.check_output(['git', 'describe'],
cwd=checkout,
universal_newlines=True)
assert describe.startswith('tag1-2-')
rev_list = subprocess.check_output(['git', 'rev-list', '--all'],
cwd=checkout,
universal_newlines=True)
assert set(rev_list.splitlines()) == set([head, tagged_ref, branch_boundary])
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
def test_default_do_not_track_tags(cli, tmpdir, datafiles):
project = str(datafiles)
project_config = _yaml.load(os.path.join(project, 'project.conf'))
_yaml.node_set(project_config, 'ref-storage', 'inline')
_yaml.dump(_yaml.node_sanitize(project_config), os.path.join(project, 'project.conf'))
repofiles = os.path.join(str(tmpdir), 'repofiles')
os.makedirs(repofiles, exist_ok=True)
file0 = os.path.join(repofiles, 'file0')
with open(file0, 'w') as f:
f.write('test\n')
repo = create_repo('git', str(tmpdir))
repo.create(repofiles)
repo.add_tag('tag')
config = repo.source_config()
config['track'] = repo.latest_commit()
# Write out our test target
element = {
'kind': 'import',
'sources': [
config
],
}
element_path = os.path.join(project, 'target.bst')
_yaml.dump(element, element_path)
result = cli.run(project=project, args=['source', 'track', 'target.bst'])
result.assert_success()
element = _yaml.load(element_path)
source = _yaml.node_get(element, dict, 'sources', indices=[0])
assert 'tags' not in source
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
def test_overwrite_rogue_tag_multiple_remotes(cli, tmpdir, datafiles):
"""When using multiple remotes in cache (i.e. when using aliases), we
need to make sure we override tags. This is not allowed to fetch
tags that were present from different origins
"""
project = str(datafiles)
repofiles = os.path.join(str(tmpdir), 'repofiles')
os.makedirs(repofiles, exist_ok=True)
file0 = os.path.join(repofiles, 'file0')
with open(file0, 'w') as f:
f.write('test\n')
repo = create_repo('git', str(tmpdir))
top_commit = repo.create(repofiles)
repodir, reponame = os.path.split(repo.repo)
project_config = _yaml.load(os.path.join(project, 'project.conf'))
_yaml.node_set(project_config, 'aliases', _yaml.new_node_from_dict({
'repo': 'http://example.com/'
}))
_yaml.node_set(project_config, 'mirrors', [
{
'name': 'middle-earth',
'aliases': {
'repo': ['file://{}/'.format(repodir)]
}
}
])
_yaml.dump(_yaml.node_sanitize(project_config), os.path.join(project, 'project.conf'))
repo.add_annotated_tag('tag', 'tag')
file1 = os.path.join(repofiles, 'file1')
with open(file1, 'w') as f:
f.write('test\n')
ref = repo.add_file(file1)
config = repo.source_config(ref=ref)
del config['track']
config['url'] = 'repo:{}'.format(reponame)
# Write out our test target
element = {
'kind': 'import',
'sources': [
config
],
}
element_path = os.path.join(project, 'target.bst')
_yaml.dump(element, element_path)
result = cli.run(project=project, args=['build', 'target.bst'])
result.assert_success()
repo.checkout(top_commit)
file2 = os.path.join(repofiles, 'file2')
with open(file2, 'w') as f:
f.write('test\n')
new_ref = repo.add_file(file2)
repo.delete_tag('tag')
repo.add_annotated_tag('tag', 'tag')
repo.checkout('master')
otherpath = os.path.join(str(tmpdir), 'other_path')
shutil.copytree(repo.repo,
os.path.join(otherpath, 'repo'))
create_repo('git', otherpath)
repodir, reponame = os.path.split(repo.repo)
_yaml.dump(_yaml.node_sanitize(project_config), os.path.join(project, 'project.conf'))
config = repo.source_config(ref=new_ref)
del config['track']
config['url'] = 'repo:{}'.format(reponame)
element = {
'kind': 'import',
'sources': [
config
],
}
_yaml.dump(element, element_path)
result = cli.run(project=project, args=['build', 'target.bst'])
result.assert_success()
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
def test_fetch_shallow(cli, tmpdir, datafiles):
project = str(datafiles)
repo = create_repo('git', str(tmpdir))
previous_ref = repo.create(os.path.join(project, 'repofiles'))
file1 = os.path.join(str(tmpdir), 'file1')
with open(file1, 'w') as f:
f.write('test\n')
ref = repo.add_file(file1)
source_config = repo.source_config(ref=ref)
# Write out our test target with a bad ref
element = {
'kind': 'import',
'sources': [
source_config
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
sources_dir = os.path.join(str(tmpdir), 'sources')
os.makedirs(sources_dir, exist_ok=True)
config = {
'sourcedir': sources_dir
}
cli.configure(config)
result = cli.run(project=project, args=[
'source', 'fetch', 'target.bst'
])
result.assert_success()
cache_dir_name = url_directory_name(source_config['url'])
full_cache_path = os.path.join(sources_dir, 'git', cache_dir_name)
shallow_cache_path = os.path.join(sources_dir, 'git', '{}-{}'.format(cache_dir_name, ref))
assert os.path.exists(shallow_cache_path)
assert not os.path.exists(full_cache_path)
output = subprocess.run(['git', 'log', '--format=format:%H'],
cwd=shallow_cache_path,
stdout=subprocess.PIPE).stdout.decode('ascii')
assert output.splitlines() == [ref]
result = cli.run(project=project, args=[
'build', 'target.bst'
])
result.assert_success()
output = subprocess.run(['git', 'log', '--format=format:%H'],
cwd=shallow_cache_path,
stdout=subprocess.PIPE).stdout.decode('ascii')
assert output.splitlines() == [ref]
assert os.path.exists(shallow_cache_path)
assert not os.path.exists(full_cache_path)
result = cli.run(project=project, args=[
'source', 'track', 'target.bst'
])
result.assert_success()
assert os.path.exists(full_cache_path)
output = subprocess.run(['git', 'log', '--format=format:%H'],
cwd=full_cache_path,
stdout=subprocess.PIPE).stdout.decode('ascii')
assert output.splitlines() == [ref, previous_ref]
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
def test_fetch_shallow_not_tagged(cli, tmpdir, datafiles):
"""When a ref is not tagged and not head of branch on remote we cannot
get a shallow clone. It should automatically get a full clone.
"""
project = str(datafiles)
repo = create_repo('git', str(tmpdir))
previous_ref = repo.create(os.path.join(project, 'repofiles'))
file1 = os.path.join(str(tmpdir), 'file1')
with open(file1, 'w') as f:
f.write('test\n')
ref = repo.add_file(file1)
source_config = repo.source_config(ref=previous_ref)
# Write out our test target with a bad ref
element = {
'kind': 'import',
'sources': [
source_config
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
sources_dir = os.path.join(str(tmpdir), 'sources')
os.makedirs(sources_dir, exist_ok=True)
config = {
'sourcedir': sources_dir
}
cli.configure(config)
result = cli.run(project=project, args=[
'source', 'fetch', 'target.bst'
])
result.assert_success()
cache_dir_name = url_directory_name(source_config['url'])
full_cache_path = os.path.join(sources_dir, 'git', cache_dir_name)
shallow_cache_path = os.path.join(sources_dir, 'git', '{}-{}'.format(cache_dir_name, previous_ref))
assert not os.path.exists(shallow_cache_path)
assert os.path.exists(full_cache_path)
output = subprocess.run(['git', 'log', '--format=format:%H'],
cwd=full_cache_path,
stdout=subprocess.PIPE).stdout.decode('ascii')
assert output.splitlines() == [ref, previous_ref]
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
def test_fetch_shallow_annotated_tag(cli, tmpdir, datafiles):
"""When a ref is not tagged and not head of branch on remote we cannot
get a shallow clone. It should automatically get a full clone.
"""
project = str(datafiles)
repo = create_repo('git', str(tmpdir))
previous_ref = repo.create(os.path.join(project, 'repofiles'))
repo.add_annotated_tag('tag', 'tag')
file1 = os.path.join(str(tmpdir), 'file1')
with open(file1, 'w') as f:
f.write('test\n')
repo.add_file(file1)
source_config = repo.source_config(ref=previous_ref)
del source_config['track']
# Write out our test target with a bad ref
element = {
'kind': 'import',
'sources': [
source_config
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
sources_dir = os.path.join(str(tmpdir), 'sources')
os.makedirs(sources_dir, exist_ok=True)
config = {
'sourcedir': sources_dir
}
cli.configure(config)
result = cli.run(project=project, args=[
'source', 'fetch', 'target.bst'
])
result.assert_success()
cache_dir_name = url_directory_name(source_config['url'])
full_cache_path = os.path.join(sources_dir, 'git', cache_dir_name)
shallow_cache_path = os.path.join(sources_dir, 'git', '{}-{}'.format(cache_dir_name, previous_ref))
assert os.path.exists(shallow_cache_path)
assert not os.path.exists(full_cache_path)
output = subprocess.run(['git', 'log', '--format=format:%H'],
cwd=shallow_cache_path,
stdout=subprocess.PIPE).stdout.decode('ascii')
assert output.splitlines() == [previous_ref]
@pytest.mark.skipif(HAVE_GIT is False, reason="git is not available")
@pytest.mark.datafiles(os.path.join(DATA_DIR, 'template'))
def test_fetch_shallow_workspace_open(cli, tmpdir, datafiles):
"""
Workspaces should get a full clone.
"""
project = str(datafiles)
repo = create_repo('git', str(tmpdir))
previous_ref = repo.create(os.path.join(project, 'repofiles'))
file1 = os.path.join(str(tmpdir), 'file1')
with open(file1, 'w') as f:
f.write('test\n')
ref = repo.add_file(file1)
source_config = repo.source_config(ref=ref)
# Write out our test target with a bad ref
element = {
'kind': 'import',
'sources': [
source_config
]
}
_yaml.dump(element, os.path.join(project, 'target.bst'))
sources_dir = os.path.join(str(tmpdir), 'sources')
os.makedirs(sources_dir, exist_ok=True)
config = {
'sourcedir': sources_dir
}
cli.configure(config)
result = cli.run(project=project, args=[
'source', 'fetch', 'target.bst'
])
result.assert_success()
cache_dir_name = url_directory_name(source_config['url'])
full_cache_path = os.path.join(sources_dir, 'git', cache_dir_name)
shallow_cache_path = os.path.join(sources_dir, 'git', '{}-{}'.format(cache_dir_name, ref))
assert os.path.exists(shallow_cache_path)
assert not os.path.exists(full_cache_path)
output = subprocess.run(['git', 'log', '--format=format:%H'],
cwd=shallow_cache_path,
stdout=subprocess.PIPE).stdout.decode('ascii')
assert output.splitlines() == [ref]
workspace = os.path.join(str(tmpdir), 'workspace')
result = cli.run(project=project, args=[
'workspace', 'open', 'target.bst', '--directory', workspace
])
result.assert_success()
output = subprocess.run(['git', 'log', '--format=format:%H'],
cwd=workspace,
stdout=subprocess.PIPE).stdout.decode('ascii')
assert output.splitlines() == [ref, previous_ref]