Safe Haskell	None
Language	Haskell2010

Test.Consensus.PointSchedule

Description

Data types and generators for point schedules.

Each generator takes a set of AnchoredFragments corresponding to the tested peers' chains, and converts them to a point schedule consisting of a sequence of NodeStates, each of which is associated with a single peer.

When a schedule is executed in a test, each tick is processed in order. The peer associated with the current tick is considered "active", which means that its ChainSync server is allowed to continue processing messages, while all the other peers' servers suspend operation by blocking on a concurrency primitive. The state in the current tick determines the actions that the peer is allowed to perform, and once it fulfills the state's criteria, it yields control back to the scheduler, who then activates the next tick's peer.

Synopsis

data BlockFetchTimeout = BlockFetchTimeout {
- busyTimeout ∷ Maybe DiffTime
- streamingTimeout ∷ Maybe DiffTime
}
data CSJParams = CSJParams {
- csjpJumpSize ∷ SlotNo
}
data DowntimeParams
- = NoDowntime
- | DowntimeWithSecurityParam SecurityParam
newtype ForecastRange = ForecastRange {
- unForecastRange ∷ Word64
}
data GenesisTest blk schedule = GenesisTest {
- gtSecurityParam ∷ SecurityParam
- gtGenesisWindow ∷ GenesisWindow
- gtForecastRange ∷ ForecastRange
- gtDelay ∷ Delta
- gtBlockTree ∷ BlockTree blk
- gtChainSyncTimeouts ∷ ChainSyncTimeout
- gtBlockFetchTimeouts ∷ BlockFetchTimeout
- gtLoPBucketParams ∷ LoPBucketParams
- gtCSJParams ∷ CSJParams
- gtSlotLength ∷ SlotLength
- gtExtraHonestPeers ∷ Word
- gtSchedule ∷ schedule
}
type GenesisTestFull blk = GenesisTest blk (PointSchedule blk)
newtype GenesisWindow = GenesisWindow {
- unGenesisWindow ∷ Word64
}
class HasPointScheduleTestParams blk where
- data ProtocolInfoArgs blk
- getProtocolInfoArgs ∷ IO (ProtocolInfoArgs blk)
- mkProtocolInfo ∷ SecurityParam → ForecastRange → GenesisWindow → ProtocolInfoArgs blk → ProtocolInfo blk
- getChunkInfoFromTopLevelConfig ∷ TopLevelConfig blk → ChunkInfo
data LoPBucketParams = LoPBucketParams {
- lbpCapacity ∷ Integer
- lbpRate ∷ Rational
}
type PeerSchedule blk = [(Time, SchedulePoint blk)]
data PointSchedule blk = PointSchedule {
- psSchedule ∷ Peers (PeerSchedule blk)
- psStartOrder ∷ [PeerId]
- psMinEndTime ∷ Time
}
data PointsGeneratorParams = PointsGeneratorParams {
- pgpExtraHonestPeers ∷ Int
- pgpDowntime ∷ DowntimeParams
}
data RunGenesisTestResult blk = RunGenesisTestResult {
- rgtrTrace ∷ String
- rgtrStateView ∷ StateView blk
}
enrichedWith ∷ (Functor f, Monad m) ⇒ m (f a) → (f a → m b) → m (f b)
ensureScheduleDuration ∷ GenesisTest blk a → PointSchedule blk → PointSchedule blk
genesisNodeState ∷ NodeState blk
longRangeAttack ∷ (StatefulGen g m, HasHeader blk) ⇒ BlockTree blk → g → m (PointSchedule blk)
peerSchedulesBlocks ∷ Peers (PeerSchedule blk) → [blk]
peerStates ∷ Peer (PeerSchedule blk) → [(Time, Peer (NodeState blk))]
peersStates ∷ PointSchedule blk → [(Time, Peer (NodeState blk))]
peersStatesRelative ∷ PointSchedule blk → [(DiffTime, Peer (NodeState blk))]
prettyGenesisTest ∷ (HasHeader blk, Terse blk) ⇒ (schedule → [String]) → GenesisTest blk schedule → [String]
prettyPointSchedule ∷ CondenseList (NodeState blk) ⇒ PointSchedule blk → [String]
stToGen ∷ (∀ s. STGenM QCGen s → ST s a) → Gen a
uniformPoints ∷ (StatefulGen g m, HasHeader blk) ⇒ PointsGeneratorParams → BlockTree blk → g → m (PointSchedule blk)
data ChainSyncTimeout = ChainSyncTimeout {
- canAwaitTimeout ∷ Maybe DiffTime
- intersectTimeout ∷ Maybe DiffTime
- mustReplyTimeout ∷ Maybe DiffTime
- idleTimeout ∷ Maybe DiffTime
}
timeLimitsChainSync ∷ ChainSyncTimeout → ProtocolTimeLimits (ChainSync header point tip)

