[SPARK-51030][CORE][TESTS] Add a check before Utils.deleteRecursively(tempDir) to ensure tempDir won't be cleaned up by the ShutdownHook in afterEach of LocalRootDirsTest
#49723
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
.github/workflows/build_and_test.yml
Outdated
| @@ -1291,3 +1291,16 @@ jobs: | |||
| cd ui-test | |||
| npm install --save-dev | |||
| node --experimental-vm-modules node_modules/.bin/jest | |||
| maven-test: | |||
| name: "Run Maven Test on macos" | |||
LuciferYang
changed the title
hasRootAsShutdownDeleteDir check for tempDir in the afterEach of LocalRootDirsTest.hasShutdownDeleteDir check for tempDir in the afterEach of LocalRootDirsTest.
LuciferYang
changed the title
hasShutdownDeleteDir check for tempDir in the afterEach of LocalRootDirsTest.tempDir before manual cleanup in the afterEach method of LocalRootDirsTest
LuciferYang
commented
Jan 29, 2025
| @@ -46,7 +46,10 @@ trait LocalRootDirsTest extends SparkFunSuite with LocalSparkContext { | |||
|
|
|||
| override def afterEach(): Unit = { | |||
| try { | |||
| Utils.deleteRecursively(tempDir) | |||
| if (!ShutdownHookManager.hasShutdownDeleteDir(tempDir) && | |||
There was a problem hiding this comment.
In the beforeEach method, tempDir = Utils.createTempDir(namePrefix = "local") invokes ShutdownHookManager.registerShutdownDeleteDir to register tempDir for deletion via a shutdown hook. Therefore, if tempDir remains unchanged during the test case, manual cleanup is unnecessary.
However, given that tempDir is defined as protected var tempDir, it is possible for it to be altered within the test case. Hence, additional checks are implemented before manually cleaning up tempDir:
tempDirhas not been registered for cleanup via a shutdown hook.tempDiris not a subpath of any path that has been registered for cleanup via a shutdown hook.
This approach helps to minimize the risk of a race condition where multiple threads attempt to clean up the tempDir concurrently. It seems that this issue is more prevalent on macOS, so let's conduct several more rounds of testing to ensure its effectiveness.
LuciferYang
changed the title
tempDir before manual cleanup in the afterEach method of LocalRootDirsTesttempDir to ensure that it won't be cleaned up by the ShutdownHook in the afterEach of LocalRootDirsTest
LuciferYang
changed the title
tempDir to ensure that it won't be cleaned up by the ShutdownHook in the afterEach of LocalRootDirsTestUtils.deleteRecursively(tempDir) to ensure tempDir won't be cleaned up by the ShutdownHook in the afterEach of LocalRootDirsTest
LuciferYang
changed the title
Utils.deleteRecursively(tempDir) to ensure tempDir won't be cleaned up by the ShutdownHook in the afterEach of LocalRootDirsTestUtils.deleteRecursively(tempDir) to ensure tempDir won't be cleaned up by the ShutdownHook in afterEach of LocalRootDirsTest
LuciferYang
changed the title
Utils.deleteRecursively(tempDir) to ensure tempDir won't be cleaned up by the ShutdownHook in afterEach of LocalRootDirsTestUtils.deleteRecursively(tempDir) to ensure tempDir won't be cleaned up by the ShutdownHook in afterEach of LocalRootDirsTest
dongjoon-hyun
approved these changes
Jan 30, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What changes were proposed in this pull request?
This pr add a check before
Utils.deleteRecursively(tempDir)to ensuretempDirwon't be cleaned up by the ShutdownHook inafterEachofLocalRootDirsTestto minimize the risk of test failures caused by race conditions in multi-threaded deletion of thetempdir.Why are the changes needed?
In the daily tests on macOS, you may see test failures similar to the following:
This appears to be an issue caused by multi-threaded deletion of the
tempdir.spark/core/src/test/scala/org/apache/spark/LocalRootDirsTest.scala
Line 42 in 42898c6
Refer to the code above, in
LocalRootDirsTest#beforeEachmethod,tempDir = Utils.createTempDir(namePrefix = "local")invokesShutdownHookManager.registerShutdownDeleteDirto registertempDirfor deletion via a shutdown hook. Therefore, iftempDirremains unchanged during the test case, manual cleanup is unnecessary inLocalRootDirsTest#afterEachmethod.However, given that
tempDiris defined asprotected var tempDir, it is possible for it to be altered within the test case. Hence, additional checks are implemented before manually cleaning uptempDir:tempDirhas not been registered for cleanup via a shutdown hook.tempDiris not a subpath of any path that has been registered for cleanup via a shutdown hook.This approach helps to minimize the risk of a race condition where multiple threads attempt to clean up the
tempDirconcurrently.Does this PR introduce any user-facing change?
No
How was this patch tested?
Was this patch authored or co-authored using generative AI tooling?
No