[Notes] [Git][BuildStream/buildstream][willsalmon/trackWarning] 5 commit

Will Salmon pushed to branch willsalmon/trackWarning at BuildStream / buildstream

Commits:

34015a26

by Tristan Maat at 2018-07-30T12:19:45Z

HACKING.rst: Add note about asking for dev permissions

ae47a72b

by Tristan Van Berkom at 2018-07-30T13:11:34Z

Merge branch 'tlater/ask-for-dev-permissions' into 'master'

HACKING.rst: Add note about asking for dev permissions

See merge request BuildStream/buildstream!587

695c0cb0

by Phil Dawson at 2018-07-30T16:07:36Z

junction-elements.rst: Add missing language specifier to literalinclude

A missing language specifier on a literal include directive results in yaml
being rendered as python code. This commit adds the :language: tag to that
directive.

fcb87b0a

by Phil Dawson at 2018-07-30T16:53:37Z

Merge branch 'phil/fixup-junctions-tutorial' into 'master'

junction-elements.rst: Add missing language specifier to literalinclude

See merge request BuildStream/buildstream!591

74076dc2

by William Salmon at 2018-08-01T08:21:02Z

git.py: Add warning to git track if track and ref are not present

This is to address https://gitlab.com/BuildStream/buildstream/issues/471 that
documented unhelpfull behavour when tracking git sources.

5 changed files:

HACKING.rst
buildstream/_pipeline.py
buildstream/plugins/sources/git.py
doc/source/advanced-features/junction-elements.rst
tests/sources/git.py

Changes:

HACKING.rst

@@ -23,6 +23,11 @@ a reasonable timeframe for identifying these.
  Patch submissions
  -----------------
 +If you want to submit a patch, do ask for developer permissions on our
 +IRC channel first (GitLab's button also works, but you may need to
 +shout about it - we often overlook this) - for CI reasons, it's much
 +easier if patches are in branches of the main repository.
++
  Branches must be submitted as merge requests in gitlab. If the branch
  fixes an issue or is related to any issues, these issues must be mentioned
  in the merge request or preferably the commit messages themselves.

buildstream/_pipeline.py

@@ -385,7 +385,14 @@ class Pipeline():
              detail = "Exact versions are missing for the following elements\n" + \
                       "Try tracking these elements first with `bst track`\n\n"
              for element in inconsistent:
 -                detail += "  " + element._get_full_name() + "\n"
 +                detail += "  " + element._get_full_name()
 +                for source in element.sources():
 +                    if not source._get_consistency() and not source.get_ref():
 +                        if hasattr(source, 'tracking') and source.tracking is None:
 +                                detail += ": Is missing ref and track, please add a branch to track or a ref.\n"
 +                detail += "\n"
++
++
              raise PipelineError("Inconsistent pipeline", detail=detail, reason="inconsistent-pipeline")
      # cleanup()

buildstream/plugins/sources/git.py

@@ -363,6 +363,12 @@ class GitSource(Source):
          # If self.tracking is not specified it's not an error, just silently return
          if not self.tracking:
 +            # Is there a better way to check if a ref is given.
 +            if self.mirror.ref is None:
 +                detail = 'Without a tracking branch ref can not be updated but with out ' + \
 +                         'a ref then build can not fetch the repo and bst build will fail'
 +                raise SourceError("{}: No track or ref".format(self),
 +                               detail=detail, reason="track-attempt-no-track")
              return None
          with self.timed_activity("Tracking {} from {}"

doc/source/advanced-features/junction-elements.rst

@@ -34,6 +34,7 @@ The below bst file describes an element which depends on the hello.bst element
  from the autotools example:
  .. literalinclude:: ../../examples/junctions/elements/callHello.bst
 +    :language: yaml
  This element consists of a script which calls hello.bst's hello command.

tests/sources/git.py

@@ -359,3 +359,44 @@ def test_submodule_track_ignore_inconsistent(cli, tmpdir, datafiles):
      # 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=['track', 'target.bst'])
 +    result.assert_main_error(ErrorDomain.STREAM, None)
 +    result.assert_task_error(ErrorDomain.SOURCE, 'track-attempt-no-track')
++
 +    # Assert that we are just fine without it, and emit a warning to the user.
 +    assert "FAILURE git source at" in result.stderr
 +    assert "Without a tracking branch ref can not be updated but with out a ref " + \
 +        "then build can not fetch the repo and bst build will fail" in result.stderr
++
 +    # Track will encounter an inconsistent submodule without any ref
 +    result = cli.run(project=project, args=['build', 'target.bst'])
 +    result.assert_main_error(ErrorDomain.PIPELINE, 'inconsistent-pipeline')
 +    result.assert_task_error(None, None)
++
 +    # Assert that we are just fine without it, and emit a warning to the user.
 +    assert "Exact versions are missing for the following elements" in result.stderr
 +    assert ": Is missing ref and track, please add a branch to track or a ref." in result.stderr

[Notes] [Git][BuildStream/buildstream][willsalmon/trackWarning] 5 commits: HACKING.rst: Add note about asking for dev permissions

Will Salmon pushed to branch willsalmon/trackWarning at BuildStream / buildstream

Commits:

5 changed files:

Changes: