refactoring scripts

Author: Julien Neuhart

.env.template

@@ -2,31 +2,31 @@
 ## CONTAINER NAME PATTERN: ^[a-zA-Z0-9._-]+$
 ## NETWORK PATTERN: ^[a-zA-Z0-9._-]+$
 
-# common
+# [common]
 PROJECT_NAME=yourproject
 ENV=dev
 
-# apache
+# [apache]
 APACHE_SERVICE_NAME=apache
 APACHE_CONTAINER_NAME=${PROJECT_NAME}_${APACHE_SERVICE_NAME}_${ENV}
 APACHE_VIRTUAL_HOST=dev.yourproject.com
 APACHE_ENABLE_XDEBUG=1
 
-# mysql
+# [mysql]
 MYSQL_SERVICE_NAME=mysql
 MYSQL_CONTAINER_NAME=${PROJECT_NAME}_${MYSQL_SERVICE_NAME}_${ENV}
 MYSQL_ROOT_PASSWORD=admin
 MYSQL_DATABASE=database_name
 MYSQL_HOST_PORT_TO_MAP=3307
-MYSQL_ENABLE_PORTS_MAPPING=1
+MYSQL_ENABLE_PORTS_MAPPING=0
 
-# nginx
-NGINX_SERVICE_NAME=nginx
-NGINX_PROXY_NAME=nginx
-NGINX_CONTAINER_NAME=${NGINX_PROXY_NAME}_proxy
-NGINX_CERTS_PATH=/the/path/to/certs
-NGINX_ENABLE_SSL=0
+# [reverse-proxy]
+REVERSE_PROXY_SERVICE_NAME=nginx
+REVERSE_PROXY_NAME=nginx
+REVERSE_PROXY_CONTAINER_NAME=${REVERSE_PROXY_NAME}_reverse_proxy
+REVERSE_PROXY_CERTS_PATH=/the/path/to/certs
+REVERSE_PROXY_ENABLE_SSL=0
 
-# networks
+# [networks]
 BASE_NETWORK=scope_${ENV}
-PROXY_NETWORK=scope_proxy
+REVERSE_PROXY_NETWORK=scope_reverse_proxy

.gitignore

@@ -7,4 +7,4 @@
 /mysql/volume
 .env
 docker-compose.yml
-docker-compose-nginx.yml
+docker-compose-reverse-proxy.yml

Makefile

@@ -7,63 +7,57 @@ include ./.env
 # BUILDING
 #------------------------------------------------------
 prepare:
-	./bin/_prepare;
-	./bin/_whalesay --say "Your docker-compose files are ready!";
+	./_bin/_prepare;
 
 build:
-	docker-compose -f docker-compose.yml build;
-	./bin/_whalesay --say "Apache container (${APACHE_CONTAINER_NAME}) has been built!";
+	./_bin/_build;
 
 down:
-	./bin/_down;
-	./bin/_whalesay --say "Apache (${APACHE_CONTAINER_NAME}) and MySQL (${MYSQL_CONTAINER_NAME}) containers have been stopped!";
+	./_bin/_down;
 
 up:
-	docker-compose -f docker-compose.yml up -d;
-	./bin/_whalesay --say "Apache (${APACHE_CONTAINER_NAME}) and MySQL (${MYSQL_CONTAINER_NAME}) containers are running!";
+	./_bin/_up;
 
-nginx-down:
-	docker-compose -p ${NGINX_PROXY_NAME} -f docker-compose-nginx.yml down;
-	./bin/_whalesay --say "NGINX (${NGINX_CONTAINER_NAME}) container has been stopped!";
+proxy-down:
+	./_bin/_reverse_proxy_down;
 
-nginx-up:
-	./bin/_nginx_up;
-	./bin/_whalesay --say "NGINX (${NGINX_CONTAINER_NAME}) container is running!";
+proxy-up:
+	./_bin/_reverse_proxy_up;
 
-kickoff: down prepare build nginx-up up;
-	./bin/_whalesay --say "You're ready to go!";
+kickoff:
+	./_bin/_kickoff;
 
 # UTILS
 #------------------------------------------------------
 shell:
-	./bin/_shell --container_name ${APACHE_CONTAINER_NAME} --service_name "Apache";
+	./_bin/_shell --container_name ${APACHE_CONTAINER_NAME} --service_name "Apache";
 