Documentation

data BlockFetchTimeout Source #

Similar to ChainSyncTimeout for BlockFetch. Only the states in which the server has agency are specified. REVIEW: Should it be upstreamed to ouroboros-network-protocols?

Constructors

BlockFetchTimeout
Fields busyTimeout ∷ Maybe DiffTime streamingTimeout ∷ Maybe DiffTime

data CSJParams Source #

Constructors

CSJParams
Fields csjpJumpSize ∷ SlotNo

Instances

Instances details

Show CSJParams Source #
Instance details Defined in Test.Consensus.PointSchedule Methods showsPrec ∷ Int → CSJParams → ShowS # show ∷ CSJParams → String # showList ∷ [CSJParams] → ShowS #

data DowntimeParams Source #

Constructors

NoDowntime
DowntimeWithSecurityParam SecurityParam

newtype ForecastRange Source #

Constructors

ForecastRange
Fields unForecastRange ∷ Word64

Instances

Instances details

Show ForecastRange Source #
Instance details Defined in Test.Consensus.PointSchedule Methods showsPrec ∷ Int → ForecastRange → ShowS # show ∷ ForecastRange → String # showList ∷ [ForecastRange] → ShowS #

data GenesisTest blk schedule Source #

All the data used by point schedule tests.

Constructors

GenesisTest

Fields

gtSecurityParam ∷ SecurityParam
gtGenesisWindow ∷ GenesisWindow
gtForecastRange ∷ ForecastRange
gtDelay ∷ Delta
gtBlockTree ∷ BlockTree blk
gtChainSyncTimeouts ∷ ChainSyncTimeout
gtBlockFetchTimeouts ∷ BlockFetchTimeout
gtLoPBucketParams ∷ LoPBucketParams
gtCSJParams ∷ CSJParams
gtSlotLength ∷ SlotLength
gtExtraHonestPeers ∷ Word
The number of extra honest peers we want in the test. It is stored here for convenience, and because it may affect schedule and block tree generation.
There will be at most one adversarial peer per alternative branch in the block tree (exactly one per branch if no adversary does a rollback), and 1 + gtExtraHonestPeers honest peers.
gtSchedule ∷ schedule

Instances

Instances details

Functor (GenesisTest blk) Source #
Instance details Defined in Test.Consensus.PointSchedule Methods fmap ∷ (a → b) → GenesisTest blk a → GenesisTest blk b # (<$) ∷ a → GenesisTest blk b → GenesisTest blk a #

type GenesisTestFull blk = GenesisTest blk (PointSchedule blk) Source #

newtype GenesisWindow Source #

Size of the Genesis window, in number of slots.

This is the number of slots that the GDD Governor (Genesis Density Disconnection Governor -- see Governor) will consider when deciding whether to disconnect from a peer. It has to be smaller or equal to the stability window. For instance, for Shelley-based eras, this will be equal to a stability window, that is 3k/f.

Constructors

GenesisWindow
Fields unGenesisWindow ∷ Word64

Instances

Instances details

