Skip to content

Tests: migrate PowerShellFormatterTest to JUnit 5 #376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 1, 2025
Merged

Tests: migrate PowerShellFormatterTest to JUnit 5 #376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
489ef0e
Tests: migrate PowerShellFormatterTest to JUnit 5
ForNeVeR Jul 1, 2025
cde25fa
PowerShellSuspendContext: fix compatibility with IJ 252
ForNeVeR Jul 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions src/main/kotlin/com/intellij/plugin/powershell/ide/debugger/PowerShellSuspendContext.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,17 +8,20 @@ import org.eclipse.lsp4j.debug.StackTraceResponse
import org.eclipse.lsp4j.debug.Variable
import org.eclipse.lsp4j.debug.services.IDebugProtocolServer

class PowerShellSuspendContext(val stack: StackTraceResponse, val server: IDebugProtocolServer,
val coroutineScope: CoroutineScope,
val threadId: Int = 0, val xDebugSession: XDebugSession
): XSuspendContext(){
class PowerShellSuspendContext(
val stack: StackTraceResponse,
val server: IDebugProtocolServer,
private val scope: CoroutineScope,
val threadId: Int = 0,
val xDebugSession: XDebugSession
): XSuspendContext() {

val variablesCache: MutableMap<Pair<Int, String>, Variable> = mutableMapOf()
override fun getExecutionStacks(): Array<XExecutionStack> {
return arrayOf(PowerShellExecutionStack(stack, server, coroutineScope, xDebugSession))
return arrayOf(PowerShellExecutionStack(stack, server, scope, xDebugSession))
}

override fun getActiveExecutionStack(): XExecutionStack {
return PowerShellExecutionStack(stack, server, coroutineScope, xDebugSession)
return PowerShellExecutionStack(stack, server, scope, xDebugSession)
}
}
166 changes: 104 additions & 62 deletions src/test/kotlin/com/intellij/plugin/powershell/lang/PowerShellFormatterTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,47 +5,53 @@ import com.intellij.openapi.application.ApplicationManager
import com.intellij.openapi.command.CommandProcessor
import com.intellij.openapi.util.TextRange
import com.intellij.plugin.powershell.ide.editor.formatting.PowerShellCodeStyleSettings
import com.intellij.plugin.powershell.testFramework.PowerShellCodeInsightTestBase
import com.intellij.plugin.powershell.testFramework.RunInEdt
import com.intellij.psi.PsiDocumentManager
import com.intellij.psi.PsiFileFactory
import com.intellij.psi.codeStyle.CodeStyleManager
import com.intellij.psi.codeStyle.CommonCodeStyleSettings
import com.intellij.psi.formatter.FormatterTestCase
import com.intellij.testFramework.junit5.TestApplication
import com.intellij.util.IncorrectOperationException
import junit.framework.TestCase
import com.intellij.util.application
import org.junit.jupiter.api.Assertions.assertEquals
import org.junit.jupiter.api.Assertions.assertTrue
import org.junit.jupiter.api.Test

class PowerShellFormatterTest : FormatterTestCase() {

private val myTestDataDir = "src/test/resources/testData/"

override fun getBasePath(): String = "format"
override fun getFileExtension(): String = "ps1"
override fun getTestDataPath(): String = myTestDataDir
@TestApplication
@RunInEdt
class PowerShellFormatterTest : PowerShellCodeInsightTestBase() {

@Test
fun testBlockIndent() {
doTest("indents", "indents_res")
}

@Test
fun testBracesShiftedIndent() {
val tempTestSettings = getCommonSettings()
tempTestSettings.BRACE_STYLE = CommonCodeStyleSettings.NEXT_LINE_SHIFTED2
tempTestSettings.METHOD_BRACE_STYLE = CommonCodeStyleSettings.NEXT_LINE_SHIFTED2
doTest("indent_brace", "indent_brace_res")
}

@Test
fun testDependentBracePlacement() {
val settings = getCommonSettings()
settings.BRACE_STYLE = CommonCodeStyleSettings.NEXT_LINE_IF_WRAPPED
settings.METHOD_BRACE_STYLE = CommonCodeStyleSettings.NEXT_LINE_IF_WRAPPED
doTest("braces1", "braces1_if_wrapped_res")
}

@Test
fun testPipelineWrap() {
val psSettings = getPowerShellSettings()
psSettings.PIPELINE_TAIL_WRAP = CommonCodeStyleSettings.WRAP_ALWAYS
psSettings.ALIGN_MULTILINE_PIPELINE_STATEMENT = true
doTest("indent_brace", "indent_brace_pipeline_wrap_res")
}

@Test
fun testBlockParametersWrap() {
doTest("wrap_block_parameters", "wrap_block_parameters_default_res")
val psSettings = getPowerShellSettings()
Expand All @@ -54,16 +60,19 @@ class PowerShellFormatterTest : FormatterTestCase() {
doTest("wrap_block_parameters", "wrap_block_parameters_res")
}

@Test
fun testBlockParameterIndent() {
doTest("block_parameter_indent", "block_parameter_indent_res")
}

@Test
fun testDefault1() {
val tempTestSettings = getCommonSettings()
tempTestSettings.KEEP_LINE_BREAKS = false
doTest("default1", "default1_res")
}

@Test
fun testChainedCallWrap() {
val settings = getCommonSettings()
settings.RIGHT_MARGIN = 60
Expand All @@ -74,12 +83,14 @@ class PowerShellFormatterTest : FormatterTestCase() {
doTest("wrap_chained_call", "wrap_chained_call_if_long_first_wrap_res")
}

@Test
fun testNoSpacingForCompoundIdentifiers() {
val settings = getCommonSettings()
settings.SPACE_AROUND_MULTIPLICATIVE_OPERATORS = true
doTest("compound_identifiers", "compound_identifiers_res")
}

@Test
fun testChainedCallWrapAlignment() {
val settings = getCommonSettings()
settings.RIGHT_MARGIN = 60
Expand All @@ -92,6 +103,7 @@ class PowerShellFormatterTest : FormatterTestCase() {
doTest("wrap_chained_call", "wrap_chained_call_always_res")
}

@Test
fun testWrapBinaryExpr() {
val settings = getCommonSettings()
settings.RIGHT_MARGIN = 30
Expand All @@ -111,60 +123,61 @@ class PowerShellFormatterTest : FormatterTestCase() {
}


@Test
fun testBraces() {
val before = "switch -regex -casesensitive (get-childitem | sort length) {\n" +
" \" ^5\" {\n" +
" \"length for \$_ started with 5\"; continue\n" +
" }\n" +
" { \$_.length >20000 } {\n" +
" \"length of \$_ is greater than 20000\"\n" +
" }\n" +
" default {\n" +
" \"Didn't match anything else...\"\n" +
" }\n" +
"}\n" +
"\n" +
"function TrapTest {\n" +
" trap {\n" +
" \"Error found.\"\n" +
" }\n" +
" nonsenseString\n" +
"}\n" +
"\n" +
"class A {\n" +
" doSomethingMethod() {\n" +
"\n" +
" }\n" +
"}"
" \" ^5\" {\n" +
" \"length for \$_ started with 5\"; continue\n" +
" }\n" +
" { \$_.length >20000 } {\n" +
" \"length of \$_ is greater than 20000\"\n" +
" }\n" +
" default {\n" +
" \"Didn't match anything else...\"\n" +
" }\n" +
"}\n" +
"\n" +
"function TrapTest {\n" +
" trap {\n" +
" \"Error found.\"\n" +
" }\n" +
" nonsenseString\n" +
"}\n" +
"\n" +
"class A {\n" +
" doSomethingMethod() {\n" +
"\n" +
" }\n" +
"}"
val after = "switch -regex -casesensitive (get-childitem | sort length)\n" +
"{\n" +
" \" ^5\" {\n" +
" \"length for \$_ started with 5\"; continue\n" +
" }\n" +
" { \$_.length >20000 } {\n" +
" \"length of \$_ is greater than 20000\"\n" +
" }\n" +
" default {\n" +
" \"Didn't match anything else...\"\n" +
" }\n" +
"}\n" +
"\n" +
"function TrapTest\n" +
"{\n" +
" trap\n" +
" {\n" +
" \"Error found.\"\n" +
" }\n" +
" nonsenseString\n" +
"}\n" +
"\n" +
"class A\n" +
"{\n" +
" doSomethingMethod()\n" +
" {\n" +
"\n" +
" }\n" +
"}"
"{\n" +
" \" ^5\" {\n" +
" \"length for \$_ started with 5\"; continue\n" +
" }\n" +
" { \$_.length >20000 } {\n" +
" \"length of \$_ is greater than 20000\"\n" +
" }\n" +
" default {\n" +
" \"Didn't match anything else...\"\n" +
" }\n" +
"}\n" +
"\n" +
"function TrapTest\n" +
"{\n" +
" trap\n" +
" {\n" +
" \"Error found.\"\n" +
" }\n" +
" nonsenseString\n" +
"}\n" +
"\n" +
"class A\n" +
"{\n" +
" doSomethingMethod()\n" +
" {\n" +
"\n" +
" }\n" +
"}"

doTextTest(before, after)

Expand All @@ -176,6 +189,7 @@ class PowerShellFormatterTest : FormatterTestCase() {
doTextTest(after, before, false)
}

@Test
fun testWhitespaceDependentOperatorSpacing() {
doTextTest(
"""
Expand All @@ -192,6 +206,7 @@ class PowerShellFormatterTest : FormatterTestCase() {
)
}

@Test
fun testCommandLineArgumentSpacing() {
val sample = """
git log --pretty=format:'%Cred'
Expand All @@ -200,6 +215,7 @@ class PowerShellFormatterTest : FormatterTestCase() {
doTextTest(sample, sample)
}

@Test
fun testNullCoalescingOperator() = doTextTest("\$foo = \$bar ??\$baz", "\$foo = \$bar ?? \$baz")

private fun doTextTest(text: String, textAfter: String, reformatAsText: Boolean = true, textRange: TextRange? = null) {
Expand All @@ -219,7 +235,7 @@ class PowerShellFormatterTest : FormatterTestCase() {
CodeStyleManager.getInstance(project).reformat(file)
}
} catch (e: IncorrectOperationException) {
TestCase.assertTrue(e.localizedMessage, false)
assertTrue(false, e.localizedMessage)
}
}
}, "", "")
Expand All @@ -231,7 +247,33 @@ class PowerShellFormatterTest : FormatterTestCase() {

private fun createFileFromText(text: String) = PsiFileFactory.getInstance(project).createFileFromText(PowerShellLanguage.INSTANCE, text)

private fun getPowerShellSettings(): PowerShellCodeStyleSettings = settings.getCustomSettings(PowerShellCodeStyleSettings::class.java)
private fun getPowerShellSettings(): PowerShellCodeStyleSettings = CodeStyle.getSettings(project).getCustomSettings(PowerShellCodeStyleSettings::class.java)

private fun getCommonSettings() = CodeStyle.getLanguageSettings(createFileFromText(""), PowerShellLanguage.INSTANCE)

private val testDataPackage = "testData/format"
private val fileExtension = "ps1"

private fun doTest(originalFileNameBase: String, expectedFileNameBase: String) {
val originalFileName = "$originalFileNameBase.$fileExtension"
val resultingFileName = "$expectedFileNameBase.$fileExtension"

val classLoader = this::class.java.classLoader
val originalFile = classLoader.getResource("$testDataPackage/$originalFileName")!!
val resultingFile = classLoader.getResource("$testDataPackage/$resultingFileName")!!

val originalFileText = originalFile.readText().replace("\r\n", "\n")
val resultingFileText = resultingFile.readText().replace("\r\n", "\n")

codeInsightTestFixture.configureByText(originalFileName, originalFileText)
val document = codeInsightTestFixture.editor.document
assertEquals(originalFileText, document.text)

CommandProcessor.getInstance().executeCommand(project, {
application.runWriteAction {
CodeStyleManager.getInstance(project).reformat(codeInsightTestFixture.file)
}
}, "", null)
assertEquals(resultingFileText, document.text)
}
}
Loading