Make sandbox run configurations more representative of the published artifact (#4171)

rli · web-flow · commit 73fc53d01eec · 2024-03-11T15:20:20.000-07:00
Previously, the sandbox tasks only ran a given submodule of the plugin.

This led to some scenarios where no issues were found when testing in the IDE sandbox, but were discovered once they were published in the marketplace.

Resolved by always running the sandbox on the artifact that will be published to the marketplace
diff --git a/.run/.editorconfig b/.run/.editorconfig
@@ -0,0 +1,2 @@
+[*.xml]
+indent_size = 2
diff --git a/.run/Run AWS Toolkit - Core [2023.1].run.xml b/.run/Run AWS Toolkit - Core [2023.1].run.xml
@@ -1,11 +1,11 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run AWS Toolkit - Core [2023.1]" type="GradleRunConfiguration" factoryName="Gradle" folderName="2023.1">
-    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/jetbrains-core/build/idea-sandbox/system/log/idea.log" />
+    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/intellij/build/idea-sandbox/system/log/idea.log" />
     <ExternalSystemSettings>
       <option name="executionName" />
-      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/jetbrains-core" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/intellij" />
       <option name="externalSystemIdString" value="GRADLE" />
-      <option name="scriptParameters" value="-PideProfileName=2023.1" />
+      <option name="scriptParameters" value="-PrunIdeVariant=IC -PideProfileName=2023.1" />
       <option name="taskDescriptions">
         <list />
       </option>
diff --git a/.run/Run AWS Toolkit - Core [2023.2].run.xml b/.run/Run AWS Toolkit - Core [2023.2].run.xml
@@ -1,11 +1,11 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run AWS Toolkit - Core [2023.2]" type="GradleRunConfiguration" factoryName="Gradle" folderName="2023.2">
-    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/jetbrains-core/build/idea-sandbox/system/log/idea.log" />
+    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/intellij/build/idea-sandbox/system/log/idea.log" />
     <ExternalSystemSettings>
       <option name="executionName" />
-      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/jetbrains-core" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/intellij" />
       <option name="externalSystemIdString" value="GRADLE" />
-      <option name="scriptParameters" value="-PideProfileName=2023.2" />
+      <option name="scriptParameters" value="-PrunIdeVariant=IC -PideProfileName=2023.2" />
       <option name="taskDescriptions">
         <list />
       </option>
diff --git a/.run/Run AWS Toolkit - Core [2023.3].run.xml b/.run/Run AWS Toolkit - Core [2023.3].run.xml
@@ -1,11 +1,11 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run AWS Toolkit - Core [2023.3]" type="GradleRunConfiguration" factoryName="Gradle" folderName="2023.3">
-    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/jetbrains-core/build/idea-sandbox/system/log/idea.log" />
+    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/intellij/build/idea-sandbox/system/log/idea.log" />
     <ExternalSystemSettings>
       <option name="executionName" />
-      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/jetbrains-core" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/intellij" />
       <option name="externalSystemIdString" value="GRADLE" />
-      <option name="scriptParameters" value="-PideProfileName=2023.3" />
+      <option name="scriptParameters" value="-PrunIdeVariant=IC -PideProfileName=2023.3" />
       <option name="taskDescriptions">
         <list />
       </option>
diff --git a/.run/Run AWS Toolkit - Core [2024.1].run.xml b/.run/Run AWS Toolkit - Core [2024.1].run.xml
@@ -1,11 +1,11 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run AWS Toolkit - Core [2024.1]" type="GradleRunConfiguration" factoryName="Gradle" folderName="2024.1">
-    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/jetbrains-core/build/idea-sandbox/system/log/idea.log" />
+    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/intellij/build/idea-sandbox/system/log/idea.log" />
     <ExternalSystemSettings>
       <option name="executionName" />
-      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/jetbrains-core" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/intellij" />
       <option name="externalSystemIdString" value="GRADLE" />
-      <option name="scriptParameters" value="-PideProfileName=2024.1" />
+      <option name="scriptParameters" value="-PrunIdeVariant=IC -PideProfileName=2024.1" />
       <option name="taskDescriptions">
         <list />
       </option>
diff --git a/.run/Run AWS Toolkit - Rider [2023.1].run.xml b/.run/Run AWS Toolkit - Rider [2023.1].run.xml
@@ -1,11 +1,11 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run AWS Toolkit - Rider [2023.1]" type="GradleRunConfiguration" factoryName="Gradle" folderName="2023.1">
-    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/jetbrains-rider/build/idea-sandbox/system/log/idea.log" />
+    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/intellij/build/idea-sandbox/system/log/idea.log" />
     <ExternalSystemSettings>
       <option name="executionName" />
-      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/jetbrains-rider" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/intellij" />
       <option name="externalSystemIdString" value="GRADLE" />
-      <option name="scriptParameters" value="-PideProfileName=2023.1" />
+      <option name="scriptParameters" value="-PrunIdeVariant=RD -PideProfileName=2023.1" />
       <option name="taskDescriptions">
         <list />
       </option>
diff --git a/.run/Run AWS Toolkit - Rider [2023.2].run.xml b/.run/Run AWS Toolkit - Rider [2023.2].run.xml
@@ -1,11 +1,11 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run AWS Toolkit - Rider [2023.2]" type="GradleRunConfiguration" factoryName="Gradle" folderName="2023.2">
-    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/jetbrains-rider/build/idea-sandbox/system/log/idea.log" />
+    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/intellij/build/idea-sandbox/system/log/idea.log" />
     <ExternalSystemSettings>
       <option name="executionName" />
-      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/jetbrains-rider" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/intellij" />
       <option name="externalSystemIdString" value="GRADLE" />
-      <option name="scriptParameters" value="-PideProfileName=2023.2" />
+      <option name="scriptParameters" value="-PrunIdeVariant=RD -PideProfileName=2023.2" />
       <option name="taskDescriptions">
         <list />
       </option>
diff --git a/.run/Run AWS Toolkit - Rider [2023.3].run.xml b/.run/Run AWS Toolkit - Rider [2023.3].run.xml
@@ -1,11 +1,11 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run AWS Toolkit - Rider [2023.3]" type="GradleRunConfiguration" factoryName="Gradle" folderName="2023.3">
-    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/jetbrains-rider/build/idea-sandbox/system/log/idea.log" />
+    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/intellij/build/idea-sandbox/system/log/idea.log" />
     <ExternalSystemSettings>
       <option name="executionName" />
-      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/jetbrains-rider" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/intellij" />
       <option name="externalSystemIdString" value="GRADLE" />
-      <option name="scriptParameters" value="-PideProfileName=2023.3" />
+      <option name="scriptParameters" value="-PrunIdeVariant=RD -PideProfileName=2023.3" />
       <option name="taskDescriptions">
         <list />
       </option>
diff --git a/.run/Run AWS Toolkit - Rider [2024.1].run.xml b/.run/Run AWS Toolkit - Rider [2024.1].run.xml
@@ -1,11 +1,11 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run AWS Toolkit - Rider [2024.1]" type="GradleRunConfiguration" factoryName="Gradle" folderName="2024.1">
-    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/jetbrains-rider/build/idea-sandbox/system/log/idea.log" />
+    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/intellij/build/idea-sandbox/system/log/idea.log" />
     <ExternalSystemSettings>
       <option name="executionName" />
-      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/jetbrains-rider" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/intellij" />
       <option name="externalSystemIdString" value="GRADLE" />
-      <option name="scriptParameters" value="-PideProfileName=2024.1" />
+      <option name="scriptParameters" value="-PrunIdeVariant=RD -PideProfileName=2024.1" />
       <option name="taskDescriptions">
         <list />
       </option>
diff --git a/.run/Run AWS Toolkit - Ultimate [2023.1].run.xml b/.run/Run AWS Toolkit - Ultimate [2023.1].run.xml
@@ -1,11 +1,11 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run AWS Toolkit - Ultimate [2023.1]" type="GradleRunConfiguration" factoryName="Gradle" folderName="2023.1">
-    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/jetbrains-ultimate/build/idea-sandbox/system/log/idea.log" />
+    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/intellij/build/idea-sandbox/system/log/idea.log" />
     <ExternalSystemSettings>
       <option name="executionName" />
-      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/jetbrains-ultimate" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/intellij" />
       <option name="externalSystemIdString" value="GRADLE" />
-      <option name="scriptParameters" value="-PideProfileName=2023.1" />
+      <option name="scriptParameters" value="-PrunIdeVariant=IU -PideProfileName=2023.1" />
       <option name="taskDescriptions">
         <list />
       </option>
diff --git a/.run/Run AWS Toolkit - Ultimate [2023.2].run.xml b/.run/Run AWS Toolkit - Ultimate [2023.2].run.xml
@@ -1,11 +1,11 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run AWS Toolkit - Ultimate [2023.2]" type="GradleRunConfiguration" factoryName="Gradle" folderName="2023.2">
-    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/jetbrains-ultimate/build/idea-sandbox/system/log/idea.log" />
+    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/intellij/build/idea-sandbox/system/log/idea.log" />
     <ExternalSystemSettings>
       <option name="executionName" />
-      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/jetbrains-ultimate" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/intellij" />
       <option name="externalSystemIdString" value="GRADLE" />
-      <option name="scriptParameters" value="-PideProfileName=2023.2" />
+      <option name="scriptParameters" value="-PrunIdeVariant=IU -PideProfileName=2023.2" />
       <option name="taskDescriptions">
         <list />
       </option>
diff --git a/.run/Run AWS Toolkit - Ultimate [2023.3].run.xml b/.run/Run AWS Toolkit - Ultimate [2023.3].run.xml
@@ -1,11 +1,11 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run AWS Toolkit - Ultimate [2023.3]" type="GradleRunConfiguration" factoryName="Gradle" folderName="2023.3">
-    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/jetbrains-ultimate/build/idea-sandbox/system/log/idea.log" />
+    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/intellij/build/idea-sandbox/system/log/idea.log" />
     <ExternalSystemSettings>
       <option name="executionName" />
-      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/jetbrains-ultimate" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/intellij" />
       <option name="externalSystemIdString" value="GRADLE" />
-      <option name="scriptParameters" value="-PideProfileName=2023.3" />
+      <option name="scriptParameters" value="-PrunIdeVariant=IU -PideProfileName=2023.3" />
       <option name="taskDescriptions">
         <list />
       </option>
diff --git a/.run/Run AWS Toolkit - Ultimate [2024.1].run.xml b/.run/Run AWS Toolkit - Ultimate [2024.1].run.xml
@@ -1,11 +1,11 @@
 <component name="ProjectRunConfigurationManager">
   <configuration default="false" name="Run AWS Toolkit - Ultimate [2024.1]" type="GradleRunConfiguration" factoryName="Gradle" folderName="2024.1">
-    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/jetbrains-ultimate/build/idea-sandbox/system/log/idea.log" />
+    <log_file alias="idea.log" path="$PROJECT_DIR$/plugins/toolkit/intellij/build/idea-sandbox/system/log/idea.log" />
     <ExternalSystemSettings>
       <option name="executionName" />
-      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/jetbrains-ultimate" />
+      <option name="externalProjectPath" value="$PROJECT_DIR$/plugins/toolkit/intellij" />
       <option name="externalSystemIdString" value="GRADLE" />
-      <option name="scriptParameters" value="-PideProfileName=2024.1" />
+      <option name="scriptParameters" value="-PrunIdeVariant=IU -PideProfileName=2024.1" />
       <option name="taskDescriptions">
         <list />
       </option>
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -82,17 +82,25 @@ If ran using the Debug feature, a debugger will be auto-attached to the sandbox
 ### Running manually
 
   ```
-  ./gradlew jetbrains-core:runIde
-  ./gradlew jetbrains-ultimate:runIde
-  ./gradlew jetbrains-rider:runIde
+  # IntelliJ IDEA Community
+  ./gradlew :plugin-toolkit:intellij:runIde -PrunIdeVariant=IC
+
+  # IntelliJ IDEA Ultimate
+  ./gradlew :plugin-toolkit:intellij:runIde -PrunIdeVariant=IU
+
+  # Rider
+  ./gradlew :plugin-toolkit:intellij:runIde -PrunIdeVariant=RD
+
+  # Gateway
+  ./gradlew :plugin-toolkit:jetbrains-gateway:runIde
   ```
   - These targets download the required IDE for testing.
 
 #### Alternative IDE
 
 - To run the plugin in a **specific JetBrains IDE** (and you have it installed), specify the `ALTERNATIVE_IDE` environment variable:
   ```
-  ALTERNATIVE_IDE=/path/to/ide ./gradlew :intellij:runIde
+  ALTERNATIVE_IDE=/path/to/ide ./gradlew :plugin-toolkit:intellij:runIde
   ```
   - This is needed to run PyCharm and WebStorm.
   - See also `alternativeIdePath` option in the `runIde` tasks provided by the Gradle IntelliJ Plugin [documentation](https://github.com/JetBrains/gradle-intellij-plugin).
@@ -137,8 +145,10 @@ If the tests run too quickly, you can tell the UI tests to wait for the debugger
 
 - Log messages (`LOG.info`, `LOG.error()`, …) by default are written to:
   ```
-  jetbrains-[subModule]/build/idea-sandbox/system/log/idea.log
-  jetbrains-[subModule]/build/idea-sandbox/system-test/logs/idea.log  # Tests
+  plugins/toolkit/intellij/build/idea-sandbox/system/log/idea.log
+  plugins/toolkit/intellij/build/idea-sandbox/system-test/logs/idea.log  # Tests
+
+  plugins/toolkit/jetbrains-gateway/build/idea-sandbox/system/logs/idea.log  # Gateway
   ```
 - DEBUG-level log messages are skipped by default. To enable them, add the
   following line to the _Help_ \> _Debug Log Settings_ dialog in the IDE
diff --git a/build.gradle.kts b/build.gradle.kts
@@ -59,7 +59,7 @@ dependencies {
 
 tasks.register("runIde") {
     doFirst {
-        throw GradleException("Use project specific runIde command, i.e. :plugin-toolkit:jetbrains-core:runIde, :plugin-toolkit:intellij:runIde")
+        throw GradleException("Use project specific runIde command, i.e. :plugin-toolkit:intellij:runIde")
     }
 }
 
diff --git a/buildSrc/src/main/kotlin/toolkit-intellij-subplugin.gradle.kts b/buildSrc/src/main/kotlin/toolkit-intellij-subplugin.gradle.kts
@@ -151,7 +151,31 @@ tasks.withType<JavaExec> {
     systemProperty("aws.toolkits.enableTelemetry", false)
 }
 
+private fun throwIfSubmodule(message: String) {
+    if (project.depth > 1 && !project.name.contains("gateway")) {
+        throw GradleException(message)
+    }
+}
+
+tasks.buildPlugin {
+    doFirst {
+        throwIfSubmodule("""
+        The build generated by this task is not an accurate representation of what will be published to the JetBrains Marketplace.
+        Please run the task associated with the composite build instead.
+        (e.g. :plugin-toolkit:intellij:buildPlugin, :plugin-toolkit:jetbrains-gateway:buildPlugin, :plugin-amazonq:buildPlugin)
+    """.trimIndent())
+    }
+}
+
 tasks.runIde {
+    doFirst {
+        throwIfSubmodule("""
+        The IDE sandbox generated by this task is not an accurate representation of what will be published to the JetBrains Marketplace.
+        Please run the task associated with the composite build instead.
+        (e.g. :plugin-toolkit:intellij:runIde, :plugin-toolkit:jetbrains-gateway:runIde, :plugin-amazonq:runIde)
+    """.trimIndent())
+    }
+
     systemProperty("aws.toolkit.developerMode", true)
     systemProperty("ide.plugins.snapshot.on.unload.fail", true)
     systemProperty("memory.snapshots.path", project.rootDir)
diff --git a/buildspec/linuxTests.yml b/buildspec/linuxTests.yml
@@ -33,7 +33,7 @@ phases:
 
       - chmod +x gradlew
       - su codebuild-user -c "./gradlew -PideProfileName=$ALTERNATIVE_IDE_PROFILE_NAME check coverageReport --info --console plain --continue"
-      - ./gradlew -PideProfileName=$ALTERNATIVE_IDE_PROFILE_NAME buildPlugin
+      - ./gradlew -PideProfileName=$ALTERNATIVE_IDE_PROFILE_NAME :plugin-toolkit:intellij:buildPlugin
       - VCS_COMMIT_ID="${CODEBUILD_RESOLVED_SOURCE_VERSION}"
       - CI_BUILD_URL=$(echo $CODEBUILD_BUILD_URL | sed 's/#/%23/g') # Encode `#` in the URL because otherwise the url is clipped in the Codecov.io site
       - CI_BUILD_ID="${CODEBUILD_BUILD_ID}"
diff --git a/plugins/toolkit/intellij/build.gradle.kts b/plugins/toolkit/intellij/build.gradle.kts
@@ -1,14 +1,21 @@
 // Copyright 2021 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
+import software.aws.toolkits.gradle.intellij.ToolkitIntelliJExtension
 
 plugins {
     id("org.jetbrains.intellij")
     id("toolkit-testing") // Needed so the coverage configurations are present
     id("toolkit-detekt")
 }
 
+val toolkitIntelliJ = project.extensions.create<ToolkitIntelliJExtension>("intellijToolkit").apply {
+    val runIdeVariant = providers.gradleProperty("runIdeVariant")
+    ideFlavor.set(IdeFlavor.values().firstOrNull { it.name == runIdeVariant.orNull } ?: IdeFlavor.IC)
+}
+
 val ideProfile = IdeVersions.ideProfile(project)
 
 val toolkitVersion: String by project
@@ -30,8 +37,8 @@ val gatewayResources = configurations.create("gatewayResources") {
 intellij {
     pluginName.set("aws-toolkit-jetbrains")
 
-    version.set(ideProfile.community.version())
-    localPath.set(ideProfile.community.localPath())
+    localPath.set(toolkitIntelliJ.localPath())
+    version.set(toolkitIntelliJ.version())
 
     updateSinceUntilBuild.set(false)
     instrumentCode.set(false)
