Merge branch 'master' into lildude/release-improv

Author: lildude

bin/ghe-restore

@@ -271,10 +271,10 @@ bm_end "ghe-import-redis"
 # Unified and enhanced restore method to 2.13.0 and newer
 if $CLUSTER || [ "$(version $GHE_REMOTE_VERSION)" -ge "$(version 2.13.0)" ]; then
   echo "Restoring Git repositories ..."
-  ghe-restore-repositories "$GHE_HOSTNAME" 1>&3
+  ghe-restore-repositories "$GHE_HOSTNAME"
 
   echo "Restoring Gists ..."
-  ghe-restore-repositories-gist "$GHE_HOSTNAME" 1>&3
+  ghe-restore-repositories-gist "$GHE_HOSTNAME"
 else
   echo "Restoring Git repositories and Gists ..."
   ghe-restore-repositories-rsync "$GHE_HOSTNAME" 1>&3

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

@@ -148,8 +148,8 @@ if $CLUSTER; then
   bm_start "$(basename $0) - Finalizing routes"
   ghe_verbose "Finalizing routes"
   ghe-ssh "$GHE_HOSTNAME" -- /bin/bash >&3 <<EOF
-    split -l 1000 $routes_list $tempdir/chunk
-    chunks=\$(find $tempdir/ -name chunk\*)
+    split -l 1000 $remote_routes_list $remote_tempdir/chunk
+    chunks=\$(find $remote_tempdir/ -name chunk\*)
     parallel -i /bin/sh -c "cat {} | github-env ./bin/dpages-cluster-restore-finalize" -- \$chunks
 EOF
   bm_end "$(basename $0) - Finalizing routes"

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

@@ -52,6 +52,7 @@ to_restore=$tempdir/to_restore
 remote_to_restore=$remote_tempdir/remote_to_restore
 routes_list=$tempdir/routes_list
 remote_routes_list=$remote_tempdir/remote_routes_list
+remote_warnings=$remote_tempdir/repo_warnings
 
 if $CLUSTER; then
   ssh_config_file="$tempdir/ssh_config"
@@ -163,7 +164,7 @@ if $CLUSTER; then
   ghe-ssh "$GHE_HOSTNAME" -- /bin/bash >&3 <<EOF
     split -l 1000 $remote_to_restore $remote_tempdir/chunk
     chunks=\$(find $remote_tempdir/ -name chunk\*)
-    parallel -i /bin/sh -c "cat {} | github-env ./bin/dgit-cluster-restore-finalize" -- \$chunks
+    parallel -i /bin/sh -c "cat {} | github-env ./bin/dgit-cluster-restore-finalize 2>>$remote_warnings" -- \$chunks
 EOF
   bm_end "$(basename $0) - Finalizing routes"
 fi
@@ -190,4 +191,10 @@ else
 fi
 bm_end "$(basename $0) - Updating repository info data"
 
+restore_warnings="$(ghe-ssh "$GHE_HOSTNAME" -- cat "$remote_warnings" 2>/dev/null || true)"
+if [ -n "$restore_warnings" ]; then
+  echo "Warning: One or more repository networks failed to restore successfully. Please contact GitHub Enterprise Support for assistance."
+  echo "$restore_warnings"
+fi
+
 bm_end "$(basename $0)"

share/github-backup-utils/ghe-restore-repositories-gist

@@ -54,6 +54,7 @@ to_restore=$tempdir/to_restore
 remote_to_restore=$remote_tempdir/remote_to_restore
 routes_list=$tempdir/routes_list
 remote_routes_list=$remote_tempdir/remote_routes_list
+remote_warnings=$remote_tempdir/gist_warnings
 
 if $CLUSTER; then
   ssh_config_file="$tempdir/ssh_config"
@@ -154,9 +155,15 @@ if $CLUSTER; then
   ghe-ssh "$GHE_HOSTNAME" -- /bin/bash >&3 <<EOF
     split -l 1000 $remote_to_restore $remote_tempdir/chunk
     chunks=\$(find $remote_tempdir/ -name chunk\*)
-    parallel -i /bin/sh -c "cat {} | github-env ./bin/gist-cluster-restore-finalize" -- \$chunks
+    parallel -i /bin/sh -c "cat {} | github-env ./bin/gist-cluster-restore-finalize 2>>$remote_warnings" -- \$chunks
 EOF
   bm_end "$(basename $0) - Finalizing routes"
 fi
 
