[T279538.3] Add example docker compose yml (#117)

* Add example docker compose yml

Author: toban

.env

@@ -1,6 +1,6 @@
 WIKIBASE_BRANCH_NAME=master
 MEDIAWIKI_BRANCH_NAME=master
-QUERYSERVICE_VERSION=0.3.40
+WDQS_VERSION=0.3.40
 
 MEDIAWIKI_MAJOR_VERSION=1.36
 MEDIAWIKI_VERSION=1.36.0

.github/workflows/built_and_test.yml

@@ -265,7 +265,7 @@ jobs:
           if-no-files-found: error
           path: artifacts/quickstatements.docker.tar.gz
 
-  build_queryservice:
+  build_wdqs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -278,17 +278,17 @@ jobs:
         with:
           env-file: ${{ env.env_file }}
 
-      - name: Cache queryservice service tar
+      - name: Cache wdqs service tar
         uses: actions/cache@v2
         env:
           cache-name: cache-wdqs-backend-git-repo
         with:
           path: cache
           key: cache-wdqs-backend-git-repo
 
-      - name: Build QueryService Image 
+      - name: Build WDQS Image 
         id: download_step
-        run: bash build.sh queryservice ${{ env.env_file }}
+        run: bash build.sh wdqs ${{ env.env_file }}
 
       - name: Login to GitHub Container Registry
         uses: docker/login-action@v1
@@ -301,13 +301,13 @@ jobs:
         if: github.ref == 'refs/heads/main'
         uses: wmde/tag-push-ghcr-action@v3
         with:
-          image_name: ${{ env.QUERYSERVICE_IMAGE_NAME }}
+          image_name: ${{ env.WDQS_IMAGE_NAME }}
           tag: latest
 
       - name: Store workflow id image on GHCR
         uses: wmde/tag-push-ghcr-action@v3
         with:
-          image_name: ${{ env.QUERYSERVICE_IMAGE_NAME }}
+          image_name: ${{ env.WDQS_IMAGE_NAME }}
           tag: ${{ github.run_id }}
 
       - name: Archive docker production artifacts
@@ -335,7 +335,7 @@ jobs:
           if-no-files-found: error
           path: artifacts/wdqs-proxy.docker.tar.gz
 
-  build_queryservice_ui:
+  build_wdqs_frontend:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
@@ -356,15 +356,15 @@ jobs:
           path: git_cache
           key: cache-wdqs-frontend-git-repo
 
-      - name: Build QueryService UI
-        run: bash build.sh queryservice-ui ${{ env.env_file }}
+      - name: Build WDQS-frontend
+        run: bash build.sh wdqs-frontend ${{ env.env_file }}
 
       - name: Archive metadata artifacts
         uses: actions/upload-artifact@v2
         with:
           name: BuildMetadata
           if-no-files-found: error
-          path: artifacts/build_metadata_wdqs_ui.env
+          path: artifacts/build_metadata_wdqs_frontend.env
 
       - name: Archive tar production artifacts
         uses: actions/upload-artifact@v2
@@ -391,13 +391,13 @@ jobs:
         if: github.ref == 'refs/heads/main'
         uses: wmde/tag-push-ghcr-action@v3
         with:
-          image_name: ${{ env.QUERYSERVICE_UI_IMAGE_NAME }}
+          image_name: ${{ env.WDQS_FRONTEND_IMAGE_NAME }}
           tag: latest
 
       - name: Store workflow id image on GHCR
         uses: wmde/tag-push-ghcr-action@v3
         with:
-          image_name: ${{ env.QUERYSERVICE_UI_IMAGE_NAME }}
+          image_name: ${{ env.WDQS_FRONTEND_IMAGE_NAME }}
           tag: ${{ github.run_id }}
 
   build_elasticsearch:
@@ -451,9 +451,9 @@ jobs:
         databaseImageName: [ 'mysql:5.6', 'mariadb:10.3' ]
     needs:
       - build_wikibase_bundle
-      - build_queryservice
+      - build_wdqs
       - build_elasticsearch
-      - build_queryservice_ui
+      - build_wdqs_frontend
       - build_wdqs_proxy
       - build_quickstatements
     runs-on: ubuntu-latest

.gitignore

@@ -9,7 +9,7 @@ Wikibase.tar.gz
 
 Docker/build/Wikibase/artifacts
 
-Docker/build/QueryService/wait-for-it.sh
+Docker/build/WDQS/wait-for-it.sh
 
 #temp 
 Docker/**/*.tar.gz

Docker/build/QueryServiceUI/Dockerfile renamed to Docker/build/WDQS-frontend/Dockerfile

@@ -0,0 +1,176 @@
+#!/usr/bin/env bash
+# Use this script to test if a given TCP host/port are available
+# shellcheck disable=SC2064,SC2086,SC2206,SC2124,SC2230,SC2046
+cmdname=$(basename $0)
+
+echoerr() { if [[ $QUIET -ne 1 ]]; then echo "$@" 1>&2; fi }
+
+usage()
+{
+    cat << USAGE >&2
+Usage:
+    $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 [[ $TIMEOUT -gt 0 ]]; then
+        echoerr "$cmdname: waiting $TIMEOUT seconds for $HOST:$PORT"
+    else
+        echoerr "$cmdname: waiting for $HOST:$PORT without a timeout"
+    fi
+    start_ts=$(date +%s)
+    while :
+    do
+        if [[ $ISBUSY -eq 1 ]]; then
+            nc -z $HOST $PORT
+            result=$?
+        else
+            (echo > /dev/tcp/$HOST/$PORT) >/dev/null 2>&1
+            result=$?
+        fi
+        if [[ $result -eq 0 ]]; then
+            end_ts=$(date +%s)
+            echoerr "$cmdname: $HOST:$PORT is available after $((end_ts - start_ts)) seconds"
+            break
+        fi
+        sleep 1
+    done
+    return $result
+}
+
+wait_for_wrapper()
+{
+    # In order to support SIGINT during timeout: http://unix.stackexchange.com/a/57692
+    if [[ $QUIET -eq 1 ]]; then
+        timeout $BUSYTIMEFLAG $TIMEOUT $0 --quiet --child --host=$HOST --port=$PORT --timeout=$TIMEOUT &
+    else
+        timeout $BUSYTIMEFLAG $TIMEOUT $0 --child --host=$HOST --port=$PORT --timeout=$TIMEOUT &
+    fi
+    PID=$!
+    trap "kill -INT -$PID" INT
+    wait $PID
+    RESULT=$?
+    if [[ $RESULT -ne 0 ]]; then
+        echoerr "$cmdname: timeout occurred after waiting $TIMEOUT seconds for $HOST:$PORT"
+    fi
+    return $RESULT
+}
+
+# process arguments
+while [[ $# -gt 0 ]]
+do
+    case "$1" in
+        *:* )
+        hostport=(${1//:/ })
+        HOST=${hostport[0]}
+        PORT=${hostport[1]}
+        shift 1
+        ;;
+        --child)
+        CHILD=1
+        shift 1
+        ;;
+        -q | --quiet)
+        QUIET=1
+        shift 1
+        ;;
+        -s | --strict)
+        STRICT=1
+        shift 1
+        ;;
+        -h)
+        HOST="$2"
+        if [[ $HOST == "" ]]; then break; fi
+        shift 2
+        ;;
+        --host=*)
+        HOST="${1#*=}"
+        shift 1
+        ;;
+        -p)
+        PORT="$2"
+        if [[ $PORT == "" ]]; then break; fi
+        shift 2
+        ;;
+        --port=*)
+        PORT="${1#*=}"
+        shift 1
+        ;;
+        -t)
+        TIMEOUT="$2"
+        if [[ $TIMEOUT == "" ]]; then break; fi
+        shift 2
+        ;;
+        --timeout=*)
+        TIMEOUT="${1#*=}"
+        shift 1
+        ;;
+        --)
+        shift
+        CLI="$@"
+        break
+        ;;
+        --help)
+        usage
+        ;;
+        *)
+        echoerr "Unknown argument: $1"
+        usage
+        ;;
+    esac
+done
+
+if [[ "$HOST" == "" || "$PORT" == "" ]]; then
+    echoerr "Error: you need to provide a host and port to test."
+    usage
+fi
+
+TIMEOUT=${TIMEOUT:-15}
+STRICT=${STRICT:-0}
+CHILD=${CHILD:-0}
+QUIET=${QUIET:-0}
+
+# check to see if timeout is from busybox?
+TIMEOUT_PATH=$(realpath $(which timeout))
+if [[ $TIMEOUT_PATH =~ "busybox" ]]; then
+        ISBUSY=1
+        BUSYTIMEFLAG="-t"
+else
+        ISBUSY=0
+        BUSYTIMEFLAG=""
+fi
+
+if [[ $CHILD -gt 0 ]]; then
+    wait_for
+    RESULT=$?
+    exit $RESULT
+else
+    if [[ $TIMEOUT -gt 0 ]]; then
+        wait_for_wrapper
+        RESULT=$?
+    else
+        wait_for
+        RESULT=$?
+    fi
+fi
+
+if [[ $CLI != "" ]]; then
+    if [[ $RESULT -ne 0 && $STRICT -eq 1 ]]; then
+        echoerr "$cmdname: strict mode, refusing to execute subprocess"
+        exit $RESULT
+    fi
+    exec $CLI
+else
+    exit $RESULT
+fi

