Merge branch 'release/v1.8.0'

clivewalkden · clivewalkden · commit eeaeeb0408a0 · 2022-01-06T12:05:51.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,19 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.8.0] - 2022-01-06
+### Added
+- Support for multiple PHP bin version on remote host
+- Remote backup is deleted after retrieval to help detect any issues with the remote backup proceedure
+- Started work on ini configuration for better option support
+- Added sozo_imagify to the image directories ignored during image sync
+- shini for future ini config usage
+- Added localinstall for development testing
+
+### Changed
+- Updated tables to drop when stripping content
+
+
 ## [1.7.3] - 2021-09-21
 ### Changed
 - Added the `--all-tables` flag to the WordPress database backup as some tables were missed without it
diff --git a/MENU.md b/MENU.md
@@ -4,19 +4,18 @@ Use the below to generate the menu.sh file from the site [https://argbash.io/gen
 
 ```
 #!/bin/bash
-# version="1.7.3"
+# version="1.8.0"
 #
 # This is an optional arguments-only example of Argbash potential
 #
 # ARG_OPTIONAL_BOOLEAN([full], [f], [full database dump])
 # ARG_OPTIONAL_BOOLEAN([local-backup], [b], [perform a backup before importing remote], [off])
 # ARG_OPTIONAL_BOOLEAN([prefix], [p], [prefix invoices, orders, shipments etc], [off])
 # ARG_OPTIONAL_BOOLEAN([wordpress], [w], [include wordpress content], [off])
+# ARG_OPTIONAL_BOOLEAN([yes], [y], [answer yes to all options])
 # ARG_VERSION([echo test v$version])
 # ARG_HELP([The general script's help msg])
 # ARGBASH_GO
 
-# [ <-- needed because of Argbash
-
 # ] <-- needed because of Argbash
 ```
diff --git a/README.md b/README.md
@@ -1,4 +1,4 @@
-# Magento 2 Production DB Sync v1.7.3
+# Magento 2 Production DB Sync v1.8.0
 
 ## About
 A script to copy over a production database to another server, also has the ability to copy across imagery.
@@ -39,6 +39,8 @@ remote_username=magento
 remote_magento_dir=/opt/magento/magento2
 remote_backup_dir=/opt/magento/backups
 remote_shared_deployment_dir=/opt/magento/deployment/shared/magento
+remote_php_path="/usr/bin/php"
+remote_n98_path="/usr/local/bin/n98-magerun"
 local_backup_dir=/opt/magento/backups
 local_shared_deployment_dir=/opt/magento/deployment/shared/magento
 local_file_user=magento
diff --git a/db-sync.ini b/db-sync.ini
@@ -0,0 +1,30 @@
+# Configuration ini file for db-sync (https://github.com/clivewalkden/bash-magento2-db-sync)
+[Global]
+remote_host="domain.com"
+remote_domain="www.domain.com"
+remote_port="22"
+remote_username="magento"
+remote_magento_dir="/opt/magento/magento2"
+remote_backup_dir="/opt/magento/backups"
+remote_shared_deployment_dir="/opt/magento/deployment/shared/magento"
+remote_php_path="/usr/bin/php"
+remote_n98_path="/usr/local/bin/n98-magerun"
+ignore_tables="mageplaza_smtp_log"
+
+[Staging]
+local_backup_dir="/opt/magento/backups"
+local_shared_deployment_dir="/opt/magento/deployment/shared/magento"
+local_file_user="magento"
+local_file_group="magento"
+
+[Development]
+local_backup_dir="/opt/magento/backups"
+local_shared_deployment_dir="/opt/magento/deployment/shared/magento"
+local_file_user="magento"
+local_file_group="magento"
+
+[Local]
+local_backup_dir="/home/username/git/magento/backups"
+local_shared_deployment_dir="/home/username/git/magento/magento"
+local_file_user="username"
+local_file_group="username"
diff --git a/db-sync.sh b/db-sync.sh
@@ -30,11 +30,19 @@ printf "${bg_black}${txt_white}%-80s${txt_end}\n" " "
 echo -e ""
 echo -e "${txt_blue}  Checking for local configuration file (${conf_file}).  ${txt_end}"
 echo -e ""
-if [[ -f "$conf_file" ]]; then
+# Load config from either .ini or .conf
+if [[ -f "$ini_file" ]]; then
+    source "${dbsyncutil}shini.sh"
+    source "${dbsyncutil}read_ini.sh"
+    echo -e "${txt_blue}  Loaded from ini.  ${txt_end}"
+elif [[ -f "$conf_file" ]]; then
     . "$conf_file"
     echo -e "${txt_blue}  Loaded from config.  ${txt_end}"
+else
+    echo -e "${txt_blue}  No config to load.  ${txt_end}"
 fi
 
+
 set -e
 
 # Set ${remote_host}
@@ -56,6 +64,7 @@ done
 # Run the remote backup
 source "${dbsyncutil}remote_backup.sh"
 source "${dbsyncutil}remote_retrieve.sh"
+source "${dbsyncutil}cleanup.sh"
 source "${dbsyncutil}local_backup.sh"
 source "${dbsyncutil}url_update.sh"
 
diff --git a/example.conf b/example.conf
@@ -6,6 +6,8 @@ remote_username=magento
 remote_magento_dir=/opt/magento/magento2
 remote_backup_dir=/opt/magento/backups
 remote_shared_deployment_dir=/opt/magento/deployment/shared/magento
+remote_php_path="/usr/bin/php"
+remote_n98_path="/usr/local/bin/n98-magerun"
 local_backup_dir=/opt/magento/backups
 local_shared_deployment_dir=/opt/magento/deployment/shared/magento
 local_file_user=magento
diff --git a/install.sh b/install.sh
@@ -7,7 +7,7 @@
   }
 
   dbsync_latest_version() {
-    echo "v1.7.3"
+    echo "v1.8.0"
   }
 
   #