-shell-nginx:
-	./bin/_shell --container_name ${NGINX_CONTAINER_NAME} --service_name "NGINX";
+shell-proxy:
+	./_bin/_shell --container_name ${REVERSE_PROXY_CONTAINER_NAME} --service_name "Reverse proxy";
 
 shell-mysql:
-	./bin/_shell --container_name ${MYSQL_CONTAINER_NAME} --service_name "MySQL";
+	./_bin/_shell --container_name ${MYSQL_CONTAINER_NAME} --service_name "MySQL";
 
 mysql-cli:
-	./bin/_mysql_cli;
+	./_bin/_mysql_cli;
 
 tail:
-	./bin/_tail --container_name ${APACHE_CONTAINER_NAME} --service_name "Apache";
+	./_bin/_tail --container_name ${APACHE_CONTAINER_NAME} --service_name "Apache";
 
-tail-nginx:
-	./bin/_tail --container_name ${NGINX_CONTAINER_NAME} --service_name "NGINX";
+tail-proxy:
+	./_bin/_tail --container_name ${REVERSE_PROXY_CONTAINER_NAME} --service_name "Reverse proxy";
 
 tail-mysql:
-	./bin/_tail --container_name ${MYSQL_CONTAINER_NAME} --service_name "MySQL";
+	./_bin/_tail --container_name ${MYSQL_CONTAINER_NAME} --service_name "MySQL";
 
 export:
-	./bin/_export;
+	./_bin/_export;
 
 import:
-	./bin/_import;
+	./_bin/_import;
 
 composer:
-	./bin/_composer --command $(cmd);
+	./_bin/_composer --command $(cmd);
 
 npm:
-	./bin/_npm --command $(cmd);
+	./_bin/_npm --command $(cmd);

README.md

@@ -65,23 +65,23 @@ Once everything has been installed, open your favorite web browser and copy / pa
 
 | Command                         | Description                                                                                                                                                                                        |
 | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
-| prepare                         | Creates the `docker-compose.yml` and `docker-compose-nginx.yml` files using the variables's values specified in the `.env` file.                                                                   |
+| prepare                         | Creates the `docker-compose.yml` and `docker-compose-reverse-proxy.yml` files using the variables's values specified in the `.env` file.                                                           |
 | build                           | Builds the Apache container.                                                                                                                                                                       |
 | down                            | Stops the Apache and MySQL containers, deletes their network and cleans the docker cache.                                                                                                          |
 | up                              | Ups the Apache and MySQL containers.                                                                                                                                                               |
-| nginx-down                      | Stops the NGINX container and deletes its network.                                                                                                                                                 |
-| nginx-up                        | Ups the NGINX container.                                                                                                                                                                           |
-| kickoff                         | Combo of down, prepare, build, nginx-up and up commands.                                                                                                                                           |
+| proxy-down                      | Stops the reverse proxy container and deletes its network.                                                                                                                                         |
+| proxy-up                        | Ups the reverse proxy container.                                                                                                                                                                   |
+| kickoff                         | Combo of down, prepare, build, proxy-up and up commands.                                                                                                                                           |
 | composer cmd=*yourcommand*      | Allows you to run a composer command. Ex: `make composer cmd=install`, `make composer cmd=update`, ...                                                                                             |
 | npm cmd=*yourcommand*           | Allows you to run a npm command. Ex: `make npm cmd=install`, `make npm cmd="install --save-dev gulp"`, ...                                                                                         |
 | export                          | This command will dump the database into two SQL files located at `mysql/dumps`. The files will be named as `yourdatabasename.sql` and `yourdatabasename.Y-m-d:H:M:S.sql`.                         |
 | import                          | This command will drop the database, recreate it and then run the `yourdatabasename.sql` file.                                                                                                     |
 | shell                           | Connects through bash to the Apache container.                                                                                                                                                     |
-| shell-nginx                     | Connects through bash to the NGINX container.                                                                                                                                                      |
+| shell-proxy                     | Connects through bash to the reverse proxy container.                                                                                                                                              |
 | shell-mysql                     | Connects through bash to the MySQL container.                                                                                                                                                      |
 | mysql-cli                       | Opens the MySQL cli.                                                                                                                                                                               |
 | tail                            | Displays the Docker's logs of the Apache container.                                                                                                                                                |
