Safe Haskell	None
Language	GHC2021

Skeletest.Internal.Snapshot

Contents

Running snapshot
Rendering
- SnapshotFile
Infrastructure

Synopsis

data SnapshotContext = SnapshotContext {
- snapshotRenderers :: [SnapshotRenderer]
- snapshotTestInfo :: TestInfo
- snapshotIndex :: Int
}
data SnapshotResult
- = SnapshotMissing
- | SnapshotMatches
- | SnapshotDiff {
  - snapshotContent :: Text
  - renderedTestResult :: Text
  }
updateSnapshot :: (Typeable a, MonadIO m) => SnapshotContext -> a -> m ()
checkSnapshot :: (Typeable a, MonadIO m) => SnapshotContext -> a -> m SnapshotResult
data SnapshotRenderer = Typeable a => SnapshotRenderer {
- render :: a -> Text
- snapshotLang :: Maybe Text
}
defaultSnapshotRenderers :: [SnapshotRenderer]
setSnapshotRenderers :: [SnapshotRenderer] -> IO ()
getSnapshotRenderers :: MonadIO m => m [SnapshotRenderer]
plainRenderer :: Typeable a => (a -> Text) -> SnapshotRenderer
renderWithShow :: (Typeable a, Show a) => SnapshotRenderer
data SnapshotFile = SnapshotFile {
- moduleName :: Text
- snapshots :: Map TestIdentifier [SnapshotValue]
}
data SnapshotValue = SnapshotValue {
- snapshotContent :: Text
- snapshotLang :: Maybe Text
}
decodeSnapshotFile :: Text -> Maybe SnapshotFile
encodeSnapshotFile :: SnapshotFile -> Text
normalizeSnapshotFile :: SnapshotFile -> SnapshotFile
getAndIncSnapshotIndex :: MonadIO m => m Int
newtype SnapshotUpdateFlag = SnapshotUpdateFlag Bool

Running snapshot

data SnapshotContext Source #

Constructors

SnapshotContext
Fields snapshotRenderers :: [SnapshotRenderer] snapshotTestInfo :: TestInfo snapshotIndex :: Int

data SnapshotResult Source #

Constructors

SnapshotMissing
SnapshotMatches
SnapshotDiff
Fields snapshotContent :: Text renderedTestResult :: Text

Instances

Instances details

Show SnapshotResult Source #
Instance details Defined in Skeletest.Internal.Snapshot Methods showsPrec :: Int -> SnapshotResult -> ShowS # show :: SnapshotResult -> String # showList :: [SnapshotResult] -> ShowS #
Eq SnapshotResult Source #
Instance details Defined in Skeletest.Internal.Snapshot Methods (==) :: SnapshotResult -> SnapshotResult -> Bool # (/=) :: SnapshotResult -> SnapshotResult -> Bool #

updateSnapshot :: (Typeable a, MonadIO m) => SnapshotContext -> a -> m () Source #

checkSnapshot :: (Typeable a, MonadIO m) => SnapshotContext -> a -> m SnapshotResult Source #

Rendering

data SnapshotRenderer Source #

Constructors

Typeable a => SnapshotRenderer
Fields render :: a -> Text snapshotLang :: Maybe Text

defaultSnapshotRenderers :: [SnapshotRenderer] Source #

setSnapshotRenderers :: [SnapshotRenderer] -> IO () Source #

getSnapshotRenderers :: MonadIO m => m [SnapshotRenderer] Source #

plainRenderer :: Typeable a => (a -> Text) -> SnapshotRenderer Source #

renderWithShow :: (Typeable a, Show a) => SnapshotRenderer Source #

SnapshotFile

data SnapshotFile Source #

Constructors

SnapshotFile
Fields moduleName :: Text snapshots :: Map TestIdentifier [SnapshotValue] full test identifier => snapshots e.g. ["group1", "group2", "returns val1 and val2"] => ["val1", "val2"]

Instances

Instances details

Show SnapshotFile Source #
Instance details Defined in Skeletest.Internal.Snapshot Methods showsPrec :: Int -> SnapshotFile -> ShowS # show :: SnapshotFile -> String # showList :: [SnapshotFile] -> ShowS #
Eq SnapshotFile Source #
Instance details Defined in Skeletest.Internal.Snapshot Methods (==) :: SnapshotFile -> SnapshotFile -> Bool # (/=) :: SnapshotFile -> SnapshotFile -> Bool #

data SnapshotValue Source #

Constructors

SnapshotValue
Fields snapshotContent :: Text snapshotLang :: Maybe Text

Instances

Instances details

Show SnapshotValue Source #
Instance details Defined in Skeletest.Internal.Snapshot Methods showsPrec :: Int -> SnapshotValue -> ShowS # show :: SnapshotValue -> String # showList :: [SnapshotValue] -> ShowS #
Eq SnapshotValue Source #
Instance details Defined in Skeletest.Internal.Snapshot Methods (==) :: SnapshotValue -> SnapshotValue -> Bool # (/=) :: SnapshotValue -> SnapshotValue -> Bool #

decodeSnapshotFile :: Text -> Maybe SnapshotFile Source #

encodeSnapshotFile :: SnapshotFile -> Text Source #

normalizeSnapshotFile :: SnapshotFile -> SnapshotFile Source #

Infrastructure

getAndIncSnapshotIndex :: MonadIO m => m Int Source #

newtype SnapshotUpdateFlag Source #

Constructors

SnapshotUpdateFlag Bool

Instances

Instances details

IsFlag SnapshotUpdateFlag Source #
Instance details Defined in Skeletest.Internal.Snapshot Methods flagName :: String Source # flagShort :: Maybe Char Source # flagMetaVar :: String Source # flagHelp :: String Source # flagSpec :: FlagSpec SnapshotUpdateFlag Source #