Skip to content

HORIZON HASKELL Docs lts/ghc-9.14.xd82dee82026-10-12Search names, modules, packages, or :: a typeCtrl K

GHC 9.14.1 · lts/ghc-9.14.x · d82dee8 · 2026-10-12

Modulecardano-prelude-test-0.1.0.5Haskell2010

Test.Cardano.Prelude

1 type
2 classes
56 values

Packagecardano-prelude-test-0.1.0.5
Exports59
LanguageHaskell2010
LicenceMIT
SourceBase16.hs

valuedecodeBase16 :: ByteString -> Maybe ByteString

Decode a given ByteString which was originally encoded using encode or encodeWithIndex.

valueencodeBase16 :: ByteString -> ByteString

Encodes a given ByteString to base-16 and line wraps every 16 bytes.

valueencodeWithIndex :: ByteString -> ByteString

Encodes a given ByteString to base-16 and displays it alongside its byte offset (line wrapped every 16 bytes).

valuegen32Bytes :: Gen ByteString

valuegenBytes :: Int -> Gen ByteString

valuegenNatural :: Gen Natural

valuegenNominalDiffTime :: Gen NominalDiffTime

valuegenUTF8Byte :: Gen ByteString

valuegenWord16 :: Gen Word16

valuegenWord32 :: Gen Word32

valuediscoverGolden :: TExpQ Group

valueeachOf

:: (Show a, HasCallStack)
=> TestLimit
-> Gen a
-> a -> PropertyT IO ()
-> Property

Check that eachOf testLimit generated things hasProperty

valuegetText :: Int -> Int -> Text

valuegoldenTestCanonicalJSONDec

:: (Eq a, FromJSON (Either SchemaError) a, HasCallStack, Show a)
=> a
-> FilePath
-> Property

Check that Canonical JSON decodes to the datatype

valuegoldenTestJSON

:: (Eq a, FromJSON a, HasCallStack, Show a, ToJSON a)
=> a
-> FilePath
-> Property

valuegoldenTestJSONDec

:: (Eq a, FromJSON a, HasCallStack, Show a)
=> a
-> FilePath
-> Property

Only check that the datatype equals the decoding of the file

valuegoldenTestJSONPretty

:: (Eq a, FromJSON a, HasCallStack, Show a, ToJSON a)
=> a
-> FilePath
-> Property

valueassertIsJust :: (HasCallStack, MonadTest m) => Maybe a -> m ()

valueassertIsLeftConstr

:: (Buildable b, Data a, HasCallStack, MonadTest m)
=> Constr
-> Either a b
-> m ()

valueassertIsNothing

:: (Buildable a, HasCallStack, MonadTest m)
=> Maybe a
-> m ()

valueassertIsRight

:: (Buildable a, HasCallStack, MonadTest m)
=> Either a b
-> m ()

valuecompareValueRight

:: (Buildable a, Eq b, HasCallStack, MonadTest m, Show b)
=> b
-> Either a b
-> m ()

valuearbitrarySizedS :: Int -> Gen ByteString

Make arbitrary ByteString of given length.

valuearbitrarySizedSL :: Int -> Gen ByteString

Make arbitrary ByteString.Lazy of given length.

valuemakeSmall :: Gen a -> Gen a

valuerunGen :: Gen a -> a

Get something out of a quickcheck Gen without having to do IO

valuesublistN :: Int -> [a] -> Gen [a]

Choose a random (shuffled) subset of length n. Throws an error if there's not enough elements.

value(.=.) :: (Eq b, Show b) => (a -> b) -> (a -> b) -> a -> Property

Extensional equality combinator. Useful to express function properties as functional equations.

value(>=.) :: (Show (m b), Eq (m b)) => (a -> m b) -> (a -> m b) -> a -> Property

Monadic extensional equality combinator.

valueassertProperty :: Monad m => Bool -> Text -> PropertyM m ()

Call stopProperty if boolean value is false.

valueexpectationError :: Text -> Expectation

valueexpectedOne :: Monad m => Text -> [a] -> PropertyM m a

valueformsCommutativeMonoid

:: (Show m, Eq m, Semigroup m, Monoid m)
=> m
-> m
-> m
-> Property

valueformsMonoid

:: (Show m, Eq m, Semigroup m, Monoid m)
=> m
-> m
-> m
-> Property

valueformsSemigroup :: (Show m, Eq m, Semigroup m) => m -> m -> m -> Property

valuemaybeStopProperty :: Monad m => Text -> Maybe a -> PropertyM m a

Use stopProperty if the value is Nothing or return something it the value is Just.

valueqcElem :: (Show a, Eq a, Show (t a), Foldable t) => a -> t a -> Property

valueqcFail :: Text -> Property

A property that is always false

valueqcIsJust :: Maybe a -> Property

valueqcIsLeft :: Show b => Either a b -> Property

valueqcIsNothing :: Show a => Maybe a -> Property

