feat(examples): Add expected CLI output for given inputs

Author: matevz

.github/workflows/ci-tests.yml

@@ -40,3 +40,10 @@ jobs:
       - name: Run tests
         run: |
           make test
+      - name: Check examples
+        run: |
+          make clean-examples
+          make examples
+          git diff --exit-code examples
+
+

Makefile

@@ -1,5 +1,7 @@
 include common.mk
 
+EXAMPLES := $(patsubst %.in,%.out,$(wildcard examples/*.in))
+
 # Check if Go's linkers flags are set in common.mk and add them as extra flags.
 ifneq ($(GOLDFLAGS),)
 	GO_EXTRA_FLAGS += -ldflags $(GOLDFLAGS)
@@ -13,6 +15,15 @@ build:
 	@$(ECHO) "$(MAGENTA)*** Building Go code...$(OFF)"
 	@$(GO) build -v -o oasis $(GOFLAGS) $(GO_EXTRA_FLAGS)
 
+examples: build $(EXAMPLES)
+
+examples/%.out: examples/%.in
+	@rm -f $@
+	@scripts/gen_example.sh $< $@
+
+clean-examples:
+	@rm -f examples/*.out
+
 # Format code.
 fmt:
 	@$(ECHO) "$(CYAN)*** Running Go formatters...$(OFF)"
@@ -64,6 +75,8 @@ clean:
 # List of targets that are not actual files.
 .PHONY: \
 	all build \
+	examples \
+	clean-examples \
 	fmt \
 	$(lint-targets) lint \
 	$(test-targets) test \

examples/account-deposit.in

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

examples/account-deposit.out

@@ -0,0 +1,17 @@
+You are about to sign the following transaction:
+Format: plain
+Method: consensus.Deposit
+Body:
+  To: test:dave (oasis1qrk58a6j2qn065m6p06jgjyt032f7qucy5wqeqpt)
+  Amount: 10.0 TEST
+Authorized signer(s):
+  1. NcPzNW3YU2T+ugNUtUWtoQnRvbOL9dYSaBfbjHLP1pE= (ed25519)
+     Nonce: 0
+Fee:
+  Amount: 0.001131 TEST
+  Gas limit: 11310
+  (gas price: 0.0000001 TEST per gas unit)
+
+Network:  testnet
+ParaTime: sapphire
+Account:  test:alice

examples/first-run.in

@@ -0,0 +1,24 @@
+CLI for interacting with the Oasis network
+
+Usage:
+  oasis [command]
+
+Available Commands:
+  account     Account operations
+  addressbook Manage addresses in the local address book
+  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
+  wallet      Manage accounts in the local wallet
+
+Flags:
+      --config string   config file to use
+  -h, --help            help for oasis
+  -v, --version         version for oasis
+
+Use "oasis [command] --help" for more information about a command.

examples/first-run.out

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+set -euo pipefail
+
+OASIS_CMD=./oasis
+IN=$1
+OUT=$2
+
+# 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.
+
+${OASIS_CMD} $(cat $IN) > $OUT &
+PID=$!
+while ! test -f $OUT || ! grep -q "Sign this transaction" "$OUT" && ps -p ${PID} > /dev/null
+do
+	sleep 0.5
+done
+
+kill -9 ${PID} 2&>/dev/null || true
+
+# Trim "Sign this transaction" prompt.
+if tail -n 1 $OUT | grep -q "Sign this transaction"
+then
+	head -n -1 $OUT > $OUT.tmp
+	mv $OUT.tmp $OUT
+fi