@@ -1,17 +1,22 @@
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−import Control.Exception (SomeException)
7import Control.Distributed.Process hiding (bracket, finally, try)
8import Control.Distributed.Process hiding (bracket, finally, try)
8−import Control.Distributed.Process.Internal.Types (ProcessExitException(..))
9+import Control.Distributed.Process.Internal.Types
10+ ( ProcessExitException(..)
11+ , unsafeCreateUnencodedMessage
9import Control.Distributed.Process.Node
13import Control.Distributed.Process.Node
10import qualified Control.Distributed.Process.UnsafePrimitives as Unsafe
14import qualified Control.Distributed.Process.UnsafePrimitives as Unsafe
13 , nsendRemote
17 , nsendRemote
16import Control.Distributed.Process.Management
21import Control.Distributed.Process.Management
17 ( MxEvent(..)
22 ( MxEvent(..)
@@ -32,8 +37,8 @@ import Control.Monad (void, unless)
32import Control.Monad.Catch(finally, bracket, try)
37import Control.Monad.Catch(finally, bracket, try)
33import Control.Rematch (equalTo)
38import Control.Rematch (equalTo)
34import Data.Binary
39import Data.Binary
35−import Data.List (find, sort)
40+import Data.List (find, sort, intercalate)
36−import Data.Maybe (isJust, fromJust, isNothing)
41+import Data.Maybe (isJust, fromJust, isNothing, fromMaybe, catMaybes)
37import Data.Typeable
42import Data.Typeable
38import GHC.Generics hiding (from)
43import GHC.Generics hiding (from)
39#if ! MIN_VERSION_base(4,6,0)
44#if ! MIN_VERSION_base(4,6,0)
@@ -61,7 +66,7 @@ awaitExit pid =
62 withMonitorRef p = bracket (monitor p) unmonitor
67 withMonitorRef p = bracket (monitor p) unmonitor
64−testAgentBroadcast :: TestResult () -> Process ()
69+testAgentBroadcast :: TestResult (Maybe ()) -> Process ()
65testAgentBroadcast result = do
70testAgentBroadcast result = do
66 (resultSP, resultRP) <- newChan :: Process (SendPort (), ReceivePort ())
71 (resultSP, resultRP) <- newChan :: Process (SendPort (), ReceivePort ())
@@ -76,10 +81,10 @@ testAgentBroadcast result = do
76 mxNotify ()
81 mxNotify ()
77 -- 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
78 -- 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.
79− stash result =<< receiveChan resultRP
84+ stash result =<< receiveChanTimeout 10000000 resultRP
81− kill publisher "finished" >> awaitExit publisher
86+ kill publisher "finished"
82− kill consumer "finished" >> awaitExit consumer
87+ kill consumer "finished"
84testAgentDualInput :: TestResult (Maybe Int) -> Process ()
89testAgentDualInput :: TestResult (Maybe Int) -> Process ()
85testAgentDualInput result = do
90testAgentDualInput result = do
@@ -94,6 +99,8 @@ testAgentDualInput result = do
94 else mxReady)
99 else mxReady)
97 mxNotify (1 :: Int)
104 mxNotify (1 :: Int)
98 nsend "sum-agent" (3 :: Int)
105 nsend "sum-agent" (3 :: Int)
99 mxNotify (2 :: Int)
106 mxNotify (2 :: Int)
@@ -101,7 +108,10 @@ testAgentDualInput result = do
101 mxNotify (5 :: Int)
108 mxNotify (5 :: Int)
103 stash result =<< receiveChanTimeout 10000000 rp
110 stash result =<< receiveChanTimeout 10000000 rp
104− awaitExit s
111+ died <- receiveTimeout 10000000 [
112+ matchIf (\(ProcessMonitorNotification r _ _) -> r == mRef) (const $ return True)
114+ died `shouldBe` equalTo (Just True)
106testAgentPrioritisation :: TestResult [String] -> Process ()
116testAgentPrioritisation :: TestResult [String] -> Process ()
107testAgentPrioritisation result = do
117testAgentPrioritisation result = do
@@ -115,10 +125,10 @@ testAgentPrioritisation result = do
115 (sp, rp) <- newChan
125 (sp, rp) <- newChan
116 s <- mxAgent (MxAgentId name) ["first"] [
126 s <- mxAgent (MxAgentId name) ["first"] [
117 mxSink (\(s :: String) -> do
127 mxSink (\(s :: String) -> do
118− mxUpdateLocal ((s:))
128+ mxUpdateLocal (s:)
119 st <- mxGetLocal
129 st <- mxGetLocal
120 case length st of
130 case length st of
121− n | n == 5 -> do liftMX $ sendChan sp st
131+ n | n == 5 -> do liftMX $ sendChan sp (sort st)
122 mxDeactivate "finished"
132 mxDeactivate "finished"
123 _ -> mxReceive -- go to the mailbox
133 _ -> mxReceive -- go to the mailbox
@@ -129,7 +139,7 @@ testAgentPrioritisation result = do
129 mxNotify "fourth"
139 mxNotify "fourth"
130 nsend name "fifth"
140 nsend name "fifth"
132− stash result . sort =<< receiveChan rp
142+ stash result . fromMaybe [] =<< receiveChanTimeout 10000000 rp
133 awaitExit s
143 awaitExit s
135testAgentMailboxHandling :: TestResult (Maybe ()) -> Process ()
145testAgentMailboxHandling :: TestResult (Maybe ()) -> Process ()
@@ -142,12 +152,19 @@ testAgentMailboxHandling result = do
142 nsend "mailbox-agent" ()
152 nsend "mailbox-agent" ()
144 stash result =<< receiveChanTimeout 1000000 rp
154 stash result =<< receiveChanTimeout 1000000 rp
145− kill agent "finished" >> awaitExit agent
155+ kill agent "finished"
147testAgentEventHandling :: TestResult Bool -> Process ()
157testAgentEventHandling :: TestResult Bool -> Process ()
148testAgentEventHandling result = do
158testAgentEventHandling result = do
149− 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]
151 (rc, rs) <- newChan
168 (rc, rs) <- newChan
152 agentPid <- mxAgent (MxAgentId "lifecycle-listener-agent") initState [
169 agentPid <- mxAgent (MxAgentId "lifecycle-listener-agent") initState [
153 (mxSink $ \ev -> do
170 (mxSink $ \ev -> do
@@ -180,8 +197,7 @@ testAgentEventHandling result = do
180 -- 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...
181 faff 2000000 rs
198 faff 2000000 rs
183− _ <- monitor agentPid
184− (sp, rp) <- newChan
200+ (sp, rp) <- newChan :: Process (SendPort (), ReceivePort ())
186 pid <- spawnLocal $ expect >>= sendChan sp
202 pid <- spawnLocal $ expect >>= sendChan sp
@@ -190,9 +206,11 @@ testAgentEventHandling result = do
190 monitor pid
206 monitor pid
192 send pid ()
208 send pid ()
193− () <- receiveChan rp
209+ rct <- receiveChanTimeout 10000000 rp
210+ unless (isJust rct) $ die "No response on channel"
195− receiveWait [ match (\(ProcessMonitorNotification _ _ _) -> return ()) ]
212+ pmn <- receiveTimeout 2000000 [ match (\ProcessMonitorNotification{} -> return ()) ]
213+ unless (isJust pmn) $ die "No monitor notification arrived"
197 -- 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...
198 faff 2000000 rs
216 faff 2000000 rs
@@ -201,17 +219,16 @@ testAgentEventHandling result = do
201 mxNotify (MxSpawned pid, replyTo)
219 mxNotify (MxSpawned pid, replyTo)
202 mxNotify (MxProcessDied pid DiedNormal, replyTo)
220 mxNotify (MxProcessDied pid DiedNormal, replyTo)
204− seenAlive <- receiveChan reply
222+ seenAlive <- receiveChanTimeout 10000000 reply
205− seenDead <- receiveChan reply
223+ seenDead <- receiveChanTimeout 10000000 reply
207− stash result $ seenAlive && seenDead
225+ stash result $ foldr (&&) True $ catMaybes [seenAlive, seenDead]
208− kill agentPid "test-complete" >> awaitExit agentPid
226+ kill timer "test-complete"
227+ kill agentPid "test-complete"
210 faff delay port = do
229 faff delay port = do
211 res <- receiveChanTimeout delay port
230 res <- receiveChanTimeout delay port
212− unless (isNothing res) $ do
231+ unless (isNothing res) $ pause delay
216testMxRegEvents :: TestResult () -> Process ()
233testMxRegEvents :: TestResult () -> Process ()
217testMxRegEvents result = do
234testMxRegEvents result = do
@@ -258,7 +275,6 @@ testMxRegEvents result = do
258 reg3 `shouldBe` equalTo (Just (label, p1))
275 reg3 `shouldBe` equalTo (Just (label, p1))
260 mapM_ (flip kill $ "test-complete") [agent, p1, p2]
277 mapM_ (flip kill $ "test-complete") [agent, p1, p2]
263testMxRegMon :: LocalNode -> TestResult () -> Process ()
279testMxRegMon :: LocalNode -> TestResult () -> Process ()
264testMxRegMon remoteNode result = do
280testMxRegMon remoteNode result = do
@@ -316,64 +332,99 @@ testMxRegMon remoteNode result = do
316 evts `shouldContain` (Just (label1, p1))
332 evts `shouldContain` (Just (label1, p1))
317 evts `shouldContain` (Just (label2, p1))
333 evts `shouldContain` (Just (label2, p1))
319− kill agent "test-complete" >> awaitExit agent
335+ kill agent "test-complete"
321ensure :: Process () -> Process () -> Process ()
337ensure :: Process () -> Process () -> Process ()
322ensure = flip finally
338ensure = flip finally
324−type SendTest = ProcessId -> ReceivePort MxEvent -> Process Bool
326testNSend :: (String -> () -> Process ())
340testNSend :: (String -> () -> Process ())
327 -> Maybe LocalNode
341 -> Maybe LocalNode
329 -> Process ()
342 -> Process ()
330−testNSend op n r = testMxSend n r $ \p1 sink -> do
343+testNSend op n = do
331 let delay = 5000000
345 let delay = 5000000
332− let label = "testMxSend"
346+ let label = "testMxSend" ++ (show us)
333 let isValid = isValidLabel n label
347 let isValid = isValidLabel n label
349+ testMxSend n label $ \p1 sink -> do
335− register label p1
350+ register label p1
336− reg1 <- receiveChanTimeout delay sink
351+ reg1 <- receiveChanTimeout delay sink
337− case reg1 of
352+ case reg1 of
338− Just (MxRegistered pd lb)
353+ Just (MxRegistered pd lb)
339− | pd == p1 && isValid lb -> return ()
354+ | pd == p1 && isValid lb -> return ()
340− _ -> die $ "Reg-Failed: " ++ show reg1
355+ _ -> die $ "Reg-Failed: " ++ show reg1
342− op label ()
357+ op label ()
345− sent <- receiveChanTimeout delay sink
359+ sent <- receiveChanTimeout delay sink
346− case sent of
360+ case sent of
347− Just (MxSentToName lb by _)
361+ Just (MxSentToName lb by _)
348− | by == us && isValid lb -> return True
362+ | by == us && isValid lb -> return True
349− _ -> die $ "Send-Failed: " ++ show sent
363+ _ -> die $ "Send-Failed: " ++ show sent
352− isValidLabel n l1 l2
366+ isValidLabel nd l1 l2
353 | l2 == l2 = True
367 | l2 == l2 = True
354− | isJust n = l2 == l1 ++ "@" ++ show (localNodeId $ fromJust n)
368+ | isJust nd = l2 == l1 ++ "@" ++ show (localNodeId $ fromJust nd)
355 | otherwise = False
369 | otherwise = False
357−testSend :: (ProcessId -> () -> Process ()) -> Maybe LocalNode -> TestResult Bool -> Process ()
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 ())
358−testSend op n r = testMxSend n r $ \p1 sink -> do
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
359 -- initiate a send
405 -- initiate a send
360− op p1 ()
406+ op ch' ()
362 -- verify the management event
408 -- verify the management event
364 sent <- receiveChanTimeout 5000000 sink
409 sent <- receiveChanTimeout 5000000 sink
365 case sent of
410 case sent of
366− Just (MxSent pidTo pidFrom _)
411+ Just (MxSentToPort sId spId _)
367− | pidTo == p1 && pidFrom == us -> return True
412+ | sId == us && spId == sendPortId ch' -> return True
368− _ -> return False
413+ _ -> return False
415+type SendTest = ProcessId -> ReceivePort MxEvent -> Process Bool
370−testMxSend :: Maybe LocalNode -> TestResult Bool -> SendTest -> Process ()
417+testMxSend :: Maybe LocalNode -> String -> SendTest -> Process ()
371−testMxSend mNode result test = do
418+testMxSend mNode label test = do
372 us <- getSelfPid
419 us <- getSelfPid
373 (chan, sink) <- newChan
421 (chan, sink) <- newChan
374 agent <- mxAgent (MxAgentId $ agentLabel us) () [
422 agent <- mxAgent (MxAgentId $ agentLabel us) () [
375 mxSink $ \ev -> do
423 mxSink $ \ev -> do
376 case ev of
424 case ev of
425+ m@(MxSentToPort _ cid _)
426+ | cid /= sendPortId chan
427+ && cid /= sendPortId sp -> liftMX $ sendChan chan m
377 m@(MxSent _ fromPid _)
428 m@(MxSent _ fromPid _)
378 | fromPid == us -> liftMX $ sendChan chan m
429 | fromPid == us -> liftMX $ sendChan chan m
379 m@(MxSentToName _ fromPid _)
430 m@(MxSentToName _ fromPid _)
@@ -384,29 +435,39 @@ testMxSend mNode result test = do
388 case mNode of
438 case mNode of
389 Nothing -> void $ spawnLocal (proc sp)
439 Nothing -> void $ spawnLocal (proc sp)
390 Just remoteNode -> void $ liftIO $ forkProcess remoteNode $ proc sp
440 Just remoteNode -> void $ liftIO $ forkProcess remoteNode $ proc sp
392− p1 <- receiveChan rp
442+ p1 <- receiveChanTimeout 2000000 rp
443+ unless (isJust p1) $ die "Timed out waiting for ProcessId"
393− res <- try (test p1 sink)
444+ res <- try $ test (fromJust p1) sink
395− Left (ProcessExitException _ m) -> (liftIO $ putStrLn $ "SomeException-" ++ show m) >> stash result False
396− Right tr -> stash result tr
397 kill agent "bye"
446 kill agent "bye"
398− kill p1 "bye"
447+ kill (fromJust p1) "bye"
450+ Left (ProcessExitException _ m) -> (liftIO $ putStrLn $ "SomeException-" ++ show m) >> die m
451+ Right tr -> tr `shouldBe` equalTo True
401− label = "testMxSend"
402 agentLabel s = "mx-unsafe-check-agent-" ++ show s
455 agentLabel s = "mx-unsafe-check-agent-" ++ show s
403− proc sp' = getSelfPid >>= sendChan sp' >> expect :: Process ()
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
405tests :: TestTransport -> IO [Test]
467tests :: TestTransport -> IO [Test]
406tests TestTransport{..} = do
468tests TestTransport{..} = do
407 node1 <- newLocalNode testTransport initRemoteTable
469 node1 <- newLocalNode testTransport initRemoteTable
408 node2 <- newLocalNode testTransport initRemoteTable
470 node2 <- newLocalNode testTransport initRemoteTable
409− let nid = localNodeId node2
411 testGroup "MxAgents" [
472 testGroup "MxAgents" [
412 testCase "EventHandling"
473 testCase "EventHandling"
@@ -416,7 +477,7 @@ tests TestTransport{..} = do
416 , testCase "InterAgentBroadcast"
477 , testCase "InterAgentBroadcast"
417 (delayedAssertion
478 (delayedAssertion
418 "expected (), but no broadcast was received"
479 "expected (), but no broadcast was received"
419− node1 () testAgentBroadcast)
480+ node1 (Just ()) testAgentBroadcast)
420 , testCase "AgentMailboxHandling"
481 , testCase "AgentMailboxHandling"
421 (delayedAssertion
482 (delayedAssertion
422 "expected (Just ()), but no regular (mailbox) input was handled"
483 "expected (Just ()), but no regular (mailbox) input was handled"
@@ -441,53 +502,41 @@ tests TestTransport{..} = do
441 (delayedAssertion
502 (delayedAssertion
442 "expected process deaths to result in unregistration events"
503 "expected process deaths to result in unregistration events"
443 node1 () (testMxRegMon node2))
504 node1 () (testMxRegMon node2))
444− , testGroup "SentEvents" [
505+ , testGroup "SendEvents" $ buildTestCases node1 node2
445− testGroup "RemoteTargets" [
506+ ]
446− testCase "Unsafe.nsend"
507+ ]
447− (delayedAssertion "expected mx events failed"
508+ where
448− node1 True (testNSend Unsafe.nsend $ Just node2))
509+ buildTestCases n1 n2 = let nid = localNodeId n2 in build n1 n2 [
449− , testCase "Unsafe.nsendRemote"
510+ ("NSend", [
450− (delayedAssertion "expected mx events failed"
451− node1 True (testNSend (Unsafe.nsendRemote nid) $ Just node2))
452− , testCase "Unsafe.send"
453− (delayedAssertion "expected mx events failed"
454− node1 True (testSend Unsafe.send $ Just node2))
455− , testCase "Unsafe.usend"
456− (delayedAssertion "expected mx events failed"
457− node1 True (testSend Unsafe.usend $ Just node2))
459− (delayedAssertion "expected mx events failed"
460− node1 True (testNSend nsend $ Just node2))
511+ ("nsend", testNSend nsend)
461− , testCase "nsendRemote"
462− (delayedAssertion "expected mx events failed"
463− node1 True (testNSend (nsendRemote nid) $ Just node2))
465− (delayedAssertion "expected mx events failed"
466− node1 True (testSend send $ Just node2))
468− (delayedAssertion "expected mx events failed"
469− node1 True (testSend usend $ Just node2))
471− , testGroup "LocalTargets" [
472− testCase "Unsafe.nsend"
512+ , ("Unsafe.nsend", testNSend Unsafe.nsend)
473− (delayedAssertion "expected mx events failed"
513+ , ("nsendRemote", testNSend (nsendRemote nid))
474− node1 True (testNSend Unsafe.nsend Nothing))
514+ , ("Unsafe.nsendRemote", testNSend (Unsafe.nsendRemote nid))
475− , testCase "Unsafe.send"
515+ ])
476− (delayedAssertion "expected mx events failed"
516+ , ("Send", [
517+ ("send", testSend send)
477− node1 True (testSend Unsafe.send Nothing))
518+ , ("Unsafe.send", testSend Unsafe.send)
478− , testCase "Unsafe.usend"
519+ , ("usend", testSend usend)
479− (delayedAssertion "expected mx events failed"
480− node1 True (testSend Unsafe.usend Nothing))
520+ , ("Unsafe.usend", testSend Unsafe.usend)
481− , testCase "nsend"
521+ , ("sendChan", testChan sendChan)
482− (delayedAssertion "expected mx events failed"
522+ , ("Unsafe.sendChan", testChan Unsafe.sendChan)
483− node1 True (testNSend nsend Nothing))
523+ ])
484− , testCase "send"
524+ , ("Forward", [
485− (delayedAssertion "expected mx events failed"
525+ ("forward", testSend (\p m -> forward (unsafeCreateUnencodedMessage m) p))
486− node1 True (testSend send Nothing))
526+ , ("uforward", testSend (\p m -> uforward (unsafeCreateUnencodedMessage m) p))
487− , testCase "usend"
527+ ])
488− (delayedAssertion "expected mx events failed"
489− node1 True (testSend usend Nothing))
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
492− ]
540+ | (groupName, groupCases) <- specs
541+ , (caseSuffix, caseNode) <- [("RemotePid", Just ln), ("LocalPid", Nothing)]