Safe Haskell	Safe-Inferred
Language	Haskell2010

Test.Ouroboros.Network.PeerSelection.PeerMetric

Synopsis

tests :: TestTree
newtype TestAddress = TestAddress Int
data Event
- = FetchedHeader TestAddress SlotNo
- | FetchedBlock TestAddress SlotNo SizeInBytes
eventPeer :: Event -> TestAddress
eventSlot :: Event -> SlotNo
newtype FixedScript = FixedScript {
- getFixedScript :: Script Event
}
mkFixedScript :: Script Event -> FixedScript
mkTimedScript :: FixedScript -> TimedScript Event
data PeerMetricsTrace = PeerMetricsTrace {
- pmtPeer :: TestAddress
- pmtSlot :: SlotNo
- pmtUpstreamyness :: Map TestAddress Int
- pmtFetchynessBytes :: Map TestAddress Int
- pmtFetchynessBlocks :: Map TestAddress Int
- pmtJoinedAt :: Map TestAddress SlotNo
}
simulatePeerMetricScript :: forall m. (MonadDelay m, MonadTimer m, MonadMonotonicTime m, MonadLabelledSTM m, MonadTraceSTM m) => Tracer m PeerMetricsTrace -> PeerMetricsConfiguration -> FixedScript -> m ()
interpretScriptDelay :: ScriptDelay -> DiffTime
prop_insert_peer :: FixedScript -> Property
prop_metrics_are_bounded :: FixedScript -> Property
prop_bounded_size :: Positive Int -> FixedScript -> Property
microbenchmark1GenerateInput :: Bool -> Int -> IO FixedScript
microbenchmark1ProcessInput :: FixedScript -> IO ()
microbenchmark1 :: Bool -> Int -> IO ()
prop_simScript :: FixedScript -> Property
simulatePeerMetricScriptWithoutDelays :: forall m. MonadLabelledSTM m => Tracer m PeerMetricsTrace -> PeerMetricsConfiguration -> FixedScript -> m ()

Documentation

tests :: TestTree Source #

newtype TestAddress Source #

Constructors

TestAddress Int

Instances

Instances details

Arbitrary TestAddress Source #
Instance details Defined in Test.Ouroboros.Network.PeerSelection.PeerMetric Methods arbitrary :: Gen TestAddress shrink :: TestAddress -> [TestAddress]
Show TestAddress Source #
Instance details Defined in Test.Ouroboros.Network.PeerSelection.PeerMetric Methods showsPrec :: Int -> TestAddress -> ShowS Source # show :: TestAddress -> String Source # showList :: [TestAddress] -> ShowS Source #
NFData TestAddress Source #
Instance details Defined in Test.Ouroboros.Network.PeerSelection.PeerMetric Methods rnf :: TestAddress -> () Source #
Eq TestAddress Source #
Instance details Defined in Test.Ouroboros.Network.PeerSelection.PeerMetric Methods (==) :: TestAddress -> TestAddress -> Bool Source # (/=) :: TestAddress -> TestAddress -> Bool Source #
Ord TestAddress Source #
Instance details Defined in Test.Ouroboros.Network.PeerSelection.PeerMetric Methods compare :: TestAddress -> TestAddress -> Ordering Source # (<) :: TestAddress -> TestAddress -> Bool Source # (<=) :: TestAddress -> TestAddress -> Bool Source # (>) :: TestAddress -> TestAddress -> Bool Source # (>=) :: TestAddress -> TestAddress -> Bool Source # max :: TestAddress -> TestAddress -> TestAddress Source # min :: TestAddress -> TestAddress -> TestAddress Source #
NoThunks TestAddress Source #
Instance details Defined in Test.Ouroboros.Network.PeerSelection.PeerMetric Methods noThunks :: Context -> TestAddress -> IO (Maybe ThunkInfo) wNoThunks :: Context -> TestAddress -> IO (Maybe ThunkInfo) showTypeOf :: Proxy TestAddress -> String