diff --git a/localinstall.sh b/localinstall.sh
@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+
+homedir=$( getent passwd "$USER" | cut -d: -f6 )
+dbsync=$homedir/.dbsync
+
+echo -e " Installing locally"
+tar c ./ | pv | tar x -C $dbsync
+echo -e " Installation complete!"
diff --git a/utils/cleanup.sh b/utils/cleanup.sh
@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+echo
+printf "${bg_black}${txt_white}%-80s${txt_end}\n" " "
+printf "${bg_black}${txt_white}%-80s${txt_end}\n" " Deleting backups. "
+printf "${bg_black}${txt_white}%-80s${txt_end}\n" " "
+
+# Delete remote db backups
+ssh -p "${remote_port}" "${remote_username}@${remote_host}" rm -f $remote_backup_dir/latest-m2.sql.gz
+ssh -p "${remote_port}" "${remote_username}@${remote_host}" rm -f $remote_backup_dir/latest-wp.sql.gz
diff --git a/utils/local_imagery_import.sh b/utils/local_imagery_import.sh
@@ -10,6 +10,6 @@ source=("/pub/media/" "/wp/wp-content/uploads/")
 dest=("${local_shared_deployment_dir}/pub/media/" "${local_shared_deployment_dir}/wp/wp-content/uploads/")
 
 for i in "${!source[@]}"; do
-    rsync --recursive --links --human-readable --partial --progress --compress --perms --exclude 'cache*' -e "ssh -p${remote_port}" "$remote_username@$remote_host:$remote_shared_deployment_dir${source[$i]}" "${dest[$i]}"
+    rsync --recursive --links --human-readable --partial --progress --compress --perms --exclude={'cache*','sozo_imagify/*'} -e "ssh -p${remote_port}" "$remote_username@$remote_host:$remote_shared_deployment_dir${source[$i]}" "${dest[$i]}"
     sudo chown -R $local_file_user:$local_file_group "${dest[$i]}"
 done
