Safe Haskell	None
Language	Haskell2010

Ouroboros.Network.Mock.ChainGenerators

Contents

Arbitrary chains generators
Utility functions
Tests of the generators
Orphan instances

Description

Arbitrary generators for chains, headers and blocks

Synopsis

data TestAddBlock = TestAddBlock (Chain Block) Block
data TestBlockChainAndUpdates = TestBlockChainAndUpdates (Chain Block) [ChainUpdate Block Block]
newtype TestBlockChain = TestBlockChain {
- getTestBlockChain :: Chain Block
}
newtype TestHeaderChain = TestHeaderChain (Chain BlockHeader)
data TestChainAndPoint = TestChainAndPoint (Chain Block) (Point Block)
data TestChainAndRange = TestChainAndRange (Chain Block) (Point Block) (Point Block)
data TestChainAndPoints = TestChainAndPoints (Chain Block) [Point Block]
data TestChainFork = TestChainFork (Chain Block) (Chain Block) (Chain Block)
data TestChainRange = TestChainRange (Point Block) (Point Block)
genNonNegative :: Gen Int
genSlotGap :: Gen Int
addSlotGap :: Int -> WithOrigin SlotNo -> SlotNo
genChainAnchor :: Gen (Anchor Block)
mkPartialBlock :: SlotNo -> BlockBody -> Block
mkRollbackPoint :: HasHeader block => Chain block -> Int -> Point block
tests :: TestTree

Arbitrary chains generators

data TestAddBlock Source #

A test generator for a chain and a block that can be appended to it.

Constructors

TestAddBlock (Chain Block) Block

Instances

Instances details

Arbitrary TestAddBlock Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods arbitrary :: Gen TestAddBlock # shrink :: TestAddBlock -> [TestAddBlock] #
Show TestAddBlock Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods showsPrec :: Int -> TestAddBlock -> ShowS # show :: TestAddBlock -> String # showList :: [TestAddBlock] -> ShowS #

data TestBlockChainAndUpdates Source #

A test generator for a chain and a sequence of updates that can be applied to it.

Constructors

TestBlockChainAndUpdates (Chain Block) [ChainUpdate Block Block]

Instances

Instances details

Arbitrary TestBlockChainAndUpdates Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods arbitrary :: Gen TestBlockChainAndUpdates # shrink :: TestBlockChainAndUpdates -> [TestBlockChainAndUpdates] #
Show TestBlockChainAndUpdates Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods showsPrec :: Int -> TestBlockChainAndUpdates -> ShowS # show :: TestBlockChainAndUpdates -> String # showList :: [TestBlockChainAndUpdates] -> ShowS #

newtype TestBlockChain Source #

A test generator for a valid chain of blocks.

Constructors

TestBlockChain
Fields getTestBlockChain :: Chain Block

Instances

Instances details

Arbitrary TestBlockChain Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods arbitrary :: Gen TestBlockChain # shrink :: TestBlockChain -> [TestBlockChain] #
Show TestBlockChain Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods showsPrec :: Int -> TestBlockChain -> ShowS # show :: TestBlockChain -> String # showList :: [TestBlockChain] -> ShowS #
Eq TestBlockChain Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods (==) :: TestBlockChain -> TestBlockChain -> Bool # (/=) :: TestBlockChain -> TestBlockChain -> Bool #

newtype TestHeaderChain Source #

A test generator for a valid chain of block headers.

Constructors

TestHeaderChain (Chain BlockHeader)

Instances

Instances details

Arbitrary TestHeaderChain Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods arbitrary :: Gen TestHeaderChain # shrink :: TestHeaderChain -> [TestHeaderChain] #
Show TestHeaderChain Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods showsPrec :: Int -> TestHeaderChain -> ShowS # show :: TestHeaderChain -> String # showList :: [TestHeaderChain] -> ShowS #
Eq TestHeaderChain Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods (==) :: TestHeaderChain -> TestHeaderChain -> Bool # (/=) :: TestHeaderChain -> TestHeaderChain -> Bool #

data TestChainAndPoint Source #

A test generator for a chain and a points. In most cases the point is on the chain, but it also covers at least 5% of cases where the point is not on the chain.

Constructors

TestChainAndPoint (Chain Block) (Point Block)

Instances

Instances details

Arbitrary TestChainAndPoint Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods arbitrary :: Gen TestChainAndPoint # shrink :: TestChainAndPoint -> [TestChainAndPoint] #
Show TestChainAndPoint Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods showsPrec :: Int -> TestChainAndPoint -> ShowS # show :: TestChainAndPoint -> String # showList :: [TestChainAndPoint] -> ShowS #

data TestChainAndRange Source #

A test generator for a chain and a range defined by a pair of points. In most cases the range is on the chain, but it also covers at least 5% of cases where the point is not on the chain.

Constructors

TestChainAndRange (Chain Block) (Point Block) (Point Block)

Instances

Instances details

