-
Notifications
You must be signed in to change notification settings - Fork 2.3k
/
ProceduresTest.java
280 lines (241 loc) · 9.87 KB
/
ProceduresTest.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
/*
* 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 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.neo4j.kernel.impl.proc;
import org.junit.Rule;
import org.junit.Test;
import org.junit.rules.ExpectedException;
import java.util.List;
import org.neo4j.collection.RawIterator;
import org.neo4j.helpers.collection.Iterables;
import org.neo4j.kernel.api.exceptions.ProcedureException;
import org.neo4j.kernel.api.proc.CallableProcedure;
import org.neo4j.kernel.api.proc.ProcedureSignature;
import org.neo4j.procedure.PerformsWrites;
import org.neo4j.procedure.Procedure;
import static org.hamcrest.CoreMatchers.equalTo;
import static org.hamcrest.Matchers.contains;
import static org.hamcrest.Matchers.containsInAnyOrder;
import static org.junit.Assert.assertNotNull;
import static org.junit.Assert.assertThat;
import static org.neo4j.helpers.collection.Iterators.asList;
import static org.neo4j.kernel.api.proc.CallableProcedure.Key.key;
import static org.neo4j.kernel.api.proc.Neo4jTypes.NTAny;
import static org.neo4j.kernel.api.proc.ProcedureSignature.procedureSignature;
public class ProceduresTest
{
@Rule
public ExpectedException exception = ExpectedException.none();
private final Procedures procs = new Procedures();
private final ProcedureSignature signature = procedureSignature( "org", "myproc" ).build();
private final CallableProcedure procedure = procedure( signature );
@Test
public void shouldGetRegisteredProcedure() throws Throwable
{
// When
procs.register( procedure );
// Then
assertThat( procs.get( signature.name() ), equalTo( signature ) );
}
@Test
public void shouldGetAllRegisteredProcedures() throws Throwable
{
// When
procs.register( procedure( procedureSignature( "org", "myproc1" ).build() ) );
procs.register( procedure( procedureSignature( "org", "myproc2" ).build() ) );
procs.register( procedure( procedureSignature( "org", "myproc3" ).build() ) );
// Then
List<ProcedureSignature> signatures = Iterables.asList( procs.getAll() );
assertThat( signatures, containsInAnyOrder(
procedureSignature( "org", "myproc1" ).build(),
procedureSignature( "org", "myproc2" ).build(),
procedureSignature( "org", "myproc3" ).build() ) );
}
@Test
public void shouldCallRegisteredProcedure() throws Throwable
{
// Given
procs.register( procedure );
// When
RawIterator<Object[], ProcedureException> result = procs.call( new CallableProcedure.BasicContext()
{
}, signature.name(), new Object[]{1337} );
// Then
assertThat( asList( result ), contains( equalTo( new Object[]{1337} ) ) );
}
@Test
public void shouldNotAllowCallingNonExistingProcedure() throws Throwable
{
// Expect
exception.expect( ProcedureException.class );
exception.expectMessage( "There is no procedure with the name `org.myproc` registered for this " +
"database instance. Please ensure you've spelled the " +
"procedure name correctly and that the procedure is properly deployed." );
// When
procs.call( new CallableProcedure.BasicContext()
{
}, signature.name(), new Object[]{1337} );
}
@Test
public void shouldNotAllowRegisteringConflictingName() throws Throwable
{
// Given
procs.register( procedure );
// Expect
exception.expect( ProcedureException.class );
exception.expectMessage( "Unable to register procedure, because the name `org.myproc` is already in use." );
// When
procs.register( procedure );
}
@Test
public void shouldNotAllowDuplicateFieldNamesInInput() throws Throwable
{
// Expect
exception.expect( ProcedureException.class );
exception.expectMessage( "Procedure `asd(a :: ANY?, a :: ANY?) :: ()` cannot be " +
"registered, because it contains a duplicated input field, 'a'. " +
"You need to rename or remove one of the duplicate fields." );
// When
procs.register( procedureWithSignature( procedureSignature( "asd" ).in( "a", NTAny ).in( "a", NTAny ).build() ) );
}
@Test
public void shouldNotAllowDuplicateFieldNamesInOutput() throws Throwable
{
// Expect
exception.expect( ProcedureException.class );
exception.expectMessage( "Procedure `asd() :: (a :: ANY?, a :: ANY?)` cannot be registered, " +
"because it contains a duplicated output field, 'a'. " +
"You need to rename or remove one of the duplicate fields." );
// When
procs.register( procedureWithSignature( procedureSignature( "asd" ).out( "a", NTAny ).out( "a", NTAny ).build() ) );
}
@Test
public void shouldSignalNonExistingProcedure() throws Throwable
{
// Expect
exception.expect( ProcedureException.class );
exception.expectMessage( "There is no procedure with the name `org.myproc` registered for this " +
"database instance. Please ensure you've spelled the " +
"procedure name correctly and that the procedure is properly deployed." );
// When
procs.get( signature.name() );
}
@Test
public void shouldMakeContextAvailable() throws Throwable
{
// Given
CallableProcedure.Key<String> someKey = key("someKey", String.class);
procs.register( new CallableProcedure.BasicProcedure(signature)
{
@Override
public RawIterator<Object[], ProcedureException> apply( Context ctx, Object[] input ) throws ProcedureException
{
return RawIterator.<Object[], ProcedureException>of( new Object[]{ctx.get( someKey )} );
}
} );
CallableProcedure.BasicContext ctx = new CallableProcedure.BasicContext();
ctx.put( someKey, "hello, world" );
// When
RawIterator<Object[], ProcedureException> result = procs.call( ctx, signature.name(), new Object[0] );
// Then
assertThat( asList( result ), contains( equalTo( new Object[]{ "hello, world" } ) ) );
}
@Test
public void shouldFailCompileProcedureWithReadConflict() throws Throwable
{
exception.expect( ProcedureException.class );
exception.expectMessage( "Conflicting procedure annotation, cannot use PerformsWrites and mode" );
procs.register( ProcedureWithReadConflictAnnotation.class );
}
@Test
public void shouldFailCompileProcedureWithWriteConflict() throws Throwable
{
exception.expect( ProcedureException.class );
exception.expectMessage( "Conflicting procedure annotation, cannot use PerformsWrites and mode" );
procs.register( ProcedureWithWriteConflictAnnotation.class );
}
@Test
public void shouldFailCompileProcedureWithSchemaConflict() throws Throwable
{
exception.expect( ProcedureException.class );
exception.expectMessage( "Conflicting procedure annotation, cannot use PerformsWrites and mode" );
procs.register( ProcedureWithSchemaConflictAnnotation.class );
}
@Test
public void shouldFailCompileProcedureWithDBMSConflict() throws Throwable
{
exception.expect( ProcedureException.class );
exception.expectMessage( "Conflicting procedure annotation, cannot use PerformsWrites and mode" );
procs.register( ProcedureWithDBMSConflictAnnotation.class );
}
public static class ProcedureWithReadConflictAnnotation
{
@PerformsWrites
@Procedure( mode = Procedure.Mode.READ )
public void shouldCompile()
{
}
}
public static class ProcedureWithWriteConflictAnnotation
{
@PerformsWrites
@Procedure( mode = Procedure.Mode.WRITE )
public void shouldCompileToo()
{
}
}
public static class ProcedureWithDBMSConflictAnnotation
{
@PerformsWrites
@Procedure( mode = Procedure.Mode.DBMS )
public void shouldNotCompile()
{
}
}
public static class ProcedureWithSchemaConflictAnnotation
{
@PerformsWrites
@Procedure( mode = Procedure.Mode.SCHEMA )
public void shouldNotCompile()
{
}
}
private CallableProcedure.BasicProcedure procedureWithSignature( final ProcedureSignature signature )
{
return new CallableProcedure.BasicProcedure(signature)
{
@Override
public RawIterator<Object[], ProcedureException> apply( Context ctx, Object[] input ) throws ProcedureException
{
return null;
}
};
}
private CallableProcedure procedure( ProcedureSignature signature )
{
return new CallableProcedure.BasicProcedure( signature )
{
@Override
public RawIterator<Object[], ProcedureException> apply( Context ctx, Object[] input )
{
return RawIterator.<Object[], ProcedureException>of( input );
}
};
}
}