git.iko.soy/distributed-process
on master help sign in
27 files changed+1323−499
since splitsnapshots
unifiedsplit
.travis.yml+8−9 benchmarks/Channels.hs+6−5 benchmarks/Latency.hs+7−5 benchmarks/ProcessRing.hs+2−2 benchmarks/Spawns.hs+6−5 benchmarks/Throughput.hs+6−5 distributed-process-tests/distributed-process-tests.cabal+24−11 distributed-process-tests/src/Control/Distributed/Process/Tests/CH.hs+455−228 distributed-process-tests/src/Control/Distributed/Process/Tests/Closure.hs+83−44 distributed-process-tests/src/Control/Distributed/Process/Tests/Internal/Utils.hs+16−5 distributed-process-tests/src/Control/Distributed/Process/Tests/Mx.hs+390−51 distributed-process-tests/src/Control/Distributed/Process/Tests/Stats.hs+11−7 distributed-process-tests/src/Control/Distributed/Process/Tests/Tracing.hs+23−11 distributed-process-tests/tests/runTCP.hs+2−2 distributed-process.cabal+3−3 src/Control/Distributed/Process/Internal/Primitives.hs+60−43 src/Control/Distributed/Process/Management.hs+34−2 src/Control/Distributed/Process/Management/Internal/Trace/Primitives.hs+8−2 src/Control/Distributed/Process/Management/Internal/Types.hs+9 src/Control/Distributed/Process/Node.hs+38−19 src/Control/Distributed/Process/UnsafePrimitives.hs+82−33 stack-ghc-7.10.3.yaml+4−1 stack-ghc-8.0.2.yaml+6−1 stack-ghc-8.2.2.yaml+4−1 stack-ghc-8.4.4.yaml+5−2 stack-nightly.yaml+26 stack.yaml+5−2
.travis.yml+8−9
@@ -6,17 +6,11 @@ matrix:
66 include:
77 - env: ARGS="--stack-yaml stack-ghc-7.10.3.yaml"
88 addons: {apt: {packages: [libgmp-dev]}}
9−
10− - env: ARGS="--stack-yaml stack-ghc-8.0.2.yaml"
11− addons: {apt: {packages: [libgmp-dev]}}
12−
139 - env: ARGS="--stack-yaml stack-ghc-8.2.2.yaml"
1410 addons: {apt: {packages: [libgmp-dev]}}
15−
1611 - env: ARGS="--stack-yaml stack-ghc-8.4.4.yaml"
1712 addons: {apt: {packages: [libgmp-dev]}}
18−
19− - env: ARGS=
13+ - env: ARGS="--stack-yaml stack-nightly.yaml --resolver nightly"
2014 addons: {apt: {packages: [libgmp-dev]}}
2115
2216cache:
@@ -40,5 +34,10 @@ script:
4034- stack ${ARGS} test $ARG='--plain -t "!Flaky"' ${TEST_PACKAGE}TestCHInTCP
4135- stack ${ARGS} test $ARG='--plain -t "!SpawnReconnect"' ${TEST_PACKAGE}TestClosure
4236- stack ${ARGS} test $ARG='--plain' ${TEST_PACKAGE}TestStats
43−- stack ${ARGS} test $ARG='--plain' ${TEST_PACKAGE}TestMx
44−- stack ${ARGS} test $ARG='--plain' ${TEST_PACKAGE}TestTracing
37+- stack ${ARGS} test $ARG='--plain' ${TEST_PACKAGE}TestMxInMemory
38+- stack ${ARGS} test $ARG='--plain' ${TEST_PACKAGE}TestMxInTCP
39+- stack ${ARGS} test $ARG='--plain' ${TEST_PACKAGE}TestTracingInMemory
40+
41+notifications:
42+ slack:
43+ secure: LbqbNjK1KiHNiQo/i/Za4vkMD9l9mhmN+PWYFBQkNvGFWffSRayRKFrTqt4znV2p7h4dY1XZFoC7T5RemBVQLq2ppZAUWxkITeu1OUlnmVLDfJLeVYGTR/fn90nP6Y5ITE7T3A07nKmWaRbKpIgFBAOjzgqaM0csscDx3z0WW18=
benchmarks/Channels.hs+6−5
@@ -4,7 +4,7 @@ import Control.Monad
44import Control.Applicative
55import Control.Distributed.Process
66import Control.Distributed.Process.Node
7−import Network.Transport.TCP (createTransport, defaultTCPParameters)
7+import Network.Transport.TCP (createTransport, defaultTCPAddr, defaultTCPParameters)
88import Data.Binary (encode, decode)
99import qualified Data.ByteString.Lazy as BSL
1010
@@ -36,7 +36,8 @@ initialProcess "CLIENT" = do
3636main :: IO ()
3737main = do
3838 [role, host, port] <- getArgs
39− Right transport <- createTransport
40− host port (\sn -> (host, port)) defaultTCPParameters
41− node <- newLocalNode transport initRemoteTable
42− runProcess node $ initialProcess role
39+ trans <- createTransport (defaultTCPAddr host port) defaultTCPParameters
40+ case trans of
41+ Right transport -> do node <- newLocalNode transport initRemoteTable
42+ runProcess node $ initialProcess role
43+ Left other -> error $ show other
benchmarks/Latency.hs+7−5
@@ -3,7 +3,7 @@ import Control.Monad
33import Control.Applicative
44import Control.Distributed.Process
55import Control.Distributed.Process.Node
6−import Network.Transport.TCP (createTransport, defaultTCPParameters)
6+import Network.Transport.TCP (createTransport, defaultTCPAddr, defaultTCPParameters)
77import Data.Binary (encode, decode)
88import qualified Data.ByteString.Lazy as BSL
99
@@ -31,7 +31,9 @@ initialProcess "CLIENT" = do
3131main :: IO ()
3232main = do
3333 [role, host, port] <- getArgs
34− Right transport <- createTransport
35− host port (\sn -> (host, sn)) defaultTCPParameters
36− node <- newLocalNode transport initRemoteTable
37− runProcess node $ initialProcess role
34+ trans <- createTransport
35+ (defaultTCPAddr host port) defaultTCPParameters
36+ case trans of
37+ Right transport -> do node <- newLocalNode transport initRemoteTable
38+ runProcess node $ initialProcess role
39+ Left other -> error $ show other
benchmarks/ProcessRing.hs+2−2
@@ -12,7 +12,7 @@ import Control.Monad
1212import Control.Distributed.Process hiding (catch)
1313import Control.Distributed.Process.Node
1414import Control.Exception (catch, SomeException)
15−import Network.Transport.TCP (createTransport, defaultTCPParameters)
15+import Network.Transport.TCP (createTransport, defaultTCPAddr, defaultTCPParameters)
1616import System.Environment
1717import System.Console.GetOpt
1818
@@ -111,7 +111,7 @@ main = do
111111 (opt, _) <- parseArgv argv
112112 putStrLn $ "options: " ++ (show opt)
113113 Right transport <- createTransport
114− "127.0.0.1" "8090" (\sn -> ("127.0.0.1", sn)) defaultTCPParameters
114+ (defaultTCPAddr "127.0.0.1" "8090" ) defaultTCPParameters
115115 node <- newLocalNode transport initRemoteTable
116116 catch (void $ runProcess node $ initialProcess opt)
117117 (\(e :: SomeException) -> putStrLn $ "ERROR: " ++ (show e))
benchmarks/Spawns.hs+6−5
@@ -7,7 +7,7 @@ import Control.Monad
77import Control.Applicative
88import Control.Distributed.Process
99import Control.Distributed.Process.Node
10−import Network.Transport.TCP (createTransport, defaultTCPParameters)
10+import Network.Transport.TCP (createTransport, defaultTCPAddr, defaultTCPParameters)
1111import Data.Binary (encode, decode)
1212import qualified Data.ByteString.Lazy as BSL
1313
@@ -42,7 +42,8 @@ initialProcess "CLIENT" = do
4242main :: IO ()
4343main = do
4444 [role, host, port] <- getArgs
45− Right transport <- createTransport
46− host port (\sn -> (host, sn)) defaultTCPParameters
47− node <- newLocalNode transport initRemoteTable
48− runProcess node $ initialProcess role
45+ trans <- createTransport (defaultTCPAddr host port) defaultTCPParameters
46+ case trans of
47+ Right transport -> do node <- newLocalNode transport initRemoteTable
48+ runProcess node $ initialProcess role
49+ Left other -> error $ show other
benchmarks/Throughput.hs+6−5
@@ -6,7 +6,7 @@ import Control.Monad
66import Control.Applicative
77import Control.Distributed.Process
88import Control.Distributed.Process.Node
9−import Network.Transport.TCP (createTransport, defaultTCPParameters)
9+import Network.Transport.TCP (createTransport, defaultTCPParameters, defaultTCPAddr)
1010import Data.Binary
1111import qualified Data.ByteString.Lazy as BSL
1212import Data.Typeable
@@ -67,7 +67,8 @@ initialProcess "CLIENT" = do
6767main :: IO ()
6868main = do
6969 [role, host, port] <- getArgs
70− Right transport <- createTransport
71− host port (\sn -> (host, sn)) defaultTCPParameters
72− node <- newLocalNode transport initRemoteTable
73− runProcess node $ initialProcess role
70+ trans <- createTransport (defaultTCPAddr host port) defaultTCPParameters
71+ case trans of
72+ Right transport -> do node <- newLocalNode transport initRemoteTable
73+ runProcess node $ initialProcess role
74+ Left other -> error $ show other
distributed-process-tests/distributed-process-tests.cabal+24−11
@@ -6,7 +6,7 @@ description: Tests and test suite for Cloud Haskell libraries.
66license: BSD3
77license-file: LICENSE
88Author: Duncan Coutts, Nicolas Wu, Edsko de Vries
9−Maintainer: Facundo Domínguez <facundo.dominguez@tweag.io>
9+Maintainer: Tim Watson <watson.timothy@gmail.com>
1010copyright: Well-Typed LLP
1111category: Control, Cloud Haskell
1212build-type: Simple
@@ -34,7 +34,7 @@ library
3434 exceptions >= 0.5,
3535 HUnit >= 1.2 && < 1.7,
3636 network-transport >= 0.4.1.0 && < 0.6,
37− network >= 2.5 && < 2.7,
37+ network >= 2.5 && < 2.9,
3838 random >= 1.0 && < 1.2,
3939 rematch >= 0.1.2.1,
4040 setenv >= 0.1.1.3,
@@ -61,7 +61,7 @@ Test-Suite TestCHInMemory
6161 CPP-Options: -DTEST_SUITE_MODULE=Control.Distributed.Process.Tests.CH
6262 Build-Depends: base >= 4.4 && < 5,
6363 distributed-process-tests,
64− network >= 2.3 && < 2.7,
64+ network >= 2.3 && < 2.9,
6565 network-transport >= 0.4.1.0 && < 0.6,
6666 network-transport-inmemory >= 0.5,
6767 test-framework >= 0.6 && < 0.9
@@ -76,7 +76,7 @@ Test-Suite TestCHInTCP
7676 if flag(tcp)
7777 Build-Depends: base >= 4.4 && < 5,
7878 distributed-process-tests,
79− network >= 2.3 && < 2.7,
79+ network >= 2.3 && < 2.9,
8080 network-transport >= 0.4.1.0 && < 0.6,
8181 network-transport-tcp >= 0.5 && < 0.7,
8282 test-framework >= 0.6 && < 0.9
@@ -93,7 +93,7 @@ Test-Suite TestClosure
9393 CPP-Options: -DTEST_SUITE_MODULE=Control.Distributed.Process.Tests.Closure
9494 Build-Depends: base >= 4.4 && < 5,
9595 distributed-process-tests,
96− network >= 2.3 && < 2.7,
96+ network >= 2.3 && < 2.9,
9797 network-transport >= 0.4.1.0 && < 0.6,
9898 network-transport-inmemory >= 0.5,
9999 test-framework >= 0.6 && < 0.9
@@ -107,7 +107,7 @@ Test-Suite TestStats
107107 CPP-Options: -DTEST_SUITE_MODULE=Control.Distributed.Process.Tests.Stats
108108 Build-Depends: base >= 4.4 && < 5,
109109 distributed-process-tests,
110− network >= 2.3 && < 2.7,
110+ network >= 2.3 && < 2.9,
111111 network-transport >= 0.4.1.0 && < 0.6,
112112 network-transport-inmemory >= 0.5,
113113 test-framework >= 0.6 && < 0.9
@@ -115,14 +115,13 @@ Test-Suite TestStats
115115 ghc-options: -Wall -eventlog -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
116116 HS-Source-Dirs: tests
117117
118−
119−Test-Suite TestMx
118+Test-Suite TestMxInMemory
120119 Type: exitcode-stdio-1.0
121120 Main-Is: runInMemory.hs
122121 CPP-Options: -DTEST_SUITE_MODULE=Control.Distributed.Process.Tests.Mx
123122 Build-Depends: base >= 4.4 && < 5,
124123 distributed-process-tests,
125− network >= 2.3 && < 2.7,
124+ network >= 2.3 && < 2.9,
126125 network-transport >= 0.4.1.0 && < 0.6,
127126 network-transport-inmemory >= 0.5,
128127 test-framework >= 0.6 && < 0.9
@@ -130,16 +129,30 @@ Test-Suite TestMx
130129 ghc-options: -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
131130 HS-Source-Dirs: tests
132131
133−Test-Suite TestTracing
132+Test-Suite TestTracingInMemory
134133 Type: exitcode-stdio-1.0
135134 Main-Is: runInMemory.hs
136135 CPP-Options: -DTEST_SUITE_MODULE=Control.Distributed.Process.Tests.Tracing
137136 Build-Depends: base >= 4.4 && < 5,
138137 distributed-process-tests,
139− network >= 2.3 && < 2.7,
138+ network >= 2.3 && < 2.9,
140139 network-transport >= 0.4.1.0 && < 0.6,
141140 network-transport-inmemory >= 0.5,
142141 test-framework >= 0.6 && < 0.9
143142 Extensions: CPP
144143 ghc-options: -eventlog -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
145144 HS-Source-Dirs: tests
145+
146+Test-Suite TestMxInTCP
147+ Type: exitcode-stdio-1.0
148+ Main-Is: runInMemory.hs
149+ CPP-Options: -DTEST_SUITE_MODULE=Control.Distributed.Process.Tests.Mx
150+ Build-Depends: base >= 4.4 && < 5,
151+ distributed-process-tests,
152+ network >= 2.3 && < 2.9,
153+ network-transport >= 0.4.1.0 && < 0.6,
154+ network-transport-inmemory >= 0.5,
155+ test-framework >= 0.6 && < 0.9
156+ Extensions: CPP
157+ ghc-options: -Wall -threaded -rtsopts -with-rtsopts=-N -fno-warn-unused-do-bind
158+ HS-Source-Dirs: tests
distributed-process-tests/src/Control/Distributed/Process/Tests/CH.hs+455−228
@@ -42,12 +42,15 @@ import Control.Distributed.Process.Internal.Types
4242 , createUnencodedMessage
4343 )
4444import Control.Distributed.Process.Node
45+import Control.Distributed.Process.Debug
46+import Control.Distributed.Process.Management.Internal.Types
47+import Control.Distributed.Process.Tests.Internal.Utils (shouldBe, pause)
4548import Control.Distributed.Process.Serializable (Serializable)
46−
47−import Test.HUnit (Assertion, assertFailure)
49+import Data.Maybe (isNothing, isJust)
50+import Test.HUnit (Assertion, assertBool, assertFailure)
4851import Test.Framework (Test, testGroup)
4952import Test.Framework.Providers.HUnit (testCase)
50−import Control.Rematch hiding (match)
53+import Control.Rematch hiding (match, isNothing, isJust)
5154import Control.Rematch.Run (Match(..))
5255
5356newtype Ping = Ping ProcessId
@@ -80,12 +83,46 @@ ping = do
8083 send partner (Ping self)
8184 ping
8285
86+verifyClient :: String -> MVar Bool -> IO ()
87+verifyClient s b = takeMVar b >>= assertBool s
88+
89+expectPing :: MVar Bool -> Process ()
90+expectPing mv = expect >>= liftIO . putMVar mv . checkPing
91+ where
92+ checkPing (Ping _) = True
93+
8394-- | Quick and dirty synchronous version of whereisRemoteAsync
8495whereisRemote :: NodeId -> String -> Process (Maybe ProcessId)
8596whereisRemote nid string = do
8697 whereisRemoteAsync nid string
87− WhereIsReply _ mPid <- expect
88− return mPid
98+ receiveWait [
99+ match (\(WhereIsReply _ mPid) -> return mPid)
100+ ]
101+
102+verifyWhereIsRemote :: NodeId -> String -> Process ProcessId
103+verifyWhereIsRemote n s = whereisRemote n s >>= maybe (die "remote name not found") return
104+
105+waitForExit :: ProcessId -> Process DiedReason
106+waitForExit pid = monitor pid >>= waitForDown
107+
108+waitForDown :: MonitorRef -> Process DiedReason
109+waitForDown ref =
110+ receiveWait [ matchIf (\(ProcessMonitorNotification ref' _ _) -> ref == ref')
111+ (\(ProcessMonitorNotification _ _ dr) -> return dr) ]
112+
113+syncBreakConnection :: (NT.EndPointAddress -> NT.EndPointAddress -> IO ()) -> LocalNode -> LocalNode -> IO ()
114+syncBreakConnection breakConnection nid0 nid1 = do
115+ m <- newEmptyMVar
116+ _ <- forkProcess nid1 $ getSelfPid >>= liftIO . putMVar m
117+ runProcess nid0 $ do
118+ them <- liftIO $ takeMVar m
119+ pinger <- spawnLocal $ forever $ send them ()
120+ _ <- monitorNode (localNodeId nid1)
121+ liftIO $ breakConnection (nodeAddress $ localNodeId nid0)
122+ (nodeAddress $ localNodeId nid1)
123+ NodeMonitorNotification _ _ _ <- expect
124+ kill pinger "finished"
125+ return ()
89126
90127data Add = Add ProcessId Double Double deriving (Typeable)
91128data Divide = Divide ProcessId Double Double deriving (Typeable)
@@ -160,12 +197,18 @@ monitorTestProcess theirAddr mOrL un reason monitorSetup done =
160197 unmonitor ref
161198 liftIO $ putMVar done ()
162199 (False, ref) -> do
163− ProcessMonitorNotification ref' pid reason' <- expect
164− True <- return $ Just ref' == ref && pid == theirAddr && mOrL && reason == reason'
165− liftIO $ putMVar done ()
200+ receiveWait [
201+ match (\(ProcessMonitorNotification ref' pid reason') -> do
202+ liftIO $ do
203+ assertBool "Bad Monitor Signal"
204+ (Just ref' == ref && pid == theirAddr &&
205+ mOrL && reason == reason')
206+ putMVar done ())
207+ ]
166208 )
167209 (\(ProcessLinkException pid reason') -> do
168− True <- return $ pid == theirAddr && not mOrL && not un && reason == reason'
210+ (liftIO $ assertBool "link exception unmatched" $
211+ pid == theirAddr && not mOrL && not un && reason == reason')
169212 liftIO $ putMVar done ()
170213 )
171214
@@ -196,8 +239,10 @@ testPing TestTransport{..} = do
196239 pid <- getSelfPid
197240 replicateM_ numPings $ do
198241 send pingServer (Pong pid)
199− Ping _ <- expect
200− return ()
242+ p <- expectTimeout 3000000
243+ case p of
244+ Just (Ping _) -> return ()
245+ Nothing -> die "Failed to receive Ping"
201246
202247 putMVar clientDone ()
203248
@@ -284,7 +329,7 @@ testMonitorLocalDeadProcess TestTransport{..} mOrL un = do
284329 runProcess localNode $ do
285330 monitor theirAddr
286331 -- wait for the process to die
287− ProcessMonitorNotification _ _ _ <- expect
332+ expect :: Process ProcessMonitorNotification
288333 monitorTestProcess theirAddr mOrL un DiedUnknownId Nothing done
289334
290335 takeMVar done
@@ -358,14 +403,17 @@ testMath TestTransport{..} = do
358403 runProcess localNode $ do
359404 pid <- getSelfPid
360405 send mathServer (Add pid 1 2)
361− 3 <- expect :: Process Double
406+ three <- expect :: Process Double
362407 send mathServer (Divide pid 8 2)
363− 4 <- expect :: Process Double
408+ four <- expect :: Process Double
364409 send mathServer (Divide pid 8 0)
365− DivByZero <- expect
366− liftIO $ putMVar clientDone ()
410+ divByZ <- expect
411+ liftIO $ putMVar clientDone (three, four, divByZ)
367412
368− takeMVar clientDone
413+ res <- takeMVar clientDone
414+ case res of
415+ (3, 4, DivByZero) -> return ()
416+ _ -> error $ "Something went horribly wrong"
369417
370418-- | Send first message (i.e. connect) to an already terminated process
371419-- (without monitoring); then send another message to a second process on
@@ -393,11 +441,9 @@ testSendToTerminated TestTransport{..} = do
393441 pid <- getSelfPid
394442 send server1 "Hi"
395443 send server2 (Pong pid)
396− Ping pid' <- expect
397− True <- return $ pid' == server2
398− liftIO $ putMVar clientDone ()
444+ expectPing clientDone
399445
400− takeMVar clientDone
446+ verifyClient "Expected Ping from server" clientDone
401447
402448-- | Test (non-zero) timeout
403449testTimeout :: TestTransport -> Assertion
@@ -406,10 +452,10 @@ testTimeout TestTransport{..} = do
406452 done <- newEmptyMVar
407453
408454 runProcess localNode $ do
409− Nothing <- receiveTimeout 1000000 [match (\(Add _ _ _) -> return ())]
410− liftIO $ putMVar done ()
455+ res <- receiveTimeout 1000000 [match (\Add{} -> return ())]
456+ liftIO $ putMVar done $ res == Nothing
411457
412− takeMVar done
458+ verifyClient "Expected receiveTimeout to timeout..." done
413459
414460-- | Test zero timeout
415461testTimeout0 :: TestTransport -> Assertion
@@ -437,10 +483,9 @@ testTimeout0 TestTransport{..} = do
437483 -- is not interested in, and then a single message that it wants
438484 replicateM_ 10000 $ send server "Irrelevant message"
439485 send server (Pong pid)
440− Ping _ <- expect
441− liftIO $ putMVar clientDone ()
486+ expectPing clientDone
442487
443− takeMVar clientDone
488+ verifyClient "Expected Ping from server" clientDone
444489
445490-- | Test typed channels
446491testTypedChannels :: TestTransport -> Assertion
@@ -463,10 +508,10 @@ testTypedChannels TestTransport{..} = do
463508 runProcess localNode $ do
464509 (clientSendPort, rport) <- newChan
465510 sendChan serverSendPort (clientSendPort, 5)
466− False <- receiveChan rport
467− liftIO $ putMVar clientDone ()
511+ ch <- receiveChan rport
512+ liftIO $ putMVar clientDone $ ch == False
468513
469− takeMVar clientDone
514+ verifyClient "Expected channel to send 'False'" clientDone
470515
471516-- | Test merging receive ports
472517testMergeChannels :: TestTransport -> Assertion
@@ -489,9 +534,8 @@ testMergeChannels TestTransport{..} = do
489534 rs <- mapM charChannel "abc"
490535 m <- mergePorts biased rs
491536 xs <- replicateM 9 $ receiveChan m
492− True <- return $ xs == expected
493− liftIO $ putMVar done ()
494− takeMVar done
537+ liftIO $ putMVar done $ xs == expected
538+ verifyClient "Expected single layer merge to match expected ordering" done
495539
496540 -- Two layers of merging
497541 testNested :: LocalNode -> Bool -> Bool -> String -> IO ()
@@ -502,9 +546,8 @@ testMergeChannels TestTransport{..} = do
502546 ms <- mapM (mergePorts biasedInner) rss
503547 m <- mergePorts biasedOuter ms
504548 xs <- replicateM (9 * 3) $ receiveChan m
505− True <- return $ xs == expected
506− liftIO $ putMVar done ()
507− takeMVar done
549+ liftIO $ putMVar done $ xs == expected
550+ verifyClient "Expected nested channels to match expeted ordering" done
508551
509552 -- Test that if no messages are (immediately) available, the scheduler makes no difference
510553 testBlocked :: LocalNode -> Bool -> IO ()
@@ -513,43 +556,45 @@ testMergeChannels TestTransport{..} = do
513556 done <- newEmptyMVar
514557
515558 forkProcess localNode $ do
516− [sa, sb, sc] <- liftIO $ mapM readMVar vs
517− mapM_ ((>> liftIO (threadDelay 10000)) . uncurry sendChan)
518− [ -- a, b, c
519− (sa, 'a')
520− , (sb, 'b')
521− , (sc, 'c')
522− -- a, c, b
523− , (sa, 'a')
524− , (sc, 'c')
525− , (sb, 'b')
526− -- b, a, c
527− , (sb, 'b')
528− , (sa, 'a')
529− , (sc, 'c')
530− -- b, c, a
531− , (sb, 'b')
532− , (sc, 'c')
533− , (sa, 'a')
534− -- c, a, b
535− , (sc, 'c')
536− , (sa, 'a')
537− , (sb, 'b')
538− -- c, b, a
539− , (sc, 'c')
540− , (sb, 'b')
541− , (sa, 'a')
542− ]
559+ ss <- liftIO $ mapM readMVar vs
560+ case ss of
561+ [sa, sb, sc] ->
562+ mapM_ ((>> pause 10000) . uncurry sendChan)
563+ [ -- a, b, c
564+ (sa, 'a')
565+ , (sb, 'b')
566+ , (sc, 'c')
567+ -- a, c, b
568+ , (sa, 'a')
569+ , (sc, 'c')
570+ , (sb, 'b')
571+ -- b, a, c
572+ , (sb, 'b')
573+ , (sa, 'a')
574+ , (sc, 'c')
575+ -- b, c, a
576+ , (sb, 'b')
577+ , (sc, 'c')
578+ , (sa, 'a')
579+ -- c, a, b
580+ , (sc, 'c')
581+ , (sa, 'a')
582+ , (sb, 'b')
583+ -- c, b, a
584+ , (sc, 'c')
585+ , (sb, 'b')
586+ , (sa, 'a')
587+ ]
588+ _ -> die "Something went horribly wrong"
543589
544590 forkProcess localNode $ do
545591 (ss, rs) <- unzip <$> replicateM 3 newChan
546592 liftIO $ mapM_ (uncurry putMVar) $ zip vs ss
547593 m <- mergePorts biased rs
548594 xs <- replicateM (6 * 3) $ receiveChan m
549− True <- return $ xs == "abcacbbacbcacabcba"
550− liftIO $ putMVar done ()
595+ liftIO $ putMVar done $ xs == "abcacbbacbcacabcba"
551596
552− takeMVar done
597+ verifyClient "Expected merged ports to match expected ordering" done
553598
554599 mergePorts :: Serializable a => Bool -> [ReceivePort a] -> Process (ReceivePort a)
555600 mergePorts True = mergePortsBiased
@@ -567,8 +612,9 @@ testTerminate TestTransport{..} = do
567612 localNode <- newLocalNode testTransport initRemoteTable
568613 runProcess localNode $ do
569614 e <- try terminate :: Process (Either ProcessTerminationException ())
570− True <- return $ either show show e == show ProcessTerminationException
571− return ()
615+ if either show show e == show ProcessTerminationException
616+ then return ()
617+ else die "Unexpected result from terminate"
572618
573619testMonitorNode :: TestTransport -> Assertion
574620testMonitorNode TestTransport{..} = do
@@ -579,11 +625,12 @@ testMonitorNode TestTransport{..} = do
579625
580626 runProcess node2 $ do
581627 ref <- monitorNode (localNodeId node1)
582− NodeMonitorNotification ref' nid DiedDisconnect <- expect
583− True <- return $ ref == ref' && nid == localNodeId node1
584− liftIO $ putMVar done ()
628+ receiveWait [
629+ match (\(NodeMonitorNotification ref' nid DiedDisconnect) ->
630+ return $ ref == ref' && nid == localNodeId node1)
631+ ] >>= liftIO . putMVar done
585632
586− takeMVar done
633+ verifyClient "Expected NodeMonitorNotification with matching ref & nodeId" done
587634
588635testMonitorLiveNode :: TestTransport -> Assertion
589636testMonitorLiveNode TestTransport{..} = do
@@ -598,15 +645,16 @@ testMonitorLiveNode TestTransport{..} = do
598645 liftIO $ putMVar ready ()
599646 liftIO $ takeMVar readyr
600647 send p ()
601− NodeMonitorNotification ref' nid _ <- expect
602− True <- return $ ref == ref' && nid == localNodeId node1
603− liftIO $ putMVar done ()
648+ receiveWait [
649+ match (\(NodeMonitorNotification ref' nid _) ->
650+ (return $ ref == ref' && nid == localNodeId node1))
651+ ] >>= liftIO . putMVar done
604652
605653 takeMVar ready
606654 closeLocalNode node1
607655 putMVar readyr ()
608656
609− takeMVar done
657+ verifyClient "Expected NodeMonitorNotification for LIVE node" done
610658
611659testMonitorChannel :: TestTransport -> Assertion
612660testMonitorChannel TestTransport{..} = do
@@ -616,18 +664,20 @@ testMonitorChannel TestTransport{..} = do
616664 pid <- forkProcess node1 $ do
617665 sport <- expect :: Process (SendPort ())
618666 ref <- monitorPort sport
619− PortMonitorNotification ref' port' reason <- expect
620− -- reason might be DiedUnknownId if the receive port is GCed before the
621− -- monitor is established (TODO: not sure that this is reasonable)
622− return $ ref' == ref && port' == sendPortId sport && (reason == DiedNormal || reason == DiedUnknownId)
623− liftIO $ putMVar gotNotification ()
667+ receiveWait [
668+ -- reason might be DiedUnknownId if the receive port is GCed before the
669+ -- monitor is established (TODO: not sure that this is reasonable)
670+ match (\(PortMonitorNotification ref' port' reason) ->
671+ return $ ref' == ref && port' == sendPortId sport &&
672+ (reason == DiedNormal || reason == DiedUnknownId))
673+ ] >>= liftIO . putMVar gotNotification
624674
625675 runProcess node2 $ do
626676 (sport, _) <- newChan :: Process (SendPort (), ReceivePort ())
627677 send pid sport
628678 liftIO $ threadDelay 100000
629679
630− takeMVar gotNotification
680+ verifyClient "Expected PortMonitorNotification" gotNotification
631681
632682testRegistry :: TestTransport -> Assertion
633683testRegistry TestTransport{..} = do
@@ -639,20 +689,28 @@ testRegistry TestTransport{..} = do
639689
640690 runProcess node $ do
641691 register "ping" pingServer
642− Just pid <- whereis "ping"
643− True <- return $ pingServer == pid
692+ whereis "ping" >>= liftIO . assertBool "Unexpected ping" . (== Just pingServer)
644693 us <- getSelfPid
645694 nsend "ping" (Pong us)
646− Ping pid' <- expect
647− True <- return $ pingServer == pid'
648− Left (ProcessRegistrationException "dead" Nothing) <- try $ register "dead" deadProcess
649− Left (ProcessRegistrationException "ping" (Just x)) <- try $ register "ping" deadProcess
650− True <- return $ x == pingServer
651− Left (ProcessRegistrationException "dead" Nothing) <- try $ unregister "dead"
695+ receiveWait [
696+ matchIf (\(Ping pid') -> pingServer == pid') (const $ return ())
697+ ]
698+ checkRegException "dead" Nothing deadProcess
699+ checkRegException "ping" (Just pingServer) deadProcess
700+ try (unregister "dead") >>= checkReg "dead" Nothing
652701 liftIO $ putMVar done ()
653702
654703 takeMVar done
655704
705+ where
706+ checkRegException name pid dead =
707+ try (register name dead) >>= checkReg name pid
708+
709+ checkReg name pid res =
710+ case res of
711+ Left (ProcessRegistrationException name pid) -> return ()
712+ _ -> die $ "Unexpected Registration" ++ show res
713+
656714testRegistryRemoteProcess :: TestTransport -> Assertion
657715testRegistryRemoteProcess TestTransport{..} = do
658716 node1 <- newLocalNode testTransport initRemoteTable
@@ -663,13 +721,13 @@ testRegistryRemoteProcess TestTransport{..} = do
663721
664722 runProcess node2 $ do
665723 register "ping" pingServer
666− Just pid <- whereis "ping"
667− True <- return $ pingServer == pid
724+ whereis "ping" >>= liftIO . assertBool "Unexpected ping" . (== Just pingServer)
668725 us <- getSelfPid
669726 nsend "ping" (Pong us)
670− Ping pid' <- expect
671− True <- return $ pingServer == pid'
672− liftIO $ putMVar done ()
727+ receiveWait [
728+ matchIf (\(Ping pid') -> pingServer == pid')
729+ (const $ liftIO $ putMVar done ())
730+ ]
673731
674732 takeMVar done
675733
@@ -677,7 +735,6 @@ testRemoteRegistry :: TestTransport -> Assertion
677735testRemoteRegistry TestTransport{..} = do
678736 node1 <- newLocalNode testTransport initRemoteTable
679737 node2 <- newLocalNode testTransport initRemoteTable
680− done <- newEmptyMVar
681738
682739 pingServer <- forkProcess node1 ping
683740 deadProcess <- forkProcess node1 (return ())
@@ -690,32 +747,34 @@ testRemoteRegistry TestTransport{..} = do
690747 "ping" == label' && pid == pingServer)
691748 (\(RegisterReply _ _ _) -> return ()) ]
692749
693− Just pid <- whereisRemote nid1 "ping"
694− True <- return $ pingServer == pid
750+ pid <- verifyWhereIsRemote nid1 "ping"
751+ liftIO $ assertBool "Expected pindServer to match pid" $ pingServer == pid
752+
695753 us <- getSelfPid
696754 nsendRemote nid1 "ping" (Pong us)
697− Ping pid' <- expect
698− True <- return $ pingServer == pid'
755+ receiveWait [
756+ match (\(Ping pid') -> return $ pingServer == pid')
757+ ] >>= liftIO . assertBool "Expected Ping with ping server's ProcessId"
699758
700759 -- test that if process was not registered Nothing is returned
701760 -- in owner field.
702761 registerRemoteAsync nid1 "dead" deadProcess
703− receiveWait [
704− matchIf (\(RegisterReply label' False Nothing) -> "dead" == label')
705− (\(RegisterReply _ _ _) -> return ()) ]
762+ receiveWait [ matchIf (\(RegisterReply label' f mPid) -> "dead" == label')
763+ (\(RegisterReply _ f mPid) -> return (not f && isNothing mPid))
764+ ] >>= liftIO . assertBool "Expected False Nothing in RegisterReply"
765+
706766 registerRemoteAsync nid1 "ping" deadProcess
707767 receiveWait [
708− matchIf (\(RegisterReply label' False (Just pid'')) ->
709− "ping" == label' && pid'' == pingServer)
710− (\(RegisterReply _ _ _) -> return ()) ]
768+ matchIf (\(RegisterReply label' False mPid) ->
769+ "ping" == label' && isJust mPid)
770+ (\(RegisterReply _ f (Just pid'')) -> return (not f && pid'' == pingServer))
771+ ] >>= liftIO . assertBool "Expected False and (Just alreadyRegisteredPid) in RegisterReply"
772+
711773 unregisterRemoteAsync nid1 "dead"
712774 receiveWait [
713− matchIf (\(RegisterReply label' False Nothing) ->
714− "dead" == label' && pid == pingServer)
715− (\(RegisterReply _ _ _) -> return ()) ]
716− liftIO $ putMVar done ()
717−
718− takeMVar done
775+ matchIf (\(RegisterReply label' _ _) -> "dead" == label')
776+ (\(RegisterReply _ f mPid) -> return (not f && isNothing mPid))
777+ ] >>= liftIO . assertBool "Expected False and Nothing in RegisterReply"
719778
720779testRemoteRegistryRemoteProcess :: TestTransport -> Assertion
721780testRemoteRegistryRemoteProcess TestTransport{..} = do
@@ -731,15 +790,15 @@ testRemoteRegistryRemoteProcess TestTransport{..} = do
731790 receiveWait [
732791 matchIf (\(RegisterReply label' _ _) -> "ping" == label')
733792 (\(RegisterReply _ _ _) -> return ()) ]
734− Just pid <- whereisRemote nid1 "ping"
735− True <- return $ pingServer == pid
793+ pid <- verifyWhereIsRemote nid1 "ping"
794+ liftIO $ assertBool "Expected pingServer to match remote name" $ pingServer == pid
736795 us <- getSelfPid
737796 nsendRemote nid1 "ping" (Pong us)
738− Ping pid' <- expect
739− True <- return $ pingServer == pid'
740− liftIO $ putMVar done ()
797+ receiveWait [
798+ match (\(Ping pid') -> return $ pingServer == pid')
799+ ] >>= liftIO . putMVar done
741800
742− takeMVar done
801+ verifyClient "Expected Ping with ping server's ProcessId" done
743802
744803testSpawnLocal :: TestTransport -> Assertion
745804testSpawnLocal TestTransport{..} = do
@@ -753,15 +812,14 @@ testSpawnLocal TestTransport{..} = do
753812 sport <- expect
754813 sendChan sport (1234 :: Int)
755814
756− sport <- spawnChannelLocal $ \rport -> do
757− (1234 :: Int) <- receiveChan rport
758− send us ()
815+ sport <- spawnChannelLocal $
816+ \rport -> (receiveChan rport :: Process Int) >>= send us
759817
760818 send pid sport
761− () <- expect
762− liftIO $ putMVar done ()
819+ expect >>= liftIO . putMVar done
763820
764− takeMVar done
821+ res <- takeMVar done
822+ assertBool "Expected 1234 :: Int" $ res == (1234 :: Int)
765823
766824testSpawnAsyncStrictness :: TestTransport -> Assertion
767825testSpawnAsyncStrictness TestTransport{..} = do
@@ -790,8 +848,9 @@ testReconnect TestTransport{..} = do
790848 liftIO $ putMVar processA us
791849 msg1 <- expect
792850 msg2 <- expect
793− True <- return $ msg1 == "message 1" && msg2 == "message 3"
794− liftIO $ putMVar sendTestOk ()
851+ liftIO $ do
852+ assertBool "messages did not match" $ msg1 == "message 1" && msg2 == "message 3"
853+ putMVar sendTestOk ()
795854
796855 forkProcess node2 $ do
797856 {-
@@ -824,7 +883,7 @@ testReconnect TestTransport{..} = do
824883 matchIf (\(RegisterReply label' _ _) -> "a" == label')
825884 (\(RegisterReply _ _ _) -> return ()) ]
826885
827− Just _ <- whereisRemote nid1 "a"
886+ _ <- whereisRemote nid1 "a"
828887
829888
830889 -- Simulate network failure
@@ -843,9 +902,10 @@ testReconnect TestTransport{..} = do
843902 (\(RegisterReply _ _ _) -> return ()) ]
844903
845904 -- Check
846− Nothing <- whereisRemote nid1 "a" -- this will fail because the name is removed when the node is disconnected
847− Just _ <- whereisRemote nid1 "b" -- this will suceed because the value is set after thereconnect
848− Just _ <- whereisRemote nid1 "c"
905+ mPid <- whereisRemote nid1 "a" -- this will fail because the name is removed when the node is disconnected
906+ liftIO $ assertBool "Expected remote name to be lost" $ mPid == Nothing
907+ verifyWhereIsRemote nid1 "b" -- this will suceed because the value is set after thereconnect
908+ verifyWhereIsRemote nid1 "c"
849909
850910 liftIO $ putMVar registerTestOk ()
851911
@@ -886,19 +946,19 @@ testUSend usendPrim TestTransport{..} numMessages = do
886946 isSorted _ = True
887947 -- The list can't be null since there are no failures after sending
888948 -- the last message.
889− True <- return $ isSorted msgs && not (null msgs)
890− liftIO $ putMVar usendTestOk ()
949+ liftIO $ putMVar usendTestOk $ isSorted msgs && not (null msgs)
891950
892951 forkProcess node2 $ do
893952 them <- liftIO $ readMVar processA
894953 getSelfPid >>= send them
895− () <- expect
954+ expect :: Process ()
896955 forM_ [1..numMessages] $ \i -> do
897956 liftIO $ testBreakConnection (nodeAddress nid1) (nodeAddress nid2)
898957 usendPrim them i
899958 liftIO (threadDelay 30000)
900959
901− takeMVar usendTestOk
960+ res <- takeMVar usendTestOk
961+ assertBool "Unexpected failure after sending last msg" res
902962
903963-- | Test 'matchAny'. This repeats the 'testMath' but with a proxy server
904964-- in between
@@ -924,14 +984,17 @@ testMatchAny TestTransport{..} = do
924984 runProcess localNode $ do
925985 pid <- getSelfPid
926986 send mathServer (Add pid 1 2)
927− 3 <- expect :: Process Double
987+ three <- expect :: Process Double
928988 send mathServer (Divide pid 8 2)
929− 4 <- expect :: Process Double
989+ four <- expect :: Process Double
930990 send mathServer (Divide pid 8 0)
931− DivByZero <- expect
932− liftIO $ putMVar clientDone ()
991+ divByZ <- expect
992+ liftIO $ putMVar clientDone (three, four, divByZ)
933993
934− takeMVar clientDone
994+ res <- takeMVar clientDone
995+ case res of
996+ (3, 4, DivByZero) -> return ()
997+ _ -> error "Unexpected result"
935998
936999-- | Test 'matchAny'. This repeats the 'testMath' but with a proxy server
9371000-- in between, however we block 'Divide' requests ....
@@ -958,12 +1021,13 @@ testMatchAnyHandle TestTransport{..} = do
9581021 runProcess localNode $ do
9591022 pid <- getSelfPid
9601023 send mathServer (Add pid 1 2)
961− 3 <- expect :: Process Double
1024+ three <- expect :: Process Double
9621025 send mathServer (Divide pid 8 2)
963− Nothing <- (expectTimeout 100000) :: Process (Maybe Double)
964− liftIO $ putMVar clientDone ()
1026+ res <- (expectTimeout 100000) :: Process (Maybe Double)
1027+ liftIO $ putMVar clientDone $ three == 3 && res == Nothing
1028+
1029+ verifyClient "Expected Nothing (i.e. timeout)" clientDone
9651030
966− takeMVar clientDone
9671031 where maybeForward :: ProcessId -> Message -> Process (Maybe ())
9681032 maybeForward s msg =
9691033 handleMessage msg (\m@(Add _ _ _) -> send s m)
@@ -991,8 +1055,10 @@ testMatchAnyNoHandle TestTransport{..} = do
9911055 Just _ -> die "NONSENSE")
9921056 ]
9931057 -- we *must* have removed the message from our mailbox though!!!
994− Nothing <- receiveTimeout 100000 [ match (\(Add _ _ _) -> return ()) ]
995− liftIO $ putMVar serverDone ()
1058+ res <- receiveTimeout 100000 [ match (\(Add _ _ _) -> return ()) ]
1059+ liftIO $ do
1060+ assertBool "Expected timeout!" $ res == Nothing
1061+ putMVar serverDone ()
9961062 putMVar addr server
9971063
9981064 -- Client
@@ -1035,14 +1101,21 @@ testMatchAnyIf TestTransport{..} = do
10351101 runProcess localNode $ do
10361102 pid <- getSelfPid
10371103 send server (pid, "foo")
1038− "foo" <- expect
1039− send server (pid, "baz")
1040− "baz" <- expect
1104+ foo <- expect
1105+ -- provoking what would be the wrong ordering is informative here...
1106+
10411107 send server (pid, "bar")
1042− Nothing <- (expectTimeout 100000) :: Process (Maybe Double)
1043− liftIO $ putMVar clientDone ()
1108+ bar <- (expectTimeout 100000) :: Process (Maybe String) -- was Double o_O !?
1109+
1110+ send server (pid, "baz")
1111+ baz <- expect
1112+
1113+ liftIO $ putMVar clientDone (foo, bar, baz)
1114+
1115+ res <- takeMVar clientDone
1116+ let res' = res == ("foo", Nothing, "baz")
1117+ assertBool "Expected timeout due to type mismatch" res'
10441118
1045− takeMVar clientDone
10461119 where tryHandleMessage :: Message -> Process (Maybe ())
10471120 tryHandleMessage msg =
10481121 handleMessage msg (\(pid :: ProcessId, (m :: String))
@@ -1075,12 +1148,13 @@ testMatchMessageWithUnwrap TestTransport{..} = do
10751148 runProcess localNode $ do
10761149 pid <- getSelfPid
10771150 send server (pid, wrapMessage ("foo" :: String))
1078− "foo" <- expect
1151+ foo <- expect
10791152 send server (pid, wrapMessage ("baz" :: String))
1080− "baz" <- expect
1081− liftIO $ putMVar clientDone ()
1153+ baz <- expect
1154+ liftIO $ putMVar clientDone (foo, baz)
10821155
1083− takeMVar clientDone
1156+ res <- takeMVar clientDone
1157+ assertBool "Unexpected unwrapped results" $ res == ("foo", "baz")
10841158
10851159-- Test 'receiveChanTimeout'
10861160testReceiveChanTimeout :: TestTransport -> Assertion
@@ -1098,18 +1172,19 @@ testReceiveChanTimeout TestTransport{..} = do
10981172
10991173 -- Wait for a message with a delay. No message arrives, we should get
11001174 -- Nothing after the delay.
1101− Nothing <- receiveChanTimeout 100000 rp
1175+ receiveChanTimeout 100000 rp >>= maybe (return ()) (const $ die "Expected Timeout")
11021176
11031177 -- Let the sender know that it can send a message.
11041178 liftIO $ putMVar mvSender ()
11051179
11061180 -- Wait for a message with a delay again. Now a message arrives after
11071181 -- 0.1 seconds
1108− Just True <- receiveChanTimeout 20000000 rp
1182+ res <- receiveChanTimeout 20000000 rp >>= maybe (die "Timeout") return
1183+ liftIO $ assertBool "Expected result to be 'True'" res
11091184
11101185 -- Wait for a message with zero timeout: non-blocking check. No message is
11111186 -- available, we get Nothing
1112− Nothing <- receiveChanTimeout 0 rp
1187+ receiveChanTimeout 0 rp >>= maybe (return ()) (const $ die "Expected Timeout")
11131188
11141189 -- Let the sender know that it can send a message.
11151190 liftIO $ putMVar mvSender ()
@@ -1119,7 +1194,7 @@ testReceiveChanTimeout TestTransport{..} = do
11191194 liftIO $ threadDelay 100000
11201195 mb <- receiveChanTimeout 0 rp
11211196 case mb of
1122− Just b -> do False <- return b; return ()
1197+ Just b -> do liftIO $ assertBool "Unexpected Message" $ not b
11231198 _ -> loop
11241199
11251200 liftIO $ putMVar done ()
@@ -1156,8 +1231,8 @@ testReceiveChanFeatures TestTransport{..} = do
11561231
11571232 rp1 <- mergePortsBiased [even <$> rpInt, rpBool]
11581233
1159− True <- receiveChan rp1
1160− False <- receiveChan rp1
1234+ receiveChan rp1 >>= liftIO . assertBool "Expected True"
1235+ receiveChan rp1 >>= liftIO . assertBool "Expected False" . not
11611236
11621237 -- Test Applicative instance
11631238
@@ -1166,7 +1241,7 @@ testReceiveChanFeatures TestTransport{..} = do
11661241
11671242 let rp2 = pure (+) <*> rpInt <*> rpInt
11681243
1169− 7 <- receiveChan rp2
1244+ receiveChan rp2 >>= liftIO . assertBool "Expected 7" . (== 7)
11701245
11711246 -- Test Alternative instance
11721247
@@ -1175,8 +1250,8 @@ testReceiveChanFeatures TestTransport{..} = do
11751250
11761251 let rp3 = (even <$> rpInt) <|> rpBool
11771252
1178− False <- receiveChan rp3
1179− True <- receiveChan rp3
1253+ receiveChan rp3 >>= liftIO . assertBool "Expected False" . not
1254+ receiveChan rp3 >>= liftIO . assertBool "Expected True"
11801255
11811256 -- Test Monad instance
11821257
@@ -1190,17 +1265,86 @@ testReceiveChanFeatures TestTransport{..} = do
11901265 then rpInt
11911266 else return 7
11921267
1193− 5 <- receiveChan rp4
1194− 7 <- receiveChan rp4
1268+ receiveChan rp4 >>= liftIO . assertBool "Expected 5" . (== 5)
1269+ receiveChan rp4 >>= liftIO . assertBool "Expected 7" . (== 7)
11951270
11961271 liftIO $ putMVar done ()
11971272
11981273 takeMVar done
11991274
1275+testChanLifecycle :: TestTransport -> Assertion
1276+testChanLifecycle TestTransport{..} = let delay = 3000000 in do
1277+ result <- newEmptyMVar
1278+ tchMV <- newEmptyMVar
1279+ localNode <- newLocalNode testTransport initRemoteTable
1280+ runProcess localNode $ do
1281+
1282+ pid <- spawnLocal $ do tCh <- newChan :: Process (SendPort (), ReceivePort ())
1283+ liftIO $ putMVar tchMV tCh
1284+ expect :: Process ()
1285+ let (sp, _) = tCh
1286+ sendChan sp ()
1287+ expect :: Process ()
1288+
1289+ mRefPid <- monitor pid
1290+
1291+ cPid <- spawnLocal $ do
1292+ (sp', rp) <- liftIO $ takeMVar tchMV
1293+ -- say "picked up our test channel"
1294+ send pid ()
1295+ -- say "told pid to continue"
1296+ res <- receiveChanTimeout delay rp
1297+ case res of
1298+ Nothing -> say "initial chan () missing!" >> (liftIO $ putMVar result False)
1299+ Just () -> do mr <- monitor pid
1300+ pause 10000
1301+ -- say "sending pid a second () will cause it to exit"
1302+ send pid ()
1303+
1304+ -- say "make sure we see a DOWN notification for pid having stopped"
1305+ receiveWait [ match (\(_ :: ProcessMonitorNotification) -> return ()) ]
1306+
1307+ -- now that pid has died, the send port should be useless...
1308+ liftIO $ putMVar tchMV (sp', rp)
1309+
1310+ -- let's verify that we do not see the message from our
1311+ -- parent process on the channel, once pid has died...
1312+ recv <- receiveChanTimeout delay rp
1313+ -- say $ "finished waiting for second (), writing result" ++ (show recv)
1314+ liftIO $ putMVar result $ isNothing recv
1315+
1316+ mRefCPid <- monitor cPid
1317+
1318+ receiveWait
1319+ [ matchIf (\(ProcessMonitorNotification r _ _) -> r == mRefPid)
1320+ (\_ -> return ())
1321+ ]
1322+
1323+ -- say "seen first pid die..."
1324+
1325+ (sendPort, _) <- liftIO $ takeMVar tchMV
1326+ sendChan sendPort ()
1327+ -- say "sent () after owning pid died"
1328+
1329+ -- let cPid know we've written to the channel...
1330+ send cPid ()
1331+
1332+ receiveWait
1333+ [ matchIf (\(ProcessMonitorNotification r _ _) -> r == mRefCPid)
1334+ (\_ -> return ())
1335+ ]
1336+
1337+ -- say "seen both pids die now..."
1338+
1339+ -- and wait on the result back in IO land...
1340+ testRes <- takeMVar result
1341+ -- runProcess localNode $ say "got result..."
1342+ assertBool "Expected sending on the channel to fail, but received data!" testRes
1343+
1344+
12001345testKillLocal :: TestTransport -> Assertion
12011346testKillLocal TestTransport{..} = do
12021347 localNode <- newLocalNode testTransport initRemoteTable
1203− done <- newEmptyMVar
12041348
12051349 pid <- forkProcess localNode $ do
12061350 liftIO $ threadDelay 1000000
@@ -1209,17 +1353,18 @@ testKillLocal TestTransport{..} = do
12091353 ref <- monitor pid
12101354 us <- getSelfPid
12111355 kill pid "TestKill"
1212− ProcessMonitorNotification ref' pid' (DiedException ex) <- expect
1213− True <- return $ ref == ref' && pid == pid' && ex == "killed-by=" ++ show us ++ ",reason=TestKill"
1214− liftIO $ putMVar done ()
1215−
1216− takeMVar done
1356+ mn <- expect
1357+ case mn of
1358+ ProcessMonitorNotification ref' pid' (DiedException ex) ->
1359+ case ref == ref' && pid == pid' && ex == "killed-by=" ++ show us ++ ",reason=TestKill" of
1360+ True -> return ()
1361+ False -> die "Invalid ProcessMonitorNotification received"
1362+ _ -> die "Something went horribly wrong"
12171363
12181364testKillRemote :: TestTransport -> Assertion
12191365testKillRemote TestTransport{..} = do
12201366 node1 <- newLocalNode testTransport initRemoteTable
12211367 node2 <- newLocalNode testTransport initRemoteTable
1222− done <- newEmptyMVar
12231368
12241369 pid <- forkProcess node1 $ do
12251370 liftIO $ threadDelay 1000000
@@ -1228,11 +1373,17 @@ testKillRemote TestTransport{..} = do
12281373 ref <- monitor pid
12291374 us <- getSelfPid
12301375 kill pid "TestKill"
1231− ProcessMonitorNotification ref' pid' (DiedException reason) <- expect
1232− True <- return $ ref == ref' && pid == pid' && reason == "killed-by=" ++ show us ++ ",reason=TestKill"
1233− liftIO $ putMVar done ()
1234−
1235− takeMVar done
1376+ mn <- expect
1377+ case mn of
1378+ ProcessMonitorNotification ref' pid' (DiedException reason) ->
1379+ case (ref == ref', pid == pid', reason == "killed-by=" ++ show us ++ ",reason=TestKill") of
1380+ (True, True, True) -> return ()
1381+ (a, b, c) -> do
1382+ let a' = if a then "" else "Invalid ref"
1383+ let b' = if b then "" else "Invalid pid"
1384+ let c' = if c then "" else "Invalid message"
1385+ die $ unwords [a', b', c']
1386+ _ -> die "Received unexpected message"
12361387
12371388testCatchesExit :: TestTransport -> Assertion
12381389testCatchesExit TestTransport{..} = do
@@ -1258,7 +1409,10 @@ testHandleMessageIf TestTransport{..} = do
12581409 self <- getSelfPid
12591410 send self (5 :: Integer, 10 :: Integer)
12601411 msg <- receiveWait [ matchMessage return ]
1261− Nothing <- handleMessageIf msg (\() -> True) (\() -> die $ "whoops")
1412+ handleMessageIf msg
1413+ (\() -> True)
1414+ (\() -> die "whoops") >>= maybe (return ())
1415+ (const $ die "Expected Mismatch")
12621416 handleMessageIf msg (\(x :: Integer, y :: Integer) -> x == 5 && y == 10)
12631417 (\input -> liftIO $ putMVar done input)
12641418 return ()
@@ -1303,8 +1457,11 @@ testDie TestTransport{..} = do
13031457 (die ("foobar", 123 :: Int))
13041458 `catchExit` \_from reason -> do
13051459 -- TODO: should verify that 'from' has the right value
1306− True <- return $ reason == ("foobar", 123 :: Int)
1460+ let res = reason == ("foobar", 123 :: Int)
13071461 liftIO $ putMVar done ()
1462+ if res
1463+ then return ()
1464+ else die "Something went horribly wrong"
13081465
13091466 takeMVar done
13101467
@@ -1318,8 +1475,11 @@ testPrettyExit TestTransport{..} = do
13181475 `catch` \ex@(ProcessExitException from _) ->
13191476 let expected = "exit-from=" ++ (show from)
13201477 in do
1321− True <- return $ (show ex) == expected
1478+ let res = (show ex) == expected
13221479 liftIO $ putMVar done ()
1480+ if res
1481+ then return ()
1482+ else die "Something went horribly wrong"
13231483
13241484 takeMVar done
13251485
@@ -1335,17 +1495,26 @@ testExitLocal TestTransport{..} = do
13351495 pid <- forkProcess localNode $ do
13361496 (liftIO (putMVar handlerSetUp ()) >> expect) `catchExit` \_from reason -> do
13371497 -- TODO: should verify that 'from' has the right value
1338− True <- return $ reason == "TestExit"
1498+ res <- return $ reason == "TestExit"
13391499 liftIO $ putMVar supervisedDone ()
1500+ if res
1501+ then return ()
1502+ else die "Something went horribly wrong"
13401503
13411504 runProcess localNode $ do
13421505 liftIO $ takeMVar handlerSetUp
13431506 ref <- monitor pid
13441507 exit pid "TestExit"
13451508 -- This time the client catches the exception, so it dies normally
1346− ProcessMonitorNotification ref' pid' DiedNormal <- expect
1347− True <- return $ ref == ref' && pid == pid'
1348− liftIO $ putMVar supervisorDone ()
1509+ mn <- expect
1510+ case mn of
1511+ ProcessMonitorNotification ref' pid' DiedNormal -> do
1512+ let res = ref == ref' && pid == pid'
1513+ liftIO $ putMVar supervisorDone ()
1514+ if res
1515+ then return ()
1516+ else die "Something went horribly wrong"
1517+ _ -> die "Something went horribly wrong"
13491518
13501519 takeMVar supervisedDone
13511520 takeMVar supervisorDone
@@ -1361,19 +1530,98 @@ testExitRemote TestTransport{..} = do
13611530 (receiveWait [] :: Process ()) -- block forever
13621531 `catchExit` \_from reason -> do
13631532 -- TODO: should verify that 'from' has the right value
1364− True <- return $ reason == "TestExit"
1533+ res <- return $ reason == "TestExit"
13651534 liftIO $ putMVar supervisedDone ()
1535+ if res
1536+ then return ()
1537+ else die "Something went horribly wrong"
13661538
13671539 runProcess node2 $ do
13681540 ref <- monitor pid
13691541 exit pid "TestExit"
1370− ProcessMonitorNotification ref' pid' DiedNormal <- expect
1371− True <- return $ ref == ref' && pid == pid'
1372− liftIO $ putMVar supervisorDone ()
1542+ mn <- expect
1543+ case mn of
1544+ ProcessMonitorNotification ref' pid' DiedNormal -> do
1545+ res' <- return $ ref == ref' && pid == pid'
1546+ liftIO $ putMVar supervisorDone ()
1547+ if res'
1548+ then return ()
1549+ else die "Something went horribly wrong"
1550+ _ -> die "Something went horribly wrong"
13731551
13741552 takeMVar supervisedDone
13751553 takeMVar supervisorDone
13761554
1555+testRegistryMonitoring :: TestTransport -> Assertion
1556+testRegistryMonitoring TestTransport{..} = do
1557+ node1 <- newLocalNode testTransport initRemoteTable
1558+ node2 <- newLocalNode testTransport initRemoteTable
1559+
1560+ let nid = localNodeId node2
1561+ pid <- forkProcess node1 $ do
1562+ self <- getSelfPid
1563+ runUntilRegistered nid self
1564+ say $ (show self) ++ " registered as " ++ regName
1565+ expect :: Process ()
1566+ say $ (show self) ++ " exiting normally"
1567+
1568+ runProcess node2 $ do
1569+ register regName pid
1570+ say $ regName ++ " registered to " ++ show pid
1571+ res <- whereis regName
1572+ send pid ()
1573+ say $ " sent finish signal to " ++ show pid
1574+ us <- getSelfPid
1575+ liftIO $ assertBool "expected (Just pid)" $ res == (Just pid)
1576+
1577+
1578+ -- This delay isn't essential!
1579+ -- The test case passes perfectly fine without it (feel free to comment out
1580+ -- and see), however waiting a few seconds here, makes it much more likely
1581+ -- that in delayUntilMaybeUnregistered we will hit the match case right
1582+ -- away, and thus not be subjected to a 20 second delay. The value of 4
1583+ -- seconds appears to work optimally on osx and across several linux distros
1584+ -- running in virtual machines (which is essentially what we do in CI)
1585+ void $ receiveTimeout 4000000 [ matchAny return ]
1586+
1587+ -- This delay doesn't serve much purpose in the happy path, however if some
1588+ -- future patch breaks the cooperative behaviour of node controllers viz
1589+ -- remote process registration and notification taking place via ncEffectDied,
1590+ -- there would be the possibility of a race in the test case should we attempt
1591+ -- to evaluate `whereis regName` on node2 right away. In case the name is still
1592+ -- erroneously registered, observing the 20 second delay (or lack of), could at
1593+ -- least give a hint that something is wrong, and we give up our time slice
1594+ -- so that there's a higher change the registrations have been cleaned up
1595+ -- in either case.
1596+ runProcess node2 $ delayUntilMaybeUnregistered nid pid
1597+
1598+ regHere <- newEmptyMVar
1599+ runProcess node2 $ whereis regName >>= liftIO . putMVar regHere
1600+ res <- takeMVar regHere
1601+ case res of
1602+ Nothing -> return ()
1603+ Just pid -> assertBool ("expected Nothing, but got " ++ show pid) False
1604+
1605+ where
1606+ runUntilRegistered nid us = do
1607+ whereisRemoteAsync nid regName
1608+ receiveWait [
1609+ matchIf (\(WhereIsReply n (Just p)) -> n == regName && p == us)
1610+ (const $ return ())
1611+ ]
1612+
1613+ delayUntilMaybeUnregistered nid p = do
1614+ whereisRemoteAsync nid regName
1615+ res <- receiveTimeout 20000000 {- 20 sec delay -} [
1616+ matchIf (\(WhereIsReply n p) -> n == regName && isNothing p)
1617+ (const $ return ())
1618+ ]
1619+ case res of
1620+ Just () -> return ()
1621+ Nothing -> delayUntilMaybeUnregistered nid p
1622+
1623+ regName = "testRegisterRemote"
1624+
13771625testUnsafeSend :: TestTransport -> Assertion
13781626testUnsafeSend TestTransport{..} = do
13791627 serverAddr <- newEmptyMVar
@@ -1389,8 +1637,7 @@ testUnsafeSend TestTransport{..} = do
13891637 void $ forkProcess localNode $ do
13901638 serverPid <- liftIO $ takeMVar serverAddr
13911639 getSelfPid >>= unsafeSend serverPid
1392− () <- expect
1393− liftIO $ putMVar clientDone ()
1640+ expect >>= liftIO . putMVar clientDone
13941641
13951642 takeMVar clientDone
13961643
@@ -1409,8 +1656,7 @@ testUnsafeUSend TestTransport{..} = do
14091656 void $ forkProcess localNode $ do
14101657 serverPid <- liftIO $ takeMVar serverAddr
14111658 getSelfPid >>= unsafeUSend serverPid
1412− () <- expect
1413− liftIO $ putMVar clientDone ()
1659+ expect >>= liftIO . putMVar clientDone
14141660
14151661 takeMVar clientDone
14161662
@@ -1421,8 +1667,7 @@ testUnsafeNSend TestTransport{..} = do
14211667 localNode <- newLocalNode testTransport initRemoteTable
14221668
14231669 pid <- forkProcess localNode $ do
1424− () <- expect
1425− liftIO $ putMVar clientDone ()
1670+ expect >>= liftIO . putMVar clientDone
14261671
14271672 void $ runProcess localNode $ do
14281673 register "foobar" pid
@@ -1440,8 +1685,7 @@ testUnsafeNSendRemote TestTransport{..} = do
14401685 _ <- forkProcess localNode1 $ do
14411686 getSelfPid >>= register "foobar"
14421687 liftIO $ putMVar clientDone ()
1443− () <- expect
1444− liftIO $ putMVar clientDone ()
1688+ expect >>= liftIO . putMVar clientDone
14451689
14461690 takeMVar clientDone
14471691 void $ runProcess localNode2 $ do
@@ -1465,7 +1709,7 @@ testUnsafeSendChan TestTransport{..} = do
14651709 serverPid <- liftIO $ takeMVar serverAddr
14661710 (sp, rp) <- newChan
14671711 unsafeSend serverPid sp
1468− () <- receiveChan rp
1712+ receiveChan rp :: Process ()
14691713 liftIO $ putMVar clientDone ()
14701714
14711715 takeMVar clientDone
@@ -1479,8 +1723,8 @@ testCallLocal TestTransport{..} = do
14791723 runProcess node $ do
14801724 r <- (/=) <$> getSelfPid <*> callLocal getSelfPid
14811725 liftIO $ putMVar result r
1482− True <- takeMVar result
1483− return ()
1726+
1727+ takeMVar result >>= assertBool "Expected 'True'"
14841728
14851729 -- Testing that when callLocal is interrupted, the worker is interrupted.
14861730 ibox <- newIORef False
@@ -1497,10 +1741,9 @@ testCallLocal TestTransport{..} = do
14971741 (send keeper ())
14981742 caller <- expect
14991743 exit caller "test"
1500− () <- expect
1501− return ()
1502− True <- readIORef ibox
1503− return ()
1744+ expect :: Process ()
1745+
1746+ readIORef ibox >>= assertBool "Expected 'True'"
15041747
15051748 -- Testing that when the worker raises an exception, the exception is propagated to the parent.
15061749 ibox2 <- newIORef False
@@ -1509,8 +1752,8 @@ testCallLocal TestTransport{..} = do
15091752 liftIO $ writeIORef ibox2 $ case r of
15101753 Left (ErrorCall "e") -> True
15111754 _ -> False
1512− True <- readIORef ibox
1513− return ()
1755+
1756+ readIORef ibox >>= assertBool "Expected 'True'"
15141757
15151758 -- Test that caller waits for the worker in correct situation
15161759 ibox3 <- newIORef False
@@ -1527,8 +1770,8 @@ testCallLocal TestTransport{..} = do
15271770 liftIO $ putMVar result3 =<< readIORef ibox3
15281771 worker <- expect
15291772 send worker ()
1530− True <- takeMVar result3
1531− return ()
1773+
1774+ takeMVar result3 >>= assertBool "Expected 'True'"
15321775
15331776 -- Test that caller waits for the worker in case when caller gets an exception
15341777 ibox4 <- newIORef False
@@ -1544,13 +1787,9 @@ testCallLocal TestTransport{..} = do
15441787 `finally` (liftIO $ putMVar result4 =<< readIORef ibox4)
15451788 caller <- expect
15461789 exit caller "hi!"
1547− True <- takeMVar result4
1548− return ()
1549− -- XXX: Testing that when mask_ $ callLocal p runs p in masked state.
1550−
1551−
1552−
15531790
1791+ takeMVar result4 >>= assertBool "Expected 'True'"
1792+ -- XXX: Testing that when mask_ $ callLocal p runs p in masked state.
15541793
15551794tests :: TestTransport -> IO [Test]
15561795tests testtrans = return [
@@ -1575,6 +1814,7 @@ tests testtrans = return [
15751814 , testCase "MatchMessageUnwrap" (testMatchMessageWithUnwrap testtrans)
15761815 , testCase "ReceiveChanTimeout" (testReceiveChanTimeout testtrans)
15771816 , testCase "ReceiveChanFeatures" (testReceiveChanFeatures testtrans)
1817+ , testCase "ChanLifecycle" (testChanLifecycle testtrans)
15781818 , testCase "KillLocal" (testKillLocal testtrans)
15791819 , testCase "KillRemote" (testKillRemote testtrans)
15801820 , testCase "Die" (testDie testtrans)
@@ -1584,6 +1824,7 @@ tests testtrans = return [
15841824 , testCase "MaskRestoreScope" (testMaskRestoreScope testtrans)
15851825 , testCase "ExitLocal" (testExitLocal testtrans)
15861826 , testCase "ExitRemote" (testExitRemote testtrans)
1827+ , testCase "RegistryMonitoring" (testRegistryMonitoring testtrans)
15871828 , testCase "TextCallLocal" (testCallLocal testtrans)
15881829 -- Unsafe Primitives
15891830 , testCase "TestUnsafeSend" (testUnsafeSend testtrans)
@@ -1636,17 +1877,3 @@ tests testtrans = return [
16361877 , testCase "MonitorUnreachable" (testMonitorUnreachable testtrans True False)
16371878 ]
16381879 ]
1639−
1640−syncBreakConnection :: (NT.EndPointAddress -> NT.EndPointAddress -> IO ()) -> LocalNode -> LocalNode -> IO ()
1641−syncBreakConnection breakConnection nid0 nid1 = do
1642− m <- newEmptyMVar
1643− _ <- forkProcess nid1 $ getSelfPid >>= liftIO . putMVar m
1644− runProcess nid0 $ do
1645− them <- liftIO $ takeMVar m
1646− pinger <- spawnLocal $ forever $ send them ()
1647− _ <- monitorNode (localNodeId nid1)
1648− liftIO $ breakConnection (nodeAddress $ localNodeId nid0)
1649− (nodeAddress $ localNodeId nid1)
1650− NodeMonitorNotification _ _ _ <- expect
1651− kill pinger "finished"
1652− return ()
distributed-process-tests/src/Control/Distributed/Process/Tests/Closure.hs+83−44
@@ -169,8 +169,11 @@ testUnclosure TestTransport{..} rtable = do
169169 node <- newLocalNode testTransport rtable
170170 done <- newEmptyMVar
171171 forkProcess node $ do
172− 120 <- join . unClosure $ factorialClosure 5
172+ i <- join . unClosure $ factorialClosure 5
173173 liftIO $ putMVar done ()
174+ if i == 720
175+ then return ()
176+ else error "Something went horribly wrong"
174177 takeMVar done
175178
176179testBind :: TestTransport -> RemoteTable -> Assertion
@@ -180,8 +183,11 @@ testBind TestTransport{..} rtable = do
180183 runProcess node $ do
181184 us <- getSelfPid
182185 join . unClosure $ sendFac 6 us
183− (720 :: Int) <- expect
186+ (i :: Int) <- expect
184187 liftIO $ putMVar done ()
188+ if i == 720
189+ then return ()
190+ else error "Something went horribly wrong"
185191 takeMVar done
186192
187193testSendPureClosure :: TestTransport -> RemoteTable -> Assertion
@@ -194,7 +200,7 @@ testSendPureClosure TestTransport{..} rtable = do
194200 addr <- forkProcess node $ do
195201 cl <- expect
196202 fn <- unClosure cl :: Process (Int -> Int)
197− 13 <- return $ fn 6
203+ (_ :: Int) <- return $ fn 6
198204 liftIO $ putMVar serverDone ()
199205 putMVar serverAddr addr
200206
@@ -218,8 +224,11 @@ testSendIOClosure TestTransport{..} rtable = do
218224 liftIO $ do
219225 someMVar <- newEmptyMVar
220226 io someMVar
221− 5 <- readMVar someMVar
227+ i <- readMVar someMVar
222228 putMVar serverDone ()
229+ if i == 5
230+ then return ()
231+ else error "Something went horribly wrong"
223232 putMVar serverAddr addr
224233
225234 forkIO $ do
@@ -248,8 +257,10 @@ testSendProcClosure TestTransport{..} rtable = do
248257 runProcess node $ do
249258 pid <- getSelfPid
250259 send theirAddr (cpSend $(mkStatic 'sdictInt) pid)
251− 5 <- expect :: Process Int
252− liftIO $ putMVar clientDone ()
260+ i <- expect :: Process Int
261+ if i == 5
262+ then liftIO $ putMVar clientDone ()
263+ else error "Something went horribly wrong"
253264
254265 takeMVar clientDone
255266
@@ -269,8 +280,9 @@ testSpawn TestTransport{..} rtable = do
269280 pid <- getSelfPid
270281 pid' <- spawn nid (sendPidClosure pid)
271282 pid'' <- expect
272− True <- return $ pid' == pid''
273− liftIO $ putMVar clientDone ()
283+ if pid' == pid''
284+ then liftIO $ putMVar clientDone ()
285+ else error "Something went horribly wrong"
274286
275287 takeMVar clientDone
276288
@@ -294,8 +306,9 @@ testSpawnRace TestTransport{..} rtable = do
294306 spawnLocal $ spawn (localNodeId node2) (sendPidClosure pid) >>= send pid
295307 pid' <- expect :: Process ProcessId
296308 pid'' <- expect :: Process ProcessId
297− True <- return $ pid' == pid''
298− return ()
309+ if pid' == pid''
310+ then return ()
311+ else error "Something went horribly wrong"
299312
300313 where
301314
@@ -332,8 +345,10 @@ testCall TestTransport{..} rtable = do
332345 node <- newLocalNode testTransport rtable
333346 nid <- readMVar serverNodeAddr
334347 runProcess node $ do
335− (120 :: Int) <- call $(mkStatic 'sdictInt) nid (factorialClosure 5)
336− liftIO $ putMVar clientDone ()
348+ (a :: Int) <- call $(mkStatic 'sdictInt) nid (factorialClosure 5)
349+ if a == 120
350+ then liftIO $ putMVar clientDone ()
351+ else error "something went horribly wrong"
337352
338353 takeMVar clientDone
339354
@@ -350,8 +365,10 @@ testCallBind TestTransport{..} rtable = do
350365 node <- newLocalNode testTransport rtable
351366 nid <- readMVar serverNodeAddr
352367 runProcess node $ do
353− (120 :: Int) <- call $(mkStatic 'sdictInt) nid (factorial' 5)
354− liftIO $ putMVar clientDone ()
368+ (a :: Int) <- call $(mkStatic 'sdictInt) nid (factorial' 5)
369+ if a == 120
370+ then liftIO $ putMVar clientDone ()
371+ else error "Something went horribly wrong"
355372
356373 takeMVar clientDone
357374
@@ -362,9 +379,11 @@ testSeq TestTransport{..} rtable = do
362379 runProcess node $ do
363380 us <- getSelfPid
364381 join . unClosure $ sendFac 5 us `seqCP` sendFac 6 us
365− 120 :: Int <- expect
366− 720 :: Int <- expect
367− liftIO $ putMVar done ()
382+ a :: Int <- expect
383+ b :: Int <- expect
384+ if a == 120 && b == 720
385+ then liftIO $ putMVar done ()
386+ else error "Something went horribly wrong"
368387 takeMVar done
369388
370389-- Test 'spawnSupervised'
@@ -393,25 +412,33 @@ testSpawnSupervised TestTransport{..} rtable = do
393412 throw supervisorDeath
394413
395414 forkProcess node2 $ do
396− [super, child] <- liftIO $ mapM readMVar [superPid, childPid]
397− ref <- monitor child
398− self <- getSelfPid
399− let waitForMOrL = do
400− liftIO $ threadDelay 10000
401− mpinfo <- getProcessInfo child
402− case mpinfo of
403− Nothing -> waitForMOrL
404− Just pinfo ->
405− unless (isJust $ lookup self (infoMonitors pinfo)) waitForMOrL
406− waitForMOrL
407− liftIO $ putMVar linkUp ()
408− -- because monitor message was sent before message to process
409− -- we hope that it will be processed before
410− ProcessMonitorNotification ref' pid' (DiedException e) <- expect
411− True <- return $ ref' == ref
412− && pid' == child
413− && e == show (ProcessLinkException super (DiedException (show supervisorDeath)))
414− liftIO $ putMVar thirdProcessDone ()
415+ res <- liftIO $ mapM readMVar [superPid, childPid]
416+ case res of
417+ [super, child] -> do
418+ ref <- monitor child
419+ self <- getSelfPid
420+ let waitForMOrL = do
421+ liftIO $ threadDelay 10000
422+ mpinfo <- getProcessInfo child
423+ case mpinfo of
424+ Nothing -> waitForMOrL
425+ Just pinfo ->
426+ unless (isJust $ lookup self (infoMonitors pinfo)) waitForMOrL
427+ waitForMOrL
428+ liftIO $ putMVar linkUp ()
429+ -- because monitor message was sent before message to process
430+ -- we hope that it will be processed before
431+ res' <- expect
432+ case res' of
433+ (ProcessMonitorNotification ref' pid' (DiedException e)) ->
434+ if (ref' == ref && pid' == child &&
435+ e == show (ProcessLinkException super
436+ (DiedException (show supervisorDeath))))
437+ then liftIO $ putMVar thirdProcessDone ()
438+ else error "Something went horribly wrong"
439+ _ -> error "Something went horribly wrong"
440+
441+ _ -> die $ "Something went horribly wrong"
415442
416443 takeMVar thirdProcessDone
417444 where
@@ -426,8 +453,10 @@ testSpawnInvalid TestTransport{..} rtable = do
426453 (pid, ref) <- spawnMonitor (localNodeId node) (closure (staticLabel "ThisDoesNotExist") empty)
427454 ProcessMonitorNotification ref' pid' _reason <- expect
428455 -- Depending on the exact interleaving, reason might be NoProc or the exception thrown by the absence of the static closure
429− True <- return $ ref' == ref && pid == pid'
430− liftIO $ putMVar done ()
456+ res <- return $ ref' == ref && pid == pid'
457+ if res == True
458+ then liftIO $ putMVar done ()
459+ else error "Something went horribly wrong"
431460 takeMVar done
432461
433462testClosureExpect :: TestTransport -> RemoteTable -> Assertion
@@ -439,8 +468,10 @@ testClosureExpect TestTransport{..} rtable = do
439468 us <- getSelfPid
440469 them <- spawn nodeId $ cpExpect $(mkStatic 'sdictInt) `bindCP` cpSend $(mkStatic 'sdictInt) us
441470 send them (1234 :: Int)
442− (1234 :: Int) <- expect
443− liftIO $ putMVar done ()
471+ (res :: Int) <- expect
472+ if res == 1234
473+ then liftIO $ putMVar done ()
474+ else error "Something went horribly wrong"
444475 takeMVar done
445476
446477testSpawnChannel :: TestTransport -> RemoteTable -> Assertion
@@ -465,8 +496,10 @@ testTDict TestTransport{..} rtable = do
465496 done <- newEmptyMVar
466497 [node1, node2] <- replicateM 2 $ newLocalNode testTransport rtable
467498 forkProcess node1 $ do
468− True <- call $(functionTDict 'isPrime) (localNodeId node2) ($(mkClosure 'isPrime) (79 :: Integer))
469− liftIO $ putMVar done ()
499+ res <- call $(functionTDict 'isPrime) (localNodeId node2) ($(mkClosure 'isPrime) (79 :: Integer))
500+ if res == True
501+ then liftIO $ putMVar done ()
502+ else error "Something went horribly wrong..."
470503 takeMVar done
471504
472505testFib :: TestTransport -> RemoteTable -> Assertion
@@ -477,8 +510,11 @@ testFib TestTransport{..} rtable = do
477510 forkProcess (head nodes) $ do
478511 (sport, rport) <- newChan
479512 spawnLocal $ dfib (map localNodeId nodes, sport, 10)
480− 55 <- receiveChan rport :: Process Integer
513+ ff <- receiveChan rport :: Process Integer
481514 liftIO $ putMVar done ()
515+ if ff /= 55
516+ then die $ "Something went horribly wrong"
517+ else return ()
482518
483519 takeMVar done
484520
@@ -503,9 +539,12 @@ testSpawnReconnect testtrans@TestTransport{..} rtable = do
503539 liftIO $ threadDelay 100000
504540
505541 count <- liftIO $ takeMVar iv
506− True <- return $ count == 2 || count == 3 -- It depends on which message we get first in 'spawn'
542+ res <- return $ count == 2 || count == 3 -- It depends on which message we get first in 'spawn'
507543
508544 liftIO $ putMVar done ()
545+ if res /= True
546+ then error "Something went horribly wrong"
547+ else return ()
509548
510549 takeMVar done
511550
distributed-process-tests/src/Control/Distributed/Process/Tests/Internal/Utils.hs+16−5
@@ -20,6 +20,7 @@ module Control.Distributed.Process.Tests.Internal.Utils
2020 -- ping !
2121 , Ping(Ping)
2222 , ping
23+ , pause
2324 , shouldBe
2425 , shouldMatch
2526 , shouldContain
@@ -73,15 +74,16 @@ import Control.Concurrent
7374import Control.Concurrent.MVar
7475 ( putMVar
7576 )
76−import Control.Distributed.Process
77+import Control.Distributed.Process hiding (finally, catch)
7778import Control.Distributed.Process.Node
7879import Control.Distributed.Process.Serializable()
7980
8081import Control.Exception (AsyncException(ThreadKilled), SomeException)
81−import Control.Monad (forever)
82+import Control.Monad (forever, void)
83+import Control.Monad.Catch (finally, catch)
8284import Control.Monad.STM (atomically)
8385import Control.Rematch hiding (match)
84−import Control.Rematch.Run
86+import Control.Rematch.Run
8587import Data.Binary
8688import Data.Typeable (Typeable)
8789
@@ -89,6 +91,7 @@ import Test.HUnit (Assertion, assertFailure)
8991import Test.HUnit.Base (assertBool)
9092
9193import GHC.Generics
94+import System.Timeout (timeout)
9295
9396-- | A mutable cell containing a test result.
9497type TestResult a = MVar a
@@ -107,10 +110,18 @@ data TestProcessControl = Stop | Go | Report ProcessId
107110
108111instance Binary TestProcessControl where
109112
113+data Private = Private
114+ deriving (Typeable, Generic)
115+instance Binary Private where
116+
110117-- | Does exactly what it says on the tin, doing so in the @Process@ monad.
111118noop :: Process ()
112119noop = return ()
113120
121+pause :: Int -> Process ()
122+pause delay =
123+ void $ receiveTimeout delay [ match (\Private -> return ()) ]
124+
114125synchronisedAssertion :: Eq a
115126 => String
116127 -> LocalNode
@@ -223,10 +234,10 @@ testProcessReport pid = do
223234tryRunProcess :: LocalNode -> Process () -> IO ()
224235tryRunProcess node p = do
225236 tid <- liftIO myThreadId
226− runProcess node $ catch p (\e -> liftIO $ throwTo tid (e::SomeException))
237+ void $ timeout (1000000 * 60 * 5 :: Int) $
238+ runProcess node $ catch p (\e -> liftIO $ throwTo tid (e::SomeException))
227239
228240tryForkProcess :: LocalNode -> Process () -> IO ProcessId
229241tryForkProcess node p = do
230242 tid <- liftIO myThreadId
231243 forkProcess node $ catch p (\e -> liftIO $ throwTo tid (e::SomeException))
232−
distributed-process-tests/src/Control/Distributed/Process/Tests/Mx.hs+390−51
@@ -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(..)
@@ -21,12 +33,14 @@ import Control.Distributed.Process.Management
2133 , mxNotify
2234 , mxBroadcast
2335 )
24−import Control.Monad (void)
36+import Control.Monad (void, unless)
37+import Control.Monad.Catch(finally, bracket, try)
38+import Control.Rematch (equalTo)
2539import Data.Binary
26−import Data.List (find, sort)
27−import Data.Maybe (isJust)
40+import Data.List (find, sort, intercalate)
41+import Data.Maybe (isJust, fromJust, isNothing, fromMaybe, catMaybes)
2842import Data.Typeable
29−import GHC.Generics
43+import GHC.Generics hiding (from)
3044#if ! MIN_VERSION_base(4,6,0)
3145import Prelude hiding (catch, log)
3246#endif
@@ -42,7 +56,17 @@ data Publish = Publish
4256
4357instance Binary Publish where
4458
45−testAgentBroadcast :: TestResult () -> Process ()
59+awaitExit :: ProcessId -> Process ()
60+awaitExit pid =
61+ withMonitorRef pid $ \ref -> do
62+ receiveWait
63+ [ matchIf (\(ProcessMonitorNotification r _ _) -> r == ref)
64+ (\_ -> return ())
65+ ]
66+ where
67+ withMonitorRef p = bracket (monitor p) unmonitor
68+
69+testAgentBroadcast :: TestResult (Maybe ()) -> Process ()
4670testAgentBroadcast result = do
4771 (resultSP, resultRP) <- newChan :: Process (SendPort (), ReceivePort ())
4872
@@ -57,7 +81,7 @@ testAgentBroadcast result = do
5781 mxNotify ()
5882 -- Once the publisher has seen our message, it will broadcast the Publish
5983 -- and the consumer will see that and send the result to our typed channel.
60− stash result =<< receiveChan resultRP
84+ stash result =<< receiveChanTimeout 10000000 resultRP
6185
6286 kill publisher "finished"
6387 kill consumer "finished"
@@ -65,7 +89,7 @@ testAgentBroadcast result = do
6589testAgentDualInput :: TestResult (Maybe Int) -> Process ()
6690testAgentDualInput result = do
6791 (sp, rp) <- newChan
68− _ <- mxAgent (MxAgentId "sum-agent") (0 :: Int) [
92+ s <- mxAgent (MxAgentId "sum-agent") (0 :: Int) [
6993 mxSink $ (\(i :: Int) -> do
7094 mxSetLocal . (+i) =<< mxGetLocal
7195 i' <- mxGetLocal
@@ -75,6 +99,8 @@ testAgentDualInput result = do
7599 else mxReady)
76100 ]
77101
102+ mRef <- monitor s
103+
78104 mxNotify (1 :: Int)
79105 nsend "sum-agent" (3 :: Int)
80106 mxNotify (2 :: Int)
@@ -82,6 +108,10 @@ testAgentDualInput result = do
82108 mxNotify (5 :: Int)
83109
84110 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)
85115
86116testAgentPrioritisation :: TestResult [String] -> Process ()
87117testAgentPrioritisation result = do
@@ -93,12 +123,12 @@ testAgentPrioritisation result = do
93123
94124 let name = "prioritising-agent"
95125 (sp, rp) <- newChan
96− void $ mxAgent (MxAgentId name) ["first"] [
97− mxSink (\(s :: String) -> do
98− mxUpdateLocal ((s:))
126+ s <- mxAgent (MxAgentId name) ["first"] [
127+ mxSink (\(s :: String) -> do
128+ mxUpdateLocal (s:)
99129 st <- mxGetLocal
100130 case length st of
101− n | n == 5 -> do liftMX $ sendChan sp st
131+ n | n == 5 -> do liftMX $ sendChan sp (sort st)
102132 mxDeactivate "finished"
103133 _ -> mxReceive -- go to the mailbox
104134 )
@@ -109,23 +139,33 @@ testAgentPrioritisation result = do
109139 mxNotify "fourth"
110140 nsend name "fifth"
111141
112− stash result . sort =<< receiveChan rp
142+ stash result . fromMaybe [] =<< receiveChanTimeout 10000000 rp
143+ awaitExit s
113144
114145testAgentMailboxHandling :: TestResult (Maybe ()) -> Process ()
115146testAgentMailboxHandling result = do
116147 (sp, rp) <- newChan
117− agent <- mxAgent (MxAgentId "listener-agent") () [
148+ agent <- mxAgent (MxAgentId "mailbox-agent") () [
118149 mxSink $ \() -> (liftMX $ sendChan sp ()) >> mxReady
119150 ]
120151
121− nsend "listener-agent" ()
152+ nsend "mailbox-agent" ()
122153
123154 stash result =<< receiveChanTimeout 1000000 rp
124155 kill agent "finished"
125156
126157testAgentEventHandling :: TestResult Bool -> Process ()
127158testAgentEventHandling 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+
128167 let initState = [] :: [MxEvent]
168+ (rc, rs) <- newChan
129169 agentPid <- mxAgent (MxAgentId "lifecycle-listener-agent") initState [
130170 (mxSink $ \ev -> do
131171 st <- mxGetLocal
@@ -134,7 +174,7 @@ testAgentEventHandling result = do
134174 (MxSpawned _) -> mxSetLocal (ev:st)
135175 (MxProcessDied _ _) -> mxSetLocal (ev:st)
136176 _ -> return ()
137− act >> mxReady),
177+ act >> (liftMX $ sendChan rc ()) >> mxReady),
138178 (mxSink $ \(ev, sp :: SendPort Bool) -> do
139179 st <- mxGetLocal
140180 let found =
@@ -154,50 +194,349 @@ testAgentEventHandling result = do
154194 mxReady)
155195 ]
156196
157− _ <- monitor agentPid
158− (sp, rp) <- newChan
159− pid <- spawnLocal $ sendChan sp ()
160− () <- receiveChan rp
197+ -- TODO: yes, this is racy, but we're at the mercy of the scheduler here...
198+ faff 2000000 rs
199+
200+ (sp, rp) <- newChan :: Process (SendPort (), ReceivePort ())
201+
202+ pid <- spawnLocal $ expect >>= sendChan sp
161203
162204 -- By waiting for a monitor notification, we have a
163− -- higher probably that the agent has seen
205+ -- higher probably that the agent has seen the spawn and died events
164206 monitor pid
165− receiveWait [ match (\(ProcessMonitorNotification _ _ _) -> return ()) ]
207+
208+ send pid ()
209+ rct <- receiveChanTimeout 10000000 rp
210+ unless (isJust rct) $ die "No response on channel"
211+
212+ pmn <- receiveTimeout 2000000 [ match (\ProcessMonitorNotification{} -> return ()) ]
213+ unless (isJust pmn) $ die "No monitor notification arrived"
214+
215+ -- TODO: yes, this is racy, but we're at the mercy of the scheduler here...
216+ faff 2000000 rs
166217
167218 (replyTo, reply) <- newChan :: Process (SendPort Bool, ReceivePort Bool)
168219 mxNotify (MxSpawned pid, replyTo)
169220 mxNotify (MxProcessDied pid DiedNormal, replyTo)
170221
171− seenAlive <- receiveChan reply
172− seenDead <- receiveChan reply
222+ seenAlive <- receiveChanTimeout 10000000 reply
223+ seenDead <- receiveChanTimeout 10000000 reply
224+
225+ stash result $ foldr (&&) True $ catMaybes [seenAlive, seenDead]
226+ kill timer "test-complete"
227+ kill agentPid "test-complete"
228+ where
229+ faff delay port = do
230+ res <- receiveChanTimeout delay port
231+ unless (isNothing res) $ pause delay
232+
233+testMxRegEvents :: TestResult () -> Process ()
234+testMxRegEvents result = do
235+ {- This test only deals with the local case, to ensure that we are being
236+ notified in the expected order - the remote cases related to the
237+ behaviour of the node controller are contained in the CH test suite. -}
238+ ensure (stash result ()) $ do
239+ let label = "testMxRegEvents"
240+ let agentLabel = "mxRegEvents-agent"
241+ let delay = 1000000
242+ (regChan, regSink) <- newChan
243+ (unRegChan, unRegSink) <- newChan
244+ agent <- mxAgent (MxAgentId agentLabel) () [
245+ mxSink $ \ev -> do
246+ case ev of
247+ MxRegistered pid label'
248+ | label' == label -> liftMX $ sendChan regChan (label', pid)
249+ MxUnRegistered pid label'
250+ | label' == label -> liftMX $ sendChan unRegChan (label', pid)
251+ _ -> return ()
252+ mxReady
253+ ]
254+
255+ p1 <- spawnLocal expect
256+ p2 <- spawnLocal expect
257+
258+ register label p1
259+ reg1 <- receiveChanTimeout delay regSink
260+ reg1 `shouldBe` equalTo (Just (label, p1))
261+
262+ unregister label
263+ unreg1 <- receiveChanTimeout delay unRegSink
264+ unreg1 `shouldBe` equalTo (Just (label, p1))
265+
266+ register label p2
267+ reg2 <- receiveChanTimeout delay regSink
268+ reg2 `shouldBe` equalTo (Just (label, p2))
269+
270+ reregister label p1
271+ unreg2 <- receiveChanTimeout delay unRegSink
272+ unreg2 `shouldBe` equalTo (Just (label, p2))
273+
274+ reg3 <- receiveChanTimeout delay regSink
275+ reg3 `shouldBe` equalTo (Just (label, p1))
276+
277+ mapM_ (flip kill $ "test-complete") [agent, p1, p2]
278+
279+testMxRegMon :: LocalNode -> TestResult () -> Process ()
280+testMxRegMon remoteNode result = do
281+ ensure (stash result ()) $ do
282+ -- ensure that when a registered process dies, we get a notification that
283+ -- it has been unregistered as well as seeing the name get removed
284+ let label1 = "aaaaa"
285+ let label2 = "bbbbb"
286+ let isValid l = l == label1 || l == label2
287+ let agentLabel = "mxRegMon-agent"
288+ let delay = 1000000
289+ (regChan, regSink) <- newChan
290+ (unRegChan, unRegSink) <- newChan
291+ agent <- mxAgent (MxAgentId agentLabel) () [
292+ mxSink $ \ev -> do
293+ case ev of
294+ MxRegistered pid label
295+ | isValid label -> liftMX $ sendChan regChan (label, pid)
296+ MxUnRegistered pid label
297+ | isValid label -> liftMX $ sendChan unRegChan (label, pid)
298+ _ -> return ()
299+ mxReady
300+ ]
301+
302+ (sp, rp) <- newChan
303+ liftIO $ forkProcess remoteNode $ do
304+ getSelfPid >>= sendChan sp
305+ expect :: Process ()
306+
307+ p1 <- receiveChan rp
308+
309+ register label1 p1
310+ reg1 <- receiveChanTimeout delay regSink
311+ reg1 `shouldBe` equalTo (Just (label1, p1))
312+
313+ register label2 p1
314+ reg2 <- receiveChanTimeout delay regSink
315+ reg2 `shouldBe` equalTo (Just (label2, p1))
316+
317+ n1 <- whereis label1
318+ n1 `shouldBe` equalTo (Just p1)
319+
320+ n2 <- whereis label2
321+ n2 `shouldBe` equalTo (Just p1)
322+
323+ kill p1 "goodbye"
173324
174− stash result $ seenAlive && seenDead
325+ unreg1 <- receiveChanTimeout delay unRegSink
326+ unreg2 <- receiveChanTimeout delay unRegSink
327+
328+ let evts = [unreg1, unreg2]
329+ -- we can't rely on the order of the values in the node controller's
330+ -- map (it's either racy to do so, or no such guarantee exists for Data.Map),
331+ -- so we simply verify that we received the un-registration events we expect
332+ evts `shouldContain` (Just (label1, p1))
333+ evts `shouldContain` (Just (label2, p1))
334+
335+ kill agent "test-complete"
336+
337+ensure :: Process () -> Process () -> Process ()
338+ensure = flip finally
339+
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
175466
176467tests :: TestTransport -> IO [Test]
177468tests TestTransport{..} = do
178469 node1 <- newLocalNode testTransport initRemoteTable
470+ node2 <- newLocalNode testTransport initRemoteTable
179471 return [
180− testGroup "Mx Agents" [
181− testCase "Event Handling"
182− (delayedAssertion
183− "expected True, but events where not as expected"
184− node1 True testAgentEventHandling)
185− , testCase "Inter-Agent Broadcast"
186− (delayedAssertion
187− "expected (), but no broadcast was received"
188− node1 () testAgentBroadcast)
189− , testCase "Agent Mailbox Handling"
190− (delayedAssertion
191− "expected (Just ()), but no regular (mailbox) input was handled"
192− node1 (Just ()) testAgentMailboxHandling)
193− , testCase "Agent Dual Input Handling"
194− (delayedAssertion
195− "expected sum = 15, but the result was Nothing"
196− node1 (Just 15 :: Maybe Int) testAgentDualInput)
197− , testCase "Agent Input Prioritisation"
198− (delayedAssertion
199− "expected [first, second, third, fourth, fifth], but result diverged"
200− node1 (sort ["first", "second",
201− "third", "fourth",
202− "fifth"]) testAgentPrioritisation)
203− ]]
472+ testGroup "MxAgents" [
473+ testCase "EventHandling"
474+ (delayedAssertion
475+ "expected True, but events where not as expected"
476+ node1 True testAgentEventHandling)
477+ , testCase "InterAgentBroadcast"
478+ (delayedAssertion
479+ "expected (), but no broadcast was received"
480+ node1 (Just ()) testAgentBroadcast)
481+ , testCase "AgentMailboxHandling"
482+ (delayedAssertion
483+ "expected (Just ()), but no regular (mailbox) input was handled"
484+ node1 (Just ()) testAgentMailboxHandling)
485+ , testCase "AgentDualInputHandling"
486+ (delayedAssertion
487+ "expected sum = 15, but the result was Nothing"
488+ node1 (Just 15 :: Maybe Int) testAgentDualInput)
489+ , testCase "AgentInputPrioritisation"
490+ (delayedAssertion
491+ "expected [first, second, third, fourth, fifth], but result diverged"
492+ node1 (sort ["first", "second",
493+ "third", "fourth",
494+ "fifth"]) testAgentPrioritisation)
495+ ]
496+ , testGroup "MxEvents" [
497+ testCase "NameRegistrationEvents"
498+ (delayedAssertion
499+ "expected registration events to map to the correct ProcessId"
500+ node1 () testMxRegEvents)
501+ , testCase "PostDeathNameUnRegistrationEvents"
502+ (delayedAssertion
503+ "expected process deaths to result in unregistration events"
504+ node1 () (testMxRegMon node2))
505+ , testGroup "SendEvents" $ buildTestCases node1 node2
506+ ]
507+ ]
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+ ]
distributed-process-tests/src/Control/Distributed/Process/Tests/Stats.hs+11−7
@@ -29,7 +29,7 @@ import Test.Framework.Providers.HUnit (testCase)
2929
3030testLocalDeadProcessInfo :: TestResult (Maybe ProcessInfo) -> Process ()
3131testLocalDeadProcessInfo result = do
32− pid <- spawnLocal $ do "finish" <- expect; return ()
32+ pid <- spawnLocal $ do (_ :: String) <- expect; return ()
3333 mref <- monitor pid
3434 send pid "finish"
3535 _ <- receiveWait [
@@ -52,8 +52,10 @@ testLocalLiveProcessInfo result = do
5252 link self
5353 mRef <- monitor self
5454 stash mon mRef
55− "die" <- expect
56− return ()
55+ res <- expect
56+ case res of
57+ "die" -> return ()
58+ _ -> die $ "unexpected message received: " ++ res
5759
5860 monRef <- liftIO $ takeMVar mon
5961
@@ -84,9 +86,9 @@ testRemoteLiveProcessInfo TestTransport{..} node1 = do
8486 -- our send op shouldn't overtake link or monitor requests AFAICT
8587 -- so a little table tennis should get us synchronised properly
8688 send serverPid (self, "ping")
87− "pong" <- expect
89+ pong <- expect
8890 pInfo <- getProcessInfo serverPid
89− stash result $ pInfo /= Nothing
91+ stash result $ pong == "pong" && pInfo /= Nothing
9092 where
9193 launchRemote :: MVar ProcessId -> IO ()
9294 launchRemote locMV = do
@@ -97,8 +99,10 @@ testRemoteLiveProcessInfo TestTransport{..} node1 = do
9799 _ <- receiveWait [
98100 match (\(pid, "ping") -> send pid "pong")
99101 ]
100− "stop" <- expect
101− return ()
102+ res <- expect
103+ case res of
104+ "stop" -> return ()
105+ _ -> die $ "unexpected message received: " ++ res
102106 return ()
103107
104108 withActiveRemote :: LocalNode
distributed-process-tests/src/Control/Distributed/Process/Tests/Tracing.hs+23−11
@@ -125,9 +125,11 @@ testTraceSending result = do
125125 (\ev ->
126126 case ev of
127127 (MxSent to from msg) -> do
128− (Just s) <- unwrapMessage msg :: Process (Maybe String)
129− stash res (to == pid && from == self && s == "hello there")
130− stash res (to == pid && from == self)
128+ mS <- unwrapMessage msg :: Process (Maybe String)
129+ case mS of
130+ (Just s) -> do stash res (to == pid && from == self && s == "hello there")
131+ stash res (to == pid && from == self)
132+ _ -> die "failed state invariant, message type unmatched..."
131133 _ ->
132134 return ()) $ do
133135 send pid "hello there"
@@ -246,12 +248,8 @@ testRemoteTraceRelay TestTransport{..} result =
246248 -- Here we set up that relay, and then wait for a signal
247249 -- that the tracer (on node1) has seen the expected
248250 -- MxSpawned message, at which point we're finished
249− (Just log') <- whereis "logger"
250− pid <- liftIO $ forkProcess node2 $ do
251− logRelay <- spawnLocal $ relay log'
252− reregister "logger" logRelay
253− getSelfNode >>= stash mvNid >> (expect :: Process ())
254251
252+ pid <- splinchLogger node2 mvNid
255253 nid <- liftIO $ takeMVar mvNid
256254 mref <- monitor pid
257255 observedPid <- liftIO $ newEmptyMVar
@@ -291,6 +289,17 @@ testRemoteTraceRelay TestTransport{..} result =
291289 -- and just to be polite...
292290 liftIO $ closeLocalNode node2
293291
292+ where
293+ splinchLogger n2 mv = do
294+ mLog <- whereis "logger"
295+ case mLog of
296+ Nothing -> die "no logger registered"
297+ Just log' -> do liftIO $ forkProcess n2 $ do
298+ logRelay <- spawnLocal $ relay log'
299+ reregister "logger" logRelay
300+ getSelfNode >>= stash mv >> (expect :: Process ())
301+
302+
294303-- | Sets the value of an environment variable while executing the given IO
295304-- computation and restores the preceeding value upon completion.
296305withEnv :: String -> String -> IO a -> IO a
@@ -319,9 +328,12 @@ testSystemLoggerMsg t action interestingMessage =
319328 -- Wait for the trace message.
320329 receiveWait [ matchIf interestingMessage' $ const $ return () ]
321330 -- Only one interesting message should arrive.
322− Nothing <- receiveTimeout 100000
323− [ matchIf interestingMessage' $ const $ return () ]
324− return ()
331+ expectedTimeout <- receiveTimeout
332+ 100000
333+ [ matchIf interestingMessage' $ const $ return () ]
334+ case expectedTimeout of
335+ Nothing -> return ()
336+ Just _ -> die "Unexpected message arrived..."
325337
326338
327339-- | Tests that one and only one trace message is produced when a message is
distributed-process-tests/tests/runTCP.hs+2−2
@@ -10,6 +10,7 @@ import Network.Transport.TCP
1010 ( createTransportExposeInternals
1111 , TransportInternals(socketBetween)
1212 , defaultTCPParameters
13+ , defaultTCPAddr
1314 , TCPParameters(..)
1415 )
1516import Test.Framework (defaultMainWithArgs)
@@ -24,8 +25,7 @@ main = do
2425 hSetBuffering stdout LineBuffering
2526 hSetBuffering stderr LineBuffering
2627 Right (transport, internals) <-
27− createTransportExposeInternals "127.0.0.1" "8080"
28− (\sn -> ("127.0.0.1", sn))
28+ createTransportExposeInternals (defaultTCPAddr "127.0.0.1" "8080")
2929 defaultTCPParameters { transportConnectTimeout = Just 3000000 }
3030 ts <- tests TestTransport
3131 { testTransport = transport
distributed-process.cabal+3−3
@@ -6,7 +6,7 @@ License: BSD3
66License-File: LICENSE
77Copyright: Well-Typed LLP, Tweag I/O Limited
88Author: Duncan Coutts, Nicolas Wu, Edsko de Vries
9−Maintainer: Facundo Domínguez <facundo.dominguez@tweag.io>
9+Maintainer: Tim Watson <watson.timothy@gmail.com>
1010Stability: experimental
1111Homepage: http://haskell-distributed.github.com/
1212Bug-Reports: https://github.com/haskell-distributed/distributed-process/issues
@@ -45,7 +45,7 @@ Library
4545 binary >= 0.6.3 && < 0.10,
4646 hashable >= 1.2.0.5 && < 1.3,
4747 network-transport >= 0.4.1.0 && < 0.6,
48− stm >= 2.4 && < 2.5,
48+ stm >= 2.4 && < 2.6,
4949 transformers >= 0.2 && < 0.6,
5050 mtl >= 2.0 && < 2.4,
5151 data-accessor >= 0.2 && < 0.3,
@@ -55,7 +55,7 @@ Library
5555 rank1dynamic >= 0.1 && < 0.5,
5656 syb >= 0.3 && < 0.8,
5757 exceptions >= 0.5,
58− containers >= 0.5 && < 0.6,
58+ containers >= 0.5 && < 0.7,
5959 deepseq >= 1.3.0.1 && < 1.6
6060 Exposed-modules: Control.Distributed.Process,
6161 Control.Distributed.Process.Closure,
src/Control/Distributed/Process/Internal/Primitives.hs+60−43
@@ -76,6 +76,7 @@ module Control.Distributed.Process.Internal.Primitives
7676 , unlink
7777 , monitor
7878 , unmonitor
79+ , unmonitorAsync
7980 , withMonitor
8081 , withMonitor_
8182 -- * Logging
@@ -253,17 +254,15 @@ send them msg = do
253254 node = processNode proc
254255 nodeId = localNodeId node
255256 destNode = (processNodeId them) in do
256− case destNode == nodeId of
257− True -> sendLocal them msg
258− False -> liftIO $ sendMessage (processNode proc)
259− (ProcessIdentifier (processId proc))
260− (ProcessIdentifier them)
261− NoImplicitReconnect
262− msg
263− -- We do not fire the trace event until after the sending is complete;
264− -- In the remote case, 'sendMessage' can block in the networking stack.
265257 liftIO $ traceEvent (localEventBus node)
266258 (MxSent them us (createUnencodedMessage msg))
259+ if destNode == nodeId
260+ then sendLocal them msg
261+ else liftIO $ sendMessage (processNode proc)
262+ (ProcessIdentifier (processId proc))
263+ (ProcessIdentifier them)
264+ NoImplicitReconnect
265+ msg
267266
268267-- | /Unsafe/ variant of 'send'. This function makes /no/ attempt to serialize
269268-- and (in the case when the destination process resides on the same local
@@ -283,9 +282,12 @@ unsafeSend = Unsafe.send
283282--
284283usend :: Serializable a => ProcessId -> a -> Process ()
285284usend them msg = do
286− here <- getSelfNode
285+ proc <- ask
287286 let there = processNodeId them
288− if here == there
287+ let (us, node) = (processId proc, processNode proc)
288+ let msg' = wrapMessage msg
289+ liftIO $ traceEvent (localEventBus node) (MxSent them us msg')
290+ if localNodeId (processNode proc) == there
289291 then sendLocal them msg
290292 else sendCtrlMsg (Just there) $ UnreliableSend (processLocalId them)
291293 (createMessage msg)
@@ -305,7 +307,13 @@ expect = receiveWait [match return]
305307-- Channels --
306308--------------------------------------------------------------------------------
307309
308−-- | Create a new typed channel
310+-- | Create a new typed channel, bound to the calling Process
311+--
312+-- Note that the channel is bound to the lifecycle of the process that evaluates
313+-- this function, such that when it dies/exits, the channel will no longer
314+-- function, but will remain accessible. Thus reading from the ReceivePort will
315+-- fail silently thereafter, blocking indefinitely (unless a timeout is used).
316+--
309317newChan :: Serializable a => Process (SendPort a, ReceivePort a)
310318newChan = do
311319 proc <- ask
@@ -333,13 +341,16 @@ newChan = do
333341sendChan :: Serializable a => SendPort a -> a -> Process ()
334342sendChan (SendPort cid) msg = do
335343 proc <- ask
336− let node = localNodeId (processNode proc)
337− destNode = processNodeId (sendPortProcessId cid) in do
338− case destNode == node of
344+ let node = processNode proc
345+ pid = processId proc
346+ us = localNodeId node
347+ them = processNodeId (sendPortProcessId cid) in do
348+ liftIO $ traceEvent (localEventBus node) (MxSentToPort pid cid $ wrapMessage msg)
349+ case them == us of
339350 True -> sendChanLocal cid msg
340351 False -> do
341− liftIO $ sendBinary (processNode proc)
342− (ProcessIdentifier (processId proc))
352+ liftIO $ sendBinary node
353+ (ProcessIdentifier pid)
343354 (SendPortIdentifier cid)
344355 NoImplicitReconnect
345356 msg
@@ -400,8 +411,11 @@ newtype Match b = Match { unMatch :: MatchOn Message (Process b) }
400411receiveWait :: [Match b] -> Process b
401412receiveWait ms = do
402413 queue <- processQueue <$> ask
403− Just proc <- liftIO $ dequeue queue Blocking (map unMatch ms)
404− proc
414+ mProc <- liftIO $ dequeue queue Blocking (map unMatch ms)
415+ case mProc of
416+ Just proc' -> proc'
417+ Nothing -> die $ "System Invariant Violation: CQueue.hs returned `Nothing` "
418+ ++ "in the absence of a timeout value."
405419
406420-- | Like 'receiveWait' but with a timeout.
407421--
@@ -480,17 +494,14 @@ forward msg them = do
480494 us = processId proc
481495 nid = localNodeId node
482496 destNode = (processNodeId them) in do
483− case destNode == nid of
484− True -> sendCtrlMsg Nothing (LocalSend them msg)
485− False -> liftIO $ sendPayload (processNode proc)
486− (ProcessIdentifier (processId proc))
487− (ProcessIdentifier them)
488− NoImplicitReconnect
489− (messageToPayload msg)
490− -- We do not fire the trace event until after the sending is complete;
491− -- In the remote case, 'sendMessage' can block in the networking stack.
492− liftIO $ traceEvent (localEventBus node)
493− (MxSent them us msg)
497+ liftIO $ traceEvent (localEventBus node) (MxSent them us msg)
498+ if destNode == nid
499+ then sendCtrlMsg Nothing (LocalSend them msg)
500+ else liftIO $ sendPayload (processNode proc)
501+ (ProcessIdentifier (processId proc))
502+ (ProcessIdentifier them)
503+ NoImplicitReconnect
504+ (messageToPayload msg)
494505
495506-- | Forward a raw 'Message' to the given 'ProcessId'.
496507--
@@ -504,14 +515,10 @@ uforward msg them = do
504515 us = processId proc
505516 nid = localNodeId node
506517 destNode = (processNodeId them) in do
507− case destNode == nid of
508− True -> sendCtrlMsg Nothing (LocalSend them msg)
509− False -> sendCtrlMsg (Just destNode) $ UnreliableSend (processLocalId them)
510− msg
511− -- We do not fire the trace event until after the sending is complete;
512− -- In the remote case, 'sendCtrlMsg' can block in the networking stack.
513− liftIO $ traceEvent (localEventBus node)
514− (MxSent them us msg)
518+ liftIO $ traceEvent (localEventBus node) (MxSent them us msg)
519+ if destNode == nid
520+ then sendCtrlMsg Nothing (LocalSend them msg)
521+ else sendCtrlMsg (Just destNode) $ UnreliableSend (processLocalId them) msg
515522
516523-- | Wrap a 'Serializable' value in a 'Message'. Note that 'Message's are
517524-- 'Serializable' - like the datum they contain - but also note, deserialising
@@ -1220,8 +1227,12 @@ whereisRemoteAsync nid label = do
12201227
12211228-- | Named send to a process in the local registry (asynchronous)
12221229nsend :: Serializable a => String -> a -> Process ()
1223−nsend label msg =
1224− sendCtrlMsg Nothing (NamedSend label (createUnencodedMessage msg))
1230+nsend label msg = do
1231+ proc <- ask
1232+ let msg' = createUnencodedMessage msg
1233+ liftIO $ traceEvent (localEventBus (processNode proc))
1234+ (MxSentToName label (processId proc) msg')
1235+ sendCtrlMsg Nothing (NamedSend label msg')
12251236
12261237-- | Named send to a process in the local registry (asynchronous).
12271238-- This function makes /no/ attempt to serialize and (in the case when the
@@ -1233,9 +1244,15 @@ unsafeNSend = Unsafe.nsend
12331244-- | Named send to a process in a remote registry (asynchronous)
12341245nsendRemote :: Serializable a => NodeId -> String -> a -> Process ()
12351246nsendRemote nid label msg = do
1236− here <- getSelfNode
1237− if here == nid then nsend label msg
1238− else sendCtrlMsg (Just nid) (NamedSend label (createMessage msg))
1247+ proc <- ask
1248+ let us = processId proc
1249+ let node = processNode proc
1250+ if localNodeId node == nid
1251+ then nsend label msg
1252+ else let lbl = label ++ "@" ++ show nid in do
1253+ liftIO $ traceEvent (localEventBus node)
1254+ (MxSentToName lbl us (wrapMessage msg))
1255+ sendCtrlMsg (Just nid) (NamedSend label (createMessage msg))
12391256
12401257-- | Named send to a process in a remote registry (asynchronous)
12411258-- This function makes /no/ attempt to serialize and (in the case when the
src/Control/Distributed/Process/Management.hs+34−2
@@ -76,6 +76,40 @@
7676--
7777-- * Whether messages will be taken from the mailbox first, or the event bus.
7878--
79+-- Since the event bus uses STM broadcast channels to communicate with agents,
80+-- no message written to the bus successfully can be lost.
81+--
82+-- Agents can also receive messages via their mailboxes - these are subject to
83+-- the same guarantees as all inter-process message sending.
84+--
85+-- Messages dispatched on an STM broadcast channel (i.e., management event bus)
86+-- are guaranteed to be delivered with the same FIFO ordering guarantees that
87+-- exist between two communicating processes, such that communication from the
88+-- node controller's threads (i.e., MxEvent's) will never be re-ordered, but
89+-- messages dispatched to the event bus by other processes (including, but not
90+-- limited to agents) are only guaranteed to be ordered between one sender and
91+-- one receiver.
92+--
93+-- No guarantee exists for the ordering in which messages sent to an agent's
94+-- mailbox will be delivered, vs messages dispatched via the event bus.
95+--
96+-- Because of the above, there are no ordering guarantees for messages sent
97+-- between agents, or for processes to agents, except for those that apply to
98+-- messages sent between regular processes, since agents are
99+-- implemented as such.
100+--
101+-- The event bus is serial and single threaded. Anything that is published by
102+-- the node controller will be seen in FIFO order. There are no ordering
103+-- guarantees pertaining to entries published to the event bus by other
104+-- processes or agents.
105+--
106+-- It should not be possible to see, for example, an @MxReceived@ before the
107+-- corresponding @MxSent@ event, since the places where we issue the @MxSent@
108+-- write directly to the event bus (using STM) in the calling (green) thread,
109+-- before dispatching instructions to the node controller to perform the
110+-- necessary routing to deliver the message to a process (or registered name,
111+-- or typed channel) locally or remotely.
112+--
79113-- [Management Data API]
80114--
81115-- Both management agents and clients of the API have access to a variety of
@@ -144,8 +178,6 @@
144178-- > monitorNames = getSelfPid >>= nsend "name-monitor"
145179-- > monitorNames2 = getSelfPid >>= mxNotify
146180--
147−-- For some real-world examples, see the distributed-process-platform package.
148−--
149181-- [Performance, Stablity and Scalability]
150182--
151183-- /Management Agents/ offer numerous advantages over regular processes:
src/Control/Distributed/Process/Management/Internal/Trace/Primitives.hs+8−2
@@ -33,6 +33,7 @@ import Control.Distributed.Process.Internal.Primitives
3333 ( whereis
3434 , newChan
3535 , receiveChan
36+ , die
3637 )
3738import Control.Distributed.Process.Management.Internal.Trace.Types
3839 ( TraceArg(..)
@@ -168,6 +169,11 @@ withRegisteredTracer act = do
168169 withLocalTracer $ \t -> liftIO $ Tracer.getCurrentTraceClient t sp
169170 currentTracer <- receiveChan rp
170171 case currentTracer of
171− Nothing -> do { (Just p') <- whereis "tracer.initial"; act p' }
172+ Nothing -> do mTP <- whereis "tracer.initial"
173+ -- NB: this should NOT ever happen, but forcing pattern matches
174+ -- is not considered cool in later versions of MonadFail
175+ case mTP of
176+ Just p' -> act p'
177+ Nothing -> die $ "System Invariant Violation: Tracer Process "
178+ ++ "Name Not Found (whereis tracer.initial)"
172179 (Just p) -> act p
173−
src/Control/Distributed/Process/Management/Internal/Types.hs+9
@@ -21,6 +21,7 @@ import Control.Concurrent.STM
2121import Control.Distributed.Process.Internal.Types
2222 ( Process
2323 , ProcessId
24+ , SendPortId
2425 , Message
2526 , DiedReason
2627 , NodeId
@@ -30,6 +31,7 @@ import qualified Control.Monad.State as ST
3031 ( MonadState
3132 , StateT
3233 )
34+import Control.Monad.Fix (MonadFix)
3335import Data.Binary
3436import Data.Typeable (Typeable)
3537import GHC.Generics
@@ -56,8 +58,14 @@ data MxEvent =
5658 -- ^ fired whenever a node /dies/ (i.e., the connection is broken/disconnected)
5759 | MxSent ProcessId ProcessId Message
5860 -- ^ fired whenever a message is sent from a local process
61+ | MxSentToName String ProcessId Message
62+ -- ^ fired whenever a named send occurs
63+ | MxSentToPort ProcessId SendPortId Message
64+ -- ^ fired whenever a sendChan occurs
5965 | MxReceived ProcessId Message
6066 -- ^ fired whenever a message is received by a local process
67+ | MxReceivedPort SendPortId Message
68+ -- ^ fired whenever a message is received via a typed channel
6169 | MxConnected ConnectionId EndPointAddress
6270 -- ^ fired when a network-transport connection is first established
6371 | MxDisconnected ConnectionId EndPointAddress
@@ -112,6 +120,7 @@ newtype MxAgent s a =
112120 } deriving ( Functor
113121 , Monad
114122 , MonadIO
123+ , MonadFix
115124 , ST.MonadState (MxAgentState s)
116125 , Typeable
117126 , Applicative
src/Control/Distributed/Process/Node.hs+38−19
@@ -28,9 +28,12 @@ import Data.Binary (decode)
2828import Data.Map (Map)
2929import qualified Data.Map as Map
3030 ( empty
31+ , delete
3132 , toList
3233 , fromList
33− , filter
34+ , insert
35+ , lookup
36+ , partition
3437 , partitionWithKey
3538 , elems
3639 , size
@@ -183,6 +186,9 @@ import Control.Distributed.Process.Internal.Types
183186import Control.Distributed.Process.Management.Internal.Agent
184187 ( mxAgentController
185188 )
189+import Control.Distributed.Process.Management.Internal.Types
190+ ( MxEvent(..)
191+ )
186192import qualified Control.Distributed.Process.Management.Internal.Trace.Remote as Trace
187193 ( remoteTable
188194 )
@@ -195,9 +201,6 @@ import Control.Distributed.Process.Management.Internal.Trace.Types
195201 , traceLogFmt
196202 , enableTrace
197203 )
198−import Control.Distributed.Process.Management.Internal.Types
199− ( MxEvent(..)
200− )
201204import Control.Distributed.Process.Serializable (Serializable)
202205import Control.Distributed.Process.Internal.Messaging
203206 ( sendBinary
@@ -210,6 +213,9 @@ import Control.Distributed.Process.Internal.Primitives
210213 , match
211214 , sendChan
212215 , unwrapMessage
216+ , monitor
217+ , unmonitorAsync
218+ , getSelfNode
213219 , SayMessage(..)
214220 )
215221import Control.Distributed.Process.Internal.Types (SendPort, Tracer(..))
@@ -486,7 +492,7 @@ type IncomingConnection = (NT.EndPointAddress, IncomingTarget)
486492data IncomingTarget =
487493 Uninit
488494 | ToProc ProcessId (Weak (CQueue Message))
489− | ToChan TypedChannel
495+ | ToChan SendPortId TypedChannel
490496 | ToNode
491497
492498data ConnectionState = ConnectionState {
@@ -541,13 +547,17 @@ handleIncomingMessages node = go initConnectionState
541547 enqueue queue msg -- 'enqueue' is strict
542548 trace node (MxReceived pid msg)
543549 go st
544− Just (_, ToChan (TypedChannel chan')) -> do
550+ Just (_, ToChan chId (TypedChannel chan')) -> do
545551 mChan <- deRefWeak chan'
546552 -- If mChan is Nothing, the process has given up the read end of
547553 -- the channel and we simply ignore the incoming message
548− forM_ mChan $ \chan -> atomically $
549− -- We make sure the message is fully decoded when it is enqueued
550− writeTQueue chan $! decode (BSL.fromChunks payload)
554+ forM_ mChan $ \chan -> do
555+ msg' <- atomically $ do
556+ msg <- return $! decode (BSL.fromChunks payload)
557+ -- We make sure the message is fully decoded when it is enqueued
558+ writeTQueue chan msg
559+ return msg
560+ trace node $ MxReceivedPort chId $ unsafeCreateUnencodedMessage msg'
551561 go st
552562 Just (_, ToNode) -> do
553563 let ctrlMsg = decode . BSL.fromChunks $ payload
@@ -574,7 +584,7 @@ handleIncomingMessages node = go initConnectionState
574584 mChannel <- withMVar (processState proc) $ return . (^. typedChannelWithId lcid)
575585 case mChannel of
576586 Just channel ->
577− go (incomingAt cid ^= Just (src, ToChan channel) $ st)
587+ go (incomingAt cid ^= Just (src, ToChan chId channel) $ st)
578588 Nothing ->
579589 invalidRequest cid st $
580590 "incoming attempt to connect to unknown channel of"
@@ -903,7 +913,11 @@ ncEffectDied ident reason = do
903913
904914 modify' $ (links ^= unaffectedLinks') . (monitors ^= unaffectedMons')
905915
906− modify' $ registeredHere ^: Map.filter (\pid -> not $ ident `impliesDeathOf` ProcessIdentifier pid)
916+ -- we now consider all labels for this identifier unregistered
917+ let toDrop pid = not $ ident `impliesDeathOf` ProcessIdentifier pid
918+ (keepNames, dropNames) <- Map.partition toDrop <$> gets (^. registeredHere)
919+ mapM_ (\(p, l) -> liftIO $ trace node (MxUnRegistered l p)) (Map.toList dropNames)
920+ modify' $ registeredHere ^= keepNames
907921
908922 remaining <- fmap Map.toList (gets (^. registeredOnNodes)) >>=
909923 mapM (\(pid,nidlist) ->
@@ -955,7 +969,11 @@ ncEffectRegister from label atnode mPid reregistration = do
955969 do modify' $ registeredHereFor label ^= mPid
956970 updateRemote node currentVal mPid
957971 case mPid of
958− (Just p) -> liftIO $ trace node (MxRegistered p label)
972+ (Just p) -> do
973+ if reregistration
974+ then liftIO $ trace node (MxUnRegistered (fromJust currentVal) label)
975+ else return ()
976+ liftIO $ trace node (MxRegistered p label)
959977 Nothing -> liftIO $ trace node (MxUnRegistered (fromJust currentVal) label)
960978 newVal <- gets (^. registeredHereFor label)
961979 ncSendToProcess from $ unsafeCreateUnencodedMessage $
@@ -1036,11 +1054,12 @@ ncEffectLocalPortSend from msg = do
10361054 -- If ch is Nothing, the process has given up the read end of
10371055 -- the channel and we simply ignore the incoming message - this
10381056 ch <- deRefWeak chan'
1039− forM_ ch $ \chan -> deliverChan msg chan
1040− where deliverChan :: forall a . Message -> TQueue a -> IO ()
1041− deliverChan (UnencodedMessage _ raw) chan' =
1057+ forM_ ch $ \chan -> deliverChan node from msg chan
1058+ where deliverChan :: forall a . LocalNode -> SendPortId -> Message -> TQueue a -> IO ()
1059+ deliverChan n p (UnencodedMessage _ raw) chan' = do
10421060 atomically $ writeTQueue chan' ((unsafeCoerce raw) :: a)
1043− deliverChan (EncodedMessage _ _) _ =
1061+ trace n (MxReceivedPort p $ unsafeCreateUnencodedMessage raw)
1062+ deliverChan _ _ (EncodedMessage _ _) _ =
10441063 -- this will not happen unless someone screws with Primitives.hs
10451064 error "invalid local channel delivery"
10461065
@@ -1070,7 +1089,7 @@ ncEffectGetInfo from pid =
10701089 case mProc of
10711090 Nothing -> dispatch (isLocal node (ProcessIdentifier from))
10721091 from (ProcessInfoNone DiedUnknownId)
1073− Just proc -> do
1092+ Just proc -> do
10741093 itsLinks <- Set.map fst . BiMultiMap.lookupBy1st them <$>
10751094 gets (^. links)
10761095 itsMons <- BiMultiMap.lookupBy1st them <$> gets (^. monitors)
@@ -1084,8 +1103,8 @@ ncEffectGetInfo from pid =
10841103 infoNode = (processNodeId pid)
10851104 , infoRegisteredNames = reg
10861105 , infoMessageQueueLength = size
1087− , infoMonitors = Set.toList itsMons
1088− , infoLinks = Set.toList itsLinks
1106+ , infoMonitors = Set.toList itsMons
1107+ , infoLinks = Set.toList itsLinks
10891108 }
10901109 where dispatch :: (Serializable a)
10911110 => Bool
src/Control/Distributed/Process/UnsafePrimitives.hs+82−33
@@ -32,7 +32,24 @@
3232-- the /normal/ strategy).
3333--
3434-- Use of the functions in this module can potentially change the runtime
35−-- behaviour of your application. You have been warned!
35+-- behaviour of your application. In addition, messages passed between Cloud
36+-- Haskell processes are written to a tracing infrastructure on the local node,
37+-- to provide improved introspection and debugging facilities for complex actor
38+-- based systems. This module makes no attempt to force evaluation in these
39+-- cases either, thus evaluation problems in passed data structures could not
40+-- only crash your processes, but could also bring down critical internal
41+-- services on which the node relies to function correctly.
42+--
43+-- If you wish to repudiate such issues, you are advised to consider the use
44+-- of NFSerialisable in the distributed-process-extras package, which type
45+-- class brings NFData into scope along with Serializable, such that we can
46+-- force evaluation. Intended for use with modules such as this one, this
47+-- approach guarantees correct evaluatedness in terms of @NFData@. Please note
48+-- however, that we /cannot/ guarantee that an @NFData@ instance will behave the
49+-- same way as a @Binary@ one with regards evaluation, so it is still possible
50+-- to introduce unexpected behaviour by using /unsafe/ primitives in this way.
51+--
52+-- You have been warned!
3653--
3754-- This module is exported so that you can replace the use of Cloud Haskell's
3855-- /safe/ messaging primitives. If you want to use both variants, then you can
@@ -55,7 +72,12 @@ import Control.Distributed.Process.Internal.Messaging
5572 , sendBinary
5673 , sendCtrlMsg
5774 )
58−
75+import Control.Distributed.Process.Management.Internal.Types
76+ ( MxEvent(..)
77+ )
78+import Control.Distributed.Process.Management.Internal.Trace.Types
79+ ( traceEvent
80+ )
5981import Control.Distributed.Process.Internal.Types
6082 ( ProcessId(..)
6183 , NodeId(..)
@@ -79,34 +101,48 @@ import Control.Monad.Reader (ask)
79101
80102-- | Named send to a process in the local registry (asynchronous)
81103nsend :: Serializable a => String -> a -> Process ()
82−nsend label msg =
83− sendCtrlMsg Nothing (NamedSend label (unsafeCreateUnencodedMessage msg))
104+nsend label msg = do
105+ proc <- ask
106+ let us = processId proc
107+ let msg' = wrapMessage msg
108+ -- see [note: tracing]
109+ liftIO $ traceEvent (localEventBus (processNode proc))
110+ (MxSentToName label us msg')
111+ sendCtrlMsg Nothing (NamedSend label msg')
84112
85113-- | Named send to a process in a remote registry (asynchronous)
86114nsendRemote :: Serializable a => NodeId -> String -> a -> Process ()
87115nsendRemote nid label msg = do
88116 proc <- ask
89− if localNodeId (processNode proc) == nid
117+ let us = processId proc
118+ let node = processNode proc
119+ if localNodeId node == nid
90120 then nsend label msg
91− else sendCtrlMsg (Just nid) (NamedSend label (createMessage msg))
121+ else
122+ let lbl = label ++ "@" ++ show nid in do
123+ -- see [note: tracing] NB: this is a remote call to another NC...
124+ liftIO $ traceEvent (localEventBus node)
125+ (MxSentToName lbl us (wrapMessage msg))
126+ sendCtrlMsg (Just nid) (NamedSend label (createMessage msg))
92127
93128-- | Send a message
94129send :: Serializable a => ProcessId -> a -> Process ()
95130send them msg = do
96131 proc <- ask
97132 let node = localNodeId (processNode proc)
98− destNode = (processNodeId them) in do
99− case destNode == node of
100− True -> unsafeSendLocal them msg
101− False -> liftIO $ sendMessage (processNode proc)
102− (ProcessIdentifier (processId proc))
103− (ProcessIdentifier them)
104− NoImplicitReconnect
105− msg
106− where
107− unsafeSendLocal :: (Serializable a) => ProcessId -> a -> Process ()
108− unsafeSendLocal pid msg' =
109− sendCtrlMsg Nothing $ LocalSend pid (unsafeCreateUnencodedMessage msg')
133+ destNode = (processNodeId them)
134+ us = (processId proc)
135+ msg' = wrapMessage msg in do
136+ -- see [note: tracing]
137+ liftIO $ traceEvent (localEventBus (processNode proc))
138+ (MxSent them us msg')
139+ if destNode == node
140+ then sendCtrlMsg Nothing $ LocalSend them msg'
141+ else liftIO $ sendMessage (processNode proc)
142+ (ProcessIdentifier (processId proc))
143+ (ProcessIdentifier them)
144+ NoImplicitReconnect
145+ msg
110146
111147-- | Send a message unreliably.
112148--
@@ -121,30 +157,43 @@ usend :: Serializable a => ProcessId -> a -> Process ()
121157usend them msg = do
122158 proc <- ask
123159 let there = processNodeId them
160+ let (us, node) = (processId proc, processNode proc)
161+ let msg' = wrapMessage msg
162+ -- see [note: tracing]
163+ liftIO $ traceEvent (localEventBus node) (MxSent them us msg')
124164 if localNodeId (processNode proc) == there
125− then sendCtrlMsg Nothing $
126− LocalSend them (unsafeCreateUnencodedMessage msg)
165+ then sendCtrlMsg Nothing $ LocalSend them msg'
127166 else sendCtrlMsg (Just there) $ UnreliableSend (processLocalId them)
128167 (createMessage msg)
129168
169+-- [note: tracing]
170+-- Note that tracing writes to the local node's control channel, and this
171+-- module explicitly specifies to its clients that it does unsafe message
172+-- encoding. The same is true for the messages it puts onto the Management
173+-- event bus, however we do *not* want unevaluated thunks hitting the event
174+-- bus control thread. Hence the word /Unsafe/ in this module's name!
175+--
176+
130177-- | Send a message on a typed channel
131178sendChan :: Serializable a => SendPort a -> a -> Process ()
132179sendChan (SendPort cid) msg = do
133180 proc <- ask
134− let node = localNodeId (processNode proc)
135− destNode = processNodeId (sendPortProcessId cid) in do
136− case destNode == node of
137− True -> unsafeSendChanLocal cid msg
138− False -> do
139− liftIO $ sendBinary (processNode proc)
140− (ProcessIdentifier (processId proc))
141− (SendPortIdentifier cid)
142− NoImplicitReconnect
143− msg
181+ let node = processNode proc
182+ pid = processId proc
183+ us = localNodeId node
184+ them = processNodeId (sendPortProcessId cid)
185+ msg' = wrapMessage msg in do
186+ liftIO $ traceEvent (localEventBus node) (MxSentToPort pid cid msg')
187+ if them == us
188+ then unsafeSendChanLocal cid msg' -- NB: we wrap to P.Message !!!
189+ else liftIO $ sendBinary node
190+ (ProcessIdentifier pid)
191+ (SendPortIdentifier cid)
192+ NoImplicitReconnect
193+ msg
144194 where
145− unsafeSendChanLocal :: (Serializable a) => SendPortId -> a -> Process ()
146− unsafeSendChanLocal spId msg' =
147− sendCtrlMsg Nothing $ LocalPortSend spId (unsafeCreateUnencodedMessage msg')
195+ unsafeSendChanLocal :: SendPortId -> Message -> Process ()
196+ unsafeSendChanLocal p m = sendCtrlMsg Nothing $ LocalPortSend p m
148197
149198-- | Create an unencoded @Message@ for any @Serializable@ type.
150199wrapMessage :: Serializable a => a -> Message
stack-ghc-7.10.3.yaml+4−1
@@ -3,12 +3,15 @@ resolver: nightly-2016-03-08
33packages:
44- '.'
55- distributed-process-tests/
6+- location:
7+ git: https://github.com/haskell-distributed/network-transport-tcp.git
8+ commit: d87d6f55697a94a1fbf211ff9c1bb769a1e129cd
9+ extra-dep: true
610
711extra-deps:
812- rank1dynamic-0.4.0
913- distributed-static-0.3.8
1014- network-transport-0.5.2
11−- network-transport-tcp-0.6.0
1215- network-transport-inmemory-0.5.2
1316- rematch-0.2.0.0
1417- exceptions-0.8.2.1 # test dependency
stack-ghc-8.0.2.yaml+6−1
@@ -1,14 +1,19 @@
11resolver: lts-9.21
2+# added -location for network-transport-tcp-0.6.0
3+# since c7fd79 broke the client facing API for createTransport :/
24
35packages:
46- '.'
57- distributed-process-tests/
8+- location:
9+ git: https://github.com/haskell-distributed/network-transport-tcp.git
10+ commit: d87d6f55697a94a1fbf211ff9c1bb769a1e129cd
11+ extra-dep: true
612
713extra-deps:
814- rank1dynamic-0.4.0
915- distributed-static-0.3.8
1016- network-transport-0.5.2
11−- network-transport-tcp-0.6.0
1217- network-transport-inmemory-0.5.2
1318- rematch-0.2.0.0
1419# - exceptions-0.8.2.1 # test dependency
stack-ghc-8.2.2.yaml+4−1
@@ -3,12 +3,15 @@ resolver: lts-11.22
33packages:
44- '.'
55- distributed-process-tests/
6+- location:
7+ git: https://github.com/haskell-distributed/network-transport-tcp.git
8+ commit: d87d6f55697a94a1fbf211ff9c1bb769a1e129cd
9+ extra-dep: true
610
711extra-deps:
812- rank1dynamic-0.4.0
913- distributed-static-0.3.8
1014- network-transport-0.5.2
11−- network-transport-tcp-0.6.0
1215- network-transport-inmemory-0.5.2
1316- rematch-0.2.0.0
1417# - exceptions-0.8.2.1 # test dependency
stack-ghc-8.4.4.yaml+5−2
@@ -1,14 +1,17 @@
1−resolver: lts-12.17
1+resolver: lts-12.18
22
33packages:
44- '.'
55- distributed-process-tests/
6+- location:
7+ git: https://github.com/haskell-distributed/network-transport-tcp.git
8+ commit: d87d6f55697a94a1fbf211ff9c1bb769a1e129cd
9+ extra-dep: true
610
711extra-deps:
812- rank1dynamic-0.4.0
913- distributed-static-0.3.8
1014- network-transport-0.5.2
11−- network-transport-tcp-0.6.0
1215- network-transport-inmemory-0.5.2
1316- rematch-0.2.0.0
1417
stack-nightly.yamlnew file+26
@@ -0,0 +1,26 @@
1+resolver: nightly
2+
3+packages:
4+- '.'
5+- distributed-process-tests/
6+- location:
7+ git: https://github.com/haskell-distributed/distributed-static.git
8+ commit: c51e6aadd3a44c044e96a8e986c11d3a94b45b11
9+ extra-dep: true
10+- location:
11+ git: https://github.com/haskell-distributed/network-transport-tcp.git
12+ commit: d58250e2388b86a1865ac4139373cbdc106e72e1
13+ extra-dep: true
14+- location:
15+ git: https://github.com/haskell-distributed/network-transport-inmemory.git
16+ commit: 0ce97924f15a8c1570b2355151834305c9bd2a28
17+ extra-dep: true
18+
19+extra-deps:
20+- rank1dynamic-0.4.0
21+- network-transport-0.5.2
22+- rematch-0.2.0.0
23+
24+flags:
25+ distributed-process-tests:
26+ tcp: true
stack.yaml+5−2
@@ -1,16 +1,19 @@
1−resolver: nightly-2017-08-20
1+resolver: lts-12.18 # Use GHC 8.4.4
22
33# TODO: we can enable nightly-2018-11-11 once PR #319 is merged
44
55packages:
66- '.'
77- distributed-process-tests/
8+- location:
9+ git: https://github.com/haskell-distributed/network-transport-tcp.git
10+ commit: d87d6f55697a94a1fbf211ff9c1bb769a1e129cd
11+ extra-dep: true
812
913extra-deps:
1014- rank1dynamic-0.4.0
1115- distributed-static-0.3.8
1216- network-transport-0.5.2
13−- network-transport-tcp-0.6.0
1417- network-transport-inmemory-0.5.2
1518- rematch-0.2.0.0
1619