-
Notifications
You must be signed in to change notification settings - Fork 1.9k
/
TypeCheckingExtensionsTest.groovy
494 lines (443 loc) · 16.1 KB
/
TypeCheckingExtensionsTest.groovy
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
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
/*
* Copyright 2003-2013 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package groovy.transform.stc
import org.codehaus.groovy.control.MultipleCompilationErrorsException
import org.codehaus.groovy.control.customizers.ASTTransformationCustomizer
import org.codehaus.groovy.transform.stc.GroovyTypeCheckingExtensionSupport
/**
* Units tests for type checking extensions.
*
* @author Cedric Champeau
*/
class TypeCheckingExtensionsTest extends StaticTypeCheckingTestCase {
private void setExtension(String name) {
def cz = config.compilationCustomizers.find {
it instanceof ASTTransformationCustomizer
}
if (name) {
cz.annotationParameters = [extensions: name]
} else {
cz.annotationParameters = [:]
}
}
void testSetupExtension() {
extension = 'groovy/transform/stc/SetupTestExtension.groovy'
assertScript '''
@ASTTest(phase=INSTRUCTION_SELECTION, value={
assert node.getNodeMetaData('setup')
})
class A {}
@ASTTest(phase=INSTRUCTION_SELECTION, value={
assert node.getNodeMetaData('setup') == null
})
class B {}
new A()
'''
}
void testNonExistentExtension() {
def extensionPath = 'groovy/transform/stc/NonExistentTestExtension.groovy'
extension = extensionPath
String errorMessage = "Static type checking extension '${extensionPath}' was not found on the classpath."
String message = shouldFail(MultipleCompilationErrorsException) {
assertScript '''
assert true
'''
}
assert message.contains(errorMessage)
}
void testFinishExtension() {
extension = 'groovy/transform/stc/FinishTestExtension.groovy'
assertScript '''
@ASTTest(phase=INSTRUCTION_SELECTION, value={
assert node.getNodeMetaData('finish')
})
class A {}
@ASTTest(phase=INSTRUCTION_SELECTION, value={
assert node.getNodeMetaData('finish') == null
})
class B {}
new A()
'''
}
void testNewMethodAndIsGenerated() {
extension = 'groovy/transform/stc/NewMethodAndIsGeneratedTestExtension.groovy'
shouldFailWithMessages '''
'foo'
''', 'Extension was executed properly'
}
void testUndefinedVariable() {
extension = 'groovy/transform/stc/UndefinedVariableTestExtension.groovy'
try {
assertScript '''
foo.toUpperCase() // normal type checker would fail here
'''
} catch (MissingPropertyException e) {
// normal
}
}
void testUndefinedVariableNoHandle() {
extension = 'groovy/transform/stc/UndefinedVariableNoHandleTestExtension.groovy'
shouldFailWithMessages '''
foo.toUpperCase() // normal type checker would fail here
''', 'The variable [foo] is undeclared'
}
void testMissingMethod() {
extension = null
shouldFailWithMessages '''
String msg = 'foo'
msg.TOUPPERCASE()
''', 'Cannot find matching method'
extension = 'groovy/transform/stc/MissingMethod1TestExtension.groovy'
try {
assertScript '''
String msg = 'foo'
msg.TOUPPERCASE()
'''
} catch (MissingMethodException e) {
// normal
}
}
void testMissingMethodWithLogic() {
extension = null
shouldFailWithMessages '''
String msg = 'foo'
msg.SIZE()
msg.CONCAT('bar')
''', 'Cannot find matching method java.lang.String#SIZE()', 'Cannot find matching method java.lang.String#CONCAT(java.lang.String)'
extension = 'groovy/transform/stc/MissingMethod2TestExtension.groovy'
try {
assertScript '''
String msg = 'foo'
msg.SIZE()
msg.CONCAT('bar')
'''
} catch (MissingMethodException e) {
// normal
}
}
void testShouldSilenceTypeChecker() {
extension = 'groovy/transform/stc/SilentTestExtension.groovy'
assertScript '''import org.codehaus.groovy.runtime.typehandling.GroovyCastException
try {
int x = 'foo'
} catch (GroovyCastException e) {
}
'''
}
void testShouldChangeErrorPrefix() {
extension = 'groovy/transform/stc/PrefixChangerTestExtension.groovy'
shouldFailWithMessages '''
int x = 'foo'
''', '[Custom] - Cannot assign value of type java.lang.String to variable of type int'
}
void testAfterMethodCallHook() {
extension = 'groovy/transform/stc/SprintfExtension.groovy'
shouldFailWithMessages '''
String count = 'foo'
sprintf("Count = %d", count)
''', 'Parameter types didn\'t match types expected from the format String',
'For placeholder 1 [%d] expected \'int\' but was \'java.lang.String\''
}
void testBeforeMethodCallHook() {
extension = 'groovy/transform/stc/UpperCaseMethodTest1Extension.groovy'
shouldFailWithMessages '''
String method() { 'foo' }
String BOO() { 'bar' }
method() // ok
BOO() // error
''', 'Calling a method which is all uppercase is not allowed'
}
void testBeforeMethodHook() {
extension = 'groovy/transform/stc/UpperCaseMethodTest2Extension.groovy'
shouldFailWithMessages '''
String method() { 'foo' } // ok
String BOO() { 'bar' } // error
''', 'Defining method which is all uppercase is not allowed'
}
void testAfterMethodHook() {
extension = 'groovy/transform/stc/UpperCaseMethodTest3Extension.groovy'
shouldFailWithMessages '''
String method() { 'foo' } // ok
String BOO() { 'bar' } // error
''', 'Defining method which is all uppercase is not allowed'
}
void testMethodSelection() {
// first step checks that without extension, type checking works properly
extension = null
assertScript '''
@ASTTest(phase=INSTRUCTION_SELECTION, value={
assert node.getNodeMetaData('selected') == null
})
def str = 'foo'.toUpperCase()
'''
// then we use a type checking extension, we add node metadata
extension = 'groovy/transform/stc/OnMethodSelectionTestExtension.groovy'
assertScript '''
@ASTTest(phase=INSTRUCTION_SELECTION, value={
assert node.getNodeMetaData('selected') == true
})
def str = 'foo'.toUpperCase()
'''
}
void testUnresolvedProperty() {
extension = null
shouldFailWithMessages '''
'str'.FOO
''', 'No such property: FOO for class: java.lang.String'
extension = 'groovy/transform/stc/UnresolvedPropertyTestExtension.groovy'
assertScript '''
try {
'str'.FOO
} catch (MissingPropertyException ex) {
}
'''
}
void testUnresolvedAttribute() {
extension = null
shouldFailWithMessages '''
'str'.@FOO
''', 'No such property: FOO for class: java.lang.String'
extension = 'groovy/transform/stc/UnresolvedAttributeTestExtension.groovy'
assertScript '''
try {
'str'.@FOO
} catch (MissingFieldException ex) {
}
'''
}
void testScopeEnterScopeExit() {
extension = 'groovy/transform/stc/ScopeEnterExitTestExtension.groovy'
shouldFailWithMessages '''
class Support {
void foo(Closure c) { c() }
}
new Support().foo {
'a'.toUpperCase()
}
''', 'Scope enter and exit behave correctly' // we're using shouldFail just to verify that the extension is ran
}
void testMatchingArguments() {
extension = 'groovy/transform/stc/ArgumentsTestingTestExtension.groovy'
shouldFailWithMessages '''
def zero() {}
def two(String a, Integer b) {}
def three(String a, int b, Date c) {}
'foo'.concat('bar')
zero()
two('foo', 1)
three('foo', 2, new Date())
three('foo', (Integer)2, new Date())
''', 'Method [zero] with matching arguments found: 0',
'Method [concat] with matching arguments found: 1',
'Method [two] with matching arguments found: 2',
'Method [three] with matching arguments found: 3',
'Method [three] with matching arguments found: 3'
}
void testFirstArgsMatches() {
extension = 'groovy/transform/stc/FirstArgumentsTestingTestExtension.groovy'
shouldFailWithMessages '''
def two(String a, Integer b) {}
def three(String a, int b, Date c) {}
two('foo', 1)
three('foo', 2, new Date())
three('foo', (Integer)2, new Date())
''', 'Method [two] with matching arguments found: 2',
'Method [three] with matching arguments found: 3',
'Method [three] with matching arguments found: 3'
}
void testNthArgMatches() {
extension = 'groovy/transform/stc/NthArgumentTestingTestExtension.groovy'
shouldFailWithMessages '''
def two(String a, Integer b) {}
def three(String a, int b, Date c) {}
two('foo', 1)
three('foo', 2, new Date())
three('foo', (Integer)2, new Date())
''', 'Method [two] with matching argument found: [0, class java.lang.String]',
'Method [two] with matching argument found: [1, class java.lang.Integer]',
'Method [three] with matching argument found: [0, class java.lang.String]',
'Method [three] with matching argument found: [1, class java.lang.Integer]',
'Method [three] with matching argument found: [2, class java.util.Date]',
'Method [three] with matching argument found: [0, class java.lang.String]',
'Method [three] with matching argument found: [1, class java.lang.Integer]',
'Method [three] with matching argument found: [2, class java.util.Date]'
}
void testIncompatibleAssignment() {
extension = null
shouldFailWithMessages '''
int x = 'foo'
''', 'Cannot assign value of type java.lang.String to variable of type int'
extension = 'groovy/transform/stc/IncompatibleAssignmentTestExtension.groovy'
assertScript '''
try {
int x = 'foo'
} catch (e) {}
'''
}
void testBinaryOperatorNotFound() {
extension = null
shouldFailWithMessages '''
int x = 1
Date y = new Date()
x+y
''', 'Cannot find matching method int#plus(java.util.Date)'
extension = 'groovy/transform/stc/BinaryOperatorTestExtension.groovy'
assertScript '''
try {
int x = 1
Date y = new Date()
x+y
} catch (e) {}
'''
}
void testBinaryOperatorNotFound2() {
extension = null
shouldFailWithMessages '''
int x = 1
Date y = new Date()
x << y
''', 'Cannot find matching method int#leftShift(java.util.Date)'
extension = 'groovy/transform/stc/BinaryOperatorTestExtension.groovy'
assertScript '''
try {
int x = 1
Date y = new Date()
x+y
} catch (e) {}
'''
}
void testDelegatesTo() {
extension = null
shouldFailWithMessages '''
class Item { void pick(){} }
void build(Closure arg) {
arg.delegate = new Item()
arg()
}
build {
pick()
}
''', 'Cannot find matching method'
extension = 'groovy/transform/stc/DelegatesToTestExtension.groovy'
assertScript '''
class Item { void pick(){} }
void build(Closure arg) {
arg.delegate = new Item()
arg()
}
build {
pick()
}
'''
}
void testIsAnnotatedBy() {
extension = null
assertScript '''
@groovy.transform.stc.MyType(String)
int foo() { 1 }
'''
extension = 'groovy/transform/stc/AnnotatedByTestExtension.groovy'
assertScript '''
@groovy.transform.stc.MyType(String)
@ASTTest(phase=INSTRUCTION_SELECTION,value={
assert node.getNodeMetaData(INFERRED_RETURN_TYPE) == STRING_TYPE
})
int foo() { 1 }
'''
}
void testBeforeAfterClass() {
extension = 'groovy/transform/stc/BeforeAfterClassTestExtension.groovy'
assertScript '''
@ASTTest(phase=INSTRUCTION_SELECTION, value={
assert node.getNodeMetaData(INFERRED_TYPE)?.name == 'A'
assert node.getNodeMetaData('after') == true
})
class A {}
@ASTTest(phase=INSTRUCTION_SELECTION, value={
assert node.getNodeMetaData(INFERRED_TYPE) == null // disabled through beforeVisitClass
assert node.getNodeMetaData('after') == true
})
class B {
void hasTypeCheckingError() { int x = 'foo' }
}
new A()
'''
}
void testLookupClassNodeNotAvailableOnExtensionsClasspath() {
extension = 'groovy/transform/stc/RobotMove.groovy'
assertScript '''
class Robot {
void move(String dist) { println "Moved $dist" }
}
this.binding.setVariable('robot', new Robot())
void operate() {
robot.move "left"
}
operate()
'''
}
void testShouldNotThrowNPE_Groovy6047() {
extension = 'groovy/transform/stc/Groovy6047Extension.groovy'
try {
assertScript '''
def b = new Vector()
b.elems()
'''
} catch (MissingMethodException e) {
// it's ok
}
}
void testAmbiguousMethodCall() {
// fail with error from type checker
extension = null
shouldFailWithMessages '''
int foo(Integer x) { 1 }
int foo(String s) { 2 }
int foo(Date d) { 3 }
assert foo(null) == 2
''', 'Reference to method is ambiguous'
// fail with error from runtime
extension = 'groovy/transform/stc/AmbiguousMethods.groovy'
shouldFail { assertScript '''
int foo(Integer x) { 1 }
int foo(String s) { 2 }
int foo(Date d) { 3 }
assert foo(null) == 2
'''}
}
void testIncompatibleReturnType() {
extension = null
shouldFailWithMessages '''
Date foo() { '1' }
true
''', 'Cannot return value of type'
extension = 'groovy/transform/stc/IncompatibleReturnTypeTestExtension.groovy'
assertScript '''
Date foo() { '1' }
true
'''
}
void testPrecompiledExtension() {
extension = null
assertScript '''
println 'Everything is ok'
'''
extension = 'groovy.transform.stc.PrecompiledExtension'
shouldFailWithMessages '''
println 'Everything is ok'
''', 'Error thrown from extension'
}
}