diff --git a/README.md b/README.md index c415c295634db4b88fa7891a07ce3e6722217f55..64e4477445b752718dc38c7e5bc036111163f05d 100644 --- a/README.md +++ b/README.md @@ -4,6 +4,12 @@ Start the server: # cd src/myaktion && go run main.go +## Build, Start and Stop service using Docker Compose + + # docker compose build + # docker compose up + # docker compose down + ## Use the REST API ### Add a campaign diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000000000000000000000000000000000000..2f48889d803edc4f1d12617a7667d21312def625 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,13 @@ +services: + myaktion: + build: ./src/myaktion + ports: + - "8000:8000" + environment: + - DB_CONNECT=mariadb:3306 + - LOG_LEVEL=info + mariadb: + image: mariadb:10.5 + environment: + - MYSQL_ROOT_PASSWORD=root + - MYSQL_DATABASE=myaktion \ No newline at end of file diff --git a/scripts/start-mariadb.sh b/scripts/start-mariadb.sh deleted file mode 100755 index 6d604cf32dbb09080270c17daff6d6abe3f680f0..0000000000000000000000000000000000000000 --- a/scripts/start-mariadb.sh +++ /dev/null @@ -1,2 +0,0 @@ -#!/usr/bin/env bash -docker run -p 3306:3306 --name database -e MYSQL_ROOT_PASSWORD=root -e MYSQL_DATABASE=myaktion mariadb:10.5 diff --git a/scripts/stop-mariadb.sh b/scripts/stop-mariadb.sh deleted file mode 100755 index 127f5969734955897c2b41d7d77f94ca029bd38a..0000000000000000000000000000000000000000 --- a/scripts/stop-mariadb.sh +++ /dev/null @@ -1,2 +0,0 @@ -#!/usr/bin/env bash -docker kill database && docker rm database diff --git a/src/myaktion/Dockerfile b/src/myaktion/Dockerfile new file mode 100644 index 0000000000000000000000000000000000000000..4a7fcaa02cafd447b229904362eb2b53ff55f477 --- /dev/null +++ b/src/myaktion/Dockerfile @@ -0,0 +1,9 @@ +FROM golang:1.20-buster +WORKDIR /go/src/app +COPY . . +RUN go mod download +RUN go install +RUN chmod +x ./wait-for-it.sh ./docker-entrypoint.sh +ENTRYPOINT ["./docker-entrypoint.sh"] +CMD ["myaktion"] +EXPOSE 8000 \ No newline at end of file diff --git a/src/myaktion/db/db.go b/src/myaktion/db/db.go index 2321e4c8cc74f307e2b91d906d8fc84b82547ae2..9a60da79e576937f1afd9e8f015718615f1c2a2f 100644 --- a/src/myaktion/db/db.go +++ b/src/myaktion/db/db.go @@ -12,7 +12,7 @@ import ( var DB *gorm.DB -func init() { +func Init() { dsn := fmt.Sprintf("root:root@tcp(%s)/myaktion?charset=utf8&parseTime=True&loc=Local", os.Getenv("DB_CONNECT")) log.Info("Using DSN for DB:", dsn) var err error diff --git a/src/myaktion/docker-entrypoint.sh b/src/myaktion/docker-entrypoint.sh new file mode 100644 index 0000000000000000000000000000000000000000..c3ab7f554d8e5e396c18bb012c5b77d3d531f30c --- /dev/null +++ b/src/myaktion/docker-entrypoint.sh @@ -0,0 +1,11 @@ +#!/bin/sh + +set -e + +# Wait for DB +if [ -n "$DB_CONNECT" ]; then + /go/src/app/wait-for-it.sh "$DB_CONNECT" -t 20 +fi + +# Run the main container command. +exec "$@" \ No newline at end of file diff --git a/src/myaktion/main.go b/src/myaktion/main.go index 9d36f99e604dfa5ec2901b88ff20393e46726054..59d665033debbf6cae554d12914b841cca1aae08 100644 --- a/src/myaktion/main.go +++ b/src/myaktion/main.go @@ -9,10 +9,13 @@ import ( "net/http" "github.com/gorilla/mux" + "gitlab.reutlingen-university.de/go-exercises/myaktion-go/src/myaktion/db" "gitlab.reutlingen-university.de/go-exercises/myaktion-go/src/myaktion/handler" ) func init() { + //ensure that logger is initialized before connecting to DB + defer db.Init() // init logger log.SetFormatter(&log.TextFormatter{}) log.SetReportCaller(true) diff --git a/src/myaktion/wait-for-it.sh b/src/myaktion/wait-for-it.sh new file mode 100644 index 0000000000000000000000000000000000000000..3974640b053e6f84a21c292c01e3674348445831 --- /dev/null +++ b/src/myaktion/wait-for-it.sh @@ -0,0 +1,182 @@ +#!/usr/bin/env bash +# Use this script to test if a given TCP host/port are available + +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 \ No newline at end of file