From 0a0f9a7dc6e4f215089cf0aabb230d5dd5dfbd1e Mon Sep 17 00:00:00 2001 From: Ryan Moeller Date: Tue, 3 Mar 2020 13:28:09 -0500 Subject: ZTS: Provide for nested cleanup routines Shared test library functions lack a simple way to ensure proper cleanup in the event of a failure. The `log_onexit` cleanup pattern cannot be used in library functions because it uses one global variable to store the cleanup command. An example of where this is a serious issue is when a tunable that artifically stalls kernel progress gets activated and then some check fails. Unless the caller knows about the tunable and sets it back, the system will be left in a bad state. To solve this problem, turn the global cleanup variable into a stack. Provide push and pop functions to add additional cleanup steps and remove them after it is safe again. The first use of this new functionality is in attempt_during_removal, which sets REMOVAL_SUSPEND_PROGRESS. Reviewed-by: Brian Behlendorf Reviewed-by: John Kennedy Signed-off-by: Ryan Moeller Closes #10080 --- tests/test-runner/include/logapi.shlib | 28 +++++++++++++++++++++++----- 1 file changed, 23 insertions(+), 5 deletions(-) (limited to 'tests/test-runner') diff --git a/tests/test-runner/include/logapi.shlib b/tests/test-runner/include/logapi.shlib index cd7982a94..3c8324d57 100644 --- a/tests/test-runner/include/logapi.shlib +++ b/tests/test-runner/include/logapi.shlib @@ -281,7 +281,23 @@ function log_pos function log_onexit { - _CLEANUP="$@" + _CLEANUP=("$*") +} + +# Push an exit handler on the cleanup stack +# +# $@ - function(s) to perform on exit + +function log_onexit_push +{ + _CLEANUP+=("$*") +} + +# Pop an exit handler off the cleanup stack + +function log_onexit_pop +{ + _CLEANUP=("${_CLEANUP[@]:0:${#_CLEANUP[@]}-1}") } # @@ -425,12 +441,14 @@ function _endlog _execute_testfail_callbacks fi - if [[ -n $_CLEANUP ]] ; then - typeset cleanup=$_CLEANUP - log_onexit "" + typeset stack=("${_CLEANUP[@]}") + log_onexit "" + typeset i=${#stack[@]} + while (( i-- )); do + typeset cleanup="${stack[i]}" log_note "Performing local cleanup via log_onexit ($cleanup)" $cleanup - fi + done exit $exitcode } -- cgit v1.2.3