-
Notifications
You must be signed in to change notification settings - Fork 86
/
Testnet.hs
4004 lines (3656 loc) · 168 KB
/
Testnet.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
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{-# LANGUAGE CPP #-}
{-# LANGUAGE LambdaCase #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RankNTypes #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE TypeApplications #-}
#if defined(mingw32_HOST_OS)
{-# OPTIONS_GHC -Wno-unused-top-binds #-}
#endif
#if __GLASGOW_HASKELL__ >= 908
{-# OPTIONS_GHC -Wno-x-partial #-}
#endif
module Test.Ouroboros.Network.Testnet (tests) where
import Control.Monad.Class.MonadFork
import Control.Monad.Class.MonadTime.SI (DiffTime, Time (Time), addTime,
diffTime)
import Control.Monad.IOSim
import Data.Bifoldable (bifoldMap)
import Data.Foldable (fold)
import Data.IP qualified as IP
import Data.List (find, foldl', intercalate, tails)
import Data.List.Trace qualified as Trace
import Data.Map (Map)
import Data.Map qualified as Map
import Data.Maybe (catMaybes, fromJust, fromMaybe, isJust, mapMaybe)
import Data.Monoid (Sum (..))
import Data.Set (Set)
import Data.Set qualified as Set
import Data.Time (secondsToDiffTime)
import Data.Typeable (Typeable)
import Data.Void (Void)
import Data.Word (Word32)
import System.Random (mkStdGen)
import Network.DNS.Types qualified as DNS
import Ouroboros.Network.ConnectionHandler (ConnectionHandlerTrace)
import Ouroboros.Network.ConnectionId
import Ouroboros.Network.ConnectionManager.Types
import Ouroboros.Network.ExitPolicy (RepromoteDelay (..))
import Ouroboros.Network.InboundGovernor hiding (TrUnexpectedlyFalseAssertion)
import Ouroboros.Network.PeerSelection.Governor hiding (PeerSelectionState (..))
import Ouroboros.Network.PeerSelection.Governor qualified as Governor
import Ouroboros.Network.PeerSelection.PeerStateActions
import Ouroboros.Network.PeerSelection.RootPeersDNS.DNSActions
import Ouroboros.Network.PeerSelection.State.EstablishedPeers qualified as EstablishedPeers
import Ouroboros.Network.PeerSelection.State.KnownPeers qualified as KnownPeers
import Ouroboros.Network.PeerSelection.State.LocalRootPeers qualified as LocalRootPeers
import Ouroboros.Network.PeerSelection.Types
import Ouroboros.Network.Server2 (ServerTrace (..))
import Ouroboros.Network.Testing.Data.AbsBearerInfo
import Ouroboros.Network.Testing.Data.Script
import Ouroboros.Network.Testing.Data.Signal
import Ouroboros.Network.Testing.Data.Signal qualified as Signal
import Ouroboros.Network.Testing.Utils hiding (SmallDelay, debugTracer)
import Simulation.Network.Snocket (BearerInfo (..))
import Test.Ouroboros.Network.Diffusion.Node (config_REPROMOTE_DELAY)
import Test.Ouroboros.Network.Diffusion.Node.NodeKernel
import Test.Ouroboros.Network.Testnet.Simulation.Node
import Test.QuickCheck
import Test.Tasty
import Test.Tasty.QuickCheck (testProperty)
import Control.Exception (AssertionFailed (..), catch, evaluate)
import Ouroboros.Network.BlockFetch (FetchMode (..), TraceFetchClientState (..))
import Ouroboros.Network.ConnectionManager.Test.Timeouts (AllProperty (..),
TestProperty (..), classifyActivityType, classifyEffectiveDataFlow,
classifyNegotiatedDataFlow, classifyPrunings, classifyTermination,
groupConns, mkProperty, ppTransition, verifyAllTimeouts)
import Ouroboros.Network.ConnectionManager.Test.Utils
(abstractStateIsFinalTransition, connectionManagerTraceMap,
validTransitionMap, verifyAbstractTransition,
verifyAbstractTransitionOrder)
import Ouroboros.Network.InboundGovernor.Test.Utils (inboundGovernorTraceMap,
remoteStrIsFinalTransition, serverTraceMap, validRemoteTransitionMap,
verifyRemoteTransition, verifyRemoteTransitionOrder)
import Ouroboros.Network.Mock.ConcreteBlock (BlockHeader)
import Ouroboros.Network.NodeToNode (DiffusionMode (..))
import Ouroboros.Network.PeerSelection.Bootstrap (UseBootstrapPeers (..))
import Ouroboros.Network.PeerSelection.PeerAdvertise (PeerAdvertise (..))
import Ouroboros.Network.PeerSelection.PeerSharing (PeerSharing (..))
import Ouroboros.Network.PeerSelection.PeerTrustable (PeerTrustable (..))
import Ouroboros.Network.PeerSelection.PublicRootPeers qualified as PublicRootPeers
import Ouroboros.Network.PeerSelection.RootPeersDNS.LocalRootPeers
(TraceLocalRootPeers (..))
import Ouroboros.Network.PeerSelection.State.LocalRootPeers (HotValency (..),
WarmValency (..))
import Ouroboros.Network.PeerSharing (PeerSharingResult (..))
import Test.Ouroboros.Network.LedgerPeers (LedgerPools (..))
import Ouroboros.Network.PeerSelection.Bootstrap (requiresBootstrapPeers)
import Ouroboros.Network.PeerSelection.LedgerPeers
tests :: TestTree
tests =
testGroup "Ouroboros.Network.Testnet"
[ testGroup "generators"
[ testProperty "diffusionScript fixupCommands idempotent"
prop_diffusionScript_fixupCommands
, testProperty "diffusionScript command script valid"
prop_diffusionScript_commandScript_valid
]
, testProperty "no failure"
prop_diffusion_nofail
, testProperty "no livelock"
prop_diffusion_nolivelock
, testProperty "dns can recover from fails"
prop_diffusion_dns_can_recover
, testProperty "unit #4191"
unit_4191
, testProperty "target established public"
prop_diffusion_target_established_public
, testProperty "target active public"
prop_diffusion_target_active_public
, testProperty "target established local"
prop_diffusion_target_established_local
, testProperty "unit reconnect"
prop_unit_reconnect
, testProperty "target active local"
prop_diffusion_target_active_local
, testProperty "target active root"
prop_diffusion_target_active_root
, testProperty "target active below"
prop_diffusion_target_active_below
, testProperty "target active local below"
prop_diffusion_target_active_local_below
, testProperty "async demotion"
prop_diffusion_async_demotions
, testProperty "async demotion (unit)"
unit_diffusion_async_demotions
, testProperty "target active local above"
prop_diffusion_target_active_local_above
, testProperty "connection manager valid transitions"
prop_diffusion_cm_valid_transitions
, testProperty "connection manager valid transition order"
prop_diffusion_cm_valid_transition_order
, testProperty "unit 4258"
prop_unit_4258
, testProperty "connection manager no dodgy traces"
prop_diffusion_cm_no_dodgy_traces
, testProperty "peer selection actions no dodgy traces"
prop_diffusion_peer_selection_actions_no_dodgy_traces
, testProperty "inbound governor valid transitions"
prop_diffusion_ig_valid_transitions
, testProperty "inbound governor valid transition order"
prop_diffusion_ig_valid_transition_order
, testProperty "cm & ig timeouts enforced"
prop_diffusion_timeouts_enforced
, testProperty "any Cold async demotion"
prop_track_coolingToCold_demotions
, testProperty "unit #4177" unit_4177
, testProperty "only bootstrap peers in fallback state"
prop_only_bootstrap_peers_in_fallback_state
, testProperty "no non trustable peers before caught up state"
prop_no_non_trustable_peers_before_caught_up_state
, testGroup "Peer Sharing"
[ testProperty "share a peer"
unit_peer_sharing
]
, testGroup "Churn"
[ testProperty "no timeouts"
prop_churn_notimeouts
, testProperty "steps"
prop_churn_steps
]
, testGroup "coverage"
[ testProperty "server trace coverage"
prop_server_trace_coverage
, testProperty "peer selection actions trace coverage"
prop_peer_selection_action_trace_coverage
, testProperty "peer selection trace coverage"
prop_peer_selection_trace_coverage
, testProperty "connection manager trace coverage"
prop_connection_manager_trace_coverage
, testProperty "connection manager transitions coverage"
prop_connection_manager_transitions_coverage
, testProperty "inbound governor trace coverage"
prop_inbound_governor_trace_coverage
, testProperty "inbound governor transitions coverage"
prop_inbound_governor_transitions_coverage
, testProperty "fetch client state trace coverage"
prop_fetch_client_state_trace_coverage
]
, testGroup "hot diffusion script"
[ testProperty "target active public"
prop_hot_diffusion_target_active_public
, testProperty "target active local"
prop_hot_diffusion_target_active_local
, testProperty "target active root"
prop_hot_diffusion_target_active_root
]
]
traceFromList :: [a] -> Trace (SimResult ()) a
traceFromList = Trace.fromList (MainReturn (Time 0) (Labelled (ThreadId []) (Just "main")) () [])
-- | As a basic property we run the governor to explore its state space a bit
-- and check it does not throw any exceptions (assertions such as invariant
-- violations).
--
-- We do /not/ assume freedom from livelock for this property, so we run the
-- governor for a maximum number of trace events rather than for a fixed
-- simulated time.
--
prop_diffusion_nofail :: AbsBearerInfo
-> DiffusionScript
-> Property
prop_diffusion_nofail defaultBearerInfo diffScript =
let sim :: forall s . IOSim s Void
sim = diffusionSimulation (toBearerInfo defaultBearerInfo)
diffScript
iosimTracer
ioSimTrace = runSimTrace sim
trace = Trace.toList
. fmap (\(WithTime t (WithName _ b)) -> (t, b))
. withTimeNameTraceEvents
@DiffusionTestTrace
@NtNAddr
. traceFromList
. fmap (\(t, tid, tl, te) -> SimEvent t tid tl te)
. take 125000
. traceEvents
$ ioSimTrace
-- run in `IO` so we can catch the pure 'AssertionFailed' exception
in ioProperty $ do
r <-
evaluate ( foldl' (flip seq) True
$ [ assertPeerSelectionState st ()
| (_, DiffusionDebugPeerSelectionTrace (TraceGovernorState _ _ st)) <- trace ]
)
`catch` \(AssertionFailed _) -> return False
case r of
True -> return $ property True
False -> do
putStrLn $ intercalate "\n" $ map show trace
-- the ioSimTrace is infinite, but it will terminate with `AssertionFailed`
error "impossible!"
-- | This test coverage of ConnectionManagerTrace constructors.
--
prop_connection_manager_trace_coverage :: AbsBearerInfo
-> DiffusionScript
-> Property
prop_connection_manager_trace_coverage defaultBearerInfo diffScript =
let sim :: forall s . IOSim s Void
sim = diffusionSimulation (toBearerInfo defaultBearerInfo)
diffScript
iosimTracer
events :: [ConnectionManagerTrace
NtNAddr
(ConnectionHandlerTrace NtNVersion NtNVersionData)]
events = mapMaybe (\case DiffusionConnectionManagerTrace st -> Just st
_ -> Nothing
)
. Trace.toList
. fmap (\(WithTime _ (WithName _ b)) -> b)
. withTimeNameTraceEvents
@DiffusionTestTrace
@NtNAddr
. traceFromList
. fmap (\(t, tid, tl, te) -> SimEvent t tid tl te)
. take 125000
. traceEvents
$ runSimTrace sim
eventsSeenNames = map connectionManagerTraceMap events
-- TODO: Add checkCoverage here
in tabulate "connection manager trace" eventsSeenNames
True
-- | This tests coverage of ConnectionManager transitions.
--
prop_connection_manager_transitions_coverage :: AbsBearerInfo
-> DiffusionScript
-> Property
prop_connection_manager_transitions_coverage defaultBearerInfo diffScript =
let sim :: forall s . IOSim s Void
sim = diffusionSimulation (toBearerInfo defaultBearerInfo)
diffScript
iosimTracer
events :: [AbstractTransitionTrace NtNAddr]
events = mapMaybe (\case DiffusionConnectionManagerTransitionTrace st ->
Just st
_ -> Nothing
)
. Trace.toList
. fmap (\(WithTime _ (WithName _ b)) -> b)
. withTimeNameTraceEvents
@DiffusionTestTrace
@NtNAddr
. traceFromList
. fmap (\(t, tid, tl, te) -> SimEvent t tid tl te)
. take 125000
. traceEvents
$ runSimTrace sim
transitionsSeenNames = map (snd . validTransitionMap . ttTransition)
events
-- TODO: Add checkCoverage here
in tabulate "connection manager transitions" transitionsSeenNames
True
-- | This test coverage of InboundGovernorTrace constructors.
--
prop_inbound_governor_trace_coverage :: AbsBearerInfo
-> DiffusionScript
-> Property
prop_inbound_governor_trace_coverage defaultBearerInfo diffScript =
let sim :: forall s . IOSim s Void
sim = diffusionSimulation (toBearerInfo defaultBearerInfo)
diffScript
iosimTracer
events :: [InboundGovernorTrace NtNAddr]
events = mapMaybe (\case DiffusionInboundGovernorTrace st -> Just st
_ -> Nothing
)
. Trace.toList
. fmap (\(WithTime _ (WithName _ b)) -> b)
. withTimeNameTraceEvents
@DiffusionTestTrace
@NtNAddr
. traceFromList
. fmap (\(t, tid, tl, te) -> SimEvent t tid tl te)
. take 125000
. traceEvents
$ runSimTrace sim
eventsSeenNames = map inboundGovernorTraceMap events
-- TODO: Add checkCoverage here
in tabulate "inbound governor trace" eventsSeenNames
True
-- | This test coverage of InboundGovernor transitions.
--
prop_inbound_governor_transitions_coverage :: AbsBearerInfo
-> DiffusionScript
-> Property
prop_inbound_governor_transitions_coverage defaultBearerInfo diffScript =
let sim :: forall s . IOSim s Void
sim = diffusionSimulation (toBearerInfo defaultBearerInfo)
diffScript
iosimTracer
events :: [RemoteTransitionTrace NtNAddr]
events = mapMaybe (\case DiffusionInboundGovernorTransitionTrace st ->
Just st
_ -> Nothing
)
. Trace.toList
. fmap (\(WithTime _ (WithName _ b)) -> b)
. withTimeNameTraceEvents
@DiffusionTestTrace
@NtNAddr
. traceFromList
. fmap (\(t, tid, tl, te) -> SimEvent t tid tl te)
. take 125000
. traceEvents
$ runSimTrace sim
transitionsSeenNames = map (snd . validRemoteTransitionMap . ttTransition)
events
-- TODO: Add checkCoverage here
in tabulate "inbound governor transitions" transitionsSeenNames
True
-- | This test coverage of TraceFetchClientState BlockHeader constructors,
-- namely accept errors.
--
prop_fetch_client_state_trace_coverage :: AbsBearerInfo
-> DiffusionScript
-> Property
prop_fetch_client_state_trace_coverage defaultBearerInfo diffScript =
let sim :: forall s . IOSim s Void
sim = diffusionSimulation (toBearerInfo defaultBearerInfo)
diffScript
iosimTracer
events :: [TraceFetchClientState BlockHeader]
events = mapMaybe (\case DiffusionFetchTrace st ->
Just st
_ -> Nothing
)
. Trace.toList
. fmap (\(WithTime _ (WithName _ b)) -> b)
. withTimeNameTraceEvents
@DiffusionTestTrace
@NtNAddr
. traceFromList
. fmap (\(t, tid, tl, te) -> SimEvent t tid tl te)
. take 125000
. traceEvents
$ runSimTrace sim
transitionsSeenNames = map traceFetchClientStateMap events
-- TODO: Add checkCoverage here
in tabulate "fetch client state trace" transitionsSeenNames
True
where
traceFetchClientStateMap :: TraceFetchClientState BlockHeader
-> String
traceFetchClientStateMap AddedFetchRequest{} = "AddedFetchRequest"
traceFetchClientStateMap AcknowledgedFetchRequest{} =
"AcknowledgedFetchRequest"
traceFetchClientStateMap SendFetchRequest{} = "SendFetchRequest"
traceFetchClientStateMap StartedFetchBatch{} = "StartedFetchBatch"
traceFetchClientStateMap CompletedBlockFetch{} = "CompletedBlockFetch"
traceFetchClientStateMap CompletedFetchBatch{} = "CompletedFetchBatch"
traceFetchClientStateMap RejectedFetchBatch{} = "RejectedFetchBatch"
traceFetchClientStateMap (ClientTerminating n) = "ClientTerminating "
++ show n
-- | Same as PeerSelection test 'prop_governor_only_bootstrap_peers_in_fallback_state'
--
prop_only_bootstrap_peers_in_fallback_state :: AbsBearerInfo
-> DiffusionScript
-> Property
prop_only_bootstrap_peers_in_fallback_state defaultBearerInfo diffScript =
let sim :: forall s . IOSim s Void
sim = diffusionSimulation (toBearerInfo defaultBearerInfo)
diffScript
iosimTracer
events :: [Events DiffusionTestTrace]
events = fmap ( Signal.eventsFromList
. fmap (\(WithName _ (WithTime t b)) -> (t, b))
)
. Trace.toList
. splitWithNameTrace
. Trace.fromList ()
. fmap snd
. Signal.eventsToList
. Signal.eventsFromListUpToTime (Time (10 * 60 * 60))
. Trace.toList
. fmap (\(WithTime t (WithName name b)) -> (t, WithName name (WithTime t b)))
. withTimeNameTraceEvents
@DiffusionTestTrace
@NtNAddr
. traceFromList
. fmap (\(t, tid, tl, te) -> SimEvent t tid tl te)
. take 125000
. traceEvents
$ runSimTrace sim
in conjoin
$ (\ev ->
let evsList = eventsToList ev
lastTime = fst
. last
$ evsList
in classifySimulatedTime lastTime
$ classifyNumberOfEvents (length evsList)
$ verify_only_bootstrap_peers_in_fallback_state ev
)
<$> events
where
verify_only_bootstrap_peers_in_fallback_state events =
let govUseBootstrapPeers :: Signal UseBootstrapPeers
govUseBootstrapPeers =
selectDiffusionPeerSelectionState (Governor.bootstrapPeersFlag) events
govLedgerStateJudgement :: Signal LedgerStateJudgement
govLedgerStateJudgement =
selectDiffusionPeerSelectionState (Governor.ledgerStateJudgement) events
trJoinKillSig :: Signal JoinedOrKilled
trJoinKillSig =
Signal.fromChangeEvents Killed -- Default to TrKillingNode
. Signal.selectEvents
(\case TrJoiningNetwork -> Just Joined
TrKillingNode -> Just Killed
_ -> Nothing
)
. selectDiffusionSimulationTrace
$ events
govKnownPeers :: Signal (Set NtNAddr)
govKnownPeers =
selectDiffusionPeerSelectionState (KnownPeers.toSet . Governor.knownPeers) events
govTrustedPeers :: Signal (Set NtNAddr)
govTrustedPeers =
selectDiffusionPeerSelectionState
(\st -> LocalRootPeers.keysSet (LocalRootPeers.clampToTrustable (Governor.localRootPeers st))
<> PublicRootPeers.getBootstrapPeers (Governor.publicRootPeers st)
) events
-- Signal.keyedUntil receives 2 functions one that sets start of the
-- set signal, one that ends it and another that stops all.
--
-- In this particular case we want a signal that is keyed beginning
-- on a TrJoiningNetwork and ends on TrKillingNode, giving us a Signal
-- with the periods when a node was alive.
trIsNodeAlive :: Signal Bool
trIsNodeAlive =
not . Set.null
<$> Signal.keyedUntil (fromJoinedOrKilled (Set.singleton ())
Set.empty)
(fromJoinedOrKilled Set.empty
(Set.singleton ()))
(const False)
trJoinKillSig
keepNonTrustablePeersTooLong :: Signal (Set NtNAddr)
keepNonTrustablePeersTooLong =
Signal.keyedTimeoutTruncated
-- Due to the possibilities of the node being reconfigured
-- frequently and disconnection timeouts we have to increase
-- this value
300 -- seconds
(\(knownPeers, useBootstrapPeers, trustedPeers, lsj, isAlive) ->
if isAlive && requiresBootstrapPeers useBootstrapPeers lsj
then knownPeers `Set.difference` trustedPeers
else Set.empty
)
((,,,,) <$> govKnownPeers
<*> govUseBootstrapPeers
<*> govTrustedPeers
<*> govLedgerStateJudgement
<*> trIsNodeAlive
)
in counterexample (intercalate "\n" $ map show $ Signal.eventsToList events)
$ signalProperty 20 show
Set.null
keepNonTrustablePeersTooLong
-- | Same as PeerSelection test 'prop_governor_no_non_trustable_peers_before_caught_up_state'
--
prop_no_non_trustable_peers_before_caught_up_state :: AbsBearerInfo
-> DiffusionScript
-> Property
prop_no_non_trustable_peers_before_caught_up_state defaultBearerInfo diffScript =
let sim :: forall s . IOSim s Void
sim = diffusionSimulation (toBearerInfo defaultBearerInfo)
diffScript
iosimTracer
events :: [Events DiffusionTestTrace]
events = fmap ( Signal.eventsFromList
. fmap (\(WithName _ (WithTime t b)) -> (t, b))
)
. Trace.toList
. splitWithNameTrace
. Trace.fromList ()
. fmap snd
. Signal.eventsToList
. Signal.eventsFromListUpToTime (Time (10 * 60 * 60))
. Trace.toList
. fmap (\(WithTime t (WithName name b)) -> (t, WithName name (WithTime t b)))
. withTimeNameTraceEvents
@DiffusionTestTrace
@NtNAddr
. traceFromList
. fmap (\(t, tid, tl, te) -> SimEvent t tid tl te)
. take 125000
. traceEvents
$ runSimTrace sim
in conjoin
$ (\ev ->
let evsList = eventsToList ev
lastTime = fst
. last
$ evsList
in classifySimulatedTime lastTime
$ classifyNumberOfEvents (length evsList)
$ verify_no_non_trustable_peers_before_caught_up_state ev
)
<$> events
where
verify_no_non_trustable_peers_before_caught_up_state events =
let govUseBootstrapPeers :: Signal UseBootstrapPeers
govUseBootstrapPeers =
selectDiffusionPeerSelectionState (Governor.bootstrapPeersFlag) events
govLedgerStateJudgement :: Signal LedgerStateJudgement
govLedgerStateJudgement =
selectDiffusionPeerSelectionState (Governor.ledgerStateJudgement) events
govKnownPeers :: Signal (Set NtNAddr)
govKnownPeers =
selectDiffusionPeerSelectionState (KnownPeers.toSet . Governor.knownPeers) events
govTrustedPeers :: Signal (Set NtNAddr)
govTrustedPeers =
selectDiffusionPeerSelectionState
(\st -> LocalRootPeers.keysSet (LocalRootPeers.clampToTrustable (Governor.localRootPeers st))
<> PublicRootPeers.getBootstrapPeers (Governor.publicRootPeers st)
) events
govHasOnlyBootstrapPeers :: Signal Bool
govHasOnlyBootstrapPeers =
selectDiffusionPeerSelectionState Governor.hasOnlyBootstrapPeers events
trJoinKillSig :: Signal JoinedOrKilled
trJoinKillSig =
Signal.fromChangeEvents Killed -- Default to TrKillingNode
. Signal.selectEvents
(\case TrJoiningNetwork -> Just Joined
TrKillingNode -> Just Killed
_ -> Nothing
)
. selectDiffusionSimulationTrace
$ events
-- Signal.keyedUntil receives 2 functions one that sets start of the
-- set signal, one that ends it and another that stops all.
--
-- In this particular case we want a signal that is keyed beginning
-- on a TrJoiningNetwork and ends on TrKillingNode, giving us a Signal
-- with the periods when a node was alive.
trIsNodeAlive :: Signal Bool
trIsNodeAlive =
not . Set.null
<$> Signal.keyedUntil (fromJoinedOrKilled (Set.singleton ())
Set.empty)
(fromJoinedOrKilled Set.empty
(Set.singleton ()))
(const False)
trJoinKillSig
keepNonTrustablePeersTooLong :: Signal (Set NtNAddr)
keepNonTrustablePeersTooLong =
Signal.keyedTimeout
10 -- seconds
(\( knownPeers, trustedPeers
, useBootstrapPeers, lsj, hasOnlyBootstrapPeers, isAlive) ->
if isAlive && hasOnlyBootstrapPeers && requiresBootstrapPeers useBootstrapPeers lsj
then Set.difference knownPeers trustedPeers
else Set.empty
)
((,,,,,) <$> govKnownPeers
<*> govTrustedPeers
<*> govUseBootstrapPeers
<*> govLedgerStateJudgement
<*> govHasOnlyBootstrapPeers
<*> trIsNodeAlive
)
in counterexample (intercalate "\n" $ map show $ Signal.eventsToList events)
$ signalProperty 20 show
Set.null
keepNonTrustablePeersTooLong
-- | Unit test which covers issue #4177
--
-- Reconfiguration of local root peers should not remove peers which are being
-- demoted.
unit_4177 :: Property
unit_4177 = prop_inbound_governor_transitions_coverage absNoAttenuation script
where
script :: DiffusionScript
script =
DiffusionScript (SimArgs 1 10)
(singletonTimedScript Map.empty)
[ ( NodeArgs (-6) InitiatorAndResponderDiffusionMode (Just 180)
(Map.fromList [(RelayAccessDomain "test2" 65535, DoAdvertisePeer)])
(Script ((UseBootstrapPeers [RelayAccessDomain "bootstrap" 00000]) :| []))
(TestAddress (IPAddr (read "0:7:0:7::") 65533))
PeerSharingDisabled
[ (1,1,Map.fromList [(RelayAccessDomain "test2" 65535,(DoNotAdvertisePeer, IsNotTrustable))
, (RelayAccessAddress "0:6:0:3:0:6:0:5" 65530,(DoNotAdvertisePeer, IsNotTrustable))])
]
(Script (LedgerPools [] :| []))
nullPeerSelectionTargets {
targetNumberOfKnownPeers = 2,
targetNumberOfEstablishedPeers = 2,
targetNumberOfActivePeers = 1,
targetNumberOfKnownBigLedgerPeers = 0,
targetNumberOfEstablishedBigLedgerPeers = 0,
targetNumberOfActiveBigLedgerPeers = 0
}
(Script (DNSTimeout {getDNSTimeout = 0.239} :| [DNSTimeout {getDNSTimeout = 0.181},DNSTimeout {getDNSTimeout = 0.185},DNSTimeout {getDNSTimeout = 0.14},DNSTimeout {getDNSTimeout = 0.221}]))
(Script (DNSLookupDelay {getDNSLookupDelay = 0.067} :| [DNSLookupDelay {getDNSLookupDelay = 0.097},DNSLookupDelay {getDNSLookupDelay = 0.101},DNSLookupDelay {getDNSLookupDelay = 0.096},DNSLookupDelay {getDNSLookupDelay = 0.051}]))
Nothing
False
(Script (FetchModeDeadline :| []))
, [JoinNetwork 1.742857142857
,Reconfigure 6.33333333333 [(1,1,Map.fromList [(RelayAccessDomain "test2" 65535,(DoAdvertisePeer, IsNotTrustable))]),
(1,1,Map.fromList [(RelayAccessAddress "0:6:0:3:0:6:0:5" 65530,(DoAdvertisePeer, IsNotTrustable))
])]
,Reconfigure 23.88888888888 [(1,1,Map.fromList []),(1,1,Map.fromList [(RelayAccessAddress "0:6:0:3:0:6:0:5" 65530,(DoAdvertisePeer, IsNotTrustable))])]
,Reconfigure 4.870967741935 [(1,1,Map.fromList [(RelayAccessDomain "test2" 65535,(DoAdvertisePeer, IsNotTrustable))])]
]
)
, ( NodeArgs (1) InitiatorAndResponderDiffusionMode (Just 135)
(Map.fromList [(RelayAccessAddress "0:7:0:7::" 65533, DoAdvertisePeer)])
(Script ((UseBootstrapPeers [RelayAccessDomain "bootstrap" 00000]) :| []))
(TestAddress (IPAddr (read "0:6:0:3:0:6:0:5") 65530))
PeerSharingDisabled
[]
(Script (LedgerPools [] :| []))
nullPeerSelectionTargets {
targetNumberOfRootPeers = 2,
targetNumberOfKnownPeers = 5,
targetNumberOfEstablishedPeers = 1,
targetNumberOfActivePeers = 1
}
(Script (DNSTimeout {getDNSTimeout = 0.28}
:| [DNSTimeout {getDNSTimeout = 0.204},
DNSTimeout {getDNSTimeout = 0.213}
]))
(Script (DNSLookupDelay {getDNSLookupDelay = 0.066}
:| [DNSLookupDelay {getDNSLookupDelay = 0.102},
DNSLookupDelay {getDNSLookupDelay = 0.031}
]))
Nothing
False
(Script (FetchModeDeadline :| []))
, [JoinNetwork 0.183783783783
,Reconfigure 4.533333333333 [(1,1,Map.fromList [])]
]
)
]
-- | Attempt to reproduce local root disconnect bug
--
-- Configure relay A to have relay B as localroot peer.
-- Start relay B then start relay A.
-- Verify that the relay A is connected to relay B.
-- Then just restart relay B.
-- The connection will never be re-established again.
--
prop_track_coolingToCold_demotions :: AbsBearerInfo
-> DiffusionScript
-> Property
prop_track_coolingToCold_demotions defaultBearerInfo diffScript =
let sim :: forall s . IOSim s Void
sim = diffusionSimulation (toBearerInfo defaultBearerInfo)
diffScript
iosimTracer
events :: [Events DiffusionTestTrace]
events = fmap ( Signal.eventsFromList
. fmap (\(WithName _ (WithTime t b)) -> (t, b))
)
. Trace.toList
. splitWithNameTrace
. Trace.fromList ()
. fmap snd
. Signal.eventsToList
. Signal.eventsFromListUpToTime (Time (10 * 60 * 60))
. Trace.toList
. fmap (\(WithTime t (WithName name b)) -> (t, WithName name (WithTime t b)))
. withTimeNameTraceEvents
@DiffusionTestTrace
@NtNAddr
. traceFromList
. fmap (\(t, tid, tl, te) -> SimEvent t tid tl te)
. take 125000
. traceEvents
$ runSimTrace sim
in conjoin
$ (\ev ->
let evsList = eventsToList ev
lastTime = fst
. last
$ evsList
in classifySimulatedTime lastTime
$ classifyNumberOfEvents (length evsList)
$ verify_coolingToColdDemotions ev
)
<$> events
where
verify_coolingToColdDemotions :: Events DiffusionTestTrace -> Property
verify_coolingToColdDemotions events =
let govInProgressDemoteToCold :: Signal (Set NtNAddr)
govInProgressDemoteToCold =
selectDiffusionPeerSelectionState
Governor.inProgressDemoteToCold
events
trJoinKillSig :: Signal JoinedOrKilled
trJoinKillSig =
Signal.fromChangeEvents Killed -- Default to TrKillingNode
. Signal.selectEvents
(\case TrJoiningNetwork -> Just Joined
TrKillingNode -> Just Killed
_ -> Nothing
)
. selectDiffusionSimulationTrace
$ events
-- Signal.keyedUntil receives 2 functions one that sets start of the
-- set signal, one that ends it and another that stops all.
--
-- In this particular case we want a signal that is keyed beginning
-- on a TrJoiningNetwork and ends on TrKillingNode, giving us a Signal
-- with the periods when a node was alive.
trIsNodeAlive :: Signal Bool
trIsNodeAlive =
not . Set.null
<$> Signal.keyedUntil (fromJoinedOrKilled (Set.singleton ())
Set.empty)
(fromJoinedOrKilled Set.empty
(Set.singleton ()))
(const False)
trJoinKillSig
govInProgressDemoteToColdWhileAlive :: Signal (Maybe (Set NtNAddr))
govInProgressDemoteToColdWhileAlive =
(\isAlive inProgressDemoteToCold ->
if isAlive then Just inProgressDemoteToCold
else Nothing
) <$> trIsNodeAlive
<*> govInProgressDemoteToCold
allInProgressDemoteToCold :: [NtNAddr]
allInProgressDemoteToCold = Set.toList
. Set.unions
. mapMaybe snd
. Signal.eventsToList
. Signal.toChangeEvents
$ govInProgressDemoteToColdWhileAlive
notInProgressDemoteToColdForTooLong =
map (\addr ->
Signal.keyedTimeoutTruncated
120
(\case
Just s | Set.member addr s -> Set.singleton addr
_ -> Set.empty
)
govInProgressDemoteToColdWhileAlive
)
allInProgressDemoteToCold
in conjoin
$ map (signalProperty 20 show Set.null) notInProgressDemoteToColdForTooLong
-- | This test coverage of ServerTrace constructors, namely accept errors.
--
prop_server_trace_coverage :: AbsBearerInfo
-> DiffusionScript
-> Property
prop_server_trace_coverage defaultBearerInfo diffScript =
let sim :: forall s . IOSim s Void
sim = diffusionSimulation (toBearerInfo defaultBearerInfo)
diffScript
iosimTracer
events :: [ServerTrace NtNAddr]
events = mapMaybe (\case DiffusionServerTrace st -> Just st
_ -> Nothing
)
. Trace.toList
. fmap (\(WithTime _ (WithName _ b)) -> b)
. withTimeNameTraceEvents
@DiffusionTestTrace
@NtNAddr
. traceFromList
. fmap (\(t, tid, tl, te) -> SimEvent t tid tl te)
. take 125000
. traceEvents
$ runSimTrace sim
eventsSeenNames = map serverTraceMap events
-- TODO: Add checkCoverage here
in tabulate "server trace" eventsSeenNames
True
-- | This test coverage of PeerSelectionActionsTrace constructors.
--
prop_peer_selection_action_trace_coverage :: AbsBearerInfo
-> DiffusionScript
-> Property
prop_peer_selection_action_trace_coverage defaultBearerInfo diffScript =
let sim :: forall s . IOSim s Void
sim = diffusionSimulation (toBearerInfo defaultBearerInfo)
diffScript
iosimTracer
events :: [PeerSelectionActionsTrace NtNAddr NtNVersion]
events = mapMaybe (\case DiffusionPeerSelectionActionsTrace st -> Just st
_ -> Nothing
)
. Trace.toList
. fmap (\(WithTime _ (WithName _ b)) -> b)
. withTimeNameTraceEvents
@DiffusionTestTrace
@NtNAddr
. traceFromList
. fmap (\(t, tid, tl, te) -> SimEvent t tid tl te)
. take 125000
. traceEvents
$ runSimTrace sim
peerSelectionActionsTraceMap :: PeerSelectionActionsTrace NtNAddr NtNVersion
-> String
peerSelectionActionsTraceMap (PeerStatusChanged _) =
"PeerStatusChanged"
peerSelectionActionsTraceMap (PeerStatusChangeFailure _ ft) =
"PeerStatusChangeFailure " ++ show ft
peerSelectionActionsTraceMap (PeerMonitoringError _ se) =
"PeerMonitoringError " ++ show se
peerSelectionActionsTraceMap (PeerMonitoringResult _ wspt) =
"PeerMonitoringResult " ++ show wspt
eventsSeenNames = map peerSelectionActionsTraceMap events
-- TODO: Add checkCoverage here
in tabulate "peer selection actions trace" eventsSeenNames
True
-- | This test coverage of TracePeerSelection constructors.
--
prop_peer_selection_trace_coverage :: AbsBearerInfo
-> DiffusionScript
-> Property
prop_peer_selection_trace_coverage defaultBearerInfo diffScript =
let sim :: forall s . IOSim s Void
sim = diffusionSimulation (toBearerInfo defaultBearerInfo)
diffScript
iosimTracer
events :: [TracePeerSelection NtNAddr]
events = mapMaybe (\case DiffusionPeerSelectionTrace st -> Just st
_ -> Nothing
)
. Trace.toList
. fmap (\(WithTime _ (WithName _ b)) -> b)
. withTimeNameTraceEvents
@DiffusionTestTrace
@NtNAddr
. traceFromList
. fmap (\(t, tid, tl, te) -> SimEvent t tid tl te)
. take 125000
. traceEvents
$ runSimTrace sim
peerSelectionTraceMap :: TracePeerSelection NtNAddr -> String
peerSelectionTraceMap TraceLocalRootPeersChanged {} =
"TraceLocalRootPeersChanged"
peerSelectionTraceMap TraceTargetsChanged {} =
"TraceTargetsChanged"
peerSelectionTraceMap TracePublicRootsRequest {} =
"TracePublicRootsRequest"
peerSelectionTraceMap TracePublicRootsResults {} =
"TracePublicRootsResults"
peerSelectionTraceMap (TracePublicRootsFailure se _ _) =
"TracePublicRootsFailure " ++ show se
peerSelectionTraceMap TracePeerShareRequests {} =
"TracePeerShareRequests"
peerSelectionTraceMap TracePeerShareResults {} =
"TracePeerShareResults"
peerSelectionTraceMap TracePeerShareResultsFiltered {} =
"TracePeerShareResultsFiltered"
peerSelectionTraceMap (TraceKnownInboundConnection addr ps) =
"TraceKnownInboundConnection " ++ show addr ++ " " ++ show ps
peerSelectionTraceMap TraceForgetColdPeers {} =
"TraceForgetColdPeers"
peerSelectionTraceMap TracePromoteColdPeers {} =
"TracePromoteColdPeers"
peerSelectionTraceMap TracePromoteColdLocalPeers {} =
"TracePromoteColdLocalPeers"
peerSelectionTraceMap TracePromoteColdFailed {} =
"TracePromoteColdFailed"
peerSelectionTraceMap TracePromoteColdDone {} =
"TracePromoteColdDone"
peerSelectionTraceMap TracePromoteWarmPeers {} =
"TracePromoteWarmPeers"
peerSelectionTraceMap TracePromoteWarmLocalPeers {} =
"TracePromoteWarmLocalPeers"
peerSelectionTraceMap TracePromoteWarmFailed {} =
"TracePromoteWarmFailed"
peerSelectionTraceMap TracePromoteWarmDone {} =
"TracePromoteWarmDone"
peerSelectionTraceMap TracePromoteWarmAborted {} =