adding BATS core and supporting libraries

removing dependency for user to have to install BATS

.gitmodules

@@ -0,0 +1,12 @@
+[submodule "test/e2e/bats/core"]
+ path = test/e2e/bats/core
+ url = https://github.com/bats-core/bats-core
+[submodule "test/e2e/bats/support"]
+ path = test/e2e/bats/support
+ url = https://github.com/bats-core/bats-support
+[submodule "test/e2e/bats/assert"]
+ path = test/e2e/bats/assert
+ url = https://github.com/bats-core/bats-assert
+[submodule "test/e2e/bats/file"]
+ path = test/e2e/bats/file
+ url = https://github.com/bats-core/bats-file

Makefile

@@ -49,9 +49,9 @@ test: test-unit test-e2e
 test-unit:
  go test $(GO_FLAGS) $(GO_TEST_FLAGS) $(CMD) $(PKG) $(ARGS)
 
-# runs all end-to-end tests using bats, it assumes bats is installed
+# looks for *.bats files in the test/e2e directory and runs them
 test-e2e:
- ./test/e2e/e2e.bats
+ ./hack/run-e2e.sh
 
 # wait for KinD cluster to be on ready state, so tests can be performed
 verify-kind:

docs/testing.md

@@ -54,8 +54,22 @@ The install script waits for the Controller instance to be running.
 [BATS][batsCore] is a testing framework for Bash. It's structured as a regular script with enhanced
 syntax to define test cases, collect results, and more.
 
-To run BATS based tests, make sure you have `bats` installed, and then execute:
+The BATS core tool and it's supporting libraries are linked in this project as `git submodules`,
+alleviating the need to install BATS yourself.
 
+To run BATS based tests, make sure that you have cloned the project (including all submodules):
+
+```sh
+ Option 1.)
+ $ git clone --recurse-submodules --depth 1 https://github.com/shipwright-io/cli.git
+
+ Option 2.) (if you did not clone using the above command)
+ $ cd /your/project/directory/cli
+ $ git submodule init
+ $ git submodule update
+```
+
+then run:
 ```sh
 make test-e2e
 ```

hack/run-e2e.sh

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+
+for i in test/e2e/*.bats; do
+ ./test/e2e/bats/core/bin/bats ${i}
+done

test/e2e/helpers.sh

@@ -17,6 +17,7 @@ function shp () {
  ${BIN} ${*}
 }
 
+# generate a random string of no more than 16 characters
 function random_name () {
- LC_ALL=C tr -dc a-z </dev/urandom | head -c64
+ LC_ALL=C tr -dc a-z </dev/urandom | head -c16
 }