Safe Haskell	Safe-Inferred
Language	Haskell2010

Test.Consensus.PeerSimulator.StateView

Synopsis

data PeerSimulatorComponent
- = ChainSyncClient
- | ChainSyncServer
- | BlockFetchClient
- | BlockFetchServer
data PeerSimulatorComponentResult blk
- = SomeChainSyncClientResult (Either SomeException (ChainSyncClientResult, Maybe (ChainSyncResult blk)))
- | SomeChainSyncServerResult (Either SomeException (Maybe (ChainSyncResult blk)))
- | SomeBlockFetchClientResult (Either SomeException (Maybe (BlockFetchResult blk)))
- | SomeBlockFetchServerResult (Either SomeException (Maybe (BlockFetchResult blk)))
data PeerSimulatorResult blk = PeerSimulatorResult {
- psePeerId ∷ PeerId
- pseResult ∷ PeerSimulatorComponentResult blk
}
data StateView blk = StateView {
- svSelectedChain ∷ AnchoredFragment (Header blk)
- svPeerSimulatorResults ∷ [PeerSimulatorResult blk]
- svTipBlock ∷ Maybe blk
}
data StateViewTracers blk m = StateViewTracers {
- svtPeerSimulatorResultsTracer ∷ Tracer m (PeerSimulatorResult blk)
- svtGetPeerSimulatorResults ∷ m [PeerSimulatorResult blk]
}
collectDisconnectedPeers ∷ StateView blk → [PeerId]
defaultStateViewTracers ∷ IOLike m ⇒ m (StateViewTracers blk m)
exceptionsByComponent ∷ PeerSimulatorComponent → StateView blk → [SomeException]
pscrToException ∷ PeerSimulatorComponentResult blk → Maybe SomeException
snapshotStateView ∷ IOLike m ⇒ StateViewTracers blk m → ChainDB m blk → m (StateView blk)

Documentation

data PeerSimulatorComponent Source #

Constructors

ChainSyncClient
ChainSyncServer
BlockFetchClient
BlockFetchServer

Instances

Instances details

Eq PeerSimulatorComponent Source #
Instance details Defined in Test.Consensus.PeerSimulator.StateView Methods (==) ∷ PeerSimulatorComponent → PeerSimulatorComponent → Bool # (/=) ∷ PeerSimulatorComponent → PeerSimulatorComponent → Bool #
Ord PeerSimulatorComponent Source #
Instance details Defined in Test.Consensus.PeerSimulator.StateView Methods compare ∷ PeerSimulatorComponent → PeerSimulatorComponent → Ordering # (<) ∷ PeerSimulatorComponent → PeerSimulatorComponent → Bool # (<=) ∷ PeerSimulatorComponent → PeerSimulatorComponent → Bool # (>) ∷ PeerSimulatorComponent → PeerSimulatorComponent → Bool # (>=) ∷ PeerSimulatorComponent → PeerSimulatorComponent → Bool # max ∷ PeerSimulatorComponent → PeerSimulatorComponent → PeerSimulatorComponent # min ∷ PeerSimulatorComponent → PeerSimulatorComponent → PeerSimulatorComponent #

data PeerSimulatorComponentResult blk Source #

Constructors

SomeChainSyncClientResult (Either SomeException (ChainSyncClientResult, Maybe (ChainSyncResult blk)))
SomeChainSyncServerResult (Either SomeException (Maybe (ChainSyncResult blk)))
SomeBlockFetchClientResult (Either SomeException (Maybe (BlockFetchResult blk)))
SomeBlockFetchServerResult (Either SomeException (Maybe (BlockFetchResult blk)))

Instances

Instances details

Eq (PeerSimulatorComponentResult blk) Source #
Instance details Defined in Test.Consensus.PeerSimulator.StateView Methods (==) ∷ PeerSimulatorComponentResult blk → PeerSimulatorComponentResult blk → Bool # (/=) ∷ PeerSimulatorComponentResult blk → PeerSimulatorComponentResult blk → Bool #
Ord (PeerSimulatorComponentResult blk) Source #
Instance details Defined in Test.Consensus.PeerSimulator.StateView Methods compare ∷ PeerSimulatorComponentResult blk → PeerSimulatorComponentResult blk → Ordering # (<) ∷ PeerSimulatorComponentResult blk → PeerSimulatorComponentResult blk → Bool # (<=) ∷ PeerSimulatorComponentResult blk → PeerSimulatorComponentResult blk → Bool # (>) ∷ PeerSimulatorComponentResult blk → PeerSimulatorComponentResult blk → Bool # (>=) ∷ PeerSimulatorComponentResult blk → PeerSimulatorComponentResult blk → Bool # max ∷ PeerSimulatorComponentResult blk → PeerSimulatorComponentResult blk → PeerSimulatorComponentResult blk # min ∷ PeerSimulatorComponentResult blk → PeerSimulatorComponentResult blk → PeerSimulatorComponentResult blk #
(StandardHash blk, Show blk, Show (Header blk)) ⇒ Condense (PeerSimulatorComponentResult blk) Source #
Instance details Defined in Test.Consensus.PeerSimulator.StateView Methods condense ∷ PeerSimulatorComponentResult blk → String Source #

