syncdb.sh

#!/usr/bin/env bash

# Local dependencies:
# - drush
# - rsync
# - drush aliases (automatically setup with `vagrant up`)

# Function to parse the project configuration yaml.
function parse_yaml {
   local prefix=$2
   local s='[[:space:]]*' w='[a-zA-Z0-9_]*' fs=$(echo @|tr @ '\034')
   sed -ne "s|^\($s\):|\1|" \
        -e "s|^\($s\)\($w\)$s:$s[\"']\(.*\)[\"']$s\$|\1$fs\2$fs\3|p" \
        -e "s|^\($s\)\($w\)$s:$s\(.*\)$s\$|\1$fs\2$fs\3|p"  $1 |
   awk -F$fs '{
      indent = length($1)/2;
      vname[indent] = $2;
      for (i in vname) {if (i > indent) {delete vname[i]}}
      if (length($3) > 0) {
         vn=""; for (i=0; i<indent; i++) {vn=(vn)(vname[i])("_")}
         printf("%s%s%s=\"%s\"\n", "'$prefix'",vn, $2, $3);
      }
   }'
}

pushd `dirname $0` > /dev/null
ROOT=`pwd -P`
popd > /dev/null

PROJECTCONF=$ROOT/conf/project.yml
eval $(parse_yaml $PROJECTCONF)

# Get config from flags. We are doing this here so that flags override project
# config.
#
# Use -gt 1 to consume two arguments per pass in the loop (e.g. each
# argument has a corresponding value to go with it).
# Use -gt 0 to consume one or more arguments per pass in the loop (e.g.
# some arguments don't have a corresponding value to go with it such
# as in the --help example).
while [[ $# -gt 0 ]]
do
key="$1"

case $key in
    -n|--name)
    project_name="$2"
    shift # Past argument
    ;;
    -s|--source)
    SOURCE="$2"
    shift # Past argument
    ;;
    -t|--target)
    TARGET="$2"
    shift # Past argument
    ;;
    -f|--file-sync-url)
    project_file_sync_url="$2"
    shift # Past argument
    ;;
    -h|--help)
    echo "Usage: ./syncdb.sh [options]
Example: ./syncdb.sh -n example1 -s prod -t local -f https://www.example1.com
Options:
  -n PROJECT_NAME, --name PROJECT_NAME  Specify the project name used as Drush
                                        aliases prefix. Defaults to
                                        'project: name' in 'conf/project.yml'.
  -s SOURCE, --source SOURCE            Specify the source environment for
                                        the sync. Defaults to 'prod'. Needs to
                                        match a Drush alias name.
  -t TARGET, --target TARGET            Specify the target environment for
                                        the sync. Defaults to 'local'. Needs to
                                        match a Drush alias name.
  -f URL, --file-sync-url URL           Specify the URL of the environment used
                                        for file sync for example with
                                        Stage File Proxy module. Defaults to
                                        the SOURCE URI, but can also be set
                                        globally by 'project: file_sync_url' in
                                        'conf/project.yml'.
  -h, --help                            Print this help.
"
    exit
    ;;
    *)
      # Unknown option
    ;;
esac
shift # Past argument or value
done

# Make sure we have the $project_name
if [ -z "$project_name" ]; then
  echo "Project name missing. Set in 'conf/project.yml' or use -p flag. Use -h for more help."
  exit
fi

# Default $SOURCE to "prod".
if [ -z "$SOURCE" ]; then
  echo "Source defaults to 'prod'. Set with -s flag. Use -h to see all options."
  SOURCE="@$project_name.prod"
else
  SOURCE="@$project_name.$SOURCE"
fi

# Default $TARGET to "local". Prevent "prod" and "production".
if [ -z "$TARGET" ]; then
  echo "Target defaults to 'local'. Set with -t flag. Use -h to see all options."
  TARGET="@$project_name.local"
else
  if [ $TARGET == 'prod' ] || [ $TARGET == 'production' ]; then
    echo "You tried to sync to a production environment!"
    echo "This is probably never the intention, so we always fail such attempts."
    exit
  else
    TARGET="@$project_name.$TARGET"
  fi
fi

# Get the project_file_sync_url to use from SOURCE URI. This requires the URI to
# be in full format including the protocol to use like HTTPS. Only get it if not
# specified in a flag or in project config.
if [ -z "$project_file_sync_url" ]; then
  project_file_sync_url=$(drush $SOURCE status | awk 'NR==2{print $4}')
fi

# Set sync directory with timestamp to allow parallel syncing.
SYNCDIR="/tmp/syncdb/$project_name$(date +%s)"
echo "Using directory $SYNCDIR for syncing."

drush $SOURCE dumpdb --structure-tables-list=cache,cache_*,history,sessions,watchdog --dump-dir=$SYNCDIR

# Make sure the tmp folder exists on the machine where this script is run so that rsync will not fail.
mkdir -p $SYNCDIR

# Make sure the tmp folder is created in the target machine
drush $TARGET ssh "mkdir -p $SYNCDIR"

# --compress-level=1 is used here as testing shows on fast network it's enough compression while at default level (6) we are already bound by the cpu
# on slow connections it might still be worth to use --compress-level=6 which could save around 40% of the bandwith
drush -y rsync --mode=akzi --compress-level=1 $SOURCE:$SYNCDIR $SYNCDIR
# Delete the exported sql files from the source for security.
drush $SOURCE ssh "rm -rf $SYNCDIR"
drush -y rsync --mode=akzi --compress-level=1 $SYNCDIR $TARGET:$SYNCDIR
# Delete the exported sql files from the local machine for security.
rm -rf $SYNCDIR

# Let's not use -y here yet so that we have at least one confirmation in this
# script before we destroy the $TARGET data.
echo "Confirm syncing database to $TARGET"
drush $TARGET sql-drop
drush $TARGET importdb --dump-dir=$SYNCDIR

# Delete the exported sql files from target for security.
drush $TARGET ssh "rm -rf $SYNCDIR"

# Include any project specific sync commands.
if [ -f syncdb_local.sh ]
then
  source syncdb_local.sh
fi

# Get Drupal major version to do version specific commands like cache clearing.
DVER=$(drush $SOURCE status | awk 'NR==1{print substr ($4, 0, 1)}')

# Clear caches after sync.
if [ "$DVER" == '8' ]; then
  drush $TARGET cr
elif [ "$DVER" == '7' ]; then
  drush $TARGET cc all
fi