diff --git a/utils/menu.sh b/utils/menu.sh
@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-version="1.7.3"
+version="1.8.0"
 
 die()
 {
@@ -26,6 +26,7 @@ _arg_full="off"
 _arg_local_backup="off"
 _arg_prefix="off"
 _arg_wordpress="off"
+_arg_yes="off"
 
 dbsync_print_help() {
   cat <<HEREDOC
@@ -103,6 +104,18 @@ parse_commandline()
 					{ begins_with_short_option "$_next" && shift && set -- "-w" "-${_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
 				;;
+			-y|--no-yes|--yes)
+				_arg_yes="on"
+				test "${1:0:5}" = "--no-" && _arg_yes="off"
+				;;
+			-y*)
+				_arg_yes="on"
+				_next="${_key##-y}"
+				if test -n "$_next" -a "$_next" != "$_key"
+				then
+					{ begins_with_short_option "$_next" && shift && set -- "-y" "-${_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
+				;;
 			-v|--version)
 				echo db-sync.sh - v$version
 				exit 0
diff --git a/utils/read_ini.sh b/utils/read_ini.sh
@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+__shini_parsed()
+{
+    declare $2=\"$3\"
+}
+
+shini_parse "$ini_file"
+
+printenv
diff --git a/utils/remote_backup.sh b/utils/remote_backup.sh
@@ -48,10 +48,23 @@ ssh -p "${remote_port}" "${remote_username}@${remote_host}" <<ENDSSH
 mkdir -p $remote_backup_dir
 cd $remote_magento_dir
 
+# Check the commands are available
+if ! command -v $remote_php_path &> /dev/null
+then
+    echo "$remote_php_path could not be found"
+    exit
+fi
+
+if ! command -v $remote_n98_path &> /dev/null
+then
+    echo "$remote_n98_path could not be found"
+    exit
+fi
+
 if [ $_arg_full == 'on' ]; then
-n98-magerun --quiet --no-interaction db:dump --no-tablespaces --compression="gzip" --strip="@log @sessions" --force $remote_backup_dir/latest-m2.sql.gz
+$remote_php_path $remote_n98_path --quiet --no-interaction db:dump --no-tablespaces --compression="gzip" --strip="@log @sessions" --force $remote_backup_dir/latest-m2.sql.gz
 else
-n98-magerun --quiet --no-interaction db:dump --no-tablespaces --compression="gzip" --strip="@log @sessions @trade @sales $ignore_tables" --force $remote_backup_dir/latest-m2.sql.gz
+$remote_php_path $remote_n98_path --quiet --no-interaction db:dump --no-tablespaces --compression="gzip" --strip="@log @sessions @trade @sales @idx @aggregated @temp @newrelic_reporting $ignore_tables" --force $remote_backup_dir/latest-m2.sql.gz
 fi
 
 if [ $_arg_wordpress == 'on' ]; then
diff --git a/utils/set_constants.sh b/utils/set_constants.sh
@@ -56,6 +56,7 @@ function existRemoteFile ()
     fi
 }
 
+ini_file=../db-sync.ini
 conf_file=../backup.conf
 
 DB_HOST=$(n98-magerun config:env:show db.connection.default.host)
diff --git a/utils/set_remote_host.sh b/utils/set_remote_host.sh
@@ -99,4 +99,6 @@ printf "${txt_green}%-40s ${txt_yellow}%-40s${txt_end}\n" " Username:" "${remote
 printf "${txt_green}%-40s ${txt_yellow}%-40s${txt_end}\n" " Host Magento Dir:" "${remote_magento_dir}"
 printf "${txt_green}%-40s ${txt_yellow}%-40s${txt_end}\n" " Host Backup Dir:" "${remote_backup_dir}"
 printf "${txt_green}%-40s ${txt_yellow}%-40s${txt_end}\n" " Host Shared Deployment Backup Dir:" "${remote_shared_deployment_dir}"
+printf "${txt_green}%-40s ${txt_yellow}%-40s${txt_end}\n" " Remote PHP Bin:" "${remote_php_path}"
+printf "${txt_green}%-40s ${txt_yellow}%-40s${txt_end}\n" " Remote n98-magerun Bin:" "${remote_n98_path}"
 echo
diff --git a/utils/shini.sh b/utils/shini.sh

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`}`
`8`	`8`
`9`	`9`	`dbsync_latest_version() {`
`10`		`- echo "v1.7.3"`
	`10`	`+ echo "v1.8.0"`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`#`