Adding ability to set importing depth for targets

JetBrains · May 26, 2022 · c221030 · c221030
1 parent c932858
commit c221030
Show file tree

Hide file tree

Showing 23 changed files with 728 additions and 449 deletions.
diff --git a/...rc/main/java/org/jetbrains/bsp/bazel/projectview/generator/DefaultProjectViewGenerator.kt b/...rc/main/java/org/jetbrains/bsp/bazel/projectview/generator/DefaultProjectViewGenerator.kt
@@ -4,6 +4,7 @@ import io.vavr.control.Try
 import org.jetbrains.bsp.bazel.projectview.generator.sections.ProjectViewBazelPathSectionGenerator
 import org.jetbrains.bsp.bazel.projectview.generator.sections.ProjectViewBuildFlagsSectionGenerator
 import org.jetbrains.bsp.bazel.projectview.generator.sections.ProjectViewDebuggerAddressSectionGenerator
+import org.jetbrains.bsp.bazel.projectview.generator.sections.ProjectViewImportDepthSectionGenerator
 import org.jetbrains.bsp.bazel.projectview.generator.sections.ProjectViewJavaPathSectionGenerator
 import org.jetbrains.bsp.bazel.projectview.generator.sections.ProjectViewTargetsSectionGenerator
 import org.jetbrains.bsp.bazel.projectview.model.ProjectView
@@ -22,5 +23,6 @@ object DefaultProjectViewGenerator : ProjectViewGenerator {
             ProjectViewDebuggerAddressSectionGenerator.generatePrettyString(projectView.debuggerAddress),
             ProjectViewJavaPathSectionGenerator.generatePrettyString(projectView.javaPath),
             ProjectViewBuildFlagsSectionGenerator.generatePrettyString(projectView.buildFlags),
+            ProjectViewImportDepthSectionGenerator.generatePrettyString(projectView.importDepth),
         ).joinToString(separator = "\n\n", postfix = "\n")
 }
diff --git a/...etbrains/bsp/bazel/projectview/generator/sections/ProjectViewSingletonSectionGenerator.kt b/...etbrains/bsp/bazel/projectview/generator/sections/ProjectViewSingletonSectionGenerator.kt
@@ -2,6 +2,7 @@ package org.jetbrains.bsp.bazel.projectview.generator.sections
 
 import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewBazelPathSection
 import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewDebuggerAddressSection
+import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewImportDepthSection
 import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewJavaPathSection
 import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewSingletonSection
 
@@ -23,3 +24,5 @@ object ProjectViewDebuggerAddressSectionGenerator :
     ProjectViewSingletonSectionGenerator<ProjectViewDebuggerAddressSection>()
 
 object ProjectViewBazelPathSectionGenerator : ProjectViewSingletonSectionGenerator<ProjectViewBazelPathSection>()
+
+object ProjectViewImportDepthSectionGenerator : ProjectViewSingletonSectionGenerator<ProjectViewImportDepthSection>()
diff --git a/...ontext/projectview/src/main/java/org/jetbrains/bsp/bazel/projectview/model/ProjectView.kt b/...ontext/projectview/src/main/java/org/jetbrains/bsp/bazel/projectview/model/ProjectView.kt
@@ -7,6 +7,7 @@ import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewBazelPathSe
 import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewBuildFlagsSection
 import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewDebuggerAddressSection
 import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewExcludableListSection
+import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewImportDepthSection
 import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewJavaPathSection
 import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewListSection
 import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewSingletonSection
