Safe Haskell	None
Language	Haskell2010

Plutus.Contract.Test.Certification.Run

Contents

A certification report holds all the necessary information
There are a tonne of lenses
and we have a function for running certification
Orphan instances

Synopsis

data CertificationReport m
certResJSON :: CertificationReport m -> String
certRes_standardPropertyResult :: forall m m. Lens ( CertificationReport m) ( CertificationReport m) Result Result
certRes_noLockedFundsResult :: forall m m. Lens ( CertificationReport m) ( CertificationReport m) ( Maybe Result ) ( Maybe Result )
certRes_noLockedFundsLightResult :: forall m m. Lens ( CertificationReport m) ( CertificationReport m) ( Maybe Result ) ( Maybe Result )
certRes_standardCrashToleranceResult :: forall m m. Lens ( CertificationReport m) ( CertificationReport m) ( Maybe Result ) ( Maybe Result )
certRes_unitTestResults :: forall m m. Lens ( CertificationReport m) ( CertificationReport m) [ Result ] [ Result ]
certRes_coverageReport :: forall m m. Lens ( CertificationReport m) ( CertificationReport m) CoverageReport CoverageReport
certRes_whitelistOk :: forall m m. Lens ( CertificationReport m) ( CertificationReport m) ( Maybe Bool ) ( Maybe Bool )
certRes_whitelistResult :: forall m m. Lens ( CertificationReport m) ( CertificationReport m) ( Maybe Result ) ( Maybe Result )
certRes_DLTests :: forall m m. Lens ( CertificationReport m) ( CertificationReport m) [( String , Result )] [( String , Result )]
data CertificationOptions = CertificationOptions {
- certOptNumTests :: Int
- certOptOutput :: Bool
- certEventChannel :: Maybe ( Chan CertificationEvent )
}
data CertificationEvent
- = QuickCheckTestEvent ( Maybe Bool )
- | QuickCheckNumTestsEvent Int
- | StartCertificationTask CertificationTask
- | FinishedTask Bool
- | CertificationDone
data CertificationTask
- = UnitTestsTask
- | StandardPropertyTask
- | NoLockedFundsTask
- | NoLockedFundsLightTask
- | CrashToleranceTask
- | WhitelistTask
- | DLTestsTask
certificationTasks :: Certification m -> [ CertificationTask ]
hasQuickCheckTests :: CertificationTask -> Bool
defaultCertificationOptions :: CertificationOptions
certify :: forall m. ContractModel m => Certification m -> IO ( CertificationReport m)
certifyWithOptions :: forall m. ContractModel m => CertificationOptions -> Certification m -> IO ( CertificationReport m)

A certification report holds all the necessary information

data CertificationReport m Source #

Instances

Instances details

