Merge pull request #24 from tyler36/refactor--modernize-test

refactor: modernize tests

Author: mmunz

tests/test.bats

@@ -1,19 +1,53 @@
+#!/usr/bin/env bats
+
+# Bats is a testing framework for Bash
+# Documentation https://bats-core.readthedocs.io/en/stable/
+# Bats libraries documentation https://github.com/ztombol/bats-docs
+
+# For local tests, install bats-core, bats-assert, bats-file, bats-support
+# And run this in the add-on root directory:
+#   bats ./tests/test.bats
+# To exclude release tests:
+#   bats ./tests/test.bats --filter-tags '!release'
+# For debugging:
+#   bats ./tests/test.bats --show-output-of-passing-tests --verbose-run --print-output-on-failure
+
 setup() {
   set -eu -o pipefail
-  export DIR="$( cd "$( dirname "$BATS_TEST_FILENAME" )" >/dev/null 2>&1 && pwd )/.."
-  export TESTDIR=~/tmp/test-addon-backstop
-  mkdir -p $TESTDIR
-  export PROJNAME=test-addon-backstop
-  export DDEV_NON_INTERACTIVE=true
-  ddev delete -Oy ${PROJNAME} >/dev/null 2>&1 || true
+
+  # Override this variable for your add-on:
+  export GITHUB_REPO=mmunz/ddev-backstopjs
+
+  TEST_BREW_PREFIX="$(brew --prefix 2>/dev/null || true)"
+  export BATS_LIB_PATH="${BATS_LIB_PATH}:${TEST_BREW_PREFIX}/lib:/usr/lib/bats"
+  bats_load_library bats-assert
+  bats_load_library bats-file
+  bats_load_library bats-support
+
+  export DIR="$(cd "$(dirname "${BATS_TEST_FILENAME}")/.." >/dev/null 2>&1 && pwd)"
+  export PROJNAME="test-$(basename "${GITHUB_REPO}")"
+  mkdir -p ~/tmp
+  export TESTDIR=$(mktemp -d ~/tmp/${PROJNAME}.XXXXXX)
+  export DDEV_NONINTERACTIVE=true
+  export DDEV_NO_INSTRUMENTATION=true
+  ddev delete -Oy "${PROJNAME}" >/dev/null 2>&1 || true
   cd "${TESTDIR}"
-  ddev config --project-name=${PROJNAME}
-  ddev start -y >/dev/null
+  run ddev config --project-name="${PROJNAME}" --project-tld=ddev.site
+  assert_success
+  run ddev start -y
+  assert_success
+  echo "# ddev started at $(date)" >&3
+}
+
+health_checks() {
+  # backstop is installed and can show its version
+  run ddev backstop version
+  assert_success
+  assert_output --partial 'Command "version" successfully executed'
 }
 
 teardown() {
   set -eu -o pipefail
-  cd ${TESTDIR} || ( printf "unable to cd to ${TESTDIR}\n" && exit 1 )
   ddev delete -Oy ${PROJNAME} >/dev/null 2>&1
   [ "${TESTDIR}" != "" ] && rm -rf ${TESTDIR}
 }
@@ -22,25 +56,30 @@ teardown() {
   set -eu -o pipefail
   cd ${TESTDIR}
   echo "# ddev add-on get ${DIR} with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3
-  ddev add-on get ${DIR}
+  run ddev add-on get ${DIR}
+  assert_success
   ddev restart
 
-  # backstop is installed and can show its version
-  ddev backstop version | grep 'Command "version" successfully executed'
+  # Check service works
+  health_checks
 
   # openReport and remote commands show an error message
   set +o pipefail
-  ddev backstop openReport | grep -q 'This does not work for backstop in ddev'
-  ddev backstop remote | grep -q 'This does not work for backstop in ddev'
+  run ddev backstop openReport
+  assert_output --partial 'This does not work for backstop in ddev'
+  run ddev backstop remote
+  assert_output --partial 'This does not work for backstop in ddev'
 }
 
 # bats test_tags=release
-#@test "install from release" {
-#  set -eu -o pipefail
-#  cd ${TESTDIR} || ( printf "unable to cd to ${TESTDIR}\n" && exit 1 )
-#  echo "# ddev add-on get drud/ddev-addon-template with project ${PROJNAME} in ${TESTDIR} ($(pwd))" >&3
-#  ddev add-on get drud/ddev-addon-template
-#  ddev restart >/dev/null
-#  # Do something useful here that verifies the add-on
-#  # ddev exec "curl -s elasticsearch:9200" | grep "${PROJNAME}-elasticsearch"
-#}
+@test "install from release" {
+  set -eu -o pipefail
+  echo "# ddev add-on get ${GITHUB_REPO} with project ${PROJNAME} in $(pwd)" >&3
+  run ddev add-on get "${GITHUB_REPO}"
+  assert_success
+  run ddev restart -y
+  assert_success
+
+  # Check service works
+  health_checks
+}