Merge pull request felipec#12 from seveas/cleanup-function

Add a 'cleanup' api to register cleanup actions

API.md

@@ -266,6 +266,20 @@
 
     Returns 0 if all tests passed or 1 if there was a failure.
 
+### cleanup()
+
+    Public: Schedule cleanup commands to be run unconditionally when all tests
+    have run.
+
+    This can be used to clean up things like test databases. It is not needed to
+    clean up temporary files, as test_done already does that.
+
+    Examples:
+
+      cleanup mysql -e "DROP DATABASE mytest"
+
+    Returns the exit code of the last cleanup command executed.
+
 ### SHARNESS_TEST_DIRECTORY
 
     Public: Root directory containing tests. Tests can override this variable,

sharness.sh

@@ -576,6 +576,23 @@ test_when_finished() {
 		} && (exit \"\$eval_ret\"); eval_ret=\$?; $test_cleanup"
 }
 
+# Public: Schedule cleanup commands to be run unconditionally when all tests
+# have run.
+#
+# This can be used to clean up things like test databases. It is not needed to
+# clean up temporary files, as test_done already does that.
+#
+# Examples:
+#
+#   cleanup mysql -e "DROP DATABASE mytest"
+#
+# Returns the exit code of the last cleanup command executed.
+final_cleanup=
+cleanup() {
+	final_cleanup="{ $*
+		} && (exit \"\$eval_ret\"); eval_ret=\$?; $final_cleanup"
+}
+
 # Public: Summarize test results and exit with an appropriate error code.
 #
 # Must be called at the end of each test script.
@@ -641,6 +658,8 @@ test_done() {
 		fi
 		say "1..$test_count$skip_all"
 
+		test_eval_ "$final_cleanup"
+
 		test -d "$remove_trash" &&
 		cd "$(dirname "$remove_trash")" &&
 		rm -rf "$(basename "$remove_trash")"

test/sharness.t

@@ -275,6 +275,17 @@ test_expect_success 'tests clean up even on failures' "
 	EOF
 "
 
+test_expect_success 'cleanup functions tun at the end of the test' "
+	run_sub_test_lib_test cleanup-function 'Empty test with cleanup function' <<-\\EOF &&
+	cleanup 'echo cleanup-function-called >&5'
+	test_done
+	EOF
+	check_sub_test_lib_test cleanup-function <<-\\EOF
+	1..0
+	cleanup-function-called
+	EOF
+"
+
 test_done
 
 # vi: set ft=sh :