@@ -1,11 +1,23 @@
1−{-# LANGUAGE DeriveGeneric #-}
1+{-# LANGUAGE DeriveGeneric #-}
2+{-# LANGUAGE ParallelListComp #-}
2module Control.Distributed.Process.Tests.Mx (tests) where
4module Control.Distributed.Process.Tests.Mx (tests) where
4import Control.Distributed.Process.Tests.Internal.Utils
6import Control.Distributed.Process.Tests.Internal.Utils
5import Network.Transport.Test (TestTransport(..))
7import Network.Transport.Test (TestTransport(..))
6−
8+import Control.Distributed.Process hiding (bracket, finally, try)
7−import Control.Distributed.Process
9+import Control.Distributed.Process.Internal.Types
10+ ( ProcessExitException(..)
11+ , unsafeCreateUnencodedMessage
8import Control.Distributed.Process.Node
13import Control.Distributed.Process.Node
14+import qualified Control.Distributed.Process.UnsafePrimitives as Unsafe
9import Control.Distributed.Process.Management
21import Control.Distributed.Process.Management
10 ( MxEvent(..)
22 ( MxEvent(..)
11 , MxAgentId(..)
23 , MxAgentId(..)
@@ -22,12 +34,13 @@ import Control.Distributed.Process.Management
22 , mxBroadcast
34 , mxBroadcast
24import Control.Monad (void, unless)
36import Control.Monad (void, unless)
37+import Control.Monad.Catch(finally, bracket, try)
25import Control.Rematch (equalTo)
38import Control.Rematch (equalTo)
26import Data.Binary
39import Data.Binary
27−import Data.List (find, sort)
40+import Data.List (find, sort, intercalate)
28−import Data.Maybe (isJust, isNothing)
41+import Data.Maybe (isJust, fromJust, isNothing, fromMaybe, catMaybes)
29import Data.Typeable
42import Data.Typeable
30−import GHC.Generics
43+import GHC.Generics hiding (from)
31#if ! MIN_VERSION_base(4,6,0)
44#if ! MIN_VERSION_base(4,6,0)
32import Prelude hiding (catch, log)
45import Prelude hiding (catch, log)
@@ -51,9 +64,9 @@ awaitExit pid =
51 (\_ -> return ())
64 (\_ -> return ())
54− withMonitorRef pid = bracket (monitor pid) unmonitor
67+ withMonitorRef p = bracket (monitor p) unmonitor
56−testAgentBroadcast :: TestResult () -> Process ()
69+testAgentBroadcast :: TestResult (Maybe ()) -> Process ()
57testAgentBroadcast result = do
70testAgentBroadcast result = do
58 (resultSP, resultRP) <- newChan :: Process (SendPort (), ReceivePort ())
71 (resultSP, resultRP) <- newChan :: Process (SendPort (), ReceivePort ())
@@ -68,10 +81,10 @@ testAgentBroadcast result = do
68 mxNotify ()
81 mxNotify ()
69 -- Once the publisher has seen our message, it will broadcast the Publish
82 -- Once the publisher has seen our message, it will broadcast the Publish
70 -- and the consumer will see that and send the result to our typed channel.
83 -- 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
73− kill publisher "finished" >> awaitExit publisher
86+ kill publisher "finished"
74− kill consumer "finished" >> awaitExit consumer
87+ kill consumer "finished"
76testAgentDualInput :: TestResult (Maybe Int) -> Process ()
89testAgentDualInput :: TestResult (Maybe Int) -> Process ()
77testAgentDualInput result = do
90testAgentDualInput result = do
@@ -86,6 +99,8 @@ testAgentDualInput result = do
86 else mxReady)
99 else mxReady)
89 mxNotify (1 :: Int)
104 mxNotify (1 :: Int)
90 nsend "sum-agent" (3 :: Int)
105 nsend "sum-agent" (3 :: Int)
91 mxNotify (2 :: Int)
106 mxNotify (2 :: Int)
@@ -93,7 +108,10 @@ testAgentDualInput result = do
93 mxNotify (5 :: Int)
108 mxNotify (5 :: Int)
95 stash result =<< receiveChanTimeout 10000000 rp
110 stash result =<< receiveChanTimeout 10000000 rp
96− awaitExit s
111+ died <- receiveTimeout 10000000 [
112+ matchIf (\(ProcessMonitorNotification r _ _) -> r == mRef) (const $ return True)
114+ died `shouldBe` equalTo (Just True)
98testAgentPrioritisation :: TestResult [String] -> Process ()
116testAgentPrioritisation :: TestResult [String] -> Process ()
99testAgentPrioritisation result = do
117testAgentPrioritisation result = do
@@ -107,10 +125,10 @@ testAgentPrioritisation result = do
107 (sp, rp) <- newChan
125 (sp, rp) <- newChan
108 s <- mxAgent (MxAgentId name) ["first"] [
126 s <- mxAgent (MxAgentId name) ["first"] [
109 mxSink (\(s :: String) -> do
127 mxSink (\(s :: String) -> do
110− mxUpdateLocal ((s:))
128+ mxUpdateLocal (s:)
111 st <- mxGetLocal
129 st <- mxGetLocal
112 case length st of
130 case length st of
113− n | n == 5 -> do liftMX $ sendChan sp st
131+ n | n == 5 -> do liftMX $ sendChan sp (sort st)
114 mxDeactivate "finished"
132 mxDeactivate "finished"
115 _ -> mxReceive -- go to the mailbox
133 _ -> mxReceive -- go to the mailbox
@@ -121,7 +139,7 @@ testAgentPrioritisation result = do
121 mxNotify "fourth"
139 mxNotify "fourth"
122 nsend name "fifth"
140 nsend name "fifth"
124− stash result . sort =<< receiveChan rp
142+ stash result . fromMaybe [] =<< receiveChanTimeout 10000000 rp
125 awaitExit s
143 awaitExit s
127testAgentMailboxHandling :: TestResult (Maybe ()) -> Process ()
145testAgentMailboxHandling :: TestResult (Maybe ()) -> Process ()
@@ -134,12 +152,19 @@ testAgentMailboxHandling result = do
134 nsend "mailbox-agent" ()
152 nsend "mailbox-agent" ()
136 stash result =<< receiveChanTimeout 1000000 rp
154 stash result =<< receiveChanTimeout 1000000 rp
137− kill agent "finished" >> awaitExit agent
155+ kill agent "finished"
139testAgentEventHandling :: TestResult Bool -> Process ()
157testAgentEventHandling :: TestResult Bool -> Process ()
140testAgentEventHandling result = do
158testAgentEventHandling 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...
165+ kill us "Test Timed Out"
167+ let initState = [] :: [MxEvent]
143 (rc, rs) <- newChan
168 (rc, rs) <- newChan
144 agentPid <- mxAgent (MxAgentId "lifecycle-listener-agent") initState [
169 agentPid <- mxAgent (MxAgentId "lifecycle-listener-agent") initState [
145 (mxSink $ \ev -> do
170 (mxSink $ \ev -> do
@@ -172,8 +197,7 @@ testAgentEventHandling result = do
172 -- TODO: yes, this is racy, but we're at the mercy of the scheduler here...
197 -- TODO: yes, this is racy, but we're at the mercy of the scheduler here...
173 faff 2000000 rs
198 faff 2000000 rs
175− _ <- monitor agentPid
176− (sp, rp) <- newChan
200+ (sp, rp) <- newChan :: Process (SendPort (), ReceivePort ())
178 pid <- spawnLocal $ expect >>= sendChan sp
202 pid <- spawnLocal $ expect >>= sendChan sp
@@ -182,9 +206,11 @@ testAgentEventHandling result = do
182 monitor pid
206 monitor pid
184 send pid ()
208 send pid ()
185− () <- receiveChan rp
209+ rct <- receiveChanTimeout 10000000 rp
210+ unless (isJust rct) $ die "No response on channel"
187− receiveWait [ match (\(ProcessMonitorNotification _ _ _) -> return ()) ]
212+ pmn <- receiveTimeout 2000000 [ match (\ProcessMonitorNotification{} -> return ()) ]
213+ unless (isJust pmn) $ die "No monitor notification arrived"
189 -- TODO: yes, this is racy, but we're at the mercy of the scheduler here...
215 -- TODO: yes, this is racy, but we're at the mercy of the scheduler here...
190 faff 2000000 rs
216 faff 2000000 rs
@@ -193,17 +219,16 @@ testAgentEventHandling result = do
193 mxNotify (MxSpawned pid, replyTo)
219 mxNotify (MxSpawned pid, replyTo)
194 mxNotify (MxProcessDied pid DiedNormal, replyTo)
220 mxNotify (MxProcessDied pid DiedNormal, replyTo)
196− seenAlive <- receiveChan reply
222+ seenAlive <- receiveChanTimeout 10000000 reply
197− seenDead <- receiveChan reply
223+ seenDead <- receiveChanTimeout 10000000 reply
199− stash result $ seenAlive && seenDead
225+ stash result $ foldr (&&) True $ catMaybes [seenAlive, seenDead]
200− kill agentPid "test-complete" >> awaitExit agentPid
226+ kill timer "test-complete"
227+ kill agentPid "test-complete"
202 faff delay port = do
229 faff delay port = do
203 res <- receiveChanTimeout delay port
230 res <- receiveChanTimeout delay port
204− unless (isNothing res) $ do
231+ unless (isNothing res) $ pause delay
208testMxRegEvents :: TestResult () -> Process ()
233testMxRegEvents :: TestResult () -> Process ()
209testMxRegEvents result = do
234testMxRegEvents result = do
@@ -250,7 +275,6 @@ testMxRegEvents result = do
250 reg3 `shouldBe` equalTo (Just (label, p1))
275 reg3 `shouldBe` equalTo (Just (label, p1))
252 mapM_ (flip kill $ "test-complete") [agent, p1, p2]
277 mapM_ (flip kill $ "test-complete") [agent, p1, p2]
255testMxRegMon :: LocalNode -> TestResult () -> Process ()
279testMxRegMon :: LocalNode -> TestResult () -> Process ()
256testMxRegMon remoteNode result = do
280testMxRegMon remoteNode result = do
@@ -308,48 +332,211 @@ testMxRegMon remoteNode result = do
308 evts `shouldContain` (Just (label1, p1))
332 evts `shouldContain` (Just (label1, p1))
309 evts `shouldContain` (Just (label2, p1))
333 evts `shouldContain` (Just (label2, p1))
311− kill agent "test-complete" >> awaitExit agent
335+ kill agent "test-complete"
313ensure :: Process () -> Process () -> Process ()
337ensure :: Process () -> Process () -> Process ()
314ensure = flip finally
338ensure = flip finally
340+testNSend :: (String -> () -> Process ())
346+ let label = "testMxSend" ++ (show us)
347+ let isValid = isValidLabel n label
349+ testMxSend n label $ \p1 sink -> do
351+ reg1 <- receiveChanTimeout delay sink
353+ Just (MxRegistered pd lb)
354+ | pd == p1 && isValid lb -> return ()
355+ _ -> die $ "Reg-Failed: " ++ show reg1
359+ sent <- receiveChanTimeout delay sink
361+ Just (MxSentToName lb by _)
362+ | by == us && isValid lb -> return True
363+ _ -> die $ "Send-Failed: " ++ show sent
366+ isValidLabel nd l1 l2
368+ | isJust nd = l2 == l1 ++ "@" ++ show (localNodeId $ fromJust nd)
371+testSend :: (ProcessId -> () -> Process ())
376+ let label = "testMxSend" ++ (show us)
377+ testMxSend n label $ \p1 sink -> do
381+ -- verify the management event
382+ sent <- receiveChanTimeout 5000000 sink
384+ Just (MxSent pidTo pidFrom _)
385+ | pidTo == p1 && pidFrom == us -> return True
388+testChan :: (SendPort () -> () -> Process ())
391+testChan op n = testMxSend n "" $ \p1 sink -> do
396+ cleared <- receiveChanTimeout 2000000 sink
398+ Just (MxSent pidTo pidFrom _)
399+ | pidTo == p1 && pidFrom == us -> return ()
400+ _ -> die "Received uncleared Mx Event"
402+ chan <- receiveTimeout 5000000 [ match return ]
403+ let ch' = fromMaybe (error "No reply chan received") chan
408+ -- verify the management event
409+ sent <- receiveChanTimeout 5000000 sink
411+ Just (MxSentToPort sId spId _)
412+ | sId == us && spId == sendPortId ch' -> return True
415+type SendTest = ProcessId -> ReceivePort MxEvent -> Process Bool
417+testMxSend :: Maybe LocalNode -> String -> SendTest -> Process ()
418+testMxSend mNode label test = do
421+ (chan, sink) <- newChan
422+ agent <- mxAgent (MxAgentId $ agentLabel us) () [
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
439+ Nothing -> void $ spawnLocal (proc sp)
440+ Just remoteNode -> void $ liftIO $ forkProcess remoteNode $ proc sp
442+ p1 <- receiveChanTimeout 2000000 rp
443+ unless (isJust p1) $ die "Timed out waiting for ProcessId"
444+ res <- try $ test (fromJust p1) sink
447+ kill (fromJust p1) "bye"
450+ Left (ProcessExitException _ m) -> (liftIO $ putStrLn $ "SomeException-" ++ show m) >> die m
451+ Right tr -> tr `shouldBe` equalTo True
455+ agentLabel s = "mx-unsafe-check-agent-" ++ show s
456+ proc sp' = getSelfPid >>= sendChan sp' >> go Nothing
458+ go :: Maybe (ReceivePort ()) -> Process ()
459+ go Nothing = receiveTimeout 5000000 [ match replyChannel ] >>= go
460+ go c@(Just c') = receiveWait [ matchChan c' return ] >> go c
462+ replyChannel p' = do
316tests :: TestTransport -> IO [Test]
467tests :: TestTransport -> IO [Test]
317tests TestTransport{..} = do
468tests TestTransport{..} = do
318 node1 <- newLocalNode testTransport initRemoteTable
469 node1 <- newLocalNode testTransport initRemoteTable
319 node2 <- newLocalNode testTransport initRemoteTable
470 node2 <- newLocalNode testTransport initRemoteTable
321− testGroup "Mx Agents" [
472+ testGroup "MxAgents" [
322− testCase "Event Handling"
473+ testCase "EventHandling"
323 (delayedAssertion
474 (delayedAssertion
324 "expected True, but events where not as expected"
475 "expected True, but events where not as expected"
325 node1 True testAgentEventHandling)
476 node1 True testAgentEventHandling)
326− , testCase "Inter-Agent Broadcast"
477+ , testCase "InterAgentBroadcast"
327 (delayedAssertion
478 (delayedAssertion
328 "expected (), but no broadcast was received"
479 "expected (), but no broadcast was received"
329− node1 () testAgentBroadcast)
480+ node1 (Just ()) testAgentBroadcast)
330− , testCase "Agent Mailbox Handling"
481+ , testCase "AgentMailboxHandling"
331 (delayedAssertion
482 (delayedAssertion
332 "expected (Just ()), but no regular (mailbox) input was handled"
483 "expected (Just ()), but no regular (mailbox) input was handled"
333 node1 (Just ()) testAgentMailboxHandling)
484 node1 (Just ()) testAgentMailboxHandling)
334− , testCase "Agent Dual Input Handling"
485+ , testCase "AgentDualInputHandling"
335 (delayedAssertion
486 (delayedAssertion
336 "expected sum = 15, but the result was Nothing"
487 "expected sum = 15, but the result was Nothing"
337 node1 (Just 15 :: Maybe Int) testAgentDualInput)
488 node1 (Just 15 :: Maybe Int) testAgentDualInput)
338− , testCase "Agent Input Prioritisation"
489+ , testCase "AgentInputPrioritisation"
339 (delayedAssertion
490 (delayedAssertion
340 "expected [first, second, third, fourth, fifth], but result diverged"
491 "expected [first, second, third, fourth, fifth], but result diverged"
341 node1 (sort ["first", "second",
492 node1 (sort ["first", "second",
342 "third", "fourth",
493 "third", "fourth",
343 "fifth"]) testAgentPrioritisation)
494 "fifth"]) testAgentPrioritisation)
345− , testGroup "Mx Events" [
496+ , testGroup "MxEvents" [
346− testCase "Name Registration Events"
497+ testCase "NameRegistrationEvents"
347 (delayedAssertion
498 (delayedAssertion
348 "expected registration events to map to the correct ProcessId"
499 "expected registration events to map to the correct ProcessId"
349 node1 () testMxRegEvents)
500 node1 () testMxRegEvents)
350− , testCase "Post Death Name UnRegistration Events"
501+ , testCase "PostDeathNameUnRegistrationEvents"
351 (delayedAssertion
502 (delayedAssertion
352 "expected process deaths to result in unregistration events"
503 "expected process deaths to result in unregistration events"
353 node1 () (testMxRegMon node2))
504 node1 () (testMxRegMon node2))
505+ , testGroup "SendEvents" $ buildTestCases node1 node2
509+ buildTestCases n1 n2 = let nid = localNodeId n2 in build n1 n2 [
511+ ("nsend", testNSend nsend)
512+ , ("Unsafe.nsend", testNSend Unsafe.nsend)
513+ , ("nsendRemote", testNSend (nsendRemote nid))
514+ , ("Unsafe.nsendRemote", testNSend (Unsafe.nsendRemote nid))
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)
525+ ("forward", testSend (\p m -> forward (unsafeCreateUnencodedMessage m) p))
526+ , ("uforward", testSend (\p m -> uforward (unsafeCreateUnencodedMessage m) p))
532+ -> [(String, [(String, (Maybe LocalNode -> Process ()))])]
535+ [ testGroup (intercalate "-" [groupName, caseSuffix]) [
536+ testCase (intercalate "-" [caseName, caseSuffix])
537+ (runProcess n (caseImpl caseNode))
538+ | (caseName, caseImpl) <- groupCases
540+ | (groupName, groupCases) <- specs
541+ , (caseSuffix, caseNode) <- [("RemotePid", Just ln), ("LocalPid", Nothing)]