valueqcIsRight :: Show a => Either a b -> Property

valueqcNotElem :: (Show a, Eq a, Show (t a), Foldable t) => a -> t a -> Property

valueshouldThrowException

:: Exception e
=> a -> b
-> Selector e
-> a
-> Expectation

valuesplitIntoChunks :: Monad m => Word -> [a] -> PropertyM m [NonEmpty a]

Split given list into chunks with size up to given value. TODO: consider using `sumEquals maxSize (length items)`

valuesplitWord :: Word64 -> Word64 -> Gen [Word64]

Split given integer total into parts parts TODO: improve naming!

valuestopProperty :: Monad m => Text -> PropertyM m a

Stop PropertyM execution with given reason. The property will fail.

valuesumEquals :: Word64 -> Word64 -> Gen [Word64]

Generate list of arbitrary positive integers which sum equals given sum. All elements in the list will be smaller or equal then first parameter

valuediscoverPropArg :: TExpQ (a -> Group)

valuediscoverRoundTrip :: TExpQ Group

valuediscoverRoundTripArg :: TExpQ (a -> Group)

valueroundTripsAesonBuildable

:: (Eq a, MonadTest m, ToJSON a, FromJSON a, Buildable a)
=> a
-> m ()

Round trip any a with both ToJSON and FromJSON instances.

valueroundTripsAesonShow

:: (Eq a, MonadTest m, ToJSON a, FromJSON a, Show a)
=> a
-> m ()

valueroundTripsCanonicalJsonPretty

:: (Eq a, Show a, MonadTest m, ToJSON Identity a, FromJSON (Either SchemaError) a)
=> a
-> m ()

Pretty round trip any a with both ToJSON and FromJSON canonical instances.

valuerunTests :: [IO Bool] -> IO ()

valuetrippingBuildable

:: (HasCallStack, Buildable (f a), Eq (f a), Show b, Applicative f, MonadTest m)
=> a
-> a -> b
-> b -> f a
-> m ()

Round trip using given encode and decode functions for types with a Buildable instance

classclass ArbitraryUnsafe a where

ArbitraryUnsafe class ~~~~~~~~~~~~~~~~~~~~~~~~

This class is the same as Arbitrary, except instances of this class for stuff like public/secret keys, VSS shares, commitments etc. are designed not to mimic real data as presisely as possible (using OpenSSL random), but rather to be simple and efficient.

This is especially useful for benchmarking.

Note: we don't need Generic to derive instances of ArbitraryUnsafe. We can either use one-line instance declaration, or -XStandaloneDeriving or -XDeriveAnyClass to write something like deriving (Arbitrary, ArbitraryUnsafe).

Methods

arbitraryUnsafe :: Gen a

Instances7ArbitraryUnsafe, …

ArbitraryUnsafe ByteStringDefined in cardano-prelude-test-0.1.0.5 · Test.Cardano.Prelude.QuickCheck.Arbitrary
ArbitraryUnsafe Word16Defined in cardano-prelude-test-0.1.0.5 · Test.Cardano.Prelude.QuickCheck.Arbitrary
ArbitraryUnsafe Word32Defined in cardano-prelude-test-0.1.0.5 · Test.Cardano.Prelude.QuickCheck.Arbitrary
ArbitraryUnsafe Word64Defined in cardano-prelude-test-0.1.0.5 · Test.Cardano.Prelude.QuickCheck.Arbitrary
ArbitraryUnsafe a => ArbitraryUnsafe (NonEmpty a)Defined in cardano-prelude-test-0.1.0.5 · Test.Cardano.Prelude.QuickCheck.Arbitrary
ArbitraryUnsafe a => ArbitraryUnsafe [a]Defined in cardano-prelude-test-0.1.0.5 · Test.Cardano.Prelude.QuickCheck.Arbitrary
(ArbitraryUnsafe a, ArbitraryUnsafe b) => ArbitraryUnsafe (a, b)Defined in cardano-prelude-test-0.1.0.5 · Test.Cardano.Prelude.QuickCheck.Arbitrary

classclass Nonrepeating a where

Type for generating list of unique (nonrepeating) elemets.

Methods

nonrepeating :: Int -> Gen [a]

newtypenewtype SmallGenerator a

Constructors

SmallGenerator
- getSmallGenerator :: a

Instances3Eq, Show, Arbitrary

Eq a => Eq (SmallGenerator a)Defined in cardano-prelude-test-0.1.0.5 · Test.Cardano.Prelude.QuickCheck.Arbitrary
Show a => Show (SmallGenerator a)Defined in cardano-prelude-test-0.1.0.5 · Test.Cardano.Prelude.QuickCheck.Arbitrary
Arbitrary a => Arbitrary (SmallGenerator a)Defined in cardano-prelude-test-0.1.0.5 · Test.Cardano.Prelude.QuickCheck.Arbitrary