[Notes] [Git][BuildStream/buildstream][master] 3 commits:

Jürg Billeter pushed to branch master at BuildStream / buildstream

Commits:

6fcfa452

by Jonathan Maw at 2018-12-03T13:21:05Z

_yamlcache.py: Use a project's junction name if present

This is required because if there are projects with the same name
loaded, that have elements in the same path, with the same contents,
they are considered the same, despite actually belonging to different
Projects.

This fixes buildstream issue #795

d0f9c724

by James Ennis at 2018-12-03T13:21:05Z

tests/loader/junctions.py: Test that we can build a junction that is referred differently, twice.

Test required to close #795 - We should be able to build a project which refers
to the same junction twice, but with two different filenames.

f7581026

by Jürg Billeter at 2018-12-03T16:27:03Z

Merge branch 'jonathan/fix-identical-element' into 'master'

_yamlcache.py: Use a project's junction name if present

Closes #795

See merge request BuildStream/buildstream!980

18 changed files:

buildstream/_yamlcache.py
tests/loader/junctions.py
+ tests/loader/junctions/inconsistent-names/elements/junction-A.bst
+ tests/loader/junctions/inconsistent-names/elements/junction-B-diff-name.bst
+ tests/loader/junctions/inconsistent-names/elements/target.bst
+ tests/loader/junctions/inconsistent-names/files/foo
+ tests/loader/junctions/inconsistent-names/junctionA/elements/app.bst
+ tests/loader/junctions/inconsistent-names/junctionA/elements/junction-B.bst
+ tests/loader/junctions/inconsistent-names/junctionA/elements/lib.bst
+ tests/loader/junctions/inconsistent-names/junctionA/files/app
+ tests/loader/junctions/inconsistent-names/junctionA/files/lib
+ tests/loader/junctions/inconsistent-names/junctionA/junctionB/base/baseimg
+ tests/loader/junctions/inconsistent-names/junctionA/junctionB/elements/base.bst
+ tests/loader/junctions/inconsistent-names/junctionA/junctionB/elements/lib2.bst
+ tests/loader/junctions/inconsistent-names/junctionA/junctionB/files/lib2
+ tests/loader/junctions/inconsistent-names/junctionA/junctionB/project.conf
+ tests/loader/junctions/inconsistent-names/junctionA/project.conf
+ tests/loader/junctions/inconsistent-names/project.conf

Changes:

buildstream/_yamlcache.py

@@ -68,7 +68,7 @@ class YamlCache():
      #    (bool): Whether the file is cached.
      def is_cached(self, project, filepath):
          cache_path = self._get_filepath(project, filepath)
 -        project_name = project.name if project else ""
 +        project_name = self.get_project_name(project)
          try:
              project_cache = self._project_caches[project_name]
              if cache_path in project_cache.elements:
@@ -167,7 +167,7 @@ class YamlCache():
      #    value (decorated dict): The data to put into the cache.
      def put_from_key(self, project, filepath, key, value):
          cache_path = self._get_filepath(project, filepath)
 -        project_name = project.name if project else ""
 +        project_name = self.get_project_name(project)
          try:
              project_cache = self._project_caches[project_name]
          except KeyError:
@@ -237,7 +237,7 @@ class YamlCache():
      #    (decorated dict): The parsed yaml from the cache, or None if the file isn't in the cache.
      def _get(self, project, filepath, key):
          cache_path = self._get_filepath(project, filepath)
 -        project_name = project.name if project else ""
 +        project_name = self.get_project_name(project)
          try:
              project_cache = self._project_caches[project_name]
              try:
@@ -253,6 +253,30 @@ class YamlCache():
              pass
          return None
 +    # get_project_name():
 +    #
 +    # Gets a name appropriate for Project. Projects must use their junction's
 +    # name if present, otherwise elements with the same contents under the
 +    # same path with identically-named projects are considered the same yaml
 +    # object, despite existing in different Projects.
 +    #
 +    # Args:
 +    #    project (Project): The project this file is in, or None.
 +    #
 +    # Returns:
 +    #    (str): The project's junction's name if present, the project's name,
 +    #           or an empty string if there is no project
 +    @staticmethod
 +    def get_project_name(project):
 +        if project:
 +            if project.junction:
 +                project_name = project.junction.name
 +            else:
 +                project_name = project.name
 +        else:
 +            project_name = ""
 +        return project_name
++
  CachedProject = namedtuple('CachedProject', ['elements'])
@@ -287,7 +311,7 @@ class BstPickler(pickle.Pickler):
          if isinstance(obj, _yaml.ProvenanceFile):
              if obj.project:
                  # ProvenanceFile's project object cannot be stored as it is.
 -                project_tag = obj.project.name
 +                project_tag = YamlCache.get_project_name(obj.project)
                  # ProvenanceFile's filename must be stored relative to the
                  # project, as the project dir may move.
                  name = os.path.relpath(obj.name, obj.project.directory)
@@ -319,14 +343,14 @@ class BstUnpickler(pickle.Unpickler):
              if project_tag is not None:
                  for p in self._context.get_projects():
 -                    if project_tag == p.name:
 +                    if YamlCache.get_project_name(p) == project_tag:
                          project = p
                          break
                  name = os.path.join(project.directory, tagged_name)
                  if not project:
 -                    projects = [p.name for p in self._context.get_projects()]
 +                    projects = [YamlCache.get_project_name(p) for p in self._context.get_projects()]
                      raise pickle.UnpicklingError("No project with name {} found in {}"
                                                   .format(project_tag, projects))
              else:

tests/loader/junctions.py

@@ -47,6 +47,16 @@ def test_simple_build(cli, tmpdir, datafiles):
      assert(os.path.exists(os.path.join(checkoutdir, 'foo.txt')))
 +@pytest.mark.datafiles(DATA_DIR)
 +def test_build_of_same_junction_used_twice(cli, tmpdir, datafiles):
 +    project = os.path.join(str(datafiles), 'inconsistent-names')
++
 +    # Check we can build a project that contains the same junction
 +    # that is used twice, but named differently
 +    result = cli.run(project=project, args=['build', 'target.bst'])
 +    assert result.exit_code == 0
++
++
  @pytest.mark.datafiles(DATA_DIR)
  def test_nested_simple(cli, tmpdir, datafiles):
      foo = os.path.join(str(datafiles), 'foo')

tests/loader/junctions/inconsistent-names/elements/junction-A.bst

 +kind: junction
 +sources:
 +- kind: local
 +  path: junctionA

tests/loader/junctions/inconsistent-names/elements/junction-B-diff-name.bst

 +kind: junction
 +sources:
 +- kind: local
 +  path: junctionA/junctionB

tests/loader/junctions/inconsistent-names/elements/target.bst

 +kind: import
 +sources:
 +- kind: local
 +  path: files/foo
 +depends:
 +- filename: lib2.bst
 +  junction: junction-B-diff-name.bst
 +- filename: lib.bst
 +  junction: junction-A.bst