Merge branch 'release/v1.3.0'

Author: clivewalkden

CHANGELOG.md

@@ -6,6 +6,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.3.0] - 2020-07-29
+### Added
+- local-backup option (enabled by default)
+
+### Changed
+- Updated some variables to stop clashing with other scripts.
+
+
 ## [1.2.1] - 2020-07-10
 ### Changed
 - Fixed message spacing issue.

MENU.md

@@ -0,0 +1,20 @@
+# Menu Generation
+
+Use the below to generate the menu.sh file from the site [https://argbash.io/generate](https://argbash.io/generate)
+
+```
+#!/bin/bash
+# version="1.1.1"
+#
+# This is an optional arguments-only example of Argbash potential
+#
+# ARG_OPTIONAL_BOOLEAN([local-backup], [b], [perform a backup before importing remote], [off])
+# ARG_OPTIONAL_BOOLEAN([full], [f], [full database dump])
+# ARG_VERSION([echo test v$version])
+# ARG_HELP([The general script's help msg])
+# ARGBASH_GO
+
+# [ <-- needed because of Argbash
+
+# ] <-- needed because of Argbash
+```

README.md

@@ -1,4 +1,4 @@
-# Magento 2 Production DB Sync v1.2.1
+# Magento 2 Production DB Sync v1.3.0
 
 ## About
 A script to copy over a production database to another server, also has the ability to copy across imagery.
@@ -14,7 +14,8 @@ Currently the script is configured to attempt Magento 2 and WordPress database m
 
 ## Installing and Updating
 To install or update the script run the following curl script
-```curl -o- https://raw.githubusercontent.com/clivewalkden/bash-magento2-db-sync/v1.2.1/install.sh | bash```
+
+```curl -o- https://raw.githubusercontent.com/clivewalkden/bash-magento2-db-sync/v1.3.0/install.sh | bash```
 
 ## Usage
 To copy over a production database first get a shell on the system you want to copy the data to. 

db-sync.sh

@@ -5,10 +5,11 @@
 #
 
 # set path to allow calling util subdir files
-source "set_util"
+#source "set_util"
+dbsyncutil="$( dirname ${BASH_SOURCE[0]} )/utils/"
 
 # Load the menu and help
-source "${util}menu.sh"
+source "${dbsyncutil}menu.sh"
 
 # Make sure we are in a Magento directory
 if [ ! -f "bin/magento" ]; then
@@ -19,7 +20,7 @@ if [ ! -f "bin/magento" ]; then
 fi
 
 # Set global paths and functions
-source "${util}set_constants.sh"
+source "${dbsyncutil}set_constants.sh"
 
 echo -e "${bg_black}${txt_white}                                              ${txt_end}"
 echo -e "${bg_black}${txt_white}  Copy over a production database to staging  ${txt_end}"
@@ -34,33 +35,33 @@ fi
 set -e
 
 # Set ${remote_host}
-source "${util}set_remote_host.sh"
+source "${dbsyncutil}set_remote_host.sh"
 
 # Test Connection
 while true; do
   echo -e "\n"
   read -p "Would you like to test the connection? " yn
 
   case $yn in
-    [Yy]* ) source "${util}ssh_connection_test.sh"; break;;
+    [Yy]* ) source "${dbsyncutil}ssh_connection_test.sh"; break;;
     [Nn]* ) break;;
     * ) echo "Please answer yes or no.";;
   esac
 done
 
 # Run the remote backup
-source "${util}remote_backup.sh"
-source "${util}remote_retrieve.sh"
-source "${util}local_backup.sh"
-source "${util}url_update.sh"
+source "${dbsyncutil}remote_backup.sh"
+source "${dbsyncutil}remote_retrieve.sh"
+source "${dbsyncutil}local_backup.sh"
+source "${dbsyncutil}url_update.sh"
 
 # Import the database(s)
 while true; do
   echo -e "\n"
   read -p "Are you ready to import databases to local system? " yn
 
   case $yn in
-    [Yy]* ) source "${util}local_import.sh"; break;;
+    [Yy]* ) source "${dbsyncutil}local_import.sh"; break;;
     [Nn]* ) break;;
     * ) echo "Please answer yes or no.";;
   esac
@@ -72,7 +73,7 @@ while true; do
   read -p "Do you want to download the latest imagery? " yn
 
   case $yn in
-    [Yy]* ) source "${util}local_imagery_import.sh"; break;;
+    [Yy]* ) source "${dbsyncutil}local_imagery_import.sh"; break;;
     [Nn]* ) break;;
     * ) echo "Please answer yes or no.";;
   esac

install.sh

@@ -7,7 +7,7 @@ dbsync_install_dir() {
 }
 
 dbsync_latest_version() {
-  echo "v1.2.1"
+  echo "v1.3.0"
 }
 
 #

set_util

@@ -1,11 +1,16 @@
 #!/usr/bin/env bash
 
-# Backup the current local database
-echo -e "\n${txt_white}${bg_black}Backing up local database(s).${txt_end}\n"
+if [ $_arg_local_backup == 'on' ]; then
+    # Backup the current local database
+    echo -e "\n${txt_white}${bg_black}Backing up local database(s).${txt_end}\n"
 
