ANDROID-15781 Fail in case plugin is applied before app/library plugin and fix issues with file overwriting in emulators. (#6)

Author: dpastor

include-build/gradle-plugin/src/main/java/com/telefonica/loggerazzi/LoggerazziNoDeviceProviderInstrumentTestTasksException.kt

@@ -0,0 +1,5 @@
+package com.telefonica.loggerazzi
+
+class LoggerazziNoDeviceProviderInstrumentTestTasksException : Exception(
+    "No device provider instrument test tasks found. Make sure you are applying the Loggerazzi plugin after the Android app/library plugin."
+)

include-build/gradle-plugin/src/main/java/com/telefonica/loggerazzi/LoggerazziPlugin.kt

@@ -16,8 +16,15 @@ class LoggerazziPlugin @Inject constructor(
 
     override fun apply(project: Project) {
         project.afterEvaluate {
-            project.tasks
+
+            val deviceProviderInstrumentTestTasks = project.tasks
                 .withType(DeviceProviderInstrumentTestTask::class.java)
+
+            if (deviceProviderInstrumentTestTasks.isEmpty()) {
+                throw LoggerazziNoDeviceProviderInstrumentTestTasksException()
+            }
+
+            deviceProviderInstrumentTestTasks
                 .forEach { deviceProviderTask ->
                     val capitalizedVariant = deviceProviderTask.variantName.capitalizeFirstLetter()
                     val beforeTaskName = "loggerazziBefore$capitalizedVariant"
@@ -48,10 +55,12 @@ class LoggerazziPlugin @Inject constructor(
         val recordedFolderFile = reportsFolder.dir("recorded").asFile.apply {
             mkdirs()
             deviceFileManager.pullRecordedLogs(absolutePath)
+            processAndFilterResults()
         }
         val failuresFolderFile = reportsFolder.dir("failures").asFile.apply {
             mkdirs()
             deviceFileManager.pullFailuresLogs(absolutePath)
+            processAndFilterResults()
         }
         val goldenForFailuresReportFolderFile = reportsFolder.dir("golden").asFile.apply {
             mkdirs()
@@ -93,7 +102,7 @@ class LoggerazziPlugin @Inject constructor(
         } else {
             File(getAbsoluteGoldenLogsSourcePath()).apply {
                 mkdirs()
-                deviceFileManager.pullRecordedLogs(absolutePath)
+                recordedFolderFile.copyRecursively(this, true)
             }
         }
     }
@@ -123,4 +132,22 @@ class LoggerazziPlugin @Inject constructor(
     private fun String.capitalizeFirstLetter(): String {
         return replaceFirstChar { if (it.isLowerCase()) it.titlecase() else it.toString() }
     }
+
+    private fun File.processAndFilterResults() {
+        listFiles()
+            ?.groupBy {
+                it.name.substringBeforeLast(".")
+            }
+            ?.forEach { (key, filesGroup) ->
+                val lastFile = filesGroup.maxByOrNull {
+                    it.name.substringAfterLast(".").toLong()
+                }
+                filesGroup.forEach { file ->
+                    if (file != lastFile) {
+                        file.delete()
+                    }
+                }
+                lastFile?.renameTo(File(this, "$key.txt"))
+            }
+    }
 }

include-build/gradle-plugin/src/main/java/com/telefonica/loggerazzi/LoggerazziReportConst.kt

@@ -87,12 +87,6 @@ REPORT_TEMPLATE_BODY
     </div>
 </div>
 
-<div id="imageBottomSheet" class="modal bottom-sheet max-height">
-    <div class="modal-content center-align">
-        <img id="modalImage" src="" alt="">
-    </div>
-</div>
-
 <footer class="page-footer orange">
     <div class="container">
         <a class="us" href="https://github.com/Telefonica/loggerazzi" target="_blank"

loggerazzi/src/main/java/com/telefonica/loggerazzi/LoggerazziRule.kt

@@ -47,25 +47,24 @@ open class GenericLoggerazziRule<LogType>(
     override fun succeeded(description: Description?) {
         super.succeeded(description)
 
-        val testName = "${description?.className}_${description?.methodName}.txt"
+        val testName = "${description?.className}_${description?.methodName}"
+        val fileName = "${testName}.${System.nanoTime()}"
 
         val recordedLogs = recorder.getRecordedLogs()
         val log = recordedLogs.joinToString("\n") { stringMapper.fromLog(it) }
-        val testFile = File(recordedDir, testName)
-        testFile.delete()
+        val testFile = File(recordedDir, fileName)
         testFile.createNewFile()
         testFile.writeText(log)
 
         if (InstrumentationRegistry.getArguments().getString("record") != "true") {
             val goldenFile =
                 InstrumentationRegistry.getInstrumentation().context.assets.open(
-                    "loggerazzi-golden-files/$testName"
+                    "loggerazzi-golden-files/${testName}.txt"
                 )
             val goldenStringLogs = String(goldenFile.readBytes()).takeIf { it.isNotEmpty() }?.split("\n") ?: emptyList()
             val result = comparator.compare(recordedLogs, goldenStringLogs.map { stringMapper.toLog(it) })
             if (result != null) {
-                val compareFile = File(failuresDir, testName)
-                compareFile.delete()
+                val compareFile = File(failuresDir, fileName)
                 compareFile.createNewFile()
                 compareFile.writeText(result)
                 throw AssertionError("Logs do not match:\n$result")