aboutsummaryrefslogtreecommitdiff
path: root/plugins/base/src/test/kotlin/model/FunctionsTest.kt
blob: 9554ad02c0f8121acf558a2ea72e21d65297f708 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
package model

import org.jetbrains.dokka.model.Function
import org.jetbrains.dokka.model.Package
import org.junit.Test
import utils.*

class FunctionTest : AbstractModelTest("/src/main/kotlin/function/Test.kt", "function") {

    @Test
    fun function() {
        inlineModelTest(
            """
            |/**
            | * Function fn
            | */
            |fun fn() {}
        """
        ) {
            with((this / "function" / "fn").cast<Function>()) {
                name equals "fn"
                type.constructorFqName equals "kotlin.Unit"
                this.children.assertCount(0, "Function children: ")
            }
        }
    }

    @Test
    fun overloads() {
        inlineModelTest(
            """
            |/**
            | * Function fn
            | */
            |fun fn() {}
            | /**
            | * Function fn(Int)
            | */
            |fun fn(i: Int) {}
        """
        ) {
            with((this / "function").cast<Package>()) {
                val fn1 = functions.find {
                    it.name == "fn" && it.parameters.isNullOrEmpty()
                }.assertNotNull("fn()")
                val fn2 = functions.find {
                    it.name == "fn" && it.parameters.isNotEmpty()
                }.assertNotNull("fn(Int)")

                with(fn1) {
                    name equals "fn"
                    parameters.assertCount(0)
                }

                with(fn2) {
                    name equals "fn"
                    parameters.assertCount(1)
                    parameters.first().type.constructorFqName equals "kotlin.Int"
                }
            }
        }
    }

    @Test
    fun functionWithReceiver() {
        inlineModelTest(
            """
            |/**
            | * Function with receiver
            | */
            |fun String.fn() {}
            |
            |/**
            | * Function with receiver
            | */
            |fun String.fn(x: Int) {}
        """
        ) {
            with((this / "function").cast<Package>()) {
                val fn1 = functions.find {
                    it.name == "fn" && it.parameters.isNullOrEmpty()
                }.assertNotNull("fn()")
                val fn2 = functions.find {
                    it.name == "fn" && it.parameters.count() == 1
                }.assertNotNull("fn(Int)")

                with(fn1) {
                    name equals "fn"
                    parameters counts 0
                    receiver.assertNotNull("fn() receiver")
                }

                with(fn2) {
                    name equals "fn"
                    parameters counts 1
                    receiver.assertNotNull("fn(Int) receiver")
                    parameters.first().type.constructorFqName equals "kotlin.Int"
                }
            }
        }
    }

    @Test
    fun functionWithParams() {
        inlineModelTest(
            """
                |/**
                | * Multiline
                | *
                | * Function
                | * Documentation
                | */
                |fun function(/** parameter */ x: Int) {
                |}
        """
        ) {
            with((this / "function" / "function").cast<Function>()) {
                comments() equals "Multiline\nFunction Documentation"

                name equals "function"
                parameters counts 1
                parameters.firstOrNull().assertNotNull("Parameter: ").also {
                    it.name equals "x"
                    it.type.constructorFqName equals "kotlin.Int"
                    it.comments() equals "parameter"
                }

                type.assertNotNull("Return type: ").constructorFqName equals "kotlin.Unit"
            }
        }
    }

// TODO add modifiers - start

    @Test
    fun functionWithNotDocumentedAnnotation() {
        inlineModelTest(
            """
                |@Suppress("FOO") fun f() {}
        """
        ) {
            // TODO add annotations

            with((this / "function" / "f").cast<Function>()) {
                assert(false) { "No annotation data" }
            }
        }
    }

//    @Test fun functionWithNotDocumentedAnnotation() {
//        verifyPackageMember("testdata/functions/functionWithNotDocumentedAnnotation.kt", defaultModelConfig) { func ->
//            assertEquals(0, func.annotations.count())
//        }
//    }

    @Test
    fun inlineFunction() {
        inlineModelTest(
            """
                |inline fun f(a: () -> String) {}
        """
        ) {
            // TODO add data about inline

            with((this / "function" / "f").cast<Function>()) {
                assert(false) { "No inline data" }
            }
        }
    }

//    @Test fun inlineFunction() {
//        verifyPackageMember("testdata/functions/inlineFunction.kt", defaultModelConfig) { func ->
//            val modifiers = func.details(NodeKind.Modifier).map { it.name }
//            assertTrue("inline" in modifiers)
//        }
//    }