-n98-magerun --root-dir="${PWD}" db:dump --compression="gzip" --force "../backups/$DATESTAMP-m2.sql.gz"
+    n98-magerun --root-dir="${PWD}" db:dump --compression="gzip" --force "../backups/$DATESTAMP-m2.sql.gz"
 
-if [ ! -z $DB_WP_HOST ]; then
-    mysqldump -u$DB_WP_USER -p$DB_WP_PASS $DB_WP_DBASE>"../backups/$DATESTAMP-wp.sql"
-    gzip "../backups/$DATESTAMP-wp.sql"
+    if [ ! -z $DB_WP_HOST ]; then
+        mysqldump -u$DB_WP_USER -p$DB_WP_PASS $DB_WP_DBASE>"../backups/$DATESTAMP-wp.sql"
+        gzip "../backups/$DATESTAMP-wp.sql"
+    fi
+else
+    # No local backup
+    echo -e "\n${txt_white}${bg_black}Skipping local database(s) backup.${txt_end}\n"
 fi

utils/local_backup.sh

@@ -1,10 +1,11 @@
 #!/usr/bin/env bash
+version="1.3.0"
 
 die()
 {
 	local _ret=$2
 	test -n "$_ret" || _ret=1
-	test "$_PRINT_HELP" = yes && dbsynchelp >&2
+	test "$_PRINT_HELP" = yes && dbsync_print_help >&2
 	echo "$1" >&2
 	exit ${_ret}
 }
@@ -22,19 +23,24 @@ begins_with_short_option()
 
 # THE DEFAULTS INITIALIZATION - OPTIONALS
 _arg_full="off"
+_arg_local_backup="off"
 
-dbsynchelp() {
-  cat <<-HEREDOC
-  Magento 2 DB Sync v1.2.1
+dbsync_print_help() {
+  cat <<HEREDOC
+
+  Magento 2 DB Sync v$version
 
   Syncronize a database from production to staging, testing or development environments.
 
   Make sure you are in a Magento 2 directory before trying to run any scripts.
 
-  Usage: db-sync.sh [-f|--(no-)full] [-h|--help]
+  Usage: db-sync.sh [-b|--(no-)local-backup] [-f|--(no-)full] [-v|--version] [-h|--help]
   Options:
+    -b, --local-backup, --no-local-backup: perform a backup before importing remote (off by default)
     -f, --full, --no-full: full database dump (off by default)
+    -v, --version: Prints version
     -h, --help: Prints help
+
 HEREDOC
 }
 
@@ -45,16 +51,22 @@ parse_commandline()
 	do
 		_key="$1"
 		case "$_key" in
-			# The full argurment doesn't accept a value,
-			# we expect the --full or -f, so we watch for them.
+			-b|--no-local-backup|--local-backup)
+				_arg_local_backup="on"
+				test "${1:0:5}" = "--no-" && _arg_local_backup="off"
+				;;
+			-b*)
+				_arg_local_backup="on"
+				_next="${_key##-b}"
+				if test -n "$_next" -a "$_next" != "$_key"
+				then
+					{ begins_with_short_option "$_next" && shift && set -- "-b" "-${_next}" "$@"; } || die "The short option '$_key' can't be decomposed to ${_key:0:2} and -${_key:2}, because ${_key:0:2} doesn't accept value and '-${_key:2:1}' doesn't correspond to a short option."
+				fi
+				;;
 			-f|--no-full|--full)
 				_arg_full="on"
 				test "${1:0:5}" = "--no-" && _arg_full="off"
 				;;
-			# We support getopts-style short arguments clustering,
-			# so as -f doesn't accept value, other short options may be appended to it, so we watch for -f*.
-			# After stripping the leading -f from the argument, we have to make sure
-			# that the first character that follows coresponds to a short option.
 			-f*)
 				_arg_full="on"
 				_next="${_key##-f}"
@@ -63,14 +75,20 @@ parse_commandline()
 					{ begins_with_short_option "$_next" && shift && set -- "-f" "-${_next}" "$@"; } || die "The short option '$_key' can't be decomposed to ${_key:0:2} and -${_key:2}, because ${_key:0:2} doesn't accept value and '-${_key:2:1}' doesn't correspond to a short option."
 				fi
 				;;
-			# See the comment of option '--full' to see what's going on here - principle is the same.
+			-v|--version)
+				echo db-sync.sh - v$version
+				exit 0
+				;;
+			-v*)
+				echo db-sync.sh - v$version
+				exit 0
+				;;
 			-h|--help)
-				dbsynchelp
+				dbsync_print_help
 				exit 0
 				;;
-			# See the comment of option '-f' to see what's going on here - principle is the same.
 			-h*)
-				dbsynchelp
+				dbsync_print_help
 				exit 0
 				;;
 			*)

utils/menu.sh

@@ -3,7 +3,7 @@
 # Use the settings to check your connection
 echo -e "\n${txt_white}${bg_black}Backing up remote database(s).   ${txt_end}\n"
 if [ $_arg_full == 'on' ]; then
-echo -e "${txt_white}${bg_black}  Full customer and order backup.${txt_end}\n"
+    echo -e "${txt_white}${bg_black}  Full customer and order backup.${txt_end}\n"
 fi
 
 ssh -p "${remote_port}" "${remote_username}@${remote_host}" <<ENDSSH