+restore_warnings="$(ghe-ssh "$GHE_HOSTNAME" -- cat "$remote_warnings" 2>/dev/null || true)"
+if [ -n "$restore_warnings" ]; then
+  echo "Warning: One or more Gists failed to restore successfully. Please contact GitHub Enterprise Support for assistance."
+  echo "$restore_warnings"
+fi
+
 bm_end "$(basename $0)"

test/bin/ghe-fake-finalize-command

@@ -2,4 +2,15 @@
 # Emulates a remote GitHub restore finalize command. Each of the *-finalize utilities
 # that are run on the remote side have corresponding commands in this directory
 # that symlink to this file. The command just writes a simple success message.
-echo "$(basename $0) OK"
+binname="$(basename "$0")"
+echo "$binname OK"
+
+# The RESTORE_FINALIZE_WARNING environment variables can be used to simulate a
+# warning from each finalize step on the remote side.
+if [ "$binname" == "dgit-cluster-restore-finalize" ] && [ -n "$GHE_DGIT_CLUSTER_RESTORE_FINALIZE_WARNING" ]; then
+    echo "1: /data/repositories/c/nw/c4/ca/42/1" >&2
+fi
+
+if [ "$binname" == "gist-cluster-restore-finalize" ] && [ -n "$GHE_GIST_CLUSTER_RESTORE_FINALIZE_WARNING" ]; then
+    echo "aabbccdd: /data/repositories/c/nw/c4/ca/42/1/gist/aabbccdd.git" >&2
+fi

test/test-ghe-restore.sh

@@ -466,8 +466,57 @@ begin_test "ghe-restore cluster"
   grep -q "Pages to git-server-fake-uuid2" "$TRASHDIR/restore-out"
   grep -q "dpages-cluster-restore-finalize OK" "$TRASHDIR/restore-out"
 
+  # verify no warnings printed
+  ! grep -q "Warning" "$TRASHDIR/restore-out"
 
   # Verify all the data we've restored is as expected
   verify_all_restored_data
 )
 end_test
+
+begin_test "ghe-restore missing directories or files from source snapshot displays warning"
+(
+    # Tests the scenario where something exists in the database, but not on disk.
+    set -e
+    rm -rf "$GHE_REMOTE_ROOT_DIR"
+    setup_remote_metadata
+    setup_remote_cluster
+    echo "cluster" > "$GHE_DATA_DIR/current/strategy"
+
+    # set as configured, enable maintenance mode and create required directories
+    setup_maintenance_mode "configured"
+
+    # set restore host environ var
+    GHE_RESTORE_HOST=127.0.0.1
+    export GHE_RESTORE_HOST
+
+    # CI servers may have moreutils parallel and GNU parallel installed. We need moreutils parallel.
+    if [ -x "/usr/bin/parallel.moreutils" ]; then
+      ln -sf /usr/bin/parallel.moreutils "$ROOTDIR/test/bin/parallel"
+    fi
+
+    # Tell dgit-cluster-restore-finalize and gist-cluster-restore-finalize to return warnings
+    export GHE_DGIT_CLUSTER_RESTORE_FINALIZE_WARNING=1
+    export GHE_GIST_CLUSTER_RESTORE_FINALIZE_WARNING=1
+
+    # run ghe-restore and write output to file for asserting against
+    if ! ghe-restore -v -f > "$TRASHDIR/restore-out" 2>&1; then
+        cat "$TRASHDIR/restore-out"
+        : ghe-restore should have exited successfully
+        false
+    fi
+
+    if [ -h "$ROOTDIR/test/bin/parallel" ]; then
+      unlink "$ROOTDIR/test/bin/parallel"
+    fi
+
+    # for debugging
+    cat "$TRASHDIR/restore-out"
+
+    grep -q "Warning: One or more repository networks failed to restore successfully." "$TRASHDIR/restore-out"
+    grep -q "Warning: One or more Gists failed to restore successfully." "$TRASHDIR/restore-out"
+
+    # Verify all the data we've restored is as expected
+    verify_all_restored_data
+)
+end_test