Safe Haskell	None
Language	Haskell2010

Test.Ouroboros.Network.TxSubmission.SizedBytes

Description

Values with a CBOR encoding of an exact, chosen size, for testing size limits of codecs, and TxSubmission2 messages built from them within given size bounds.

Synopsis

tests :: TestTree
newtype SizedBytes = SizedBytes {
- size :: Word
}
codec_sized :: forall (m :: Type -> Type). MonadST m => Codec (TxSubmission2 SizedBytes SizedBytes) DeserialiseFailure m ByteString
data TxSubmission2Bounds = TxSubmission2Bounds {
- tbMaxNumTxIds :: Word16
- tbMaxTxIdSize :: Word
- tbMaxTxSize :: Word
- tbMaxTxsSize :: Word
}
genBoundedMessage :: TxSubmission2Bounds -> Gen (AnyMessage (TxSubmission2 SizedBytes SizedBytes))
shrinkBoundedMessage :: AnyMessage (TxSubmission2 SizedBytes SizedBytes) -> [AnyMessage (TxSubmission2 SizedBytes SizedBytes)]
withinBounds :: TxSubmission2Bounds -> AnyMessage (TxSubmission2 SizedBytes SizedBytes) -> Bool

Documentation

tests :: TestTree Source #

newtype SizedBytes Source #

A value represented only by the size of its CBOR encoding, which is a byte string of exactly that many bytes. It can stand in for any encoded value, to build encodings of a chosen size.

Constructors

SizedBytes
Fields size :: Word

Instances

Instances details

Arbitrary SizedBytes Source #	Sizes of each width of the CBOR length header, and the sizes at which the width changes.
Instance details Defined in Test.Ouroboros.Network.TxSubmission.SizedBytes Methods arbitrary :: Gen SizedBytes # shrink :: SizedBytes -> [SizedBytes] #
Show SizedBytes Source #
Instance details Defined in Test.Ouroboros.Network.TxSubmission.SizedBytes Methods showsPrec :: Int -> SizedBytes -> ShowS # show :: SizedBytes -> String # showList :: [SizedBytes] -> ShowS #
Eq SizedBytes Source #
Instance details Defined in Test.Ouroboros.Network.TxSubmission.SizedBytes Methods (==) :: SizedBytes -> SizedBytes -> Bool # (/=) :: SizedBytes -> SizedBytes -> Bool #

codec_sized :: forall (m :: Type -> Type). MonadST m => Codec (TxSubmission2 SizedBytes SizedBytes) DeserialiseFailure m ByteString Source #

data TxSubmission2Bounds Source #

Bounds on the messages generated by genBoundedMessage. Sizes are sizes of CBOR encodings.

Constructors

TxSubmission2Bounds
Fields tbMaxNumTxIds :: Word16 maximal number of txids in a message, and of txs in a `MsgReplyTxs` tbMaxTxIdSize :: Word maximal size of a txid tbMaxTxSize :: Word maximal size of a tx, which is sent on its own in a `MsgReplyTxs` tbMaxTxsSize :: Word maximal total size of the txs in a `MsgReplyTxs`, unless it carries a single tx

Instances

Instances details

Show TxSubmission2Bounds Source #
Instance details Defined in Test.Ouroboros.Network.TxSubmission.SizedBytes Methods showsPrec :: Int -> TxSubmission2Bounds -> ShowS # show :: TxSubmission2Bounds -> String # showList :: [TxSubmission2Bounds] -> ShowS #

genBoundedMessage :: TxSubmission2Bounds -> Gen (AnyMessage (TxSubmission2 SizedBytes SizedBytes)) Source #

Generate any message within the given bounds. Counts and sizes are biased towards the bounds.

shrinkBoundedMessage :: AnyMessage (TxSubmission2 SizedBytes SizedBytes) -> [AnyMessage (TxSubmission2 SizedBytes SizedBytes)] Source #

Shrink a message, keeping its constructor. Fewer txids or txs, and smaller sizes and counts, keep a message within the bounds it was generated in (see withinBounds).

withinBounds :: TxSubmission2Bounds -> AnyMessage (TxSubmission2 SizedBytes SizedBytes) -> Bool Source #

Whether a message is within the given bounds; every message generated by genBoundedMessage is.