-| tail-nginx                      | Displays the Docker's logs of the NGINX container.                                                                                                                                                 |
+| tail-proxy                      | Displays the Docker's logs of the reverse proxy container.                                                                                                                                         |
 | tail-mysql                      | Displays the Docker's logs of the MySQL container.                                                                                                                                                 |
 
 ## Dive in
@@ -92,12 +92,12 @@ There are three important files:
 
 * `.env.template` which contains variables with default values.
 * `docker-compose.yml.template` which contains the run configuration of the Apache and MySQL containers plus some of the variables defined in `.env.template`.
-* `docker-compose-nginx.yml.template` which contains the run configuration of the NGINX container plus some of the variables defined in `.env.template`.
+* `docker-compose-reverse-proxy.yml.template` which contains the run configuration of the reverse proxy container plus some of the variables defined in `.env.template`.
 
 As these files are templates, they are not used directly. That's why you have to:
 
 * run `cp .env.template .env` and update the variables' values in the `.env` file at your convenience.
-* run `make kickoff` which runs `make prepare`: this command creates the `docker-compose.yml` and `docker-compose-nginx.yml` files using the variables' values defined in the `.env` file.
+* run `make kickoff` which runs `make prepare`: this command creates the `docker-compose.yml` and `docker-compose-reverse-proxy.yml` files using the variables' values defined in the `.env` file.
 
 For security concern, these three files have been added in the `.gitignore` file as they contain sensible data like the MySQL database password and so on.
 
@@ -146,13 +146,13 @@ If you're using SSL Certificate Chains, we advise you to read the official NGINX
 
 ### Multiple environments/projects on the same host
 
-As you long as each `NGINX_PROXY_NAME` and `PROXY_NETWORK` variables in your `.env` files have the same values, you are able to run as many environments/projects as you need. 
+As you long as each `REVERSE_PROXY_NAME` and `REVERSE_PROXY_NETWORK` variables in your `.env` files have the same values, you are able to run as many environments/projects as you need. 
 
 Make sure that you have defined a different `APACHE_VIRTUAL_HOST` value for each of your Apache containers.
 
 ### Install more PHP extensions
 
