Auto-remove local debugger caches on test data modification

(cherry picked from commit 59c28e4)

compiler/tests-common/org/jetbrains/kotlin/test/util/jetTestUtils.kt

@@ -16,12 +16,14 @@
 
 package org.jetbrains.kotlin.test.util
 
+import com.intellij.openapi.util.io.FileUtil
 import com.intellij.psi.*
 import com.intellij.psi.util.PsiTreeUtil
 import com.intellij.util.SmartFMap
 import org.jetbrains.kotlin.psi.KtDeclaration
 import org.jetbrains.kotlin.psi.KtPackageDirective
 import org.jetbrains.kotlin.psi.KtTreeVisitorVoid
+import java.io.File
 
 fun String.trimTrailingWhitespacesAndAddNewlineAtEOF(): String =
         this.split('\n').map { it.trimEnd() }.joinToString(separator = "\n").let {
@@ -55,3 +57,18 @@ fun PsiFile.findElementsByCommentPrefix(prefix: String): Map<PsiElement, String>
     )
     return result
 }
+
+fun lastModificationDate(dir: File): Long {
+    var lastModified: Long = -1L
+
+    FileUtil.processFilesRecursively(dir) { file ->
+        val fileModified = file.lastModified()
+        if (fileModified > lastModified) {
+            lastModified = fileModified
+        }
+
+        true
+    }
+
+    return lastModified
+}

idea/tests/org/jetbrains/kotlin/idea/debugger/KotlinDebuggerTestCase.java

@@ -29,6 +29,7 @@ import com.intellij.openapi.roots.ModuleRootManager;
 import com.intellij.openapi.roots.OrderRootType;
 import com.intellij.openapi.roots.ui.configuration.libraryEditor.NewLibraryEditor;
 import com.intellij.openapi.util.Computable;
+import com.intellij.openapi.util.io.FileUtil;
 import com.intellij.openapi.vfs.VfsUtil;
 import com.intellij.openapi.vfs.newvfs.impl.VfsRootAccess;
 import com.intellij.pom.java.LanguageLevel;
@@ -40,6 +41,7 @@ import com.intellij.testFramework.IdeaTestUtil;
 import com.intellij.util.ThrowableRunnable;
 import com.intellij.util.indexing.FileBasedIndex;
 import com.intellij.xdebugger.XDebugSession;
+import kotlin.io.FilesKt;
 import org.jetbrains.annotations.NotNull;
 import org.jetbrains.kotlin.asJava.classes.FakeLightClassForFileOfPackage;
 import org.jetbrains.kotlin.asJava.classes.KtLightClassForFacade;
@@ -51,6 +53,7 @@ import org.jetbrains.kotlin.name.FqName;
 import org.jetbrains.kotlin.psi.KtFile;
 import org.jetbrains.kotlin.test.KotlinTestUtils;
 import org.jetbrains.kotlin.test.MockLibraryUtil;
+import org.jetbrains.kotlin.test.util.JetTestUtilsKt;
 import org.jetbrains.kotlin.utils.ExceptionUtilsKt;
 import org.junit.Assert;
 import org.junit.ComparisonFailure;
