Merge branch 'release/v1.1.0'

Author: clivewalkden

CHANGELOG.md

@@ -0,0 +1,21 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [1.1.0] - 2020-07-10
+### Added
+- Installer
+- Example [config file](./example.conf)
+- [Changelog](./CHANGELOG.md)
+
+### Changed
+- README.md includes more information
+
+
+## [1.0.0] - 2020-07-09
+### Added
+- Initial Release

README.md

@@ -1,8 +1,32 @@
-# Magento 2 Production DB Sync v1.0.0
+# Magento 2 Production DB Sync v1.1.0
 
-A script to copy over a production database to a staging server.
+## About
+A script to copy over a production database to another server, also has the ability to copy across imagery.
 
-You can save a configuration file in the Magento directory to save answering some of the questions.
+Currently the script is configured to attempt Magento 2 and WordPress database migrations and assumes you have your WordPress database details configured in the `magento/app/etc/env.php` file as a second `connection`.
+
+## Requirements
+- You need curl installed locally. 
+- The excellent [n98-magerun2](https://github.com/netz98/n98-magerun2) needs to be installed on both the local machine and the production machine. (Needs to be executable as n98-magerun).
+- 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.
+
+## 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.1.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. 
+
+> Notes: If using SSH to connect to the host machine make sure you've connected with the -A flag so that your ssh agent is forwarded to allow additional connections. 
+
+Execute the script in your Magento directory
+```
+$ db-sync.sh
+```
+
+You can save a configuration file in the Magento directory to save answering some of the questions. An example is included in this repository [example.conf](./example.conf)
 
 ```bash
 remote_host=cotswoldcollections.com
@@ -14,4 +38,3 @@ remote_backup_dir=/opt/magento/backups
 remote_shared_deployment_dir=/opt/magento/deployment/shared/magento
 ```
 
-| Notes: Make sure you've connected to the host machine with the -A flag so that your ssh agent is forwarded to allow additional connections.

example.conf

@@ -0,0 +1,8 @@
+# Configuration file for db-sync (https://github.com/clivewalkden/bash-magento2-db-sync)
+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

install.sh

@@ -0,0 +1,118 @@
+#!/usr/bin/env bash
+
+{ # this ensures the entire script is downloaded #
+
+dbsync_install_dir() {
+    printf %s "${HOME}/.dbsync"
+}
+
+dbsync_latest_version() {
+  echo "v1.1.0"
+}
+
+#
+# Outputs the location to DB Sync depending on:
+# * The availability of $GIT_SOURCE
+#
+dbsync_source() {
+  local DBSYNC_METHOD
+  DBSYNC_METHOD="$1"
+  local DBSYNC_SOURCE_URL
+  DBSYNC_SOURCE_URL="https://github.com/clivewalkden/bash-magento2-db-sync.git"
+  echo "$DBSYNC_SOURCE_URL"
+}
+
+do_install() {
+    local INSTALL_DIR
+    INSTALL_DIR="$(dbsync_install_dir)"
+
+    # Downloading to $INSTALL_DIR
+    mkdir -p "$INSTALL_DIR"
+    if [ -f "$INSTALL_DIR/db-sync.sh" ]; then
+        echo "=> db-sync is already installed in $INSTALL_DIR, trying to update the script"
+    else
+        echo "=> Downloading db-sync as script to '$INSTALL_DIR'"
+    fi
+
+    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 || {
+        echo >&2 "Failed to update db-sync, run 'git fetch' in $INSTALL_DIR yourself."
+        exit 1
+        }
+    else
+        # Cloning to $INSTALL_DIR
+        echo "=> Downloading db-sync from git to '$INSTALL_DIR'"
+        command printf '\r=> '
+        mkdir -p "${INSTALL_DIR}"
+        if [ "$(ls -A "${INSTALL_DIR}")" ]; then
+        command git init "${INSTALL_DIR}" || {
+            echo >&2 'Failed to initialize db-sync repo. Please report this!'
+            exit 2
+        }
+        command git --git-dir="${INSTALL_DIR}/.git" remote add origin "$(dbsync_source)" 2> /dev/null \
+            || command git --git-dir="${INSTALL_DIR}/.git" remote set-url origin "$(dbsync_source)" || {
+            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 || {
+            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}" || {
+            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)"
+    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
+        else
+        echo >&2 "Your version of git is out of date. Please update it!"
+        command git --git-dir="$INSTALL_DIR"/.git --work-tree="$INSTALL_DIR" branch -D master >/dev/null 2>&1
+        fi
+    fi
+
+    echo "=> Compressing and cleaning up git repository"
+    if ! command git --git-dir="$INSTALL_DIR"/.git --work-tree="$INSTALL_DIR" reflog expire --expire=now --all; then
+        echo >&2 "Your version of git is out of date. Please update it!"
+    fi
+    if ! command git --git-dir="$INSTALL_DIR"/.git --work-tree="$INSTALL_DIR" gc --auto --aggressive --prune=now ; then
+        echo >&2 "Your version of git is out of date. Please update it!"
+    fi
+
+    local PROFILE_INSTALL_DIR
+    PROFILE_INSTALL_DIR="$(dbsync_install_dir | command sed "s:^$HOME:\$HOME:")"
+    SOURCE_STR="\\nexport DBSYNC_DIR=\"${PROFILE_INSTALL_DIR}\"\\nif [ -f \"\$DBSYNC_DIR/db-sync.sh\" ]; then\\n\t export PATH=\"$INSTALL_DIR:\$PATH\"\\nfi  # This loads db-sync\\n"
+    local DBSYNC_PROFILE
+    DBSYNC_PROFILE="${HOME}/.bashrc"
+
+    if ! command grep -qc '/db-sync.sh' "${DBSYNC_PROFILE}"; then
+      echo "=> Appending db-sync source string to ${DBSYNC_PROFILE}"
+      command printf "${SOURCE_STR}" >> "${DBSYNC_PROFILE}"
+    else
+      echo "=> db-sync source string already in ${DBSYNC_PROFILE}"
+    fi
+
+    \. "${DBSYNC_PROFILE}"
+
+    dbsync_reset
+
+    echo "=> Close and reopen your terminal to start using db-sync.sh"
+}
+
+#
+# Unsets the various functions defined
+# during the execution of the install script
+#
+dbsync_reset() {
+  unset -f dbsync_install_dir dbsync_latest_version dbsync_source do_install
+}
+
+do_install
+
+} # this ensures the entire script is downloaded #