feat: bats test framework (#216)

Author: Sebastiaan Verbeek

Dockerfile

@@ -1,34 +1,43 @@
 FROM node:14-slim as npm
 
-ARG SKIP_TESTS='false'
-ENV CI=true
-
 ENV APP_HOME=/home/app/stack
 RUN mkdir -p $APP_HOME
 WORKDIR $APP_HOME
 
+ARG SKIP_TESTS='false'
+ENV CI=true
+
 COPY . .
 COPY ./.cspell.json .
 
 RUN if [ "$SKIP_TESTS" = 'false' ]; then \
   npm install cspell && npm run spellcheck; fi
 
 #-----------------------------
-FROM otomi/tools:1.4.10 as prod
-
-ARG SKIP_TESTS='false'
-ENV CI=true
+FROM otomi/tools:1.4.10 as test
 
 ENV APP_HOME=/home/app/stack
 RUN mkdir -p $APP_HOME
 WORKDIR $APP_HOME
 
+ARG SKIP_TESTS='false'
+ENV CI=true
+
 COPY . .
 
 RUN if [ "$SKIP_TESTS" = 'false' ]; then \
   cp -r .demo/ env/ && \
   bin/validate-values.sh && \
   bin/validate-templates.sh && \
-  rm -rf env/*; fi
+  bats bin/tests; fi
+
+#-----------------------------
+FROM otomi/tools:1.4.10 as prod
+
+ENV APP_HOME=/home/app/stack
+RUN mkdir -p $APP_HOME
+WORKDIR $APP_HOME
+
+COPY . .
 
 CMD ["bin/otomi"]

bin/bootstrap.sh

@@ -11,7 +11,6 @@ else
 fi
 
 has_otomi='false'
-skip_demo_files=${1-'false'}
 [ -f $ENV_DIR/bin/otomi ] && has_otomi='true'
 
 function generate_loose_schema() {
@@ -44,8 +43,8 @@ done
 for f in '.gitignore' '.prettierrc.yml' 'README.md'; do
   cp $PWD/.values/$f $ENV_DIR/
 done
-if [ "$skip_demo_files" = "false" ]; then
-  echo "Installing demo files"
+if [ -z "$(ls -A $ENV_DIR/env)" ]; then
+  echo "No files found in env, installing demo files"
   cp -r $PWD/.demo/env $ENV_DIR/env
 fi
 cp -f $PWD/bin/hooks/pre-commit $ENV_DIR/.git/hooks/

bin/tests/bootstrap-integration.bats

@@ -0,0 +1,36 @@
+#!/usr/local/bin/bats
+
+lib_dir="/usr/local/lib"
+
+load "$lib_dir/bats-support/load.bash"
+load "$lib_dir/bats-assert/load.bash"
+load "$lib_dir/bats-file/load.bash"
+
+setup () {
+    test_temp_dir="$(temp_make --prefix "otomi-values-")"
+    export ENV_DIR="$test_temp_dir"
+}
+
+teardown () {
+    temp_del "$test_temp_dir"
+    unset ENV_DIR
+}
+
+@test "executing bootstrap.sh should pass with new ENV_DIR (otomi-values) folder" {
+    git init "$ENV_DIR"
+    run bin/bootstrap.sh
+    assert_success
+}
+
+@test "executing bootstrap.sh should fail without new ENV_DIR (otomi-values) folder" {
+    unset ENV_DIR
+    run bin/bootstrap.sh
+    assert_failure
+}
+
+@test "executing bootstrap.sh multiple times should pass with new ENV_DIR (otomi-values)" {
+    git init "$test_temp_dir"
+    bin/bootstrap.sh 
+    run bin/bootstrap.sh
+    assert_success
+}

bin/tests/bootstrap-unit.bats

@@ -0,0 +1,39 @@
+#!/usr/local/bin/bats
+
+lib_dir="/usr/local/lib"
+
+load "$lib_dir/bats-support/load.bash"
+load "$lib_dir/bats-assert/load.bash"
+load "$lib_dir/bats-file/load.bash"
+
+setup () {
+    test_temp_dir="$(temp_make --prefix 'otomi-values-')"
+    export ENV_DIR="$test_temp_dir"
+    env_path="$ENV_DIR/env"
+}
+
+teardown () {
+    temp_del "$test_temp_dir"
+    unset ENV_DIR
+    unset env_path
+}
+
+@test "the env folder should not be overwritten" {
+    git init "$ENV_DIR"
+    cluster_path="$env_path/clusters.yaml"
+    mkdir -p "$env_path" && touch $cluster_path && echo "clouds: please-do-not-remove" > $cluster_path
+    bin/bootstrap.sh 
+
+    assert_file_not_exist "$env_path/charts"
+    assert_file_not_exist "$env_path/clouds"
+    assert_file_not_exist "$env_path/teams"
+}
+
+@test "the env folder should be created after bootstrap.sh" {
+    git init "$ENV_DIR"
+    bin/bootstrap.sh
+
+    assert_file_exist "$env_path/charts"
+    assert_file_exist "$env_path/clouds"
+    assert_file_exist "$env_path/teams"
+}

tools/Dockerfile

@@ -18,6 +18,12 @@ ARG KUBEVAL_VERSION=0.15.0
 
 ARG HELM_FILE_NAME=helm-${HELM_VERSION}-linux-amd64.tar.gz
 
+# https://github.com/ztombol/bats-assert/releases https://github.com/ztombol/bats-support
+ARG BATS_VERSION=1.2.1
+ARG BATS_ASSERT_VERSION=0.3.0
+ARG BATS_SUPPORT_VERSION=0.3.0
+ARG BATS_FILE_VERSION=0.2.0
+
 WORKDIR /
 
 RUN apt-get update -qq \
@@ -80,6 +86,20 @@ RUN curl -sL https://deb.nodesource.com/setup_lts.x | bash -
 RUN apt-get install -y nodejs && \
   npm install -g ajv-cli
 
+# bats
+ADD https://codeload.github.com/bats-core/bats-core/tar.gz/v${BATS_VERSION} /tmp
+RUN tar -zxvf /tmp/v${BATS_VERSION} -C /tmp && /tmp/bats-core-${BATS_VERSION}/install.sh /usr/local
+
+# bats libs
+ADD https://codeload.github.com/ztombol/bats-assert/tar.gz/v${BATS_ASSERT_VERSION} /tmp
+RUN tar -zxvf /tmp/v${BATS_ASSERT_VERSION} -C /tmp && mv /tmp/bats-assert-${BATS_ASSERT_VERSION} /usr/local/lib/bats-assert
+
+ADD https://codeload.github.com/ztombol/bats-support/tar.gz/v${BATS_SUPPORT_VERSION} /tmp
+RUN tar -zxvf /tmp/v${BATS_SUPPORT_VERSION} -C /tmp && mv /tmp/bats-support-${BATS_SUPPORT_VERSION} /usr/local/lib/bats-support
+
+ADD https://codeload.github.com/ztombol/bats-file/tar.gz/v${BATS_FILE_VERSION} /tmp
+RUN tar -zxvf /tmp/v${BATS_FILE_VERSION} -C /tmp && mv /tmp/bats-file-${BATS_FILE_VERSION} /usr/local/lib/bats-file
+
 RUN chown -R app:app /home/app
 USER app