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

Author: matevz

.github/workflows/ci-tests.yml

@@ -40,3 +40,8 @@ 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,8 @@
 include common.mk
 
+# Each Oasis CLI example's input .in must have a corresponding output .out.
+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)
@@ -9,10 +12,20 @@ endif
 all: build
 
 # Build.
-build:
+build: oasis
+oasis: $(shell find -name "*.go" -type f) go.sum go.mod
 	@$(ECHO) "$(MAGENTA)*** Building Go code...$(OFF)"
 	@$(GO) build -v -o oasis $(GOFLAGS) $(GO_EXTRA_FLAGS)
 
+examples: $(EXAMPLES)
+
+examples/%.out: examples/%.in oasis
+	@rm -f $@
+	@scripts/gen_example.sh $< $@
+
+clean-examples:
+	@rm -f examples/*.out
+
 # Format code.
 fmt:
 	@$(ECHO) "$(CYAN)*** Running Go formatters...$(OFF)"
@@ -64,6 +77,8 @@ clean:
 # List of targets that are not actual files.
 .PHONY: \
 	all build \
+	examples \
+	clean-examples \
 	fmt \
 	$(lint-targets) lint \
 	$(test-targets) test \

examples/README.md

@@ -0,0 +1 @@
+oasis account allow logan -- -10

examples/account-allow-negative.in.static

@@ -0,0 +1,14 @@
+You are about to sign the following transaction:
+Method: staking.Allow
+Body:
+  Beneficiary:   oasis1qpl4axynedmdrrgrg7dpw3yxc4a8crevr5dkuksl
+  Amount change: -10.0 TEST
+Nonce:  0
+Fee:
+  Amount: 0.0 TEST
+  Gas limit: 1288
+  (gas price: 0.0 TEST per gas unit)
+
+Network:  testnet
+ParaTime: none (consensus layer)
+Account:  oscar

examples/account-allow-negative.out.static

@@ -0,0 +1 @@
+oasis account from-public-key NcPzNW3YU2T+ugNUtUWtoQnRvbOL9dYSaBfbjHLP1pE=

examples/account-from-public-key.in

@@ -0,0 +1 @@
+oasis1qrec770vrek0a9a5lcrv0zvt22504k68svq7kzve

examples/account-from-public-key.out

@@ -0,0 +1 @@
+oasis account show

examples/account.00.in

@@ -0,0 +1,8 @@
+Address: oasis1qp87hflmelnpqhzcqcw8rhzakq4elj7jzv090p3e
+Nonce: 0
+
+=== CONSENSUS LAYER (testnet) ===
+  Total: 0.0 TEST
+  Available: 0.0 TEST
+
+

examples/account.00.out

@@ -0,0 +1 @@
+oasis account show orlando