COMP: Auto-remove transient single-owner test outputs in itk_add_test

Wire transient-output cleanup into every test whose ${ITK_TEST_OUTPUT_DIR}/
${TEMP} outputs are owned by a single test. Each such test lists its outputs
with an ITK_REMOVE_TEMPORARY_TEST_FILES <file>... argument to itk_add_test,
which registers a FIXTURES_CLEANUP companion that removes them. Gated by the
ITK_REMOVE_TEMPORARY_TEST_FILES option (ON by default); set OFF to retain
outputs for debugging.

The argument keeps each test's cleanup file list co-located with the
itk_add_test call that produces them, rather than a separate
itk_add_file_test_cleanup() companion call. It is the only parsed keyword, so
it must appear last. The gersemi stub declares it so call sites format
correctly.

Detached-header outputs (.mhd, .nhdr) also remove their companion raw data
files, and the cleanup command uses rm -rf so directory outputs (DICOM
series, FileTools dirs) are removed as well as plain files.

1355 tests instrumented across 126 test/CMakeLists.txt. 42 multi-consumer
shared outputs are excluded so the file persists for the consuming test.

Co-authored-by: Bradley Lowekamp <blowekamp@mail.nih.gov>
Co-authored-by: Dženan Zukić <dzenan.zukic@kitware.com>

Author: 3 people

CMake/ITKModuleTest.cmake

@@ -101,21 +101,29 @@ endfunction()
 # to the value of its containing module.
 #
 function(itk_add_test)
+  # Optional ITK_REMOVE_TEMPORARY_TEST_FILES <file>... lists the transient
+  # outputs to remove after the test.  It is the only parsed keyword, so it
+  # must appear LAST: every argument following it is consumed as a file to
+  # remove.  Arguments preceding it form the add_test specification.
+  cmake_parse_arguments(_iat "" "" "ITK_REMOVE_TEMPORARY_TEST_FILES" ${ARGN})
+  set(_iat_args ${_iat_UNPARSED_ARGUMENTS})
+
   # Add tests with data in the ITKData group.
   ExternalData_Add_Test(
     ITKData
-    ${ARGN}
+    ${_iat_args}
   )
 
-  if("NAME" STREQUAL "${ARGV0}")
-    set(_iat_testname ${ARGV1})
+  list(GET _iat_args 0 _iat_arg0)
+  if("NAME" STREQUAL "${_iat_arg0}")
+    list(GET _iat_args 1 _iat_testname)
   else()
-    set(_iat_testname ${ARGV0})
+    set(_iat_testname ${_iat_arg0})
   endif()
 
   if(itk-module)
     set(_label ${itk-module})
-    if(TARGET ${itk-module}-all AND "${ARGN}" MATCHES "DATA{")
+    if(TARGET ${itk-module}-all AND "${_iat_args}" MATCHES "DATA{")
       add_dependencies(${itk-module}-all ITKData)
     endif()
   else()
@@ -129,6 +137,13 @@ function(itk_add_test)
       LABELS
         ${_label}
   )
+
+  if(_iat_ITK_REMOVE_TEMPORARY_TEST_FILES)
+    itk_add_file_test_cleanup(
+      ${_iat_testname}
+      ${_iat_ITK_REMOVE_TEMPORARY_TEST_FILES}
+    )
+  endif()
 endfunction()
 
 #-----------------------------------------------------------------------------
@@ -343,15 +358,19 @@ function(itk_memcheck_ignore)
 endfunction()
 
 #-----------------------------------------------------------------------------
