Safe Haskell	None
Language	GHC2024

Napkin.Run.Effects.Languages.Assertion

Synopsis

data Assertion (m :: k) a where
- Assert' :: forall {k} (m :: k). AssertionGroup -> AssertionSeverity -> Text -> AssertionStatus -> Assertion m ()
newtype AssertionGroup = AssertionGroup [Text]
prettyPrintAssertionGroup :: AssertionGroup -> Text -> Text
newtype AssertionLog = AssertionLog [AssertionEntry]
hasFailedAssertions :: AssertionLog -> Bool
filterFailedAssertions :: AssertionLog -> [Text]
isFailure :: AssertionEntry -> Bool
data AssertionEntry = AssertionEntry {
- assertionGroup :: AssertionGroup
- message :: Text
- status :: AssertionStatus
- severity :: AssertionSeverity
}
data AssertionStatus
- = Success
- | Failure (Maybe Text)
pattern FailureWithMessage :: Text -> AssertionStatus
data AssertionSeverity
- = Fail
- | WarnOnly
prettyPrintAssertionEntry :: AssertionEntry -> Text
assert' :: forall (r :: EffectRow). Member (Assertion :: (Type -> Type) -> Type -> Type) r => AssertionGroup -> AssertionSeverity -> Text -> AssertionStatus -> Sem r ()
successIsTrue :: Bool -> AssertionStatus
assertTrue :: forall (r :: EffectRow). Member (Assertion :: (Type -> Type) -> Type -> Type) r => Text -> Bool -> Sem r ()
assertEquals :: forall a (r :: EffectRow). (Eq a, Member (Assertion :: (Type -> Type) -> Type -> Type) r) => Text -> a -> a -> Sem r ()
assertTrueWith :: forall (r :: EffectRow). Member (Assertion :: (Type -> Type) -> Type -> Type) r => Text -> Bool -> Text -> Sem r ()
assertTrueWithM :: forall (r :: EffectRow). Member (Assertion :: (Type -> Type) -> Type -> Type) r => Text -> Bool -> Sem r Text -> Sem r ()
assert :: forall (r :: EffectRow). Member (Assertion :: (Type -> Type) -> Type -> Type) r => Text -> AssertionStatus -> Sem r ()
assertM :: forall (r :: EffectRow). Member (Assertion :: (Type -> Type) -> Type -> Type) r => Text -> Sem r AssertionStatus -> Sem r ()
assertError :: forall (r :: EffectRow). Member (Assertion :: (Type -> Type) -> Type -> Type) r => Text -> Sem ((Error Text :: (Type -> Type) -> Type -> Type) ': r) () -> Sem r ()
failedAssertion :: forall (r :: EffectRow). Member (Assertion :: (Type -> Type) -> Type -> Type) r => Text -> Sem r ()
warnOnly :: forall (r :: EffectRow) a. Member (Assertion :: (Type -> Type) -> Type -> Type) r => Sem r a -> Sem r a
describe :: forall (r :: EffectRow) a. Members '[Assertion :: (Type -> Type) -> Type -> Type, Log :: (Type -> Type) -> Type -> Type] r => Text -> Sem r a -> Sem r a
describe' :: forall (r :: EffectRow) a. Members '[Assertion :: (Type -> Type) -> Type -> Type, Log :: (Type -> Type) -> Type -> Type] r => [Text] -> Sem r a -> Sem r a
assertionToAssertionEntry :: forall {k} (r :: k) a. Assertion r a -> AssertionEntry

Documentation

data Assertion (m :: k) a where #

Assertion effects so we can skip past them in dry runs, and optionally throw exceptions or just collect them along the way for final reporting, etc..

Constructors

Assert' :: forall {k} (m :: k). AssertionGroup -> AssertionSeverity -> Text -> AssertionStatus -> Assertion m ()

Assertions are run-time checks based on actual results that may be returned by various operations. Dry runs may ignore these failures, but they're respected in real operations.

Instances

Instances details

ToDumpItem (b :: k) (Assertion :: (Type -> Type) -> Type -> Type) #
Instance details Defined in Napkin.Run.Effects.Interceptors.LogProgram.Types Methods toDumpItem :: forall (r :: EffectRow) x. Assertion (Sem r) x -> DumpItem b #
GShow (Assertion a :: Type -> Type) #
Instance details Defined in Napkin.Run.Effects.Languages.Assertion Methods gshowsPrec :: Int -> Assertion a a0 -> ShowS #
Show (Assertion a b) #
Instance details Defined in Napkin.Run.Effects.Languages.Assertion Methods showsPrec :: Int -> Assertion a b -> ShowS # show :: Assertion a b -> String # showList :: [Assertion a b] -> ShowS #
Eq (Assertion a b) #
Instance details Defined in Napkin.Run.Effects.Languages.Assertion Methods (==) :: Assertion a b -> Assertion a b -> Bool # (/=) :: Assertion a b -> Assertion a b -> Bool #

newtype AssertionGroup #

Constructors

AssertionGroup [Text]

Instances

Instances details

Default AssertionGroup #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

Methods

def :: AssertionGroup #

Monoid AssertionGroup #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

Methods

mempty :: AssertionGroup #

mappend :: AssertionGroup -> AssertionGroup -> AssertionGroup #

mconcat :: [AssertionGroup] -> AssertionGroup #

Semigroup AssertionGroup #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

Methods

(<>) :: AssertionGroup -> AssertionGroup -> AssertionGroup #

sconcat :: NonEmpty AssertionGroup -> AssertionGroup #

stimes :: Integral b => b -> AssertionGroup -> AssertionGroup #

Generic AssertionGroup #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

Associated Types

type Rep AssertionGroup
Instance details Defined in Napkin.Run.Effects.Languages.Assertion type Rep AssertionGroup = D1 ('MetaData "AssertionGroup" "Napkin.Run.Effects.Languages.Assertion" "napkin-spec-2.0.0-7NH5JHRFo7V8BQP5NCfMo1" 'True) (C1 ('MetaCons "AssertionGroup" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))

Methods

from :: AssertionGroup -> Rep AssertionGroup x #

to :: Rep AssertionGroup x -> AssertionGroup #

Show AssertionGroup #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

Methods

showsPrec :: Int -> AssertionGroup -> ShowS #

show :: AssertionGroup -> String #

showList :: [AssertionGroup] -> ShowS #

Eq AssertionGroup #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

Methods

(==) :: AssertionGroup -> AssertionGroup -> Bool #

(/=) :: AssertionGroup -> AssertionGroup -> Bool #

type Rep AssertionGroup #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

type Rep AssertionGroup = D1 ('MetaData "AssertionGroup" "Napkin.Run.Effects.Languages.Assertion" "napkin-spec-2.0.0-7NH5JHRFo7V8BQP5NCfMo1" 'True) (C1 ('MetaCons "AssertionGroup" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text])))

prettyPrintAssertionGroup :: AssertionGroup -> Text -> Text #

newtype AssertionLog #

Constructors

AssertionLog [AssertionEntry]

Instances

Instances details

Monoid AssertionLog #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

Methods

mempty :: AssertionLog #

mappend :: AssertionLog -> AssertionLog -> AssertionLog #

mconcat :: [AssertionLog] -> AssertionLog #

Semigroup AssertionLog #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

Methods

(<>) :: AssertionLog -> AssertionLog -> AssertionLog #

sconcat :: NonEmpty AssertionLog -> AssertionLog #

stimes :: Integral b => b -> AssertionLog -> AssertionLog #

Generic AssertionLog #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

Associated Types

type Rep AssertionLog
Instance details Defined in Napkin.Run.Effects.Languages.Assertion type Rep AssertionLog = D1 ('MetaData "AssertionLog" "Napkin.Run.Effects.Languages.Assertion" "napkin-spec-2.0.0-7NH5JHRFo7V8BQP5NCfMo1" 'True) (C1 ('MetaCons "AssertionLog" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [AssertionEntry])))

Methods

from :: AssertionLog -> Rep AssertionLog x #

to :: Rep AssertionLog x -> AssertionLog #

Show AssertionLog #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

Methods

showsPrec :: Int -> AssertionLog -> ShowS #

show :: AssertionLog -> String #

showList :: [AssertionLog] -> ShowS #

Eq AssertionLog #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

Methods

(==) :: AssertionLog -> AssertionLog -> Bool #

(/=) :: AssertionLog -> AssertionLog -> Bool #

type Rep AssertionLog #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

type Rep AssertionLog = D1 ('MetaData "AssertionLog" "Napkin.Run.Effects.Languages.Assertion" "napkin-spec-2.0.0-7NH5JHRFo7V8BQP5NCfMo1" 'True) (C1 ('MetaCons "AssertionLog" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [AssertionEntry])))

hasFailedAssertions :: AssertionLog -> Bool #

filterFailedAssertions :: AssertionLog -> [Text] #

isFailure :: AssertionEntry -> Bool #

data AssertionEntry #

Constructors

AssertionEntry
Fields assertionGroup :: AssertionGroup message :: Text status :: AssertionStatus severity :: AssertionSeverity

Instances

Instances details

Generic AssertionEntry #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

Associated Types

type Rep AssertionEntry

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

type Rep AssertionEntry = D1 ('MetaData "AssertionEntry" "Napkin.Run.Effects.Languages.Assertion" "napkin-spec-2.0.0-7NH5JHRFo7V8BQP5NCfMo1" 'False) (C1 ('MetaCons "AssertionEntry" 'PrefixI 'True) ((S1 ('MetaSel ('Just "assertionGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AssertionGroup) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AssertionStatus) :*: S1 ('MetaSel ('Just "severity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AssertionSeverity))))

Methods

from :: AssertionEntry -> Rep AssertionEntry x #

to :: Rep AssertionEntry x -> AssertionEntry #

Show AssertionEntry #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

Methods

showsPrec :: Int -> AssertionEntry -> ShowS #

show :: AssertionEntry -> String #

showList :: [AssertionEntry] -> ShowS #

Eq AssertionEntry #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

Methods

(==) :: AssertionEntry -> AssertionEntry -> Bool #

(/=) :: AssertionEntry -> AssertionEntry -> Bool #

type Rep AssertionEntry #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

type Rep AssertionEntry = D1 ('MetaData "AssertionEntry" "Napkin.Run.Effects.Languages.Assertion" "napkin-spec-2.0.0-7NH5JHRFo7V8BQP5NCfMo1" 'False) (C1 ('MetaCons "AssertionEntry" 'PrefixI 'True) ((S1 ('MetaSel ('Just "assertionGroup") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AssertionGroup) :*: S1 ('MetaSel ('Just "message") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AssertionStatus) :*: S1 ('MetaSel ('Just "severity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AssertionSeverity))))

data AssertionStatus #

Constructors

Success
Failure (Maybe Text)

Instances

Instances details

ToJSON AssertionStatus #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

Methods

toJSON :: AssertionStatus -> Value #

toEncoding :: AssertionStatus -> Encoding #

toJSONList :: [AssertionStatus] -> Value #

toEncodingList :: [AssertionStatus] -> Encoding #

omitField :: AssertionStatus -> Bool #

Generic AssertionStatus #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

Associated Types

type Rep AssertionStatus

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

type Rep AssertionStatus = D1 ('MetaData "AssertionStatus" "Napkin.Run.Effects.Languages.Assertion" "napkin-spec-2.0.0-7NH5JHRFo7V8BQP5NCfMo1" 'False) (C1 ('MetaCons "Success" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Failure" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))

Methods

from :: AssertionStatus -> Rep AssertionStatus x #

to :: Rep AssertionStatus x -> AssertionStatus #

Show AssertionStatus #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

Methods

showsPrec :: Int -> AssertionStatus -> ShowS #

show :: AssertionStatus -> String #

showList :: [AssertionStatus] -> ShowS #

Eq AssertionStatus #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

Methods

(==) :: AssertionStatus -> AssertionStatus -> Bool #

(/=) :: AssertionStatus -> AssertionStatus -> Bool #

type Rep AssertionStatus #

Instance details

Defined in Napkin.Run.Effects.Languages.Assertion

type Rep AssertionStatus = D1 ('MetaData "AssertionStatus" "Napkin.Run.Effects.Languages.Assertion" "napkin-spec-2.0.0-7NH5JHRFo7V8BQP5NCfMo1" 'False) (C1 ('MetaCons "Success" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Failure" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Text))))

pattern FailureWithMessage :: Text -> AssertionStatus #

data AssertionSeverity #

Constructors

Fail
WarnOnly

Instances

Instances details

Show AssertionSeverity #
Instance details Defined in Napkin.Run.Effects.Languages.Assertion Methods showsPrec :: Int -> AssertionSeverity -> ShowS # show :: AssertionSeverity -> String # showList :: [AssertionSeverity] -> ShowS #
Eq AssertionSeverity #
Instance details Defined in Napkin.Run.Effects.Languages.Assertion Methods (==) :: AssertionSeverity -> AssertionSeverity -> Bool # (/=) :: AssertionSeverity -> AssertionSeverity -> Bool #

prettyPrintAssertionEntry :: AssertionEntry -> Text #

assert' :: forall (r :: EffectRow). Member (Assertion :: (Type -> Type) -> Type -> Type) r => AssertionGroup -> AssertionSeverity -> Text -> AssertionStatus -> Sem r () #

Assertions are run-time checks based on actual results that may be returned by various operations. Dry runs may ignore these failures, but they're respected in real operations.

successIsTrue :: Bool -> AssertionStatus #

assertTrue :: forall (r :: EffectRow). Member (Assertion :: (Type -> Type) -> Type -> Type) r => Text -> Bool -> Sem r () #

assertEquals :: forall a (r :: EffectRow). (Eq a, Member (Assertion :: (Type -> Type) -> Type -> Type) r) => Text -> a -> a -> Sem r () #

assertTrueWith :: forall (r :: EffectRow). Member (Assertion :: (Type -> Type) -> Type -> Type) r => Text -> Bool -> Text -> Sem r () #

assertTrueWithM :: forall (r :: EffectRow). Member (Assertion :: (Type -> Type) -> Type -> Type) r => Text -> Bool -> Sem r Text -> Sem r () #

assert :: forall (r :: EffectRow). Member (Assertion :: (Type -> Type) -> Type -> Type) r => Text -> AssertionStatus -> Sem r () #

assertM :: forall (r :: EffectRow). Member (Assertion :: (Type -> Type) -> Type -> Type) r => Text -> Sem r AssertionStatus -> Sem r () #

assertError :: forall (r :: EffectRow). Member (Assertion :: (Type -> Type) -> Type -> Type) r => Text -> Sem ((Error Text :: (Type -> Type) -> Type -> Type) ': r) () -> Sem r () #

failedAssertion :: forall (r :: EffectRow). Member (Assertion :: (Type -> Type) -> Type -> Type) r => Text -> Sem r () #

warnOnly :: forall (r :: EffectRow) a. Member (Assertion :: (Type -> Type) -> Type -> Type) r => Sem r a -> Sem r a #

describe :: forall (r :: EffectRow) a. Members '[Assertion :: (Type -> Type) -> Type -> Type, Log :: (Type -> Type) -> Type -> Type] r => Text -> Sem r a -> Sem r a #

describe' :: forall (r :: EffectRow) a. Members '[Assertion :: (Type -> Type) -> Type -> Type, Log :: (Type -> Type) -> Type -> Type] r => [Text] -> Sem r a -> Sem r a #

assertionToAssertionEntry :: forall {k} (r :: k) a. Assertion r a -> AssertionEntry #