tests: use FileProvider API to access file paths

Author: itsaky

.androidide_root

@@ -0,0 +1,3 @@
+DO NOT DELETE!
+
+This file is used in tests to check for the project's root directory.

app/src/main/assets/data/common/tooling-api-all.jar

@@ -33,10 +33,11 @@ dependencies {
     implementation(projects.common)
     implementation(projects.eventbusAndroid)
     implementation(projects.subprojects.toolingApiTesting)
+    implementation(projects.shared)
+
     implementation(libs.common.editor)
     implementation(libs.tests.junit)
     implementation(libs.tests.google.truth)
     implementation(libs.tests.robolectric)
     implementation(libs.tests.mockk)
-    implementation(projects.actions)
 }

lsp/testing/build.gradle.kts

@@ -39,19 +39,20 @@ import com.itsaky.androidide.tooling.api.messages.InitializeProjectMessage
 import com.itsaky.androidide.tooling.testing.ToolingApiTestLauncher
 import com.itsaky.androidide.tooling.testing.ToolingApiTestLauncher.MultiVersionTestClient
 import com.itsaky.androidide.utils.Environment
+import com.itsaky.androidide.utils.FileProvider
 import com.itsaky.androidide.utils.ILogger
 import io.github.rosemoe.sora.text.Content
 import io.mockk.every
 import io.mockk.mockkStatic
-import java.io.File
-import java.nio.file.Path
-import kotlin.io.path.pathString
 import org.greenrobot.eventbus.EventBus
 import org.junit.Before
 import org.junit.runner.RunWith
 import org.robolectric.RobolectricTestRunner
 import org.robolectric.RuntimeEnvironment
 import org.robolectric.annotation.Config
+import java.io.File
+import java.nio.file.Path
+import kotlin.io.path.pathString
 
 /**
  * Runs tests for a language server.
@@ -87,7 +88,6 @@ abstract class LSPTest {
     val (server, project) =
       ToolingApiTestLauncher()
         .launchServer(
-          implDir = FileProvider.implModule().pathString,
           client = MultiVersionTestClient()
         )
     this.toolingProject = project
@@ -96,7 +96,7 @@ abstract class LSPTest {
     Lookup.DEFAULT.update(BuildService.KEY_PROJECT_PROXY, project)
 
     server
-      .initialize(InitializeProjectMessage(FileProvider.projectRoot().toFile().absolutePath))
+      .initialize(InitializeProjectMessage(FileProvider.testProjectRoot().toFile().absolutePath))
       .get()
 
     Environment.ANDROID_JAR = FileProvider.resources().resolve("android.jar").toFile()
@@ -130,7 +130,17 @@ abstract class LSPTest {
 
     // As the content has been changed, we have to
     // Update the content in language server
-    dispatchEvent(DocumentChangeEvent(file!!, contents.toString(), contents.toString(), 1, DELETE, 0, Range.NONE))
+    dispatchEvent(
+      DocumentChangeEvent(
+        file!!,
+        contents.toString(),
+        contents.toString(),
+        1,
+        DELETE,
+        0,
+        Range.NONE
+      )
+    )
   }
 
   @JvmOverloads

lsp/testing/src/main/java/com/itsaky/androidide/lsp/api/LSPTest.kt

@@ -25,4 +25,7 @@ dependencies {
     implementation(libs.androidx.annotation)
     implementation(libs.google.guava)
     implementation(projects.logger)
+
+    testImplementation(libs.tests.google.truth)
+    testImplementation(libs.tests.junit)
 }

shared/build.gradle.kts

@@ -14,22 +14,32 @@
  *  You should have received a copy of the GNU General Public License
  *   along with AndroidIDE.  If not, see <https://www.gnu.org/licenses/>.
  */
-package com.itsaky.androidide.lsp.api
+package com.itsaky.androidide.utils
 
 import java.io.File
 import java.nio.file.Path
 import java.nio.file.Paths
+import kotlin.io.path.ExperimentalPathApi
+import kotlin.io.path.absolute
+import kotlin.io.path.name
 import kotlin.io.path.readText
