Added unit tests (#1)

* Added Unit tests
* Updated travis config
* Added empty database test case
* Added badge to README.md, added sys to SKIP_DATABASES
* Added views skip databases

Author: williamdes

.env-example

@@ -5,7 +5,7 @@ MYSQL_USER=root
 MYSQL_PASS=toor
 
 # (Optional, use recommended example below ) Databases to skip with no space between the args separated by a ,
-SKIP_DATABASES=mysql,information_schema,performance_schema,phpmyadmin
+SKIP_DATABASES=mysql,sys,information_schema,performance_schema,phpmyadmin
 
 # (Optional) No not use if you are a goat
 # EXPERT_ARGS=--default-character-set=utf8 --extended-insert=FALSE --single-transaction --skip-comments --skip-dump-date --hex-blob --tz-utc

.gitignore

@@ -1,2 +1,4 @@
 .env
-*.sql
+*.sql
+shunit*
+!samples/**/*

.travis.yml

@@ -0,0 +1,24 @@
+language: bash
+cache: bundler
+dependencies:
+  cache_directories:
+    - "~/.apt-cache"
+  pre:
+    - sudo rm -rf /var/cache/apt/archives && sudo ln -s ~/.apt-cache /var/cache/apt/archives && mkdir -p ~/.apt-cache/partial
+services:
+  - mysql
+addons:
+  apt:
+    sources:
+      - mysql-5.7-trusty
+    packages:
+      - mysql-server
+      - mysql-client
+before_script:
+    - curl -L "http://downloads.sourceforge.net/shunit2/shunit2-2.0.3.tgz" | tar zx
+    - chmod +x ./shunit2-2.0.3/src/shell/shunit2
+script:
+    - bash tests.sh
+before_install:
+  - sudo mysql -e "use mysql; update user set authentication_string=PASSWORD('testbench'), host='%', password_last_changed=FROM_UNIXTIME(1523829600) where User='root'; update user set plugin='mysql_native_password'; delete from user where User != 'root' OR host != '%'; delete from user where User = 'sys'; FLUSH PRIVILEGES;"
+  - sudo service mysql restart

CHANGELOG.md

@@ -11,6 +11,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - Added optional `BACKUP_CONFIG_ENVFILE` variable to set the env file location
 - Updated .env-example (commented out some optional variables)
 - Added check if `BACKUP_DIR` exists
+- Added exit codes
+- Added unit tests
+- Updated .gitignore
+- Bug fix (no views)
+
+### Will be done
+- Skipping users & grants
+
 
 ## [1.0.0] - 2018-04-07
 ### Added

README.md

@@ -1,6 +1,8 @@
 # sql-backup
 [![Maintainability](https://api.codeclimate.com/v1/badges/9af0b964df176436608d/maintainability)](https://codeclimate.com/github/williamdes/sql-backup/maintainability)
 
+[![Build Status](https://travis-ci.org/williamdes/sql-backup.svg?branch=master)](https://travis-ci.org/williamdes/sql-backup)
+
 Backup your MySQL server ( data, users, grants, views, triggers, routines, events )
 
 ## Install
@@ -64,7 +66,7 @@ BACKUP_DIR=/sql_backup
 MYSQL_HOST=localhost
 MYSQL_USER=root
 MYSQL_PASS=root
-SKIP_DATABASES=mysql,information_schema,performance_schema,phpmyadmin
+SKIP_DATABASES=mysql,sys,information_schema,performance_schema,phpmyadmin
 ```
 
 ## Files

backup.sh

@@ -1,12 +1,16 @@
 #!/bin/bash
 
+exitWithMsg() {
+  echo $2
+  exit $1
+}
+
 # from : github:builtinnya/dotenv-shell-loader
 DOTENV_SHELL_LOADER_SAVED_OPTS=$(set +o)
 set -o allexport
 if [ ! -z "${BACKUP_CONFIG_ENVFILE}" ]; then
     if [ ! -f "${BACKUP_CONFIG_ENVFILE}" ]; then
-        echo "Value of variable BACKUP_CONFIG_ENVFILE is not a file (${BACKUP_CONFIG_ENVFILE})"
-        exit 1
+        exitWithMsg 201 "Value of variable BACKUP_CONFIG_ENVFILE is not a file (${BACKUP_CONFIG_ENVFILE})"
     else
       [ -f "${BACKUP_CONFIG_ENVFILE}" ] && source "${BACKUP_CONFIG_ENVFILE}"
     fi
@@ -18,33 +22,27 @@ eval "$DOTENV_SHELL_LOADER_SAVED_OPTS"
 unset DOTENV_SHELL_LOADER_SAVED_OPTS
 
 if ! [ -x "$(command -v mysql)" ]; then
-  echo 'Error: mysql is not installed !, apt-get install -y mysql-client' >&2
-  exit 1
+  exitWithMsg 203 'Error: mysql is not installed !, apt-get install -y mysql-client' >&2
 fi
 
 if ! [ -x "$(command -v mysqldump)" ]; then
-  echo 'Error: mysqldump is not installed !, apt-get install -y mysql-client' >&2
-  exit 1
+  exitWithMsg 203 'Error: mysqldump is not installed !, apt-get install -y mysql-client' >&2
 fi
 
 if [ -z "${BACKUP_DIR}" ]; then
-    echo "Empty Variable BACKUP_DIR"
-    exit 1
+    exitWithMsg 200 "Empty Variable BACKUP_DIR"
 else
   if [ ! -d "${BACKUP_DIR}" ]; then
-      echo "Value of variable BACKUP_DIR is not a directory (${BACKUP_DIR})"
-      exit 1
+      exitWithMsg 202 "Value of variable BACKUP_DIR is not a directory (${BACKUP_DIR})"
   fi
 fi
 
 if [ -z "${MYSQL_HOST}" ]; then
-    echo "Empty Variable MYSQL_HOST"
-    exit 1
+    exitWithMsg 200 "Empty Variable MYSQL_HOST"
 fi
 
 if [ -z "${MYSQL_USER}" ]; then
-    echo "Empty Variable MYSQL_USER"
-    exit 1
+    exitWithMsg 200 "Empty Variable MYSQL_USER"
 fi
 
 
@@ -77,14 +75,41 @@ fi
 # Get result
 DB_LIST=`mysql ${MYSQL_CONN} -ANe"${DB_LIST_SQL}"`
 
+if [ "$?" -ne 0 ]; then
+  exitWithMsg 204 "Databases listing failed"
+fi
+
+if [ -z "${DB_LIST}" ]; then
+  exitWithMsg 206 "No databases to backup"
+fi
+
 for DB in $DB_LIST; do # Concat ignore command
     DBS="${DBS} ${DB}"
 done
 
-VIEW_LIST_SQL="SET SESSION group_concat_max_len = 1000000;SELECT GROUP_CONCAT(concat(':!\`',table_schema,'\`.\`',table_name,'\`') SEPARATOR '') FROM information_schema.views"
+VIEW_LIST_SQL="SET SESSION group_concat_max_len = 1000000;SELECT IFNULL(GROUP_CONCAT(concat(':!\`',table_schema,'\`.\`',table_name,'\`') SEPARATOR ''),'') FROM information_schema.views"
+
+# If ${SKIP_DATABASES} is not empty, create a where chain 
+if [ ! -z "${SKIP_DATABASES}" ]; then
+    VIEW_LIST_SQL="${VIEW_LIST_SQL} WHERE table_schema NOT IN ("
+    # Split on ,
+    SKIP_DATABASES=$(echo -e "${SKIP_DATABASES}" | tr "," "\n")
+    for DB in ${SKIP_DATABASES} ; do
+    VIEW_LIST_SQL="${VIEW_LIST_SQL}'${DB}'," ;
+    done
+    VIEW_LIST_SQL="${VIEW_LIST_SQL: : -1}"
+    VIEW_LIST_SQL="${VIEW_LIST_SQL});"
+else
+    VIEW_LIST_SQL=";"
+fi
+
 # Get result
 VIEWS_LIST=`mysql ${MYSQL_CONN} -ANe"${VIEW_LIST_SQL}"`
 
+if [ "$?" -ne 0 ]; then
+  exitWithMsg 204 "Views listing failed"
+fi
+
 VIEW_IGNORE_ARG=""
 # Split on :!
 VIEWS=$(echo -e "${VIEWS_LIST}" | tr ":!" "\n")
@@ -99,21 +124,38 @@ VIEW_IGNORE_ARG=${VIEW_IGNORE_ARG//\`/}
 echo "Structure..."
 mysqldump ${MYSQLDUMP_DEFAULTS} --routines=FALSE --triggers=FALSE --events=FALSE --no-data ${VIEW_IGNORE_ARG} --databases ${DBS} > ${BACKUP_DIR}/structure.sql
 
+if [ "$?" -ne 0 ]; then
+  exitWithMsg 205 "Structure dump failed"
+fi
+
 echo "Data ..."
 mysqldump ${MYSQLDUMP_DEFAULTS} --routines=FALSE --triggers=FALSE --events=FALSE --no-create-info ${VIEW_IGNORE_ARG} --databases ${DBS} > ${BACKUP_DIR}/database.sql
 
-echo "Users ..."
-mysqldump ${MYSQLDUMP_DEFAULTS} mysql --no-create-info --complete-insert --tables user db > ${BACKUP_DIR}/users.sql
+if [ "$?" -ne 0 ]; then
+  exitWithMsg 205 "Data dump failed"
+fi
 
 echo "Routines ..."
 mysqldump ${MYSQLDUMP_DEFAULTS} --routines=TRUE --triggers=FALSE --events=FALSE --no-create-info --no-data --no-create-db --databases ${DBS} > ${BACKUP_DIR}/routines.sql
 
+if [ "$?" -ne 0 ]; then
+  exitWithMsg 205 "Routines dump failed"
+fi
+
 echo "Triggers ..."
 mysqldump ${MYSQLDUMP_DEFAULTS} --routines=FALSE --triggers=TRUE --events=FALSE --no-create-info --no-data --no-create-db --databases ${DBS} > ${BACKUP_DIR}/triggers.sql
 
+if [ "$?" -ne 0 ]; then
+  exitWithMsg 205 "Triggers dump failed"
+fi
+
 echo "Events ..."
 mysqldump ${MYSQLDUMP_DEFAULTS} --routines=FALSE --triggers=FALSE --events=TRUE --no-create-info --no-data --no-create-db --databases ${DBS} > ${BACKUP_DIR}/events.sql
 
+if [ "$?" -ne 0 ]; then
+  exitWithMsg 205 "Events dump failed"
+fi
+
 echo "Views ..."
 VIEWS_SHOW_SQL=""
 for VIEW in $VIEWS; do # Concat SHOW CREATE VIEW command
@@ -122,6 +164,10 @@ done
 # echo -e "${VIEWS_SHOW_SQL}"
 echo ${VIEWS_SHOW_SQL} | sed 's/;/\\G/g' | mysql ${MYSQL_CONN} > ${BACKUP_DIR}/views.sql
 
+if [ "$?" -ne 0 ]; then
+  exitWithMsg 205 "Views dump failed"
+fi
+
 #Keeps lines starting with Create
 sed -i '/Create/!d' ${BACKUP_DIR}/views.sql
 # Removes 'Create View'
@@ -135,16 +181,30 @@ sed -i 's/$/;/' ${BACKUP_DIR}/views.sql
 #Replace double ;; by ;
 sed -i 's/;;/;/' ${BACKUP_DIR}/views.sql
 
+echo "Users ..."
+mysqldump ${MYSQLDUMP_DEFAULTS} mysql --no-create-info --complete-insert --tables user db > ${BACKUP_DIR}/users.sql
+
+if [ "$?" -ne 0 ]; then
+  exitWithMsg 205 "Users dump failed"
+fi
+
 echo "Grants ..."
 # Needs refactor
 GRANTS_SQL="select distinct concat( \"SHOW GRANTS FOR '\",user,\"'@'\",host,\"';\" ) from mysql.user WHERE user != 'root';"
 GRANTS_LIST=`mysql ${MYSQL_CONN} -ANe"${GRANTS_SQL}"`
 echo ${GRANTS_LIST} | mysql --default-character-set=utf8 --skip-comments ${MYSQL_CONN} | sed 's/\(GRANT .*\)/\1;/;s/^\(Grants for .*\)/-- \1 --/;/--/{x;p;x;}' > ${BACKUP_DIR}/grants.sql
+
+if [ "$?" -ne 0 ]; then
+  exitWithMsg 205 "Grants dump failed"
+fi
+
 # Removes double backslashes >  \\
 sed -i -e 's/\\\\//g' ${BACKUP_DIR}/grants.sql
 # echo -e ${GRANTS_SQL}
 
 echo "Backup done !"
+
 if [ ! -z "${ON_SUCCESS}" ]; then
-`echo ${ON_SUCCESS}`
+  `echo ${ON_SUCCESS}`
 fi
+exit 0

samples/empty/database.sql

@@ -0,0 +1,25 @@
+
+/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
+/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
+/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
+/*!40101 SET NAMES utf8 */;
+/*!40103 SET @OLD_TIME_ZONE=@@TIME_ZONE */;
+/*!40103 SET TIME_ZONE='+00:00' */;
+/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;
+/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
+/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
+/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;
+
+CREATE DATABASE /*!32312 IF NOT EXISTS*/ `testbench` /*!40100 DEFAULT CHARACTER SET utf8mb4 */;
+
+USE `testbench`;
+/*!40103 SET TIME_ZONE=@OLD_TIME_ZONE */;
+
+/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;
+/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;
+/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;
+/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
+/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
+/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;
+/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;
+

samples/empty/events.sql

@@ -0,0 +1,23 @@
+
+/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
+/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
+/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
+/*!40101 SET NAMES utf8 */;
+/*!40103 SET @OLD_TIME_ZONE=@@TIME_ZONE */;
+/*!40103 SET TIME_ZONE='+00:00' */;
+/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;
+/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
+/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
+/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;
+
+USE `testbench`;
+/*!40103 SET TIME_ZONE=@OLD_TIME_ZONE */;
+
+/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;
+/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;
+/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;
+/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
+/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
+/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;
+/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;
+

samples/empty/grants.sql

@@ -0,0 +1,23 @@
+
+/*!40101 SET @OLD_CHARACTER_SET_CLIENT=@@CHARACTER_SET_CLIENT */;
+/*!40101 SET @OLD_CHARACTER_SET_RESULTS=@@CHARACTER_SET_RESULTS */;
+/*!40101 SET @OLD_COLLATION_CONNECTION=@@COLLATION_CONNECTION */;
+/*!40101 SET NAMES utf8 */;
+/*!40103 SET @OLD_TIME_ZONE=@@TIME_ZONE */;
+/*!40103 SET TIME_ZONE='+00:00' */;
+/*!40014 SET @OLD_UNIQUE_CHECKS=@@UNIQUE_CHECKS, UNIQUE_CHECKS=0 */;
+/*!40014 SET @OLD_FOREIGN_KEY_CHECKS=@@FOREIGN_KEY_CHECKS, FOREIGN_KEY_CHECKS=0 */;
+/*!40101 SET @OLD_SQL_MODE=@@SQL_MODE, SQL_MODE='NO_AUTO_VALUE_ON_ZERO' */;
+/*!40111 SET @OLD_SQL_NOTES=@@SQL_NOTES, SQL_NOTES=0 */;
+
+USE `testbench`;
+/*!40103 SET TIME_ZONE=@OLD_TIME_ZONE */;
+
+/*!40101 SET SQL_MODE=@OLD_SQL_MODE */;
+/*!40014 SET FOREIGN_KEY_CHECKS=@OLD_FOREIGN_KEY_CHECKS */;
+/*!40014 SET UNIQUE_CHECKS=@OLD_UNIQUE_CHECKS */;
+/*!40101 SET CHARACTER_SET_CLIENT=@OLD_CHARACTER_SET_CLIENT */;
+/*!40101 SET CHARACTER_SET_RESULTS=@OLD_CHARACTER_SET_RESULTS */;
+/*!40101 SET COLLATION_CONNECTION=@OLD_COLLATION_CONNECTION */;
+/*!40111 SET SQL_NOTES=@OLD_SQL_NOTES */;
+