IntelliJ Platform Plugin SDK Help

3. Completion Test

This test checks if the Simple Language code completion functionality, implemented in the Reference Contributor section of the Custom Language Support Tutorial, works as expected.

Define Test Data

Create the DefaultTestData.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

Create a test input Java file in the testData directory. This file contains a Simple Language reference within the Java code at <caret>.

public class Test { public static void main(String[] args) { System.out.println("simple:<caret>"); } }

Define a Test

Subclass LightJavaCodeInsightFixtureTestCase to create SimpleCodeInsightTest. Override getTestDataPath(), and return the path from the root of this plugin module to the testData directory.

/** * @return path to test data file directory relative to working directory in the run configuration for this test. */ @Override protected String getTestDataPath() { return "src/test/testData"; }

At this point only one test is defined in SimpleCodeInsightTest: testCompletion(). This method:

  • Configures the test using the two input files.

  • Calls the basic completion functionality. Behind the scenes, this method call creates a list of possible elements to complete the embedded Simple Language reference.

  • Checks the list of returned lookup strings to ensure it matches the completion variants provided by the reference.

public void testCompletion() { myFixture.configureByFiles("", "DefaultTestData.simple"); myFixture.complete(CompletionType.BASIC); List<String> lookupElementStrings = myFixture.getLookupElementStrings(); assertNotNull(lookupElementStrings); assertSameElements(lookupElementStrings, "key with spaces", "language", "message", "tab", "website"); }

A number of related methods exist in CodeInsightTestFixture for testing completion and lookup elements, e.g., when testing completion variants and requiring only one testdata file CodeInsightTestFixture.testCompletionVariants().

Run the Test

Run the test and make sure it's green.

Last modified: 23 June 2021