chylex/IntelliJ-IdeaVim
1
0
Fork 0
mirror of https://github.com/chylex/IntelliJ-IdeaVim.git synced 2025-05-09 00:34:07 +02:00
Code

Mark VimTestCase as deprecated

Browse Source
This commit is contained in:
Alex Plate 2025-02-20 19:13:39 +02:00
parent e18035b729
commit d65a219194
No known key found for this signature in database
GPG Key ID: 0B97153C8FFEC09F
1 changed files with 22 additions and 0 deletions

22
src/testFixtures/kotlin/org/jetbrains/plugins/ideavim/VimTestCase.kt
View File

@ -113,9 +113,31 @@ import kotlin.test.assertTrue
* To plugin writers: this class is internal, thus not allowed to be used by third-party plugins.
* This is done as we have no mechanism to guarantee compatibility as we update this test case.
* Feel free to copy this class into your plugin, or copy just needed functions.
*
* Deprecated: Use [VimNoWriteActionTestCase]
* Tests with [VimTestCase] are always started on the EDT with the write action. This is not only incorrect but also
* prevents an implementation of VIM-3376.
*
* If your test fails because of:
* Missing EDT: Wrap with `ApplicationManager.getInstance().invokeAndWait { }`
* Missing Write Action: Wrap with `ApplicationManager.getInstance().runWriteAction { }`
* Missing Read Action: Wrap with `ApplicationManager.getInstance().runReadAction { }`
*
* This wrapping may be needed right in the test if there is a platform call in the test itself.
* E.g. `fixture.editor.foldingModel.runBatchFoldingOperation`.
*
* However, there is a chance that the platform call happens deep in IdeaVim code. IdeaVim historically uses
* very broad EDT and write action scopes. This means we wrap with the write action almost at the top of the
* call stack. This is incorrect, the write action should be taken only in the place where it's necessary.
* So, try to properly introduce a write/read action wrapping in the IdeaVim code. If it's too complicated,
* wrap with write/read action the call in the test and mark it that the action wrapping should be done deeper in the code.
*/
@RunInEdt(writeIntent = true)
@ApiStatus.Internal
@Deprecated(
"Use VimNoWriteActionTestCase instead",
replaceWith = ReplaceWith("VimNoWriteActionTestCase", "org.jetbrains.plugins.ideavim.VimNoWriteActionTestCase")
)
abstract class VimTestCase : VimNoWriteActionTestCase() {
object Checks {
var caretShape: Boolean = true