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
|
/*
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You 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 org.apache.spark.rpc
import java.util.concurrent.{TimeUnit, CountDownLatch, TimeoutException}
import scala.collection.mutable
import scala.concurrent.Await
import scala.concurrent.duration._
import scala.language.postfixOps
import org.scalatest.{BeforeAndAfterAll, FunSuite}
import org.scalatest.concurrent.Eventually._
import org.apache.spark.{SparkException, SparkConf}
/**
* Common tests for an RpcEnv implementation.
*/
abstract class RpcEnvSuite extends FunSuite with BeforeAndAfterAll {
var env: RpcEnv = _
override def beforeAll(): Unit = {
val conf = new SparkConf()
env = createRpcEnv(conf, "local", 12345)
}
override def afterAll(): Unit = {
if(env != null) {
env.shutdown()
}
}
def createRpcEnv(conf: SparkConf, name: String, port: Int): RpcEnv
test("send a message locally") {
@volatile var message: String = null
val rpcEndpointRef = env.setupEndpoint("send-locally", new RpcEndpoint {
override val rpcEnv = env
override def receive = {
case msg: String => message = msg
}
})
rpcEndpointRef.send("hello")
eventually(timeout(5 seconds), interval(10 millis)) {
assert("hello" === message)
}
}
test("send a message remotely") {
@volatile var message: String = null
// Set up a RpcEndpoint using env
env.setupEndpoint("send-remotely", new RpcEndpoint {
override val rpcEnv = env
override def receive: PartialFunction[Any, Unit] = {
case msg: String => message = msg
}
})
val anotherEnv = createRpcEnv(new SparkConf(), "remote" ,13345)
// Use anotherEnv to find out the RpcEndpointRef
val rpcEndpointRef = anotherEnv.setupEndpointRef("local", env.address, "send-remotely")
try {
rpcEndpointRef.send("hello")
eventually(timeout(5 seconds), interval(10 millis)) {
assert("hello" === message)
}
} finally {
anotherEnv.shutdown()
anotherEnv.awaitTermination()
}
}
test("send a RpcEndpointRef") {
val endpoint = new RpcEndpoint {
override val rpcEnv = env
override def receiveAndReply(context: RpcCallContext) = {
case "Hello" => context.reply(self)
case "Echo" => context.reply("Echo")
}
}
val rpcEndpointRef = env.setupEndpoint("send-ref", endpoint)
val newRpcEndpointRef = rpcEndpointRef.askWithReply[RpcEndpointRef]("Hello")
val reply = newRpcEndpointRef.askWithReply[String]("Echo")
assert("Echo" === reply)
}
test("ask a message locally") {
val rpcEndpointRef = env.setupEndpoint("ask-locally", new RpcEndpoint {
override val rpcEnv = env
override def receiveAndReply(context: RpcCallContext): PartialFunction[Any, Unit] = {
case msg: String => {
context.reply(msg)
}
}
})
val reply = rpcEndpointRef.askWithReply[String]("hello")
assert("hello" === reply)
}
test("ask a message remotely") {
env.setupEndpoint("ask-remotely", new RpcEndpoint {
override val rpcEnv = env
override def receiveAndReply(context: RpcCallContext): PartialFunction[Any, Unit] = {
case msg: String => {
context.reply(msg)
}
}
})
val anotherEnv = createRpcEnv(new SparkConf(), "remote", 13345)
// Use anotherEnv to find out the RpcEndpointRef
val rpcEndpointRef = anotherEnv.setupEndpointRef("local", env.address, "ask-remotely")
try {
val reply = rpcEndpointRef.askWithReply[String]("hello")
assert("hello" === reply)
} finally {
anotherEnv.shutdown()
anotherEnv.awaitTermination()
}
}
test("ask a message timeout") {
env.setupEndpoint("ask-timeout", new RpcEndpoint {
override val rpcEnv = env
override def receiveAndReply(context: RpcCallContext): PartialFunction[Any, Unit] = {
case msg: String => {
Thread.sleep(100)
context.reply(msg)
}
}
})
val conf = new SparkConf()
conf.set("spark.akka.retry.wait", "0")
conf.set("spark.akka.num.retries", "1")
val anotherEnv = createRpcEnv(conf, "remote", 13345)
// Use anotherEnv to find out the RpcEndpointRef
val rpcEndpointRef = anotherEnv.setupEndpointRef("local", env.address, "ask-timeout")
try {
val e = intercept[Exception] {
rpcEndpointRef.askWithReply[String]("hello", 1 millis)
}
assert(e.isInstanceOf[TimeoutException] || e.getCause.isInstanceOf[TimeoutException])
} finally {
anotherEnv.shutdown()
anotherEnv.awaitTermination()
}
}
test("onStart and onStop") {
val stopLatch = new CountDownLatch(1)
val calledMethods = mutable.ArrayBuffer[String]()
val endpoint = new RpcEndpoint {
override val rpcEnv = env
override def onStart(): Unit = {
calledMethods += "start"
}
override def receive: PartialFunction[Any, Unit] = {
case msg: String =>
}
override def onStop(): Unit = {
calledMethods += "stop"
stopLatch.countDown()
}
}
val rpcEndpointRef = env.setupEndpoint("start-stop-test", endpoint)
env.stop(rpcEndpointRef)
stopLatch.await(10, TimeUnit.SECONDS)
assert(List("start", "stop") === calledMethods)
}
test("onError: error in onStart") {
@volatile var e: Throwable = null
env.setupEndpoint("onError-onStart", new RpcEndpoint {
override val rpcEnv = env
override def onStart(): Unit = {
throw new RuntimeException("Oops!")
}
override def receive: PartialFunction[Any, Unit] = {
case m =>
}
override def onError(cause: Throwable): Unit = {
e = cause
}
})
eventually(timeout(5 seconds), interval(10 millis)) {
assert(e.getMessage === "Oops!")
}
}
test("onError: error in onStop") {
@volatile var e: Throwable = null
val endpointRef = env.setupEndpoint("onError-onStop", new RpcEndpoint {
override val rpcEnv = env
override def receive: PartialFunction[Any, Unit] = {
case m =>
}
override def onError(cause: Throwable): Unit = {
e = cause
}
override def onStop(): Unit = {
throw new RuntimeException("Oops!")
}
})
env.stop(endpointRef)
eventually(timeout(5 seconds), interval(10 millis)) {
assert(e.getMessage === "Oops!")
}
}
test("onError: error in receive") {
@volatile var e: Throwable = null
val endpointRef = env.setupEndpoint("onError-receive", new RpcEndpoint {
override val rpcEnv = env
override def receive: PartialFunction[Any, Unit] = {
case m => throw new RuntimeException("Oops!")
}
override def onError(cause: Throwable): Unit = {
e = cause
}
})
endpointRef.send("Foo")
eventually(timeout(5 seconds), interval(10 millis)) {
assert(e.getMessage === "Oops!")
}
}
test("self: call in onStart") {
@volatile var callSelfSuccessfully = false
env.setupEndpoint("self-onStart", new RpcEndpoint {
override val rpcEnv = env
override def onStart(): Unit = {
self
callSelfSuccessfully = true
}
override def receive: PartialFunction[Any, Unit] = {
case m =>
}
})
eventually(timeout(5 seconds), interval(10 millis)) {
// Calling `self` in `onStart` is fine
assert(callSelfSuccessfully === true)
}
}
test("self: call in receive") {
@volatile var callSelfSuccessfully = false
val endpointRef = env.setupEndpoint("self-receive", new RpcEndpoint {
override val rpcEnv = env
override def receive: PartialFunction[Any, Unit] = {
case m => {
self
callSelfSuccessfully = true
}
}
})
endpointRef.send("Foo")
eventually(timeout(5 seconds), interval(10 millis)) {
// Calling `self` in `receive` is fine
assert(callSelfSuccessfully === true)
}
}
test("self: call in onStop") {
@volatile var selfOption: Option[RpcEndpointRef] = null
val endpointRef = env.setupEndpoint("self-onStop", new RpcEndpoint {
override val rpcEnv = env
override def receive: PartialFunction[Any, Unit] = {
case m =>
}
override def onStop(): Unit = {
selfOption = Option(self)
}
override def onError(cause: Throwable): Unit = {
}
})
env.stop(endpointRef)
eventually(timeout(5 seconds), interval(10 millis)) {
// Calling `self` in `onStop` will return null, so selfOption will be None
assert(selfOption == None)
}
}
test("call receive in sequence") {
// If a RpcEnv implementation breaks the `receive` contract, hope this test can expose it
for(i <- 0 until 100) {
@volatile var result = 0
val endpointRef = env.setupEndpoint(s"receive-in-sequence-$i", new ThreadSafeRpcEndpoint {
override val rpcEnv = env
override def receive: PartialFunction[Any, Unit] = {
case m => result += 1
}
})
(0 until 10) foreach { _ =>
new Thread {
override def run() {
(0 until 100) foreach { _ =>
endpointRef.send("Hello")
}
}
}.start()
}
eventually(timeout(5 seconds), interval(5 millis)) {
assert(result == 1000)
}
env.stop(endpointRef)
}
}
test("stop(RpcEndpointRef) reentrant") {
@volatile var onStopCount = 0
val endpointRef = env.setupEndpoint("stop-reentrant", new RpcEndpoint {
override val rpcEnv = env
override def receive: PartialFunction[Any, Unit] = {
case m =>
}
override def onStop(): Unit = {
onStopCount += 1
}
})
env.stop(endpointRef)
env.stop(endpointRef)
eventually(timeout(5 seconds), interval(5 millis)) {
// Calling stop twice should only trigger onStop once.
assert(onStopCount == 1)
}
}
test("sendWithReply") {
val endpointRef = env.setupEndpoint("sendWithReply", new RpcEndpoint {
override val rpcEnv = env
override def receiveAndReply(context: RpcCallContext): PartialFunction[Any, Unit] = {
case m => context.reply("ack")
}
})
val f = endpointRef.sendWithReply[String]("Hi")
val ack = Await.result(f, 5 seconds)
assert("ack" === ack)
env.stop(endpointRef)
}
test("sendWithReply: remotely") {
env.setupEndpoint("sendWithReply-remotely", new RpcEndpoint {
override val rpcEnv = env
override def receiveAndReply(context: RpcCallContext): PartialFunction[Any, Unit] = {
case m => context.reply("ack")
}
})
val anotherEnv = createRpcEnv(new SparkConf(), "remote", 13345)
// Use anotherEnv to find out the RpcEndpointRef
val rpcEndpointRef = anotherEnv.setupEndpointRef("local", env.address, "sendWithReply-remotely")
try {
val f = rpcEndpointRef.sendWithReply[String]("hello")
val ack = Await.result(f, 5 seconds)
assert("ack" === ack)
} finally {
anotherEnv.shutdown()
anotherEnv.awaitTermination()
}
}
test("sendWithReply: error") {
val endpointRef = env.setupEndpoint("sendWithReply-error", new RpcEndpoint {
override val rpcEnv = env
override def receiveAndReply(context: RpcCallContext): PartialFunction[Any, Unit] = {
case m => context.sendFailure(new SparkException("Oops"))
}
})
val f = endpointRef.sendWithReply[String]("Hi")
val e = intercept[SparkException] {
Await.result(f, 5 seconds)
}
assert("Oops" === e.getMessage)
env.stop(endpointRef)
}
test("sendWithReply: remotely error") {
env.setupEndpoint("sendWithReply-remotely-error", new RpcEndpoint {
override val rpcEnv = env
override def receiveAndReply(context: RpcCallContext): PartialFunction[Any, Unit] = {
case msg: String => context.sendFailure(new SparkException("Oops"))
}
})
val anotherEnv = createRpcEnv(new SparkConf(), "remote", 13345)
// Use anotherEnv to find out the RpcEndpointRef
val rpcEndpointRef = anotherEnv.setupEndpointRef(
"local", env.address, "sendWithReply-remotely-error")
try {
val f = rpcEndpointRef.sendWithReply[String]("hello")
val e = intercept[SparkException] {
Await.result(f, 5 seconds)
}
assert("Oops" === e.getMessage)
} finally {
anotherEnv.shutdown()
anotherEnv.awaitTermination()
}
}
test("network events") {
val events = new mutable.ArrayBuffer[(Any, Any)] with mutable.SynchronizedBuffer[(Any, Any)]
env.setupEndpoint("network-events", new ThreadSafeRpcEndpoint {
override val rpcEnv = env
override def receive: PartialFunction[Any, Unit] = {
case "hello" =>
case m => events += "receive" -> m
}
override def onConnected(remoteAddress: RpcAddress): Unit = {
events += "onConnected" -> remoteAddress
}
override def onDisconnected(remoteAddress: RpcAddress): Unit = {
events += "onDisconnected" -> remoteAddress
}
override def onNetworkError(cause: Throwable, remoteAddress: RpcAddress): Unit = {
events += "onNetworkError" -> remoteAddress
}
})
val anotherEnv = createRpcEnv(new SparkConf(), "remote", 13345)
// Use anotherEnv to find out the RpcEndpointRef
val rpcEndpointRef = anotherEnv.setupEndpointRef(
"local", env.address, "network-events")
val remoteAddress = anotherEnv.address
rpcEndpointRef.send("hello")
eventually(timeout(5 seconds), interval(5 millis)) {
assert(events === List(("onConnected", remoteAddress)))
}
anotherEnv.shutdown()
anotherEnv.awaitTermination()
eventually(timeout(5 seconds), interval(5 millis)) {
assert(events === List(
("onConnected", remoteAddress),
("onNetworkError", remoteAddress),
("onDisconnected", remoteAddress)))
}
}
test("sendWithReply: unserializable error") {
env.setupEndpoint("sendWithReply-unserializable-error", new RpcEndpoint {
override val rpcEnv = env
override def receiveAndReply(context: RpcCallContext): PartialFunction[Any, Unit] = {
case msg: String => context.sendFailure(new UnserializableException)
}
})
val anotherEnv = createRpcEnv(new SparkConf(), "remote", 13345)
// Use anotherEnv to find out the RpcEndpointRef
val rpcEndpointRef = anotherEnv.setupEndpointRef(
"local", env.address, "sendWithReply-unserializable-error")
try {
val f = rpcEndpointRef.sendWithReply[String]("hello")
intercept[TimeoutException] {
Await.result(f, 1 seconds)
}
} finally {
anotherEnv.shutdown()
anotherEnv.awaitTermination()
}
}
}
class UnserializableClass
class UnserializableException extends Exception {
private val unserializableField = new UnserializableClass
}
|