Ci tuning

.travis.yml

@@ -1,237 +1,36 @@
 dist: xenial
 language: minimal
+
+env:
+  global:
+    - VERSION=4.6.0
+    - COMMIT=449e06c
+    - BRANCH=develop
+
 services:
   - docker
 
 jobs:
    include:
-     - stage: given ver string build image from VERSION build-arg
-       env:
-        - VERSION=4.6.0
-        - DOCKER_TAG=4.6.0
-        - URL=http://127.0.0.1:8080/exist/rest/db
-       script:
-       - docker build --tag existdb/existdb:${VERSION} --build-arg "VERSION=${VERSION}" . &>/dev/null
-       - docker-compose up -d  &>/dev/null
-       - |
-          # CHECK! eXist is starting with health status
-          #  ps cmd should show health status as starting
-          set -eo pipefail
-          docker ps -a | \
-          grep 'exist' | \
-          grep -oP 'health.\sstarting'
-       - |
-          # WAIT! until eXist can be reached
-          # set -eo pipefail
-          N=0
-          until curl -Isf http://127.0.0.1:8080/ 2>/dev/null | grep 'Jetty' || [ $N -eq 20 ]
-            do sleep $(( N++ ))
-          done
-       - |
-          # CHECK! eXist can be reached via http
-          # response header should grep Jetty
-          set -eo pipefail
-          curl -Is http://127.0.0.1:8080/ | \
-          grep 'Jetty'
-       - |
-          # CHECK! docker logs should show server has started
-          set -eo pipefail
-          docker logs exist | \
-          grep -oP '^.+\KServer has started.+'
-       - sleep 30
-       - |
-          # CHECK! healthcheck should register healthy
-          docker ps | \
-          grep -o 'healthy'
-       - |
-          # changing password with client.jar
-          # CHECK! the ability to
-          #  - invoke client.jar
-          #  - change password
-          #  - query db with new pass
-          # after changing password the is-dba() query call should return true
-          set -eo pipefail
-          docker exec exist java -jar start.jar client -q -u admin -P '' \
-          -x 'sm:passwd("admin", "nimda")' 2>/dev/null
-          cat <<EOF | curl -s -H 'Content-Type: text/xml' -u 'admin:nimda' --data-binary @- "$URL" | grep 'true'
-          <query xmlns='http://exist.sourceforge.net/NS/exist' start='1' max='99' wrap='no'>
-          <text><![CDATA[
-          xquery version '3.1';
-          sm:is-dba(xmldb:get-current-user())
-          ]]></text>
-          </query>
-          EOF
-       - |
-          # obtain running container eXist 'version'
-          # # http GET request to rest endpoint url via CURL
-          # CHECK! the ability to
-          #  - invoke a http client (curl)
-          #  - use GET to query the database
-          #  the get-version() query,
-          #  should match the version of the freshly minted built image
-          set -eo pipefail
-          curl -s -u 'admin:nimda' "$URL?_query=system:get-version()&_wrap=no" | \
-          grep "$VERSION"
-       - |
-          # posting requests to rest endpoint url via CURL
-          # CHECK! the ability to
-          #  - invoke a http client (curl)
-          #  - to query the database by POSTing a query
-          #
-          #  the list returned from a repo:list() query,
-          #  should grep 'http://'
-          set -eo pipefail
-          cat <<EOF | curl -s -H 'Content-Type: text/xml' -u 'admin:nimda' --data-binary @- "$URL" | grep 'http://'
-          <query xmlns='http://exist.sourceforge.net/NS/exist' start='1' max='99' wrap='no'>
-          <text><![CDATA[
-          xquery version '3.1';
-          string-join(repo:list(), '&#10;')
-          ]]></text>
-          </query>
-          EOF
-       - |
-          # manage config files
-          # CHECK! the ability to
-          # - copy a config file from container to local disk
-          # after copying conf.xml the file should exist locally
-          set -eo pipefail
-          docker cp exist:exist/config/conf.xml ./conf.xml \
-          && [[ -e ./conf.xml ]] && ls -l ./conf.xml
-       - |
-          # persist changed configuration items
-          # CHECK! the abilty to
-          #  - alter a config item in a config file on local disk,
-          #  - copy the altered config file into containers config dir.
-          #  - stop and start the container
-          #  - view changed item taking effect in startup logs
-          #
-          # The startup log should show altered shutdown time
-          set -eo pipefail
-          sed -i.bak 's/wait-before-shutdown="120000"/wait-before-shutdown="60000"/' ./conf.xml
-          docker cp ./conf.xml exist:exist/config/conf.xml
-          docker-compose down &>/dev/null
-          docker-compose up -d &>/dev/null
-          N=0
-          until curl -Isf http://127.0.0.1:8080/ 2>/dev/null | grep 'Jetty' || [ $N -eq 20 ]
-            do sleep $(( N++ ))
-          done
-          docker logs exist | grep '60,000 ms during shutdown'
-       - |
-          # log to docker logs
-          # CHECK! the abilty to
-          # - call log functions
-          # - view results in docker logs
-          #
-          # eXist log queries should turn up in docker logs
-          {
-          cat <<EOF | curl -s -H 'Content-Type: text/xml' -u 'admin:nimda' --data-binary @- "$URL"
-          <query xmlns='http://exist.sourceforge.net/NS/exist' start='1' max='99' wrap='no'>
-          <text><![CDATA[
-          xquery version '3.1';
-          (
-          util:log-system-out('HELLO SYSTEM-OUT!'),
-          util:log-system-err('HELLO SYSTEM-ERR!'),
-          util:log('INFO', 'HELLO logged INFO!'),
-          util:log('WARN', 'HELLO logged WARN' )
-          )
-          ]]></text>
-          </query>
-          EOF
-          } && docker logs exist | grep HELLO
-       - docker-compose down
-     - stage: given commit hash build image from BRANCH build-arg
-       env: DOCKER_TAG=449e06c
-       install: skip
-       script:
-       - docker build --tag existdb/existdb:${DOCKER_TAG} --build-arg "BRANCH=${DOCKER_TAG}" . &>/dev/null
-       - docker-compose up -d  &>/dev/null
-       - |
-          # CHECK! eXist is starting with health status
-          #  ps cmd should show health status as starting
-          set -eo pipefail
-          docker ps -a | \
-          grep 'exist' | \
-          grep -oP 'health.\sstarting'
-       - |
-          # WAIT! until eXist can be reached
-          # set -eo pipefail
-          N=0
-          until curl -Isf http://127.0.0.1:8080/ 2>/dev/null | grep 'Jetty' || [ $N -eq 20 ]
-            do sleep $(( N++ ))
-          done
-       - |
-          # CHECK! eXist can be reached via http
-          # response header should grep Jetty
-          set -eo pipefail
-          curl -Is http://127.0.0.1:8080/ | \
-          grep 'Jetty'
-       - |
-          # CHECK! docker logs should show server has started
-          set -eo pipefail
-          docker logs exist | \
-          grep -oP '^.+\KServer has started.+'
-       - sleep 30
-       - |
-          # CHECK! healthcheck should register healthy
-          docker ps | \
-          grep -o 'healthy'
-       - docker-compose down
-     - stage: given master branch name build image from BRANCH build-arg
-       env: DOCKER_TAG=master
-       install: skip
-       script:
-       - docker build --tag existdb/existdb:${DOCKER_TAG} --build-arg "BRANCH=${DOCKER_TAG}" . &>/dev/null
-       - docker-compose up -d  &>/dev/null
-       - |
-          # CHECK! eXist is starting with health status
-          #  ps cmd should show health status as starting
-          set -eo pipefail
-          docker ps -a | \
-          grep 'exist' | \
-          grep -oP 'health.\sstarting'
-       - |
-          # WAIT! until eXist can be reached
-          # set -eo pipefail
-          N=0
-          until curl -Isf http://127.0.0.1:8080/ 2>/dev/null | grep 'Jetty' || [ $N -eq 20 ]
-            do sleep $(( N++ ))
-          done
-       - |
-          # CHECK! eXist can be reached via http
-          # response header should grep Jetty
-          set -eo pipefail
-          curl -Is http://127.0.0.1:8080/ | \
-          grep 'Jetty'
-       - |
-          # CHECK! docker logs should show server has started
-          set -eo pipefail
-          docker logs exist | \
-          grep -oP '^.+\KServer has started.+'
-       - sleep 30
-       - |
-          # CHECK! healthcheck should register healthy
-          docker ps | \
-          grep -o 'healthy'
-       - docker-compose down
+     - stage: build docker images
+       name: via VERSION tag
+       script: docker build --tag existdb/exist-ci-build:${VERSION} --build-arg "VERSION=${VERSION}" .
+     - script: docker build --tag existdb/exist-ci-build:${COMMIT} --build-arg "BRANCH=${COMMIT}" .
+       name: via BRANCH commit
+     - script:
+       - echo "$DOCKER_PASSWORD" | docker login -u "$DOCKER_USERNAME" --password-stdin
+       - docker build --tag existdb/exist-ci-build:latest --build-arg "BRANCH=${BRANCH}" .
+       - docker push existdb/exist-ci-build
+       name: via BRANCH name
+     - stage: test
+       before_install: docker run -dit -p 8080:8080 --rm --name exist existdb/exist-ci-build:latest
+       install:
+         - sudo add-apt-repository ppa:duggan/bats --yes
+         - sudo apt-get update -qq
+         - sudo apt-get install -qq bats
+         - sleep 20
+       script: bats --tap test/*.bats
+
 
 notifications:
   slack: exist-db:IXzUdqA0n11cnxaDz43ZQgdX
-
-# TODO maybe
-# a # listing files in config dir
-#  # CHECK! with the exist containers provided config dir,
-#  # a user should be able to list configuration files
-#  # that will enable user to alter eXist start up options.
-#  set -eo pipefail
-#  cat <<EOF | curl -s -H 'Content-Type: text/xml' -u 'admin:nimda' --data-binary @- "$URL"
-#  <query xmlns='http://exist.sourceforge.net/NS/exist' start='1' max='99' wrap='no'>
-#  <text><![CDATA[
-#  xquery version '3.1';
-#  let $eXistHome := system:get-exist-home()
-#  let $configDir := concat($eXistHome, '/config')
-#  let $fileList := file:list( configDir )
-#  return
-#   $fileList
-#  ]]></text>
-#  </query>
-#  EOF

README.md

@@ -14,6 +14,9 @@ This repository holds the source files for building a minimal docker image of th
 ## Requirements
 *   [Docker](https://www.docker.com): `18-stable`
 
+For test development only:
+*   [bats-core](https://github.com/bats-core/bats-core): `1.1.0`
+
 ## How to use
 Pre-build images are available on [DockerHub](https://hub.docker.com/r/existdb/existdb/). There are two channels:
 *   `release` for the latest stable releases based on the [`master` branch](https://github.com/eXist-db/exist/tree/master)

test/01-connect-spec.bats

@@ -0,0 +1,28 @@
+#!/usr/bin/env bats
+
+# Basic start-up and connection tests
+@test "jvm responds from client" {
+  run docker exec exist java -version
+  [ "$status" -eq 0 ]
+}
+
+@test "eXist can be reached via http" {
+  result=$(curl -Is http://127.0.0.1:8080/ | grep -o 'Jetty')
+  [ "$result" == 'Jetty' ]
+}
+
+@test "eXist reports healthy to docker" {
+  result=$(docker ps | grep -o 'healthy')
+  [ "$result" == 'healthy' ]
+}
+
+@test "eXist logs show clean start" {
+  result=$(docker logs exist | grep -o 'Server has started')
+  [ "$result" == 'Server has started' ]
+}
+
+@test "logs are error free" {
+  skip
+  run docker logs exist | grep -o 'ERROR'
+  [ "$status" -eq 1 ]
+}

test/02-config-spec.bats

@@ -0,0 +1,57 @@
+#!/usr/bin/env bats
+
+# Tests for modifying eXist's configuration files
+@test "copy configuration file from container to disk" {
+  run docker cp exist:exist/config/conf.xml ./conf.xml && [[ -e ./conf.xml ]] && ls -l ./conf.xml
+  [ "$status" -eq 0 ]
+}
+
+@test "modify the copied config file" {
+  run sed -i.bak 's/wait-before-shutdown="120000"/wait-before-shutdown="60000"/' ./conf.xml
+  [ "$status" -eq 0 ]
+}
+
+@test "create modified image" {
+  run docker create --name ex-mod -p 9090:8080 existdb/exist-ci-build:latest
+  [ "$status" -eq 0 ]
+  run docker cp ./conf.xml ex-mod:exist/config/conf.xml
+  [ "$status" -eq 0 ]
+  run docker start ex-mod
+  [ "$status" -eq 0 ]
+}
+
+@test "modification is applied in container" {
+  # Make sure container is running
+  result=$(docker ps | grep -o 'ex-mod')
+  [ "$result" == 'ex-mod' ]
+  sleep 30
+  result=$(docker logs ex-mod | grep -o "60,000 ms during shutdown")
+  [ "$result" == '60,000 ms during shutdown' ]
+}
+
+@test "teardown modified image" {
+  run docker stop ex-mod
+  [ "$status" -eq 0 ]
+  [ "$output" == "ex-mod" ]
+  run docker rm ex-mod
+  [ "$status" -eq 0 ]
+  [ "$output" == "ex-mod" ]
+  run rm ./conf.xml
+  [ "$status" -eq 0 ]
+  run rm ./conf.xml.bak
+  [ "$status" -eq 0 ]
+}
+
+@test "log queries to sytem are visible to docker" {
+  run docker exec exist java -jar start.jar client -q -u admin -P '' -x 'util:log-system-out("HELLO SYSTEM-OUT")'
+  [ "$status" -eq 0 ]
+  result=$(docker logs exist | grep -o "HELLO SYSTEM-OUT" | head -1)
+  [ "$result" == "HELLO SYSTEM-OUT" ]
+}
+
+@test "regular log queries are visible to docker" {
+  run docker exec exist java -jar start.jar client -q -u admin -P '' -x 'util:log("INFO", "HELLO logged INFO")'
+  [ "$status" -eq 0 ]
+  result=$(docker logs exist | grep -o "HELLO logged INFO" | head -1)
+  [ "$result" == "HELLO logged INFO" ]
+}

test/03-xquery-spec.bats

@@ -0,0 +1,29 @@
+#!/usr/bin/env bats
+
+# Tests that execute xquery via start.jar
+@test "Change admin password" {
+  run docker exec exist java -jar start.jar client -q -u admin -P '' -x 'sm:passwd("admin", "nimda")'
+  [ "$status" -eq 0 ]
+}
+
+# Tests that use rest endpoint, this might be disabled by default soon
+@test "confirm new password" {
+  result=$(curl -s -H 'Content-Type: text/xml' -u 'admin:nimda' --data-binary @test/dba-xq.xml http://127.0.0.1:8080/exist/rest/db | grep 'true' | head -1)
+  [ "$result" == 'true' ]
+}
+
+@test "GET version via rest" {
+  run curl -s -u 'admin:nimda' "http://127.0.0.1:8080/exist/rest/db?_query=system:get-version()&_wrap=no"
+  [ "$status" -eq 0 ]
+  echo '# ' $output >&3
+}
+
+@test "POST list repo query" {
+  result=$(curl -s -H 'Content-Type: text/xml' -u 'admin:nimda' --data-binary @test/repo-list.xml http://127.0.0.1:8080/exist/rest/db | grep -o 'http://' | head -1)
+  [ "$result" == 'http://' ]
+}
+
+@test "teardown revert changes" {
+  run docker exec exist java -jar start.jar client -q -u admin -P 'nimda' -x 'sm:passwd("admin", "")'
+  [ "$status" -eq 0 ]
+}

test/dba-xq.xml

@@ -0,0 +1,6 @@
+<query xmlns='http://exist.sourceforge.net/NS/exist' start='1' max='99' wrap='no'>
+<text><![CDATA[
+xquery version '3.1';
+sm:is-dba(xmldb:get-current-user())
+]]></text>
+</query>