Merge branch 'master' into snh/benchmark-init

Author: rubiojr

bin/ghe-backup

@@ -1,5 +1,5 @@
 #!/usr/bin/env bash
-#/ Usage: ghe-backup [-v]
+#/ Usage: ghe-backup [-v] [--version]
 #/ Take snapshots of all GitHub Enterprise data, including Git repository data,
 #/ the MySQL database, instance settings, GitHub Pages data, etc.
 #/
@@ -162,11 +162,11 @@ if [ $GHE_VERSION_MAJOR -ge 2 ]; then
   echo "Backing up audit log ..."
   ghe-backup-es-audit-log ||
   failures="$failures audit-log"
-fi
 
-echo "Backing up hookshot logs ..."
-ghe-backup-es-hookshot ||
-failures="$failures hookshot"
+  echo "Backing up hookshot logs ..."
+  ghe-backup-es-hookshot ||
+  failures="$failures hookshot"
+fi
 
 echo "Backing up Git repositories ..."
 if [ "$GHE_BACKUP_STRATEGY" = "cluster" ]; then

bin/ghe-restore

@@ -6,6 +6,7 @@
 #/ argument is provided, it always overrides the configured restore host.
 #/
 #/ Options:
+#/   --version         Display version information.
 #/   -f                Don't prompt for confirmation before restoring.
 #/   -c                Restore appliance settings and license in addition to
 #/                     datastores. Settings are not restored by default to
@@ -330,14 +331,14 @@ fi
 if $cluster; then
   echo "Restoring ElasticSearch Audit logs"
   ghe-restore-es-audit-log "$GHE_HOSTNAME" 1>&3
+
+  echo "Restoring hookshot logs ..."
+  ghe-restore-es-hookshot "$GHE_HOSTNAME" 1>&3
 else
   echo "Restoring Elasticsearch indices ..."
   ghe-restore-es-${GHE_BACKUP_STRATEGY} "$GHE_HOSTNAME" 1>&3
 fi
 
-echo "Restoring hookshot logs ..."
-ghe-restore-es-hookshot "$GHE_HOSTNAME" 1>&3
-
 # Restart an already running memcached to reset the cache after restore
 if [ "$GHE_VERSION_MAJOR" -ge 2 ]; then
     echo "Restarting memcached ..." 1>&3

share/github-backup-utils/ghe-backup-config

@@ -25,6 +25,12 @@ PATH="$GHE_BACKUP_ROOT/bin:$GHE_BACKUP_ROOT/share/github-backup-utils:$PATH"
 
 . $GHE_BACKUP_ROOT/share/github-backup-utils/bm.sh
 
+# Display version string if flag present for any command
+if [ "$1" = "--version" ]; then
+    echo "GitHub backup-utils v$BACKUP_UTILS_VERSION"
+    exit 0
+fi
+
 # Parse out -v (verbose) argument
 if [ "$1" = "-v" ]; then
     GHE_VERBOSE=true
@@ -83,6 +89,18 @@ if [ ${GHE_DATA_DIR:0:1} != "/" ]; then
   GHE_DATA_DIR="$( cd "$GHE_BACKUP_ROOT" && readlink -m "$GHE_DATA_DIR" 2> /dev/null || echo "$GHE_BACKUP_ROOT/$GHE_DATA_DIR" )"
 fi
 
+# Assign the Release File path if it hasn't been provided (eg: by test suite)
+: ${GHE_RELEASE_FILE:="/etc/github/enterprise-release"}
+
+# Check that utils are not being run directly on GHE appliance.
+if [ -f "$GHE_RELEASE_FILE" ]; then
+  echo "Error: Backup Utils cannot be run on the GitHub Enterprise host." 1>&2
+  echo "       The backup utilities should be run on a host dedicated to" 1>&2
+  echo "       long-term permanent storage and must have network connectivity" 1>&2
+  echo "       with the GitHub Enterprise appliance." 1>&2
+  exit 1
+fi
+
 GHE_CREATE_DATA_DIR=${GHE_CREATE_DATA_DIR:-yes}
 
 # Check that the data directory is set and create it if it doesn't exist.

share/github-backup-utils/ghe-backup-settings

@@ -1,6 +1,6 @@
 #!/usr/bin/env bash
 #/ Usage: ghe-backup-settings
-#/ Restore settings from a snapshot to the given <host>.
+#/ Backup settings from a snapshot to the given <host>.
 set -e
 
 # Bring in the backup configuration
@@ -45,6 +45,11 @@ if [ "$GHE_VERSION_MAJOR" -ge 2 ]; then
     fi
 fi
 
+if ghe-ssh "$host" -- "which ghe-export-ssl-ca-certificates 1>/dev/null"; then
+  echo "* Transferring CA certificates ..." 1>&3
+  ghe-ssh "$host" -- "ghe-export-ssl-ca-certificates" > ssl-ca-certificates.tar
+fi
+
 if [ "$GHE_BACKUP_STRATEGY" = "cluster" ]; then
   echo "* Transferring cluster configuration ..." 1>&3
   if ! ghe-ssh "$host" -- "sudo cat $GHE_REMOTE_CLUSTER_CONF_FILE 2>/dev/null" > cluster.conf; then

share/github-backup-utils/ghe-restore-settings

@@ -58,4 +58,11 @@ if [ -f "$GHE_RESTORE_SNAPSHOT_PATH/saml-keys.tar" ]; then
     ghe-ssh "$GHE_HOSTNAME" -- "sudo tar -C $GHE_REMOTE_DATA_USER_DIR/common/ -xf -"
 fi
 
