api-client/run_dev.sh at master · TeselaGen/api-client · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
#!/bin/bash

# This script is recommended for running the docker container (in DEVELOPMENT mode).

# It can be executed without arguments.
#       bash run.sh

# Alternatively, default values can be overridden by passing their new values as follows:
#       DOCKER_IMAGE_TAG=v0.0.1 \
#       bash run.sh

# Additionally, an extra argument can be provided with a route to be mounted.
#   Example:
#       bash run_dev.sh ~/Documents/GitHub/ai/Notebooks

set -o pipefail >/dev/null 2>&1 || true # bash specific option to propagate exit codes through pipes
set -o errexit                          # Exit immediately if a command exits with a non-zero status
set -o xtrace                           # Trace the execution of the script (debug mode)

# if [ "$1" == "--dev" ]; then
#     set -o xtrace                       # Trace the execution of the script (debug mode)
# fi

# start with an error if Docker isn't working...
docker version >/dev/null
printf "[$(date)] Docker version: %s\n" "$(docker version --format '{{.Server.Version}}')"

# >>>>>> Command line arguments >>>>>>
# Check if the first command line argument is empty
if
    [ -z "$1" ]
    echo "[$(date)] No additional volume provided."
then
    ADDITIONAL_VOLUME=""
else
    ADDITIONAL_VOLUME="--volume $1:/home/development/Notebooks"
    echo "[$(date)] Additional volume: " "${ADDITIONAL_VOLUME}"
fi
# >>>>>> Command line arguments >>>>>>

# >>>>>> Definitions >>>>>>
# general
CURRENT_DIR="$(pwd -P)"
# PARENT_DIR="$(dirname "$(pwd -P)")"
# image
DOCKER_IMAGE_NAME=${DOCKER_IMAGE_NAME:-'teselagen/python/tgclient'}
DOCKER_IMAGE_TAG=${DOCKER_IMAGE_TAG:-'v0.0.1'}
# container
DOCKER_CONTAINER_NAME=${DOCKER_CONTAINER_NAME:-'tgclient'}
DOCKER_CONTAINER_IPC_MODE=${DOCKER_CONTAINER_IPC_MODE:-'host'}
# ports
#   jupyter notebook
HOST_JUPYTER_NOTEBOOK_PORT=${HOST_JUPYTER_NOTEBOOK_PORT:-'8889'}
CONTAINER_JUPYTER_NOTEBOOK_PORT=${CONTAINER_JUPYTER_NOTEBOOK_PORT:-'8888'}
# volumes
#   shared directory
HOST_DIRPATH_TO_SHARED_FOLDER=${HOST_DIRPATH_TO_SHARED_FOLDER:-"${CURRENT_DIR}"}
CONTAINER_DIRPATH_TO_SHARED_FOLDER=${CONTAINER_DIRPATH_TO_SHARED_FOLDER:-'/home'}
CONTAINER_PARENT_DIRPATH_OF_SETUP_PY=${CONTAINER_PARENT_DIRPATH_OF_SETUP_PY:-'/home/'}
# <<<<<< Definitions <<<<<<

# >>>>>> Run the Docker container >>>>>>
#   ports
#       syntax: --publish HOST:CONTAINER
#   volumes
#       syntax: --volume HOST:CONTAINER
#
# For more info, run : docker run --help
#   --init: Makes process PID=1 be docker-init backed by tini: https://docs.docker.com/engine/reference/run/#specify-an-init-process
#   --security-opt seccomp=unconfined : https://docs.docker.com/engine/reference/run/#seccomp-profile
echo "[$(date)] Running the Docker container ...: ${DOCKER_CONTAINER_NAME}"
docker run \
    --publish "${HOST_JUPYTER_NOTEBOOK_PORT}":"${CONTAINER_JUPYTER_NOTEBOOK_PORT}" \
    --volume "${HOST_DIRPATH_TO_SHARED_FOLDER}":"${CONTAINER_DIRPATH_TO_SHARED_FOLDER}" \
    ${ADDITIONAL_VOLUME} \
    --name "${DOCKER_CONTAINER_NAME}" \
    --detach \
    --init \
    --security-opt=seccomp=unconfined \
    --ipc="${DOCKER_CONTAINER_IPC_MODE}" \
    "${DOCKER_IMAGE_NAME}":"${DOCKER_IMAGE_TAG}"
# <<<<<< Run the Docker container <<<<<<

# >>>>>> Opt out from `vscode` experiments >>>>>>
echo "[$(date)] Opt-out from VSCode Experiments ..."
# docker exec --tty --interactive "${DOCKER_CONTAINER_NAME}" bash -c 'mkdir -p /root/.vscode-server/data/Machine/ && printf "{\n\t\"python.defaultInterpreterPath\": \"/usr/bin/python3\",\n\t\"python.experiments.enabled\": false,\n\t\"jupyter.experiments.enabled\": false\n}\n" > /root/.vscode-server/data/Machine/settings.json && cat /root/.vscode-server/data/Machine/settings.json'
docker exec --tty --interactive "${DOCKER_CONTAINER_NAME}" bash -c 'mkdir -p /root/.vscode-server/data/Machine/ && printf "{\n\t\"python.experiments.enabled\": false,\n\t\"jupyter.experiments.enabled\": false\n}\n" > /root/.vscode-server/data/Machine/settings.json && cat /root/.vscode-server/data/Machine/settings.json'
# <<<<<< Opt out from `vscode` experiments <<<<<<

# >>>>>> Install `teselagen` library in "editable" mode in the container >>>>>>
echo "[$(date)] Installing TeselaGen Library (in editable mode) in the Docker container ...: ${DOCKER_CONTAINER_NAME}"
docker exec "${DOCKER_CONTAINER_NAME}" bash -c "cd ${CONTAINER_PARENT_DIRPATH_OF_SETUP_PY}; python3 setup.py develop"
# <<<<<< Install `teselagen` library in "editable" mode in the container <<<<<<

# >>>>>> Run 'teselagen' Library Tests >>>>>>
# echo "[$(date)] Running TeselaGen Library tests in the Docker container ...: ${DOCKER_CONTAINER_NAME}"
# docker exec --tty --interactive --workdir="${CONTAINER_PARENT_DIRPATH_OF_SETUP_PY}" "${DOCKER_CONTAINER_NAME}" /bin/bash -c 'pytest --maxfail=100 --cov="teselagen" --cov-report term:skip-covered'
# <<<<<< Run 'teselagen' Library Tests <<<<<<

echo "[$(date)] Done."