@@ -1,11 +1,23 @@
1−{-# LANGUAGE DeriveGeneric #-}
1+{-# LANGUAGE DeriveGeneric #-}
2+{-# LANGUAGE ParallelListComp #-}
3+
24module Control.Distributed.Process.Tests.Mx (tests) where
35
46import Control.Distributed.Process.Tests.Internal.Utils
57import Network.Transport.Test (TestTransport(..))
6−
7−import Control.Distributed.Process
8+import Control.Distributed.Process hiding (bracket, finally, try)
9+import Control.Distributed.Process.Internal.Types
10+ ( ProcessExitException(..)
11+ , unsafeCreateUnencodedMessage
12+ )
813import Control.Distributed.Process.Node
14+import qualified Control.Distributed.Process.UnsafePrimitives as Unsafe
15+ ( send
16+ , nsend
17+ , nsendRemote
18+ , usend
19+ , sendChan
20+ )
921import Control.Distributed.Process.Management
1022 ( MxEvent(..)
1123 , MxAgentId(..)
@@ -22,12 +34,13 @@ import Control.Distributed.Process.Management
2234 , mxBroadcast
2335 )
2436import Control.Monad (void, unless)
37+import Control.Monad.Catch(finally, bracket, try)
2538import Control.Rematch (equalTo)
2639import Data.Binary
27−import Data.List (find, sort)
28−import Data.Maybe (isJust, isNothing)
40+import Data.List (find, sort, intercalate)
41+import Data.Maybe (isJust, fromJust, isNothing, fromMaybe, catMaybes)
2942import Data.Typeable
30−import GHC.Generics
43+import GHC.Generics hiding (from)
3144#if ! MIN_VERSION_base(4,6,0)
3245import Prelude hiding (catch, log)
3346#endif
@@ -51,9 +64,9 @@ awaitExit pid =
5164 (\_ -> return ())
5265 ]
5366 where
54− withMonitorRef pid = bracket (monitor pid) unmonitor
67+ withMonitorRef p = bracket (monitor p) unmonitor
5568
56−testAgentBroadcast :: TestResult () -> Process ()
69+testAgentBroadcast :: TestResult (Maybe ()) -> Process ()
5770testAgentBroadcast result = do
5871 (resultSP, resultRP) <- newChan :: Process (SendPort (), ReceivePort ())
5972
@@ -68,10 +81,10 @@ testAgentBroadcast result = do
6881 mxNotify ()
6982 -- Once the publisher has seen our message, it will broadcast the Publish
7083 -- and the consumer will see that and send the result to our typed channel.
71− stash result =<< receiveChan resultRP
84+ stash result =<< receiveChanTimeout 10000000 resultRP
7285
73− kill publisher "finished" >> awaitExit publisher
74− kill consumer "finished" >> awaitExit consumer
86+ kill publisher "finished"
87+ kill consumer "finished"
7588
7689testAgentDualInput :: TestResult (Maybe Int) -> Process ()
7790testAgentDualInput result = do
@@ -86,6 +99,8 @@ testAgentDualInput result = do
8699 else mxReady)
87100 ]
88101
102+ mRef <- monitor s
103+
89104 mxNotify (1 :: Int)
90105 nsend "sum-agent" (3 :: Int)
91106 mxNotify (2 :: Int)
@@ -93,7 +108,10 @@ testAgentDualInput result = do
93108 mxNotify (5 :: Int)
94109
95110 stash result =<< receiveChanTimeout 10000000 rp
96− awaitExit s
111+ died <- receiveTimeout 10000000 [
112+ matchIf (\(ProcessMonitorNotification r _ _) -> r == mRef) (const $ return True)
113+ ]
114+ died `shouldBe` equalTo (Just True)
97115
98116testAgentPrioritisation :: TestResult [String] -> Process ()
99117testAgentPrioritisation result = do
@@ -107,10 +125,10 @@ testAgentPrioritisation result = do
107125 (sp, rp) <- newChan
108126 s <- mxAgent (MxAgentId name) ["first"] [
109127 mxSink (\(s :: String) -> do
110− mxUpdateLocal ((s:))
128+ mxUpdateLocal (s:)
111129 st <- mxGetLocal
112130 case length st of
113− n | n == 5 -> do liftMX $ sendChan sp st
131+ n | n == 5 -> do liftMX $ sendChan sp (sort st)
114132 mxDeactivate "finished"
115133 _ -> mxReceive -- go to the mailbox
116134 )
@@ -121,7 +139,7 @@ testAgentPrioritisation result = do
121139 mxNotify "fourth"
122140 nsend name "fifth"
123141
124− stash result . sort =<< receiveChan rp
142+ stash result . fromMaybe [] =<< receiveChanTimeout 10000000 rp
125143 awaitExit s
126144
127145testAgentMailboxHandling :: TestResult (Maybe ()) -> Process ()
@@ -134,12 +152,19 @@ testAgentMailboxHandling result = do
134152 nsend "mailbox-agent" ()
135153
136154 stash result =<< receiveChanTimeout 1000000 rp
137− kill agent "finished" >> awaitExit agent
155+ kill agent "finished"
138156
139157testAgentEventHandling :: TestResult Bool -> Process ()
140158testAgentEventHandling result = do
141− let initState = [] :: [MxEvent]
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"
142166
167+ let initState = [] :: [MxEvent]
143168 (rc, rs) <- newChan
144169 agentPid <- mxAgent (MxAgentId "lifecycle-listener-agent") initState [
145170 (mxSink $ \ev -> do
@@ -172,8 +197,7 @@ testAgentEventHandling result = do
172197 -- TODO: yes, this is racy, but we're at the mercy of the scheduler here...
173198 faff 2000000 rs
174199
175− _ <- monitor agentPid
176− (sp, rp) <- newChan
200+ (sp, rp) <- newChan :: Process (SendPort (), ReceivePort ())
177201
178202 pid <- spawnLocal $ expect >>= sendChan sp
179203
@@ -182,9 +206,11 @@ testAgentEventHandling result = do
182206 monitor pid
183207
184208 send pid ()
185− () <- receiveChan rp
209+ rct <- receiveChanTimeout 10000000 rp
210+ unless (isJust rct) $ die "No response on channel"
186211
187− receiveWait [ match (\(ProcessMonitorNotification _ _ _) -> return ()) ]
212+ pmn <- receiveTimeout 2000000 [ match (\ProcessMonitorNotification{} -> return ()) ]
213+ unless (isJust pmn) $ die "No monitor notification arrived"
188214
189215 -- TODO: yes, this is racy, but we're at the mercy of the scheduler here...
190216 faff 2000000 rs
@@ -193,17 +219,16 @@ testAgentEventHandling result = do
193219 mxNotify (MxSpawned pid, replyTo)
194220 mxNotify (MxProcessDied pid DiedNormal, replyTo)
195221
196− seenAlive <- receiveChan reply
197− seenDead <- receiveChan reply
222+ seenAlive <- receiveChanTimeout 10000000 reply
223+ seenDead <- receiveChanTimeout 10000000 reply
198224
199− stash result $ seenAlive && seenDead
200− kill agentPid "test-complete" >> awaitExit agentPid
225+ stash result $ foldr (&&) True $ catMaybes [seenAlive, seenDead]
226+ kill timer "test-complete"
227+ kill agentPid "test-complete"
201228 where
202229 faff delay port = do
203230 res <- receiveChanTimeout delay port
204− unless (isNothing res) $ do
205− pause delay
206− faff delay port
231+ unless (isNothing res) $ pause delay
207232
208233testMxRegEvents :: TestResult () -> Process ()
209234testMxRegEvents result = do
@@ -250,7 +275,6 @@ testMxRegEvents result = do
250275 reg3 `shouldBe` equalTo (Just (label, p1))
251276
252277 mapM_ (flip kill $ "test-complete") [agent, p1, p2]
253− awaitExit agent
254278
255279testMxRegMon :: LocalNode -> TestResult () -> Process ()
256280testMxRegMon remoteNode result = do
@@ -308,48 +332,211 @@ testMxRegMon remoteNode result = do
308332 evts `shouldContain` (Just (label1, p1))
309333 evts `shouldContain` (Just (label2, p1))
310334
311− kill agent "test-complete" >> awaitExit agent
335+ kill agent "test-complete"
312336
313337ensure :: Process () -> Process () -> Process ()
314338ensure = flip finally
315339
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+
316467tests :: TestTransport -> IO [Test]
317468tests TestTransport{..} = do
318469 node1 <- newLocalNode testTransport initRemoteTable
319470 node2 <- newLocalNode testTransport initRemoteTable
320471 return [
321− testGroup "Mx Agents" [
322− testCase "Event Handling"
472+ testGroup "MxAgents" [
473+ testCase "EventHandling"
323474 (delayedAssertion
324475 "expected True, but events where not as expected"
325476 node1 True testAgentEventHandling)
326− , testCase "Inter-Agent Broadcast"
477+ , testCase "InterAgentBroadcast"
327478 (delayedAssertion
328479 "expected (), but no broadcast was received"
329− node1 () testAgentBroadcast)
330− , testCase "Agent Mailbox Handling"
480+ node1 (Just ()) testAgentBroadcast)
481+ , testCase "AgentMailboxHandling"
331482 (delayedAssertion
332483 "expected (Just ()), but no regular (mailbox) input was handled"
333484 node1 (Just ()) testAgentMailboxHandling)
334− , testCase "Agent Dual Input Handling"
485+ , testCase "AgentDualInputHandling"
335486 (delayedAssertion
336487 "expected sum = 15, but the result was Nothing"
337488 node1 (Just 15 :: Maybe Int) testAgentDualInput)
338− , testCase "Agent Input Prioritisation"
489+ , testCase "AgentInputPrioritisation"
339490 (delayedAssertion
340491 "expected [first, second, third, fourth, fifth], but result diverged"
341492 node1 (sort ["first", "second",
342493 "third", "fourth",
343494 "fifth"]) testAgentPrioritisation)
344495 ]
345− , testGroup "Mx Events" [
346− testCase "Name Registration Events"
496+ , testGroup "MxEvents" [
497+ testCase "NameRegistrationEvents"
347498 (delayedAssertion
348499 "expected registration events to map to the correct ProcessId"
349500 node1 () testMxRegEvents)
350− , testCase "Post Death Name UnRegistration Events"
501+ , testCase "PostDeathNameUnRegistrationEvents"
351502 (delayedAssertion
352503 "expected process deaths to result in unregistration events"
353504 node1 () (testMxRegMon node2))
505+ , testGroup "SendEvents" $ buildTestCases node1 node2
354506 ]
355507 ]
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+ ]