Docker/build/QueryServiceUI/custom-config.json renamed to Docker/build/WDQS-frontend/custom-config.json

@@ -33,8 +33,8 @@ function echo_tag {
 # tag and push Wikibase
 echo_tag "$METADATA_WIKIBASE_COMMIT_HASH" "Wikibase"
 
-# tag and push queryservice ui
-echo_tag "$METADATA_WDQS_UI_COMMIT_HASH" "Queryservice UI"
+# tag and push wdqs-frontend
+echo_tag "$METADATA_WDQS_UI_COMMIT_HASH" "WDQS frontend"
 
 # tag and push WikibaseManifest
 echo_tag "$METADATA_WIKIBASEMANIFEST_COMMIT_HASH" "Wikibase Manifest"

Docker/build/QueryServiceUI/default.conf renamed to Docker/build/WDQS-frontend/default.conf

@@ -1,25 +1,25 @@
 #!/bin/bash
 set -e
 
-if [ -z "$QUERYSERVICE_BACKEND_DOCKER_PATH" ] || \
-[ -z "$QUERYSERVICE_FRONTEND_DOCKER_PATH" ] || \
+if [ -z "$WDQS_DOCKER_PATH" ] || \
+[ -z "$WDQS_FRONTEND_DOCKER_PATH" ] || \
 [ -z "$WIKIBASE_DOCKER_PATH" ] || \
 [ -z "$WIKIBASE_BUNDLE_DOCKER_PATH" ] || \
 [ -z "$ELASTICSEARCH_DOCKER_PATH" ] || \
 [ -z "$QUICKSTATEMENTS_DOCKER_PATH" ] || \
 [ -z "$WDQS_PROXY_DOCKER_PATH" ] || \
 \
+[ -z "$WDQS_FRONTEND_IMAGE_NAME" ] || \
+[ -z "$WDQS_IMAGE_NAME" ] || \
 [ -z "$WDQS_PROXY_IMAGE_NAME" ] || \
-[ -z "$QUERYSERVICE_UI_IMAGE_NAME" ] || \
-[ -z "$QUERYSERVICE_IMAGE_NAME" ] || \
 [ -z "$WIKIBASE_IMAGE_NAME" ] || \
 [ -z "$WIKIBASE_BUNDLE_IMAGE_NAME" ] || \
 [ -z "$ELASTICSEARCH_IMAGE_NAME" ] || \
 [ -z "$QUICKSTATEMENTS_IMAGE_NAME" ] || \
 \
 [ -z "$RELEASE_VERSION" ] || \
 [ -z "$WMDE_RELEASE_VERSION" ] || \
-[ -z "$QUERYSERVICE_VERSION" ] || \
+[ -z "$WDQS_VERSION" ] || \
 [ -z "$ELASTICSEARCH_VERSION" ] || \
 \
 [ -z "$DOCKER_HUB_ID" ] || \
@@ -59,20 +59,20 @@ echo "$DOCKER_HUB_ACCESS_TOKEN" | docker login --username "$DOCKER_HUB_ID" --pas
 # load images
 docker load -i "$WIKIBASE_DOCKER_PATH"
 docker load -i "$WIKIBASE_BUNDLE_DOCKER_PATH"
-docker load -i "$QUERYSERVICE_BACKEND_DOCKER_PATH"
-docker load -i "$QUERYSERVICE_FRONTEND_DOCKER_PATH"
+docker load -i "$WDQS_DOCKER_PATH"
+docker load -i "$WDQS_FRONTEND_DOCKER_PATH"
 docker load -i "$ELASTICSEARCH_DOCKER_PATH"
 docker load -i "$QUICKSTATEMENTS_DOCKER_PATH"
 docker load -i "$WDQS_PROXY_DOCKER_PATH"
 
 # Tag Queryservice Proxy with version
 tag_and_push "$WDQS_PROXY_IMAGE_NAME" "$WMDE_RELEASE_VERSION"
 
-# Tag Queryservice UI with version
-tag_and_push "$QUERYSERVICE_UI_IMAGE_NAME" "$WMDE_RELEASE_VERSION"
+# Tag WDQS-frontend with version
+tag_and_push "$WDQS_FRONTEND_IMAGE_NAME" "$WMDE_RELEASE_VERSION"
 
-# Tag Queryservice with version
-tag_and_push "$QUERYSERVICE_IMAGE_NAME" "$QUERYSERVICE_VERSION-$WMDE_RELEASE_VERSION"
+# Tag WDQS with version
+tag_and_push "$WDQS_IMAGE_NAME" "$WDQS_VERSION-$WMDE_RELEASE_VERSION"
 
 # Tag Wikibase with version
 tag_and_push "$WIKIBASE_IMAGE_NAME" "$RELEASE_VERSION-$WMDE_RELEASE_VERSION"

Docker/build/QueryServiceUI/entrypoint.sh renamed to Docker/build/WDQS-frontend/entrypoint.sh

@@ -20,6 +20,6 @@ check_if_up() {
 
 check_if_up "$WIKIBASE_SERVER" "/wiki/Main_Page"
 
-check_if_up "$QUERYSERVICE_SERVER" "/bigdata/namespace/wdq/sparql"
+check_if_up "$WDQS_SERVER" "/bigdata/namespace/wdq/sparql"
 
-check_if_up "$QUERYSERVICE_UI_SERVER" "/"
+check_if_up "$WDQS_FRONTEND_SERVER" "/"

Docker/build/QueryService/Dockerfile renamed to Docker/build/WDQS/Dockerfile

@@ -9,7 +9,7 @@
   - [ ] add a statement
   - [ ] add a qualifier
   - [ ] add a reference
-## Wikibase & QueryService/QueryService UI
+## Wikibase & WDQS/WDQS-frontend
 - [x] Create an item on Wikibase, and verify it can be found on Query Service (including the label etc)
 - [x] Delete an item on Wikibase, and verify that the item isn’t there on the query service any more
 - [x] Create an item with a statement and verify that querying using prefixes work correctly (wdt:P1 etc.. )
@@ -30,7 +30,7 @@
 ## Wikibase Federated properties (using wikidata.org as source wiki)
 - [X] Create an item on Wikibase and add a statement using a federated property
   - [X] verify it is available with the correct rdf through the Entity page
-  - [X] verify it is available through the QueryService with the correct prefixes
+  - [X] verify it is available through the WDQS-frontend with the correct prefixes
 
 ## Elasticsearch
 - [X] Create item with an alias and search by item alias