@@ -1,22 +1,16 @@
1−{-# LANGUAGE DeriveGeneric #-}
2−{-# LANGUAGE ParallelListComp #-}
3−
1+{-# LANGUAGE DeriveGeneric #-}
42module Control.Distributed.Process.Tests.Mx (tests) where
53
64import Control.Distributed.Process.Tests.Internal.Utils
75import Network.Transport.Test (TestTransport(..))
8−import Control.Distributed.Process hiding (bracket, finally, try)
9−import Control.Distributed.Process.Internal.Types
10− ( ProcessExitException(..)
11− , unsafeCreateUnencodedMessage
12− )
6+
7+import Control.Distributed.Process
138import Control.Distributed.Process.Node
149import qualified Control.Distributed.Process.UnsafePrimitives as Unsafe
1510 ( send
1611 , nsend
1712 , nsendRemote
1813 , usend
19− , sendChan
2014 )
2115import Control.Distributed.Process.Management
2216 ( MxEvent(..)
@@ -34,13 +28,12 @@ import Control.Distributed.Process.Management
3428 , mxBroadcast
3529 )
3630import Control.Monad (void, unless)
37−import Control.Monad.Catch(finally, bracket, try)
3831import Control.Rematch (equalTo)
3932import Data.Binary
40−import Data.List (find, sort, intercalate)
41−import Data.Maybe (isJust, fromJust, isNothing, fromMaybe, catMaybes)
33+import Data.List (find, sort)
34+import Data.Maybe (isJust, isNothing)
4235import Data.Typeable
43−import GHC.Generics hiding (from)
36+import GHC.Generics
4437#if ! MIN_VERSION_base(4,6,0)
4538import Prelude hiding (catch, log)
4639#endif
@@ -64,9 +57,9 @@ awaitExit pid =
6457 (\_ -> return ())
6558 ]
6659 where
67− withMonitorRef p = bracket (monitor p) unmonitor
60+ withMonitorRef pid = bracket (monitor pid) unmonitor
6861
69−testAgentBroadcast :: TestResult (Maybe ()) -> Process ()
62+testAgentBroadcast :: TestResult () -> Process ()
7063testAgentBroadcast result = do
7164 (resultSP, resultRP) <- newChan :: Process (SendPort (), ReceivePort ())
7265
@@ -81,10 +74,10 @@ testAgentBroadcast result = do
8174 mxNotify ()
8275 -- Once the publisher has seen our message, it will broadcast the Publish
8376 -- and the consumer will see that and send the result to our typed channel.
84− stash result =<< receiveChanTimeout 10000000 resultRP
77+ stash result =<< receiveChan resultRP
8578
86− kill publisher "finished"
87− kill consumer "finished"
79+ kill publisher "finished" >> awaitExit publisher
80+ kill consumer "finished" >> awaitExit consumer
8881
8982testAgentDualInput :: TestResult (Maybe Int) -> Process ()
9083testAgentDualInput result = do
@@ -99,8 +92,6 @@ testAgentDualInput result = do
9992 else mxReady)
10093 ]
10194
102− mRef <- monitor s
103−
10495 mxNotify (1 :: Int)
10596 nsend "sum-agent" (3 :: Int)
10697 mxNotify (2 :: Int)
@@ -108,10 +99,7 @@ testAgentDualInput result = do
10899 mxNotify (5 :: Int)
109100
110101 stash result =<< receiveChanTimeout 10000000 rp
111− died <- receiveTimeout 10000000 [
112− matchIf (\(ProcessMonitorNotification r _ _) -> r == mRef) (const $ return True)
113− ]
114− died `shouldBe` equalTo (Just True)
102+ awaitExit s
115103
116104testAgentPrioritisation :: TestResult [String] -> Process ()
117105testAgentPrioritisation result = do
@@ -125,10 +113,10 @@ testAgentPrioritisation result = do
125113 (sp, rp) <- newChan
126114 s <- mxAgent (MxAgentId name) ["first"] [
127115 mxSink (\(s :: String) -> do
128− mxUpdateLocal (s:)
116+ mxUpdateLocal ((s:))
129117 st <- mxGetLocal
130118 case length st of
131− n | n == 5 -> do liftMX $ sendChan sp (sort st)
119+ n | n == 5 -> do liftMX $ sendChan sp st
132120 mxDeactivate "finished"
133121 _ -> mxReceive -- go to the mailbox
134122 )
@@ -139,7 +127,7 @@ testAgentPrioritisation result = do
139127 mxNotify "fourth"
140128 nsend name "fifth"
141129
142− stash result . fromMaybe [] =<< receiveChanTimeout 10000000 rp
130+ stash result . sort =<< receiveChan rp
143131 awaitExit s
144132
145133testAgentMailboxHandling :: TestResult (Maybe ()) -> Process ()
@@ -152,19 +140,12 @@ testAgentMailboxHandling result = do
152140 nsend "mailbox-agent" ()
153141
154142 stash result =<< receiveChanTimeout 1000000 rp
155− kill agent "finished"
143+ kill agent "finished" >> awaitExit agent
156144
157145testAgentEventHandling :: TestResult Bool -> Process ()
158146testAgentEventHandling result = do
159− us <- getSelfPid
160− -- because this test is a bit racy, let's ensure it can't run indefinitely
161− timer <- spawnLocal $ do
162− pause (1000000 * 60 * 5)
163− -- okay we've waited 5 mins, let's kill the test off if it's stuck...
164− stash result False
165− kill us "Test Timed Out"
166−
167147 let initState = [] :: [MxEvent]
148+
168149 (rc, rs) <- newChan
169150 agentPid <- mxAgent (MxAgentId "lifecycle-listener-agent") initState [
170151 (mxSink $ \ev -> do
@@ -197,7 +178,8 @@ testAgentEventHandling result = do
197178 -- TODO: yes, this is racy, but we're at the mercy of the scheduler here...
198179 faff 2000000 rs
199180
200− (sp, rp) <- newChan :: Process (SendPort (), ReceivePort ())
181+ _ <- monitor agentPid
182+ (sp, rp) <- newChan
201183
202184 pid <- spawnLocal $ expect >>= sendChan sp
203185
@@ -206,11 +188,9 @@ testAgentEventHandling result = do
206188 monitor pid
207189
208190 send pid ()
209− rct <- receiveChanTimeout 10000000 rp
210− unless (isJust rct) $ die "No response on channel"
191+ () <- receiveChan rp
211192
212− pmn <- receiveTimeout 2000000 [ match (\ProcessMonitorNotification{} -> return ()) ]
213− unless (isJust pmn) $ die "No monitor notification arrived"
193+ receiveWait [ match (\(ProcessMonitorNotification _ _ _) -> return ()) ]
214194
215195 -- TODO: yes, this is racy, but we're at the mercy of the scheduler here...
216196 faff 2000000 rs
@@ -219,16 +199,17 @@ testAgentEventHandling result = do
219199 mxNotify (MxSpawned pid, replyTo)
220200 mxNotify (MxProcessDied pid DiedNormal, replyTo)
221201
222− seenAlive <- receiveChanTimeout 10000000 reply
223− seenDead <- receiveChanTimeout 10000000 reply
202+ seenAlive <- receiveChan reply
203+ seenDead <- receiveChan reply
224204
225− stash result $ foldr (&&) True $ catMaybes [seenAlive, seenDead]
226− kill timer "test-complete"
227− kill agentPid "test-complete"
205+ stash result $ seenAlive && seenDead
206+ kill agentPid "test-complete" >> awaitExit agentPid
228207 where
229208 faff delay port = do
230209 res <- receiveChanTimeout delay port
231− unless (isNothing res) $ pause delay
210+ unless (isNothing res) $ do
211+ pause delay
212+ faff delay port
232213
233214testMxRegEvents :: TestResult () -> Process ()
234215testMxRegEvents result = do
@@ -275,6 +256,7 @@ testMxRegEvents result = do
275256 reg3 `shouldBe` equalTo (Just (label, p1))
276257
277258 mapM_ (flip kill $ "test-complete") [agent, p1, p2]
259+ awaitExit agent
278260
279261testMxRegMon :: LocalNode -> TestResult () -> Process ()
280262testMxRegMon remoteNode result = do
@@ -332,211 +314,106 @@ testMxRegMon remoteNode result = do
332314 evts `shouldContain` (Just (label1, p1))
333315 evts `shouldContain` (Just (label2, p1))
334316
335− kill agent "test-complete"
317+ kill agent "test-complete" >> awaitExit agent
336318
337319ensure :: Process () -> Process () -> Process ()
338320ensure = flip finally
339321
340−testNSend :: (String -> () -> Process ())
341− -> Maybe LocalNode
342− -> Process ()
343−testNSend op n = do
344− us <- getSelfPid
345− let delay = 5000000
346− let label = "testMxSend" ++ (show us)
347− let isValid = isValidLabel n label
348−
349− testMxSend n label $ \p1 sink -> do
350− register label p1
351− reg1 <- receiveChanTimeout delay sink
352− case reg1 of
353− Just (MxRegistered pd lb)
354− | pd == p1 && isValid lb -> return ()
355− _ -> die $ "Reg-Failed: " ++ show reg1
356322
357− op label ()
323+testMxUnsafeSendEvents :: LocalNode -> Process ()
324+testMxUnsafeSendEvents remoteNode = do
358325
359− sent <- receiveChanTimeout delay sink
360− case sent of
361− Just (MxSentToName lb by _)
362− | by == us && isValid lb -> return True
363− _ -> die $ "Send-Failed: " ++ show sent
326+ -- ensure that when a registered process dies, we get a notification that
327+ -- it has been unregistered as well as seeing the name get removed
364328
365− where
366− isValidLabel nd l1 l2
367− | l2 == l2 = True
368− | isJust nd = l2 == l1 ++ "@" ++ show (localNodeId $ fromJust nd)
369− | otherwise = False
370−
371−testSend :: (ProcessId -> () -> Process ())
372− -> Maybe LocalNode
373− -> Process ()
374−testSend op n = do
375− us <- getSelfPid
376− let label = "testMxSend" ++ (show us)
377− testMxSend n label $ \p1 sink -> do
378− -- initiate a send
379− op p1 ()
380−
381− -- verify the management event
382− sent <- receiveChanTimeout 5000000 sink
383− case sent of
384− Just (MxSent pidTo pidFrom _)
385− | pidTo == p1 && pidFrom == us -> return True
386− _ -> return False
387−
388−testChan :: (SendPort () -> () -> Process ())
389− -> Maybe LocalNode
390− -> Process ()
391−testChan op n = testMxSend n "" $ \p1 sink -> do
392−
393− us <- getSelfPid
394− send p1 us
395−
396− cleared <- receiveChanTimeout 2000000 sink
397− case cleared of
398− Just (MxSent pidTo pidFrom _)
399− | pidTo == p1 && pidFrom == us -> return ()
400− _ -> die "Received uncleared Mx Event"
401−
402− chan <- receiveTimeout 5000000 [ match return ]
403− let ch' = fromMaybe (error "No reply chan received") chan
404−
405− -- initiate a send
406− op ch' ()
407−
408− -- verify the management event
409− sent <- receiveChanTimeout 5000000 sink
410− case sent of
411− Just (MxSentToPort sId spId _)
412− | sId == us && spId == sendPortId ch' -> return True
413− _ -> return False
414−
415−type SendTest = ProcessId -> ReceivePort MxEvent -> Process Bool
416−
417−testMxSend :: Maybe LocalNode -> String -> SendTest -> Process ()
418−testMxSend mNode label test = do
419− us <- getSelfPid
420− (sp, rp) <- newChan
421− (chan, sink) <- newChan
422− agent <- mxAgent (MxAgentId $ agentLabel us) () [
329+ let label1 = "aaaaa"
330+ let label2 = "bbbbb"
331+ let isValid l = l ==label1 || l == label2
332+ let agentLabel = "listener-agent"
333+ let delay = 1000000
334+ (regChan, regSink) <- newChan
335+ (unRegChan, unRegSink) <- newChan
336+ agent <- mxAgent (MxAgentId agentLabel) () [
423337 mxSink $ \ev -> do
424338 case ev of
425− m@(MxSentToPort _ cid _)
426− | cid /= sendPortId chan
427− && cid /= sendPortId sp -> liftMX $ sendChan chan m
428− m@(MxSent _ fromPid _)
429− | fromPid == us -> liftMX $ sendChan chan m
430− m@(MxSentToName _ fromPid _)
431− | fromPid == us -> liftMX $ sendChan chan m
432− m@(MxRegistered _ name)
433− | name == label -> liftMX $ sendChan chan m
339+ MxRegistered pid label
340+ | isValid label -> liftMX $ sendChan regChan (label, pid)
341+ MxUnRegistered pid label
342+ | isValid label -> liftMX $ sendChan unRegChan (label, pid)
434343 _ -> return ()
435344 mxReady
436345 ]
437346
438− case mNode of
439− Nothing -> void $ spawnLocal (proc sp)
440− Just remoteNode -> void $ liftIO $ forkProcess remoteNode $ proc sp
347+ (sp, rp) <- newChan
348+ liftIO $ forkProcess remoteNode $ do
349+ getSelfPid >>= sendChan sp
350+ expect :: Process ()
441351
442− p1 <- receiveChanTimeout 2000000 rp
443− unless (isJust p1) $ die "Timed out waiting for ProcessId"
444− res <- try $ test (fromJust p1) sink
352+ p1 <- receiveChan rp
445353
446− kill agent "bye"
447− kill (fromJust p1) "bye"
354+ register label1 p1
355+ reg1 <- receiveChanTimeout delay regSink
356+ reg1 `shouldBe` equalTo (Just (label1, p1))
448357
449− case res of
450− Left (ProcessExitException _ m) -> (liftIO $ putStrLn $ "SomeException-" ++ show m) >> die m
451− Right tr -> tr `shouldBe` equalTo True
358+ register label2 p1
359+ reg2 <- receiveChanTimeout delay regSink
360+ reg2 `shouldBe` equalTo (Just (label2, p1))
452361
362+ n1 <- whereis label1
363+ n1 `shouldBe` equalTo (Just p1)
453364
454− where
455− agentLabel s = "mx-unsafe-check-agent-" ++ show s
456− proc sp' = getSelfPid >>= sendChan sp' >> go Nothing
365+ n2 <- whereis label2
366+ n2 `shouldBe` equalTo (Just p1)
457367
458− go :: Maybe (ReceivePort ()) -> Process ()
459− go Nothing = receiveTimeout 5000000 [ match replyChannel ] >>= go
460− go c@(Just c') = receiveWait [ matchChan c' return ] >> go c
368+ kill p1 "goodbye"
461369
462− replyChannel p' = do
463− (s, r) <- newChan
464− send p' s
465− return r
370+ unreg1 <- receiveChanTimeout delay unRegSink
371+ unreg2 <- receiveChanTimeout delay unRegSink
372+
373+ sort [unreg1, unreg2]
374+ `shouldBe` equalTo [Just (label1, p1), Just (label2, p1)]
375+
376+ kill agent "test-complete"
466377
467378tests :: TestTransport -> IO [Test]
468379tests TestTransport{..} = do
469380 node1 <- newLocalNode testTransport initRemoteTable
470381 node2 <- newLocalNode testTransport initRemoteTable
471382 return [
472− testGroup "MxAgents" [
473− testCase "EventHandling"
383+ testGroup "Mx Agents" [
384+ testCase "Event Handling"
474385 (delayedAssertion
475386 "expected True, but events where not as expected"
476387 node1 True testAgentEventHandling)
477− , testCase "InterAgentBroadcast"
388+ , testCase "Inter-Agent Broadcast"
478389 (delayedAssertion
479390 "expected (), but no broadcast was received"
480− node1 (Just ()) testAgentBroadcast)
481− , testCase "AgentMailboxHandling"
391+ node1 () testAgentBroadcast)
392+ , testCase "Agent Mailbox Handling"
482393 (delayedAssertion
483394 "expected (Just ()), but no regular (mailbox) input was handled"
484395 node1 (Just ()) testAgentMailboxHandling)
485− , testCase "AgentDualInputHandling"
396+ , testCase "Agent Dual Input Handling"
486397 (delayedAssertion
487398 "expected sum = 15, but the result was Nothing"
488399 node1 (Just 15 :: Maybe Int) testAgentDualInput)
489− , testCase "AgentInputPrioritisation"
400+ , testCase "Agent Input Prioritisation"
490401 (delayedAssertion
491402 "expected [first, second, third, fourth, fifth], but result diverged"
492403 node1 (sort ["first", "second",
493404 "third", "fourth",
494405 "fifth"]) testAgentPrioritisation)
495406 ]
496− , testGroup "MxEvents" [
497− testCase "NameRegistrationEvents"
407+ , testGroup "Mx Events" [
408+ testCase "Name Registration Events"
498409 (delayedAssertion
499410 "expected registration events to map to the correct ProcessId"
500411 node1 () testMxRegEvents)
501− , testCase "PostDeathNameUnRegistrationEvents"
412+ , testCase "Post Death Name UnRegistration Events"
502413 (delayedAssertion
503414 "expected process deaths to result in unregistration events"
504415 node1 () (testMxRegMon node2))
505− , testGroup "SendEvents" $ buildTestCases node1 node2
416+ , testCase "Monitor Events"
417+ (runProcess node1 (testMxUnsafeSendEvents node2))
506418 ]
507419 ]
508− where
509− buildTestCases n1 n2 = let nid = localNodeId n2 in build n1 n2 [
510− ("NSend", [
511− ("nsend", testNSend nsend)
512− , ("Unsafe.nsend", testNSend Unsafe.nsend)
513− , ("nsendRemote", testNSend (nsendRemote nid))
514− , ("Unsafe.nsendRemote", testNSend (Unsafe.nsendRemote nid))
515− ])
516− , ("Send", [
517− ("send", testSend send)
518− , ("Unsafe.send", testSend Unsafe.send)
519− , ("usend", testSend usend)
520− , ("Unsafe.usend", testSend Unsafe.usend)
521− , ("sendChan", testChan sendChan)
522− , ("Unsafe.sendChan", testChan Unsafe.sendChan)
523− ])
524− , ("Forward", [
525− ("forward", testSend (\p m -> forward (unsafeCreateUnencodedMessage m) p))
526− , ("uforward", testSend (\p m -> uforward (unsafeCreateUnencodedMessage m) p))
527− ])
528− ]
529−
530− build :: LocalNode
531− -> LocalNode
532− -> [(String, [(String, (Maybe LocalNode -> Process ()))])]
533− -> [Test]
534− build n ln specs =
535− [ testGroup (intercalate "-" [groupName, caseSuffix]) [
536− testCase (intercalate "-" [caseName, caseSuffix])
537− (runProcess n (caseImpl caseNode))
538− | (caseName, caseImpl) <- groupCases
539− ]
540− | (groupName, groupCases) <- specs
541− , (caseSuffix, caseNode) <- [("RemotePid", Just ln), ("LocalPid", Nothing)]
542− ]