-
Notifications
You must be signed in to change notification settings - Fork 86
/
MockEnvironment.hs
919 lines (844 loc) · 42 KB
/
MockEnvironment.hs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
{-# LANGUAGE BangPatterns #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# OPTIONS_GHC -Wno-orphans #-}
{-# OPTIONS_GHC -Wno-deferred-out-of-scope-variables #-}
{-# OPTIONS_GHC -Wno-incomplete-uni-patterns #-}
{-# LANGUAGE LambdaCase #-}
module Test.Ouroboros.Network.PeerSelection.MockEnvironment
( PeerGraph (..)
, GovernorMockEnvironment (..)
, GovernorMockEnvironmentWithoutAsyncDemotion (..)
, runGovernorInMockEnvironment
, exploreGovernorInMockEnvironment
, TraceMockEnv (..)
, TestTraceEvent (..)
, selectGovernorEvents
, selectPeerSelectionTraceEvents
, selectPeerSelectionTraceEventsUntil
, peerShareReachablePeers
, module Ouroboros.Network.Testing.Data.Script
, module Ouroboros.Network.PeerSelection.Types
, tests
, prop_shrink_nonequal_GovernorMockEnvironment
, config_REPROMOTE_DELAY
) where
import Data.Bifunctor (first)
import Data.Dynamic (fromDynamic)
import Data.List (nub)
import Data.List.NonEmpty qualified as NonEmpty
import Data.Map.Strict (Map)
import Data.Map.Strict qualified as Map
import Data.Proxy (Proxy (..))
import Data.Set (Set)
import Data.Set qualified as Set
import Data.Typeable (Typeable)
import Data.Void (Void)
import System.Random (mkStdGen)
import Control.Concurrent.Class.MonadSTM
import Control.Concurrent.Class.MonadSTM.Strict qualified as StrictTVar
import Control.Exception (throw)
import Control.Monad.Class.MonadAsync
import Control.Monad.Class.MonadFork
import Control.Monad.Class.MonadSay
import Control.Monad.Class.MonadTest
import Control.Monad.Class.MonadThrow
import Control.Monad.Class.MonadTime.SI
import Control.Monad.Class.MonadTimer.SI hiding (timeout)
import Control.Monad.Fail qualified as Fail
import Control.Monad.IOSim
import Control.Tracer (Tracer (..), contramap, traceWith)
import Ouroboros.Network.ExitPolicy
import Ouroboros.Network.PeerSelection.Governor hiding (PeerSelectionState (..))
import Ouroboros.Network.PeerSelection.State.LocalRootPeers qualified as LocalRootPeers
import Ouroboros.Network.Testing.Data.Script (PickScript, Script (..),
ScriptDelay (..), TimedScript, arbitraryPickScript,
arbitraryScriptOf, initScript, initScript', interpretPickScript,
playTimedScript, prop_shrink_Script, singletonScript, stepScript,
stepScriptSTM, stepScriptSTM')
import Ouroboros.Network.Testing.Utils (ShrinkCarefully, arbitrarySubset,
prop_shrink_nonequal, prop_shrink_valid)
import Test.Ouroboros.Network.PeerSelection.Instances
import Test.Ouroboros.Network.PeerSelection.LocalRootPeers as LocalRootPeers hiding
(tests)
import Test.Ouroboros.Network.PeerSelection.PeerGraph
import Ouroboros.Network.PeerSelection.Bootstrap (UseBootstrapPeers (..),
requiresBootstrapPeers)
import Ouroboros.Network.PeerSelection.LedgerPeers (IsBigLedgerPeer,
LedgerPeersKind (..))
import Ouroboros.Network.PeerSelection.LedgerPeers.Type
(LedgerStateJudgement (..))
import Ouroboros.Network.PeerSelection.PeerSharing (PeerSharing (..))
import Ouroboros.Network.PeerSelection.PublicRootPeers (PublicRootPeers (..))
import Ouroboros.Network.PeerSelection.PublicRootPeers qualified as PublicRootPeers
import Ouroboros.Network.PeerSelection.Types (PeerStatus (..))
import Ouroboros.Network.Protocol.PeerSharing.Type (PeerSharingAmount,
PeerSharingResult (..))
import Ouroboros.Network.Testing.Utils (nightlyTest)
import Test.Ouroboros.Network.LedgerPeers (ArbitraryLedgerStateJudgement (..))
import Test.Ouroboros.Network.PeerSelection.PublicRootPeers ()
import Test.QuickCheck
import Test.Tasty (TestTree, localOption, testGroup)
import Test.Tasty.QuickCheck (QuickCheckMaxSize (..), testProperty)
tests :: TestTree
tests =
testGroup "Ouroboros.Network.PeerSelection"
[ testGroup "MockEnvironment"
[ testProperty "shrink for Script" prop_shrink_Script
, testProperty "shrink for GovernorScripts" prop_shrink_GovernorScripts
, testProperty "arbitrary for PeerSelectionTargets" prop_arbitrary_PeerSelectionTargets
, testProperty "shrink for PeerSelectionTargets" prop_shrink_PeerSelectionTargets
, testProperty "arbitrary for PeerGraph" prop_arbitrary_PeerGraph
, localOption (QuickCheckMaxSize 30) $
testProperty "shrink for PeerGraph" prop_shrink_PeerGraph
, testProperty "arbitrary for GovernorMockEnvironment" prop_arbitrary_GovernorMockEnvironment
, localOption (QuickCheckMaxSize 30) $
testProperty "shrink for GovernorMockEnvironment" prop_shrink_GovernorMockEnvironment
, nightlyTest $
testProperty "shrink nonequal GovernorMockEnvironment"
prop_shrink_nonequal_GovernorMockEnvironment
]
]
--
-- Mock environment types
--
-- | The data needed to execute the peer selection governor in a test with a
-- mock network environment. It contains the data needed to provide the
-- 'PeerSelectionActions' and 'PeerSelectionPolicy' to run the governor.
--
-- The representations are chosen to be easily shrinkable. See the @Arbitrary@
-- instances.
--
data GovernorMockEnvironment = GovernorMockEnvironment {
peerGraph :: !PeerGraph,
localRootPeers :: !(LocalRootPeers PeerAddr),
publicRootPeers :: !(PublicRootPeers PeerAddr),
targets :: !(TimedScript PeerSelectionTargets),
pickKnownPeersForPeerShare :: !(PickScript PeerAddr),
pickColdPeersToPromote :: !(PickScript PeerAddr),
pickWarmPeersToPromote :: !(PickScript PeerAddr),
pickHotPeersToDemote :: !(PickScript PeerAddr),
pickWarmPeersToDemote :: !(PickScript PeerAddr),
pickColdPeersToForget :: !(PickScript PeerAddr),
peerSharing :: !PeerSharing,
useBootstrapPeers :: !(TimedScript UseBootstrapPeers),
ledgerStateJudgement :: !(TimedScript LedgerStateJudgement)
}
deriving (Show, Eq)
data PeerConn m = PeerConn !PeerAddr !PeerSharing !(TVar m PeerStatus)
instance Show (PeerConn m) where
show (PeerConn peeraddr peerSharing _) =
"PeerConn " ++ show peeraddr ++ " " ++ show peerSharing
-- | 'GovernorMockEnvironment' which does not do any asynchronous demotions.
--
newtype GovernorMockEnvironmentWithoutAsyncDemotion =
GovernorMockEnvironmentWAD GovernorMockEnvironment
deriving Show
instance Arbitrary GovernorMockEnvironmentWithoutAsyncDemotion where
arbitrary = GovernorMockEnvironmentWAD . fixGraph <$> arbitrary
where
fixGraph g@GovernorMockEnvironment { peerGraph = PeerGraph peerGraph } =
g { peerGraph = PeerGraph (map fixNode peerGraph) }
fixNode (addr, addrs, peerInfo) =
(addr, addrs, peerInfo { connectionScript = singletonScript (Noop, ShortDelay) })
shrink (GovernorMockEnvironmentWAD env) = map GovernorMockEnvironmentWAD (shrink env)
-- | Invariant. Used to check the QC generator and shrinker.
--
-- NOTE: Local and Public Root Peers sets should be disjoint.
-- However we do not check for that invariant here. The goal
-- is to check if the actual Governor takes care of this and enforces
-- the invariant.
validGovernorMockEnvironment :: GovernorMockEnvironment -> Property
validGovernorMockEnvironment GovernorMockEnvironment {
peerGraph,
localRootPeers,
publicRootPeers,
targets
} =
conjoin [ counterexample "invalid peer graph"
(validPeerGraph peerGraph)
, counterexample "local roots not a subset of all peers"
(LocalRootPeers.keysSet localRootPeers `Set.isSubsetOf` allPeersSet)
, property (PublicRootPeers.toSet publicRootPeers `Set.isSubsetOf` allPeersSet)
, property (foldl (\ !p (!a,_) -> p && sanePeerSelectionTargets a) True targets)
, counterexample "big ledger peers not a subset of public roots"
(PublicRootPeers.invariant publicRootPeers)
]
where
allPeersSet = allPeers peerGraph
--
-- Execution in the mock environment
--
-- | Run the 'peerSelectionGovernor' in the mock environment dictated by the
-- data in the 'GovernorMockEnvironment'.
--
-- The result is an execution trace.
--
runGovernorInMockEnvironment :: GovernorMockEnvironment -> SimTrace Void
runGovernorInMockEnvironment mockEnv =
runSimTrace $ governorAction mockEnv
governorAction :: GovernorMockEnvironment -> IOSim s Void
governorAction mockEnv = do
publicStateVar <- makePublicPeerSelectionStateVar
lsjVar <- playTimedScript (contramap TraceEnvSetLedgerStateJudgement tracerMockEnv)
(ledgerStateJudgement mockEnv)
usbVar <- playTimedScript (contramap TraceEnvSetUseBootstrapPeers tracerMockEnv)
(useBootstrapPeers mockEnv)
debugVar <- StrictTVar.newTVarIO (emptyPeerSelectionState (mkStdGen 42) [])
countersVar <- StrictTVar.newTVarIO (emptyPeerSelectionCounters [])
policy <- mockPeerSelectionPolicy mockEnv
actions <- mockPeerSelectionActions tracerMockEnv mockEnv (readTVar usbVar) (readTVar lsjVar) policy
exploreRaces -- explore races within the governor
_ <- forkIO $ do -- races with the governor should be explored
labelThisThread "outbound-governor"
_ <- peerSelectionGovernor
tracerTracePeerSelection
tracerDebugPeerSelection
tracerTracePeerSelectionCounters
(mkStdGen 42)
countersVar
publicStateVar
debugVar
actions
policy
atomically retry
atomically retry -- block to allow the governor to run
exploreGovernorInMockEnvironment :: Testable test
=> (ExplorationOptions->ExplorationOptions)
-> GovernorMockEnvironment
-> (Maybe (SimTrace Void) -> SimTrace Void -> test)
-> Property
exploreGovernorInMockEnvironment optsf mockEnv k =
exploreSimTrace optsf (governorAction mockEnv) k
data TraceMockEnv = TraceEnvAddPeers !PeerGraph
| TraceEnvSetLocalRoots !(LocalRootPeers PeerAddr)
| TraceEnvRequestPublicRootPeers
| TraceEnvRequestBigLedgerPeers
| TraceEnvSetPublicRoots !(PublicRootPeers PeerAddr)
| TraceEnvPublicRootTTL
| TraceEnvBigLedgerPeersTTL
| TraceEnvPeerShareTTL !PeerAddr
| TraceEnvSetTargets !PeerSelectionTargets
| TraceEnvPeersDemote !AsyncDemotion !PeerAddr
| TraceEnvEstablishConn !PeerAddr
| TraceEnvActivatePeer !PeerAddr
| TraceEnvDeactivatePeer !PeerAddr
| TraceEnvCloseConn !PeerAddr
| TraceEnvRootsResult ![PeerAddr]
| TraceEnvBigLedgerPeersResult !(Set PeerAddr)
| TraceEnvPeerShareRequest !PeerAddr !(Maybe ([PeerAddr], PeerShareTime))
| TraceEnvPeerShareResult !PeerAddr ![PeerAddr]
| TraceEnvPeersStatus !(Map PeerAddr PeerStatus)
| TraceEnvSetUseBootstrapPeers !UseBootstrapPeers
| TraceEnvSetLedgerStateJudgement !LedgerStateJudgement
deriving Show
mockPeerSelectionActions :: forall m.
(MonadAsync m, MonadDelay m, MonadTimer m,
Fail.MonadFail m, MonadThrow (STM m), MonadTraceSTM m)
=> Tracer m TraceMockEnv
-> GovernorMockEnvironment
-> STM m UseBootstrapPeers
-> STM m LedgerStateJudgement
-> PeerSelectionPolicy PeerAddr m
-> m (PeerSelectionActions PeerAddr (PeerConn m) m)
mockPeerSelectionActions tracer
env@GovernorMockEnvironment {
peerGraph,
localRootPeers,
publicRootPeers,
targets
}
readUseBootstrapPeers
getLedgerStateJudgement
policy = do
scripts <- Map.fromList <$>
sequence
[ (\a b c -> (addr, (a, b, c)))
<$> initScript peerShareScript
<*> initScript peerSharingScript
<*> initScript connectionScript
| let PeerGraph adjacency = peerGraph
, (addr, _, GovernorScripts {
peerShareScript,
peerSharingScript,
connectionScript
}) <- adjacency
]
targetsVar <- playTimedScript (contramap TraceEnvSetTargets tracer) targets
peerConns <- atomically $ do
v <- newTVar Map.empty
traceTVar proxy
v (\_ a -> TraceDynamic . TraceEnvPeersStatus
<$> snapshotPeersStatus proxy a)
return v
traceWith tracer (TraceEnvAddPeers peerGraph)
traceWith tracer (TraceEnvSetLocalRoots localRootPeers) --TODO: make dynamic
traceWith tracer (TraceEnvSetPublicRoots publicRootPeers) --TODO: make dynamic
return $ mockPeerSelectionActions'
tracer env policy
scripts targetsVar readUseBootstrapPeers getLedgerStateJudgement peerConns
where
proxy :: Proxy m
proxy = Proxy
data TransitionError
= ActivationError
| DeactivationError
deriving (Show, Typeable)
instance Exception TransitionError where
mockPeerSelectionActions' :: forall m.
(MonadAsync m, MonadDelay m, MonadSTM m, MonadTimer m, Fail.MonadFail m,
MonadThrow (STM m))
=> Tracer m TraceMockEnv
-> GovernorMockEnvironment
-> PeerSelectionPolicy PeerAddr m
-> Map PeerAddr (TVar m PeerShareScript, TVar m PeerSharingScript, TVar m ConnectionScript)
-> TVar m PeerSelectionTargets
-> STM m UseBootstrapPeers
-> STM m LedgerStateJudgement
-> TVar m (Map PeerAddr (TVar m PeerStatus))
-> PeerSelectionActions PeerAddr (PeerConn m) m
mockPeerSelectionActions' tracer
GovernorMockEnvironment {
localRootPeers,
publicRootPeers,
peerSharing
}
_
scripts
targetsVar
readUseBootstrapPeers
readLedgerStateJudgement
connsVar =
PeerSelectionActions {
readLocalRootPeers = return (LocalRootPeers.toGroups localRootPeers),
peerSharing = peerSharing,
peerConnToPeerSharing = \(PeerConn _ ps _) -> ps,
requestPublicRootPeers,
readPeerSelectionTargets = readTVar targetsVar,
readNewInboundConnection = retry,
requestPeerShare,
peerStateActions = PeerStateActions {
establishPeerConnection,
monitorPeerConnection,
activatePeerConnection,
deactivatePeerConnection,
closePeerConnection
},
readUseBootstrapPeers,
readLedgerStateJudgement
}
where
-- TODO: make this dynamic
requestPublicRootPeers ledgerPeersKind _n = do
traceWith tracer TraceEnvRequestPublicRootPeers
let ttl :: DiffTime
ttl = 60
_ <- async $ do
threadDelay ttl
traceWith tracer TraceEnvPublicRootTTL
-- Read the current ledger state judgement
usingBootstrapPeers <- atomically
$ requiresBootstrapPeers <$> readUseBootstrapPeers
<*> readLedgerStateJudgement
-- If the ledger state is YoungEnough we should get ledger peers.
-- Otherwise we should get bootstrap peers
let publicConfigPeers = PublicRootPeers.getPublicConfigPeers publicRootPeers
bootstrapPeers = PublicRootPeers.getBootstrapPeers publicRootPeers
ledgerPeers = PublicRootPeers.getLedgerPeers publicRootPeers
bigLedgerPeers = PublicRootPeers.getBigLedgerPeers publicRootPeers
result =
if usingBootstrapPeers
then PublicRootPeers.fromBootstrapPeers bootstrapPeers
else case ledgerPeersKind of
AllLedgerPeers
| Set.null ledgerPeers ->
PublicRootPeers.fromPublicRootPeers publicConfigPeers
| otherwise ->
PublicRootPeers.fromLedgerPeers ledgerPeers
BigLedgerPeers
| Set.null ledgerPeers ->
PublicRootPeers.fromPublicRootPeers publicConfigPeers
| otherwise ->
PublicRootPeers.fromBigLedgerPeers bigLedgerPeers
traceWith tracer (TraceEnvRootsResult (Set.toList (PublicRootPeers.toSet result)))
return (result, ttl)
requestPeerShare :: PeerSharingAmount -> PeerAddr -> m (PeerSharingResult PeerAddr)
requestPeerShare _ addr = do
let Just (peerShareScript, _, _) = Map.lookup addr scripts
mPeerShare <- stepScript peerShareScript
traceWith tracer (TraceEnvPeerShareRequest addr mPeerShare)
case mPeerShare of
Nothing -> do
threadDelay 1
traceWith tracer (TraceEnvPeerShareResult addr [])
fail "no peers"
Just (peeraddrs, time) -> do
threadDelay (interpretPeerShareTime time)
traceWith tracer (TraceEnvPeerShareResult addr peeraddrs)
return (PeerSharingResult peeraddrs)
establishPeerConnection :: IsBigLedgerPeer -> PeerAddr -> m (PeerConn m)
establishPeerConnection _ peeraddr = do
--TODO: add support for variable delays and synchronous failure
traceWith tracer (TraceEnvEstablishConn peeraddr)
threadDelay 1
let Just (_, peerSharingScript, connectScript) = Map.lookup peeraddr scripts
conn@(PeerConn _ _ v) <- atomically $ do
conn <- newTVar PeerWarm
conns <- readTVar connsVar
let !conns' = Map.insert peeraddr conn conns
writeTVar connsVar conns'
remotePeerSharing <- stepScriptSTM peerSharingScript
return (PeerConn peeraddr (peerSharing <> remotePeerSharing) conn)
_ <- async $
-- monitoring loop which does asynchronous demotions. It will terminate
-- as soon as either of the events:
--
-- + the script returns 'Noop'
-- + peer demoted to 'PeerCold'
--
let loop = do
(demotion, delay) <- stepScript connectScript
let interpretScriptDelay NoDelay = 1
interpretScriptDelay ShortDelay = 60
interpretScriptDelay LongDelay = 600
interpretScriptDelay (Delay a) = a -- not used by the generator
done <-
case demotion of
Noop -> return True
ToWarm -> do
threadDelay (interpretScriptDelay delay)
atomically $ do
s <- readTVar v
case s of
PeerHot -> writeTVar v PeerWarm
>> return False
PeerCold -> return True
_ -> return False
ToCooling -> do
threadDelay (interpretScriptDelay delay)
atomically $ do
s <- readTVar v
case s of
PeerCooling -> return False
PeerCold -> return True
_ -> writeTVar v PeerCooling
>> return False
ToCold -> do
threadDelay (interpretScriptDelay delay)
atomically $ do
s <- readTVar v
case s of
PeerCold -> return True
_ -> writeTVar v PeerCold
>> return True
traceWith tracer (TraceEnvPeersDemote demotion peeraddr)
if done
then return ()
else loop
in loop
return conn
activatePeerConnection :: IsBigLedgerPeer -> PeerConn m -> m ()
activatePeerConnection _ (PeerConn peeraddr _ conn) = do
traceWith tracer (TraceEnvActivatePeer peeraddr)
threadDelay 1
atomically $ do
status <- readTVar conn
case status of
PeerHot -> error "activatePeerConnection of hot peer"
PeerWarm -> writeTVar conn PeerHot
--TODO: check it's just a race condition and not just wrong:
--
-- We throw 'ActivationError' for the following reason:
-- 'PeerCold' can be set by the monitoring loop started by
-- 'establishedPeerConnection' above. However if that happens we
-- want to signal the governor that the warm -> hot transition
-- errored. Otherwise 'jobPromoteWarmPeer' will try to update the
-- state as if the transition went fine which will violate
-- 'invariantPeerSelectionState'.
PeerCooling -> throwIO ActivationError
PeerCold -> throwIO ActivationError
deactivatePeerConnection :: PeerConn m -> m ()
deactivatePeerConnection (PeerConn peeraddr _ conn) = do
traceWith tracer (TraceEnvDeactivatePeer peeraddr)
atomically $ do
status <- readTVar conn
case status of
PeerHot -> writeTVar conn PeerWarm
--TODO: check it's just a race condition and not just wrong:
PeerWarm -> return ()
-- See the note in 'activatePeerConnection' why we throw an exception
-- here.
PeerCooling -> throwIO DeactivationError
PeerCold -> throwIO DeactivationError
closePeerConnection :: PeerConn m -> m ()
closePeerConnection (PeerConn peeraddr _ conn) = do
traceWith tracer (TraceEnvCloseConn peeraddr)
atomically $ do
status <- readTVar conn
case status of
PeerHot -> writeTVar conn PeerCold
--TODO: check it's just a race condition and not just wrong:
PeerWarm -> writeTVar conn PeerCold
PeerCooling -> writeTVar conn PeerCold
PeerCold -> return ()
conns <- readTVar connsVar
let !conns' = Map.delete peeraddr conns
writeTVar connsVar conns'
monitorPeerConnection :: PeerConn m -> STM m (PeerStatus, Maybe RepromoteDelay)
monitorPeerConnection (PeerConn _peeraddr _ conn) = do
st <- readTVar conn
pure $ case st of
PeerCooling -> (st, Nothing)
_ -> (st, Just config_REPROMOTE_DELAY)
config_REPROMOTE_DELAY :: RepromoteDelay
config_REPROMOTE_DELAY = 10
snapshotPeersStatus :: MonadInspectSTM m
=> proxy m
-> Map PeerAddr (TVar m PeerStatus)
-> InspectMonad m (Map PeerAddr PeerStatus)
snapshotPeersStatus p conns = traverse (inspectTVar p) conns
mockPeerSelectionPolicy :: MonadSTM m
=> GovernorMockEnvironment
-> m (PeerSelectionPolicy PeerAddr m)
mockPeerSelectionPolicy GovernorMockEnvironment {
pickKnownPeersForPeerShare,
pickColdPeersToPromote,
pickWarmPeersToPromote,
pickHotPeersToDemote,
pickWarmPeersToDemote,
pickColdPeersToForget
} = do
pickKnownPeersForPeerShareVar <- initScript' pickKnownPeersForPeerShare
pickColdPeersToPromoteVar <- initScript' pickColdPeersToPromote
pickWarmPeersToPromoteVar <- initScript' pickWarmPeersToPromote
pickHotPeersToDemoteVar <- initScript' pickHotPeersToDemote
pickWarmPeersToDemoteVar <- initScript' pickWarmPeersToDemote
pickColdPeersToForgetVar <- initScript' pickColdPeersToForget
return PeerSelectionPolicy {
policyPickKnownPeersForPeerShare = \_ _ _ -> interpretPickScript pickKnownPeersForPeerShareVar,
policyPickColdPeersToPromote = \_ _ _ -> interpretPickScript pickColdPeersToPromoteVar,
policyPickWarmPeersToPromote = \_ _ _ -> interpretPickScript pickWarmPeersToPromoteVar,
policyPickHotPeersToDemote = \_ _ _ -> interpretPickScript pickHotPeersToDemoteVar,
policyPickWarmPeersToDemote = \_ _ _ -> interpretPickScript pickWarmPeersToDemoteVar,
policyPickColdPeersToForget = \_ _ _ -> interpretPickScript pickColdPeersToForgetVar,
policyFindPublicRootTimeout = 5, -- seconds
policyMaxInProgressPeerShareReqs = 2,
policyPeerShareRetryTime = 3600, -- seconds
policyPeerShareBatchWaitTime = 3, -- seconds
policyPeerShareOverallTimeout = 10, -- seconds
policyPeerShareActivationDelay = 300, -- seconds
policyErrorDelay = 10 -- seconds
}
--
-- Utils for properties
--
data TestTraceEvent = GovernorDebug !(DebugPeerSelection PeerAddr)
| GovernorEvent !(TracePeerSelection PeerAddr)
| GovernorCounters !PeerSelectionCounters
| MockEnvEvent !TraceMockEnv
-- Warning: be careful with writing properties that rely
-- on trace events from both the governor and from the
-- environment. These events typically occur in separate
-- threads and so are not casually ordered. It is ok to use
-- them for timeout/eventually properties, but not for
-- properties that check conditions synchronously.
-- The governor debug vs other events are fully ordered.
deriving Show
tracerTracePeerSelection :: Tracer (IOSim s) (TracePeerSelection PeerAddr)
tracerTracePeerSelection = contramap f tracerTestTraceEvent
where
-- make the tracer strict
f :: TracePeerSelection PeerAddr -> TestTraceEvent
f a@(TraceLocalRootPeersChanged !_ !_) = GovernorEvent a
f a@(TraceTargetsChanged !_ !_) = GovernorEvent a
f a@(TracePublicRootsRequest !_ !_) = GovernorEvent a
f a@(TracePublicRootsResults !_ !_ !_) = GovernorEvent a
f a@(TracePublicRootsFailure !_ !_ !_) = GovernorEvent a
f a@(TraceForgetColdPeers !_ !_ !_) = GovernorEvent a
f a@(TraceBigLedgerPeersRequest !_ !_) = GovernorEvent a
f a@(TraceBigLedgerPeersResults !_ !_ !_) = GovernorEvent a
f a@(TraceBigLedgerPeersFailure !_ !_ !_) = GovernorEvent a
f a@(TraceForgetBigLedgerPeers !_ !_ !_) = GovernorEvent a
f a@(TracePeerShareRequests !_ !_ !_ !_ !_) = GovernorEvent a
f a@(TracePeerShareResults !_) = GovernorEvent a
f a@(TracePeerShareResultsFiltered !_) = GovernorEvent a
f a@(TraceKnownInboundConnection !_ !_) = GovernorEvent a
f a@(TracePromoteColdPeers !_ !_ !_) = GovernorEvent a
f a@(TracePromoteColdLocalPeers !_ !_) = GovernorEvent a
f a@(TracePromoteColdFailed !_ !_ !_ !_ !_) = GovernorEvent a
f a@(TracePromoteColdDone !_ !_ !_) = GovernorEvent a
f a@(TracePromoteColdBigLedgerPeers !_ !_ !_) = GovernorEvent a
f a@(TracePromoteColdBigLedgerPeerFailed !_ !_ !_ !_ !_) = GovernorEvent a
f a@(TracePromoteColdBigLedgerPeerDone !_ !_ !_) = GovernorEvent a
f a@(TracePromoteWarmPeers !_ !_ !_) = GovernorEvent a
f a@(TracePromoteWarmLocalPeers !_ !_) = GovernorEvent a
f a@(TracePromoteWarmFailed !_ !_ !_ !_) = GovernorEvent a
f a@(TracePromoteWarmDone !_ !_ !_) = GovernorEvent a
f a@(TracePromoteWarmAborted !_ !_ !_) = GovernorEvent a
f a@(TracePromoteWarmBigLedgerPeers !_ !_ !_) = GovernorEvent a
f a@(TracePromoteWarmBigLedgerPeerFailed !_ !_ !_ !_) = GovernorEvent a
f a@(TracePromoteWarmBigLedgerPeerDone !_ !_ !_) = GovernorEvent a
f a@(TracePromoteWarmBigLedgerPeerAborted !_ !_ !_) = GovernorEvent a
f a@(TraceDemoteWarmPeers !_ !_ !_) = GovernorEvent a
f a@(TraceDemoteWarmFailed !_ !_ !_ !_) = GovernorEvent a
f a@(TraceDemoteWarmDone !_ !_ !_) = GovernorEvent a
f a@(TraceDemoteWarmBigLedgerPeers !_ !_ !_) = GovernorEvent a
f a@(TraceDemoteWarmBigLedgerPeerFailed !_ !_ !_ !_) = GovernorEvent a
f a@(TraceDemoteWarmBigLedgerPeerDone !_ !_ !_) = GovernorEvent a
f a@(TraceDemoteHotPeers !_ !_ !_) = GovernorEvent a
f a@(TraceDemoteLocalHotPeers !_ !_) = GovernorEvent a
f a@(TraceDemoteHotFailed !_ !_ !_ !_) = GovernorEvent a
f a@(TraceDemoteHotDone !_ !_ !_) = GovernorEvent a
f a@(TraceDemoteHotBigLedgerPeers !_ !_ !_) = GovernorEvent a
f a@(TraceDemoteHotBigLedgerPeerFailed !_ !_ !_ !_) = GovernorEvent a
f a@(TraceDemoteHotBigLedgerPeerDone !_ !_ !_) = GovernorEvent a
f a@(TraceDemoteAsynchronous !_) = GovernorEvent a
f a@(TraceDemoteLocalAsynchronous !_) = GovernorEvent a
f a@(TraceDemoteBigLedgerPeersAsynchronous !_) = GovernorEvent a
f a@TraceGovernorWakeup = GovernorEvent a
f a@(TraceChurnWait !_) = GovernorEvent a
f a@(TraceChurnMode !_) = GovernorEvent a
f a@(TraceLedgerStateJudgementChanged !_) = GovernorEvent a
f a@TraceOnlyBootstrapPeers = GovernorEvent a
f a@TraceBootstrapPeersFlagChangedWhilstInSensitiveState = GovernorEvent a
f a@(TraceUseBootstrapPeersChanged !_) = GovernorEvent a
f a@(TraceOutboundGovernorCriticalFailure !_) = GovernorEvent a
f a@(TraceDebugState !_ !_) = GovernorEvent a
f a@(TraceChurnAction !_) = GovernorEvent a
f a@(TraceChurnTimeout !_) = GovernorEvent a
tracerDebugPeerSelection :: Tracer (IOSim s) (DebugPeerSelection PeerAddr)
tracerDebugPeerSelection = GovernorDebug `contramap` tracerTestTraceEvent
tracerTracePeerSelectionCounters :: Tracer (IOSim s) PeerSelectionCounters
tracerTracePeerSelectionCounters = contramap GovernorCounters tracerTestTraceEvent
tracerMockEnv :: Tracer (IOSim s) TraceMockEnv
tracerMockEnv = contramap MockEnvEvent tracerTestTraceEvent
tracerTestTraceEvent :: Tracer (IOSim s) TestTraceEvent
tracerTestTraceEvent = dynamicTracer <> Tracer (say . show)
dynamicTracer :: Typeable a => Tracer (IOSim s) a
dynamicTracer = Tracer traceM
selectPeerSelectionTraceEvents :: SimTrace a -> [(Time, TestTraceEvent)]
selectPeerSelectionTraceEvents = go
where
go (SimTrace t _ _ (EventLog e) trace)
| Just x <- fromDynamic e = (t,x) : go trace
go (SimPORTrace t _ _ _ (EventLog e) trace)
| Just x <- fromDynamic e = (t,x) : go trace
go (SimTrace _ _ _ _ trace) = go trace
go (SimPORTrace _ _ _ _ _ trace) = go trace
go (TraceRacesFound _ trace) = go trace
go (TraceMainException _ _ e _) = throw e
go (TraceDeadlock _ _) = [] -- expected result in many cases
go TraceMainReturn {} = []
go (TraceInternalError e) = error ("IOSim: " ++ e)
go TraceLoop = error "Step time limit exceeded"
selectPeerSelectionTraceEventsUntil :: Time -> SimTrace a -> [(Time, TestTraceEvent)]
selectPeerSelectionTraceEventsUntil tmax = go
where
go (SimTrace t _ _ _ _)
| t > tmax = []
go (SimTrace t _ _ (EventLog e) trace)
| Just x <- fromDynamic e = (t,x) : go trace
go (SimPORTrace t _ _ _ _ _)
| t > tmax = []
go (SimPORTrace t _ _ _ (EventLog e) trace)
| Just x <- fromDynamic e = (t,x) : go trace
go (SimTrace _ _ _ _ trace) = go trace
go (SimPORTrace _ _ _ _ _ trace) = go trace
go (TraceRacesFound _ trace) = go trace
go (TraceMainException _ _ e _) = throw e
go (TraceDeadlock _ _) = [] -- expected result in many cases
go TraceMainReturn {} = []
go (TraceInternalError e) = error ("IOSim: " ++ e)
go TraceLoop = error "Step time limit exceeded"
selectGovernorEvents :: [(Time, TestTraceEvent)]
-> [(Time, TracePeerSelection PeerAddr)]
selectGovernorEvents trace = [ (t, e) | (t, GovernorEvent e) <- trace ]
--
-- QuickCheck instances
--
instance Arbitrary GovernorMockEnvironment where
arbitrary = do
-- Dependency of the root set on the graph
peerGraph <- arbitrary
let peersSet = allPeers peerGraph
(localRootPeers,
publicRootPeers) <- arbitraryRootPeers peersSet
-- But the others are independent
targets <- arbitrary
let arbitrarySubsetOfPeers = arbitrarySubset peersSet
pickKnownPeersForPeerShare <- arbitraryPickScript arbitrarySubsetOfPeers
pickColdPeersToPromote <- arbitraryPickScript arbitrarySubsetOfPeers
pickWarmPeersToPromote <- arbitraryPickScript arbitrarySubsetOfPeers
pickHotPeersToDemote <- arbitraryPickScript arbitrarySubsetOfPeers
pickWarmPeersToDemote <- arbitraryPickScript arbitrarySubsetOfPeers
pickColdPeersToForget <- arbitraryPickScript arbitrarySubsetOfPeers
peerSharing <- arbitrary
useBootstrapPeers <- arbitrary
ledgerStateJudgementList <- fmap getArbitraryLedgerStateJudgement <$> arbitrary
ledgerStateJudgementDelays <- listOf1 (elements [NoDelay, ShortDelay])
let ledgerStateJudgementWithDelay =
zip ledgerStateJudgementList ledgerStateJudgementDelays
++ [(YoungEnough, ShortDelay)]
ledgerStateJudgement = Script $ NonEmpty.fromList ledgerStateJudgementWithDelay
return GovernorMockEnvironment{..}
where
arbitraryRootPeers :: Set PeerAddr
-> Gen (LocalRootPeers PeerAddr, PublicRootPeers PeerAddr)
arbitraryRootPeers peers | Set.null peers =
return (LocalRootPeers.empty, PublicRootPeers.empty)
arbitraryRootPeers peers = do
-- We decide how many we want and then pick randomly.
sz <- getSize
let minroots
| sz >= 10 = 1
| otherwise = 0
maxroots = ceiling
. sqrt
. (fromIntegral :: Int -> Double)
. length
$ peers
numroots <- choose (minroots, maxroots)
ixs <- vectorOf numroots (getNonNegative <$> arbitrary)
let pick n = Set.elemAt i peers where i = n `mod` Set.size peers
rootPeers = nub (map pick ixs)
-- divide into local and public, but with a bit of overlap:
local <- vectorOf (length rootPeers) (choose (0, 10 :: Int))
-- Deliberately asking for a small intersection in order to test if
-- the Governor actually takes care of this invariant
let localRootsSet = Set.fromList [ x | (x, v) <- zip rootPeers local
, v <= 5 ]
publicRootsSet = nub [ x | (x, v) <- zip rootPeers local
, v >= 5 ]
pAdvPLedger <- vectorOf (length publicRootsSet)
((,) <$> arbitrary <*> arbitrary)
let publicRoots = Map.fromList (zip publicRootsSet pAdvPLedger)
numBigLedgerPeers <- choose (minroots, numroots)
-- `publicRoots` might be empty
ixs' <- vectorOf numBigLedgerPeers (getNonNegative <$> arbitrary)
let bigLedgerPeers = (Set.\\ localRootsSet)
. Set.fromList
. map (\(_,_,a) -> a)
. filter (\(ix, ix', _) ->
ix == ix' `mod` Map.size publicRoots)
$ zip3 [0..] ixs' (Map.keys publicRoots)
let (publicConfigPeers, otherPeers) =
span (\case (_, (x, _)) -> not x)
(zip publicRootsSet pAdvPLedger)
(publicConfigPeersMap, (boostrapPeers, ledgerPeers)) =
( Map.fromList $ map (\(p, (_, pa)) -> (p, pa)) publicConfigPeers
, let otherPeers' = map fst otherPeers
in splitAt (length otherPeers' `div` 2) otherPeers'
)
localRoots <- arbitraryLocalRootPeers localRootsSet
return ( localRoots
, PublicRootPeers.fromMapAndSet
publicConfigPeersMap
(Set.fromList boostrapPeers)
(Set.fromList ledgerPeers)
bigLedgerPeers
)
shrink env@GovernorMockEnvironment {
peerGraph,
localRootPeers,
publicRootPeers,
targets,
pickKnownPeersForPeerShare,
pickColdPeersToPromote,
pickWarmPeersToPromote,
pickHotPeersToDemote,
pickWarmPeersToDemote,
pickColdPeersToForget,
peerSharing,
useBootstrapPeers,
ledgerStateJudgement
} =
-- Special rule for shrinking the peerGraph because the localRootPeers
-- depends on it so has to be updated too.
[ env {
peerGraph = peerGraph',
localRootPeers = LocalRootPeers.restrictKeys localRootPeers nodes',
publicRootPeers = publicRootPeers `PublicRootPeers.intersection` nodes'
}
| peerGraph' <- shrink peerGraph
, let nodes' = allPeers peerGraph' ]
-- All the others are generic.
++ [ GovernorMockEnvironment {
peerGraph,
localRootPeers = localRootPeers',
publicRootPeers = publicRootPeers',
targets = targets',
pickKnownPeersForPeerShare = pickKnownPeersForPeerShare',
pickColdPeersToPromote = pickColdPeersToPromote',
pickWarmPeersToPromote = pickWarmPeersToPromote',
pickHotPeersToDemote = pickHotPeersToDemote',
pickWarmPeersToDemote = pickWarmPeersToDemote',
pickColdPeersToForget = pickColdPeersToForget',
peerSharing,
useBootstrapPeers = useBootstrapPeers',
ledgerStateJudgement = fmap (first getArbitraryLedgerStateJudgement)
ledgerStateJudgement'
}
| (targets',
pickKnownPeersForPeerShare',
pickColdPeersToPromote',
pickWarmPeersToPromote',
pickHotPeersToDemote',
pickWarmPeersToDemote',
pickColdPeersToForget',
ledgerStateJudgement',
useBootstrapPeers'
)
<- shrink (targets,
pickKnownPeersForPeerShare,
pickColdPeersToPromote,
pickWarmPeersToPromote,
pickHotPeersToDemote,
pickWarmPeersToDemote,
pickColdPeersToForget,
fmap (first ArbitraryLedgerStateJudgement) ledgerStateJudgement,
useBootstrapPeers
),
localRootPeers' <- shrinkLocalRootPeers localRootPeers,
publicRootPeers' <- shrinkPublicRootPeers publicRootPeers
]
where
shrinkLocalRootPeers (LocalRootPeers m g) =
[ LocalRootPeers m' g'
| (m', g') <- shrink (m, g)
]
shrinkPublicRootPeers (PublicRootPeers pp bsp lp blp) =
[ PublicRootPeers pp' bsp' lp' blp'
| (pp', bsp', lp', blp') <- shrink (pp, bsp, lp, blp)
]
--
-- Tests for the QC Arbitrary instances
--
prop_arbitrary_GovernorMockEnvironment :: GovernorMockEnvironment -> Property
prop_arbitrary_GovernorMockEnvironment env =
tabulate "num root peers" [show (LocalRootPeers.size (localRootPeers env)
+ PublicRootPeers.size (publicRootPeers env))] $
tabulate "num local root peers" [show (LocalRootPeers.size (localRootPeers env))] $
tabulate "num public root peers" [show (PublicRootPeers.size (publicRootPeers env))] $
tabulate "empty root peers" [show $ not emptyGraph && emptyRootPeers] $
tabulate "overlapping local/public roots" [show overlappingRootPeers] $
tabulate "num big ledger peers" [show (Set.size bigLedgerPeersSet)] $
validGovernorMockEnvironment env
where
bigLedgerPeersSet = PublicRootPeers.getBigLedgerPeers (publicRootPeers env)
emptyGraph = null g where PeerGraph g = peerGraph env
emptyRootPeers = LocalRootPeers.null (localRootPeers env)
&& PublicRootPeers.null (publicRootPeers env)
overlappingRootPeers =
not $ PublicRootPeers.null $
PublicRootPeers.intersection
(publicRootPeers env)
(LocalRootPeers.keysSet (localRootPeers env))
prop_shrink_GovernorMockEnvironment :: ShrinkCarefully GovernorMockEnvironment -> Property
prop_shrink_GovernorMockEnvironment x =
prop_shrink_valid validGovernorMockEnvironment x
.&&. prop_shrink_nonequal x
prop_shrink_nonequal_GovernorMockEnvironment ::
ShrinkCarefully GovernorMockEnvironment -> Property
prop_shrink_nonequal_GovernorMockEnvironment = prop_shrink_nonequal