From 45c5ca989e6acb67614a0c470acc8a9f614240de Mon Sep 17 00:00:00 2001 From: Seth Damiani Date: Sat, 12 Dec 2020 21:07:16 -0500 Subject: [PATCH] Docker additions/modifications --- .gitignore | 1 + Dockerfile | 9 +++ db_init.sql | 2 + docker-compose.yml | 43 +++++++++++ qa327/__init__.py | 3 + qa327/__main__.py | 4 +- requirements.txt | 3 +- wait-for-it.sh | 182 +++++++++++++++++++++++++++++++++++++++++++++ 8 files changed, 244 insertions(+), 3 deletions(-) create mode 100644 Dockerfile create mode 100644 db_init.sql create mode 100644 docker-compose.yml create mode 100644 wait-for-it.sh diff --git a/.gitignore b/.gitignore index c7dad6c..19b1540 100644 --- a/.gitignore +++ b/.gitignore @@ -111,3 +111,4 @@ latest_logs db.sqlite ~$tailed Test Plan.docx ~WRL0005.tmp +mysql_data diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..b2c0c14 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,9 @@ +FROM python:3.8-slim +RUN mkdir /app +WORKDIR /app +ADD requirements.txt /app +RUN pip3 install -r requirements.txt +ADD . /app +ADD wait-for-it.sh /app +RUN chmod +x /app/wait-for-it.sh +EXPOSE 8081 diff --git a/db_init.sql b/db_init.sql new file mode 100644 index 0000000..671c972 --- /dev/null +++ b/db_init.sql @@ -0,0 +1,2 @@ +-- create the databases +CREATE DATABASE IF NOT EXISTS qa327; diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..73bb72b --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,43 @@ +version: "2" +services: + seetgeek-web: + image: chadcipython/chad-ci-python:v1 + depends_on: + - seetgeek-db + links: + - seetgeek-db + ports: + - "8081:8081" + environment: + - db_string=mysql+pymysql://root:root@seetgeek-db/qa327 + command: ["./wait-for-it.sh", "seetgeek-db:3306", "--strict" , "--timeout=300", "--", "python", "-m", "qa327"] + networks: + - seetgeek-site + + seetgeek-db: + image: mysql:5.7 + environment: + MYSQL_ROOT_PASSWORD: root + command: --init-file /data/application/init.sql + volumes: + - ./mysql_data:/var/lib/mysql + - ./db_init.sql:/data/application/init.sql + networks: + - seetgeek-site + + phpmyadmin: + image: phpmyadmin/phpmyadmin + container_name: pma + depends_on: + - seetgeek-db + environment: + PMA_HOST: seetgeek-db + PMA_ARBITRARY: 1 + restart: always + ports: + - 8082:80 + networks: + - seetgeek-site + +networks: + seetgeek-site: \ No newline at end of file diff --git a/qa327/__init__.py b/qa327/__init__.py index 4ba14ed..e2ba29e 100644 --- a/qa327/__init__.py +++ b/qa327/__init__.py @@ -22,8 +22,11 @@ # for windows user, C:\ is the root directory, so it # should not be included. e.g. Users/xxx/Document/db.sqlite db_name = os.getenv('DB_NAME') +db_string = os.getenv('db_string') if db_name: database_url = "sqlite:////" + db_name +elif db_string: + database_url = db_string else: # default: # db.sqlite at the working directory diff --git a/qa327/__main__.py b/qa327/__main__.py index df55d03..eff94f6 100644 --- a/qa327/__main__.py +++ b/qa327/__main__.py @@ -4,7 +4,7 @@ This file runs the server at a given port """ -FLASK_PORT = 8081 +FLASK_PORT = 8082 if __name__ == "__main__": - app.run(debug=True, port=FLASK_PORT) + app.run(debug=True, port=FLASK_PORT, host='0.0.0.0') diff --git a/requirements.txt b/requirements.txt index b9d74cb..22e2c10 100644 --- a/requirements.txt +++ b/requirements.txt @@ -30,4 +30,5 @@ wrapt==1.11.2 zipp==0.6.0 flask-pytest -seleniumbase \ No newline at end of file +seleniumbase +pymysql diff --git a/wait-for-it.sh b/wait-for-it.sh new file mode 100644 index 0000000..d990e0d --- /dev/null +++ b/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