Safe Haskell	Safe-Inferred
Language	GHC2021

Napkin.Spec.Yaml.Interpret

Synopsis

newtype YamlParseError = YamlParseError Text
type LoadYamlConstraint backend = (SpecBackend backend, Default (DbBackendOptions backend), Show (DbBackendOptions backend), FromJSON (DbBackendOptions backend), Eq (BackendTableMeta backend), Show (BackendTableMeta backend), RunBackendEffect backend, RunBackendConn backend, DumpBackendRequirements backend, HasBackendQueryStats backend, BackendMetaConstraints backend, SqlConcat backend)
type CliAction m a = forall b. LoadYamlConstraint b => b -> YamlSpec b -> Value -> m a
loadYamlFile :: forall m a. MonadIO m => SpecFilesWithOverrides -> CliAction m a -> m (Either NapkinError a)
loadYamlFile' :: forall m a. (MonadError NapkinError m, MonadIO m) => SpecFilesWithOverrides -> CliAction m a -> m a
loadYaml' :: forall m a. Monad m => Value -> Maybe Patch -> CliAction m a -> m (Either Text a)
loadHaskellModules :: forall bk m. (ToDbBackend bk, Typeable bk, MonadIO m) => InterpreterInstance -> YamlSpec bk -> m (Either HaskellEvaluationError ())
interpretTables :: forall bk m. (ToDbBackend bk, Typeable bk, MonadIO m) => InterpreterInstance -> YamlSpec bk -> ExceptT HaskellEvaluationError m (SpecProgramArguments, Spec bk ())
interpretHaskellSpec :: forall bk. (ToDbBackend bk, Typeable bk) => InterpreterInstance -> YamlSpec bk -> ExceptT HaskellEvaluationError (Spec bk) ()
interpretYamlToSpec :: forall b m. (MonadIO m, ReifiesBackend b, ToDbBackend b, Typeable b) => LogEnv -> RuntimeEnv -> YamlSpec b -> SpecMetaArgs -> ExceptT NapkinError m (RawInterpretedSpec b)
interpretYamlToSpec' :: forall b m. (MonadIO m, ToDbBackend b, Typeable b) => LogEnv -> RuntimeEnv -> YamlSpec b -> SpecMetaArgs -> ExceptT YamlSpecInterpretError m (RawInterpretedSpec b)
interpretTable :: forall bk m. (MonadIO m, Typeable bk) => InterpreterInstance -> SpecTableName -> YamlTableSpec bk -> ExceptT HaskellEvaluationError m (SpecProgramArguments, Spec bk ())
interpretSpec :: forall b. Typeable b => InterpreterInstance -> Typed (Spec b ()) ModuleFunction -> ExceptT HaskellEvaluationError (Spec b) ()
evalHsFun :: forall m b. (Typeable b, MonadIO m) => InterpreterInstance -> Typed b ModuleFunction -> ExceptT HaskellEvaluationError m b
specMerge :: SpecFileArrayMergeStrategy -> Value -> Value -> Value

Documentation

newtype YamlParseError #

Constructors

YamlParseError Text

Instances

Instances details

Exception YamlParseError #
Instance details Defined in Napkin.Spec.Yaml.Interpret Methods toException :: YamlParseError -> SomeException # fromException :: SomeException -> Maybe YamlParseError # displayException :: YamlParseError -> String #
Show YamlParseError #
Instance details Defined in Napkin.Spec.Yaml.Interpret Methods showsPrec :: Int -> YamlParseError -> ShowS # show :: YamlParseError -> String # showList :: [YamlParseError] -> ShowS #
Eq YamlParseError #
Instance details Defined in Napkin.Spec.Yaml.Interpret Methods (==) :: YamlParseError -> YamlParseError -> Bool # (/=) :: YamlParseError -> YamlParseError -> Bool #

type LoadYamlConstraint backend = (SpecBackend backend, Default (DbBackendOptions backend), Show (DbBackendOptions backend), FromJSON (DbBackendOptions backend), Eq (BackendTableMeta backend), Show (BackendTableMeta backend), RunBackendEffect backend, RunBackendConn backend, DumpBackendRequirements backend, HasBackendQueryStats backend, BackendMetaConstraints backend, SqlConcat backend) #

type CliAction m a = forall b. LoadYamlConstraint b => b -> YamlSpec b -> Value -> m a #

loadYamlFile :: forall m a. MonadIO m => SpecFilesWithOverrides -> CliAction m a -> m (Either NapkinError a) #

loadYamlFile' :: forall m a. (MonadError NapkinError m, MonadIO m) => SpecFilesWithOverrides -> CliAction m a -> m a #

loadYaml' :: forall m a. Monad m => Value -> Maybe Patch -> CliAction m a -> m (Either Text a) #

loadHaskellModules :: forall bk m. (ToDbBackend bk, Typeable bk, MonadIO m) => InterpreterInstance -> YamlSpec bk -> m (Either HaskellEvaluationError ()) #

The main entry point interpreting a given YAML spec file as a Spec value ready to run via executeSpec

This function is intended to unroll/interpret as much as possible to get the spec in its final state ready to be actually run.

interpretTables :: forall bk m. (ToDbBackend bk, Typeable bk, MonadIO m) => InterpreterInstance -> YamlSpec bk -> ExceptT HaskellEvaluationError m (SpecProgramArguments, Spec bk ()) #

interpretHaskellSpec :: forall bk. (ToDbBackend bk, Typeable bk) => InterpreterInstance -> YamlSpec bk -> ExceptT HaskellEvaluationError (Spec bk) () #

interpretYamlToSpec :: forall b m. (MonadIO m, ReifiesBackend b, ToDbBackend b, Typeable b) => LogEnv -> RuntimeEnv -> YamlSpec b -> SpecMetaArgs -> ExceptT NapkinError m (RawInterpretedSpec b) #

interpretYamlToSpec' :: forall b m. (MonadIO m, ToDbBackend b, Typeable b) => LogEnv -> RuntimeEnv -> YamlSpec b -> SpecMetaArgs -> ExceptT YamlSpecInterpretError m (RawInterpretedSpec b) #

interpretTable :: forall bk m. (MonadIO m, Typeable bk) => InterpreterInstance -> SpecTableName -> YamlTableSpec bk -> ExceptT HaskellEvaluationError m (SpecProgramArguments, Spec bk ()) #

Main entry point for fully interpreting a given table's entry in the YAML file.

interpretSpec :: forall b. Typeable b => InterpreterInstance -> Typed (Spec b ()) ModuleFunction -> ExceptT HaskellEvaluationError (Spec b) () #

evalHsFun :: forall m b. (Typeable b, MonadIO m) => InterpreterInstance -> Typed b ModuleFunction -> ExceptT HaskellEvaluationError m b #

specMerge :: SpecFileArrayMergeStrategy -> Value -> Value -> Value #