Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[WIP] Cleanup intermediate dir usage, since there seem to be some problems restoring it when caches are used #363

Closed
wants to merge 2 commits into from
Closed

[WIP] Cleanup intermediate dir usage, since there seem to be some problems restoring it when caches are used #363

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ed98ff7
Cleanup intermediate dir usage, since there seem to be some problems …
lukas-mercari May 17, 2024
2302588
Adjust test to check if task was taken from cache rather than skipped
lukas-mercari May 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions ...e-plugin/src/integrationTest/java/io/github/takahirom/roborazzi/RoborazziGradleProject.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,11 +107,6 @@ class RoborazziGradleProject(val testProjectDir: TemporaryFolder) {
File(testProjectDir.root, "app/$buildDirName/outputs/roborazzi").deleteRecursively()
}

fun removeRoborazziAndIntermediateOutputDir() {
File(testProjectDir.root, "app/$buildDirName/outputs/roborazzi").deleteRecursively()
File(testProjectDir.root, "app/$buildDirName/intermediates/roborazzi").deleteRecursively()
}

fun assertNotSkipped(output: String) {
assert(output.contains("testDebugUnitTest' is not up-to-date because"))
}
Expand All @@ -121,6 +116,10 @@ class RoborazziGradleProject(val testProjectDir: TemporaryFolder) {
assert(output.contains("testDebugUnitTest UP-TO-DATE"))
}

fun assertFromCache(output: String) {
assert(output.contains("testDebugUnitTest FROM-CACHE"))
}

enum class BuildType {
Build, BuildAndFail
}
Expand Down
20 changes: 1 addition & 19 deletions ...ugin/src/integrationTest/java/io/github/takahirom/roborazzi/RoborazziGradleProjectTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,25 +59,7 @@ class RoborazziGradleProjectTest {
record()
removeRoborazziOutputDir()
val output = record().output
assertSkipped(output)

checkResultsSummaryFileExists()
checkRecordedFileExists("$screenshotAndName.testCapture.png")
checkRecordedFileNotExists("$screenshotAndName.testCapture_compare.png")
checkRecordedFileNotExists("$screenshotAndName.testCapture_actual.png")
}
}

