test: resync copied Scala-plugin testkit, cleanup, move to a separate module

Author: myazinn

.scalafmt.conf

@@ -33,6 +33,7 @@ newlines {
 project.excludeFilters = [
   "macros/*",
   "src/test/scala/intellij/testfixtures/*",
+  "scala-plugin-testkit/.*",
 ]
 
 rewrite {

build.sbt

@@ -63,7 +63,12 @@ lazy val root =
       // using PackagingMethod.Standalone, mirroring the pattern used by the Scala plugin for other test runners
       packageAdditionalProjects += zio2TestRunner
     )
-    .dependsOn(macros)
+    .dependsOn(macros, scalaPluginTestkit % "test->test")
+
+// Vendored copy of the IntelliJ Scala plugin test framework — see scala-plugin-testkit/ORIGIN.md.
+lazy val scalaPluginTestkit =
+  newProject("scala-plugin-testkit", file("scala-plugin-testkit"))
+    .enablePlugins(SbtIdeaPlugin)
 
 lazy val macros =
   newProject("macros", file("macros"))

scala-plugin-testkit/ORIGIN.md

@@ -0,0 +1,18 @@
+# scala-plugin-testkit
+
+- **Source:** https://github.com/JetBrains/intellij-scala
+- **Synced from commit:** `345dc52da7` (branch `idea262.release`)
+
+Vendored copy of the IntelliJ **Scala plugin** test framework — the base classes, fixtures and helpers our
+inspection/refactoring tests build on. JetBrains does not publish these as a Maven artifact, so they have to be copied
+into the repository.
+
+Almost every file is a verbatim copy, but a few carry unavoidable local adaptations, each tagged inline with
+`// zio-local`. Do not "clean up" `// zio-local` lines when re-syncing — re-apply them.
+
+Not all files are copied from the upstream, only those that are actually used by our tests.
+
+This module exists purely so the vendored code is **physically isolated** from our own code to make it easier to re-sync
+with upstream.
+
+Excluded from scalafmt (see `.scalafmt.conf`) so the files stay byte-comparable with upstream.

…ns/plugins/scala/annotator/Message.scala …ns/plugins/scala/annotator/Message.scalasrc/test/scala/org/jetbrains/plugins/scala/annotator/Message.scala renamed to scala-plugin-testkit/src/test/scala/org/jetbrains/plugins/scala/annotator/Message.scala src/test/scala/org/jetbrains/plugins/scala/annotator/Message.scala renamed to scala-plugin-testkit/src/test/scala/org/jetbrains/plugins/scala/annotator/Message.scala

@@ -8,7 +8,7 @@ import scala.annotation.nowarn
 import scala.math.Ordered.orderingToOrdered
 
 /**
- *  See also [[Message2]] for the version with range and text attributes
+ * See also [[Message2]] for the version with range and text attributes
  */
 sealed abstract class Message extends Ordered[Message] {
   def element: String
@@ -19,25 +19,24 @@ sealed abstract class Message extends Ordered[Message] {
 }
 
 object Message {
-  case class Info(override val element: String, override val message: String)    extends Message
+  case class Info(override val element: String, override val message: String) extends Message
   case class Warning(override val element: String, override val message: String) extends Message
-  case class Error(override val element: String, override val message: String)   extends Message
-  case class Hint(override val element: String, text: String, override val message: String = "", offsetDelta: Int = 0)
-      extends Message
+  case class Error(override val element: String, override val message: String) extends Message
+  case class Hint(override val element: String, text: String, override val message: String = "", offsetDelta: Int = 0) extends Message
 
   def fromHighlightInfo(info: HighlightInfo, fileText: String): Option[Message] = {
     val constructor = HighlightingSeverityToConstructor.get(info.getSeverity)
-    val range       = TextRange.create(info.getStartOffset, info.getEndOffset)
+    val range = TextRange.create(info.getStartOffset, info.getEndOffset)
     constructor.map(_.apply(range.substring(fileText), info.getDescription))
   }
 
   @nowarn("cat=deprecation")
   val HighlightingSeverityToConstructor: Map[HighlightSeverity, (String, String) => Message] =
     Map(
-      HighlightSeverity.ERROR        -> Message.Error.apply,
-      HighlightSeverity.WARNING      -> Message.Warning.apply,
+      HighlightSeverity.ERROR -> Message.Error.apply,
+      HighlightSeverity.WARNING -> Message.Warning.apply,
       HighlightSeverity.WEAK_WARNING -> Message.Warning.apply,
-      HighlightSeverity.INFORMATION  -> Message.Info.apply,
-      HighlightSeverity.INFO         -> Message.Info.apply
+      HighlightSeverity.INFORMATION -> Message.Info.apply,
+      HighlightSeverity.INFO -> Message.Info.apply
     )
 }

…ns/scala/base/EditorActionTestBase.scala …ns/scala/base/EditorActionTestBase.scalasrc/test/scala/org/jetbrains/plugins/scala/base/EditorActionTestBase.scala renamed to scala-plugin-testkit/src/test/scala/org/jetbrains/plugins/scala/base/EditorActionTestBase.scala src/test/scala/org/jetbrains/plugins/scala/base/EditorActionTestBase.scala renamed to scala-plugin-testkit/src/test/scala/org/jetbrains/plugins/scala/base/EditorActionTestBase.scala

@@ -1,11 +1,7 @@
 package org.jetbrains.plugins.scala
 package base
 
-import com.intellij.openapi.actionSystem.IdeActions.{
-  ACTION_EDITOR_BACKSPACE,
-  ACTION_EDITOR_ENTER,
-  ACTION_EXPAND_LIVE_TEMPLATE_BY_TAB
-}
+import com.intellij.openapi.actionSystem.IdeActions.{ACTION_EDITOR_BACKSPACE, ACTION_EDITOR_ENTER, ACTION_EXPAND_LIVE_TEMPLATE_BY_TAB}
 import com.intellij.openapi.application.ApplicationManager
 import com.intellij.openapi.application.impl.NonBlockingReadActionImpl
 import com.intellij.openapi.editor.CaretState
@@ -32,8 +28,8 @@ import scala.util.control.NonFatal
 @Category(Array(classOf[EditorTests]))
 abstract class EditorActionTestBase extends ScalaLightCodeInsightFixtureTestCase with ShortCaretMarker {
 
-  protected val q: String   = "\""
-  protected val qq: String  = "\"\""
+  protected val q  : String = "\""
+  protected val qq : String = "\"\""
   protected val qqq: String = "\"\"\""
 
   private implicit def p: Project = getProject
@@ -42,7 +38,9 @@ abstract class EditorActionTestBase extends ScalaLightCodeInsightFixtureTestCase
 
   protected def defaultFileName: String = s"aaa.${fileType.getDefaultExtension}"
 
-  protected def configureByText(text: String, fileName: String = defaultFileName, trimText: Boolean = false): Unit = {
+  protected def configureByText(text: String,
+                                fileName: String = defaultFileName,
+                                trimText: Boolean = false): Unit = {
     val (textActual, caretOffsets) = findCaretOffsets(text, trimText)
 
     assertTrue("expected at least one caret", caretOffsets.nonEmpty)
@@ -60,26 +58,22 @@ abstract class EditorActionTestBase extends ScalaLightCodeInsightFixtureTestCase
     }
     val editor = myFixture.getEditor
     editor.getCaretModel.moveToOffset(caretOffsets.head)
-    val caretStates = caretOffsets.map(offset => new CaretState(editor.offsetToLogicalPosition(offset), null, null))
+    val caretStates = caretOffsets.map { offset => new CaretState(editor.offsetToLogicalPosition(offset), null, null) }
     editor.getCaretModel.setCaretsAndSelections(caretStates.asJava)
   }
 
   /**
-   *  @param textBefore
-   *    editor text with caret markers before the action
-   *  @param textAfter
-   *    editor text with caret markers after the action
-   *  @param stripTrailingSpacesAfterAction
-   *    whether to trim trailing editor spaces after action perform
-   *  @param testBody
-   *    action to perform with `textBefore`
+   * @param textBefore                     editor text with caret markers before the action
+   * @param textAfter                      editor text with caret markers after the action
+   * @param stripTrailingSpacesAfterAction whether to trim trailing editor spaces after action perform
+   * @param testBody                       action to perform with `textBefore`
    */
   protected def performTest(
     textBefore: String,
     textAfter: String,
     fileName: String = defaultFileName,
     trimTestDataText: Boolean = false,
-    stripTrailingSpacesAfterAction: Boolean = false
+    stripTrailingSpacesAfterAction: Boolean = false,
   )(testBody: () => Unit): Unit = try {
     configureByText(textBefore, fileName, trimTestDataText)
 
@@ -88,9 +82,10 @@ abstract class EditorActionTestBase extends ScalaLightCodeInsightFixtureTestCase
     val (expectedText, expectedCarets) = findCaretOffsets(textAfter, trimTestDataText)
 
     /**
-     *  Copied from `com.intellij.testFramework.fixtures.impl.CodeInsightTestFixtureImpl.checkResult` Replaced inner
-     *  `checkResult` call with `checkCaretOffsets` It allows to see caret positions together with file text directly in
-     *  the diff view of failed test It's more convenient then operating with caret offset (as simple integer value)
+     * Copied from `com.intellij.testFramework.fixtures.impl.CodeInsightTestFixtureImpl.checkResult`
+     * Replaced inner `checkResult` call with `checkCaretOffsets`
+     * It allows to see caret positions together with file text directly in the diff view of failed test
+     * It's more convenient then operating with caret offset (as simple integer value)
      */
     Option(IdeaTestExecutionPolicy.current).foreach(_.beforeCheckResult(getFile))
     inWriteCommandAction {
@@ -101,6 +96,7 @@ abstract class EditorActionTestBase extends ScalaLightCodeInsightFixtureTestCase
     }
   } catch {
     case cf: org.junit.ComparisonFailure =>
+      printComparisonFailureRepro(textBefore, cf.getExpected, cf.getActual)
       throw cf.withBeforePrefix(textBefore)
 
     case NonFatal(other) =>
@@ -114,25 +110,52 @@ abstract class EditorActionTestBase extends ScalaLightCodeInsightFixtureTestCase
   protected def performTypingAction(charTyped: Char): Unit =
     myFixture.`type`(charTyped)
 
+  private def printComparisonFailureRepro(textBefore: String, expectedAfter: String, actualAfter: String): Unit =
+    System.err.println(
+      s"""<<<Repro>>>
+         |<<<Before>>>
+         |$textBefore
+         |----------------------------------------------------
+         |<<<ExpectedAfter>>>
+         |$expectedAfter
+         |----------------------------------------------------
+         |<<<ActualAfter>>>
+         |$actualAfter
+         |""".stripMargin
+    )
+
   protected def performTypingAction(text: String): Unit =
     myFixture.`type`(text)
 
-  protected def checkGeneratedTextAfterTyping(
-    textBefore: String,
-    textAfter: String,
-    charTyped: Char,
-    fileName: String = defaultFileName
-  ): Unit =
+  /**
+   * Types text character-by-character and commits the editor document after each character.
+   *
+   * Why we need this helper for some typing tests:
+   * - `TypedHandlerDelegate` API does not guarantee PSI is in sync with the document during typing callbacks.
+   * - `EditorTestFixture.type(String)` types in a tight loop (`type(char)` per character) without explicit commit between characters.
+   * - Psi commits are asynchronous and coalesced, so in tests PSI can lag behind typed text longer than in production.
+   *
+   * In production, human typing cadence usually gives the async commit pipeline enough time to catch up between key presses.
+   * In tests, typing whole strings too fast can make `file.findElementAt(...)` return `null` in typed handlers and produce
+   * behavior different from what users see in the IDE.
+   *
+   * Without extra "commit" some tests might fail after fixes in the formatter related to SCL-25190
+   */
+  protected def performTypingActionAndCommitEachChar(text: String): Unit =
+    text.foreach { char: Char =>
+      performTypingAction(char)
+
+      getEditor.getDocument.commit(getProject)
+    }
+
+  protected def checkGeneratedTextAfterTyping(textBefore: String, textAfter: String, charTyped: Char,
+                                              fileName: String = defaultFileName): Unit =
     performTest(textBefore, textAfter, fileName) { () =>
       performTypingAction(charTyped)
     }
 
-  protected def checkGeneratedTextAfterTypingText(
-    textBefore: String,
-    textAfter: String,
-    textTyped: String,
-    fileName: String = defaultFileName
-  ): Unit =
+  protected def checkGeneratedTextAfterTypingText(textBefore: String, textAfter: String, textTyped: String,
+                                                  fileName: String = defaultFileName): Unit =
     performTest(textBefore, textAfter, fileName) { () =>
       performTypingAction(textTyped)
     }
@@ -144,10 +167,7 @@ abstract class EditorActionTestBase extends ScalaLightCodeInsightFixtureTestCase
     fileName: String = defaultFileName
   ): Unit =
     performTest(textBefore, textAfter, fileName) { () =>
-      textTyped.foreach { char: Char =>
-        performTypingAction(char)
-        getEditor.getDocument.commit(getProject)
-      }
+      performTypingActionAndCommitEachChar(textTyped)
     }
 
   protected def performBackspaceAction(): Unit =
@@ -222,13 +242,12 @@ abstract class EditorActionTestBase extends ScalaLightCodeInsightFixtureTestCase
         .foldLeft(text)(_.patch(_, CARET, 0))
 
     val expected0 = patchTextWithCarets(expectedText, expectedCarets)
-    val expected  = if (stripTrailingSpaces) doStripTrailingSpaces(expected0) else expected0
+    val expected = if (stripTrailingSpaces) doStripTrailingSpaces(expected0) else expected0
 
-    val actual =
-      if (expectedCarets.nonEmpty)
-        patchTextWithCarets(actualText, actualCarets)
-      else
-        actualText // if expected text doesn't contain any carets, just don't assert carets positions then
+    val actual = if (expectedCarets.nonEmpty)
+      patchTextWithCarets(actualText, actualCarets)
+    else
+      actualText //if expected text doesn't contain any carets, just don't assert carets positions then
     assertEquals(expected, actual)
   }
 }

…ns/plugins/scala/base/FailableTest.scala …ns/plugins/scala/base/FailableTest.scalasrc/test/scala/org/jetbrains/plugins/scala/base/FailableTest.scala renamed to scala-plugin-testkit/src/test/scala/org/jetbrains/plugins/scala/base/FailableTest.scala src/test/scala/org/jetbrains/plugins/scala/base/FailableTest.scala renamed to scala-plugin-testkit/src/test/scala/org/jetbrains/plugins/scala/base/FailableTest.scala

@@ -5,14 +5,15 @@ import org.junit.Assert
 trait FailableTest {
 
   /**
-   *  A hook to allow tests that are currently failing to pass when they fail and vice versa.
-   *  @return
+   * A hook to allow tests that are currently failing to pass when they fail and vice versa.
+   * @return
    */
   protected def shouldPass: Boolean = true
 
-  protected def assertEqualsFailable(expected: AnyRef, actual: AnyRef): Unit =
+  protected def assertEqualsFailable(expected: AnyRef, actual: AnyRef): Unit = {
     if (shouldPass) Assert.assertEquals(expected, actual)
     else Assert.assertNotEquals(expected, actual)
+  }
 
   protected val failingPassed: String = "Test has passed, but was supposed to fail"
 }

…s/plugins/scala/base/InjectableJdk.scala …s/plugins/scala/base/InjectableJdk.scalasrc/test/scala/org/jetbrains/plugins/scala/base/InjectableJdk.scala renamed to scala-plugin-testkit/src/test/scala/org/jetbrains/plugins/scala/base/InjectableJdk.scala src/test/scala/org/jetbrains/plugins/scala/base/InjectableJdk.scala renamed to scala-plugin-testkit/src/test/scala/org/jetbrains/plugins/scala/base/InjectableJdk.scala

@@ -5,8 +5,8 @@ import com.intellij.pom.java.LanguageLevel
 trait InjectableJdk {
 
   private var _injectedJdkVersion: Option[LanguageLevel] = None
-  def injectedJdkVersion: Option[LanguageLevel]          = _injectedJdkVersion
-  def injectedJdkVersion_=(value: LanguageLevel): Unit   = _injectedJdkVersion = Some(value)
+  def injectedJdkVersion: Option[LanguageLevel] = _injectedJdkVersion
+  def injectedJdkVersion_=(value: LanguageLevel): Unit = _injectedJdkVersion = Some(value)
 
   def defaultJdkVersion: LanguageLevel = InjectableJdk.DefaultJdk
 

…/plugins/scala/base/LibrariesOwner.scala …/plugins/scala/base/LibrariesOwner.scalasrc/test/scala/org/jetbrains/plugins/scala/base/LibrariesOwner.scala renamed to scala-plugin-testkit/src/test/scala/org/jetbrains/plugins/scala/base/LibrariesOwner.scala src/test/scala/org/jetbrains/plugins/scala/base/LibrariesOwner.scala renamed to scala-plugin-testkit/src/test/scala/org/jetbrains/plugins/scala/base/LibrariesOwner.scala

@@ -14,14 +14,14 @@ trait LibrariesOwner {
 
   private lazy val myLoaders = mutable.ListBuffer.empty[LibraryLoader]
 
-  protected def setUpLibraries(implicit module: Module): Unit =
+  protected def setUpLibraries(module: Module): Unit =
     librariesLoaders.foreach { loader =>
       myLoaders += loader
       loader.init(module, version)
     }
 
-  protected def disposeLibraries(implicit module: Module): Unit = {
-    myLoaders.foreach(_.clean)
+  protected def disposeLibraries(module: Module): Unit = {
+    myLoaders.foreach(_.clean(module))
     myLoaders.clear()
   }
 }