Dart/testSrc/com/jetbrains/dart/analysisServer/DartServerDocUtilTest.java

// Copyright 2000-2022 JetBrains s.r.o. and contributors. Use of this source code is governed by the Apache 2.0 license. package com.jetbrains.dart.analysisServer; import com.intellij.psi.PsiFile; import com.intellij.testFramework.fixtures.CodeInsightFixtureTestCase; import com.intellij.testFramework.fixtures.impl.CodeInsightTestFixtureImpl; import com.jetbrains.lang.dart.ide.documentation.DartDocumentationProvider; import com.jetbrains.lang.dart.util.DartTestUtils; import org.dartlang.analysis.server.protocol.HoverInformation; public class DartServerDocUtilTest extends CodeInsightFixtureTestCase { @Override public void setUp() throws Exception { super.setUp(); DartTestUtils.configureDartSdk(myModule, myFixture.getTestRootDisposable(), true); ((CodeInsightTestFixtureImpl)myFixture).canChangeDocumentDuringHighlighting(true); } public void testAbstractClassSig() { doTest("<code>test.dart abstract class Foo extends Bar </code>", "abstract class <caret>Foo extends Bar { }\nclass Bar { }"); } public void testClassMultilineDoc1() { doTest(""" <code>test.dart class A </code> doc1 doc2 doc3doc4<pre><code>code </code></pre>""", """ /** 1 */ /** * doc1 * doc2 * doc3 * * doc4 *\s * code */ // non-doc class <caret>A{}"""); } public void testClassMultilineDoc2() { doTest(""" <code>test.dart abstract class A </code> doc1 doc2 doc3 doc4 doc5 doc6""", """ @deprecated /** *doc1 * doc2 * doc3 *doc4 * doc5 * doc6 */ abstract class <caret>A{}"""); } public void testClassSingleLineDocs1() { doTest(""" <code>test.dart class A </code> doc1 doc2""", """ // not doc\s /// doc1 \s /* not doc */ /// doc2 \s // not doc\s class <caret>A{}"""); } public void testClassSingleLineDocs2() { doTest(""" <code>test.dart class A </code> doc1 doc2""", """ @deprecated// not doc\s /// doc1 \s /* not doc */ /// doc2 \s // not doc\s class <caret>A{}"""); } public void testConstructorSig1() { // unnamed constructor at declaration doTest("<code>test.dart A A(int one, int two) Containing class: A </code>\n" + "constructor comment", "class A { /** constructor comment */ A<caret>(int one, int two); }"); } public void testConstructorSig2() { // named constructor at declaration doTest( "<code>test.dart A A.name(int one, int two) Containing class: A </code>\n" + "constructor comment", "class A { /** constructor comment */ A.name<caret>(int one, int two); }"); } public void testConstructorSig3() { // unnamed constructor at instantiation doTest("<code>test.dart A A(int one, int two) Containing class: A </code>\n" + "constructor comment", "class A { /** constructor comment */ A(int one, int two);}" + "void m() { var a = new A<caret>(1,2); }"); } public void testConstructorSig4() { // named constructor at instantiation doTest( "<code>test.dart A A.name(int one, int two) Containing class: A </code>\n" + "constructor comment", "class A { /** constructor comment */ A.name(int one, int two); }" + "void m() { var a = new A.name<caret>(1,2); }"); } public void testConstructorSig5() { // unnamed constructor at instantiation, implicit new doTest( "<code>test.dart (new) A A(int one, int two) Containing class: A </code>\n" + "constructor comment", "class A { /** constructor comment */ A(int one, int two); }" + "void m() { var a = A<caret>(1,2); }"); } public void testConstructorSig6() { // named constructor at instantiation, implicit new doTest( "<code>test.dart (new) A A.name(int one, int two) Containing class: A </code>\n" + "constructor comment", "class A { /** constructor comment */ A.name(int one, int two); }" + "void m() { var a = A.name<caret>(1,2); }"); } public void testEnumSig() { doTest("<code>test.dart enum Foo </code>", "enum <caret>Foo { BAR }"); } public void testFieldSig1() { doTest("<code>test.dart int y Containing class: Z Type: int </code>", "class Z { int <caret>y = 42; }"); } public void testFieldSig2() { doTest("<code>test.dart int y Containing class: Z Type: int </code>", "class Z { int <caret>y; }"); } public void testFunctionDoc1() { doTest("<code>test.dart void foo(int x) </code>\nA function on <code>x</code>s.", "/// A function on [x]s.\nvoid <caret>foo(int x) { }"); } public void testFunctionDoc2() { doTest(""" <code>test.dart void foo(int x) </code> Good for:<ul><li>this</li><li>that</li></ul>""", """ /** Good for: * * this * * that */ void <caret>foo(int x) { }"""); } public void testFunctionSig1() { doTest("<code>test.dart int calc(int x) </code>", "int <caret>calc(int x) => x + 42;"); } public void testFunctionSig10() { doTest("<code>test.dart void x({bool b}) </code>", "void <caret>x({bool b}){};"); } public void testFunctionSig11() { doTest( "<code>test.dart List<String> x({bool b = true, List<String> c}) </code>", "List<String> <caret>x({bool b= true, List<String> c}){}"); } public void testFunctionSig12() { doTest( "<code>test.dart List<String> x({bool b = true, Map<String, String> c}) </code>", "List<String> <caret>x({bool b= true, Map<String, String> c}){}"); } public void testFunctionSig13() { doTest( "<code>test.dart Map<String, String> x({bool b = true, List<String> c}) </code>", "Map<String, String> <caret>x({bool b= true, List<String> c}){}"); } public void testFunctionSig14() { doTest( "<code>test.dart Map<String, String> x({bool b = true, Map<String, String> c}) </code>", "Map<String, String> <caret>x({bool b= true, Map<String, String> c}){}"); } public void testFunctionSig15() { doTest( "<code>test.dart Map<String, Map<String, String>> x({bool b = true, Map<String, Map<String, String>> c}) </code>", "Map<String, Map<String, String>> <caret>x({bool b= true, Map<String, Map<String, String>> c}){}"); } public void testFunctionSig16() { doTest( "<code>test.dart String x({bool b = true, dynamic Function(dynamic, dynamic, dynamic) Function}) </code>", "String <caret>x({bool b= true, Function(String, String, String)}){}"); } public void testFunctionSig2() { doTest("<code>test.dart dynamic foo([int x = 3]) </code>", "<caret>foo([int x = 3]) { print(x); }"); } public void testFunctionSig3() { doTest("<code>test.dart void foo([int x = 3]) </code>", "void <caret>foo([int x = 3]) { print(x); }"); } public void testFunctionSig4() { doTest( "<code>test.dart void foo(   int x, {   int y,   int z, }) </code>", "void <caret>foo(int x, {int y, int z}) { }"); } public void testFunctionSig5() { doTest("<code>test.dart InvalidType x(List<InvalidType> e) </code>", "E <caret>x(List<E> e) { }"); } public void testFunctionSig6() { doTest("<code>test.dart int calc(int Function() x) </code>", "int <caret>calc(int x()) => null;"); } public void testFunctionSig7() { doTest("<code>test.dart Map<String, int> foo(Map<int, String> p) </code>", "Map<String, int> <caret>foo(Map<int, String> p) => null;"); } public void testFunctionSig8() { doTest("<code>test.dart dynamic x() </code>", "<caret>x() => null;"); } public void testFunctionSig9() { doTest("<code>test.dart dynamic x({bool b = true}) </code>", "<caret>x({bool b: true}){};"); } public void testGetterSig() { doTest("<code>test.dart int get x Containing class: Z </code>", "class Z { int get <caret>x => 0; }"); } public void testImplementsSig1() { doTest("<code>test.dart abstract class Foo implements Bar </code>", "abstract class <caret>Foo implements Bar<T> { }\nclass Bar { }"); } public void testLibraryClassDoc() { doTest("<code>test.dart class A </code>", "library c.b.a;\nclass <caret>A {}"); } public void testMetaClassSig1() { doTest("<code>test.dart class A </code>", " @deprecated class <caret>A {}"); } public void testMethodMultilineDoc() { doTest(""" <code>test.dart dynamic foo() Containing class: A </code> doc1 doc2 doc3doc4<pre><code>code </code></pre>""", """ class A{ /** 1 */ /** * doc1 * doc2 * doc3 * * doc4 *\s * code */ // non-doc <caret>foo(){} }"""); } public void testMethodSig1() { doTest("<code>test.dart int y() Containing class: Z </code>", "class Z { int <caret>y() => 42; }"); } public void testMethodSingleLineDocs() { doTest(""" <code>test.dart dynamic foo() Containing class: A </code> doc1 doc2""", """ class A{ // not doc\s /// doc1 \s /* not doc */ /// doc2 \s // not doc\s <caret>foo(){} }"""); } public void testMixinSig1() { doTest("<code>test.dart class Foo2 extends Bar1 with Baz1, Baz2 </code>", "class Bar1 {} class Baz1{} class Baz2 {} class <caret>Foo2 = Bar1<E> with Baz1<K>, Baz2"); } public void testMixinSig2() { doTest("<code>test.dart class X extends Y with Z </code>", "class Y {} class Z {} class <caret>X extends Y with Z { }"); } public void testNamedConstructorSig() { doTest("<code>test.dart Z Z.z() Containing class: Z </code>", "class Z { <caret>Z.z(); }"); } public void testParamClassSig() { doTest("<code>test.dart class Foo<T> </code>", "class <caret>Foo<T>{ }"); } public void testParamClassSig2() { doTest("<code>test.dart class Foo<T, Z> </code>", "class <caret>Foo<T,Z>{ }"); } public void testParamClassSig3() { doTest("<code>test.dart class Foo implements Bar </code>", "class <caret>Foo implements Bar { } class Bar { }"); } public void testParamClassSig4() { doTest("<code>test.dart class Foo implements Bar, Baz </code>", "class <caret>Foo implements Bar, Baz { } class Bar { } class Baz { }"); } public void testParamClassSig5() { doTest("<code>test.dart class Foo<A, B> extends Bar<A, B> </code>", "class <caret>Foo<A,B> extends Bar<A,B> { } class Bar<A,B> { }"); } public void testParamClassSig6() { doTest("<code>List<String> ids Type: List<String> </code>", "class A { foo() { List<String> <caret>ids; }}"); } public void testParamClassSig7() { doTest( "<code>List<Map<String, int>> ids Type: List<Map<String, int>> </code>", "class A { foo() { List<Map<String, int>> <caret>ids; }}"); } public void testParamClassSig8() { doTest( "<code>List<List<Map<String, List<Object>>>> list Type: List<List<Map<String, List<Object>>>> </code>", "class A { foo() { List<List<Map<String, List<Object>>>> <caret>list; }}"); } public void testSetterSig() { doTest( "<code>test.dart void set x(int x) Containing class: Z </code>", "class Z { void set <caret>x(int x) { } }"); } public void testTopLevelVarDoc1() { doTest("<code>test.dart String x Type: String </code>\ndocs1\ndocs2", """ library a.b.c; /// docs1 /// docs2 @deprecated var <caret>x = 'foo';"""); } public void testTopLevelVarDoc2() { doTest("<code>test.dart int x Type: int </code>", "library a.b.c;\nint <caret>x = 3;\n"); } public void testTypedefSig() { doTest("<code>test.dart typedef F = int Function(int x) </code>", "typedef int <caret>F(int x);"); } private void doTest(String expectedDoc, String fileContents) { final int caretOffset = fileContents.indexOf("<caret>"); assertTrue(caretOffset != -1); final String realContents = fileContents.substring(0, caretOffset) + fileContents.substring(caretOffset + "<caret>".length()); final PsiFile psiFile = myFixture.configureByText("test.dart", realContents); myFixture.doHighlighting(); // warm up final HoverInformation hover = DartDocumentationProvider.getSingleHover(psiFile, caretOffset); assertNotNull(hover); final String doc = DartDocumentationProvider.generateDocServer(getProject(), hover); assertEquals(expectedDoc, doc); } }

Dart/testSrc/com/jetbrains/dart/analysisServer/DartServerDocUtilTest.java (346 lines of code) (raw):