Merge pull request #1805 from Fishbowler/upgrade_tests

Database Upgrade tests for Openfire

.github/workflows/database-upgrades.yml

@@ -0,0 +1,130 @@
+name: Openfire Database Upgrade Tests
+
+env:
+  CI: true
+  STARTER_VERSION: 21 # The version of the initial DB being installed, as per the ofVersion table
+
+on:
+  push:
+    branches: [ master ]
+    paths:
+    - 'distribution/src/database/**'
+    - 'build/ci/**'
+    - '.github/workflows/database-upgrades.yml'
+    - 'xmppserver/pom.xml'
+  pull_request:
+    paths:
+    - 'distribution/src/database/**'
+    - 'build/ci/**'
+    - '.github/workflows/database-upgrades.yml'
+    - 'xmppserver/pom.xml'
+
+
+
+jobs:
+  sqlserver:
+    name: Test SQL Server Upgrades
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout Openfire
+      uses: actions/checkout@v2
+    - name: Set environment variables
+      run: |
+        echo "CONNECTION_STRING=jdbc:sqlserver://localhost:1433;databaseName=openfire;applicationName=Openfire" >> $GITHUB_ENV
+        echo "CONNECTION_DRIVER=com.microsoft.sqlserver.jdbc.SQLServerDriver" >> $GITHUB_ENV
+        echo "CONNECTION_USERNAME=sa" >> $GITHUB_ENV
+        echo "CONNECTION_PASSWORD=SecurePa55w0rd" >> $GITHUB_ENV
+        OPENFIREVSN=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)
+        echo "OPENFIREVSN=$OPENFIREVSN" >> $GITHUB_ENV
+    - name: Download old Openfire database script
+      run: |
+        mkdir olddb
+        curl https://raw.githubusercontent.com/igniterealtime/Openfire/v3.9.3/src/database/openfire_sqlserver.sql > $GITHUB_WORKSPACE/olddb/openfire_sqlserver.sql
+    - name: Start database server and install database
+      run: docker-compose -f ./build/ci/compose/mssql.yml up --detach
+    - name: Cache local Maven repository
+      uses: actions/cache@v2
+      with:
+        path: ~/.m2/repository
+        key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+        restore-keys: |
+          ${{ runner.os }}-maven-
+    - name: Build openfire
+      run: mvn install
+    - name: Build & run update tester
+      run: |
+        pushd ./build/ci/updater
+        mvn package
+        java -jar ./target/updaterunner-1.0.0-jar-with-dependencies.jar
+
+
+  postgres:
+    name: Test Postgres Upgrades
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Openfire
+        uses: actions/checkout@v2
+      - name: Set environment variables
+        run: |
+          echo "CONNECTION_STRING=jdbc:postgresql://localhost:5432/openfire" >> $GITHUB_ENV
+          echo "CONNECTION_DRIVER=org.postgresql.Driver" >> $GITHUB_ENV
+          echo "CONNECTION_USERNAME=openfire" >> $GITHUB_ENV
+          echo "CONNECTION_PASSWORD=SecurePa55w0rd" >> $GITHUB_ENV
+          OPENFIREVSN=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)
+          echo "OPENFIREVSN=$OPENFIREVSN" >> $GITHUB_ENV
+      - name: Download old Openfire database script
+        run: |
+          mkdir olddb
+          curl https://raw.githubusercontent.com/igniterealtime/Openfire/v3.9.3/src/database/openfire_postgresql.sql > $GITHUB_WORKSPACE/olddb/openfire_postgresql.sql
+      - name: Start database server and install database
+        run: docker-compose -f ./build/ci/compose/postgresql.yml up --detach
+      - name: Cache local Maven repository
+        uses: actions/cache@v2
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
+      - name: Build openfire
+        run: mvn install
+      - name: Build & run update tester
+        run: |
+          pushd ./build/ci/updater
+          mvn package
+          java -jar ./target/updaterunner-1.0.0-jar-with-dependencies.jar
+
+
+  mysql:
+    name: Test MySQL Upgrades
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Openfire
+        uses: actions/checkout@v2
+      - name: Set environment variables
+        run: |
+          echo "CONNECTION_STRING=jdbc:mysql://localhost:3306/openfire?rewriteBatchedStatements=true&characterEncoding=UTF-8&characterSetResults=UTF-8&serverTimezone=UTC" >> $GITHUB_ENV
+          echo "CONNECTION_DRIVER=com.mysql.cj.jdbc.Driver" >> $GITHUB_ENV
+          echo "CONNECTION_USERNAME=root" >> $GITHUB_ENV
+          echo "CONNECTION_PASSWORD=SecurePa55w0rd" >> $GITHUB_ENV
+          OPENFIREVSN=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)
+          echo "OPENFIREVSN=$OPENFIREVSN" >> $GITHUB_ENV
+      - name: Download old Openfire database script
+        run: |
+          mkdir olddb
+          curl https://raw.githubusercontent.com/igniterealtime/Openfire/v3.9.3/src/database/openfire_mysql.sql > $GITHUB_WORKSPACE/olddb/openfire_mysql.sql
+      - name: Start database server and install database
+        run: docker-compose -f ./build/ci/compose/mysql.yml up --detach
+      - name: Cache local Maven repository
+        uses: actions/cache@v2
+        with:
+          path: ~/.m2/repository
+          key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+          restore-keys: |
+            ${{ runner.os }}-maven-
+      - name: Build openfire
+        run: mvn install
+      - name: Build & run update tester
+        run: |
+          pushd ./build/ci/updater
+          mvn package
+          java -jar ./target/updaterunner-1.0.0-jar-with-dependencies.jar

