From 6e426c3a54e1bc94a2c96a5f6c6e0b629ed066b9 Mon Sep 17 00:00:00 2001
From: Chandan Singh <csingh43@bloomberg.net>
Date: Wed, 26 Sep 2018 00:30:17 +0100
Subject: Ensure `--deps=none` option works for `bst checkout`

This is a backport of !819.

---

Currently, `bst checkout --deps none` command always produces empty
output. Fix this issue and add regression test for the same.

Fixes #670.
---
 buildstream/element.py                             | 26 +++++++++++++---------
 tests/frontend/buildcheckout.py                    | 20 +++++++----------
 tests/frontend/project/elements/checkout-deps.bst  | 10 +++++++++
 .../project/files/etc-files/etc/buildstream/config |  1 +
 4 files changed, 34 insertions(+), 23 deletions(-)
 create mode 100644 tests/frontend/project/elements/checkout-deps.bst
 create mode 100644 tests/frontend/project/files/etc-files/etc/buildstream/config

diff --git a/buildstream/element.py b/buildstream/element.py
index 260762cf1..54b764eb9 100644
--- a/buildstream/element.py
+++ b/buildstream/element.py
@@ -434,7 +434,7 @@ class Element(Plugin):
                                                 visited=visited, recursed=True)
 
         # Yeild self only at the end, after anything needed has been traversed
-        if should_yield and (recurse or recursed) and (scope == Scope.ALL or scope == Scope.RUN):
+        if should_yield and (recurse or recursed) and scope != Scope.BUILD:
             yield self
 
     def search(self, scope, name):
@@ -1289,17 +1289,21 @@ class Element(Plugin):
                 if scope == Scope.BUILD:
                     self.stage(sandbox)
                 elif scope == Scope.RUN:
-                    # Stage deps in the sandbox root
                     if deps == 'run':
-                        with self.timed_activity("Staging dependencies", silent_nested=True):
-                            self.stage_dependency_artifacts(sandbox, scope)
-
-                        # Run any integration commands provided by the dependencies
-                        # once they are all staged and ready
-                        if integrate:
-                            with self.timed_activity("Integrating sandbox"):
-                                for dep in self.dependencies(scope):
-                                    dep.integrate(sandbox)
+                        dependency_scope = Scope.RUN
+                    else:
+                        dependency_scope = None
+
+                    # Stage deps in the sandbox root
+                    with self.timed_activity("Staging dependencies", silent_nested=True):
+                        self.stage_dependency_artifacts(sandbox, dependency_scope)
+
+                    # Run any integration commands provided by the dependencies
+                    # once they are all staged and ready
+                    if integrate:
+                        with self.timed_activity("Integrating sandbox"):
+                            for dep in self.dependencies(dependency_scope):
+                                dep.integrate(sandbox)
 
             yield sandbox
 
diff --git a/tests/frontend/buildcheckout.py b/tests/frontend/buildcheckout.py
index d0f52d6a7..10849b918 100644
--- a/tests/frontend/buildcheckout.py
+++ b/tests/frontend/buildcheckout.py
@@ -65,9 +65,10 @@ def test_build_checkout(datafiles, cli, strict, hardlinks):
 def test_build_checkout_deps(datafiles, cli, deps):
     project = os.path.join(datafiles.dirname, datafiles.basename)
     checkout = os.path.join(cli.directory, 'checkout')
+    element_name = "checkout-deps.bst"
 
     # First build it
-    result = cli.run(project=project, args=['build', 'target.bst'])
+    result = cli.run(project=project, args=['build', element_name])
     result.assert_success()
 
     # Assert that after a successful build, the builddir is empty
@@ -76,20 +77,15 @@ def test_build_checkout_deps(datafiles, cli, deps):
     assert not os.listdir(builddir)
 
     # Now check it out
-    result = cli.run(project=project, args=['checkout', 'target.bst', '--deps', deps, checkout])
+    result = cli.run(project=project, args=['checkout', element_name, '--deps', deps, checkout])
     result.assert_success()
 
-    # Check that the executable hello file is found in the checkout
-    filename = os.path.join(checkout, 'usr', 'bin', 'hello')
-
-    if deps == "run":
-        assert os.path.exists(filename)
-    else:
-        assert not os.path.exists(filename)
-
-    # Check that the executable hello file is found in the checkout
-    filename = os.path.join(checkout, 'usr', 'include', 'pony.h')
+    # Verify output of this element
+    filename = os.path.join(checkout, 'etc', 'buildstream', 'config')
+    assert os.path.exists(filename)
 
+    # Verify output of this element's runtime dependencies
+    filename = os.path.join(checkout, 'usr', 'bin', 'hello')
     if deps == "run":
         assert os.path.exists(filename)
     else:
diff --git a/tests/frontend/project/elements/checkout-deps.bst b/tests/frontend/project/elements/checkout-deps.bst
new file mode 100644
index 000000000..a2c1d93cc
--- /dev/null
+++ b/tests/frontend/project/elements/checkout-deps.bst
@@ -0,0 +1,10 @@
+kind: import
+description: It is important for this element to have both build and runtime dependencies
+sources:
+- kind: local
+  path: files/etc-files
+depends:
+- filename: import-dev.bst
+  type: build
+- filename: import-bin.bst
+  type: runtime
diff --git a/tests/frontend/project/files/etc-files/etc/buildstream/config b/tests/frontend/project/files/etc-files/etc/buildstream/config
new file mode 100644
index 000000000..04204c7c9
--- /dev/null
+++ b/tests/frontend/project/files/etc-files/etc/buildstream/config
@@ -0,0 +1 @@
+config
-- 
cgit v1.2.1