Merge pull request #469 from github/enterprise-3.9-backport-408-zheng/6791-indicator

Backport 408 for 3.9: fix indicator when doing backup and restore

Author: chuckp22

bin/ghe-backup

@@ -46,12 +46,36 @@ export CALLING_SCRIPT="ghe-backup"
 
 # Setup progress tracking
 init-progress
+export PROGRESS_TOTAL=14 # Minimum number of steps in backup is 14
+echo "$PROGRESS_TOTAL" > /tmp/backup-utils-progress-total
 export PROGRESS_TYPE="Backup"
 echo "$PROGRESS_TYPE" > /tmp/backup-utils-progress-type
 export PROGRESS=0 # Used to track progress of backup
 echo "$PROGRESS" > /tmp/backup-utils-progress
-export PROGRESS_TOTAL=18 # Maximum number of steps in backup
 
+OPTIONAL_STEPS=0
+# Backup actions+mssql
+if ghe-ssh "$GHE_HOSTNAME" -- 'ghe-config --true app.actions.enabled'; then
+  OPTIONAL_STEPS=$((OPTIONAL_STEPS + 2))
+fi
+
+# Backup fsck
+if [ "$GHE_BACKUP_FSCK" = "yes" ]; then
+  OPTIONAL_STEPS=$((OPTIONAL_STEPS + 1))
+fi
+
+# Backup minio
+if ghe-ssh "$GHE_HOSTNAME" -- 'ghe-config --true app.minio.enabled'; then
+  OPTIONAL_STEPS=$((OPTIONAL_STEPS + 1))
+fi
+
+# Backup pages
+if [ "$GHE_BACKUP_PAGES" != "no" ]; then
+  OPTIONAL_STEPS=$((OPTIONAL_STEPS + 1))
+fi
+
+PROGRESS_TOTAL=$((OPTIONAL_STEPS + PROGRESS_TOTAL)) # Minimum number of steps in backup is 14
+echo "$PROGRESS_TOTAL" > /tmp/backup-utils-progress-total
 # Check to make sure moreutils parallel is installed and working properly
 ghe_parallel_check
 
@@ -269,6 +293,7 @@ echo \"$cmd_title\"
 ghe-backup-git-hooks || printf %s \"git-hooks \" >> \"$failures_file\"")
 
 if [ "$GHE_BACKUP_STRATEGY" = "rsync" ]; then
