docs; cleanups

README.md

@@ -207,6 +207,25 @@ CONTAINER_USER_UID and CONTAINER_USER_GID environment variables _before_ running
 More details in the file docker/.env.
 
 
+## Contributing to development
+
+Bug reports are welcome, as well as Pull requests. The project is managed on GitHub.
+
+### Running tests
+
+Once you have built the db3v4l stack once, running the test suite is a breeze:
+
+    ./tests/01_dbstack.sh
+    ./tests/02_dbconsole.sh
+    ./tests/03_web.sh
+    ./tests/04_admin.sh
+
+None of those shell scripts should fail (exit with non-zero exit code).
+
+NB: when running the test suite, custom databases and database users are created then destroyed within each available
+database instance. It is not recommended to run the test suite if your databases already contain (important) data.
+
+
 ## Thanks
 
 Many thanks to

bin/dbstack

@@ -92,26 +92,6 @@ check_requirements() {
     fi
 }
 
-create_compose_command() {
-    local VENDORS
-    DOCKER_COMPOSE_CMD='docker-compose -f docker-compose.yml'
-    if [ -n "${COMPOSE_ONLY_VENDORS}" ]; then
-        VENDORS=${COMPOSE_ONLY_VENDORS//,/ }
-    else
-        VENDORS=$(cd compose && ls -- *.yml | tr '\n' ' ')
-        VENDORS=${VENDORS//.yml/}
-    fi
-    if [ -n "${COMPOSE_EXCEPT_VENDORS}" ]; then
-        for COMPOSE_EXCEPT_VENDOR in ${COMPOSE_EXCEPT_VENDORS//,/ }; do
-            # @bug what if a COMPOSE_EXCEPT_VENDOR is a substring of a VENDOR ?
-            VENDORS=${VENDORS/$COMPOSE_EXCEPT_VENDOR/}
-        done
-    fi
-    for DC_CONF_FILE in ${VENDORS}; do
-        DOCKER_COMPOSE_CMD="${DOCKER_COMPOSE_CMD} -f compose/${DC_CONF_FILE}.yml"
-    done
-}
-
 # @todo have this function looked at by a bash guru to validate it's not a brainf**t
 #load_config_value() {
 #    local VALUE=
@@ -191,6 +171,26 @@ setup_local_config() {
     # @todo allow setting up: custom db root account pwd, sf env, etc...
 }
 
+create_compose_command() {
+    local VENDORS
+    DOCKER_COMPOSE_CMD='docker-compose -f docker-compose.yml'
+    if [ -n "${COMPOSE_ONLY_VENDORS}" ]; then
+        VENDORS=${COMPOSE_ONLY_VENDORS//,/ }
+    else
+        VENDORS=$(cd compose && ls -- *.yml | tr '\n' ' ')
+        VENDORS=${VENDORS//.yml/}
+    fi
+    if [ -n "${COMPOSE_EXCEPT_VENDORS}" ]; then
+        for COMPOSE_EXCEPT_VENDOR in ${COMPOSE_EXCEPT_VENDORS//,/ }; do
+            # @bug what if a COMPOSE_EXCEPT_VENDOR is a substring of a VENDOR ?
+            VENDORS=${VENDORS/$COMPOSE_EXCEPT_VENDOR/}
+        done
+    fi
+    for DC_CONF_FILE in ${VENDORS}; do
+        DOCKER_COMPOSE_CMD="${DOCKER_COMPOSE_CMD} -f compose/${DC_CONF_FILE}.yml"
+    done
+}
+
 build() {
     local IMAGES
 

doc/WHATSNEW.md

@@ -1,5 +1,5 @@
-Version 0.16 (unreleased)
--------------------------
+Version 0.16
+------------
 
 - Improved: bumped minimum required docker-compose version to 1.19 in docs and tests, as that was effectively necessary
 
@@ -10,13 +10,13 @@ Version 0.16 (unreleased)
   to specific vendors, making it require less cpu/ram/disk resources.
   Example usages:
 
-      export COMPOSE_ONLY_VENDORS=mysql,mariadb
+      export COMPOSE_ONLY_VENDORS=mysql,mariadb,percona
       ./bin/dbstack start
 
       export COMPOSE_EXCEPT_VENDORS=oracle,mssql
       ./bin/dbstack start
 
-- Improved: tests on Travis exercise a wider set of configuration options and execute faster
+- Improved: tests on Travis exercise a wider set of configuration options and execute somewhat faster
 
 
 Version 0.15

docker/.env

@@ -9,7 +9,7 @@ COMPOSE_PROJECT_NAME=db3v4l
 
 # The containers get their TZ config from this;
 # use 'none' as null value
-COMPOSE_TZ=Europe/London???
+COMPOSE_TZ=Europe/London
 
 # Use alternative debian mirrors when building 'surrogate/helper' containers. Useful if there are problems with the default mirrors
 # use 'none' as null value
@@ -45,6 +45,9 @@ COMPOSE_DB_SIZE=small
 #
 COMPOSE_SETUP_APP_ON_BOOT=true
 
+# See the FAQ for how to use these two
+#COMPOSE_ONLY_VENDORS=
+#COMPOSE_EXCEPT_VENDORS=
 
 ### Settings used by all Containers
 # Your user ID and group for file permissions (_as used on host computer_).
@@ -89,6 +92,7 @@ POSTGRESQL_12_VERSION=12
 MSSQLSERVER_2017_VERSION=2017-latest
 MSSQLSERVER_2019_VERSION=2019-latest
 
+
 ### MySQL + MariaDB Settings
 # NB: these are used when the db is created the 1st time the platform is executed. Changing them afterwards will have
 # no effect (unless you delete the db data files)
@@ -107,6 +111,6 @@ SA_PASSWORD=3v4l3V4L
 ORACLE_PWD=3v4l
 
 
-# pg root user
+# PostgreSQL root user
 #POSTGRES_USER=postgres
 POSTGRES_PASSWORD=3v4l