    @Test
    fun suspendFunction() {
        inlineModelTest(
            """
                |suspend fun f() {}
        """
        ) {
            // TODO add data about suspend

            with((this / "function" / "f").cast<Function>()) {
                assert(false) { "No suspend data" }
            }
        }
    }

//    @Test fun suspendFunction() {
//        verifyPackageMember("testdata/functions/suspendFunction.kt") { func ->
//            val modifiers = func.details(NodeKind.Modifier).map { it.name }
//            assertTrue("suspend" in modifiers)
//        }
//    }

//    @Test fun suspendInlineFunctionOrder() {
//        verifyPackageMember("testdata/functions/suspendInlineFunction.kt") { func ->
//            val modifiers = func.details(NodeKind.Modifier).map { it.name }.filter {
//                it == "suspend" || it == "inline"
//            }
//
//            assertEquals(listOf("suspend", "inline"), modifiers)
//        }
//    }
//
//    @Test fun inlineSuspendFunctionOrderChanged() {
//        verifyPackageMember("testdata/functions/inlineSuspendFunction.kt") { func ->
//            val modifiers = func.details(NodeKind.Modifier).map { it.name }.filter {
//                it == "suspend" || it == "inline"
//            }
//
//            assertEquals(listOf("suspend", "inline"), modifiers)
//        }
//    }
//
//    @Test fun functionWithAnnotatedParam() {
//        checkSourceExistsAndVerifyModel("testdata/functions/functionWithAnnotatedParam.kt", defaultModelConfig) { model ->
//            with(model.members.single().members.single { it.name == "function" }) {
//                with(details(NodeKind.Parameter).first()) {
//                    assertEquals(1, annotations.count())
//                    with(annotations[0]) {
//                        assertEquals("Fancy", name)
//                        assertEquals(Content.Empty, content)
//                        assertEquals(NodeKind.Annotation, kind)
//                    }
//                }
//            }
//        }
//    }
//
//    @Test fun functionWithNoinlineParam() {
//        verifyPackageMember("testdata/functions/functionWithNoinlineParam.kt", defaultModelConfig) { func ->
//            with(func.details(NodeKind.Parameter).first()) {
//                val modifiers = details(NodeKind.Modifier).map { it.name }
//                assertTrue("noinline" in modifiers)
//            }
//        }
//    }
//
//    @Test fun annotatedFunctionWithAnnotationParameters() {
//        checkSourceExistsAndVerifyModel(
//            "testdata/functions/annotatedFunctionWithAnnotationParameters.kt",
//            defaultModelConfig
//        ) { model ->
//            with(model.members.single().members.single { it.name == "f" }) {
//                assertEquals(1, annotations.count())
//                with(annotations[0]) {
//                    assertEquals("Fancy", name)
//                    assertEquals(Content.Empty, content)
//                    assertEquals(NodeKind.Annotation, kind)
//                    assertEquals(1, details.count())
//                    with(details[0]) {
//                        assertEquals(NodeKind.Parameter, kind)
//                        assertEquals(1, details.count())
//                        with(details[0]) {
//                            assertEquals(NodeKind.Value, kind)
//                            assertEquals("1", name)
//                        }
//                    }
//                }
//            }
//        }
//    }

// TODO add modifiers - end

//    @Test
//    fun functionWithDefaultParameter() {
//        inlineModelTest(
//            """
//                |/src/main/kotlin/function/Test.kt
//                |package function
//                |fun f(x: String = "") {}
//        """
//        ) {
//            // TODO add default value data
//
//            with(this / "function" / "f" cast Function::class) {
//                parameters.forEach { p ->
//                    p.name equals "x"
//                    p.type.constructorFqName.assertNotNull("Parameter type: ") equals "kotlin.String"
//                    assert(false) { "Add default value data" }
//                }
//            }
//        }
//    }

//    @Test fun functionWithDefaultParameter() {
//        checkSourceExistsAndVerifyModel("testdata/functions/functionWithDefaultParameter.kt", defaultModelConfig) { model ->
//            with(model.members.single().members.single()) {
//                with(details.elementAt(3)) {
//                    val value = details(NodeKind.Value)
//                    assertEquals(1, value.count())
//                    with(value[0]) {
//                        assertEquals("\"\"", name)
//                    }
//                }
//            }
//        }
//    }
//
//    @Test fun sinceKotlin() {
//        checkSourceExistsAndVerifyModel("testdata/functions/sinceKotlin.kt", defaultModelConfig) { model ->
//            with(model.members.single().members.single()) {
//                assertEquals("1.1", sinceKotlin)
//            }
//        }
//    }
//}

}