build/ci/compose/mssql.yml

@@ -0,0 +1,14 @@
+version: '3.7'
+
+services:
+    db:
+        image: mcr.microsoft.com/mssql/server:2019-latest
+        ports:
+            - "1433:1433"
+        environment:
+            - ACCEPT_EULA=Y
+            - SA_PASSWORD=${CONNECTION_PASSWORD}
+        volumes:
+            - ${GITHUB_WORKSPACE}/olddb:/openfiredb:ro
+            - ./scripts:/scripts:ro
+        entrypoint: [ "/bin/bash", "-c", "/scripts/mssql.sh" ]

build/ci/compose/mysql.yml

@@ -0,0 +1,12 @@
+version: '3.7'
+
+services:
+  db:
+    image: library/mysql:5.7
+    ports:
+      - "3306:3306"
+    environment:
+      - MYSQL_ROOT_PASSWORD=${CONNECTION_PASSWORD}
+      - MYSQL_DATABASE=openfire
+    volumes:
+      - ${GITHUB_WORKSPACE}/olddb:/docker-entrypoint-initdb.d

build/ci/compose/postgresql.yml

@@ -0,0 +1,13 @@
+version: '3.7'
+
+services:
+  db:
+    image: library/postgres:9.6.17-alpine
+    ports:
+      - "5432:5432"
+    environment:
+      - POSTGRES_DB=openfire
+      - POSTGRES_USER=${CONNECTION_USERNAME}
+      - POSTGRES_PASSWORD=${CONNECTION_PASSWORD}
+    volumes:
+      - ${GITHUB_WORKSPACE}/olddb:/docker-entrypoint-initdb.d

build/ci/compose/scripts/mssql.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+/opt/mssql/bin/sqlservr &
+/scripts/wait-for-it.sh 127.0.0.1:1433
+
+for i in {1..50};
+do
+    /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P $SA_PASSWORD -d master -Q "CREATE DATABASE openfire;"
+    /opt/mssql-tools/bin/sqlcmd -S localhost -U sa -P $SA_PASSWORD -d openfire -i /openfiredb/openfire_sqlserver.sql
+    if [ $? -eq 0 ]
+    then
+        echo "openfire sql import"
+        break
+    else
+        echo "not ready yet..."
+        sleep 1
+    fi
+done
+
+sleep infinity # Keep the container running forever

build/ci/compose/scripts/wait-for-it.sh

