Merge branch 'release/v1.7.0'

Author: clivewalkden

CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [1.7.0] - 2021-04-27
+### Added
+- New flag to add prefix to sales orders, invoices, credit memos and shipments.
+- Ability to change installed version when installing.
+
+### Changed
+- Call to the site url changed and backup added.
+
+
 ## [1.6.0] - 2020-10-16
 ### Added
 - Added ignore tables option for the main config which is passed to n98-magerun2.

MENU.md

@@ -4,12 +4,13 @@ Use the below to generate the menu.sh file from the site [https://argbash.io/gen
 
 ```
 #!/bin/bash
-# version="1.5.1"
+# version="1.7.0"
 #
 # 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_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_VERSION([echo test v$version])
 # ARG_HELP([The general script's help msg])

README.md

@@ -1,4 +1,4 @@
-# Magento 2 Production DB Sync v1.5.1
+# Magento 2 Production DB Sync v1.7.0
 
 ## About
 A script to copy over a production database to another server, also has the ability to copy across imagery.
@@ -11,6 +11,7 @@ Currently the script is configured to attempt Magento 2 and WordPress database m
 - MySQL (or equivalent) needs to be installed on both the local machine and the server (obviously).
 - Magento 2 needs to be installed and configured on both the local and the host machine.
 - rsync needs to be installed locally.
+- Magento URL's set in the env.php file `system.default.web.secure.base_url`.
 
 ## Installing and Updating
 To install or update the script run the following curl script

db-sync.sh

@@ -71,6 +71,11 @@ while true; do
   esac
 done
 
+# Add prefix to sequence table
+if [ $_arg_prefix == 'on' ]; then
+  source "${dbsyncutil}prefix.sh";
+fi
+
 # Import latest imagery
 while true; do
   echo -e "\n"

install.sh

@@ -7,7 +7,7 @@
   }
 
   dbsync_latest_version() {
-    echo "v1.6.0"
+    echo "v1.7.0"
   }
 
   #
@@ -22,6 +22,15 @@
     echo "$DBSYNC_SOURCE_URL"
   }
 
+  dbsync_version() {
+    local DBSYNC_VERSION="$(dbsync_latest_version)"
+    if [ ! -z $1]; then
+      DBSYNC_VERSION="$1"
+    fi
+
+    echo "$DBSYNC_VERSION"
+  }
+
   do_install() {
     local INSTALL_DIR
     INSTALL_DIR="$(dbsync_install_dir)"
@@ -37,7 +46,7 @@
     if [ -d "$INSTALL_DIR/.git" ]; then
       echo "=> db-sync is already installed in $INSTALL_DIR, trying to update using git"
       command printf '\r=> '
-      command git --git-dir="$INSTALL_DIR"/.git --work-tree="$INSTALL_DIR" fetch origin tag "$(dbsync_latest_version)" --depth=1 2>/dev/null || {
+      command git --git-dir="$INSTALL_DIR"/.git --work-tree="$INSTALL_DIR" fetch origin tag "$(dbsync_version $1)" --depth=1 2>/dev/null || {
         echo >&2 "Failed to update db-sync, run 'git fetch' in $INSTALL_DIR yourself."
         exit 1
       }
@@ -56,18 +65,18 @@
           echo >&2 'Failed to add remote "origin" (or set the URL). Please report this!'
           exit 2
         }
-        command git --git-dir="${INSTALL_DIR}/.git" fetch origin tag "$(dbsync_latest_version)" --depth=1 || {
+        command git --git-dir="${INSTALL_DIR}/.git" fetch origin tag "$(dbsync_version $1)" --depth=1 || {
           echo >&2 'Failed to fetch origin with tags. Please report this!'
           exit 2
         }
       else
-        command git -c advice.detachedHead=false clone "$(dbsync_source)" -b "$(dbsync_latest_version)" --depth=1 "${INSTALL_DIR}" || {
+        command git -c advice.detachedHead=false clone "$(dbsync_source)" -b "$(dbsync_version $1)" --depth=1 "${INSTALL_DIR}" || {
           echo >&2 'Failed to clone dbsync repo. Please report this!'
           exit 2
         }
       fi
     fi
-    command git -c advice.detachedHead=false --git-dir="$INSTALL_DIR"/.git --work-tree="$INSTALL_DIR" checkout -f --quiet "$(dbsync_latest_version)"
+    command git -c advice.detachedHead=false --git-dir="$INSTALL_DIR"/.git --work-tree="$INSTALL_DIR" checkout -f --quiet "$(dbsync_version $1)"
     if [ -n "$(command git --git-dir="$INSTALL_DIR"/.git --work-tree="$INSTALL_DIR" show-ref refs/heads/master)" ]; then
       if command git --git-dir="$INSTALL_DIR"/.git --work-tree="$INSTALL_DIR" branch --quiet 2>/dev/null; then
         command git --git-dir="$INSTALL_DIR"/.git --work-tree="$INSTALL_DIR" branch --quiet -D master >/dev/null 2>&1
@@ -110,7 +119,7 @@
   # during the execution of the install script
   #
   dbsync_reset() {
-    unset -f dbsync_install_dir dbsync_latest_version dbsync_source do_install
+    unset -f dbsync_install_dir dbsync_latest_version dbsync_version dbsync_source do_install
   }
 
   do_install

utils/menu.sh

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-version="1.6.0"
+version="1.7.0"
 
 die()
 {
@@ -24,6 +24,7 @@ begins_with_short_option()
 # THE DEFAULTS INITIALIZATION - OPTIONALS
 _arg_full="off"
 _arg_local_backup="off"
+_arg_prefix="off"
 _arg_wordpress="off"
 
 dbsync_print_help() {
@@ -35,10 +36,11 @@ dbsync_print_help() {
 
   Make sure you are in a Magento 2 directory before trying to run any scripts.
 
-  Usage: db-sync.sh [-b|--local-backup] [-f|--full] [-w|--wordpress] [-v|--version] [-h|--help]
+  Usage: db-sync.sh [-b|--local-backup] [-f|--full] [-p|--prefix] [-w|--wordpress] [-v|--version] [-h|--help]
   Options:
     -b, --local-backup: perform a backup before importing remote (off by default)
     -f, --full: full database dump (off by default)
+    -p, --prefix: prefix invoices, orders, shipments etc (off by default)
     -w, --wordpress: include wordpress content (off by default)"
     -v, --version: Prints version
     -h, --help: Prints help
@@ -77,6 +79,18 @@ 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
 				;;
+			-p|--no-prefix|--prefix)
+				_arg_prefix="on"
+				test "${1:0:5}" = "--no-" && _arg_prefix="off"
+				;;
+			-p*)
+				_arg_prefix="on"
+				_next="${_key##-p}"
+				if test -n "$_next" -a "$_next" != "$_key"
+				then
+					{ begins_with_short_option "$_next" && shift && set -- "-p" "-${_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
+				;;
 			-w|--no-wordpress|--wordpress)
 				_arg_wordpress="on"
 				test "${1:0:5}" = "--no-" && _arg_wordpress="off"

utils/prefix.sh

@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+# Run the prefix information to the sequence table
+echo
+echo -e "${txt_blue}  Adding prefix to Magento Orders, Invoices, Credit Memo's and Shipping Notes.${txt_end}"
+echo
+
+mysql -h$DB_HOST -u$DB_USER -p$DB_PASS -D$DB_DBASE <<EOF
+UPDATE sales_sequence_profile SET prefix = IFNULL(CONCAT("TEST", prefix, "-"), "TEST-")
+EOF

utils/url_update.sh

@@ -5,8 +5,11 @@ echo -e ""
 echo -e "${txt_blue}  Update the database urls to current environment.${txt_end}"
 echo -e ""
 
-# TODO: need to catch if this fails
-CURRENT_URL=$(n98-magerun config:show web/secure/base_url)
+# Get the URL from n98, if the first option fails it'll try the next
+if ! CURRENT_URL=$(n98-magerun config:env:show system.default.web.secure.base_url); then
+    CURRENT_URL=$(n98-magerun config:show web/secure/base_url)
+fi
+
 new_domain=${CURRENT_URL,,}
 # remove http://
 new_domain=$(printf '%s' "${new_domain}" | sed 's/^http:\/\///g')