Merge pull request #109 from djmaze/add-incomplete-backup-hook

Add incomplete backup hook

README.md

@@ -151,13 +151,17 @@ You can add one or multiple commands by specifying the following environment var
     POST_COMMANDS_FAILURE: |-
     	/my/scripts/mail-failure.sh
 
+    POST_COMMANDS_INCOMPLETE: |-
+    	/my/scripts/mail-incomplete.sh
+
     POST_COMMANDS_EXIT: |-
     	docker start my_container
 
 The commands specified are executed one by one.
 
-- `POST_COMMANDS_SUCCESS` commands will be executed after a successful backup run.
+- `POST_COMMANDS_SUCCESS` commands will be executed after a fully successful backup run (i.e. all files could be read).
 - `POST_COMMANDS_FAILURE` commands will be executed after a failed backup run.
+- `POST_COMMANDS_INCOMPLETE` commands will be executed if the backup is incomplete (i.e. one or more files could not be read).
 - `POST_COMMANDS_EXIT` will always be executed, after both successful or failed backup runs.
 
 ### Notification example

backup

@@ -53,9 +53,13 @@ set +e
 restic --repo="${RESTIC_REPOSITORY}" backup "${backup_args[@]}" "${tag_options[@]}" "${backup_sources[@]}"
 rc=$?
 set -e
+
 if [ $rc -ne 0 ]; then
-	run_commands "${POST_COMMANDS_FAILURE:-}"
-	exit $rc
+  if [ $rc -eq 3 ] && [ -n "${POST_COMMANDS_INCOMPLETE:-}" ]; then
+  	run_commands "${POST_COMMANDS_INCOMPLETE:-}"
+  else
+  	run_commands "${POST_COMMANDS_FAILURE:-}"
+  fi
 fi
 
 echo Backup successful
@@ -69,4 +73,6 @@ fi
 end=$(date +%s)
 echo Finished backup at $(date +"%Y-%m-%d %H:%M:%S") after $((end-start)) seconds
 
+[ $rc -ne 0 ] && exit $rc
+
 run_commands "${POST_COMMANDS_SUCCESS:-}"

spec/backup_spec.sh

@@ -76,6 +76,30 @@ HERE
     The status should eq 1
   End
 
+  It "Runs failure command if backup is incomplete and incomplete command is not specified"
+    cat <<HERE >"$extra_env"
+      RESTIC_BACKUP_SOURCES=/proc/self/mem
+      POST_COMMANDS_FAILURE=echo Total failure!
+HERE
+    When call docker_exec backup
+    The stderr should not include "Fatal:"
+    The output should include "Total failure!"
+    The status should eq 3
+  End
+
+  It "Runs incomplete command if backup is incomplete and incomplete command is specified"
+    cat <<HERE >"$extra_env"
+      RESTIC_BACKUP_SOURCES=/proc/self/mem
+      POST_COMMANDS_INCOMPLETE=echo Partial failure!
+      POST_COMMANDS_FAILURE=echo Total failure!
+HERE
+    When call docker_exec backup
+    The stderr should not include "Fatal:"
+    The output should not include "Total failure!"
+    The output should include "Partial failure!"
+    The status should eq 3
+  End
+
   It "Forgets old backups after backup"
     cat <<HERE >"$extra_env"
       RESTIC_FORGET_ARGS=--keep-last 1
@@ -84,5 +108,4 @@ HERE
     The status should be success
     The output should match pattern "*keep 1 snapshots*"
   End
-
 End