IntelliJ Platform Plugin SDK Help

5. Formatter Test

See also FormatterTestCase as convenient base class.

Define Test Data

Create the FormatterTestData.simple file in the testData directory.

# You are reading the ".properties" entry. ! The exclamation mark can also mark text as comments. website= language= English # The backslash below tells the application to continue reading # the value onto the next line. message = Welcome to \ Wikipedia! # Add spaces to the key key\ with\ spaces = This is the value that could be looked up with the key "key with spaces". # Unicode tab :\u0009

Define a Test Method

Add the testFormatter() method to the SimpleCodeInsightTest class previously defined.

  • Again, this method configures the test fixture by using the test file.

  • The code style Simple Language settings for spaces and blank lines are set.

  • The file is then formatted according to the settings.

  • The formatted file is compared to the expected results in the benchmark file DefaultTestData.simple.

public void testFormatter() { myFixture.configureByFile("FormatterTestData.simple"); CodeStyle.getLanguageSettings(myFixture.getFile()).SPACE_AROUND_ASSIGNMENT_OPERATORS = true; CodeStyle.getLanguageSettings(myFixture.getFile()).KEEP_BLANK_LINES_IN_CODE = 2; WriteCommandAction.writeCommandAction(getProject()).run(() -> CodeStyleManager.getInstance(getProject()).reformatText( myFixture.getFile(), List.of(myFixture.getFile().getTextRange()) ) ); myFixture.checkResultByFile("DefaultTestData.simple"); }

Run the Test

Run the test and make sure it's successful.

Running tests

  1. Open the Gradle Tool Window.

  2. Select the simple_language_plugin node. You may need to reimport it as a Gradle project.

  3. Drill down under simple_language_plugin to Tasks, verification, test task.

  4. Run the test task.

The results are displayed in the Run Tool Window, and also written to the simple_language_plugin/build/test-results/test directory.

If the Run Tool Window displays the error Test events were not received, do the following:

  1. In the Gradle Tool Window, drill down under simple_language_plugin to Tasks, build, clean task.

  2. Run the clean task, which deletes the simple_language_plugin/build directory.

  3. Restart the test.

    Last modified: 24 March 2023