+  increment-progress-total-count 1
   cmd_title=$(log_info "Backing up Elasticsearch indices ...")
   commands+=("
   echo \"$cmd_title\"

bin/ghe-restore

@@ -275,17 +275,14 @@ fi
 # taking into account the options passed to the script and the appliance configuration
 # calculate restore steps
 OPTIONAL_STEPS=0
-# Cluster restores add an additional step
-if $CLUSTER ; then
-  OPTIONAL_STEPS=$((OPTIONAL_STEPS + 1))
-fi
+
 # Restoring UUID
 if [ -s "$GHE_RESTORE_SNAPSHOT_PATH/uuid" ] && ! $CLUSTER; then
   OPTIONAL_STEPS=$((OPTIONAL_STEPS + 1))
 fi
-# Restoring Actions
+# Restoring Actions + MSSQL
 if ghe-ssh "$GHE_HOSTNAME" -- 'ghe-config --true app.actions.enabled'; then
-  OPTIONAL_STEPS=$((OPTIONAL_STEPS + 1))
+  OPTIONAL_STEPS=$((OPTIONAL_STEPS + 2))
 fi
 # Restoring minio
 if ghe-ssh "$GHE_HOSTNAME" -- 'ghe-config --true app.minio.enabled'; then
@@ -305,10 +302,16 @@ fi
 if ! $CLUSTER && $instance_configured; then
   OPTIONAL_STEPS=$((OPTIONAL_STEPS + 1))
 fi
-# Maximum restore steps
-export PROGRESS_TOTAL=$((OPTIONAL_STEPS + 6))
+# Restoring settings + restore-chat-integration + restore-packages
+if $RESTORE_SETTINGS; then
+  OPTIONAL_STEPS=$((OPTIONAL_STEPS + 3))
+fi
+
+# Minimum number of steps is 7
+export PROGRESS_TOTAL=$((OPTIONAL_STEPS + 7))
 
 init-progress
+echo "$PROGRESS_TOTAL" > /tmp/backup-utils-progress-total
 export PROGRESS_TYPE="Restore"
 echo "$PROGRESS_TYPE" > /tmp/backup-utils-progress-type
 export PROGRESS=0 # Used to track progress of restore
@@ -484,6 +487,7 @@ if is_external_database_target_or_snapshot && $SKIP_MYSQL; then
   log_info "Skipping MySQL restore."
 else
   log_info "Restoring MySQL database from ${backup_snapshot_strategy} backup snapshot on an appliance configured for ${appliance_strategy} backups ..."
+  increment-progress-total-count 2
   ghe-restore-mysql "$GHE_HOSTNAME" 1>&3
 fi
 

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

@@ -712,6 +712,12 @@ init-progress() {
   rm -f /tmp/backup-utils-progress*
 }
 
+#increase total count of progress
+increment-progress-total-count() {
+  ((PROGRESS_TOTAL += $1))
+  echo "$PROGRESS_TOTAL" > /tmp/backup-utils-progress-total
+}
+
 
 
 

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

@@ -63,6 +63,7 @@ if [ -d "$GHE_DATA_DIR/current/pages" ] && [ "$(ls -A $GHE_DATA_DIR/current/page
   link_dest="--link-dest=../../current/pages"
 fi
 
+count=0
 for hostname in $hostnames; do
   bm_start "$(basename $0) - $hostname"
   echo 1>&3
@@ -82,6 +83,7 @@ for hostname in $hostnames; do
     "$GHE_SNAPSHOT_DIR/pages" 1>&3
   log_rsync "END: pages rsync" 1>&3
   bm_end "$(basename $0) - $hostname"
+  count=$((count + 1))
 done
-
+increment-progress-total-count $count
 bm_end "$(basename $0)"

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

@@ -144,6 +144,8 @@ bm_end "$(basename $0) - Processing routes"
 if [ -z "$(find "$tempdir" -maxdepth 1 -name '*.rsync')" ]; then
   log_warn "no routes found, skipping repositories backup ..."
   exit 0
+else
+  increment-progress-total-count 3
 fi
 
 # Transfer repository data from a GitHub instance to the current snapshot
@@ -377,7 +379,7 @@ if [ -z "$GHE_SKIP_ROUTE_VERIFICATION" ]; then
   (cd $backup_dir/ && find * -mindepth 5 -maxdepth 6 -type d -name \*.git | fix_paths_for_ghe_version | uniq | sort | uniq) > $tempdir/destination_routes
 
   git --no-pager diff --unified=0 --no-prefix -- $tempdir/source_routes $tempdir/destination_routes || echo "Warning: One or more repository networks and/or gists were not found on the source appliance. Please contact GitHub Enterprise Support for assistance."
-
+  increment-progress-total-count 1
   bm_end "$(basename $0) - Verifying Routes"
 fi
 

share/github-backup-utils/ghe-backup-storage

@@ -113,6 +113,8 @@ bm_end "$(basename $0) - Processing routes"
 if [ -z "$(find "$tempdir" -maxdepth 1 -name '*.rsync')" ]; then
   log_warn "no routes found, skipping storage backup ..."
   exit 0
+else
+  increment-progress-total-count 2
 fi
 
 # rsync all the storage objects
@@ -149,6 +151,7 @@ if [ -z "$GHE_SKIP_ROUTE_VERIFICATION" ]; then
 
   git --no-pager diff --unified=0 --no-prefix -- $tempdir/source_routes $tempdir/destination_routes || echo "Warning: One or more storage objects were not found on the source appliance. Please contact GitHub Enterprise Support for assistance."
 
+  increment-progress-total-count 1
   bm_end "$(basename $0) - Verifying Routes"
 fi
 

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

@@ -29,6 +29,8 @@ pages_paths=$(cd $GHE_DATA_DIR/$GHE_RESTORE_SNAPSHOT/ && find pages -mindepth 5
 if [ -z "$pages_paths" ]; then
   log_warn "Warning: Pages backup missing. Skipping ..."
   exit 0
+else
+  increment-progress-total-count 5
 fi
 
 # Perform a host-check and establish GHE_REMOTE_XXX variables.
@@ -125,6 +127,8 @@ bm_end "$(basename $0) - Processing routes"
 if [ -z "$(find "$tempdir" -maxdepth 1 -name '*.rsync')" ]; then
   log_warn "Warning: no routes found, skipping pages restore ..."
   exit 0
+else
+  increment-progress-total-count 2
 fi
 
 bm_start "$(basename $0) - Restoring pages"
@@ -154,6 +158,7 @@ if $CLUSTER; then
     chunks=\$(find $remote_tempdir/ -name chunk\*)
     parallel -i /bin/sh -c "cat {} | github-env ./bin/dpages-cluster-restore-finalize" -- \$chunks
 EOF
+  increment-progress-total-count 1
   bm_end "$(basename $0) - Finalizing routes"
 fi
 

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

@@ -30,6 +30,8 @@ network_paths=$(cd $GHE_DATA_DIR/$GHE_RESTORE_SNAPSHOT/ && find repositories -mi
 if [ -z "$network_paths" ]; then
   log_warn "Warning: Repositories backup missing. Skipping ..."
   exit 0
+else
+  increment-progress-total-count 5
 fi
 
 # Perform a host-check and establish GHE_REMOTE_XXX variables.
@@ -142,6 +144,8 @@ bm_end "$(basename $0) - Processing routes"
 if [ -z "$(find "$tempdir" -maxdepth 1 -name '*.rsync')" ]; then
   log_warn "Warning: no routes found, skipping repositories restore ..."
   exit 0
+else
+  increment-progress-total-count 3
 fi
 
 # rsync all the repository networks to the git server where they belong.
@@ -190,6 +194,7 @@ if $CLUSTER; then
     chunks=\$(find $remote_tempdir/ -name chunk\*)
     parallel -i /bin/sh -c "cat {} | github-env ./bin/dgit-cluster-restore-finalize 2>>$remote_warnings" -- \$chunks
 EOF
+  increment-progress-total-count 1
   bm_end "$(basename $0) - Finalizing routes"
 fi
 

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

@@ -29,6 +29,8 @@ gist_paths=$(cd $GHE_DATA_DIR/$GHE_RESTORE_SNAPSHOT/  && find repositories -mind
 if [ -z "$gist_paths" ]; then
   log_warn "Warning: Gist backup missing. Skipping ..."
   exit 0
+else
+  increment-progress-total-count 5
 fi
 
 # Perform a host-check and establish GHE_REMOTE_XXX variables.
@@ -128,6 +130,8 @@ bm_end "$(basename $0) - Processing routes"
 if [ -z "$(find "$tempdir" -maxdepth 1 -name '*.rsync')" ]; then
   log_warn "Warning: no routes found, skipping gists restore ..."
   exit 0
+else
+  increment-progress-total-count 2
 fi
 
 # rsync all the gist repositories
@@ -157,6 +161,7 @@ if $CLUSTER; then
     chunks=\$(find $remote_tempdir/ -name chunk\*)
     parallel -i /bin/sh -c "cat {} | github-env ./bin/gist-cluster-restore-finalize 2>>$remote_warnings" -- \$chunks
 EOF
+  increment-progress-total-count 1
   bm_end "$(basename $0) - Finalizing routes"
 fi
 

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

@@ -33,6 +33,8 @@ storage_paths=$(cd $GHE_DATA_DIR/$GHE_RESTORE_SNAPSHOT/ && find storage -mindept
 if [ -z "$storage_paths" ]; then
   log_warn "Warning: Storage backup missing. Skipping ..."
   exit 0
+else
+  increment-progress-total-count 5
 fi
 
 # Perform a host-check and establish GHE_REMOTE_XXX variables.
@@ -120,6 +122,8 @@ bm_end "$(basename $0) - Processing routes"
 if [ -z "$(find "$tempdir" -maxdepth 1 -name '*.rsync')" ]; then
   log_warn "Warning: no routes found, skipping storage restore ..."
   exit 0
+else
+  increment-progress-total-count 2
 fi
 
 # rsync all the objects to the storage server where they belong.
@@ -169,6 +173,7 @@ if $CLUSTER; then
     chunks=\$(find $remote_tempdir/ -name chunk\*)
     parallel -i /bin/sh -c "cat {} | github-env ./bin/storage-cluster-restore-finalize" -- \$chunks
 EOF
+  increment-progress-total-count 1
   bm_end "$(basename $0) - Finalizing routes"
 fi