@Test
fun recordWhenRemovedOutputAndIntermediate() {
RoborazziGradleProject(testProjectDir).apply {
removeRoborazziAndIntermediateOutputDir()
record()
removeRoborazziAndIntermediateOutputDir()
// should not be skipped even if tests and sources are not changed
// when output directory is removed
val output = record().output
assertNotSkipped(output)
assertFromCache(output)

checkResultsSummaryFileExists()
checkRecordedFileExists("$screenshotAndName.testCapture.png")
Expand Down
193 changes: 4 additions & 189 deletions ...ld/roborazzi-gradle-plugin/src/main/java/io/github/takahirom/roborazzi/RoborazziPlugin.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,6 @@ import javax.inject.Inject
import kotlin.reflect.KClass

private const val DEFAULT_OUTPUT_DIR = "outputs/roborazzi"
private const val DEFAULT_TEMP_DIR = "intermediates/roborazzi"

/**
* Experimental API
Expand Down Expand Up @@ -90,30 +89,6 @@ abstract class RoborazziPlugin : Plugin<Project> {
// For fixing unexpected skip test
val outputDir =
extension.outputDir.convention(project.layout.buildDirectory.dir(DEFAULT_OUTPUT_DIR))
val testTaskOutputDir: DirectoryProperty = project.objects.directoryProperty()
val intermediateDir =
testTaskOutputDir.convention(project.layout.buildDirectory.dir(DEFAULT_TEMP_DIR))

val restoreOutputDirRoborazziTaskProvider =
project.tasks.register(
"restoreOutputDirRoborazzi",
RestoreOutputDirRoborazziTask::class.java
) { task ->

task.inputDir.set(intermediateDir.map {
if (!it.asFile.exists()) {
it.asFile.mkdirs()
}
it
})
task.outputDir.set(outputDir)
task.onlyIf {
val outputDirFile = task.outputDir.asFile.get()
val inputDirFile = task.inputDir.asFile.get()
(outputDirFile.listFiles()?.isEmpty() ?: true)
&& (inputDirFile.listFiles()?.isNotEmpty() ?: false)
}
}

fun isAnyTaskRun(
isRecordRun: Property<Boolean>,
Expand All @@ -129,32 +104,8 @@ abstract class RoborazziPlugin : Plugin<Project> {
fun configureRoborazziTasks(
variantSlug: String,
testTaskName: String,
testTaskSkipEventsServiceProvider: Provider<TestTaskSkipEventsServiceProvider>,
testTaskClass: KClass<out AbstractTestTask> = Test::class
) {
try {
testTaskSkipEventsServiceProvider.get().addExpectingTestTaskName(testTaskName)
} catch (e: ClassCastException) {
throw IllegalStateException(
"""You should use `id("io.github.takahirom.roborazzi") version "[version]" apply false` in the root project
|to ensure the build cache property functions correctly.
|This is a temporary workaround,
|and we are awaiting a permanent fix from the Gradle core.
|https://github.com/takahirom/roborazzi/issues/266""".trimMargin(),
e
)
}
val testTaskOutputDirForEachVariant: DirectoryProperty = project.objects.directoryProperty()
val intermediateDirForEachVariant =
testTaskOutputDirForEachVariant.convention(
project.layout.buildDirectory.dir(
DEFAULT_TEMP_DIR
)
)

// val reportOutputDir = project.layout.buildDirectory.dir("reports/roborazzi")
// val snapshotOutputDir = project.layout.projectDirectory.dir("src/test/snapshots")

val recordTaskProvider =
project.tasks.register("recordRoborazzi$variantSlug", RoborazziTask::class.java) {
it.group = VERIFICATION_GROUP
Expand Down Expand Up @@ -238,39 +189,7 @@ abstract class RoborazziPlugin : Plugin<Project> {
finalizeTestTask.infoln("Roborazzi: roborazziTestFinalizer.onlyIf doesRoborazziRun $doesRoborazziRun")
doesRoborazziRun
}
val taskPath = if (project.path == ":") {
":"
} else {
project.path + ":"
}
finalizeTestTask.doLast {
val taskSkipEventsService = testTaskSkipEventsServiceProvider.get()
val buildFinishCountDownLatch = taskSkipEventsService.countDownLatch
val currentIsTestSkipped =
taskSkipEventsService.skippedTestTaskMap[taskPath + testTaskName]
val isTestSkipped = if (currentIsTestSkipped == null) {
// BuildService could cause race condition
// https://github.com/gradle/gradle/issues/24887
finalizeTestTask.infoln("Roborazzi: roborazziTestFinalizer.doLast test task result doesn't exits. currentIsTestSkipped:$currentIsTestSkipped currentTimeMillis:${System.currentTimeMillis()}")
val waitSuccess = buildFinishCountDownLatch.await(200, TimeUnit.MILLISECONDS)
val new =
taskSkipEventsService.skippedTestTaskMap[taskPath + testTaskName]
finalizeTestTask.infoln("Roborazzi: roborazziTestFinalizer.doLast wait end currentIsTestSkipped:$currentIsTestSkipped new:$new waitSuccess:$waitSuccess currentTimeMillis:${System.currentTimeMillis()}")
new ?: false
} else {
currentIsTestSkipped
}
finalizeTestTask.infoln("Roborazzi: roborazziTestFinalizer.doLast isTestSkipped:$isTestSkipped")
if (isTestSkipped) {
// If the test is skipped, we need to use cached files
finalizeTestTask.infoln("Roborazzi: finalizeTestRoborazziTask isTestSkipped:$isTestSkipped Copy files from ${intermediateDir.get()} to ${outputDir.get()}")
intermediateDir.get().asFile.mkdirs()
intermediateDir.get().asFile.copyRecursively(
target = outputDir.get().asFile,
overwrite = true
)
}

val results: List<CaptureResult> = resultDirFileTree.get().mapNotNull {
if (it.name.endsWith(".json")) {
CaptureResult.fromJsonFile(it.path)
Expand Down Expand Up @@ -300,7 +219,7 @@ abstract class RoborazziPlugin : Plugin<Project> {
testTaskProvider
.configureEach { test ->
val resultsDir = resultDirFileProperty.get().asFile
test.outputs.dir(intermediateDirForEachVariant.map {
test.outputs.dir(outputDir.map {
test.infoln("Roborazzi: Set output dir $it to test task")
it
})
Expand Down Expand Up @@ -364,19 +283,6 @@ abstract class RoborazziPlugin : Plugin<Project> {
resultsDir.deleteRecursively()
resultsDir.mkdirs()
}
test.doLast {
// Copy all files from outputDir to intermediateDir
// so that we can use Gradle's output caching
it.infoln("Roborazzi: test.doLast Copy files from ${outputDir.get()} to ${intermediateDir.get()}")
// outputDir.get().asFileTree.forEach {
// println("Copy file ${finalizeTask.absolutePath} to ${intermediateDir.get()}")
// }
outputDir.get().asFile.mkdirs()
outputDir.get().asFile.copyRecursively(
target = intermediateDir.get().asFile,
overwrite = true
)
}
test.finalizedBy(finalizeTestRoborazziTask)
}

Expand All @@ -386,14 +292,6 @@ abstract class RoborazziPlugin : Plugin<Project> {
verifyAndRecordTaskProvider.configure { it.dependsOn(testTaskProvider) }
}

val testTaskSkipEventsServiceProvider: Provider<TestTaskSkipEventsServiceProvider> =
project.gradle.sharedServices.registerIfAbsent(
"roborazziTestTaskEvents", TestTaskSkipEventsServiceProvider::class.java
) { spec ->
// do nothing
}
getEventsListenerRegistry().onTaskCompletion(testTaskSkipEventsServiceProvider)

fun AndroidComponentsExtension<*, *, *>.configureComponents() {
onVariants { variant ->
val unitTest = variant.unitTest ?: return@onVariants
Expand All @@ -403,8 +301,7 @@ abstract class RoborazziPlugin : Plugin<Project> {
// e.g. testDebugUnitTest -> recordRoborazziDebug
configureRoborazziTasks(
variantSlug = variantSlug,
testTaskName = "test$testVariantSlug",
testTaskSkipEventsServiceProvider = testTaskSkipEventsServiceProvider
testTaskName = "test$testVariantSlug"
)
}
}
Expand All @@ -421,8 +318,7 @@ abstract class RoborazziPlugin : Plugin<Project> {
// e.g. test -> recordRoborazziJvm
configureRoborazziTasks(
variantSlug = "Jvm",
testTaskName = "test",
testTaskSkipEventsServiceProvider = testTaskSkipEventsServiceProvider
testTaskName = "test"
)
}
project.pluginManager.withPlugin("org.jetbrains.kotlin.multiplatform") {
Expand All @@ -437,8 +333,7 @@ abstract class RoborazziPlugin : Plugin<Project> {
// e.g. desktopTest -> recordRoborazziDesktop
configureRoborazziTasks(
variantSlug = target.name.capitalizeUS(),
testTaskName = testRun.executionTask.name,
testTaskSkipEventsServiceProvider = testTaskSkipEventsServiceProvider
testTaskName = testRun.executionTask.name
)
}
}
Expand All @@ -448,7 +343,6 @@ abstract class RoborazziPlugin : Plugin<Project> {
configureRoborazziTasks(
variantSlug = target.name.capitalizeUS(),
testTaskName = (testRun as ExecutionTaskHolder<*>).executionTask.name,
testTaskSkipEventsServiceProvider = testTaskSkipEventsServiceProvider,
testTaskClass = KotlinNativeTest::class
)
}
Expand All @@ -460,24 +354,6 @@ abstract class RoborazziPlugin : Plugin<Project> {
private fun String.capitalizeUS() =
replaceFirstChar { if (it.isLowerCase()) it.titlecase(Locale.US) else it.toString() }

abstract class RestoreOutputDirRoborazziTask @Inject constructor(objects: ObjectFactory) :
DefaultTask() {
@get:InputDirectory
@Optional
val inputDir: DirectoryProperty = objects.directoryProperty()

@get:OutputDirectory
val outputDir: DirectoryProperty = objects.directoryProperty()

@TaskAction
fun copy() {
val outputDirFile = outputDir.get().asFile
if (outputDirFile.exists() && outputDirFile.listFiles().isNotEmpty()) return
this.infoln("Roborazzi RestoreOutputDirRoborazziTask: Copy files from ${inputDir.get()} to ${outputDirFile}")
inputDir.get().asFile.copyRecursively(outputDirFile)
}
}

open class RoborazziTask : DefaultTask() {
@Option(
option = "tests",
Expand All @@ -492,66 +368,5 @@ abstract class RoborazziPlugin : Plugin<Project> {
}
}

/**
* We can't get whether the test is skipped or not from the test task itself
* because of the configuration cache
*/
abstract class TestTaskSkipEventsServiceProvider : BuildService<BuildServiceParameters.None?>,
OperationCompletionListener {
val skippedTestTaskMap = mutableMapOf<String, Boolean>()
var countDownLatch = CountDownLatch(1)
private set
private val logger = Logging.getLogger(this::class.java)
private val expectingTestNames = mutableListOf<String>()
fun addExpectingTestTaskName(testName: String) {
expectingTestNames.add(testName)
}

override fun onFinish(finishEvent: FinishEvent) {
val displayName = finishEvent.displayName
// println(
// "Roborazzi: onFinish " +
// "expectingTestNames:$expectingTestNames" +
// "displayName:$displayName " +
// "finishEvent:$finishEvent " +
// "finishEvent.descriptor:${finishEvent.descriptor}" +
// "finishEvent.descriptor.name:${finishEvent.descriptor.name}"
// )
if (finishEvent !is TaskFinishEvent) {
return
}
if (!expectingTestNames.any {
displayName.contains(it, ignoreCase = true)
}) {
return
}
val result = finishEvent.result
if (when (result) {
is TaskSuccessResult -> {
if (result.isFromCache) {
true
} else if (result.isUpToDate) {
true
} else {
false
}
}

is TaskFailureResult -> false
is TaskSkippedResult -> true
else -> false
}
) {
logger.info("Roborazzi: Skip test ${finishEvent.descriptor.name} ${System.currentTimeMillis()}")
skippedTestTaskMap[finishEvent.descriptor.name] = true
} else {
logger.info("Roborazzi: Don't skip test ${finishEvent.descriptor.name} ${System.currentTimeMillis()}")
skippedTestTaskMap[finishEvent.descriptor.name] = false
}
countDownLatch.countDown()
countDownLatch = CountDownLatch(1)
}
}

fun Task.infoln(format: String) =
logger.info(format)
Loading