docker: general improvements

* rename set_env->set_default
* fix bug with return from bash func
* make '--miningaddr' optional

docker/btcd/start-btcctl.sh

@@ -1,32 +1,46 @@
 #!/usr/bin/env bash
 
-# Check env variable and in case of empty value and default value specified
+# exit from script if error was raised.
-# returns default value, in case of non-empty value returns value.
+set -e
-set_env() {
+
+# error function is used within a bash function in order to send the error
+# message directly to the stderr output and exit.
+error() {
+    echo "$1" > /dev/stderr
+    exit 0
+}
+
+# return is used within bash function in order to return the value.
+return() {
+    echo "$1"
+}
+
+# set_default function gives the ability to move the setting of default
+# env variable from docker file to the script thereby giving the ability to the
+# user override it durin container start.
+set_default() {
     # docker initialized env variables with blank string and we can't just
     # use -z flag as usually.
     BLANK_STRING='""'
 
     VARIABLE="$1"
-    NAME="$2"
+    DEFAULT="$2"
-    DEFAULT="$3"
 
     if [[ -z "$VARIABLE" || "$VARIABLE" == "$BLANK_STRING" ]]; then
 
         if [ -z "$DEFAULT" ]; then
-            echo "You should specify '$NAME' env variable"
+            error "You should specify default variable"
-            exit 0
         else
             VARIABLE="$DEFAULT"
         fi
     fi
 
-    # echo is used as return in case if string values
+   return "$VARIABLE"
-    echo "$VARIABLE"
 }
 
-RPCUSER=$(set_env "$RPCUSER" "RPCUSER")
+# Set default variables if needed.
-RPCPASS=$(set_env "$RPCPASS" "RPCPASS")
+RPCUSER=$(set_default "$RPCUSER" "devuser")
+RPCPASS=$(set_default "$RPCPASS" "devpass")
 
 btcctl \
     --simnet \

docker/btcd/start-btcd.sh

@@ -1,47 +1,69 @@
 #!/usr/bin/env bash
 
-# Check env variable and in case of empty value and default value specified
+# exit from script if error was raised.
-# returns default value, in case of non-empty value returns value.
+set -e
-set_env() {
+
+# error function is used within a bash function in order to send the error
+# message directly to the stderr output and exit.
+error() {
+    echo "$1" > /dev/stderr
+    exit 0
+}
+
+# return is used within bash function in order to return the value.
+return() {
+    echo "$1"
+}
+
+# set_default function gives the ability to move the setting of default
+# env variable from docker file to the script thereby giving the ability to the
+# user override it durin container start.
+set_default() {
     # docker initialized env variables with blank string and we can't just
     # use -z flag as usually.
     BLANK_STRING='""'
 
     VARIABLE="$1"
-    NAME="$2"
+    DEFAULT="$2"
-    DEFAULT="$3"
 
     if [[ -z "$VARIABLE" || "$VARIABLE" == "$BLANK_STRING" ]]; then
 
         if [ -z "$DEFAULT" ]; then
-            echo "You should specify '$NAME' env variable"
+            error "You should specify default variable"
-            exit 0
         else
             VARIABLE="$DEFAULT"
         fi
     fi
 
-    # echo is used as return in case if string values
+   return "$VARIABLE"
-    echo "$VARIABLE"
 }
 
-RPCUSER=$(set_env "$RPCUSER" "RPCUSER")
+# Set default variables if needed.
-RPCPASS=$(set_env "$RPCPASS" "RPCPASS")
+RPCUSER=$(set_default "$RPCUSER" "devuser")
+RPCPASS=$(set_default "$RPCPASS" "devpass")
+DEBUG=$(set_default "$DEBUG" "info")
 
-DEBUG=$(set_env "$DEBUG" "DEBUG")
+PARAMS=$(echo \
+    "--simnet" \
+    "--debuglevel=$DEBUG" \
+    "--rpcuser=$RPCUSER" \
+    "--rpcpass=$RPCPASS" \
+    "--datadir=/data" \
+    "--logdir=/data" \
+    "--rpccert=/rpc/rpc.cert" \
+    "--rpckey=/rpc/rpc.key" \
+    "--rpclisten=0.0.0.0"
+)
 
-MINING_ADDRESS=$(set_env "$MINING_ADDRESS" "MINING_ADDRESS" "ScoDuqH7kYA9nvxuRg4Xk7E31AhsSc5zxp")
+# Set the mining flag only if address is non empty.
+if [[ -n "$MINING_ADDRESS" ]]; then
+    PARAMS="$PARAMS --miningaddr=$MINING_ADDRESS"
+fi
 
-btcd \
+# Add user parameters to command.
-    --debuglevel="$DEBUG" \
+PARAMS="$PARAMS $@"
-    --datadir="/data" \
+
-    --logdir="/data" \
+# Print command and start bitcoin node.
-    --simnet \
+echo "Command: btcd $PARAMS"
-    --rpccert="/rpc/rpc.cert" \
+btcd $PARAMS
-    --rpckey="/rpc/rpc.key" \
-    --rpcuser="$RPCUSER" \
-    --rpcpass="$RPCPASS" \
-    --miningaddr="$MINING_ADDRESS" \
-    --rpclisten="0.0.0.0" \
-    "$@"
 

docker/docker-compose.yml

@@ -1,6 +1,9 @@
 version: '2'
 services:
 
+    # btc is an image of bitcoin node which used as base image for btcd and
+    # btccli. The environment variables default values determined on stage of
+    # container start within starting script.
     btc:
       image: btcd
       build:
@@ -8,14 +11,14 @@ services:
       volumes:
             - shared:/rpc
       environment:
-        - RPCUSER="devuser"
+        - RPCUSER
-        - RPCPASS="devpass"
+        - RPCPASS
 
     btcd:
         extends: btc
         container_name: btcd
         environment:
-          - DEBUG="debug"
+          - DEBUG
           - MINING_ADDRESS
         entrypoint: ["./start-btcd.sh"]
 
@@ -32,9 +35,9 @@ services:
           context: ../
           dockerfile: docker/lnd/Dockerfile
         environment:
-          - RPCUSER="devuser"
+          - RPCUSER
-          - RPCPASS="devpass"
+          - RPCPASS
-          - DEBUG="debug"
+          - DEBUG
         volumes:
             - shared:/rpc
         entrypoint: ["./start-lnd.sh"]
@@ -43,14 +46,16 @@ services:
       extends: lnd
       container_name: alice
       links:
-            - btcd
+          - "btcd:btcd"
 
     bob:
       extends: lnd
       container_name: bob
       links:
-            - btcd
+          - "btcd:btcd"
 
 volumes:
+  # shared volume is need to store the btcd rpc certificates and us it within
+  # btcctl and lnd containers.
   shared:
     driver: local

docker/lnd/start-lnd.sh

@@ -1,34 +1,47 @@
 #!/usr/bin/env bash
 
-# Check env variable and in case of empty value and default value specified
+# exit from script if error was raised.
-# returns default value, in case of non-empty value returns value.
+set -e
-set_env() {
+
+# error function is used within a bash function in order to send the error
+# mesage directly to the stderr output and exit.
+error() {
+    echo "$1" > /dev/stderr
+    exit 0
+}
+
+# return is used within bash function in order to return the value.
+return() {
+    echo "$1"
+}
+
+# set_default function gives the ability to move the setting of default
+# env variable from docker file to the script thereby giving the ability to the
+# user override it durin container start.
+set_default() {
     # docker initialized env variables with blank string and we can't just
     # use -z flag as usually.
     BLANK_STRING='""'
 
     VARIABLE="$1"
-    NAME="$2"
+    DEFAULT="$2"
-    DEFAULT="$3"
 
     if [[ -z "$VARIABLE" || "$VARIABLE" == "$BLANK_STRING" ]]; then
 
         if [ -z "$DEFAULT" ]; then
-            echo "You should specify '$NAME' env variable"
+            error "You should specify default variable"
-            exit 0
         else
             VARIABLE="$DEFAULT"
         fi
     fi
 
-    # echo is used as return in case if string values
+   return "$VARIABLE"
-    echo "$VARIABLE"
 }
 
-RPCUSER=$(set_env "$RPCUSER" "RPCUSER")
+# Set default variables if needed.
-RPCPASS=$(set_env "$RPCPASS" "RPCPASS")
+RPCUSER=$(set_default "$RPCUSER" "devuser")
-
+RPCPASS=$(set_default "$RPCPASS" "devpass")
-DEBUG=$(set_env "$DEBUG" "DEBUG")
+DEBUG=$(set_default "$DEBUG" "debug")
 
 lnd \
     --datadir="/data" \