Num GenesisWindow
Instance details Defined in Ouroboros.Consensus.Block.Abstract Methods (+) ∷ GenesisWindow → GenesisWindow → GenesisWindow # (-) ∷ GenesisWindow → GenesisWindow → GenesisWindow # (*) ∷ GenesisWindow → GenesisWindow → GenesisWindow # negate ∷ GenesisWindow → GenesisWindow # abs ∷ GenesisWindow → GenesisWindow # signum ∷ GenesisWindow → GenesisWindow # fromInteger ∷ Integer → GenesisWindow #
Show GenesisWindow
Instance details Defined in Ouroboros.Consensus.Block.Abstract Methods showsPrec ∷ Int → GenesisWindow → ShowS # show ∷ GenesisWindow → String # showList ∷ [GenesisWindow] → ShowS #
Eq GenesisWindow
Instance details Defined in Ouroboros.Consensus.Block.Abstract Methods (==) ∷ GenesisWindow → GenesisWindow → Bool # (/=) ∷ GenesisWindow → GenesisWindow → Bool #
Ord GenesisWindow
Instance details Defined in Ouroboros.Consensus.Block.Abstract Methods compare ∷ GenesisWindow → GenesisWindow → Ordering # (<) ∷ GenesisWindow → GenesisWindow → Bool # (<=) ∷ GenesisWindow → GenesisWindow → Bool # (>) ∷ GenesisWindow → GenesisWindow → Bool # (>=) ∷ GenesisWindow → GenesisWindow → Bool # max ∷ GenesisWindow → GenesisWindow → GenesisWindow # min ∷ GenesisWindow → GenesisWindow → GenesisWindow #
NoThunks GenesisWindow
Instance details Defined in Ouroboros.Consensus.Block.Abstract Methods noThunks ∷ Context → GenesisWindow → IO (Maybe ThunkInfo) Source # wNoThunks ∷ Context → GenesisWindow → IO (Maybe ThunkInfo) Source # showTypeOf ∷ Proxy GenesisWindow → String Source #

class HasPointScheduleTestParams blk where Source #

This class exists to house some of the functions required of a block type in order to be used by point schedule tests in nodeLifecycle. It was introduced to help generalize the tests from TestBlocks to live block types. It has no laws, and all these functions have in common is that they provide bits of state required to run the tests that did not already have a class to live in.

Associated Types

data ProtocolInfoArgs blk Source #

Methods

getProtocolInfoArgs ∷ IO (ProtocolInfoArgs blk) Source #

The requirement of IO comes from needing to parse configuration files.

mkProtocolInfo ∷ SecurityParam → ForecastRange → GenesisWindow → ProtocolInfoArgs blk → ProtocolInfo blk Source #

getChunkInfoFromTopLevelConfig ∷ TopLevelConfig blk → ChunkInfo Source #

Instances

Instances details

a ~ () ⇒ HasPointScheduleTestParams (TestBlockWith a) Source #

If you are here because you tried to implement HasPointScheduleTestParams for some type `TestBlockWith Foo` and got an overlapping instance warning, the `a ~ ()` constraint is only here to get your attention. The tests should remain as block polymorphic as possible, so maybe there should be a class for the types a that can appear in `TestBlockWith a`. But we in the past do not know what that class should look like! So the choice is yours: if what you need from this class can be made polymorphic in a, consider adding a class. If not, specialize this instance.

Instance details

Defined in Test.Consensus.PeerSimulator.Config

Associated Types

data ProtocolInfoArgs (TestBlockWith a)
Instance details Defined in Test.Consensus.PeerSimulator.Config data ProtocolInfoArgs (TestBlockWith a) = TestBlockProtocolInfoArgs

Methods

getProtocolInfoArgs ∷ IO (ProtocolInfoArgs (TestBlockWith a)) Source #

mkProtocolInfo ∷ SecurityParam → ForecastRange → GenesisWindow → ProtocolInfoArgs (TestBlockWith a) → ProtocolInfo (TestBlockWith a) Source #

getChunkInfoFromTopLevelConfig ∷ TopLevelConfig (TestBlockWith a) → ChunkInfo Source #

data LoPBucketParams Source #

Constructors

LoPBucketParams
Fields lbpCapacity ∷ Integer lbpRate ∷ Rational