@@ -65,14 +68,17 @@ import java.util.List;
 
 public abstract class KotlinDebuggerTestCase extends DescriptorTestCase {
     private static final String TINY_APP = PluginTestCaseBase.getTestDataPathBase() + "/debugger/tinyApp";
+    private static final File TINY_APP_SRC = new File(TINY_APP, "src");
     private static boolean IS_TINY_APP_COMPILED = false;
 
-    // Delete LOCAL_CACHE_DIR to invalidate caches
+    // Caches are auto-invalidated when file modification in TINY_APP_SRC detected (through File.lastModified()).
+    // LOCAL_CACHE_DIR removing can be used to force caches invalidating as well.
     private static final boolean LOCAL_CACHE_REUSE = false;
 
     private static final File LOCAL_CACHE_DIR = new File("out/debuggerTinyApp");
     private static final File LOCAL_CACHE_JAR_DIR = new File(LOCAL_CACHE_DIR, "jar");
     private static final File LOCAL_CACHE_APP_DIR = new File(LOCAL_CACHE_DIR, "app");
+    private static final File LOCAL_CACHE_LAST_MODIFIED_FILE = new File(LOCAL_CACHE_DIR, "lastModified.txt");
 
     private static File CUSTOM_LIBRARY_JAR;
     private static final File CUSTOM_LIBRARY_SOURCES = new File(PluginTestCaseBase.getTestDataPathBase() + "/debugger/customLibraryForTinyApp");
@@ -94,9 +100,20 @@ public abstract class KotlinDebuggerTestCase extends DescriptorTestCase {
     @SuppressWarnings("AssignmentToStaticFieldFromInstanceMethod")
     @Override
     protected void setUp() throws Exception {
-        boolean localCacheRebuild = !LOCAL_CACHE_DIR.exists();
-
         if (LOCAL_CACHE_REUSE) {
+            boolean localCacheRebuild = false;
+
+            if (LOCAL_CACHE_DIR.exists()) {
+                if (isLocalCacheOutdated()) {
+                    System.out.println("-- Local caches outdated --");
+                    FilesKt.deleteRecursively(LOCAL_CACHE_DIR);
+                    localCacheRebuild = true;
+                }
+            }
+            else {
+                localCacheRebuild = true;
+            }
+
             overrideTempOutputDirectory();
             CUSTOM_LIBRARY_JAR = new File(LOCAL_CACHE_DIR, "debuggerCustomLibrary.jar");
             IS_TINY_APP_COMPILED = !localCacheRebuild;
@@ -109,6 +126,23 @@ public abstract class KotlinDebuggerTestCase extends DescriptorTestCase {
         super.setUp();
     }
 
+    private static boolean isLocalCacheOutdated() {
+        if (!LOCAL_CACHE_LAST_MODIFIED_FILE.exists()) return true;
+
+        String text;
+        try {
+            text = FileUtil.loadFile(LOCAL_CACHE_LAST_MODIFIED_FILE);
+        }
+        catch (IOException e) {
+            throw ExceptionUtilsKt.rethrow(e);
+        }
+
+        long cachedFor = Long.parseLong(text);
+        long currentLastDate = JetTestUtilsKt.lastModificationDate(TINY_APP_SRC);
+
+        return currentLastDate != cachedFor;
+    }
+
     private static void overrideTempOutputDirectory() {
         try {
             Field ourOutputRootField = ExecutionTestCase.class.getDeclaredField("ourOutputRoot");
@@ -121,6 +155,12 @@ public abstract class KotlinDebuggerTestCase extends DescriptorTestCase {
                         LOCAL_CACHE_APP_DIR.mkdir();
 
                 Assert.assertTrue("Failure on local cache directories creation", result);
+
+                boolean createFileResult = LOCAL_CACHE_LAST_MODIFIED_FILE.createNewFile();
+                Assert.assertTrue("Failure on " + LOCAL_CACHE_LAST_MODIFIED_FILE.getName() + " creation", createFileResult);
+
+                long lastModificationDate = JetTestUtilsKt.lastModificationDate(TINY_APP_SRC);
+                FileUtil.writeToFile(LOCAL_CACHE_LAST_MODIFIED_FILE, Long.toString(lastModificationDate));
             }
 
             ourOutputRootField.set(null, LOCAL_CACHE_APP_DIR);
@@ -131,6 +171,9 @@ public abstract class KotlinDebuggerTestCase extends DescriptorTestCase {
         catch (IllegalAccessException e) {
             throw ExceptionUtilsKt.rethrow(e);
         }
+        catch (IOException e) {
+            throw ExceptionUtilsKt.rethrow(e);
+        }
     }
 
     private static void configureLibrary(@NotNull ModifiableRootModel model, @NotNull String libraryName, @NotNull File classes, @NotNull File sources) {