-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
ProcedureIT.java
696 lines (598 loc) · 20.7 KB
/
ProcedureIT.java
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
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
/*
* Copyright (c) 2002-2016 "Neo Technology,"
* Network Engine for Objects in Lund AB [http://neotechnology.com]
*
* This file is part of Neo4j.
*
* Neo4j is free software: you can redistribute it and/or modify
* it under the terms of the GNU Affero General Public License as
* published by the Free Software Foundation, either version 3 of the
* License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Affero General Public License for more details.
*
* You should have received a copy of the GNU Affero General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.procedure;
import java.io.IOException;
import java.util.Arrays;
import java.util.List;
import java.util.Map;
import java.util.stream.Stream;
import org.junit.After;
import org.junit.Before;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import org.junit.rules.TemporaryFolder;
import org.neo4j.graphdb.GraphDatabaseService;
import org.neo4j.graphdb.Label;
import org.neo4j.graphdb.Node;
import org.neo4j.graphdb.QueryExecutionException;
import org.neo4j.graphdb.Result;
import org.neo4j.graphdb.Transaction;
import org.neo4j.graphdb.factory.GraphDatabaseSettings;
import org.neo4j.kernel.impl.proc.JarBuilder;
import org.neo4j.kernel.impl.proc.Procedures;
import org.neo4j.logging.AssertableLogProvider;
import org.neo4j.logging.Log;
import org.neo4j.test.TestGraphDatabaseFactory;
import static java.lang.System.lineSeparator;
import static java.util.Spliterator.IMMUTABLE;
import static java.util.Spliterator.ORDERED;
import static java.util.Spliterators.spliteratorUnknownSize;
import static java.util.stream.StreamSupport.stream;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.hamcrest.core.IsEqual.equalTo;
import static org.junit.Assert.assertEquals;
import static org.junit.Assert.assertFalse;
import static org.neo4j.graphdb.Label.label;
import static org.neo4j.helpers.collection.IteratorUtil.single;
import static org.neo4j.helpers.collection.MapUtil.map;
import static org.neo4j.logging.AssertableLogProvider.inLog;
public class ProcedureIT
{
@Rule
public TemporaryFolder plugins = new TemporaryFolder();
@Rule
public ExpectedException exception = ExpectedException.none();
private GraphDatabaseService db;
@Test
public void shouldCallProcedureWithParameterMap() throws Throwable
{
// Given
try ( Transaction ignore = db.beginTx() )
{
// When
Result res = db.execute( "CALL org.neo4j.procedure.simpleArgument", map( "name", 42L ) );
// Then
assertThat( res.next(), equalTo( map( "someVal", 42L ) ) );
assertFalse( res.hasNext() );
}
}
@Test
public void shouldGiveNiceErrorMessageOnWrongStaticType() throws Throwable
{
//Expect
exception.expect( QueryExecutionException.class );
exception.expectMessage(
"Parameter `name` for procedure `org.neo4j.procedure.simpleArgument`" + lineSeparator() +
"expects value of type String but got value of type Integer." + lineSeparator() + lineSeparator() +
"Usage: CALL org.neo4j.procedure.simpleArgument(<name>)" + lineSeparator() +
"Parameters:" + lineSeparator() +
" name (type Integer)" );
// When
try ( Transaction ignore = db.beginTx() )
{
db.execute( "CALL org.neo4j.procedure.simpleArgument('42')");
}
}
@Test
public void shouldCallDelegatingProcedure() throws Throwable
{
// Given
try ( Transaction ignore = db.beginTx() )
{
// When
Result res = db.execute( "CALL org.neo4j.procedure.delegatingProcedure", map( "name", 43L ) );
// Then
assertThat( res.next(), equalTo( map( "someVal", 43L ) ) );
assertFalse( res.hasNext() );
}
}
@Test
public void shouldCallRecursiveProcedure() throws Throwable
{
// Given
try ( Transaction ignore = db.beginTx() )
{
// When
Result res = db.execute( "CALL org.neo4j.procedure.recursiveSum", map( "order", 10L ) );
// Then
assertThat( res.next(), equalTo( map( "someVal", 55L ) ) );
assertFalse( res.hasNext() );
}
}
@Test
public void shouldCallProcedureWithGenericArgument() throws Throwable
{
// Given
try ( Transaction ignore = db.beginTx() )
{
// When
Result res = db.execute(
"CALL org.neo4j.procedure.genericArguments([ ['graphs'], ['are'], ['everywhere']], " +
"[ [[1, 2, 3]], [[4, 5]]] )" );
// Then
assertThat( res.next(), equalTo( map( "someVal", 5L ) ) );
assertFalse( res.hasNext() );
}
}
@Test
public void shouldCallProcedureWithMapArgument() throws Throwable
{
// Given
try ( Transaction ignore = db.beginTx() )
{
// When
Result res = db.execute(
"CALL org.neo4j.procedure.mapArgument({foo: 42, bar: 'hello'})" );
// Then
assertThat( res.next(), equalTo( map( "someVal", 2L ) ) );
assertFalse( res.hasNext() );
}
}
@Test
public void shouldCallProcedureWithNodeReturn() throws Throwable
{
// Given
try ( Transaction ignore = db.beginTx() )
{
long nodeId = db.createNode().getId();
// When
Result res = db.execute( "CALL org.neo4j.procedure.node({id})", map( "id", nodeId ) );
// Then
Node node = (Node) res.next().get( "node" );
assertThat(node.getId(), equalTo( nodeId ));
assertFalse( res.hasNext() );
}
}
@Test
public void shouldGiveHelpfulErrorOnMissingProcedure() throws Throwable
{
// Expect
exception.expect( QueryExecutionException.class );
exception.expectMessage( "There is no procedure with the name `someProcedureThatDoesNotExist` " +
"registered for this database instance. Please ensure you've spelled the " +
"procedure name correctly and that the procedure is properly deployed." );
// When
db.execute( "CALL someProcedureThatDoesNotExist" );
}
@Test
public void shouldGiveHelpfulErrorOnExceptionMidStream() throws Throwable
{
// Given
// run in tx to avoid having to wait for tx rollback on shutdown
try( Transaction ignore = db.beginTx() )
{
Result result = db.execute( "CALL org.neo4j.procedure.throwsExceptionInStream" );
// Expect
exception.expect( QueryExecutionException.class );
exception.expectMessage(
"Failed to call procedure `org.neo4j.procedure.throwsExceptionInStream() :: (someVal :: INTEGER?)`: " +
"Kaboom" );
// When
result.next();
}
}
@Test
public void shouldCallProcedureWithAccessToDB() throws Throwable
{
// When
try ( Transaction ignore = db.beginTx() )
{
db.createNode( label( "Person" ) ).setProperty( "name", "Buddy Holly" );
}
// Then
try ( Transaction ignore = db.beginTx() )
{
Result res = db.execute(
"CALL org.neo4j.procedure.listCoolPeopleInDatabase" );
assertFalse( res.hasNext() );
}
}
@Test
public void shouldLogLikeThereIsNoTomorrow() throws Throwable
{
// Given
AssertableLogProvider logProvider = new AssertableLogProvider();
db.shutdown();
db = new TestGraphDatabaseFactory()
.setInternalLogProvider( logProvider )
.setUserLogProvider( logProvider )
.newImpermanentDatabaseBuilder()
.setConfig( GraphDatabaseSettings.plugin_dir, plugins.getRoot().getAbsolutePath() )
.newGraphDatabase();
// When
try ( Transaction ignore = db.beginTx() )
{
Result res = db.execute( "CALL org.neo4j.procedure.logAround()" );
while ( res.hasNext() ) res.next();
}
// Then
AssertableLogProvider.LogMatcherBuilder match = inLog( Procedures.class );
logProvider.assertAtLeastOnce(
match.debug( "1" ),
match.info( "2" ),
match.warn( "3" ),
match.error( "4" )
);
}
@Test
public void shouldDenyReadOnlyProcedureToPerformWrites() throws Throwable
{
// Expect
exception.expect( QueryExecutionException.class );
exception.expectMessage( "Write operations are not allowed" );
// When
try ( Transaction ignore = db.beginTx() )
{
db.execute( "CALL org.neo4j.procedure.readOnlyTryingToWrite()" ).next();
}
}
@Test
public void shouldAllowWriteProcedureToPerformWrites() throws Throwable
{
// When
try ( Transaction tx = db.beginTx() )
{
db.execute( "CALL org.neo4j.procedure.writingProcedure()" );
tx.success();
}
// Then
try( Transaction tx = db.beginTx() )
{
assertEquals(1, db.getAllNodes().stream().count());
tx.success();
}
}
@Test
public void shouldNotBeAbleToCallWriteProcedureThroughReadProcedure() throws Throwable
{
// Expect
exception.expect( QueryExecutionException.class );
exception.expectMessage( "Write operations are not allowed" );
// When
try ( Transaction ignore = db.beginTx() )
{
db.execute( "CALL org.neo4j.procedure.readOnlyCallingWriteProcedure" ).next();
}
}
@Test
public void shouldBeAbleToCallWriteProcedureThroughWriteProcedure() throws Throwable
{
// When
try ( Transaction tx = db.beginTx() )
{
db.execute( "CALL org.neo4j.procedure.writeProcedureCallingWriteProcedure()" );
tx.success();
}
// Then
try( Transaction tx = db.beginTx() )
{
assertEquals(1, db.getAllNodes().stream().count());
tx.success();
}
}
@Test
public void shouldCoerceLongToDoubleAtRuntimeWhenCallingProcedure() throws Throwable {
// Given
try (Transaction ignore = db.beginTx()) {
// When
Result res = db.execute("CALL org.neo4j.procedure.squareDouble", map("value", 4L));
// Then
assertThat(res.next(), equalTo(map("result", 16.0d)));
assertFalse(res.hasNext());
}
}
@Test
public void shouldCoerceListOfNumbersToDoublesAtRuntimeWhenCallingProcedure() throws Throwable
{
// Given
try ( Transaction ignore = db.beginTx() )
{
// When
Result res = db.execute( "CALL org.neo4j.procedure.avgNumberList({param})", map( "param", Arrays.<Number>asList(1L, 2L, 3L) ) );
// Then
assertThat( res.next(), equalTo( map( "result", 2.0d ) ) );
assertFalse( res.hasNext() );
}
}
@Test
public void shouldCoerceListOfMixedNumbers() throws Throwable
{
// Given
try ( Transaction ignore = db.beginTx() )
{
// When
Result res = db.execute( "CALL org.neo4j.procedure.avgDoubleList([{long}, {double}])", map( "long", 1L, "double", 2.0d ) );
// Then
assertThat( res.next(), equalTo( map( "result", 1.5d ) ) );
assertFalse( res.hasNext() );
}
}
@Test
public void shouldCoerceDoubleToLongAtRuntimeWhenCallingProcedure() throws Throwable
{
// Given
try ( Transaction ignore = db.beginTx() )
{
// When
Result res = db.execute( "CALL org.neo4j.procedure.squareLong", map( "value", 4L ) );
// Then
assertThat( res.next(), equalTo( map( "someVal", 16L ) ) );
assertFalse( res.hasNext() );
}
}
@Test
public void shouldBeAbleToCallVoidProcedure() throws Throwable
{
try ( Transaction ignore = db.beginTx() )
{
db.execute( "CALL org.neo4j.procedure.sideEffect('PONTUS')" );
assertThat( db.execute( "MATCH (n:PONTUS) RETURN count(n) AS c" ).next().get( "c" ), equalTo( 1L ) );
}
}
@Test
public void shouldBeAbleToCallDelegatingVoidProcedure() throws Throwable
{
try ( Transaction ignore = db.beginTx() )
{
db.execute( "CALL org.neo4j.procedure.delegatingSideEffect('SUTNOP')" );
assertThat( db.execute( "MATCH (n:SUTNOP) RETURN count(n) AS c" ).next().get( "c" ), equalTo( 1L ) );
}
}
@Test
public void shouldBeAbleToPerformWritesOnNodesReturnedFromReadOnlyProcedure() throws Throwable
{
// When
try (Transaction tx = db.beginTx())
{
long nodeId = db.createNode().getId();
Node node = single( db.execute( "CALL org.neo4j.procedure.node", map( "id", nodeId ) ).columnAs( "node" ) );
node.setProperty( "name", "Stefan" );
tx.success();
};
}
@Test
public void shouldFailToShutdown()
{
// Expect
exception.expect( QueryExecutionException.class );
exception.expectMessage( "Failed to invoke procedure `org.neo4j.procedure.shutdown`: `java.lang.UnsupportedOperationException` was thrown when invoking the procedure." );
try ( Transaction ignore = db.beginTx() )
{
db.execute( "CALL org.neo4j.procedure.shutdown()" );
}
}
@Test
public void shouldBeAbleToWriteAfterCallingReadOnlyProcedure()
{
try ( Transaction ignore = db.beginTx() )
{
db.execute( "CALL org.neo4j.procedure.simpleArgument(12)" );
db.createNode();
}
}
@Before
public void setUp() throws IOException
{
new JarBuilder().createJarFor( plugins.newFile( "myProcedures.jar" ), ClassWithProcedures.class );
db = new TestGraphDatabaseFactory()
.newImpermanentDatabaseBuilder()
.setConfig( GraphDatabaseSettings.plugin_dir, plugins.getRoot().getAbsolutePath() )
.newGraphDatabase();
}
@After
public void tearDown()
{
if ( this.db != null )
{
this.db.shutdown();
}
}
public static class Output
{
public long someVal = 1337;
public Output()
{
}
public Output( long someVal )
{
this.someVal = someVal;
}
}
public static class DoubleOutput
{
public double result = 0.0d;
public DoubleOutput()
{
}
public DoubleOutput( double result)
{
this.result = result;
}
}
public static class NodeOutput
{
public Node node;
public NodeOutput()
{
}
void setNode( Node node )
{
this.node = node;
}
}
public static class MyOutputRecord
{
public String name;
public MyOutputRecord( String name )
{
this.name = name;
}
}
public static class ClassWithProcedures
{
@Context
public GraphDatabaseService db;
@Context
public Log log;
@Procedure
public Stream<Output> integrationTestMe()
{
return Stream.of( new Output() );
}
@Procedure
public Stream<Output> simpleArgument( @Name( "name" ) long someValue )
{
return Stream.of( new Output( someValue ) );
}
@Procedure
public Stream<Output> delegatingProcedure( @Name( "name" ) long someValue )
{
return db.execute( "CALL org.neo4j.procedure.simpleArgument", map( "name", someValue ) )
.stream()
.map( (row) -> new Output( (Long) row.get( "someVal" ) ) );
}
@Procedure
public Stream<Output> recursiveSum( @Name( "order" ) long order )
{
if ( order == 0L )
{
return Stream.of( new Output( 0L ) );
}
else
{
Long prev =
(Long) db.execute( "CALL org.neo4j.procedure.recursiveSum", map( "order", order - 1 ) )
.next().get( "someVal" );
return Stream.of( new Output( order + prev ) );
}
}
@Procedure
public Stream<Output> genericArguments( @Name( "stringList" ) List<List<String>> stringList,
@Name( "longList" ) List<List<List<Long>>> longList )
{
return Stream.of( new Output( stringList.size() + longList.size() ) );
}
@Procedure
public Stream<Output> mapArgument( @Name( "map" )Map<String,Object> map )
{
return Stream.of( new Output( map.size() ) );
}
@Procedure
public Stream<NodeOutput> node( @Name( "id" ) long id )
{
NodeOutput nodeOutput = new NodeOutput();
nodeOutput.setNode( db.getNodeById( id ) );
return Stream.of( nodeOutput );
}
@Procedure
public Stream<DoubleOutput> squareDouble( @Name("value") double value )
{
DoubleOutput output = new DoubleOutput( value * value );
return Stream.of( output );
}
@Procedure
public Stream<DoubleOutput> avgNumberList( @Name("list") List<Number> list )
{
double sum = list.stream().reduce( (l, r) -> l.doubleValue() + r.doubleValue()).orElse(0.0d).doubleValue();
int count = list.size();
DoubleOutput output = new DoubleOutput( sum / count );
return Stream.of( output );
}
@Procedure
public Stream<DoubleOutput> avgDoubleList( @Name("list") List<Double> list )
{
double sum = list.stream().reduce( (l, r) -> l + r ).orElse(0.0d);
int count = list.size();
DoubleOutput output = new DoubleOutput( sum / count );
return Stream.of( output );
}
@Procedure
public Stream<Output> squareLong( @Name("value") long value )
{
Output output = new Output( value * value );
return Stream.of( output );
}
@Procedure
public Stream<Output> throwsExceptionInStream()
{
return Stream.generate( () -> { throw new RuntimeException( "Kaboom" ); } );
}
@Procedure
public Stream<MyOutputRecord> listCoolPeopleInDatabase()
{
return stream( spliteratorUnknownSize( db.findNodes( label( "Person" ) ), ORDERED | IMMUTABLE ), false )
.map( ( n ) -> new MyOutputRecord( (String) n.getProperty( "name" ) ) );
}
@Procedure
public Stream<Output> logAround()
{
log.debug( "1" );
log.info( "2" );
log.warn( "3" );
log.error( "4" );
return Stream.empty();
}
@Procedure
public Stream<Output> readOnlyTryingToWrite()
{
db.createNode();
return Stream.empty();
}
@Procedure
@PerformsWrites
public Stream<Output> writingProcedure()
{
db.createNode();
return Stream.empty();
}
@Procedure
public Stream<Output> readOnlyCallingWriteProcedure()
{
return db.execute("CALL org.neo4j.procedure.writingProcedure")
.stream()
.map( (row) -> new Output( 0 ) );
}
@Procedure
@PerformsWrites
public Stream<Output> writeProcedureCallingWriteProcedure()
{
return db.execute("CALL org.neo4j.procedure.writingProcedure")
.stream()
.map( (row) -> new Output( 0 ) );
}
@Procedure
@PerformsWrites
public void sideEffect( @Name( "value" ) String value )
{
db.createNode( Label.label( value ) );
}
@Procedure
public void shutdown() {
db.shutdown();
}
@Procedure
@PerformsWrites
public void delegatingSideEffect( @Name( "value" ) String value )
{
db.execute( "CALL org.neo4j.procedure.sideEffect", map( "value", value ) );
}
}
}