-# Option to automatically remove large test output files after completion.
-# BigIO write-read tests can produce multi-gigabyte temporary files
-# that exhaust disk space on CI runners and local builds.
+# Removing transient test outputs is the default behavior: each wired test
+# gets a companion cleanup test that deletes its ${ITK_TEST_OUTPUT_DIR}
+# outputs, which otherwise accumulate (BigIO write-read tests alone produce
+# multi-gigabyte files that exhaust disk on CI runners and local builds).
+# Cleanup runs unconditionally after the test (pass, fail, or skip); a
+# developer who needs to inspect outputs must opt out by configuring with
+# -DITK_REMOVE_TEMPORARY_TEST_FILES=OFF, which retains all test outputs.
 option(
-  ITK_REMOVE_TEST_FILES_ON_SUCCESS
-  "Remove large test output files after test completion. Set OFF to retain files for debugging."
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+  "Remove transient test outputs after each test (default ON; removed even on failure). Set OFF to retain all outputs for debugging."
   ON
 )
-mark_as_advanced(ITK_REMOVE_TEST_FILES_ON_SUCCESS)
+mark_as_advanced(ITK_REMOVE_TEMPORARY_TEST_FILES)
 
 #-----------------------------------------------------------------------------
 # itk_add_file_test_cleanup(<test_name> <output_file> [<output_file2> ...])
@@ -363,19 +382,19 @@ mark_as_advanced(ITK_REMOVE_TEST_FILES_ON_SUCCESS)
 # NOTE: Per CMake documentation, FIXTURES_CLEANUP tests execute
 # unconditionally after their fixture — they run regardless of whether the
 # SETUP test passed, failed, or was skipped.  To retain output files for
-# debugging after a failure, set ITK_REMOVE_TEST_FILES_ON_SUCCESS=OFF.
+# debugging after a failure, set ITK_REMOVE_TEMPORARY_TEST_FILES=OFF.
 #
 # NOTE: In a full unfiltered run all tests (including *_cleanup variants)
 # are in the active set and fixture ordering is respected.  When rerunning
 # a single test with a strict filter (e.g. ctest -R "^<test_name>$"),
 # the *_cleanup test does not match; omit the anchors (ctest -R <test_name>)
 # so both the main test and its cleanup are selected.
 #
-# When ITK_REMOVE_TEST_FILES_ON_SUCCESS is OFF, no cleanup test is added
+# When ITK_REMOVE_TEMPORARY_TEST_FILES is OFF, no cleanup test is added
 # and the output files are retained for manual inspection.
 #
 function(itk_add_file_test_cleanup TEST_NAME)
-  if(NOT ITK_REMOVE_TEST_FILES_ON_SUCCESS)
+  if(NOT ITK_REMOVE_TEMPORARY_TEST_FILES)
     return()
   endif()
 
@@ -392,21 +411,24 @@ function(itk_add_file_test_cleanup TEST_NAME)
   # Build the removal command for all output files
   set(RM_ARGS "")
   foreach(OUTPUT_FILE ${ARGN})
-    # For .mhd files, also remove the companion .raw/.zraw
+    # Detached-header formats write a companion raw data file; remove it too.
     get_filename_component(EXT "${OUTPUT_FILE}" LAST_EXT)
     get_filename_component(BASE_NAME "${OUTPUT_FILE}" NAME_WLE)
     get_filename_component(DIR "${OUTPUT_FILE}" DIRECTORY)
     list(APPEND RM_ARGS "${OUTPUT_FILE}")
     if("${EXT}" STREQUAL ".mhd")
       list(APPEND RM_ARGS "${DIR}/${BASE_NAME}.raw")
       list(APPEND RM_ARGS "${DIR}/${BASE_NAME}.zraw")
+    elseif("${EXT}" STREQUAL ".nhdr")
+      list(APPEND RM_ARGS "${DIR}/${BASE_NAME}.raw")
+      list(APPEND RM_ARGS "${DIR}/${BASE_NAME}.raw.gz")
     endif()
   endforeach()
 
   add_test(
     NAME ${TEST_NAME}_cleanup
     COMMAND
-      ${CMAKE_COMMAND} -E rm -f ${RM_ARGS}
+      ${CMAKE_COMMAND} -E rm -rf ${RM_ARGS}
   )
   set_tests_properties(
     ${TEST_NAME}_cleanup

CMake/stubs/itk_add_test.cmake

@@ -12,7 +12,7 @@ function(itk_add_test)
     ARG
     "COMMAND_EXPAND_LISTS"
     "NAME;WORKING_DIRECTORY"
-    "COMMAND;CONFIGURATIONS"
+    "COMMAND;CONFIGURATIONS;ITK_REMOVE_TEMPORARY_TEST_FILES"
   )
 
   # This is a stub function to assist code formatting

