feat(cli): verbose output for renku show (#1524)

Author: mohammad-alisafaee

renku/cli/show.py

@@ -86,14 +86,31 @@
    $ echo $?  # last command finished with an error code
    1
 
+You can use the ``-v`` or ``--verbose`` flag to print detailed information
+in a tabular format.
+
+.. code-block:: console
+
+   $ renku show inputs -v
+   PATH        COMMIT   USAGE TIME           WORKFLOW
+   ----------  -------  -------------------  -------------------...-----------
+   source.txt  6d10e05  2020-09-14 23:47:17  .renku/workflow/388...d8_head.yaml
+
+
 """
+from collections import namedtuple
 
 import click
 
 from renku.core import errors
 from renku.core.commands.client import pass_local_client
 from renku.core.commands.graph import Graph
 from renku.core.models.entities import Entity
+from renku.core.models.provenance.activities import ProcessRun
+from renku.core.models.tabulate import tabulate
+
+Result = namedtuple("Result", ["path", "commit", "time", "workflow"])
+HEADERS = {"path": None, "commit": None, "time": "time", "workflow": None}
 
 
 @click.group()
@@ -121,7 +138,7 @@ def siblings(client, revision, flat, verbose, paths):
     for node in nodes:
         try:
             sibling_sets.add(frozenset(graph.siblings(node)))
-        except (errors.InvalidOutputPath):
+        except errors.InvalidOutputPath:
             # ignore nodes that aren't outputs if no path was supplied
             if paths:
                 raise
@@ -151,29 +168,28 @@ def siblings(client, revision, flat, verbose, paths):
 
 @show.command()
 @click.option("--revision", default="HEAD")
-@click.argument(
-    "paths", type=click.Path(exists=True, dir_okay=False), nargs=-1,
-)
+@click.option("-v", "--verbose", is_flag=True)
+@click.argument("paths", type=click.Path(exists=True, dir_okay=False), nargs=-1)
 @pass_local_client(requires_migration=True)
 @click.pass_context
-def inputs(ctx, client, revision, paths):
+def inputs(ctx, client, revision, verbose, paths):
     r"""Show inputs files in the repository.
 
     <PATHS>    Files to show. If no files are given all input files are shown.
     """
-    from renku.core.models.provenance.activities import ProcessRun
-
     graph = Graph(client)
     paths = set(paths)
     nodes = graph.build(revision=revision)
     commits = {node.activity.commit if hasattr(node, "activity") else node.commit for node in nodes}
     commits |= {node.activity.commit for node in nodes if hasattr(node, "activity")}
     candidates = {(node.commit, node.path) for node in nodes if not paths or node.path in paths}
 
-    input_paths = set()
+    input_paths = {}
 
     for commit in commits:
-        activity = graph.activities[commit]
+        activity = graph.activities.get(commit)
+        if not activity:
+            continue
 
         if isinstance(activity, ProcessRun):
             for usage in activity.qualified_usage:
@@ -182,37 +198,59 @@ def inputs(ctx, client, revision, paths):
                     usage_key = (entity.commit, entity.path)
 
                     if path not in input_paths and usage_key in candidates:
-                        input_paths.add(path)
+                        input_paths[path] = Result(
+                            path=path, commit=entity.commit, time=activity.started_at_time, workflow=activity.path
+                        )
 
-    click.echo("\n".join(graph._format_path(path) for path in input_paths))
+    if not verbose:
+        click.echo("\n".join(graph._format_path(path) for path in input_paths))
+    else:
+        records = list(input_paths.values())
+        records.sort(key=lambda v: v[0])
+        HEADERS["time"] = "usage time"
+        click.echo(tabulate(collection=records, headers=HEADERS))
     ctx.exit(0 if not paths or len(input_paths) == len(paths) else 1)
 
 
 @show.command()
 @click.option("--revision", default="HEAD")
-@click.argument(
-    "paths", type=click.Path(exists=True, dir_okay=True), nargs=-1,
-)
+@click.option("-v", "--verbose", is_flag=True)
+@click.argument("paths", type=click.Path(exists=True, dir_okay=True), nargs=-1)
 @pass_local_client(requires_migration=True)
 @click.pass_context
-def outputs(ctx, client, revision, paths):
+def outputs(ctx, client, revision, verbose, paths):
     r"""Show output files in the repository.
 
     <PATHS>    Files to show. If no files are given all output files are shown.
     """
     graph = Graph(client)
-    filter = graph.build(paths=paths, revision=revision)
-    output_paths = graph.output_paths
+    filter_ = graph.build(paths=paths, revision=revision)
+    output_paths = {}
 
-    click.echo("\n".join(graph._format_path(path) for path in output_paths))
+    for activity in graph.activities.values():
+        if isinstance(activity, ProcessRun):
+            for entity in activity.generated:
+                if entity.path not in graph.output_paths:
+                    continue
+                output_paths[entity.path] = Result(
+                    path=entity.path, commit=entity.commit, time=activity.ended_at_time, workflow=activity.path
+                )
+
+    if not verbose:
+        click.echo("\n".join(graph._format_path(path) for path in output_paths.keys()))
+    else:
+        records = list(output_paths.values())
+        records.sort(key=lambda v: v[0])
+        HEADERS["time"] = "generation time"
+        click.echo(tabulate(collection=records, headers=HEADERS))
 
     if paths:
         if not output_paths:
             ctx.exit(1)
 
         from renku.core.models.datastructures import DirectoryTree
 
-        tree = DirectoryTree.from_list(item.path for item in filter)
+        tree = DirectoryTree.from_list(item.path for item in filter_)
 
         for output in output_paths:
             if tree.get(output) is None:

tests/cli/test_show.py

@@ -44,3 +44,28 @@ def test_show_outputs_with_directory(runner, client, run):
     result = runner.invoke(cli, cmd + ["output/foo", "output/bar"])
     assert 0 == result.exit_code
     assert {"output"} == set(result.output.strip().split("\n"))
+
+
+def test_show_verbose(runner, client, run):
+    """Show with verbose option."""
+    base_sh = ["bash", "-c", 'DIR="$0"; mkdir -p "$DIR"; ' 'for x in "$@"; do touch "$DIR/$x"; done']
+    assert 0 == run(args=["run"] + base_sh + ["intermediate", "foo", "bar"])
+    input_commit = client.repo.head.commit.parents[0].hexsha
+    assert 0 == run(args=["run", "ls", "intermediate"], stdout="baz")
+    output_commit = client.repo.head.commit.parents[0].hexsha
+
+    workflow_partial_name = "_ls.yaml"
+
+    result = runner.invoke(cli, ["show", "inputs", "-v"])
+    assert 0 == result.exit_code
+    assert input_commit in result.output
+    assert workflow_partial_name in result.output
+    for header in ("PATH", "COMMIT", "USAGE TIME", "WORKFLOW"):
+        assert header in result.output.split("\n")[0]
+
+    result = runner.invoke(cli, ["show", "outputs", "-v", "baz"])
+    assert 0 == result.exit_code
+    assert output_commit in result.output
+    assert workflow_partial_name in result.output
+    for header in ("PATH", "COMMIT", "GENERATION TIME", "WORKFLOW"):
+        assert header in result.output.split("\n")[0]