[Notes] [Git][BuildStream/buildstream][chandan/junction-dependency-forma

Chandan Singh pushed to branch chandan/junction-dependency-format at BuildStream / buildstream

Commits:

1b02c550

by Chandan Singh at 2019-02-12T12:05:14Z

loader: Allow dependencies to use ":" to refer to junctioned elements

This will allow cross-junction dependencies to be listed as strings on a
single line.

* _loader/types.py: While initializing `Dependency` objects, attempt to
                    split filenames, only if no `junction` was specified
                    explicitly. If a `junction` was specified, then
                    filenames with `:` in their names will result in an
                    error.

* tests/frontend/buildcheckout.py: Add tests to ensure the above.

* _versions.py: Bump BST_FORMAT_VERSION.

Fixes #809.

43c98533

by Chandan Singh at 2019-02-12T14:34:35Z

NEWS: Cross-junction dependencies can now be specified inline

beeab6ea

by Chandan Singh at 2019-02-12T14:34:35Z

Document how to refer to cross-junction dependencies inline

In the previous commit, we added support to express cross-junction
dependencies inline as simple strings. Document it along with the
version in which the feature was added.

Changes:

NEWS

@@ -70,6 +70,9 @@ buildstream 1.3.1
      to avoid having to specify the dependency type for every entry in
      'depends'.
 +  o Elements may now specify cross-junction dependencies as simple strings
 +    using the format '{junction-name}:{element-name}'.
++
    o Source plugins may now request access access to previous during track and
      fetch by setting `BST_REQUIRES_PREVIOUS_SOURCES_TRACK` and/or
      `BST_REQUIRES_PREVIOUS_SOURCES_FETCH` attributes.

buildstream/_loader/types.py

@@ -17,6 +17,8 @@
  #  Authors:
  #        Tristan Van Berkom <tristan vanberkom codethink co uk>
 +from .._exceptions import LoadError, LoadErrorReason
++
  # Symbol():
+ #
@@ -56,8 +58,22 @@ class Symbol():
  #                             dependency was declared
+ #
  class Dependency():
 -    def __init__(self, name,
 +    def __init__(self, filename,
                   dep_type=None, junction=None, provenance=None):
 +        # Attempt to split name if no junction was specified explicitly
 +        if not junction:
 +            junction_path = filename.rsplit(":", 1)
 +            name = junction_path[-1]
 +            junction = None if len(junction_path) == 1 else junction_path[-2]
 +        else:
 +            name = filename
++
 +        # Name of the element should not contain any `:` characters at this stage
 +        if ':' in name:
 +            raise LoadError(LoadErrorReason.INVALID_DATA,
 +                            "Element {} contains `:` in its name. "
 +                            "Recursive lookups for cross-junction elements is not allowed.".format(filename))
++
          self.name = name
          self.dep_type = dep_type
          self.junction = junction

buildstream/_versions.py

@@ -23,7 +23,7 @@
  # This version is bumped whenever enhancements are made
  # to the `project.conf` format or the core element format.
+ #
 -BST_FORMAT_VERSION = 21
 +BST_FORMAT_VERSION = 22
  # The base BuildStream artifact version

doc/source/format_declaring.rst

@@ -401,6 +401,40 @@ Attributes:
       The ``junction`` attribute is available since :ref:`format version 1 <project_format_version>`
 +Cross-junction dependencies
 +~~~~~~~~~~~~~~~~~~~~~~~~~~~
 +As mentioned above, cross-junction dependencies can be specified using the
 +``junction`` attribute. They can also be expressed as simple strings as a
 +convenience shorthand. You can refer to cross-junction elements using the
 +syntax ``{junction-name}:{element-name}``.
++
 +For example, the following is logically same as the example above:
++
 +.. code:: yaml
++
 +   build-depends:
 +     - baseproject.bst:foo.bst
++
 +Similarly, you can also refer to cross-junction elements via the ``filename``
 +attribute, like so:
++
 +.. code:: yaml
++
 +   depends:
 +     - filename: baseproject.bst:foo.bst
 +       type: build
++
 +.. note::
++
 +   Recursive lookups are not allowed using this syntax. If a filename
 +   contains more than one ``:`` (colon) character, BuildStream will raise
 +   an error.
++
 +.. note::
++
 +   This shorthand is available since :ref:`format version 22 <project_format_version>`
++
++
  .. _format_dependencies_types:
  Dependency types

tests/frontend/buildcheckout.py

@@ -709,3 +709,114 @@ def test_build_checkout_cross_junction(datafiles, cli, tmpdir):
      filename = os.path.join(checkout, 'etc', 'animal.conf')
      assert os.path.exists(filename)
++
++
 +@pytest.mark.datafiles(DATA_DIR)
 +def test_build_junction_short_notation(cli, tmpdir, datafiles):
 +    project = os.path.join(datafiles.dirname, datafiles.basename)
 +    subproject_path = os.path.join(project, 'files', 'sub-project')
 +    junction_path = os.path.join(project, 'elements', 'junction.bst')
 +    element_path = os.path.join(project, 'elements', 'junction-dep.bst')
 +    workspace = os.path.join(cli.directory, 'workspace')
 +    checkout = os.path.join(cli.directory, 'checkout')
++
 +    # Create a repo to hold the subproject and generate a junction element for it
 +    ref = generate_junction(tmpdir, subproject_path, junction_path)
++
 +    # Create a stack element to depend on a cross junction element, using
 +    # colon (:) as the separator
 +    element = {
 +        'kind': 'stack',
 +        'depends': ['junction.bst:import-etc.bst']
 +    }
 +    _yaml.dump(element, element_path)
++
 +    # Now try to build it, this should automatically result in fetching
 +    # the junction itself at load time.
 +    result = cli.run(project=project, args=['build', 'junction-dep.bst'])
 +    result.assert_success()
++
 +    # Assert that it's cached now
 +    assert cli.get_element_state(project, 'junction-dep.bst') == 'cached'
++
 +    # Now check it out
 +    result = cli.run(project=project, args=[
 +        'artifact', 'checkout', 'junction-dep.bst', '--directory', checkout
 +    ])
 +    result.assert_success()
++
 +    # Assert the content of /etc/animal.conf
 +    filename = os.path.join(checkout, 'etc', 'animal.conf')
 +    assert os.path.exists(filename)
 +    with open(filename, 'r') as f:
 +        contents = f.read()
 +    assert contents == 'animal=Pony\n'
++
++
 +@pytest.mark.datafiles(DATA_DIR)
 +def test_build_junction_short_notation_filename(cli, tmpdir, datafiles):
 +    project = os.path.join(datafiles.dirname, datafiles.basename)
 +    subproject_path = os.path.join(project, 'files', 'sub-project')
 +    junction_path = os.path.join(project, 'elements', 'junction.bst')
 +    element_path = os.path.join(project, 'elements', 'junction-dep.bst')
 +    checkout = os.path.join(cli.directory, 'checkout')
++
 +    # Create a repo to hold the subproject and generate a junction element for it
 +    ref = generate_junction(tmpdir, subproject_path, junction_path)
++
 +    # Create a stack element to depend on a cross junction element, using
 +    # colon (:) as the separator
 +    element = {
 +        'kind': 'stack',
 +        'depends': [{'filename': 'junction.bst:import-etc.bst'}]
 +    }
 +    _yaml.dump(element, element_path)
++
 +    # Now try to build it, this should automatically result in fetching
 +    # the junction itself at load time.
 +    result = cli.run(project=project, args=['build', 'junction-dep.bst'])
 +    result.assert_success()
++
 +    # Assert that it's cached now
 +    assert cli.get_element_state(project, 'junction-dep.bst') == 'cached'
++
 +    # Now check it out
 +    result = cli.run(project=project, args=[
 +        'artifact', 'checkout', 'junction-dep.bst', '--directory', checkout
 +    ])
 +    result.assert_success()
++
 +    # Assert the content of /etc/animal.conf
 +    filename = os.path.join(checkout, 'etc', 'animal.conf')
 +    assert os.path.exists(filename)
 +    with open(filename, 'r') as f:
 +        contents = f.read()
 +    assert contents == 'animal=Pony\n'
++
++
 +@pytest.mark.datafiles(DATA_DIR)
 +def test_build_junction_short_notation_no_recurse(cli, tmpdir, datafiles):
 +    project = os.path.join(datafiles.dirname, datafiles.basename)
 +    subproject_path = os.path.join(project, 'files', 'sub-project')
 +    junction_path = os.path.join(project, 'elements', 'junction.bst')
 +    element_path = os.path.join(project, 'elements', 'junction-dep.bst')
 +    checkout = os.path.join(cli.directory, 'checkout')
++
 +    # Create a repo to hold the subproject and generate a junction element for it
 +    ref = generate_junction(tmpdir, subproject_path, junction_path)
++
 +    # Create a stack element to depend on a cross junction element, using
 +    # colon (:) as the separator
 +    element = {
 +        'kind': 'stack',
 +        'depends': [{
 +            'filename': 'junction.bst:import-etc.bst',
 +            'junction': 'junction.bst',
 +        }]
 +    }
 +    _yaml.dump(element, element_path)
++
 +    # Now try to build it, this should fail as recursive lookups for
 +    # cross-junction elements is not allowed.
 +    result = cli.run(project=project, args=['build', 'junction-dep.bst'])
 +    result.assert_main_error(ErrorDomain.LOAD, LoadErrorReason.INVALID_DATA)

[Notes] [Git][BuildStream/buildstream][chandan/junction-dependency-format] 3 commits: loader: Allow dependencies to use ":" to refer to junctioned elements

Chandan Singh pushed to branch chandan/junction-dependency-format at BuildStream / buildstream

Commits:

5 changed files:

Changes: