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
|
package superFields
import org.jetbrains.dokka.base.testApi.testRunner.BaseAbstractTest
import org.jetbrains.dokka.links.DRI
import org.jetbrains.dokka.model.InheritedMember
import org.junit.jupiter.api.Test
import kotlin.test.assertEquals
import kotlin.test.assertNotNull
import kotlin.test.assertNull
class DescriptorSuperPropertiesTest : BaseAbstractTest() {
private val commonTestConfiguration = dokkaConfiguration {
sourceSets {
sourceSet {
sourceRoots = listOf("src/")
analysisPlatform = "jvm"
name = "jvm"
}
}
}
@Test
fun `kotlin inheriting java should append only getter`() {
testInline(
"""
|/src/test/A.java
|package test;
|public class A {
| private int a = 1;
| public int getA() { return a; }
|}
|
|/src/test/B.kt
|package test
|class B : A {}
""".trimIndent(),
commonTestConfiguration
) {
this.documentablesTransformationStage = { module ->
val kotlinProperties = module.packages.single().classlikes.single { it.name == "B" }.properties
val property = kotlinProperties.single { it.name == "a" }
val propertyInheritedFrom = property.extra[InheritedMember]?.inheritedFrom?.values?.single()
assertEquals(DRI(packageName = "test", classNames = "A"), propertyInheritedFrom)
assertNull(property.setter)
assertNotNull(property.getter)
val getterInheritedFrom = property.getter?.extra?.get(InheritedMember)?.inheritedFrom?.values?.single()
assertEquals(DRI(packageName = "test", classNames = "A"), getterInheritedFrom)
}
}
}
@Test
fun `kotlin inheriting java should append getter and setter`() {
testInline(
"""
|/src/test/A.java
|package test;
|public class A {
| private int a = 1;
| public int getA() { return a; }
| public void setA(int a) { this.a = a; }
|}
|
|/src/test/B.kt
|package test
|class B : A {}
""".trimIndent(),
commonTestConfiguration
) {
documentablesMergingStage = { module ->
val kotlinProperties = module.packages.single().classlikes.single { it.name == "B" }.properties
val property = kotlinProperties.single { it.name == "a" }
property.extra[InheritedMember]?.inheritedFrom?.values?.single()?.run {
assertEquals(
DRI(packageName = "test", classNames = "A"),
this
)
}
val getter = property.getter
assertNotNull(getter)
assertEquals("getA", getter.name)
val getterInheritedFrom = getter.extra[InheritedMember]?.inheritedFrom?.values?.single()
assertEquals(DRI(packageName = "test", classNames = "A"), getterInheritedFrom)
val setter = property.setter
assertNotNull(setter)
assertEquals("setA", setter.name)
val setterInheritedFrom = setter.extra[InheritedMember]?.inheritedFrom?.values?.single()
assertEquals(DRI(packageName = "test", classNames = "A"), setterInheritedFrom)
}
}
}
@Test
fun `should have special getter and setter names for boolean property inherited from java`() {
testInline(
"""
|/src/test/A.java
|package test;
|public class A {
| private boolean bool = true;
| public boolean isBool() { return bool; }
| public void setBool(boolean bool) { this.bool = bool; }
|}
|
|/src/test/B.kt
|package test
|class B : A {}
""".trimIndent(),
commonTestConfiguration
) {
documentablesMergingStage = { module ->
val kotlinProperties = module.packages.single().classlikes.single { it.name == "B" }.properties
val boolProperty = kotlinProperties.single { it.name == "bool" }
val getter = boolProperty.getter
assertNotNull(getter)
assertEquals("isBool", getter.name)
val setter = boolProperty.setter
assertNotNull(setter)
assertEquals("setBool", setter.name)
}
}
}
@Test
fun `kotlin inheriting java should not append anything since field is public`() {
testInline(
"""
|/src/test/A.java
|package test;
|public class A {
| public int a = 1;
| public int getA() { return a; }
| public void setA(int a) { this.a = a; }
|}
|
|/src/test/B.kt
|package test
|class B : A {}
""".trimIndent(),
commonTestConfiguration
) {
documentablesMergingStage = { module ->
val kotlinProperties = module.packages.single().classlikes.single { it.name == "B" }.properties
val property = kotlinProperties.single { it.name == "a" }
assertNull(property.getter)
assertNull(property.setter)
val inheritedFrom = property.extra[InheritedMember]?.inheritedFrom?.values?.single()
assertEquals(DRI(packageName = "test", classNames = "A"), inheritedFrom)
}
}
}
@Test
fun `should preserve regular functions that look like accessors, but are not accessors`() {
testInline(
"""
|/src/test/A.kt
|package test
|class A {
| val v = 0
| fun setV() { println(10) } // no arg
| fun getV(): String { return "s" } // wrong return type
|}
""".trimIndent(),
commonTestConfiguration
) {
documentablesMergingStage = { module ->
val testClass = module.packages.single().classlikes.single { it.name == "A" }
val setterLookalike = testClass.functions.firstOrNull { it.name == "setV" }
assertNotNull(setterLookalike) {
"Expected regular function not found, wrongly categorized as setter?"
}
val getterLookalike = testClass.functions.firstOrNull { it.name == "getV" }
assertNotNull(getterLookalike) {
"Expected regular function not found, wrongly categorized as getter?"
}
}
}
}
}
|