+import kotlin.io.path.walk
+
+const val PROJECT_ROOT_FILE = ".androidide_root"
 
 /**
- * Provides paths to source files in 'resources' directory.
+ * Provides paths to various directories and files.
  *
  * @author Akash Yadav
  */
 class FileProvider {
 
   companion object {
 
+    private val projectRoot by lazy {
+      currentDir().findProjectRoot()?.absolute()?.normalize()
+    }
+
     @JvmField
     val extension = run {
       val file = File(".").canonicalFile
@@ -41,8 +51,15 @@ class FileProvider {
 
     @JvmStatic fun currentDir(): Path = Paths.get(System.getProperty("user.dir")!!)
 
-    @JvmStatic fun implModule(): Path = currentDir().resolve("../../subprojects/tooling-api-impl")
-    @JvmStatic fun projectRoot(): Path = currentDir().resolve("../../tests/test-project")
+    @JvmStatic fun implModule(): Path = projectRoot().resolve("subprojects/tooling-api-impl")
+
+    @JvmStatic
+    fun projectRoot(): Path =
+      checkNotNull(projectRoot) {
+        "Unable to file project root. Check if '${PROJECT_ROOT_FILE}' file exists in the project root directory."
+      }
+
+    @JvmStatic fun testProjectRoot(): Path = projectRoot().resolve("tests/test-project")
 
     /**
      * Get the path to the 'resources' directory.
@@ -51,7 +68,7 @@ class FileProvider {
      */
     @JvmStatic
     fun resources(): Path {
-      return projectRoot().resolve("app/src/main/resources")
+      return testProjectRoot().resolve("app/src/main/resources")
     }
 
     /**
@@ -68,3 +85,12 @@ class FileProvider {
     @JvmStatic fun contents(file: Path): StringBuilder = StringBuilder(file.readText())
   }
 }
+
+@OptIn(ExperimentalPathApi::class)
+private fun Path.findProjectRoot(): Path? {
+  if (walk().find { it.name == PROJECT_ROOT_FILE } != null) {
+    return this
+  }
+
+  return parent?.findProjectRoot()
+}

lsp/testing/src/main/java/com/itsaky/androidide/lsp/api/FileProvider.kt renamed to shared/src/main/java/com/itsaky/androidide/utils/FileProvider.kt

@@ -15,46 +15,40 @@
  *   along with AndroidIDE.  If not, see <https://www.gnu.org/licenses/>.
  */
 
-package com.itsaky.androidide.lsp.api
+package com.itsaky.androidide.utils
 
-import com.google.common.truth.Truth
+import com.google.common.truth.Truth.assertThat
+import org.junit.Test
 import java.io.File
 import java.nio.file.Files
-import org.junit.Test
-import org.junit.runner.RunWith
-import org.robolectric.RobolectricTestRunner
-import org.robolectric.annotation.Config
 
-/** @author Akash Yadav */
-@RunWith(RobolectricTestRunner::class)
-@Config(manifest = Config.NONE)
 class FileProviderTest {
 
   @Test
   fun testPath() {
     val path = FileProvider.sourceFile("SourceFileTest")
-    Truth.assertThat(Files.exists(path)).isTrue()
-    Truth.assertThat(path.fileName.toString()).isEqualTo("SourceFileTest_template.java")
+    assertThat(Files.exists(path)).isTrue()
+    assertThat(path.fileName.toString()).isEqualTo("SourceFileTest_template.java")
   }
 
   @Test
   fun testNested() {
     val path = FileProvider.sourceFile("package/SourceFileTest")
-    Truth.assertThat(Files.exists(path)).isTrue()
-    Truth.assertThat(path.fileName.toString()).isEqualTo("SourceFileTest_template.java")
+    assertThat(Files.exists(path)).isTrue()
+    assertThat(path.fileName.toString()).isEqualTo("SourceFileTest_template.java")
   }
 
   @Test
   fun testExtension() {
     val folder = File(".").canonicalFile
 
-    Truth.assertThat(FileProvider.extension).isNotEmpty()
-    Truth.assertThat(FileProvider.extension)
+    assertThat(FileProvider.extension).isNotEmpty()
+    assertThat(FileProvider.extension)
       .isEqualTo(
         when (folder.name) {
           "xml" -> "xml"
           else -> "java"
         }
       )
   }
-}
+}

lsp/testing/src/test/java/com/itsaky/androidide/lsp/api/FileProviderTest.kt renamed to shared/src/test/java/com/itsaky/androidide/utils/FileProviderTest.kt

@@ -44,4 +44,5 @@ dependencies {
     testImplementation(libs.tests.junit)
     testImplementation(libs.tests.robolectric)
     testImplementation(libs.tests.google.truth)
+    testImplementation(projects.shared)
 }

subprojects/aaptcompiler/build.gradle.kts

@@ -26,6 +26,7 @@ import com.android.aaptcompiler.compileResource
 import com.android.aaptcompiler.extractPathData
 import com.android.utils.StdLogger
 import com.android.utils.StdLogger.Level.VERBOSE
+import com.itsaky.androidide.utils.FileProvider
 import java.nio.file.Paths
 import kotlin.io.path.absolute
 import org.junit.Test
@@ -39,7 +40,7 @@ class CompilerTest {
   @Test
   fun `test simple compilatation`() {
     val input =
-      Paths.get("../../app/src/main/res/layout/activity_editor.xml").absolute().normalize().toFile()
+      FileProvider.projectRoot().resolve("app/src/main/res/layout/activity_editor.xml").toFile()
     val output = Paths.get("./build").absolute().normalize().toFile()
     println(input)
     println(output)

subprojects/aaptcompiler/src/test/java/com/itsaky/androidide/aaptcompiler/CompilerTest.kt

@@ -34,6 +34,7 @@ dependencies {
     implementation(libs.google.guava)
 
     testImplementation(projects.subprojects.toolingApiTesting)
+    testImplementation(projects.shared)
     testImplementation(libs.tests.junit)
     testImplementation(libs.tests.google.truth)
     testImplementation(libs.tests.robolectric)

subprojects/projects/build.gradle.kts

@@ -26,15 +26,16 @@ import com.itsaky.androidide.projects.ProjectManager
 import com.itsaky.androidide.projects.builder.BuildService
 import com.itsaky.androidide.tooling.api.messages.InitializeProjectMessage
 import com.itsaky.androidide.tooling.testing.ToolingApiTestLauncher
+import com.itsaky.androidide.utils.FileProvider
 import com.itsaky.androidide.utils.SourceClassTrie.SourceNode
+import java.io.File
+import java.nio.file.Files
+import kotlin.io.path.pathString
+import kotlin.io.path.writeText
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.robolectric.RobolectricTestRunner
 import org.robolectric.annotation.Config
-import java.io.File
-import java.nio.file.Files
-import java.nio.file.Paths
-import kotlin.io.path.writeText
 
 /** @author Akash Yadav */
 @RunWith(RobolectricTestRunner::class)
@@ -44,7 +45,7 @@ class ModuleProjectTest {
   @Test
   fun test() {
     val (server, project) = ToolingApiTestLauncher().launchServer()
-    server.initialize(InitializeProjectMessage(File("../../tests/test-project").absolutePath)).get()
+    server.initialize(InitializeProjectMessage(FileProvider.testProjectRoot().pathString)).get()
 
     Lookup.DEFAULT.register(BuildService.KEY_PROJECT_PROXY, project)
 
@@ -56,8 +57,7 @@ class ModuleProjectTest {
 
     val rootDir = root.projectDir
     assertThat(rootDir).isNotNull()
-    assertThat(Files.isSameFile(rootDir.toPath(), File("../../tests/test-project").toPath()))
-      .isTrue()
+    assertThat(Files.isSameFile(rootDir.toPath(), FileProvider.testProjectRoot())).isTrue()
 
     val app = root.findByPath(":app")
     assertThat(app).isNotNull()
@@ -183,7 +183,8 @@ class ModuleProjectTest {
   private fun verifyProjectManagerAPIs() {
 
     val testCls =
-      Paths.get("../../tests/test-project/app/src/main/java/com/itsaky/test/app/Test.java")
+      FileProvider.testProjectRoot()
+        .resolve("app/src/main/java/com/itsaky/test/app/Test.java")
         .toAbsolutePath()
         .normalize()
     val testCls_renamed = testCls.parent!!.resolve("TestRenamed.java")

subprojects/projects/src/test/java/com/itsaky/androidide/projects/api/ModuleProjectTest.kt

@@ -18,7 +18,7 @@
 package com.itsaky.androidide.projects.classpath
 
 import com.google.common.truth.Truth.assertThat
-import java.io.File
+import com.itsaky.androidide.utils.FileProvider
 import org.junit.Test
 import org.junit.runner.RunWith
 import org.robolectric.RobolectricTestRunner
@@ -32,9 +32,12 @@ class ZipFileClasspathReaderTest {
   @Test
   fun testListClasses() {
     val classes =
-      ZipFileClasspathReader().listClasses(
-        listOf(File("../../tests/test-project/app/src/main/resources/android.jar"))
-      )
+      ZipFileClasspathReader()
+        .listClasses(
+          listOf(
+            FileProvider.testProjectRoot().resolve("app/src/main/resources/android.jar").toFile()
+          )
+        )
 
     val context = classes.firstOrNull { it.name == "android.content.Context" }
     assertThat(context).isNotNull()

subprojects/projects/src/test/java/com/itsaky/androidide/projects/classpath/ZipFileClasspathReaderTest.kt

@@ -63,6 +63,7 @@ dependencies {
   implementation(libs.tooling.gradleApi)
 
   testImplementation(projects.subprojects.toolingApiTesting)
+  testImplementation(projects.shared)
   testImplementation(libs.tests.junit)
   testImplementation(libs.tests.google.truth)