Simplify UX of aliBuild deps (#1010)

Author: ktf

alibuild_helpers/args.py

@@ -212,14 +212,8 @@ def doParseArgs():
                                  "with commas."))
   deps_parser.add_argument("-e", dest="environment", action="append", default=[],
                            help="KEY=VALUE binding to add to the environment. May be specified multiple times.")
-
-  deps_graph = deps_parser.add_argument_group(title="Customise graph output")
-  deps_graph.add_argument("--neat", dest="neat", action="store_true",
-                          help="Produce a graph with transitive reduction.")
-  deps_graph.add_argument("--outdot", dest="outdot", metavar="FILE",
-                          help="Keep intermediate Graphviz dot file in %(metavar)s.")
-  deps_graph.add_argument("--outgraph", dest="outgraph", metavar="FILE",
-                          help="Store final output PDF file in %(metavar)s.")
+  deps_parser.add_argument("--output,-o", dest="output", metavar="FILE",
+                           help="Save output to %(metavar)s.")
 
   deps_docker = deps_parser.add_argument_group(title="Use a Docker container", description="""\
   If you're planning to build inside a Docker container, e.g. using aliBuild

alibuild_helpers/deps.py

@@ -1,17 +1,12 @@
 #!/usr/bin/env python3
 
-from alibuild_helpers.log import debug, error, info, dieOnError
+from alibuild_helpers.log import debug, dieOnError
 from alibuild_helpers.utilities import parseDefaults, readDefaults, getPackageList, validateDefaults
 from alibuild_helpers.cmd import DockerRunner, execute
-from tempfile import NamedTemporaryFile
-from os import remove, path
+from os import path
+import sys
 
 def doDeps(args, parser):
-
-  # Check if we have an output file
-  if not args.outgraph:
-    parser.error("Specify a PDF output file with --outgraph")
-
   # Resolve all the package parsing boilerplate
   specs = {}
   defaultsReader = lambda: readDefaults(args.configDir, args.defaults, parser.error, args.architecture)
@@ -93,28 +88,8 @@ def performCheck(pkg, cmd):
 
   dot += "}\n"
 
-  if args.outdot:
-    fp = open(args.outdot, "w")
+  if getattr(args, "output", None) and args.output != "-":
+    fp = open(args.output, "w")
   else:
-    fp = NamedTemporaryFile(delete=False, mode="wt")
+    fp = sys.stdout
   fp.write(dot)
-  fp.close()
-
-  # Check if we have dot in PATH
-  try:
-    execute(["dot", "-V"])
-  except Exception:
-    dieOnError(True, "Could not find dot in PATH. Please install graphviz and add it to PATH.")
-  try:
-    if args.neat:
-      execute("tred {dotFile} > {dotFile}.0 && mv {dotFile}.0 {dotFile}".format(dotFile=fp.name))
-    execute(["dot", fp.name, "-Tpdf", "-o", args.outgraph])
-  except Exception as e:
-    error("Error generating dependencies with dot: %s: %s", type(e).__name__, e)
-  else:
-    info("Dependencies graph generated: %s" % args.outgraph)
-  if fp.name != args.outdot:
-    remove(fp.name)
-  else:
-    info("Intermediate dot file for Graphviz saved: %s" % args.outdot)
-  return True

docs/docs/user.md

@@ -371,7 +371,7 @@ It is possible to generating a PDF with a dependency graph using the `aliBuild d
 tool. Assuming you run it from a directory containing `alidist`, and you have
 Graphviz installed on your system, you can simply run:
 
-    aliBuild deps O2 --outgraph graph.pdf
+    aliBuild deps O2 | dot -Tpdf -o graph.pdf
 
 The example above generates a dependency graph for the package `O2`, and saving
 the results to a PDF file named `graph.pdf`. This is what the graph looks like:
@@ -389,19 +389,12 @@ By default, `aliBuild deps` runs the usual system checks to exclude packages tha
 be taken from the system. If you want to display the full list of dependencies,
 you may want to use:
 
-    aliBuild deps O2 --no-system --outgraph graph.pdf
+    aliBuild deps O2 --no-system | dot -Tpdf -o graph.pdf
 
-Additional useful options for `aliBuild deps` include:
+As usual you can customise the input of dot using `tred` to produce a graph with 
+a transitive reduction:
 
-- `--neat`: Produce a graph with transitive reduction, removing edges that are
-  implied by other paths in the graph. This can make complex dependency graphs
-  easier to read.
-- `--outdot FILE`: Keep the intermediate Graphviz dot file in `FILE`. Useful if
-  you want to manually modify the graph or generate output in different formats.
-
-For example, to generate a simplified graph and keep the dot file:
-
-    aliBuild deps O2 --neat --outdot graph.dot --outgraph graph.pdf
+    aliBuild deps O2 --no-system | tred | dot -Tpdf -o graph.pdf
 
 Please run `aliBuild deps --help` for further information.
 

tests/test_args.py

@@ -72,7 +72,7 @@ class FakeExit(Exception):
   (("sw3", "mydir"), "init"                                                            , [("action", "init"), ("workDir", "sw3"), ("referenceSources", "sw3/MIRROR"), ("chdir", "mydir")]),
   (("sw", ".")     , "clean --chdir mydir2 --work-dir sw4"                             , [("action", "clean"), ("workDir", "sw4"), ("chdir", "mydir2")]),
   (()              , "doctor zlib -C mydir -w sw2"                                     , [("action", "doctor"), ("workDir", "sw2"), ("chdir", "mydir")]),
-  (()              , "deps zlib --outgraph graph.pdf"                                  , [("action", "deps"), ("outgraph", "graph.pdf")]),
+  (()              , "deps zlib --output graph.pdf"                                  , [("action", "deps"), ("output", "graph.pdf")]),
   (()              , "completion bash"                                                  , [("action", "completion"), ("shell", "bash")]),
   (()              , "completion zsh"                                                   , [("action", "completion"), ("shell", "zsh")]),
 ]