Add more quotes to tests (#64)

.github/workflows/ci.yml

@@ -1,26 +1,22 @@
 name: CI
 
-on: [push, pull_request]
+on:
+  push:
+    branches:
+      - master
+  pull_request:
 
 jobs:
-
-  prepare:
-    runs-on: ubuntu-latest
-    if: "! contains(github.event.head_commit.message, 'skip ci')"
-    steps:
-      - run: echo "${{ github.event.head_commit.message }}"
-
-  build:
-    needs: prepare
+  test:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-go@v2
         with:
-          go-version: '1.13.12'
-      - run: 'go version'
-      - run: 'make get-bats'
-      - name: 'build'
-        run: 'make cross-compile'
-      - name: 'test'
-        run: 'make integration-tests'
+          go-version: 1.15.7
+      - run: go version
+      - run: make get-bats
+      - name: build
+        run: make cross-compile
+      - name: test
+        run: make integration-tests

Makefile

@@ -3,7 +3,10 @@ PLATFORMS := linux darwin
 ARCHS := 386 amd64
 VERSION := $(shell git describe --tags --always --dirty)
 
-cross-compile: clean
+help: ## Prints help for targets with comments
+	@grep -E '^[a-zA-Z0-9.\ _-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
+
+cross-compile: clean ## Compile vsh binaries for multiple platforms and architectures
 	mkdir -p ./build/
 	for GOOS in $(PLATFORMS); do \
 		for GOARCH in $(ARCHS); do \
@@ -13,10 +16,10 @@ cross-compile: clean
 	done
 	ls build/
 
-compile: clean
+compile: clean ## Compile vsh for platform based on uname
 	go build -ldflags "-X main.vshVersion=$(VERSION)" -o build/${APP_NAME}_$(shell uname | tr '[:upper:]' '[:lower:]')_amd64
 
-get-bats:
+get-bats: ## Download bats dependencies to test directory
 	rm -rf test/bin/
 	mkdir -p test/bin/core
 	mkdir -p test/bin/plugins/bats-assert
@@ -27,11 +30,12 @@ get-bats:
 	curl -sL https://github.com/bats-core/bats-support/archive/v0.3.0.tar.gz | tar xvz --strip 1 -C test/bin/plugins/bats-support
 	curl -sL https://github.com/bats-core/bats-file/archive/v0.2.0.tar.gz | tar xvz --strip 1 -C test/bin/plugins/bats-file
 
-integration-tests:
+integration-tests: ## Run integration test suites (requires bats - see get-bats)
 	test/run.sh
 
-local-vault-test-instance:
+local-vault-test-instance: ## Start a local vault container with integration test provisioning
 	bash -c ". test/util/util.bash && setup"
 
-clean:
+clean: ## Remove builds and vsh related docker containers
+	docker rm -f vsh-integration-test-vault || true
 	rm ./build/* || true

test/suites/commands/append.bats

@@ -26,7 +26,7 @@ load ../../bin/plugins/bats-assert/load
 
   #######################################
   echo "==== case: append to non-existing file ===="
-  run ${APP_BIN} -c "append ${KV_BACKEND}/src/does/not/exist ${KV_BACKEND}/src/aa"
+  run ${APP_BIN} -c "append '${KV_BACKEND}/src/does/not/exist' \"${KV_BACKEND}/src/aa\""
   assert_failure 1
 
   echo "ensure proper error message"
@@ -50,7 +50,7 @@ load ../../bin/plugins/bats-assert/load
 
   #######################################
   echo "==== case: append value to existing destination with conflicting keys (skip strategy) ===="
-  run ${APP_BIN} -c "append ${KV_BACKEND}/src/tooling/v1 ${KV_BACKEND}/dest/prod/all --skip"
+  run ${APP_BIN} -c "append \"${KV_BACKEND}/src/tooling/v1\" '${KV_BACKEND}/dest/prod/all' --skip"
   assert_success
 
   echo "ensure the file got appended to destination"

test/suites/commands/cat.bats

@@ -33,7 +33,7 @@ load ../../bin/plugins/bats-assert/load
 
   #######################################
   echo "==== case: cat ambiguous directory ===="
-  run ${APP_BIN} -c "cat ${KV_BACKEND}/src/tooling/"
+  run ${APP_BIN} -c "cat '${KV_BACKEND}/src/tooling/'"
   assert_failure 1
   assert_line --partial "Not a valid path for operation: /${KV_BACKEND}/src/tooling/"
 }

test/suites/commands/cp.bats

@@ -34,7 +34,7 @@ load ../../bin/plugins/bats-assert/load
 
   #######################################
   echo "==== case: copy single directory without trailing '/' ===="
-  run ${APP_BIN} -c "cp ${KV_BACKEND}/src/dev ${KV_BACKEND}/dest/dev"
+  run ${APP_BIN} -c "cp '${KV_BACKEND}/src/dev' '${KV_BACKEND}/dest/dev'"
   assert_success
 
   echo "ensure the directory got copied to destination"
@@ -61,7 +61,7 @@ load ../../bin/plugins/bats-assert/load
 
   #######################################
   echo "==== case: copy single directory with trailing '/' ===="
-  run ${APP_BIN} -c "cp ${KV_BACKEND}/src/dev/ ${KV_BACKEND}/dest/dev.copy"
+  run ${APP_BIN} -c "cp \"${KV_BACKEND}/src/dev/\" \"${KV_BACKEND}/dest/dev.copy\""
   assert_success
 
   echo "ensure the directory got copied to destination"

test/suites/commands/mv.bats

@@ -5,7 +5,7 @@ load ../../bin/plugins/bats-assert/load
 @test "vault-${VAULT_VERSION} ${KV_BACKEND} 'mv'" {
   #######################################
   echo "==== case: move single file ===="
-  run ${APP_BIN} -c "mv ${KV_BACKEND}/src/prod/all ${KV_BACKEND}/dest/prod/all"
+  run ${APP_BIN} -c "mv '${KV_BACKEND}/src/prod/all' ${KV_BACKEND}/dest/prod/all"
   assert_success
 
   echo "ensure the file got moved to destination"

test/suites/commands/rm.bats

@@ -65,7 +65,7 @@ load ../../bin/plugins/bats-assert/load
   assert_success
   assert_output "v2"
 
-  run ${APP_BIN} -c "rm ${KV_BACKEND}/src/staging/all/"
+  run ${APP_BIN} -c "rm \"${KV_BACKEND}/src/staging/all/\""
   assert_success
 
   echo "ensure the directory got removed"