+# Restore CA certificates if present.
+if [ -f "$GHE_RESTORE_SNAPSHOT_PATH/ssl-ca-certificates.tar" ]; then
+    echo "Restoring CA certificates ..."
+    cat "$GHE_RESTORE_SNAPSHOT_PATH/ssl-ca-certificates.tar" |
+    ghe-ssh "$GHE_HOSTNAME" -- "ghe-import-ssl-ca-certificates"
+fi
+
 bm_start "$(basename $0)"

test/bin/ghe-export-ssl-ca-certificates

@@ -0,0 +1 @@
+ghe-fake-export-command

test/bin/ghe-import-ssl-ca-certificates

@@ -0,0 +1 @@
+ghe-fake-import-command

test/test-ghe-backup-config.sh

@@ -41,6 +41,26 @@ begin_test "ghe-backup-config GHE_CREATE_DATA_DIR disabled"
 )
 end_test
 
+begin_test "ghe-backup-config run on GHE appliance"
+(
+    set -e
+
+    export GHE_RELEASE_FILE="$TRASHDIR/enterprise-release"
+    touch "$GHE_RELEASE_FILE"
+    set +e
+    error=$(. share/github-backup-utils/ghe-backup-config 2>&1)
+    # should exit 1
+    if [ $? != 1 ]; then
+      exit 1
+    fi
+    set -e
+    echo "$error" | grep -q "Error: Backup Utils cannot be run on the GitHub Enterprise host."
+
+    test -f "$GHE_RELEASE_FILE"
+    rm -rf "$GHE_RELEASE_FILE"
+)
+end_test
+
 begin_test "ghe-backup-config ssh_host_part"
 (
     set -e
@@ -51,7 +71,6 @@ begin_test "ghe-backup-config ssh_host_part"
 )
 end_test
 
-
 begin_test "ghe-backup-config ssh_port_part"
 (
     set -e

test/test-ghe-backup.sh

@@ -151,6 +151,9 @@ begin_test "ghe-backup first snapshot"
 
         # verify the UUID was transferred
         diff -ru "$GHE_REMOTE_DATA_USER_DIR/common/uuid" "$GHE_DATA_DIR/current/uuid"
+
+        # check that ca certificates were backed up
+        [ "$(cat "$GHE_DATA_DIR/current/ssl-ca-certificates.tar")" = "fake ghe-export-ssl-ca-certificates data" ]
     fi
 
     # verify that ghe-backup wrote its version information to the host
@@ -235,6 +238,9 @@ begin_test "ghe-backup subsequent snapshot"
 
         # verify the UUID was transferred
         diff -ru "$GHE_REMOTE_DATA_USER_DIR/common/uuid" "$GHE_DATA_DIR/current/uuid"
+
+        # check that ca certificates were backed up
+        [ "$(cat "$GHE_DATA_DIR/current/ssl-ca-certificates.tar")" = "fake ghe-export-ssl-ca-certificates data" ]
     fi
 )
 end_test
@@ -335,6 +341,9 @@ begin_test "ghe-backup with relative data dir path"
 
         # verify the UUID was transferred
         diff -ru "$GHE_REMOTE_DATA_USER_DIR/common/uuid" "$GHE_DATA_DIR/current/uuid"
+
+        # check that ca certificates were backed up
+        [ "$(cat "$GHE_DATA_DIR/current/ssl-ca-certificates.tar")" = "fake ghe-export-ssl-ca-certificates data" ]
     fi
 
     # verify that ghe-backup wrote its version information to the host

test/test-ghe-restore.sh

@@ -79,6 +79,7 @@ echo "fake ghe-export-es-indices data" > "$GHE_DATA_DIR/current/elasticsearch.ta
 echo "fake ghe-export-ssh-host-keys data" > "$GHE_DATA_DIR/current/ssh-host-keys.tar"
 echo "fake ghe-export-repositories data" > "$GHE_DATA_DIR/current/repositories.tar"
 echo "fake ghe-export-settings data" > "$GHE_DATA_DIR/current/settings.json"
+echo "fake ghe-export-ssl-ca-certificates data" > "$GHE_DATA_DIR/current/ssl-ca-certificates.tar"
 echo "fake license data" > "$GHE_DATA_DIR/current/enterprise.ghl"
 echo "fake manage password hash data" > "$GHE_DATA_DIR/current/manage-password"
 echo "rsync" > "$GHE_DATA_DIR/current/strategy"
@@ -288,6 +289,9 @@ begin_test "ghe-restore -c into unconfigured vm"
 
         # verify the UUID was transferred
         diff -ru "$GHE_DATA_DIR/current/uuid" "$GHE_REMOTE_DATA_USER_DIR/common/uuid"
+
+        # verify ghe-export-ssl-ca-certificates was run
+        grep -q "fake ghe-export-ssl-ca-certificates data" "$TRASHDIR/restore-out"
     fi
 )
 end_test
@@ -356,6 +360,9 @@ begin_test "ghe-restore into unconfigured vm"
         # verify the UUID was transferred
         diff -ru "$GHE_DATA_DIR/current/uuid" "$GHE_REMOTE_DATA_USER_DIR/common/uuid"
 
+        # verify ghe-export-ssl-ca-certificates was run
+        grep -q "fake ghe-export-ssl-ca-certificates data" "$TRASHDIR/restore-out"
+
         # verify no config run after restore on unconfigured instance
         ! grep -q "ghe-config-apply OK" "$TRASHDIR/restore-out"
     fi