@@ -1,23 +1,11 @@
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
14−import qualified Control.Distributed.Process.UnsafePrimitives as Unsafe
15− ( send
16− , nsend
17− , nsendRemote
18− , usend
19− , sendChan
20− )
219import Control.Distributed.Process.Management
2210 ( MxEvent(..)
2311 , MxAgentId(..)
@@ -34,13 +22,12 @@ import Control.Distributed.Process.Management
3422 , mxBroadcast
3523 )
3624import Control.Monad (void, unless)
37−import Control.Monad.Catch(finally, bracket, try)
3825import Control.Rematch (equalTo)
3926import Data.Binary
40−import Data.List (find, sort, intercalate)
41−import Data.Maybe (isJust, fromJust, isNothing, fromMaybe, catMaybes)
27+import Data.List (find, sort)
28+import Data.Maybe (isJust, isNothing)
4229import Data.Typeable
43−import GHC.Generics hiding (from)
30+import GHC.Generics
4431#if ! MIN_VERSION_base(4,6,0)
4532import Prelude hiding (catch, log)
4633#endif
@@ -64,9 +51,9 @@ awaitExit pid =
6451 (\_ -> return ())
6552 ]
6653 where
67− withMonitorRef p = bracket (monitor p) unmonitor
54+ withMonitorRef pid = bracket (monitor pid) unmonitor
6855
69−testAgentBroadcast :: TestResult (Maybe ()) -> Process ()
56+testAgentBroadcast :: TestResult () -> Process ()
7057testAgentBroadcast result = do
7158 (resultSP, resultRP) <- newChan :: Process (SendPort (), ReceivePort ())
7259
@@ -81,10 +68,10 @@ testAgentBroadcast result = do
8168 mxNotify ()
8269 -- Once the publisher has seen our message, it will broadcast the Publish
8370 -- and the consumer will see that and send the result to our typed channel.
84− stash result =<< receiveChanTimeout 10000000 resultRP
71+ stash result =<< receiveChan resultRP
8572
86− kill publisher "finished"
87− kill consumer "finished"
73+ kill publisher "finished" >> awaitExit publisher
74+ kill consumer "finished" >> awaitExit consumer
8875
8976testAgentDualInput :: TestResult (Maybe Int) -> Process ()
9077testAgentDualInput result = do
@@ -99,8 +86,6 @@ testAgentDualInput result = do
9986 else mxReady)
10087 ]
10188
102− mRef <- monitor s
103−
10489 mxNotify (1 :: Int)
10590 nsend "sum-agent" (3 :: Int)
10691 mxNotify (2 :: Int)
@@ -108,10 +93,7 @@ testAgentDualInput result = do
10893 mxNotify (5 :: Int)
10994
11095 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)
96+ awaitExit s
11597
11698testAgentPrioritisation :: TestResult [String] -> Process ()
11799testAgentPrioritisation result = do
@@ -125,10 +107,10 @@ testAgentPrioritisation result = do
125107 (sp, rp) <- newChan
126108 s <- mxAgent (MxAgentId name) ["first"] [
127109 mxSink (\(s :: String) -> do
128− mxUpdateLocal (s:)
110+ mxUpdateLocal ((s:))
129111 st <- mxGetLocal
130112 case length st of
131− n | n == 5 -> do liftMX $ sendChan sp (sort st)
113+ n | n == 5 -> do liftMX $ sendChan sp st
132114 mxDeactivate "finished"
133115 _ -> mxReceive -- go to the mailbox
134116 )
@@ -139,7 +121,7 @@ testAgentPrioritisation result = do
139121 mxNotify "fourth"
140122 nsend name "fifth"
141123
142− stash result . fromMaybe [] =<< receiveChanTimeout 10000000 rp
124+ stash result . sort =<< receiveChan rp
143125 awaitExit s
144126
145127testAgentMailboxHandling :: TestResult (Maybe ()) -> Process ()
@@ -152,19 +134,12 @@ testAgentMailboxHandling result = do
152134 nsend "mailbox-agent" ()
153135
154136 stash result =<< receiveChanTimeout 1000000 rp
155− kill agent "finished"
137+ kill agent "finished" >> awaitExit agent
156138
157139testAgentEventHandling :: TestResult Bool -> Process ()
158140testAgentEventHandling 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−
167141 let initState = [] :: [MxEvent]
142+
168143 (rc, rs) <- newChan
169144 agentPid <- mxAgent (MxAgentId "lifecycle-listener-agent") initState [
170145 (mxSink $ \ev -> do
@@ -197,7 +172,8 @@ testAgentEventHandling result = do
197172 -- TODO: yes, this is racy, but we're at the mercy of the scheduler here...
198173 faff 2000000 rs
199174
200− (sp, rp) <- newChan :: Process (SendPort (), ReceivePort ())
175+ _ <- monitor agentPid
176+ (sp, rp) <- newChan
201177
202178 pid <- spawnLocal $ expect >>= sendChan sp
203179
@@ -206,11 +182,9 @@ testAgentEventHandling result = do
206182 monitor pid
207183
208184 send pid ()
209− rct <- receiveChanTimeout 10000000 rp
210− unless (isJust rct) $ die "No response on channel"
185+ () <- receiveChan rp
211186
212− pmn <- receiveTimeout 2000000 [ match (\ProcessMonitorNotification{} -> return ()) ]
213− unless (isJust pmn) $ die "No monitor notification arrived"
187+ receiveWait [ match (\(ProcessMonitorNotification _ _ _) -> return ()) ]
214188
215189 -- TODO: yes, this is racy, but we're at the mercy of the scheduler here...
216190 faff 2000000 rs
@@ -219,16 +193,17 @@ testAgentEventHandling result = do
219193 mxNotify (MxSpawned pid, replyTo)
220194 mxNotify (MxProcessDied pid DiedNormal, replyTo)
221195
222− seenAlive <- receiveChanTimeout 10000000 reply
223− seenDead <- receiveChanTimeout 10000000 reply
196+ seenAlive <- receiveChan reply
197+ seenDead <- receiveChan reply
224198
225− stash result $ foldr (&&) True $ catMaybes [seenAlive, seenDead]
226− kill timer "test-complete"
227− kill agentPid "test-complete"
199+ stash result $ seenAlive && seenDead
200+ kill agentPid "test-complete" >> awaitExit agentPid
228201 where
229202 faff delay port = do
230203 res <- receiveChanTimeout delay port
231− unless (isNothing res) $ pause delay
204+ unless (isNothing res) $ do
205+ pause delay
206+ faff delay port
232207
233208testMxRegEvents :: TestResult () -> Process ()
234209testMxRegEvents result = do
@@ -275,6 +250,7 @@ testMxRegEvents result = do
275250 reg3 `shouldBe` equalTo (Just (label, p1))
276251
277252 mapM_ (flip kill $ "test-complete") [agent, p1, p2]
253+ awaitExit agent
278254
279255testMxRegMon :: LocalNode -> TestResult () -> Process ()
280256testMxRegMon remoteNode result = do
@@ -332,211 +308,48 @@ testMxRegMon remoteNode result = do
332308 evts `shouldContain` (Just (label1, p1))
333309 evts `shouldContain` (Just (label2, p1))
334310
335− kill agent "test-complete"
311+ kill agent "test-complete" >> awaitExit agent
336312
337313ensure :: Process () -> Process () -> Process ()
338314ensure = flip finally
339315
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
356−
357− op label ()
358−
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
364−
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) () [
423− mxSink $ \ev -> do
424− 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
434− _ -> return ()
435− mxReady
436− ]
437−
438− case mNode of
439− Nothing -> void $ spawnLocal (proc sp)
440− Just remoteNode -> void $ liftIO $ forkProcess remoteNode $ proc sp
441−
442− p1 <- receiveChanTimeout 2000000 rp
443− unless (isJust p1) $ die "Timed out waiting for ProcessId"
444− res <- try $ test (fromJust p1) sink
445−
446− kill agent "bye"
447− kill (fromJust p1) "bye"
448−
449− case res of
450− Left (ProcessExitException _ m) -> (liftIO $ putStrLn $ "SomeException-" ++ show m) >> die m
451− Right tr -> tr `shouldBe` equalTo True
452−
453−
454− where
455− agentLabel s = "mx-unsafe-check-agent-" ++ show s
456− proc sp' = getSelfPid >>= sendChan sp' >> go Nothing
457−
458− go :: Maybe (ReceivePort ()) -> Process ()
459− go Nothing = receiveTimeout 5000000 [ match replyChannel ] >>= go
460− go c@(Just c') = receiveWait [ matchChan c' return ] >> go c
461−
462− replyChannel p' = do
463− (s, r) <- newChan
464− send p' s
465− return r
466−
467316tests :: TestTransport -> IO [Test]
468317tests TestTransport{..} = do
469318 node1 <- newLocalNode testTransport initRemoteTable
470319 node2 <- newLocalNode testTransport initRemoteTable
471320 return [
472− testGroup "MxAgents" [
473− testCase "EventHandling"
321+ testGroup "Mx Agents" [
322+ testCase "Event Handling"
474323 (delayedAssertion
475324 "expected True, but events where not as expected"
476325 node1 True testAgentEventHandling)
477− , testCase "InterAgentBroadcast"
326+ , testCase "Inter-Agent Broadcast"
478327 (delayedAssertion
479328 "expected (), but no broadcast was received"
480− node1 (Just ()) testAgentBroadcast)
481− , testCase "AgentMailboxHandling"
329+ node1 () testAgentBroadcast)
330+ , testCase "Agent Mailbox Handling"
482331 (delayedAssertion
483332 "expected (Just ()), but no regular (mailbox) input was handled"
484333 node1 (Just ()) testAgentMailboxHandling)
485− , testCase "AgentDualInputHandling"
334+ , testCase "Agent Dual Input Handling"
486335 (delayedAssertion
487336 "expected sum = 15, but the result was Nothing"
488337 node1 (Just 15 :: Maybe Int) testAgentDualInput)
489− , testCase "AgentInputPrioritisation"
338+ , testCase "Agent Input Prioritisation"
490339 (delayedAssertion
491340 "expected [first, second, third, fourth, fifth], but result diverged"
492341 node1 (sort ["first", "second",
493342 "third", "fourth",
494343 "fifth"]) testAgentPrioritisation)
495344 ]
496− , testGroup "MxEvents" [
497− testCase "NameRegistrationEvents"
345+ , testGroup "Mx Events" [
346+ testCase "Name Registration Events"
498347 (delayedAssertion
499348 "expected registration events to map to the correct ProcessId"
500349 node1 () testMxRegEvents)
501− , testCase "PostDeathNameUnRegistrationEvents"
350+ , testCase "Post Death Name UnRegistration Events"
502351 (delayedAssertion
503352 "expected process deaths to result in unregistration events"
504353 node1 () (testMxRegMon node2))
505− , testGroup "SendEvents" $ buildTestCases node1 node2
506354 ]
507355 ]
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− ]