Use java.io.File everywhere and accept existing source files

Author: tschuchortdev

src/main/kotlin/SynchronizedToolProvider.kt

@@ -17,7 +17,6 @@
 package com.facebook.buck.jvm.java.javax
 
 import com.tschuchort.compiletesting.isJdk9OrLater
-import org.jetbrains.kotlin.com.intellij.util.lang.JavaVersion
 
 import java.lang.reflect.InvocationTargetException
 import java.lang.reflect.Method
@@ -29,7 +28,7 @@ import javax.tools.ToolProvider
  * ToolProvider has no synchronization internally, so if we don't synchronize from the outside we
  * could wind up loading the compiler classes multiple times from different class loaders.
  */
-object SynchronizedToolProvider {
+internal object SynchronizedToolProvider {
     private var getPlatformClassLoaderMethod: Method? = null
 
     val systemJavaCompiler: JavaCompiler

src/main/kotlin/com/tschuchort/compiletesting/KotlinCompilation.kt

@@ -19,8 +19,6 @@ package com.tschuchort.compiletesting
 import com.facebook.buck.jvm.java.javax.SynchronizedToolProvider
 import io.github.classgraph.ClassGraph
 import okio.Buffer
-import okio.buffer
-import okio.sink
 import org.jetbrains.kotlin.base.kapt3.AptMode
 import org.jetbrains.kotlin.base.kapt3.KaptFlag
 import org.jetbrains.kotlin.base.kapt3.KaptOptions
@@ -33,7 +31,6 @@ import org.jetbrains.kotlin.config.JVMAssertionsMode
 import org.jetbrains.kotlin.config.JvmDefaultMode
 import org.jetbrains.kotlin.config.JvmTarget
 import org.jetbrains.kotlin.config.Services
-import org.jetbrains.kotlin.incremental.isJavaFile
 import java.io.*
 import java.lang.RuntimeException
 import java.net.URLClassLoader
@@ -63,7 +60,7 @@ class KotlinCompilation {
 	var classpaths: List<File> = emptyList()
 
 	/** Source files to be compiled */
-	var sources: List<KotlinCompilation.SourceFile> = emptyList()
+	var sources: List<SourceFile> = emptyList()
 
 	/** Annotation processors to be passed to kapt */
 	var annotationProcessors: List<Processor> = emptyList()
@@ -129,7 +126,7 @@ class KotlinCompilation {
 	 * Root modules to resolve in addition to the initial modules,
 	 * or all modules on the module path if <module> is ALL-MODULE-PATH
 	 */
-	var additionalJavaModules: MutableList<Path> = mutableListOf()
+	var additionalJavaModules: MutableList<File> = mutableListOf()
 
 	/** Don't generate not-null assertions for arguments of platform types */
 	var noCallAssertions: Boolean = false
@@ -158,7 +155,7 @@ class KotlinCompilation {
 	var assertionsMode: String? = JVMAssertionsMode.DEFAULT.description
 
 	/** Path to the .xml build file to compile */
-	var buildFile: Path? = null
+	var buildFile: File? = null
 
 	/** Compile multifile classes as a hierarchy of parts and facade */
 	var inheritMultifileParts: Boolean = false
@@ -170,7 +167,7 @@ class KotlinCompilation {
 	var skipRuntimeVersionCheck: Boolean = false
 
 	/** Path to JSON file to dump Java to Kotlin declaration mappings */
-	var declarationsOutputPath: Path? = null
+	var declarationsOutputPath: File? = null
 
 	/** Combine modules for source files and binary dependencies into a single module */
 	var singleModule: Boolean = false
@@ -212,7 +209,7 @@ class KotlinCompilation {
 	var sanitizeParentheses: Boolean = false
 
 	/** Paths to output directories for friend modules (whose internals should be visible) */
-	var friendPaths: MutableList<Path> = mutableListOf()
+	var friendPaths: MutableList<File> = mutableListOf()
 
 	/**
 	 * Path to the kotlin-stdlib.jar
@@ -275,17 +272,17 @@ class KotlinCompilation {
 	}
 
 	// Directory for input source files
-	private val sourcesDir get() = File(workingDir, "sources")
+	private val sourcesDir get() = workingDir.resolve("sources")
 
 	// *.class files, Jars and resources (non-temporary) that are created by the
 	// compilation will land here
-	val classesDir get() = File(workingDir, "classes")
+	val classesDir get() = workingDir.resolve("classes")
 
 	// Base directory for kapt stuff
-	private val kaptBaseDir get() = File(workingDir, "kapt")
+	private val kaptBaseDir get() = workingDir.resolve("kapt")
 
 	// Java annotation processors that are compile by kapt will put their generated files here
-	val kaptSourceDir get() = File(kaptBaseDir, "sources")
+	val kaptSourceDir get() = kaptBaseDir.resolve("sources")
 
 	// Output directory for Kotlin source files generated by kapt
 	val kaptKotlinGeneratedDir get() = kaptArgs[OPTION_KAPT_KOTLIN_GENERATED]
@@ -295,23 +292,8 @@ class KotlinCompilation {
 			}
 			?: File(kaptBaseDir, "kotlinGenerated")
 
-	val kaptStubsDir get() = File(kaptBaseDir, "stubs")
-	val kaptIncrementalDataDir get() = File(kaptBaseDir, "incrementalData")
-
-	/** A Kotlin source file to be compiled */
-	data class SourceFile(val name: String, val contents: String) {
-		/**
-		 * Writes the source file to the location and returns the
-		 * corresponding [File] object
-		 */
-		fun writeTo(dir: File): File =
-			File(dir, name).apply {
-				parentFile.mkdirs()
-				sink().buffer().use {
-					it.writeUtf8(contents)
-				}
-			}
-	}
+	val kaptStubsDir get() = kaptBaseDir.resolve("stubs")
+	val kaptIncrementalDataDir get() = kaptBaseDir.resolve("incrementalData")
 
     /** ExitCode of the entire Kotlin compilation process */
     enum class ExitCode {
@@ -364,7 +346,7 @@ class KotlinCompilation {
 		if(javaModulePath != null)
 			it.javaModulePath = javaModulePath!!.toString()
 
-		it.additionalJavaModules = additionalJavaModules.map(Path::toString).toTypedArray()
+		it.additionalJavaModules = additionalJavaModules.map(File::getAbsolutePath).toTypedArray()
 		it.noCallAssertions = noCallAssertions
 		it.noParamAssertions = noParamAssertions
 		it.noReceiverAssertions = noReceiverAssertions
@@ -399,7 +381,7 @@ class KotlinCompilation {
 		it.sanitizeParentheses = sanitizeParentheses
 
 		if(friendPaths.isNotEmpty())
-			it.friendPaths = friendPaths.map(Path::toString).toTypedArray()
+			it.friendPaths = friendPaths.map(File::getAbsolutePath).toTypedArray()
 
 		if(scriptResolverEnvironment.isNotEmpty())
 			it.scriptResolverEnvironment = scriptResolverEnvironment.map { (key, value) -> "$key=\"$value\"" }.toTypedArray()
@@ -445,7 +427,7 @@ class KotlinCompilation {
 				KaptComponentRegistrar.Parameters(annotationProcessors, kaptOptions)
 		)
 
-		val kotlinSources = sourcesDir.listFilesRecursively().filter(File::isKotlinFile)
+		val kotlinSources = sourcesDir.listFilesRecursively().filter<File>(File::isKotlinFile)
 		val javaSources = sourcesDir.listFilesRecursively().filter(File::isJavaFile)
 
 		val sourcePaths = mutableListOf<File>().apply {
@@ -463,7 +445,7 @@ class KotlinCompilation {
                    Java files might generate Kotlin files which then need to be compiled in the
                    compileKotlin step before the compileJava step). So instead we trick K2JVMCompiler
                    by just including an empty .kt-File. */
-				add(SourceFile("emptyKotlinFile.kt", "").writeTo(kaptBaseDir))
+				add(SourceFile.new("emptyKotlinFile.kt", "").writeIfNeeded(kaptBaseDir))
 			}
 		}.map(File::getAbsolutePath).distinct()
 
@@ -658,7 +640,7 @@ class KotlinCompilation {
 		kaptKotlinGeneratedDir.mkdirs()
 
 		// write given sources to working directory
-		sources.forEach { it.writeTo(sourcesDir) }
+		sources.forEach { it.writeIfNeeded(sourcesDir) }
 
 		/*
 		There are 4 steps to the compilation process:
@@ -738,13 +720,11 @@ class KotlinCompilation {
 			//TODO("check that jar file actually contains the right classes")
 		}
 
-
 		if (jarFile == null)
 			log("Searched host classpaths for $simpleName and found no match")
 		else
 			log("Searched host classpaths for $simpleName and found ${jarFile.path}")
 
-
 		return jarFile
 	}
 

src/main/kotlin/com/tschuchort/compiletesting/SourceFile.kt

@@ -0,0 +1,41 @@
+package com.tschuchort.compiletesting
+
+import okio.buffer
+import okio.sink
+import java.io.File
+
+/**
+ * A source file for the [KotlinCompilation]
+ */
+abstract class SourceFile {
+    internal abstract fun writeIfNeeded(dir: File): File
+
+    companion object {
+        /**
+         * Create a new source file for the compilation when the compilation is run
+         */
+        fun new(name: String, contents: String) = object : SourceFile() {
+            override fun writeIfNeeded(dir: File): File {
+                val file = dir.resolve(name)
+                file.createNewFile()
+
+                file.sink().buffer().use {
+                    it.writeUtf8(contents)
+                }
+
+                return file
+            }
+        }
+
+        /**
+         * Compile an existing source file
+         */
+        fun fromPath(path: File) = object : SourceFile() {
+            init {
+                require(path.isFile)
+            }
+
+            override fun writeIfNeeded(dir: File): File = path
+        }
+    }
+}

src/main/kotlin/com/tschuchort/compiletesting/Utils.kt

@@ -1,8 +1,11 @@
 package com.tschuchort.compiletesting
 
 import java.io.File
+import java.io.IOException
 import java.net.URL
 import java.net.URLClassLoader
+import java.nio.file.*
+import java.nio.file.attribute.BasicFileAttributes
 import javax.lang.model.SourceVersion
 
 internal fun <E> MutableCollection<E>.addAll(vararg elems: E) = addAll(elems)
@@ -34,11 +37,25 @@ internal fun File.listFilesRecursively(): List<File> {
     }
 }
 
-internal fun File.isKotlinFile()
-        = listOf("kt", "kts").any{ it.equals(extension, ignoreCase = true) }
+internal fun Path.listFilesRecursively(): List<Path> {
+    val files = mutableListOf<Path>()
 
-internal fun File.isJavaFile()
-        = listOf("java").any{ it.equals(extension, ignoreCase = true) }
+    Files.walkFileTree(this, object : SimpleFileVisitor<Path>() {
+        override fun visitFile(file: Path, attrs: BasicFileAttributes): FileVisitResult {
+            files.add(file)
+            return FileVisitResult.CONTINUE
+        }
+    })
+
+    return files
+}
+
+internal fun File.isKotlinFile() = hasFileExtension(listOf("kt", "kts"))
+
+internal fun File.isJavaFile() = hasFileExtension(listOf("java"))
+
+internal fun File.hasFileExtension(extensions: List<String>)
+    = extensions.any{ it.equals(extension, ignoreCase = true) }
 
 internal fun URLClassLoader.addUrl(url: URL) {
     val addUrlMethod = URLClassLoader::class.java.getDeclaredMethod("addURL", URL::class.java)