feat(examples): Add multiple configs support

Author: matevz

Makefile

@@ -17,7 +17,7 @@ build:
 
 examples: build $(EXAMPLES)
 
-examples/%.out: examples/%.in
+examples/%.out: examples/%.in $(shell find -name "*.go" -type f) go.sum go.mod
 	@rm -f $@
 	@scripts/gen_example.sh $< $@
 

examples/README.md

@@ -0,0 +1,35 @@
+# Oasis CLI Examples
+
+This folder contains a number of Oasis CLI invocations and expected outputs.
+The snippets are included in the documentation and serve as a check for
+potential regressions in the CI.
+
+## Input files
+
+The invocation parameters of each Oasis CLI example consists of one or more
+`<EXAMPLE_NAME>[.NUMBER].in` files. Each file begins with `oasis` command,
+which will be replaced with the actual path of the Oasis CLI command during
+execution. If multiple files exist for the same example name, they will be
+executed sequentially based on NUMBER and they will all share the config
+file. This way, you can prepare and execute a scenario of Oasis CLI
+invocations.
+
+## Output files
+
+The Oasis CLI output for the given input is stored in the corresponding
+`<EXAMPLE_NAME>[.NUMBER].out` file.
+
+## Custom config files
+
+Sometimes, you want to use the existing config file for the Oasis CLI. Put
+your desired Oasis CLI config folder inside `examples/<EXAMPLE_NAME>`. Upon
+example invocation, the folder will be copied over to a temporary location and
+provided to CLI with `--config` parameter.
+
+## Example output generation
+
+To run the examples and generate outputs, invoke
+
+```sh
+make examples
+```

examples/account-deposit.0.in

@@ -0,0 +1 @@
+oasis account deposit 10 test:dave --account test:alice

examples/account-deposit.out examples/account-deposit.0.outexamples/account-deposit.out renamed to examples/account-deposit.0.out

@@ -3,15 +3,15 @@ Format: plain
 Method: consensus.Deposit
 Body:
   To: test:dave (oasis1qrk58a6j2qn065m6p06jgjyt032f7qucy5wqeqpt)
-  Amount: 10.0 TEST
+  Amount: 10.0 ROSE
 Authorized signer(s):
   1. NcPzNW3YU2T+ugNUtUWtoQnRvbOL9dYSaBfbjHLP1pE= (ed25519)
      Nonce: 0
 Fee:
-  Amount: 0.001131 TEST
+  Amount: 0.001131 ROSE
   Gas limit: 11310
-  (gas price: 0.0000001 TEST per gas unit)
+  (gas price: 0.0000001 ROSE per gas unit)
 
-Network:  testnet
-ParaTime: sapphire
+Network:  mainnet
+ParaTime: emerald
 Account:  test:alice

examples/account-deposit.in

@@ -0,0 +1 @@
+oasis

examples/first-run.in

@@ -9,11 +9,9 @@ Available Commands:
   completion  Generate the autocompletion script for the specified shell
   contract    WebAssembly smart contracts operations
   help        Help about any command
-  inspect     Inspect the network
-  network     Manage network endpoints
-  paratime    Manage paratimes
-  registry    Registry operations
-  tx          Raw transaction operations
+  network     Consensus layer operations
+  paratime    ParaTime layer operations
+  transaction Raw transaction operations
   wallet      Manage accounts in the local wallet
 
 Flags:

examples/first-run.out

@@ -1,16 +1,64 @@
 #!/bin/bash
 
+# Run Oasis CLI as defined in $1 and store its output to $2.
+# CLI execution is terminated when interaction is required (e.g. "Sign this transaction?" question).
+
 set -euo pipefail
 
 OASIS_CMD=./oasis
 IN=$1
 OUT=$2
+EXAMPLE_NAME=$(echo $(basename $IN) | cut -d "." -f 1)
+CFG_DIR="/tmp/cli_examples/${EXAMPLE_NAME}"
+CFG_FLAG="--config /tmp/cli_examples/${EXAMPLE_NAME}/cli.toml"
+RESTORE_CFG_DIR="${HOME}/.config/oasis.backup"
+
+# Prepare clean config file for example or take the example-specific one, if it exists.
+function init_cfg() {
+  # Init config in the first scenario step only.
+  if [ "$(basename $IN)" != "${EXAMPLE_NAME}.in" ] && [ "$(basename $IN)" != "${EXAMPLE_NAME}.0.in" ]; then
+    return
+  fi
+
+  rm -rf "${CFG_DIR}"
+  mkdir -p "$(dirname ${CFG_DIR})"
+
+  # Check for example-specific config and copy it over.
+  CUSTOM_CFG_DIR="$(dirname $IN)/${EXAMPLE_NAME}"
+  if [ -d "${CUSTOM_CFG_DIR}" ]; then
+    cp -r "${CUSTOM_CFG_DIR}" "${CFG_DIR}"
+    return
+  fi
+
+  # Otherwise, generate a clean config file.
+  USER_CFG_DIR="${HOME}/.config/oasis"
+  if [ -d "${USER_CFG_DIR}" ]; then
+    if [ -d "${RESTORE_CFG_DIR}" ]; then
+      echo "error: cannot initialize config: restore config directory ${RESTORE_CFG_DIR} already exists. Please restore it into your ${USER_CFG_DIR} or remove it"
+      exit 1
+    fi
+    mv "${USER_CFG_DIR}" "${RESTORE_CFG_DIR}"
+  fi
+
+  # XXX: What is the simplest Oasis CLI command to generate initial config file?
+  $OASIS_CMD network ls >/dev/null
+  wait
+
+  # Use the fresh config for our example.
+  mv "${USER_CFG_DIR}" "${CFG_DIR}"
+
+  # Restore the original config, if it existed.
+  if [ -d "${RESTORE_CFG_DIR}" ]; then
+    mv "${RESTORE_CFG_DIR}" "${CFG_DIR}"
+  fi
+}
+
+init_cfg
 
-# Runs Oasis CLI with command line arguments passed as $1 and stores output
-# to $2. Oasis CLI is automatically terminated when "Sign this transaction"
-# occurs on the output.
+CMD="$(sed "s#oasis#$OASIS_CMD#" $IN) ${CFG_FLAG}"
 
-${OASIS_CMD} $(cat $IN) > $OUT &
+# Execute the Oasis CLI and store the PID.
+$CMD > $OUT &
 PID=$!
 while ! test -f $OUT || ! grep -q "Sign this transaction" "$OUT" && ps -p ${PID} > /dev/null
 do