| # |
| # 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> |
| # |
| |
| import os |
| import pytest |
| |
| from buildstream._exceptions import ErrorDomain |
| from buildstream import _yaml |
| from buildstream.plugin import CoreWarnings |
| |
| from tests.testutils import cli, create_repo |
| from tests.testutils.site import HAVE_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 = os.path.join(datafiles.dirname, datafiles.basename) |
| |
| # 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 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=[ |
| '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 = os.path.join(datafiles.dirname, datafiles.basename) |
| checkoutdir = os.path.join(str(tmpdir), "checkout") |
| |
| # Create the submodule first from the 'subrepofiles' subdir |
| subrepo = create_repo('git', str(tmpdir), 'subrepo') |
| subref = 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 |
| 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=['fetch', 'target.bst']) |
| result.assert_success() |
| result = cli.run(project=project, args=['build', 'target.bst']) |
| result.assert_success() |
| result = cli.run(project=project, args=['checkout', 'target.bst', 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 = os.path.join(datafiles.dirname, datafiles.basename) |
| 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)) |
| ref = 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=['fetch', 'target.bst']) |
| result.assert_success() |
| result = cli.run(project=project, args=['build', 'target.bst']) |
| result.assert_success() |
| result = cli.run(project=project, args=['checkout', 'target.bst', 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 = os.path.join(datafiles.dirname, datafiles.basename) |
| 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)) |
| ref = 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=['fetch', 'target.bst']) |
| result.assert_success() |
| result = cli.run(project=project, args=['build', 'target.bst']) |
| result.assert_success() |
| result = cli.run(project=project, args=['checkout', 'target.bst', 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 = os.path.join(datafiles.dirname, datafiles.basename) |
| 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)) |
| ref = 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=['fetch', 'target.bst']) |
| result.assert_success() |
| result = cli.run(project=project, args=['build', 'target.bst']) |
| result.assert_success() |
| result = cli.run(project=project, args=['checkout', 'target.bst', 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 = os.path.join(datafiles.dirname, datafiles.basename) |
| 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)) |
| ref = 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=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=['fetch', 'target.bst']) |
| result.assert_success() |
| result = cli.run(project=project, args=['build', 'target.bst']) |
| result.assert_success() |
| result = cli.run(project=project, args=['checkout', 'target.bst', 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 = os.path.join(datafiles.dirname, datafiles.basename) |
| 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)) |
| ref = 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=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=['fetch', 'target.bst']) |
| result.assert_success() |
| result = cli.run(project=project, args=['build', 'target.bst']) |
| result.assert_success() |
| result = cli.run(project=project, args=['checkout', 'target.bst', 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 = os.path.join(datafiles.dirname, datafiles.basename) |
| 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)) |
| ref = 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=['fetch', 'target.bst']) |
| result.assert_success() |
| result = cli.run(project=project, args=['build', 'target.bst']) |
| result.assert_success() |
| result = cli.run(project=project, args=['checkout', 'target.bst', 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 = os.path.join(datafiles.dirname, datafiles.basename) |
| |
| # 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=['fetch', 'target.bst']) |
| result.assert_success() |
| |
| # Track will encounter an inconsistent submodule without any ref |
| result = cli.run(project=project, args=['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 = os.path.join(datafiles.dirname, datafiles.basename) |
| |
| # 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 |
| 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')) |
| def test_ref_not_in_track_warn(cli, tmpdir, datafiles): |
| project = os.path.join(datafiles.dirname, datafiles.basename) |
| |
| # 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')) |
| |
| # Assert the warning is raised as ref is not in branch foo. |
| # Assert warning not error to the user, when not set as fatal. |
| result = cli.run(project=project, args=['build', 'target.bst']) |
| assert "The ref provided for the element does not exist locally" 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_ref_not_in_track_warn_error(cli, tmpdir, datafiles): |
| project = os.path.join(datafiles.dirname, datafiles.basename) |
| |
| # Add fatal-warnings ref-not-in-track to project.conf |
| 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')) |
| |
| # Assert that build raises a warning here that is captured |
| # as plugin error, due to the fatal warning being set |
| result = cli.run(project=project, args=['build', 'target.bst']) |
| result.assert_main_error(ErrorDomain.STREAM, None) |
| result.assert_task_error(ErrorDomain.PLUGIN, CoreWarnings.REF_NOT_IN_TRACK) |