_frontend/widget: Add artifact-cas-digest show format

This adds the artifact-cas-digest format string to the show command,
allowing to show the CAS digest of the built artifact.

Author: Adrien Plazas

man/bst-show.1

@@ -45,6 +45,7 @@ Show elements in the pipeline
         %{deps}           A list of all dependencies
         %{build-deps}     A list of build dependencies
         %{runtime-deps}   A list of runtime dependencies
+        %{artifact-cas-digest} The CAS digest of the built artifact
 .PP
     The value of the %{symbol} without the leading '%' character is understood
     as a pythonic formatting string, so python formatting features apply,

src/buildstream/_frontend/cli.py

@@ -613,6 +613,7 @@ def show(app, elements, deps, except_, order, format_):
         %{deps}           A list of all dependencies
         %{build-deps}     A list of build dependencies
         %{runtime-deps}   A list of runtime dependencies
+        %{artifact-cas-digest} The CAS digest of the built artifact
 
     The value of the %{symbol} without the leading '%' character is understood
     as a pythonic formatting string, so python formatting features apply,
@@ -638,7 +639,8 @@ def show(app, elements, deps, except_, order, format_):
         state_match = re.search(r"%(\{(state)[^%]*?\})", format_)
         key_match = re.search(r"%(\{(key)[^%]*?\})", format_)
         full_key_match = re.search(r"%(\{(full-key)[^%]*?\})", format_)
-        need_state = bool(state_match or key_match or full_key_match)
+        artifact_cas_digest_match = re.search(r"%(\{(artifact-cas-digest)[^%]*?\})", format_)
+        need_state = bool(state_match or key_match or full_key_match or artifact_cas_digest_match)
 
         if not elements:
             elements = app.project.get_default_targets()

src/buildstream/_frontend/widget.py

@@ -437,6 +437,21 @@ def show_pipeline(self, dependencies, format_):
                 runtime_deps = [e._get_full_name() for e in element._dependencies(_Scope.RUN, recurse=False)]
                 line = p.fmt_subst(line, "runtime-deps", _yaml.roundtrip_dump_string(runtime_deps).rstrip("\n"))
 
+            # Artifact CAS Digest
+            if "%{artifact-cas-digest" in format_:
+                artifact = element._get_artifact()
+                if not artifact.query_cache():
+                    artifact = None
+                if artifact is not None:
+                    artifact_files = artifact.get_files()
+                    # We call the private CasBasedDirectory._get_digest() for
+                    # the moment, we should make it public on Directory.
+                    artifact_digest = artifact_files._get_digest()
+                    formated_artifact_digest = "{}/{}".format(artifact_digest.hash, artifact_digest.size_bytes)
+                    line = p.fmt_subst(line, "artifact-cas-digest", formated_artifact_digest)
+                else:
+                    line = p.fmt_subst(line, "artifact-cas-digest", "(no artifact CAS digest)", fg="yellow")
+
             report += line + "\n"
 
         return report.rstrip("\n")

tests/frontend/show.py

@@ -438,8 +438,9 @@ def setup_test():
         ("%{deps}", "- import-dev.bst\n- import-links.bst\n- import-bin.bst"),
         ("%{build-deps}", "- import-dev.bst\n- import-links.bst"),
         ("%{runtime-deps}", "- import-links.bst\n- import-bin.bst"),
+        ("%{artifact-cas-digest}", "(no artifact CAS digest)"),
     ],
-    ids=["deps", "build-deps", "runtime-deps"],
+    ids=["deps", "build-deps", "runtime-deps", "artifact-cas-digest"],
 )
 def test_format_deps(cli, datafiles, dep_kind, expected_deps):
     project = str(datafiles)
@@ -553,6 +554,64 @@ def test_strict_dependencies(cli, datafiles, target, expected_state):
     assert states[target] == expected_state
 
 
+# This tests that cache keys behave as expected when
+# dependencies have been specified as `strict` and
+# when building in strict mode.
+#
+# This test will:
+#
+#  * Build the target once (and assert that it is cached)
+#  * Modify some local files which are imported
+#    by an import element which the target depends on
+#  * Assert that the cached state of the target element
+#    is as expected
+#
+# We run the test twice, once with an element which strict
+# depends on the changing import element, and one which
+# depends on it regularly.
+#
+@pytest.mark.datafiles(os.path.join(DATA_DIR, "project"))
+@pytest.mark.parametrize(
+    "target, expected_digests",
+    [
+        ("target.bst", {
+            "compose-all.bst": "c742f599e198f348ba7600bf50194ae45af6cba759e0005dcd980ad596c51959/78",
+            "import-bin.bst": "594334e3e9f15c9eac5b8325befc3f53af8ffbaa664424bb308484abb892944f/77",
+            "import-dev.bst": "42203f9284db4817a2fc2d57714c6c92ec318f82a23a25e5325852e5dd6effc3/77",
+            "target.bst": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855/0",
+        }),
+    ],
+)
+def test_format_artifact_cas_digest(cli, datafiles, target, expected_digests):
+    project = str(datafiles)
+    expected_no_digest = "(no artifact CAS digest)"
+
+    result = cli.run(project=project, silent=True, args=["show", "--format", "%{name},%{artifact-cas-digest}", target])
+    result.assert_success()
+
+    digests = dict(line.split(",", 2) for line in result.output.splitlines())
+
+    assert len(digests) == len(expected_digests)
+    for component, received in sorted(digests.items()):
+        expected = expected_no_digest
+        if received != expected:
+            raise AssertionError("Expected output:\n{}\nInstead received output:\n{}".format(expected, received))
+
+    result = cli.run(project=project, silent=True, args=["build", target])
+    result.assert_success()
+
+    result = cli.run(project=project, silent=True, args=["show", "--format", "%{name},%{artifact-cas-digest}", target])
+    result.assert_success()
+
+    digests = dict(line.split(",", 2) for line in result.output.splitlines())
+
+    assert len(digests) == len(expected_digests)
+    for component, received in sorted(digests.items()):
+        expected = expected_digests[component]
+        if received != expected:
+            raise AssertionError("Expected output:\n{}\nInstead received output:\n{}".format(expected, received))
+
+
 @pytest.mark.datafiles(os.path.join(DATA_DIR, "project"))
 @pytest.mark.parametrize("fatal", [True, False], ids=["fatal", "non-fatal"])
 def test_unaliased_url(cli, tmpdir, datafiles, fatal):