From 461f4a7e02ec982ab14efd8f98fc9040e4e70077 Mon Sep 17 00:00:00 2001 From: Nicolas Giard Date: Sat, 8 Dec 2018 20:51:55 -0500 Subject: [PATCH] fix: various docker issues --- Makefile | 12 +- dev/build/Dockerfile | 5 +- dev/docker/Dockerfile | 3 +- .../docker/docker-compose.yml | 1 + dev/docker/init.sh | 7 + dev/docker/wait.sh | 178 ++++++++++++++++++ package.json | 8 +- 7 files changed, 201 insertions(+), 13 deletions(-) rename docker-compose.yml => dev/docker/docker-compose.yml (94%) create mode 100644 dev/docker/init.sh create mode 100644 dev/docker/wait.sh diff --git a/Makefile b/Makefile index 8ae711c4..b18fecc0 100644 --- a/Makefile +++ b/Makefile @@ -23,18 +23,18 @@ test: ## Run code linting tests pug-lint server/views && jest docker-dev-up: ## Run dockerized dev environment - docker-compose up -d - docker-compose exec wiki yarn dev + docker-compose -f ./dev/docker/docker-compose.yml -p wiki --project-directory . up -d + docker-compose -f ./dev/docker/docker-compose.yml -p wiki --project-directory . exec wiki yarn dev docker-dev-down: ## Shutdown dockerized dev environment - docker-compose down + docker-compose -f ./dev/docker/docker-compose.yml -p wiki --project-directory . down docker-dev-rebuild: ## Rebuild dockerized dev image - docker-compose build + docker-compose -f ./dev/docker/docker-compose.yml -p wiki --project-directory . build --no-cache --force-rm docker-build: ## Run assets generation build in docker - docker-compose run wiki yarn build - docker-compose down + docker-compose -f ./dev/docker/docker-compose.yml -p wiki --project-directory . run wiki yarn build + docker-compose -f ./dev/docker/docker-compose.yml -p wiki --project-directory . down help: ## Display help @echo '' diff --git a/dev/build/Dockerfile b/dev/build/Dockerfile index abd54a25..37c58cee 100644 --- a/dev/build/Dockerfile +++ b/dev/build/Dockerfile @@ -1,7 +1,7 @@ # ==================== # --- Build Assets --- # ==================== -FROM node:10-alpine AS assets +FROM node:10.14-alpine AS assets RUN apk update && \ apk add yarn g++ make python --no-cache && \ @@ -25,7 +25,7 @@ RUN yarn --production # =============== # --- Release --- # =============== -FROM node:10-alpine +FROM node:10.14-alpine LABEL maintainer="requarks.io" RUN apk update && \ @@ -42,6 +42,7 @@ COPY --from=assets /var/wiki/node_modules ./node_modules COPY ./server ./server COPY --from=assets /var/wiki/server/views ./server/views COPY ./dev/build/config.yml ./config.yml +COPY ./dev/docker/wait.sh ./wait.sh COPY ./package.json ./package.json COPY ./LICENSE ./LICENSE diff --git a/dev/docker/Dockerfile b/dev/docker/Dockerfile index 70706736..2ec469c4 100644 --- a/dev/docker/Dockerfile +++ b/dev/docker/Dockerfile @@ -1,7 +1,7 @@ # -- DEV DOCKERFILE -- # -- DO NOT USE IN PRODUCTION! -- -FROM node:10-alpine +FROM node:10.14-alpine LABEL maintainer "requarks.io" RUN apk update && \ @@ -11,6 +11,7 @@ RUN apk update && \ WORKDIR /var/wiki COPY package.json . RUN yarn --silent +COPY ./dev/docker/init.sh ./init.sh ENV dockerdev 1 diff --git a/docker-compose.yml b/dev/docker/docker-compose.yml similarity index 94% rename from docker-compose.yml rename to dev/docker/docker-compose.yml index 6439372a..e116e448 100644 --- a/docker-compose.yml +++ b/dev/docker/docker-compose.yml @@ -42,6 +42,7 @@ services: volumes: - .:/var/wiki - /var/wiki/node_modules + command: ["sh", "./dev/docker/init.sh"] networks: wikinet: diff --git a/dev/docker/init.sh b/dev/docker/init.sh new file mode 100644 index 00000000..7634bad8 --- /dev/null +++ b/dev/docker/init.sh @@ -0,0 +1,7 @@ +#!/bin/sh + +echo "Waiting for redis and postgres to start up..." +bash ./dev/docker/wait.sh redis:6379 +bash ./dev/docker/wait.sh db:5432 +echo "=== READY ===" +tail -f /dev/null diff --git a/dev/docker/wait.sh b/dev/docker/wait.sh new file mode 100644 index 00000000..071c2bee --- /dev/null +++ b/dev/docker/wait.sh @@ -0,0 +1,178 @@ +#!/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 > /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) +if [[ $WAITFORIT_TIMEOUT_PATH =~ "busybox" ]]; then + WAITFORIT_ISBUSY=1 + WAITFORIT_BUSYTIMEFLAG="-t" + +else + WAITFORIT_ISBUSY=0 + WAITFORIT_BUSYTIMEFLAG="" +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 diff --git a/package.json b/package.json index 5dfb039c..dbb526fe 100644 --- a/package.json +++ b/package.json @@ -11,10 +11,10 @@ "build": "webpack --profile --config dev/webpack/webpack.prod.js", "watch": "webpack --config dev/webpack/webpack.dev.js", "test": "eslint --format codeframe --ext .js,.vue . && pug-lint server/views && jest", - "docker:dev:up": "docker-compose up -d && docker-compose exec wiki yarn dev", - "docker:dev:down": "docker-compose down", - "docker:dev:rebuild": "docker-compose build", - "docker:build": "docker-compose run wiki yarn build && docker-compose down" + "docker:dev:up": "docker-compose -f ./dev/docker/docker-compose.yml -p wiki --project-directory . up -d && docker-compose -f ./dev/docker/docker-compose.yml -p wiki --project-directory . exec wiki yarn dev", + "docker:dev:down": "docker-compose -f ./dev/docker/docker-compose.yml -p wiki --project-directory . down", + "docker:dev:rebuild": "docker-compose -f ./dev/docker/docker-compose.yml -p wiki --project-directory . build --no-cache --force-rm", + "docker:build": "docker-compose -f ./dev/docker/docker-compose.yml -p wiki --project-directory . run wiki yarn build && docker-compose -f ./dev/docker/docker-compose.yml -p wiki --project-directory . down" }, "bin": { "wiki": "wiki.js"