data Event Source #

Constructors

FetchedHeader TestAddress SlotNo
FetchedBlock TestAddress SlotNo SizeInBytes

Instances

Instances details

Arbitrary Event Source #
Instance details Defined in Test.Ouroboros.Network.PeerSelection.PeerMetric Methods arbitrary :: Gen Event shrink :: Event -> [Event]
Show Event Source #
Instance details Defined in Test.Ouroboros.Network.PeerSelection.PeerMetric Methods showsPrec :: Int -> Event -> ShowS Source # show :: Event -> String Source # showList :: [Event] -> ShowS Source #

eventPeer :: Event -> TestAddress Source #

eventSlot :: Event -> SlotNo Source #

newtype FixedScript Source #

Constructors

FixedScript
Fields getFixedScript :: Script Event

Instances

Instances details

Arbitrary FixedScript Source #
Instance details Defined in Test.Ouroboros.Network.PeerSelection.PeerMetric Methods arbitrary :: Gen FixedScript shrink :: FixedScript -> [FixedScript]
Show FixedScript Source #
Instance details Defined in Test.Ouroboros.Network.PeerSelection.PeerMetric Methods showsPrec :: Int -> FixedScript -> ShowS Source # show :: FixedScript -> String Source # showList :: [FixedScript] -> ShowS Source #

mkFixedScript :: Script Event -> FixedScript Source #

Order events by SlotNo

TODO: SizeInBytes should be a function of SlotNo

mkTimedScript :: FixedScript -> TimedScript Event Source #

data PeerMetricsTrace Source #

Constructors

PeerMetricsTrace
Fields pmtPeer :: TestAddress pmtSlot :: SlotNo pmtUpstreamyness :: Map TestAddress Int pmtFetchynessBytes :: Map TestAddress Int pmtFetchynessBlocks :: Map TestAddress Int pmtJoinedAt :: Map TestAddress SlotNo

Instances

Instances details

Show PeerMetricsTrace Source #
Instance details Defined in Test.Ouroboros.Network.PeerSelection.PeerMetric Methods showsPrec :: Int -> PeerMetricsTrace -> ShowS Source # show :: PeerMetricsTrace -> String Source # showList :: [PeerMetricsTrace] -> ShowS Source #

simulatePeerMetricScript :: forall m. (MonadDelay m, MonadTimer m, MonadMonotonicTime m, MonadLabelledSTM m, MonadTraceSTM m) => Tracer m PeerMetricsTrace -> PeerMetricsConfiguration -> FixedScript -> m () Source #

interpretScriptDelay :: ScriptDelay -> DiffTime Source #

prop_insert_peer :: FixedScript -> Property Source #

Check that newly added peer is never in the 20% worst performing peers (if there are at least 5 results).

prop_metrics_are_bounded :: FixedScript -> Property Source #

Check that the results are always positive.

prop_bounded_size :: Positive Int -> FixedScript -> Property Source #

Check that the result are bounded.

The bound is maxEntriesToTrack times number of peers in the simulation. This could be lowered by computing number of peers in each maxEntriesToTrack slots window.

microbenchmark1GenerateInput :: Bool -> Int -> IO FixedScript Source #

microbenchmark1 n - one test of simple property on a FixedScript of length n: one input, one property, one test.

We split into generating input and running/checking it so we can more accurately measure the latter.

microbenchmark1ProcessInput :: FixedScript -> IO () Source #

microbenchmark1 :: Bool -> Int -> IO () Source #

prop_simScript :: FixedScript -> Property Source #

one simple property (pmtUpstreamyness >= 0) checked on the trace of a script:

simulatePeerMetricScriptWithoutDelays :: forall m. MonadLabelledSTM m => Tracer m PeerMetricsTrace -> PeerMetricsConfiguration -> FixedScript -> m () Source #

similar to simulatePeerMetricScript: but we don't do in "real/simulated" time: not calling getMonotonicTime and threadDelay.