type PeerSchedule blk = [(Time, SchedulePoint blk)] Source #

data PointSchedule blk Source #

Constructors

PointSchedule

Fields

psSchedule ∷ Peers (PeerSchedule blk)
The actual point schedule
psStartOrder ∷ [PeerId]
The order in which the peers start and connect to the node under test. The peers that are absent from psSchedule are ignored; the peers from psSchedule that are absent of psStartOrder are started in the end in the order of PeerId.
psMinEndTime ∷ Time
Minimum duration for the simulation of this point schedule. If no point in the schedule is larger than psMinEndTime, the simulation will still run until this time is reached.

data PointsGeneratorParams Source #

Constructors

PointsGeneratorParams
Fields pgpExtraHonestPeers ∷ Int pgpDowntime ∷ DowntimeParams

data RunGenesisTestResult blk Source #

All the data describing the result of a test

Constructors

RunGenesisTestResult
Fields rgtrTrace ∷ String rgtrStateView ∷ StateView blk

enrichedWith ∷ (Functor f, Monad m) ⇒ m (f a) → (f a → m b) → m (f b) Source #

ensureScheduleDuration ∷ GenesisTest blk a → PointSchedule blk → PointSchedule blk Source #

genesisNodeState ∷ NodeState blk Source #

longRangeAttack ∷ (StatefulGen g m, HasHeader blk) ⇒ BlockTree blk → g → m (PointSchedule blk) Source #

Produce a schedule similar to Frequencies (Peers 1 [10]), using the new SinglePeer generator.

We hardcode the two schedules to use the latest block as the initial tip point. The honest peer gets a substantially larger (and disconnected) delay interval to ensure that k+1 blocks are sent fast enough to trigger selection of a fork.

peerSchedulesBlocks ∷ Peers (PeerSchedule blk) → [blk] Source #

List of all blocks appearing in the schedules.

peerStates ∷ Peer (PeerSchedule blk) → [(Time, Peer (NodeState blk))] Source #

Convert a SinglePeer schedule to a NodeState schedule.

Accumulates the new points in each tick into the previous state, starting with a set of all Origin points.

Finally, drops the first state, since all points being Origin (in particular the tip) has no useful effects in the simulator, but it could set the tip in the GDD governor to Origin, which causes slow nodes to be disconnected right away.

TODO Remove dropping the first state in favor of better GDD logic

peersStates ∷ PointSchedule blk → [(Time, Peer (NodeState blk))] Source #

Convert several SinglePeer schedules to a common NodeState schedule.

The resulting schedule contains all the peers. Items are sorted by time.

peersStatesRelative ∷ PointSchedule blk → [(DiffTime, Peer (NodeState blk))] Source #

Same as peersStates but returns the duration of a state instead of the absolute time at which it starts holding.

prettyGenesisTest ∷ (HasHeader blk, Terse blk) ⇒ (schedule → [String]) → GenesisTest blk schedule → [String] Source #

prettyPointSchedule ∷ CondenseList (NodeState blk) ⇒ PointSchedule blk → [String] Source #

stToGen ∷ (∀ s. STGenM QCGen s → ST s a) → Gen a Source #

Wrap a ST generator in Gen.

uniformPoints ∷ (StatefulGen g m, HasHeader blk) ⇒ PointsGeneratorParams → BlockTree blk → g → m (PointSchedule blk) Source #

data ChainSyncTimeout Source #

Configurable chain-sync timeouts

Constructors

ChainSyncTimeout
Fields canAwaitTimeout ∷ Maybe DiffTime intersectTimeout ∷ Maybe DiffTime mustReplyTimeout ∷ Maybe DiffTime idleTimeout ∷ Maybe DiffTime

timeLimitsChainSync ∷ ChainSyncTimeout → ProtocolTimeLimits (ChainSync header point tip) Source #

Time Limits

'TokIdle'               'waitForever' (ie never times out)
'TokNext TokCanAwait'   the given 'canAwaitTimeout'
'TokNext TokMustReply'  the given 'mustReplyTimeout'
'TokIntersect'          the given 'intersectTimeout'