Move incremental test modification utils to build-common

KT-8487

build-common/src/org/jetbrains/kotlin/incremental/testingUtils/incrementalModificationUtils.kt

@@ -0,0 +1,160 @@
+/*
+ * Copyright 2010-2016 JetBrains s.r.o.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.jetbrains.kotlin.incremental.testingUtils
+
+import com.intellij.openapi.util.io.FileUtil
+import java.io.File
+import java.util.*
+
+private val COMMANDS = listOf("new", "touch", "delete")
+private val COMMANDS_AS_REGEX_PART = COMMANDS.joinToString("|")
+private val COMMANDS_AS_MESSAGE_PART = COMMANDS.joinToString("/") { "\".$it\"" }
+
+enum class TouchPolicy {
+    TIMESTAMP,
+    CHECKSUM
+}
+
+fun copyTestSources(testDataDir: File, sourceDestinationDir: File, filePrefix: String): Map<File, File> {
+    val mapping = hashMapOf<File, File>()
+    FileUtil.copyDir(testDataDir, sourceDestinationDir) {
+        it.isDirectory || it.name.startsWith(filePrefix) && (it.name.endsWith(".kt") || it.name.endsWith(".java"))
+    }
+
+    sourceDestinationDir.walk().forEach { mapping[it] = File(testDataDir, filePrefix + it.name) }
+    return mapping
+}
+
+fun getModificationsToPerform(
+        testDataDir: File,
+        moduleNames: Collection<String>?,
+        allowNoFilesWithSuffixInTestData: Boolean,
+        touchPolicy: TouchPolicy
+): List<List<Modification>> {
+
+    fun getModificationsForIteration(newSuffix: String, touchSuffix: String, deleteSuffix: String): List<Modification> {
+
+        fun getDirPrefix(fileName: String): String {
+            val underscore = fileName.indexOf("_")
+
+            if (underscore != -1) {
+                val module = fileName.substring(0, underscore)
+
+                assert(moduleNames != null) { "File name has module prefix, but multi-module environment is absent" }
+                assert(module in moduleNames!!) { "Module not found for file with prefix: $fileName" }
+
+                return "$module/src"
+            }
+
+            assert(moduleNames == null) { "Test is multi-module, but file has no module prefix: $fileName" }
+            return "src"
+        }
+
+        val modifications = ArrayList<Modification>()
+        for (file in testDataDir.listFiles()!!) {
+            val fileName = file.name
+
+            if (fileName.endsWith(newSuffix)) {
+                modifications.add(ModifyContent(getDirPrefix(fileName) + "/" + fileName.removeSuffix(newSuffix), file))
+            }
+            if (fileName.endsWith(touchSuffix)) {
+                modifications.add(TouchFile(getDirPrefix(fileName) + "/" + fileName.removeSuffix(touchSuffix), touchPolicy))
+            }
+            if (fileName.endsWith(deleteSuffix)) {
+                modifications.add(DeleteFile(getDirPrefix(fileName) + "/" + fileName.removeSuffix(deleteSuffix)))
+            }
+        }
+        return modifications
+    }
+
+    val haveFilesWithoutNumbers = testDataDir.listFiles { it -> it.name.matches(".+\\.(${COMMANDS_AS_REGEX_PART})$".toRegex()) }?.isNotEmpty() ?: false
+    val haveFilesWithNumbers = testDataDir.listFiles { it -> it.name.matches(".+\\.(${COMMANDS_AS_REGEX_PART})\\.\\d+$".toRegex()) }?.isNotEmpty() ?: false
+
+    if (haveFilesWithoutNumbers && haveFilesWithNumbers) {
+        throw IllegalStateException("Bad test data format: files ending with both unnumbered and numbered ${COMMANDS_AS_MESSAGE_PART} were found")
+    }
+    if (!haveFilesWithoutNumbers && !haveFilesWithNumbers) {
+        if (allowNoFilesWithSuffixInTestData) {
+            return listOf(listOf())
+        }
+        else {
+            throw IllegalStateException("Bad test data format: no files ending with ${COMMANDS_AS_MESSAGE_PART} found")
+        }
+    }
+
+    if (haveFilesWithoutNumbers) {
+        return listOf(getModificationsForIteration(".new", ".touch", ".delete"))
+    }
+    else {
+        return (1..10)
+                .map { getModificationsForIteration(".new.$it", ".touch.$it", ".delete.$it") }
+                .filter { it.isNotEmpty() }
+    }
+}
+
+abstract class Modification(val path: String) {
+    abstract fun perform(workDir: File, mapping: MutableMap<File, File>)
+
+    override fun toString(): String = "${javaClass.simpleName} $path"
+}
+
+class ModifyContent(path: String, val dataFile: File) : Modification(path) {
+    override fun perform(workDir: File, mapping: MutableMap<File, File>) {
+        val file = File(workDir, path)
+
+        val oldLastModified = file.lastModified()
+        file.delete()
+        dataFile.copyTo(file)
+
+        val newLastModified = file.lastModified()
+        if (newLastModified <= oldLastModified) {
+            //Mac OS and some versions of Linux truncate timestamp to nearest second
+            file.setLastModified(oldLastModified + 1000)
+        }
+
+        mapping[file] = dataFile
+    }
+}
+
+class TouchFile(path: String, private val touchPolicy: TouchPolicy) : Modification(path) {
+    override fun perform(workDir: File, mapping: MutableMap<File, File>) {
+        val file = File(workDir, path)
+
+        when (touchPolicy) {
+            TouchPolicy.TIMESTAMP -> {
+                val oldLastModified = file.lastModified()
+                //Mac OS and some versions of Linux truncate timestamp to nearest second
+                file.setLastModified(Math.max(System.currentTimeMillis(), oldLastModified + 1000))
+            }
+            TouchPolicy.CHECKSUM -> {
+                file.appendText(" ")
+            }
+        }
+
+    }
+}
+
+class DeleteFile(path: String) : Modification(path) {
+    override fun perform(workDir: File, mapping: MutableMap<File, File>) {
+        val fileToDelete = File(workDir, path)
+        if (!fileToDelete.delete()) {
+            throw AssertionError("Couldn't delete $fileToDelete")
+        }
+
+        mapping.remove(fileToDelete)
+    }
+}