Arbitrary TestChainAndRange Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods arbitrary :: Gen TestChainAndRange # shrink :: TestChainAndRange -> [TestChainAndRange] #
Show TestChainAndRange Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods showsPrec :: Int -> TestChainAndRange -> ShowS # show :: TestChainAndRange -> String # showList :: [TestChainAndRange] -> ShowS #

data TestChainAndPoints Source #

A test generator for a chain and a list of points, some of which may not be on the chain. Only 50% of the blocks are selected, one fifth of selected ones are not on the chain. Points which come from the chain are given in the newest to oldest order, but the intermediate points which are not in the chain might break the order.

Constructors

TestChainAndPoints (Chain Block) [Point Block]

Instances

Instances details

Arbitrary TestChainAndPoints Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods arbitrary :: Gen TestChainAndPoints # shrink :: TestChainAndPoints -> [TestChainAndPoints] #
Show TestChainAndPoints Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods showsPrec :: Int -> TestChainAndPoints -> ShowS # show :: TestChainAndPoints -> String # showList :: [TestChainAndPoints] -> ShowS #

data TestChainFork Source #

A test generator for two chains sharing a common prefix.

Constructors

TestChainFork (Chain Block) (Chain Block) (Chain Block)

Instances

Instances details

Arbitrary TestChainFork Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods arbitrary :: Gen TestChainFork # shrink :: TestChainFork -> [TestChainFork] #
Show TestChainFork Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods showsPrec :: Int -> TestChainFork -> ShowS # show :: TestChainFork -> String # showList :: [TestChainFork] -> ShowS #

data TestChainRange Source #

Constructors

TestChainRange (Point Block) (Point Block)

Instances

Instances details

Arbitrary TestChainRange Source #
Instance details Defined in Ouroboros.Network.Mock.ChainGenerators Methods arbitrary :: Gen TestChainRange # shrink :: TestChainRange -> [TestChainRange] #

Utility functions

genNonNegative :: Gen Int Source #

The NonNegative generator produces a large proportion of 0s, so we use this one instead for now.

https://github.com/nick8325/quickcheck/issues/229

genSlotGap :: Gen Int Source #

addSlotGap :: Int -> WithOrigin SlotNo -> SlotNo Source #

Special case: adding a 0-sized gap to Origin results in SlotNo 0, not Origin. We do this because we use the result of this function to create a block, and blocks must have a slot number.

genChainAnchor :: Gen (Anchor Block) Source #

A starting anchor for a chain fragment: either the AnchorGenesis or an arbitrary anchor

mkPartialBlock :: SlotNo -> BlockBody -> Block Source #

mkRollbackPoint :: HasHeader block => Chain block -> Int -> Point block Source #

Tests of the generators

tests :: TestTree Source #

Orphan instances

Arbitrary BlockNo Source #
Instance details Methods arbitrary :: Gen BlockNo # shrink :: BlockNo -> [BlockNo] #
Arbitrary Block Source #
Instance details Methods arbitrary :: Gen Block # shrink :: Block -> [Block] #
Arbitrary BlockBody Source #
Instance details Methods arbitrary :: Gen BlockBody # shrink :: BlockBody -> [BlockBody] #
Arbitrary BlockHeader Source #
Instance details Methods arbitrary :: Gen BlockHeader # shrink :: BlockHeader -> [BlockHeader] #
Arbitrary ConcreteHeaderHash Source #
Instance details Methods arbitrary :: Gen ConcreteHeaderHash # shrink :: ConcreteHeaderHash -> [ConcreteHeaderHash] #
CoArbitrary BlockNo Source #
Instance details Methods coarbitrary :: BlockNo -> Gen b -> Gen b #
CoArbitrary SlotNo Source #
Instance details Methods coarbitrary :: SlotNo -> Gen b -> Gen b #
CoArbitrary Block Source #
Instance details Methods coarbitrary :: Block -> Gen b -> Gen b #
CoArbitrary BlockBody Source #
Instance details Methods coarbitrary :: BlockBody -> Gen b -> Gen b #
CoArbitrary BlockHeader Source #
Instance details Methods coarbitrary :: BlockHeader -> Gen b -> Gen b #
CoArbitrary BodyHash Source #
Instance details Methods coarbitrary :: BodyHash -> Gen b -> Gen b #
CoArbitrary ConcreteHeaderHash Source #
Instance details Methods coarbitrary :: ConcreteHeaderHash -> Gen b -> Gen b #
Arbitrary (Point Block) Source #
Instance details Methods arbitrary :: Gen (Point Block) # shrink :: Point Block -> [Point Block] #
Arbitrary (Point BlockHeader) Source #
Instance details Methods arbitrary :: Gen (Point BlockHeader) # shrink :: Point BlockHeader -> [Point BlockHeader] #
CoArbitrary (ChainHash BlockHeader) Source #
Instance details Methods coarbitrary :: ChainHash BlockHeader -> Gen b -> Gen b #