Modules/Bridge/VtkGlue/test/CMakeLists.txt

@@ -82,6 +82,8 @@ if(NOT VTK_RENDERING_BACKEND STREQUAL "None")
       QuickViewTest
       DATA{${ITK_DATA_ROOT}/Input/peppers.png}
       ${ITK_TEST_OUTPUT_DIR}
+    ITK_REMOVE_TEMPORARY_TEST_FILES
+      ${ITK_TEST_OUTPUT_DIR}/QuickViewTest0.png
   )
   set_property(
     TEST

Modules/Core/Common/test/CMakeLists.txt

@@ -172,6 +172,8 @@ itk_add_test(
     ${TEMP}/itkColorTableTest1.txt
     itkColorTableTest
     8
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${TEMP}/itkColorTableTest1.txt
 )
 set_tests_properties(
   itkColorTableTest1
@@ -187,6 +189,8 @@ itk_add_test(
     ${TEMP}/itkColorTableTest2.txt
     itkColorTableTest
     16
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${TEMP}/itkColorTableTest2.txt
 )
 set_tests_properties(
   itkColorTableTest2
@@ -208,6 +212,8 @@ itk_add_test(
     ITKCommon1TestDriver
     itkMultipleLogOutputTest
     ${TEMP}/test_multi.txt
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${TEMP}/test_multi.txt
 )
 itk_add_test(
   NAME itkFixedArrayTest2
@@ -256,6 +262,8 @@ itk_add_test(
     DATA{${ITK_DATA_ROOT}/Input/sf4.png}
     0
     ${ITK_TEST_OUTPUT_DIR}/itkSobelOperatorImageConvolutionHorizTest.tiff
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${ITK_TEST_OUTPUT_DIR}/itkSobelOperatorImageConvolutionHorizTest.tiff
 )
 itk_add_test(
   NAME itkSobelOperatorImageFilterHorizTest
@@ -268,6 +276,8 @@ itk_add_test(
     DATA{${ITK_DATA_ROOT}/Input/sf4.png}
     0
     ${ITK_TEST_OUTPUT_DIR}/itkSobelOperatorImageFilterHorizTest.tiff
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${ITK_TEST_OUTPUT_DIR}/itkSobelOperatorImageFilterHorizTest.tiff
 )
 itk_add_test(
   NAME itkSobelOperatorImageConvolutionVertTest
@@ -280,6 +290,8 @@ itk_add_test(
     DATA{${ITK_DATA_ROOT}/Input/sf4.png}
     1
     ${ITK_TEST_OUTPUT_DIR}/itkSobelOperatorImageConvolutionVertTest.tiff
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${ITK_TEST_OUTPUT_DIR}/itkSobelOperatorImageConvolutionVertTest.tiff
 )
 
 # A simplified data test for debugging sobel operator failures
@@ -294,6 +306,8 @@ itk_add_test(
     DATA{${ITK_DATA_ROOT}/Input/circle.png}
     1
     ${ITK_TEST_OUTPUT_DIR}/itkSobelOperatorImageConvolutionVertCircleTest.tiff
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${ITK_TEST_OUTPUT_DIR}/itkSobelOperatorImageConvolutionVertCircleTest.tiff
 )
 
 itk_add_test(
@@ -307,6 +321,8 @@ itk_add_test(
     DATA{${ITK_DATA_ROOT}/Input/sf4.png}
     1
     ${ITK_TEST_OUTPUT_DIR}/itkSobelOperatorImageFilterVertTest.tiff
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${ITK_TEST_OUTPUT_DIR}/itkSobelOperatorImageFilterVertTest.tiff
 )
 
 itk_add_test(
@@ -316,6 +332,8 @@ itk_add_test(
     --redirectOutput
     ${TEMP}/itkConstNeighborhoodIteratorTest.txt
     itkConstNeighborhoodIteratorTest
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${TEMP}/itkConstNeighborhoodIteratorTest.txt
 )
 set_tests_properties(
   itkConstNeighborhoodIteratorTest
@@ -331,6 +349,8 @@ itk_add_test(
     --redirectOutput
     ${TEMP}/itkShapedNeighborhoodIteratorTest.txt
     itkShapedNeighborhoodIteratorTest
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${TEMP}/itkShapedNeighborhoodIteratorTest.txt
 )
 set_tests_properties(
   itkShapedNeighborhoodIteratorTest
@@ -431,6 +451,8 @@ itk_add_test(
     itkImageDuplicatorTest2
     DATA{${ITK_DATA_ROOT}/Input/vol-raw-big.nrrd}
     ${ITK_TEST_OUTPUT_DIR}/vol-raw-big-dup2.nrrd
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${ITK_TEST_OUTPUT_DIR}/vol-raw-big-dup2.nrrd
 )
 itk_add_test(
   NAME itkImageIteratorsForwardBackwardTest
@@ -456,6 +478,8 @@ itk_add_test(
     ITKCommon1TestDriver
     itkImageRandomIteratorTest2
     ${ITK_TEST_OUTPUT_DIR}/itkImageRandomIteratorTest2Output.mha
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${ITK_TEST_OUTPUT_DIR}/itkImageRandomIteratorTest2Output.mha
 )
 itk_add_test(
   NAME itkImageSliceIteratorTest
@@ -488,27 +512,35 @@ itk_add_test(
     ITKCommon1TestDriver
     itkLoggerTest
     ${TEMP}/test_logger.txt
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${TEMP}/test_logger.txt
 )
 itk_add_test(
   NAME itkLoggerOutputTest
   COMMAND
     ITKCommon2TestDriver
     itkLoggerOutputTest
     ${TEMP}/test_loggerOutput.txt
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${TEMP}/test_loggerOutput.txt
 )
 itk_add_test(
   NAME itkLoggerManagerTest
   COMMAND
     ITKCommon2TestDriver
     itkLoggerManagerTest
     ${TEMP}/test_LoggerManager.txt
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${TEMP}/test_LoggerManager.txt
 )
 itk_add_test(
   NAME itkLoggerThreadWrapperTest
   COMMAND
     ITKCommon2TestDriver
     itkLoggerThreadWrapperTest
     ${TEMP}/test_LoggerThreadWrapper.txt
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${TEMP}/test_LoggerThreadWrapper.txt
 )
 itk_add_test(
   NAME itkMatrixTest
@@ -561,6 +593,8 @@ itk_add_test(
     ${ITK_TEST_OUTPUT_DIR}/itkPointSetToImageFilterTest1.png
     itkPointSetToImageFilterTest1
     ${ITK_TEST_OUTPUT_DIR}/itkPointSetToImageFilterTest1.png
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${ITK_TEST_OUTPUT_DIR}/itkPointSetToImageFilterTest1.png
 )
 itk_add_test(
   NAME itkPointSetToImageFilterTest2
@@ -572,6 +606,8 @@ itk_add_test(
     itkPointSetToImageFilterTest2
     DATA{${ITK_DATA_ROOT}/Input/VascularTreePointSet.txt}
     ${ITK_TEST_OUTPUT_DIR}/itkPointSetToImageFilterTest2.mha
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${ITK_TEST_OUTPUT_DIR}/itkPointSetToImageFilterTest2.mha
 )
 itk_add_test(
   NAME itkDataObjectTest
@@ -977,6 +1013,8 @@ itk_add_test(
     --redirectOutput
     ${TEMP}/itkSliceIteratorTest.txt
     itkSliceIteratorTest
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${TEMP}/itkSliceIteratorTest.txt
 )
 set_tests_properties(
   itkSliceIteratorTest
@@ -996,13 +1034,17 @@ itk_add_test(
     ITKCommon2TestDriver
     itkStdStreamLogOutputTest
     ${TEMP}/testStreamLogOutput.txt
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${TEMP}/testStreamLogOutput.txt
 )
 itk_add_test(
   NAME itkThreadLoggerTest
   COMMAND
     ITKCommon2TestDriver
     itkThreadLoggerTest
     ${TEMP}/test_threadLogger.txt
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${TEMP}/test_threadLogger.txt
 )
 itk_add_test(
   NAME itkThreadDefsTest
@@ -1022,13 +1064,17 @@ itk_add_test(
     ITKCommon1TestDriver
     itkSymmetricSecondRankTensorImageReadTest
     ${ITK_TEST_OUTPUT_DIR}/testSymmetricTensor.nrrd
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${ITK_TEST_OUTPUT_DIR}/testSymmetricTensor.nrrd
 )
 itk_add_test(
   NAME itkSymmetricSecondRankTensorImageWriteReadTest
   COMMAND
     ITKCommon1TestDriver
     itkSymmetricSecondRankTensorImageWriteReadTest
     ${ITK_TEST_OUTPUT_DIR}/testSymmetricTensorWriteRead.mha
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${ITK_TEST_OUTPUT_DIR}/testSymmetricTensorWriteRead.mha
 )
 itk_add_test(
   NAME itkSymmetricSecondRankTensorTest
@@ -1071,6 +1117,8 @@ itk_add_test(
     DATA{${ITK_DATA_ROOT}/Input/CellsFluorescence1.png}
     ${ITK_TEST_OUTPUT_DIR}/itkStreamingImageFilterTest3_1.png
     10
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${ITK_TEST_OUTPUT_DIR}/itkStreamingImageFilterTest3_1.png
 )
 itk_add_test(
   NAME itkStreamingImageFilterTest3_2
@@ -1083,6 +1131,8 @@ itk_add_test(
     DATA{${ITK_DATA_ROOT}/Input/CellsFluorescence1.png}
     ${ITK_TEST_OUTPUT_DIR}/itkStreamingImageFilterTest3_2.png
     1000
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${ITK_TEST_OUTPUT_DIR}/itkStreamingImageFilterTest3_2.png
 )
 itk_add_test(
   NAME itkVariableLengthVectorTest
@@ -1285,6 +1335,8 @@ itk_add_test(
     ITKCommon2TestDriver
     itkXMLFileOutputWindowTest
     ${ITK_TEST_OUTPUT_DIR}/itkXMLFileOutputWindowTest.xml
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${ITK_TEST_OUTPUT_DIR}/itkXMLFileOutputWindowTest.xml
 )
 
 itk_add_test(
@@ -1295,6 +1347,8 @@ itk_add_test(
     ${ITK_TEST_OUTPUT_DIR}/itkXMLFilterWatcherTest.txt
     itkXMLFilterWatcherTest
     DATA{${ITK_DATA_ROOT}/Input/cthead1.png}
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${ITK_TEST_OUTPUT_DIR}/itkXMLFilterWatcherTest.txt
 )
 
 if(ITK_BUILD_SHARED_LIBS AND ITK_DYNAMIC_LOADING)

Modules/Core/ImageAdaptors/test/CMakeLists.txt

@@ -29,6 +29,9 @@ itk_add_test(
     itkVectorImageTest
     ${ITK_TEST_OUTPUT_DIR}/VectorImage.nrrd
     ${ITK_TEST_OUTPUT_DIR}/VectorImage.mhd
+  ITK_REMOVE_TEMPORARY_TEST_FILES
+    ${ITK_TEST_OUTPUT_DIR}/VectorImage.nrrd
+    ${ITK_TEST_OUTPUT_DIR}/VectorImage.mhd
 )
 itk_add_test(
   NAME itkComplexConjugateImageAdaptorTest