Add build skeleton for Q subplugin (#4154)

rli · web-flow · commit 6a2ae39561ee · 2024-03-05T12:56:03.000-08:00
diff --git a/buildSrc/src/main/kotlin/toolkit-intellij-subplugin.gradle.kts b/buildSrc/src/main/kotlin/toolkit-intellij-subplugin.gradle.kts
@@ -58,16 +58,6 @@ configurations {
         exclude(group = "software.amazon.awssdk", module = "netty-nio-client")
     }
 
-    // TODO: https://github.com/gradle/gradle/issues/15383
-    val versionCatalog = extensions.getByType<VersionCatalogsExtension>().named("libs")
-    dependencies {
-        testImplementation(platform(versionCatalog.findLibrary("junit5-bom").get()))
-        testImplementation(versionCatalog.findLibrary("junit5-jupiterApi").get())
-
-        testRuntimeOnly(versionCatalog.findLibrary("junit5-jupiterEngine").get())
-        testRuntimeOnly(versionCatalog.findLibrary("junit5-jupiterVintage").get())
-    }
-
     all {
         if (name.startsWith("detekt")) {
             return@all
@@ -94,7 +84,9 @@ tasks.processResources {
 
 // Run after the project has been evaluated so that the extension (intellijToolkit) has been configured
 intellij {
-    pluginName.set("aws-toolkit-jetbrains")
+    // find the name of first subproject depth, or root if not applied to a subproject hierarchy
+    val projectName = generateSequence(project) { it.parent }.first { it.depth <= 1 }.name
+    pluginName.convention(projectName)
 
     localPath.set(toolkitIntelliJ.localPath())
     version.set(toolkitIntelliJ.version())
@@ -106,7 +98,8 @@ intellij {
 }
 
 tasks.jar {
-    archiveBaseName.set(toolkitIntelliJ.ideFlavor.map { "aws-toolkit-jetbrains-$it" })
+    // :plugin-toolkit:jetbrains-community results in: --plugin-toolkit-jetbrains-community-IC-<version>.jar
+    archiveBaseName.set(toolkitIntelliJ.ideFlavor.map { "${project.buildTreePath.replace(':', '-')}-$it" })
 }
 
 tasks.withType<PatchPluginXmlTask>().all {
@@ -148,14 +141,10 @@ tasks.withType<Test>().all {
     systemProperty("log.dir", intellij.sandboxDir.map { "$it-test/logs" }.get())
     systemProperty("testDataPath", project.rootDir.resolve("testdata").absolutePath)
     val jetbrainsCoreTestResources = project(":plugin-toolkit:jetbrains-core").projectDir.resolve("tst-resources")
-    // FIX_WHEN_MIN_IS_221: log4j 1.2 removed in 221
-    systemProperty("log4j.configuration", jetbrainsCoreTestResources.resolve("log4j.xml"))
     systemProperty("idea.log.config.properties.file", jetbrainsCoreTestResources.resolve("toolkit-test-log.properties"))
     systemProperty("org.gradle.project.ideProfileName", ideProfile.name)
 
     jvmArgs(openedPackages)
-
-    useJUnitPlatform()
 }
 
 tasks.withType<JavaExec> {
diff --git a/buildSrc/src/main/kotlin/toolkit-kotlin-conventions.gradle.kts b/buildSrc/src/main/kotlin/toolkit-kotlin-conventions.gradle.kts
@@ -16,6 +16,9 @@ plugins {
 // TODO: https://github.com/gradle/gradle/issues/15383
 val versionCatalog = extensions.getByType<VersionCatalogsExtension>().named("libs")
 dependencies {
+    // kotlin/kotlin-coroutines might not be necessary if we're in an intellij-plugin-based module
+    // - The dependency on the Kotlin Standard Library (stdlib) is automatically added when using the Gradle Kotlin plugin and may conflict with the version provided with the IntelliJ Platform, see: https://jb.gg/intellij-platform-kotlin-stdlib
+    //- The Kotlin Coroutines library should not be added explicitly to the project as it is already provided with the IntelliJ Platform.
     implementation(versionCatalog.findBundle("kotlin").get())
     implementation(versionCatalog.findLibrary("kotlin-coroutines").get())
 
diff --git a/buildSrc/src/main/kotlin/toolkit-testing.gradle.kts b/buildSrc/src/main/kotlin/toolkit-testing.gradle.kts
@@ -16,7 +16,12 @@ dependencies {
     testImplementation(versionCatalog.findBundle("mockito").get())
     testImplementation(versionCatalog.findLibrary("assertj").get())
 
-    // Don't add a test framework by default since we use junit4, junit5, and testng depending on project
+    // Everything uses junit4/5 except rider, which uses TestNG
+    testImplementation(platform(versionCatalog.findLibrary("junit5-bom").get()))
+    testImplementation(versionCatalog.findLibrary("junit5-jupiterApi").get())
+
+    testRuntimeOnly(versionCatalog.findLibrary("junit5-jupiterEngine").get())
+    testRuntimeOnly(versionCatalog.findLibrary("junit5-jupiterVintage").get())
 }
 
 jacoco {
@@ -45,6 +50,8 @@ artifacts {
 }
 
 tasks.withType<Test>().all {
+    useJUnitPlatform()
+
     ciOnly {
         retry {
             failOnPassedAfterRetry.set(false)
diff --git a/plugins/amazonq/build.gradle.kts b/plugins/amazonq/build.gradle.kts
@@ -0,0 +1,38 @@
+// Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import software.aws.toolkits.gradle.intellij.IdeFlavor
+import software.aws.toolkits.gradle.intellij.IdeVersions
+
+plugins {
+    id("org.jetbrains.intellij")
+}
+
+val ideProfile = IdeVersions.ideProfile(project)
+
+val toolkitVersion: String by project
+val publishToken: String by project
+val publishChannel: String by project
+
+intellij {
+    version.set(ideProfile.community.version())
+    localPath.set(ideProfile.community.localPath())
+
+    updateSinceUntilBuild.set(false)
+    instrumentCode.set(false)
+}
+
+dependencies {
+    implementation(project(":plugin-amazonq:shared"))
+    implementation(project(":plugin-amazonq:codewhisperer"))
+    implementation(project(":plugin-amazonq:mynah-ui"))
+}
+
+configurations {
+    // Make sure we exclude stuff we either A) ships with IDE, B) we don't use to cut down on size
+    runtimeClasspath {
+        exclude(group = "org.slf4j")
+        exclude(group = "org.jetbrains.kotlin")
+        exclude(group = "org.jetbrains.kotlinx")
+    }
+}
diff --git a/plugins/amazonq/codewhisperer/build.gradle.kts b/plugins/amazonq/codewhisperer/build.gradle.kts
@@ -0,0 +1,11 @@
+// Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+plugins {
+    id("java")
+}
+
+dependencies {
+    implementation(project(":plugin-amazonq:codewhisperer:jetbrains-community", "instrumentedJar"))
+    implementation(project(":plugin-amazonq:codewhisperer:jetbrains-ultimate", "instrumentedJar"))
+}
diff --git a/plugins/amazonq/codewhisperer/jetbrains-community/build.gradle.kts b/plugins/amazonq/codewhisperer/jetbrains-community/build.gradle.kts
@@ -0,0 +1,16 @@
+// Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import software.aws.toolkits.gradle.intellij.IdeFlavor
+
+plugins {
+    id("toolkit-intellij-subplugin")
+}
+
+intellijToolkit {
+    ideFlavor.set(IdeFlavor.IC)
+}
+
+dependencies {
+    compileOnly(project(":plugin-amazonq:shared:jetbrains-community"))
+}
diff --git a/plugins/amazonq/codewhisperer/jetbrains-community/resources/META-INF/plugin-codewhisperer.xml b/plugins/amazonq/codewhisperer/jetbrains-community/resources/META-INF/plugin-codewhisperer.xml
@@ -0,0 +1,8 @@
+<!-- Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved. -->
+<!-- SPDX-License-Identifier: Apache-2.0 -->
+
+<idea-plugin>
+    <actions>
+        <action class="Hello" id="q.hello" />
+    </actions>
+</idea-plugin>
diff --git a/plugins/amazonq/codewhisperer/jetbrains-community/src/Hello.kt b/plugins/amazonq/codewhisperer/jetbrains-community/src/Hello.kt
@@ -0,0 +1,15 @@
+// Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import com.intellij.openapi.actionSystem.AnAction
+import com.intellij.openapi.actionSystem.AnActionEvent
+import com.intellij.openapi.project.DumbAware
+import com.intellij.openapi.ui.MessageDialogBuilder
+import software.aws.toolkits.resources.AmazonQBundle
+
+class Hello : AnAction(AmazonQBundle.message("q.hello")), DumbAware {
+    override fun actionPerformed(e: AnActionEvent) {
+        MessageDialogBuilder.okCancel("title", AmazonQBundle.message("q.hello"))
+            .ask(e.project)
+    }
+}
diff --git a/plugins/amazonq/codewhisperer/jetbrains-ultimate/build.gradle.kts b/plugins/amazonq/codewhisperer/jetbrains-ultimate/build.gradle.kts
@@ -0,0 +1,16 @@
+// Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import software.aws.toolkits.gradle.intellij.IdeFlavor
+
+plugins {
+    id("toolkit-intellij-subplugin")
+}
+
+intellijToolkit {
+    ideFlavor.set(IdeFlavor.IU)
+}
+
+dependencies {
+    compileOnly(project(":plugin-amazonq:codewhisperer:jetbrains-community"))
+}
diff --git a/plugins/amazonq/shared/build.gradle.kts b/plugins/amazonq/shared/build.gradle.kts
@@ -0,0 +1,13 @@
+// Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+plugins {
+    id("java")
+}
+
+dependencies {
+    implementation(project(":plugin-amazonq:shared:jetbrains-community", "instrumentedJar"))
+
+    // delete when fully split
+    implementation(project(":plugin-amazonq:shared:jetbrains-ultimate", "instrumentedJar"))
+}
diff --git a/plugins/amazonq/shared/jetbrains-community/build.gradle.kts b/plugins/amazonq/shared/jetbrains-community/build.gradle.kts
@@ -0,0 +1,17 @@
+// Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import software.aws.toolkits.gradle.intellij.IdeFlavor
+
+plugins {
+    id("toolkit-intellij-subplugin")
+}
+
+intellijToolkit {
+    ideFlavor.set(IdeFlavor.IC)
+}
+
+dependencies {
+    // delete when fully split
+    compileOnly(project(":plugin-toolkit:jetbrains-core", "instrumentedJar"))
+}
diff --git a/plugins/amazonq/shared/jetbrains-community/resources/META-INF/plugin.xml b/plugins/amazonq/shared/jetbrains-community/resources/META-INF/plugin.xml
@@ -0,0 +1,10 @@
+<!-- Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved. -->
+<!-- SPDX-License-Identifier: Apache-2.0 -->
+
+<idea-plugin xmlns:xi="http://www.w3.org/2001/XInclude">
+    <id>plugin-amazonq</id>
+
+    <resource-bundle>software.aws.toolkits.resources.AmazonQBundle</resource-bundle>
+
+    <xi:include href="/META-INF/plugin-codewhisperer.xml" />
+</idea-plugin>
diff --git a/plugins/amazonq/shared/jetbrains-community/resources/software/aws/toolkits/resources/AmazonQBundle.properties b/plugins/amazonq/shared/jetbrains-community/resources/software/aws/toolkits/resources/AmazonQBundle.properties
@@ -0,0 +1,2 @@
+action.q.hello.description=Hello description
+q.hello=Hello
diff --git a/plugins/amazonq/shared/jetbrains-community/src/software/aws/toolkits/resources/AmazonQBundle.kt b/plugins/amazonq/shared/jetbrains-community/src/software/aws/toolkits/resources/AmazonQBundle.kt
@@ -0,0 +1,18 @@
+// Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package software.aws.toolkits.resources
+
+import com.intellij.DynamicBundle
+import org.jetbrains.annotations.PropertyKey
+
+object AmazonQBundle {
+    private const val BUNDLE_FQN: String = "software.aws.toolkits.resources.AmazonQBundle"
+    private val BUNDLE = DynamicBundle(AmazonQBundle::class.java, BUNDLE_FQN)
+
+    fun message(key: @PropertyKey(resourceBundle = BUNDLE_FQN) String, vararg params: Any) =
+        BUNDLE.getMessage(key, *params)
+
+    fun messagePointer(key: @PropertyKey(resourceBundle = BUNDLE_FQN) String, vararg params: Any) =
+        BUNDLE.getLazyMessage(key, *params)
+}
diff --git a/plugins/amazonq/shared/jetbrains-ultimate/build.gradle.kts b/plugins/amazonq/shared/jetbrains-ultimate/build.gradle.kts
@@ -0,0 +1,17 @@
+// Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+import software.aws.toolkits.gradle.intellij.IdeFlavor
+
+plugins {
+    id("toolkit-intellij-subplugin")
+}
+
+intellijToolkit {
+    ideFlavor.set(IdeFlavor.IU)
+}
+
+dependencies {
+    compileOnly(project(":plugin-amazonq:shared:jetbrains-community"))
+    compileOnly(project(":plugin-toolkit:jetbrains-ultimate"))
+}
diff --git a/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/resources/AwsToolkitBundle.kt b/plugins/toolkit/jetbrains-core/src/software/aws/toolkits/resources/AwsToolkitBundle.kt
@@ -0,0 +1,18 @@
+// Copyright 2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+
+package software.aws.toolkits.resources
+
+import com.intellij.DynamicBundle
+import org.jetbrains.annotations.PropertyKey
+
+object AwsToolkitBundle {
+    private const val BUNDLE_FQN: String = "software.aws.toolkits.resources.MessagesBundle"
+    private val BUNDLE = DynamicBundle(AwsToolkitBundle::class.java, BUNDLE_FQN)
+
+    fun message(key: @PropertyKey(resourceBundle = BUNDLE_FQN) String, vararg params: Any) =
+        BUNDLE.getMessage(key, *params)
+
+    fun messagePointer(key: @PropertyKey(resourceBundle = BUNDLE_FQN) String, vararg params: Any) =
+        BUNDLE.getLazyMessage(key, *params)
+}
diff --git a/plugins/toolkit/jetbrains-core/tst-resources/log4j.xml b/plugins/toolkit/jetbrains-core/tst-resources/log4j.xml
diff --git a/plugins/toolkit/jetbrains-rider/build.gradle.kts b/plugins/toolkit/jetbrains-rider/build.gradle.kts
@@ -300,6 +300,11 @@ tasks.clean {
 // `runIde` depends on `prepareSandbox` task and then executes IJ inside the sandbox dir
 // `prepareSandbox` depends on the standard Java `jar` and then copies everything into the sandbox dir
 
+intellij {
+    // kotlin and .NET parts of the plugin need to be in the same plugin base directroy
+    pluginName.set("aws-toolkit-jetbrains")
+}
+
 tasks.withType<PrepareSandboxTask>().all {
     dependsOn(resharperDllsDir)
 
diff --git a/plugins/toolkit/jetbrains-rider/testData/.gitignore b/plugins/toolkit/jetbrains-rider/testData/.gitignore
@@ -0,0 +1 @@
+obj/
diff --git a/plugins/toolkit/resources/src/software/aws/toolkits/resources/Localization.kt b/plugins/toolkit/resources/src/software/aws/toolkits/resources/Localization.kt
@@ -13,6 +13,10 @@ private val BUNDLE by lazy {
     ResourceBundle.getBundle(BUNDLE_NAME) ?: throw RuntimeException("Cannot find resource bundle '$BUNDLE_NAME'.")
 }
 
+@Deprecated(
+    "Use extension-specific localization bundle instead",
+    ReplaceWith("AwsToolkitBundle.message(key, *params)", "software.aws.toolkits.resources.AwsToolkitBundle")
+)
 fun message(@PropertyKey(resourceBundle = BUNDLE_NAME) key: String, vararg params: Any): String {
     val value = BUNDLE.getString(key) ?: throw RuntimeException("Key $key not found in $BUNDLE")
     if (params.isNotEmpty() && value.contains("{")) {
diff --git a/settings.gradle.kts b/settings.gradle.kts
@@ -98,7 +98,7 @@ file("plugins").listFiles()?.forEach root@ {
     project(":$pluginRoot").projectDir = it
 
     val path = ArrayDeque<String>()
-    it.walk().maxDepth(2)
+    it.walk().maxDepth(3)
         .onEnter {
             // dont bother traversing a directory if it does not declare a subproject
             if (!it.resolve("build.gradle.kts").isFile) {
