Daemon might keep files open on user home cleanup

[asodja]

See discussion:
https://gradle.slack.com/archives/C0WTFHWT1/p1725541056983899

org.gradle.profiler.ProfilerIntegrationTest tests can fail with:

org.gradle.profiler.Main$ScenarioFailedException: java.lang.IllegalStateException: Could not delete C:\tcagent1\temp\buildTmp\junit8579535606657717703\junit1504971569986759376\gradle-user-home\native

This might indicate that even though we require no-daemon for user home cleanup, daemon is kept around and locks files.

Test:

gradle-profiler/src/test/groovy/org/gradle/profiler/ProfilerIntegrationTest.groovy

Lines 1587 to 1617 in f604495

	def "clean Gradle user home cache when configured"() {
	given:
	buildFile << """
	plugins {
	id 'java'
	}
	"""
	file("src/main/java").mkdirs()
	file("src/main/java/Main.java") << """
	public class Main {
	public static void main(String... args) {
	System.out.println("Hello, World!");
	}
	}
	"""
	def scenarios = file("performance.scenario")
	scenarios.text = """
	buildTarget {
	versions = ["${latestSupportedGradleVersion}"]
	clear-gradle-user-home-before = BUILD
	daemon = none
	tasks = ["compileJava"]
	}
	"""
	when:
	benchmarkScenario(scenarios)
	then:
	output.count("> Cleaning Gradle user home: ") == 2
	}

Build scan:
https://ge.gradle.org/s/zbhfyalegpj3w/tests/task/:test/details/org.gradle.profiler.ProfilerIntegrationTest/clean%20Gradle%20user%20home%20cache%20when%20configured?top-execution=1

[lptr]

Since the test is flaky, it looks like the daemon is shutting down, we just don't wait long enough for it to finish.

Let's add some logic to await daemon shutdown.

Doing so would have the added benefit of eliminating the impact of a shutting down daemon from a previous iteration when measuring a build.