Merge pull request #3227 from input-output-hk/mhuesch/CDEC-429

[CDEC-429] Flesh out `package-dep-graph.sh`, document it in `stack.yaml`

Author: erikd

scripts/package-dep-graph.sh

@@ -0,0 +1,87 @@
+#!/bin/bash -eu
+
+################################################################################
+# Check deps
+################################################################################
+
+if ! command -v dot >/dev/null 2>&1; then
+    echo "\`dot\` not found. It is usually in the \`graphviz\` package."
+    exit 1
+fi
+
+if ! command -v tred >/dev/null 2>&1; then
+    echo "\`tred\` not found. It is usually in the \`graphviz\` package."
+    exit 1
+fi
+
+################################################################################
+# Argument processing
+################################################################################
+
+script=$(basename "$0")
+stack_dot_flags=""
+include_test_bench="0"
+use_tred="1"
+
+while getopts "hetf" opt; do
+  case $opt in
+    h)
+      echo "usage: ./${script} OPTS" >&2
+      echo "OPTS:" >&2
+      echo "    -h : show help" >&2
+      echo "    -e : include external dependencies in graph" >&2
+      echo "    -t : include test+bench packages in graph" >&2
+      echo "    -f : don't use \`tred\` - render full deg graph" >&2
+      exit 0
+      ;;
+    e)
+      stack_dot_flags="${stack_dot_flags} --external"
+      ;;
+    t)
+      include_test_bench="1"
+      ;;
+    f)
+      use_tred="0"
+      ;;
+    ?)
+      echo "Invalid option: -$OPTARG" >&2
+      exit 1
+      ;;
+  esac
+done
+
+
+################################################################################
+# Generate graph
+################################################################################
+
+tmpdir=$(mktemp -d "${TMPDIR:-/tmp/}$(basename "$0").XXXXXXXXXXXX")
+outfile="cardano-sl-pkg-deps.png"
+
+# 'tred' and 'dot' are in the 'graphviz' of most Linux distributions.
+
+if [ "${include_test_bench}" = "0" ]; then
+    prunefiles=$(find . -name \*.cabal -exec basename {} \; \
+        | grep -v stack-work | grep "test.cabal\\|bench.cabal" \
+        | sed 's/\.cabal//' | tr '\n' ',')
+    stack_dot_flags="${stack_dot_flags} --prune ${prunefiles}"
+fi
+
+# This is a weird hack to satisfy shellcheck. While strange, it works, and is
+# technically safer.
+output="yes"
+stack dot ${output:+${stack_dot_flags}} > "${tmpdir}/full-dependencies.dot"
+
+final_dotfile=""
+if [ "${use_tred}" = "1" ]; then
+    final_dotfile="${tmpdir}/direct-dependencies.dot"
+    tred "${tmpdir}/full-dependencies.dot" > "${final_dotfile}"
+else
+    final_dotfile="${tmpdir}/full-dependencies.dot"
+fi
+
+dot -Tpng "${final_dotfile}" -o ${outfile}
+
+rm -rf "${tmpdir:?}/"
+
+echo "Generated ${outfile}"

stack.yaml

@@ -6,11 +6,10 @@ flags:
 
 extra-package-dbs: []
 
-# util -> networking → binary →  crypto → core → db → [lrc, infra]
-#              → [ssc, txp, update, delegation] → block → lib → ...
-# Then we have two branches:
-# ... → client → generator → [auxx, explorer, wallet] → wallet-new
-# ... → [node, tools]
+# The dependency graph which was previously here has been dropped in favor of
+# PNG output from the script `scripts/package-dep-graph.sh`, which uses
+# `stack dot` to construct a graph which represents the current state exactly.
+
 packages:
 - util
 - util/test