-Open the `Dockerfile` located in the `apache/volume` folder and [follow the official instructions](https://github.com/docker-library/docs/tree/master/php#how-to-install-more-php-extensions).
+Open the `Dockerfile` located in the `apache` folder and [follow the official instructions](https://github.com/docker-library/docs/tree/master/php#how-to-install-more-php-extensions).
 
 Once done, run `make kickoff` to rebuild your Apache container.
 

_bin/_build

@@ -0,0 +1,27 @@
+#!/bin/bash
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )";
+ROOT=${DIR}/..;
+
+# environment variables
+source ${ROOT}/.env;
+
+build()
+{
+    if [ -f ${ROOT}/docker-compose.yml ]; then
+        if docker-compose -f ${ROOT}/docker-compose.yml build; then
+            /bin/bash ${DIR}/misc/_whalesay --say "Apache container (${APACHE_CONTAINER_NAME}) has been built!";
+        else
+            /bin/bash ${DIR}/misc/_whalesay --say "Failed to build the Apache container (${APACHE_CONTAINER_NAME}).";
+            exit 1;
+        fi;
+    else
+        /bin/bash ${DIR}/misc/_whalesay --say "No docker-compose.yml found. Did you run make prepare?";
+        exit 1;
+    fi;
+}
+
+
+build;
+
+exit 0;

bin/_composer _bin/_composerbin/_composer renamed to _bin/_composer

@@ -21,10 +21,10 @@ missing_arg()
 
 composer()
 {
-    /bin/bash ${DIR}/_health_check --container_name ${APACHE_CONTAINER_NAME};
+    /bin/bash ${DIR}/utils/_health_check --container_name ${APACHE_CONTAINER_NAME};
 
     if [ $? -eq 1 ]; then
-        /bin/bash ${DIR}/_whalesay --say "Apache container (${APACHE_CONTAINER_NAME}) is not running.";
+        /bin/bash ${DIR}/misc/_whalesay --say "Apache container (${APACHE_CONTAINER_NAME}) is not running.";
         exit 1;
     fi;
 

_bin/_down

@@ -0,0 +1,30 @@
+#!/bin/bash
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )";
+ROOT=${DIR}/..;
+
+# environment variables
+source ${ROOT}/.env;
+
+down()
+{
+    if [ -f ${ROOT}/docker-compose.yml ]; then
+        if docker-compose -f ${ROOT}/docker-compose.yml down; then
+            /bin/bash ${DIR}/misc/_whalesay --say "Apache (${APACHE_CONTAINER_NAME}) and MySQL (${MYSQL_CONTAINER_NAME}) containers have been stopped!";
+        else
+            /bin/bash ${DIR}/misc/_whalesay --say "Failed to stop the Apache (${APACHE_CONTAINER_NAME}) and MySQL (${MYSQL_CONTAINER_NAME}) containers.";
+        fi;
+    fi;
+}
+
+cache()
+{
+    docker rm $(docker ps -q -f status=exited) >/dev/null;
+    docker rmi $(docker images -q -f dangling=true) >/dev/null
+    docker volume rm $(docker volume ls -qf dangling=true) >/dev/null;
+}
+
+down;
+cache;
+
+exit 0;

bin/_export _bin/_exportbin/_export renamed to _bin/_export

@@ -8,10 +8,10 @@ source ${ROOT}/.env;
 
 exportDatabase()
 {
-    /bin/bash ${DIR}/_health_check --container_name ${MYSQL_CONTAINER_NAME};
+    /bin/bash ${DIR}/utils/_health_check --container_name ${MYSQL_CONTAINER_NAME};
 
     if [ $? -eq 1 ]; then
-        /bin/bash ${DIR}/_whalesay --say "MySQL container (${MYSQL_CONTAINER_NAME}) is not running.";
+        /bin/bash ${DIR}/misc/_whalesay --say "MySQL container (${MYSQL_CONTAINER_NAME}) is not running.";
         exit 1;
     fi;
 
@@ -22,7 +22,7 @@ exportDatabase()
     docker exec ${MYSQL_CONTAINER_NAME} mysqldump --opt -uroot -p${MYSQL_ROOT_PASSWORD} ${MYSQL_DATABASE} > ${ROOT}/mysql/dumps/${MYSQL_DATABASE}.sql;
     cp ${ROOT}/mysql/dumps/${MYSQL_DATABASE}.sql ${ROOT}/mysql/dumps/${MYSQL_DATABASE}.$(date +%Y-%m-%d:%H:%M:%S).sql;
 
-    /bin/bash ${DIR}/_whalesay --say "Export task complete!";
+    /bin/bash ${DIR}/misc/_whalesay --say "Export task complete!";
 }
 
 exportDatabase;

bin/_import _bin/_importbin/_import renamed to _bin/_import

@@ -8,10 +8,10 @@ source ${ROOT}/.env;
 
 importDatabase()
 {
-    /bin/bash ${DIR}/_health_check --container_name ${MYSQL_CONTAINER_NAME};
+    /bin/bash ${DIR}/utils/_health_check --container_name ${MYSQL_CONTAINER_NAME};
 
     if [ $? -eq 1 ]; then
-        /bin/bash ${DIR}/_whalesay --say "MySQL container (${MYSQL_CONTAINER_NAME}) is not running.";
+        /bin/bash ${DIR}/misc/_whalesay --say "MySQL container (${MYSQL_CONTAINER_NAME}) is not running.";
         exit 1;
     fi;
 
@@ -21,7 +21,7 @@ importDatabase()
 
     cat ${ROOT}/mysql/dumps/${MYSQL_DATABASE}.sql | docker exec -i ${MYSQL_CONTAINER_NAME} mysql --verbose -uroot -p${MYSQL_ROOT_PASSWORD} ${MYSQL_DATABASE};
 
-    /bin/bash ${DIR}/_whalesay --say "Import task complete!";
+    /bin/bash ${DIR}/misc/_whalesay --say "Import task complete!";
 }
 
 importDatabase;

_bin/_kickoff

@@ -0,0 +1,32 @@
+#!/bin/bash
+
+DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )";
+ROOT=${DIR}/..;
+
+kickoff()
+{
+    /bin/bash ${DIR}/_down;
+
+    if ! /bin/bash ${DIR}/_prepare; then
+        exit 1;
+    fi;
+
+    if ! /bin/bash ${DIR}/_build; then
+        exit 1;
+    fi;
+
+    if ! /bin/bash ${DIR}/_reverse_proxy_up; then
+        exit 1;
+    fi;
+
+    if ! /bin/bash ${DIR}/_up; then
+        exit 1;
+    fi;
+
+    /bin/bash ${DIR}/misc/_whalesay --say "You're ready to go!";
+}
+
+
+kickoff;
+
+exit 0;