Merge upstream (#84)

* Skip hookshot es backup on pre 2.0

* Only restore hookshot es backup to cluster

* Correct minor spelling error

* Backup and restore ca certificates

* Don't suppress output

* Check if command exists so to expose errors

* Backup not restore

* Use which instead of type to verify existence

* Silence test output

* Run bm_file_path first

* Revert removal of bm_file_path from bm_start

In case bm.sh is used outside or independently of ghe-backup or
ghe-restore, such as when testing backup utilities individual
components.

* Rename bm_file_path to bm_init

Should make the intention a bit more clear.

* Add --version flag to all commands

* Check for missing GHE_DATA_DIR variable in config

```
$ ./bin/ghe-backup
./bin/../share/github-backup-utils/ghe-backup-config: line 82: [: !=: unary operator expected
mkdir: : No such file or directory
```

These errors occur because `GHE_DATA_DIR` is not defined before running`ghe-backup-config`, causing it to throw errors.

```
$ ./share/github-backup-utils/ghe-backup-config
./share/github-backup-utils/ghe-backup-config: line 82: [: !=: unary operator expected
mkdir: : No such file or directory
Error: GHE_DATA_DIR  does not exist.
```

This change adds a test to ensure `GHE_DATA_DIR` is defined, else return an appropriate error.

```
$ ./bin/ghe-backup
Error: GHE_DATA_DIR not set in config file.
$ ./share/github-backup-utils/ghe-backup-config
Error: GHE_DATA_DIR not set in config file.
```

* Check backup-utils are not being run on GitHub Enterprise host

Customers occasionally configure backup-utils to run on the GitHub Enterprise
host or HA replica. Apart from losing their backup if the appliance is lost,
it leads to running out of disk space issues.

This PR adds a check for this case and returns an informative error to guide the user.

Author: rubiojr

README.md

@@ -172,7 +172,7 @@ enable when output is logged to a file.
 
 When restoring to an already configured GHE instance, settings, certificate, and license data
 are *not* restored to prevent overwriting manual configuration on the restore
-host. This behavior can be overriden by passing the `-c` argument to `ghe-restore`,
+host. This behavior can be overridden by passing the `-c` argument to `ghe-restore`,
 forcing settings, certificate, and license data to be overwritten with the backup copy's data.
 
 ### Scheduling backups

bin/ghe-backup

@@ -120,6 +120,9 @@ if [ "$GHE_BACKUP_STRATEGY" = "tarball" ]; then
     GHE_MAINTENANCE_MODE_ENABLED=true
 fi
 
+# Create benchmark file
+bm_init > /dev/null
+
 ghe-backup-store-version  ||
 echo "Warning: storing backup-utils version remotely failed."
 
@@ -159,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

@@ -203,6 +203,9 @@ if $instance_configured; then
     fi
 fi
 
+# Create benchmark file
+bm_init > /dev/null
+
 ghe-backup-store-version  ||
 echo "Warning: storing backup-utils version remotely failed."
 
@@ -328,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/bm.sh

@@ -18,10 +18,10 @@ bm_start()
 {
   eval "$(bm_desc_to_varname $@)_start=$(date +%s)"
 
-  bm_file_path > /dev/null
+  bm_init > /dev/null
 }
 
-bm_file_path() {
+bm_init() {
   if [ -n "$BM_FILE_PATH" ]; then
     echo $BM_FILE_PATH
     return

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

@@ -45,7 +45,7 @@ if [ "$GHE_VERSION_MAJOR" -ge 2 ]; then
     fi
 fi
 
-if ghe-ssh "$host" -- "which ghe-export-ssl-ca-certificates"; then
+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