data PeerSimulatorResult blk Source #

A record to associate an exception thrown by a thread running a component of the peer simulator with the peer that it was running for.

Constructors

PeerSimulatorResult
Fields psePeerId ∷ PeerId pseResult ∷ PeerSimulatorComponentResult blk

Instances

Instances details

Eq (PeerSimulatorResult blk) Source #
Instance details Defined in Test.Consensus.PeerSimulator.StateView Methods (==) ∷ PeerSimulatorResult blk → PeerSimulatorResult blk → Bool # (/=) ∷ PeerSimulatorResult blk → PeerSimulatorResult blk → Bool #
Ord (PeerSimulatorResult blk) Source #
Instance details Defined in Test.Consensus.PeerSimulator.StateView Methods compare ∷ PeerSimulatorResult blk → PeerSimulatorResult blk → Ordering # (<) ∷ PeerSimulatorResult blk → PeerSimulatorResult blk → Bool # (<=) ∷ PeerSimulatorResult blk → PeerSimulatorResult blk → Bool # (>) ∷ PeerSimulatorResult blk → PeerSimulatorResult blk → Bool # (>=) ∷ PeerSimulatorResult blk → PeerSimulatorResult blk → Bool # max ∷ PeerSimulatorResult blk → PeerSimulatorResult blk → PeerSimulatorResult blk # min ∷ PeerSimulatorResult blk → PeerSimulatorResult blk → PeerSimulatorResult blk #
(StandardHash blk, Show blk, Show (Header blk)) ⇒ Condense (PeerSimulatorResult blk) Source #
Instance details Defined in Test.Consensus.PeerSimulator.StateView Methods condense ∷ PeerSimulatorResult blk → String Source #
(StandardHash blk, Show blk, Show (Header blk)) ⇒ CondenseList (PeerSimulatorResult blk) Source #
Instance details Defined in Test.Consensus.PeerSimulator.StateView Methods condenseList ∷ [PeerSimulatorResult blk] → [String] Source #

data StateView blk Source #

A state view is a partial view of the state of the whole peer simulator. This includes information about the part of the code that is being tested (for instance the fragment that is selected by the ChainDB) but also information about the mocked peers (for instance the exceptions raised in the mocked ChainSync server threads).

Constructors

StateView
Fields svSelectedChain ∷ AnchoredFragment (Header blk) svPeerSimulatorResults ∷ [PeerSimulatorResult blk] svTipBlock ∷ Maybe blk This field holds the most recent point in the selection (incl. anchor) for which we have a full block (not just a header).

Instances

Instances details

Condense (StateView TestBlock) Source #
Instance details Defined in Test.Consensus.PeerSimulator.StateView Methods condense ∷ StateView TestBlock → String Source #

data StateViewTracers blk m Source #

State view tracers are a lightweight mechanism to record information that can later be used to produce a state view. This mechanism relies on contra-tracers which we already use in a pervasives way.

Constructors

StateViewTracers
Fields svtPeerSimulatorResultsTracer ∷ Tracer m (PeerSimulatorResult blk) svtGetPeerSimulatorResults ∷ m [PeerSimulatorResult blk]

collectDisconnectedPeers ∷ StateView blk → [PeerId] Source #

Return the list of peer ids for all peers whose ChainSync thread or BlockFetch thread was terminated.

defaultStateViewTracers ∷ IOLike m ⇒ m (StateViewTracers blk m) Source #

Make default state view tracers. The tracers are all freshly initialised and contain no information.

exceptionsByComponent ∷ PeerSimulatorComponent → StateView blk → [SomeException] Source #

Helper to get exceptions from a StateView.

pscrToException ∷ PeerSimulatorComponentResult blk → Maybe SomeException Source #

snapshotStateView ∷ IOLike m ⇒ StateViewTracers blk m → ChainDB m blk → m (StateView blk) Source #

Use the state view tracers as well as some extra information to produce a state view. This mostly consists in reading and storing the current state of the tracers.