Show ( CertificationReport m) Source #
Instance details Defined in Plutus.Contract.Test.Certification.Run Methods showsPrec :: Int -> CertificationReport m -> ShowS Source # show :: CertificationReport m -> String Source # showList :: [ CertificationReport m] -> ShowS Source #
Generic ( CertificationReport m) Source #
Instance details Defined in Plutus.Contract.Test.Certification.Run Associated Types type Rep ( CertificationReport m) :: Type -> Type Source # Methods from :: CertificationReport m -> Rep ( CertificationReport m) x Source # to :: Rep ( CertificationReport m) x -> CertificationReport m Source #
ToJSON ( CertificationReport m) Source #
Instance details Defined in Plutus.Contract.Test.Certification.Run Methods toJSON :: CertificationReport m -> Value Source # toEncoding :: CertificationReport m -> Encoding Source # toJSONList :: [ CertificationReport m] -> Value Source # toEncodingList :: [ CertificationReport m] -> Encoding Source #
type Rep ( CertificationReport m) Source #
Instance details Defined in Plutus.Contract.Test.Certification.Run type Rep ( CertificationReport m) = D1 (' MetaData "CertificationReport" "Plutus.Contract.Test.Certification.Run" "plutus-contract-certification-1.2.0.0-9kb87hRqXUeFFdqF5ROmcx" ' False ) ( C1 (' MetaCons "CertificationReport" ' PrefixI ' True ) ((( S1 (' MetaSel (' Just "_certRes_standardPropertyResult") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 Result ) :: S1 (' MetaSel (' Just "_certRes_noLockedFundsResult") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe Result ))) :: ( S1 (' MetaSel (' Just "_certRes_noLockedFundsLightResult") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe Result )) :: S1 (' MetaSel (' Just "_certRes_standardCrashToleranceResult") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe Result )))) :: (( S1 (' MetaSel (' Just "_certRes_unitTestResults") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 [ Result ]) :: S1 (' MetaSel (' Just "_certRes_coverageReport") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 CoverageReport )) :: ( S1 (' MetaSel (' Just "_certRes_whitelistOk") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe Bool )) :: ( S1 (' MetaSel (' Just "_certRes_whitelistResult") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 ( Maybe Result )) :: S1 (' MetaSel (' Just "_certRes_DLTests") ' NoSourceUnpackedness ' NoSourceStrictness ' DecidedLazy ) ( Rec0 [( String , Result )]))))))

certResJSON :: CertificationReport m -> String Source #

There are a tonne of lenses

certRes_standardPropertyResult :: forall m m. Lens ( CertificationReport m) ( CertificationReport m) Result Result Source #

certRes_noLockedFundsResult :: forall m m. Lens ( CertificationReport m) ( CertificationReport m) ( Maybe Result ) ( Maybe Result ) Source #

certRes_noLockedFundsLightResult :: forall m m. Lens ( CertificationReport m) ( CertificationReport m) ( Maybe Result ) ( Maybe Result ) Source #

certRes_standardCrashToleranceResult :: forall m m. Lens ( CertificationReport m) ( CertificationReport m) ( Maybe Result ) ( Maybe Result ) Source #

certRes_unitTestResults :: forall m m. Lens ( CertificationReport m) ( CertificationReport m) [ Result ] [ Result ] Source #

certRes_coverageReport :: forall m m. Lens ( CertificationReport m) ( CertificationReport m) CoverageReport CoverageReport Source #

certRes_whitelistOk :: forall m m. Lens ( CertificationReport m) ( CertificationReport m) ( Maybe Bool ) ( Maybe Bool ) Source #

certRes_whitelistResult :: forall m m. Lens ( CertificationReport m) ( CertificationReport m) ( Maybe Result ) ( Maybe Result ) Source #

certRes_DLTests :: forall m m. Lens ( CertificationReport m) ( CertificationReport m) [( String , Result )] [( String , Result )] Source #

and we have a function for running certification

data CertificationOptions Source #

Constructors

CertificationOptions
Fields certOptNumTests :: Int certOptOutput :: Bool certEventChannel :: Maybe ( Chan CertificationEvent )

data CertificationEvent Source #

Constructors

QuickCheckTestEvent ( Maybe Bool )	Nothing if discarded, otherwise test result
QuickCheckNumTestsEvent Int
StartCertificationTask CertificationTask
FinishedTask Bool
CertificationDone

Instances

Instances details

Eq CertificationEvent Source #
Instance details Defined in Plutus.Contract.Test.Certification.Run Methods (==) :: CertificationEvent -> CertificationEvent -> Bool Source # (/=) :: CertificationEvent -> CertificationEvent -> Bool Source #
Show CertificationEvent Source #
Instance details Defined in Plutus.Contract.Test.Certification.Run Methods showsPrec :: Int -> CertificationEvent -> ShowS Source # show :: CertificationEvent -> String Source # showList :: [ CertificationEvent ] -> ShowS Source #

data CertificationTask Source #

Constructors

UnitTestsTask
StandardPropertyTask
NoLockedFundsTask	DoubleSatisfactionTask
NoLockedFundsLightTask
CrashToleranceTask
WhitelistTask
DLTestsTask

Instances

Instances details

Bounded CertificationTask Source #
Instance details Defined in Plutus.Contract.Test.Certification.Run Methods minBound :: CertificationTask Source # maxBound :: CertificationTask Source #
Enum CertificationTask Source #
Instance details Defined in Plutus.Contract.Test.Certification.Run Methods succ :: CertificationTask -> CertificationTask Source # pred :: CertificationTask -> CertificationTask Source # toEnum :: Int -> CertificationTask Source # fromEnum :: CertificationTask -> Int Source # enumFrom :: CertificationTask -> [ CertificationTask ] Source # enumFromThen :: CertificationTask -> CertificationTask -> [ CertificationTask ] Source # enumFromTo :: CertificationTask -> CertificationTask -> [ CertificationTask ] Source # enumFromThenTo :: CertificationTask -> CertificationTask -> CertificationTask -> [ CertificationTask ] Source #
Eq CertificationTask Source #
Instance details Defined in Plutus.Contract.Test.Certification.Run Methods (==) :: CertificationTask -> CertificationTask -> Bool Source # (/=) :: CertificationTask -> CertificationTask -> Bool Source #
Ord CertificationTask Source #
Instance details Defined in Plutus.Contract.Test.Certification.Run Methods compare :: CertificationTask -> CertificationTask -> Ordering Source # (<) :: CertificationTask -> CertificationTask -> Bool Source # (<=) :: CertificationTask -> CertificationTask -> Bool Source # (>) :: CertificationTask -> CertificationTask -> Bool Source # (>=) :: CertificationTask -> CertificationTask -> Bool Source # max :: CertificationTask -> CertificationTask -> CertificationTask Source # min :: CertificationTask -> CertificationTask -> CertificationTask Source #
Show CertificationTask Source #
Instance details Defined in Plutus.Contract.Test.Certification.Run Methods showsPrec :: Int -> CertificationTask -> ShowS Source # show :: CertificationTask -> String Source # showList :: [ CertificationTask ] -> ShowS Source #

certificationTasks :: Certification m -> [ CertificationTask ] Source #

The list of certification tasks that will be run for a given certification object.

hasQuickCheckTests :: CertificationTask -> Bool Source #

defaultCertificationOptions :: CertificationOptions Source #

certify :: forall m. ContractModel m => Certification m -> IO ( CertificationReport m) Source #

certifyWithOptions :: forall m. ContractModel m => CertificationOptions -> Certification m -> IO ( CertificationReport m) Source #

Orphan instances

Generic Result Source #
Instance details Associated Types type Rep Result :: Type -> Type Source # Methods from :: Result -> Rep Result x Source # to :: Rep Result x -> Result Source #
Generic FailureReason Source #
Instance details Associated Types type Rep FailureReason :: Type -> Type Source # Methods from :: FailureReason -> Rep FailureReason x Source # to :: Rep FailureReason x -> FailureReason Source #
ToJSON SMGen Source #
Instance details Methods toJSON :: SMGen -> Value Source # toEncoding :: SMGen -> Encoding Source # toJSONList :: [ SMGen ] -> Value Source # toEncodingList :: [ SMGen ] -> Encoding Source #
ToJSON QCGen Source #
Instance details Methods toJSON :: QCGen -> Value Source # toEncoding :: QCGen -> Encoding Source # toJSONList :: [QCGen] -> Value Source # toEncodingList :: [QCGen] -> Encoding Source #
ToJSON Result Source #
Instance details Methods toJSON :: Result -> Value Source # toEncoding :: Result -> Encoding Source # toJSONList :: [ Result ] -> Value Source # toEncodingList :: [ Result ] -> Encoding Source #
ToJSON SomeException Source #
Instance details Methods toJSON :: SomeException -> Value Source # toEncoding :: SomeException -> Encoding Source # toJSONList :: [ SomeException ] -> Value Source # toEncodingList :: [ SomeException ] -> Encoding Source #
ToJSON FailureReason Source #
Instance details Methods toJSON :: FailureReason -> Value Source # toEncoding :: FailureReason -> Encoding Source # toJSONList :: [ FailureReason ] -> Value Source # toEncodingList :: [ FailureReason ] -> Encoding Source #
ToJSON Outcome Source #
Instance details Methods toJSON :: Outcome -> Value Source # toEncoding :: Outcome -> Encoding Source # toJSONList :: [ Outcome ] -> Value Source # toEncodingList :: [ Outcome ] -> Encoding Source #
ToJSON Result Source #
Instance details Methods toJSON :: Result -> Value Source # toEncoding :: Result -> Encoding Source # toJSONList :: [ Result ] -> Value Source # toEncodingList :: [ Result ] -> Encoding Source #
FromJSON SMGen Source #
Instance details Methods parseJSON :: Value -> Parser SMGen Source # parseJSONList :: Value -> Parser [ SMGen ] Source #
FromJSON QCGen Source #
Instance details Methods parseJSON :: Value -> Parser QCGen Source # parseJSONList :: Value -> Parser [QCGen] Source #
FromJSON Result Source #
Instance details Methods parseJSON :: Value -> Parser Result Source # parseJSONList :: Value -> Parser [ Result ] Source #
FromJSON SomeException Source #
Instance details Methods parseJSON :: Value -> Parser SomeException Source # parseJSONList :: Value -> Parser [ SomeException ] Source #