@@ -0,0 +1,184 @@
+#!/usr/bin/env bash
+# Use this script to test if a given TCP host/port are available
+
+#Source: https://github.com/vishnubob/wait-for-it/blob/81b1373f17855a4dc21156cfe1694c31d7d1792e/wait-for-it.sh
+
+WAITFORIT_cmdname=${0##*/}
+
+echoerr() { if [[ $WAITFORIT_QUIET -ne 1 ]]; then echo "$@" 1>&2; fi }
+
+usage()
+{
+    cat << USAGE >&2
+Usage:
+    $WAITFORIT_cmdname host:port [-s] [-t timeout] [-- command args]
+    -h HOST | --host=HOST       Host or IP under test
+    -p PORT | --port=PORT       TCP port under test
+                                Alternatively, you specify the host and port as host:port
+    -s | --strict               Only execute subcommand if the test succeeds
+    -q | --quiet                Don't output any status messages
+    -t TIMEOUT | --timeout=TIMEOUT
+                                Timeout in seconds, zero for no timeout
+    -- COMMAND ARGS             Execute command with args after the test finishes
+USAGE
+    exit 1
+}
+
+wait_for()
+{
+    if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
+        echoerr "$WAITFORIT_cmdname: waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
+    else
+        echoerr "$WAITFORIT_cmdname: waiting for $WAITFORIT_HOST:$WAITFORIT_PORT without a timeout"
+    fi
+    WAITFORIT_start_ts=$(date +%s)
+    while :
+    do
+        if [[ $WAITFORIT_ISBUSY -eq 1 ]]; then
+            nc -z $WAITFORIT_HOST $WAITFORIT_PORT
+            WAITFORIT_result=$?
+        else
+            (echo -n > /dev/tcp/$WAITFORIT_HOST/$WAITFORIT_PORT) >/dev/null 2>&1
+            WAITFORIT_result=$?
+        fi
+        if [[ $WAITFORIT_result -eq 0 ]]; then
+            WAITFORIT_end_ts=$(date +%s)
+            echoerr "$WAITFORIT_cmdname: $WAITFORIT_HOST:$WAITFORIT_PORT is available after $((WAITFORIT_end_ts - WAITFORIT_start_ts)) seconds"
+            break
+        fi
+        sleep 1
+    done
+    return $WAITFORIT_result
+}
+
+wait_for_wrapper()
+{
+    # In order to support SIGINT during timeout: http://unix.stackexchange.com/a/57692
+    if [[ $WAITFORIT_QUIET -eq 1 ]]; then
+        timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --quiet --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
+    else
+        timeout $WAITFORIT_BUSYTIMEFLAG $WAITFORIT_TIMEOUT $0 --child --host=$WAITFORIT_HOST --port=$WAITFORIT_PORT --timeout=$WAITFORIT_TIMEOUT &
+    fi
+    WAITFORIT_PID=$!
+    trap "kill -INT -$WAITFORIT_PID" INT
+    wait $WAITFORIT_PID
+    WAITFORIT_RESULT=$?
+    if [[ $WAITFORIT_RESULT -ne 0 ]]; then
+        echoerr "$WAITFORIT_cmdname: timeout occurred after waiting $WAITFORIT_TIMEOUT seconds for $WAITFORIT_HOST:$WAITFORIT_PORT"
+    fi
+    return $WAITFORIT_RESULT
+}
+
+# process arguments
+while [[ $# -gt 0 ]]
+do
+    case "$1" in
+        *:* )
+        WAITFORIT_hostport=(${1//:/ })
+        WAITFORIT_HOST=${WAITFORIT_hostport[0]}
+        WAITFORIT_PORT=${WAITFORIT_hostport[1]}
+        shift 1
+        ;;
+        --child)
+        WAITFORIT_CHILD=1
+        shift 1
+        ;;
+        -q | --quiet)
+        WAITFORIT_QUIET=1
+        shift 1
+        ;;
+        -s | --strict)
+        WAITFORIT_STRICT=1
+        shift 1
+        ;;
+        -h)
+        WAITFORIT_HOST="$2"
+        if [[ $WAITFORIT_HOST == "" ]]; then break; fi
+        shift 2
+        ;;
+        --host=*)
+        WAITFORIT_HOST="${1#*=}"
+        shift 1
+        ;;
+        -p)
+        WAITFORIT_PORT="$2"
+        if [[ $WAITFORIT_PORT == "" ]]; then break; fi
+        shift 2
+        ;;
+        --port=*)
+        WAITFORIT_PORT="${1#*=}"
+        shift 1
+        ;;
+        -t)
+        WAITFORIT_TIMEOUT="$2"
+        if [[ $WAITFORIT_TIMEOUT == "" ]]; then break; fi
+        shift 2
+        ;;
+        --timeout=*)
+        WAITFORIT_TIMEOUT="${1#*=}"
+        shift 1
+        ;;
+        --)
+        shift
+        WAITFORIT_CLI=("$@")
+        break
+        ;;
+        --help)
+        usage
+        ;;
+        *)
+        echoerr "Unknown argument: $1"
+        usage
+        ;;
+    esac
+done
+
+if [[ "$WAITFORIT_HOST" == "" || "$WAITFORIT_PORT" == "" ]]; then
+    echoerr "Error: you need to provide a host and port to test."
+    usage
+fi
+
+WAITFORIT_TIMEOUT=${WAITFORIT_TIMEOUT:-15}
+WAITFORIT_STRICT=${WAITFORIT_STRICT:-0}
+WAITFORIT_CHILD=${WAITFORIT_CHILD:-0}
+WAITFORIT_QUIET=${WAITFORIT_QUIET:-0}
+
+# Check to see if timeout is from busybox?
+WAITFORIT_TIMEOUT_PATH=$(type -p timeout)
+WAITFORIT_TIMEOUT_PATH=$(realpath $WAITFORIT_TIMEOUT_PATH 2>/dev/null || readlink -f $WAITFORIT_TIMEOUT_PATH)
+
+WAITFORIT_BUSYTIMEFLAG=""
+if [[ $WAITFORIT_TIMEOUT_PATH =~ "busybox" ]]; then
+    WAITFORIT_ISBUSY=1
+    # Check if busybox timeout uses -t flag
+    # (recent Alpine versions don't support -t anymore)
+    if timeout &>/dev/stdout | grep -q -e '-t '; then
+        WAITFORIT_BUSYTIMEFLAG="-t"
+    fi
+else
+    WAITFORIT_ISBUSY=0
+fi
+
+if [[ $WAITFORIT_CHILD -gt 0 ]]; then
+    wait_for
+    WAITFORIT_RESULT=$?
+    exit $WAITFORIT_RESULT
+else
+    if [[ $WAITFORIT_TIMEOUT -gt 0 ]]; then
+        wait_for_wrapper
+        WAITFORIT_RESULT=$?
+    else
+        wait_for
+        WAITFORIT_RESULT=$?
+    fi
+fi
+
+if [[ $WAITFORIT_CLI != "" ]]; then
+    if [[ $WAITFORIT_RESULT -ne 0 && $WAITFORIT_STRICT -eq 1 ]]; then
+        echoerr "$WAITFORIT_cmdname: strict mode, refusing to execute subprocess"
+        exit $WAITFORIT_RESULT
+    fi
+    exec "${WAITFORIT_CLI[@]}"
+else
+    exit $WAITFORIT_RESULT
+fi

build/ci/updater/README.md

@@ -0,0 +1,12 @@
+# Update Runner
+
+Uses Openfire's update strategy to test running updates.
+
+Designed to be used on test databases to prove that recent updates can & will apply.
+
+## Build
+
+* From the root, `mvn install` Openfire
+* Set up properties for the Update Runner by executing `export OPENFIREVSN=$(mvn help:evaluate -Dexpression=project.version -q -DforceStdout)`
+* Run the Update Runner with `java -jar ./target/updaterunner-1.0.0-jar-with-dependencies.jar`
+