@@ -28,6 +29,8 @@ data class ProjectView constructor(
     val javaPath: ProjectViewJavaPathSection?,
     /** bazel flags added to all bazel command invocations  */
     val buildFlags: ProjectViewBuildFlagsSection?,
+    /** level of depth for importing inherited targets */
+    val importDepth: ProjectViewImportDepthSection?,
 ) {
 
     class Builder constructor(
@@ -37,6 +40,7 @@ data class ProjectView constructor(
         private val debuggerAddress: ProjectViewDebuggerAddressSection? = null,
         private val javaPath: ProjectViewJavaPathSection? = null,
         private val buildFlags: ProjectViewBuildFlagsSection? = null,
+        private val importDepth: ProjectViewImportDepthSection? = null,
     ) {
 
         fun build(): Try<ProjectView> {
@@ -48,7 +52,8 @@ data class ProjectView constructor(
                         + " bazel path: {},"
                         + " debugger address: {},"
                         + " java path: {},"
-                        + " build flags: {}.",
+                        + " build flags: {},"
+                        + " import depth: {}.",
                 imports,
                 targets,
                 bazelPath,
@@ -69,18 +74,21 @@ data class ProjectView constructor(
             val debuggerAddress = combineDebuggerAddressSection(importedProjectViews)
             val javaPath = combineJavaPathSection(importedProjectViews)
             val buildFlags = combineBuildFlagsSection(importedProjectViews)
+            val importDepth = combineImportDepthSection(importedProjectViews)
             log.debug(
                 "Building project view with combined"
                         + " targets: {},"
                         + " bazel path: {},"
                         + " debugger address: {},"
-                        + " java path: {}.",
+                        + " java path: {},"
+                        + " import depth: {}.",
                 targets,
                 bazelPath,
                 debuggerAddress,
-                javaPath
+                javaPath,
+                importDepth
             )
-            return ProjectView(targets, bazelPath, debuggerAddress, javaPath, buildFlags)
+            return ProjectView(targets, bazelPath, debuggerAddress, javaPath, buildFlags, importDepth)
         }
 
         private fun combineTargetsSection(importedProjectViews: List<ProjectView>): ProjectViewTargetsSection? {
@@ -153,6 +161,9 @@ data class ProjectView constructor(
         private fun combineJavaPathSection(importedProjectViews: List<ProjectView>): ProjectViewJavaPathSection? =
             javaPath ?: getLastImportedSingletonValue(importedProjectViews, ProjectView::javaPath)
 
+        private fun combineImportDepthSection(importedProjectViews: List<ProjectView>): ProjectViewImportDepthSection? =
+            importDepth ?: getLastImportedSingletonValue(importedProjectViews, ProjectView::importDepth)
+
 
         private fun <T : ProjectViewSingletonSection<*>> getLastImportedSingletonValue(
             importedProjectViews: List<ProjectView>, sectionGetter: (ProjectView) -> T?

diff --git a/...in/java/org/jetbrains/bsp/bazel/projectview/model/sections/ProjectViewSingletonSection.kt b/...in/java/org/jetbrains/bsp/bazel/projectview/model/sections/ProjectViewSingletonSection.kt
@@ -26,3 +26,10 @@ data class ProjectViewBazelPathSection(override val value: Path) :
         const val SECTION_NAME = "bazel_path"
     }
 }
+
+data class ProjectViewImportDepthSection(override val value: Int) :
+    ProjectViewSingletonSection<Int>(SECTION_NAME) {
+    companion object {
+        const val SECTION_NAME = "import_depth"
+    }
+}
diff --git a/...view/src/main/java/org/jetbrains/bsp/bazel/projectview/parser/DefaultProjectViewParser.kt b/...view/src/main/java/org/jetbrains/bsp/bazel/projectview/parser/DefaultProjectViewParser.kt
@@ -6,6 +6,7 @@ import org.jetbrains.bsp.bazel.projectview.model.ProjectView
 import org.jetbrains.bsp.bazel.projectview.parser.sections.ProjectViewBazelPathSectionParser
 import org.jetbrains.bsp.bazel.projectview.parser.sections.ProjectViewBuildFlagsSectionParser
 import org.jetbrains.bsp.bazel.projectview.parser.sections.ProjectViewDebuggerAddressSectionParser
+import org.jetbrains.bsp.bazel.projectview.parser.sections.ProjectViewImportDepthSectionParser
 import org.jetbrains.bsp.bazel.projectview.parser.sections.ProjectViewJavaPathSectionParser
 import org.jetbrains.bsp.bazel.projectview.parser.sections.ProjectViewTargetsSectionParser
 import org.jetbrains.bsp.bazel.projectview.parser.splitter.ProjectViewRawSections
@@ -46,6 +47,7 @@ open class DefaultProjectViewParser : ProjectViewParser {
             debuggerAddress = ProjectViewDebuggerAddressSectionParser.parse(rawSections),
             javaPath = ProjectViewJavaPathSectionParser.parse(rawSections),
             buildFlags = ProjectViewBuildFlagsSectionParser.parse(rawSections),
+            importDepth = ProjectViewImportDepthSectionParser.parse(rawSections),
         ).build()
     }
 

diff --git a/.../org/jetbrains/bsp/bazel/projectview/parser/sections/ProjectViewSingletonSectionParser.kt b/.../org/jetbrains/bsp/bazel/projectview/parser/sections/ProjectViewSingletonSectionParser.kt
@@ -1,10 +1,7 @@
 package org.jetbrains.bsp.bazel.projectview.parser.sections
 
 import org.apache.logging.log4j.LogManager
-import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewBazelPathSection
-import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewDebuggerAddressSection
-import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewJavaPathSection
-import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewSingletonSection
+import org.jetbrains.bsp.bazel.projectview.model.sections.*
 import org.jetbrains.bsp.bazel.projectview.parser.splitter.ProjectViewRawSections
 import java.nio.file.Path
 import kotlin.io.path.Path
@@ -69,3 +66,13 @@ object ProjectViewJavaPathSectionParser :
 
     override fun createInstance(value: Path): ProjectViewJavaPathSection = ProjectViewJavaPathSection(value)
 }
+
+
+object ProjectViewImportDepthSectionParser :
+    ProjectViewSingletonSectionParser<Int, ProjectViewImportDepthSection>(ProjectViewImportDepthSection.SECTION_NAME) {
+
+    override fun mapRawValue(rawValue: String): Int = rawValue.toInt()
+
+    override fun createInstance(value: Int): ProjectViewImportDepthSection =
+        ProjectViewImportDepthSection(value)
+}
diff --git a/...est/java/org/jetbrains/bsp/bazel/projectview/generator/DefaultProjectViewGeneratorTest.kt b/...est/java/org/jetbrains/bsp/bazel/projectview/generator/DefaultProjectViewGeneratorTest.kt
@@ -3,11 +3,7 @@ package org.jetbrains.bsp.bazel.projectview.generator
 import ch.epfl.scala.bsp4j.BuildTargetIdentifier
 import io.kotest.matchers.shouldBe
 import org.jetbrains.bsp.bazel.projectview.model.ProjectView
-import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewBazelPathSection
-import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewBuildFlagsSection
-import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewDebuggerAddressSection
-import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewJavaPathSection
-import org.jetbrains.bsp.bazel.projectview.model.sections.ProjectViewTargetsSection
+import org.jetbrains.bsp.bazel.projectview.model.sections.*
 import org.jetbrains.bsp.bazel.projectview.parser.DefaultProjectViewParser
 import org.jetbrains.bsp.bazel.utils.dope.DopeTemp
 import org.junit.jupiter.api.DisplayName
@@ -31,6 +27,7 @@ class DefaultProjectViewGeneratorTest {
                 debuggerAddress = null,
                 javaPath = null,
                 buildFlags = null,
+                importDepth = null,
             )
 
             // when
@@ -59,6 +56,7 @@ class DefaultProjectViewGeneratorTest {
                 debuggerAddress = null,
                 javaPath = null,
                 buildFlags = null,
+                importDepth = null,
             )
 
             // when
@@ -87,6 +85,7 @@ class DefaultProjectViewGeneratorTest {
                 debuggerAddress = null,
                 javaPath = null,
                 buildFlags = null,
+                importDepth = null,
             )
 
             // when
@@ -110,6 +109,7 @@ class DefaultProjectViewGeneratorTest {
                 debuggerAddress = ProjectViewDebuggerAddressSection("localhost:8000"),
                 javaPath = null,
                 buildFlags = null,
+                importDepth = null,
             )
 
             // when
@@ -133,6 +133,7 @@ class DefaultProjectViewGeneratorTest {
                 debuggerAddress = null,
                 javaPath = ProjectViewJavaPathSection(Paths.get("/path/to/java")),
                 buildFlags = null,
+                importDepth = null,
             )
 
             // when
@@ -162,6 +163,7 @@ class DefaultProjectViewGeneratorTest {
                         "--build_flag3=value3",
                     )
                 ),
+                importDepth = null,
             )
 
             // when
@@ -179,6 +181,30 @@ class DefaultProjectViewGeneratorTest {
             generatedString shouldBe expectedGeneratedString
         }
 
+        @Test
+        fun `should return pretty string only with import depth flag for project view only with import depth flag`() {
+            // given
+            val projectView = ProjectView(
+                targets = null,
+                bazelPath = null,
+                debuggerAddress = null,
+                javaPath = null,
+                buildFlags = null,
+                importDepth = ProjectViewImportDepthSection(3),
+            )
+
+            // when
+            val generatedString = DefaultProjectViewGenerator.generatePrettyString(projectView)
+
+            // then
+            val expectedGeneratedString =
+                """
+                import_depth: 3
+
+                """.trimIndent()
+            generatedString shouldBe expectedGeneratedString
+        }
+
         @Test
         fun `should return pretty string with project view for project view with empty list sections`() {
             // given
@@ -188,6 +214,7 @@ class DefaultProjectViewGeneratorTest {
                 debuggerAddress = ProjectViewDebuggerAddressSection("localhost:8000"),
                 javaPath = ProjectViewJavaPathSection(Paths.get("/path/to/java")),
                 buildFlags = ProjectViewBuildFlagsSection(emptyList()),
+                importDepth = ProjectViewImportDepthSection(3),
             )
 
             // when
@@ -206,6 +233,8 @@ class DefaultProjectViewGeneratorTest {
 
                 build_flags:
 
+                import_depth: 3
+
                 """.trimIndent()
             generatedString shouldBe expectedGeneratedString
         }
@@ -231,6 +260,7 @@ class DefaultProjectViewGeneratorTest {
                         "--build_flag3=value3",
                     )
                 ),
+                importDepth = null
             )
 
             // when
@@ -280,6 +310,7 @@ class DefaultProjectViewGeneratorTest {
                         "--build_flag3=value3",
                     )
                 ),
+                importDepth = ProjectViewImportDepthSection(3),
             )
 
             // when
@@ -306,6 +337,8 @@ class DefaultProjectViewGeneratorTest {
                     --build_flag2=value2
                     --build_flag3=value3
 
+                import_depth: 3
+
                 """.trimIndent()
             generatedString shouldBe expectedGeneratedString
         }
@@ -342,6 +375,7 @@ class DefaultProjectViewGeneratorTest {
                         "--build_flag3=value3",
                     )
                 ),
+                importDepth = ProjectViewImportDepthSection(3),
             )
 
             // when
@@ -370,6 +404,8 @@ class DefaultProjectViewGeneratorTest {
                     --build_flag2=value2
                     --build_flag3=value3
 
+                import_depth: 3
+
                 """.trimIndent()
             Files.readString(filePath) shouldBe expectedFileContent
         }
@@ -402,6 +438,7 @@ class DefaultProjectViewGeneratorTest {
                         "--build_flag3=value3",
                     )
                 ),
+                importDepth = ProjectViewImportDepthSection(3),
             )
 
             // when
@@ -430,6 +467,8 @@ class DefaultProjectViewGeneratorTest {
                     --build_flag2=value2
                     --build_flag3=value3
 
+                import_depth: 3
+
                 """.trimIndent()
             Files.readString(filePath) shouldBe expectedFileContent
         }
@@ -445,6 +484,7 @@ class DefaultProjectViewGeneratorTest {
                 debuggerAddress = ProjectViewDebuggerAddressSection("localhost:8000"),
                 javaPath = ProjectViewJavaPathSection(Paths.get("/path/to/java")),
                 buildFlags = ProjectViewBuildFlagsSection(emptyList()),
+                importDepth = ProjectViewImportDepthSection(3),
             )
 
             val parser = DefaultProjectViewParser()
@@ -463,6 +503,7 @@ class DefaultProjectViewGeneratorTest {
                 debuggerAddress = ProjectViewDebuggerAddressSection("localhost:8000"),
                 javaPath = ProjectViewJavaPathSection(Paths.get("/path/to/java")),
                 buildFlags = null,
+                importDepth = ProjectViewImportDepthSection(3),
             )
             parsedProjectViewTry.get() shouldBe expectedProjectView
         }
@@ -490,6 +531,7 @@ class DefaultProjectViewGeneratorTest {
                         "--build_flag3=value3",
                     )
                 ),
+                importDepth = null,
             )
 
             val parser = DefaultProjectViewParser()
@@ -532,6 +574,7 @@ class DefaultProjectViewGeneratorTest {
                         "--build_flag3=value3",
                     )
                 ),
+                importDepth = ProjectViewImportDepthSection(3),
             )
 
             val parser = DefaultProjectViewParser()