[DEVOPS-1131] Add README, tweak scripts, add gitignore entry

Author: Michael Hueschen

.gitignore

@@ -73,6 +73,9 @@ scripts/haskell/dependencies.hi
 scripts/haskell/dependencies.o
 scripts/haskell/dependencies
 
+# script-runner state
+script-runner/states/
+
 # Cache for pkgs/generate.sh
 /pkgs/.cabal/
 /pkgs/.stack/

script-runner/README.md

@@ -0,0 +1,7 @@
+# script-runner
+
+This module contains scripts to perform tests at the cluster level - running clusters of nodes, issuing update proposals to them, restarting them, etc. Some of the code here was extracted from the `auxx` package and reworked.
+
+### Usage
+
+See the `stack-gui` and `stack-test` scripts which contain usage commands.

script-runner/stack-gui

@@ -2,12 +2,19 @@
 
 # usage: ./stack-gui testnet
 
+# UI usage:
+#
+# Up/down arrows: navigate menus
+# Left arrow: return to higher menu level
+# Enter: activate menu items
+# 'q': return to higher menu level or (at toplevel) quit the Brick UI
+
 set -e
 set -x
 
 pushd ..
 stack build cardano-sl-script-runner cardano-sl-node cardano-sl-tools
-export PATH=$(realpath .stack-work/install/x86_64-linux-nix/lts-12.17/8.4.4/bin/):$PATH
+export PATH=$(realpath $(stack path --local-install-root)/bin):$PATH
 popd
 
 NAME=$1

script-runner/stack-test

@@ -2,12 +2,15 @@
 
 # usage: ./stack-test test4.2
 
+# on Mac (and OS's with different `mktemp` versions)
+# usage: ALT_MKTEMP=1 ./stack-test test4.2
+
 set -e
 set -x
 
 pushd ..
 stack build cardano-sl-script-runner cardano-sl-node cardano-sl-tools
-export PATH=$(realpath .stack-work/install/x86_64-linux-nix/lts-12.17/8.4.4/bin/):$PATH
+export PATH=$(realpath $(stack path --local-install-root)/bin):$PATH
 popd
 
 export SCRIPT=$1
@@ -17,7 +20,12 @@ LOGCFG=$(realpath ./log-config.yaml)
 TOPO=$(realpath ./topology-local.yaml)
 POLFILE=$(realpath ../scripts/policies/policy_script-runner.yaml)
 
-T=$(mktemp -d -p . testrun-XXXXXX)
+if [ -z "$ALT_MKTEMP" ]; then
+  T=$(mktemp -d -t . testrun-XXXXXX)
+else
+  T=$(mktemp -d -p . testrun-XXXXXX)
+fi
+
 cd $T
 mkdir poc-state