Control.Funflow.External

Definition of external tasks

Documentation

data InputPath

Set of items which may be treated as an input path to an external task.

Constructors

IPItem Item

An item in the content store.

IPExternalFile ExternallyAssuredFile

An external file whose contents are considered assured by the external system.

IPExternalDir ExternallyAssuredDirectory

An external directory whose contents are considered assured by the external system.

Instances

Show InputPath

Defined in Control.Funflow.External

Methods

showsPrec :: Int -> InputPath -> ShowS

show :: InputPath -> String

showList :: [InputPath] -> ShowS

Generic InputPath

Defined in Control.Funflow.External

Associated Types

type Rep InputPath :: Type -> Type

Methods

from :: InputPath -> Rep InputPath x

to :: Rep InputPath x -> InputPath

ToJSON InputPath

Defined in Control.Funflow.External

Methods

toJSON :: InputPath -> Value

toEncoding :: InputPath -> Encoding

toJSONList :: [InputPath] -> Value

toEncodingList :: [InputPath] -> Encoding

FromJSON InputPath

Defined in Control.Funflow.External

Methods

parseJSON :: Value -> Parser InputPath

parseJSONList :: Value -> Parser [InputPath]

Store InputPath

Defined in Control.Funflow.External

Methods

size :: Size InputPath

poke :: InputPath -> Poke ()

peek :: Peek InputPath

ContentHashable IO InputPath

Defined in Control.Funflow.External

Methods

contentHashUpdate :: Context SHA256 -> InputPath -> IO (Context SHA256)

contentHash :: InputPath -> IO ContentHash

type Rep InputPath

Defined in Control.Funflow.External

type Rep InputPath = D1 (MetaData "InputPath" "Control.Funflow.External" "funflow-1.5.0-IcEGfJSp3ag8T7kfAGHQUp" False) (C1 (MetaCons "IPItem" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Item)) :+: (C1 (MetaCons "IPExternalFile" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ExternallyAssuredFile)) :+: C1 (MetaCons "IPExternalDir" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ExternallyAssuredDirectory))))

data ParamField

Component of a parameter

Constructors

ParamText !Text

Text component.

ParamPath !InputPath

Reference to a path to a content store item.

ParamEnv !Text

Reference to an environment variable.

ParamUid

Reference to the effective user ID of the executor.

ParamGid

Reference to the effective group ID of the executor.

ParamOut

Reference to the output path in the content store.

ParamCmd Param

A quoted command that we can pass to another program as an argument.

Instances

Show ParamField

Defined in Control.Funflow.External

Methods

showsPrec :: Int -> ParamField -> ShowS

show :: ParamField -> String

showList :: [ParamField] -> ShowS

Generic ParamField

Defined in Control.Funflow.External

Associated Types

type Rep ParamField :: Type -> Type

Methods

from :: ParamField -> Rep ParamField x

to :: Rep ParamField x -> ParamField

ToJSON ParamField

Defined in Control.Funflow.External

Methods

toJSON :: ParamField -> Value

toEncoding :: ParamField -> Encoding

toJSONList :: [ParamField] -> Value

toEncodingList :: [ParamField] -> Encoding

FromJSON ParamField

Defined in Control.Funflow.External

Methods

parseJSON :: Value -> Parser ParamField

parseJSONList :: Value -> Parser [ParamField]

Store ParamField

Defined in Control.Funflow.External

Methods

size :: Size ParamField

poke :: ParamField -> Poke ()

peek :: Peek ParamField

ContentHashable IO ParamField

Defined in Control.Funflow.External

Methods

contentHashUpdate :: Context SHA256 -> ParamField -> IO (Context SHA256)

contentHash :: ParamField -> IO ContentHash

type Rep ParamField

Defined in Control.Funflow.External

type Rep ParamField = D1 (MetaData "ParamField" "Control.Funflow.External" "funflow-1.5.0-IcEGfJSp3ag8T7kfAGHQUp" False) ((C1 (MetaCons "ParamText" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) :+: (C1 (MetaCons "ParamPath" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 InputPath)) :+: C1 (MetaCons "ParamEnv" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)))) :+: ((C1 (MetaCons "ParamUid" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "ParamGid" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "ParamOut" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "ParamCmd" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Param)))))

newtype Param

A parameter to an external task

The runtime values to external references, e.g. environment variables, should not significantly influence the result of the external task. In particular, the content hash will not depend on these runtime values.

Constructors

Param [ParamField]

Instances

Show Param

Defined in Control.Funflow.External

Methods

showsPrec :: Int -> Param -> ShowS

show :: Param -> String

showList :: [Param] -> ShowS

IsString Param

Defined in Control.Funflow.External

Methods

fromString :: String -> Param

Generic Param

Defined in Control.Funflow.External

Associated Types

type Rep Param :: Type -> Type

Methods

from :: Param -> Rep Param x

to :: Rep Param x -> Param

Semigroup Param

Defined in Control.Funflow.External

Methods

(<>) :: Param -> Param -> Param

sconcat :: NonEmpty Param -> Param

stimes :: Integral b => b -> Param -> Param

Monoid Param

Defined in Control.Funflow.External

Methods

mempty :: Param

mappend :: Param -> Param -> Param

mconcat :: [Param] -> Param

ToJSON Param

Defined in Control.Funflow.External

Methods

toJSON :: Param -> Value

toEncoding :: Param -> Encoding

toJSONList :: [Param] -> Value

toEncodingList :: [Param] -> Encoding

FromJSON Param

Defined in Control.Funflow.External

Methods

parseJSON :: Value -> Parser Param

parseJSONList :: Value -> Parser [Param]

Store Param

Defined in Control.Funflow.External

Methods

size :: Size Param

poke :: Param -> Poke ()

peek :: Peek Param

ContentHashable IO Param

Defined in Control.Funflow.External

Methods

contentHashUpdate :: Context SHA256 -> Param -> IO (Context SHA256)

contentHash :: Param -> IO ContentHash

type Rep Param

Defined in Control.Funflow.External

type Rep Param = D1 (MetaData "Param" "Control.Funflow.External" "funflow-1.5.0-IcEGfJSp3ag8T7kfAGHQUp" True) (C1 (MetaCons "Param" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ParamField])))

data ConvParam f

Converter of path components.

Constructors

ConvParam

Fields

• convPath :: Item -> f (Path Abs Dir)

  Resolve a reference to a content store item.

• convEnv :: Text -> f Text

  Resolve an environment variable.

• convUid :: f CUid

  Resolve the effective user ID.

• convGid :: f CGid

  Resolve the effective group ID.

• convOut :: f (Path Abs Dir)

  Resolve the output path in the content store.

paramFieldToText :: Applicative f => ConvParam f -> ParamField -> f Text

paramToText :: Applicative f => ConvParam f -> Param -> f Text

Transform a parameter to text using the given converter.

stringParam :: String -> Param

textParam :: Text -> Param

pathParam :: InputPath -> Param

Reference to a path to either: - a content store item, or - an externally assured file/directory.

contentParam :: Content t -> Param

Reference to a path to a file or directory within a store item.

externalFileParam :: ExternallyAssuredFile -> Param

Reference an externally assured file

externalDirectoryParam :: ExternallyAssuredDirectory -> Param

Reference an externally assured file

envParam :: Text -> Param

Reference to an environment variable.

uidParam :: Param

Reference to the effective user ID of the executor.

gidParam :: Param

Reference to the effective group ID of the executor.

outParam :: Param

Reference to the output path in the content store.

data OutputCapture

Control how and where stdout from the process is captured. Some external steps will write their output to stdout rather than to a file.

Constructors

NoOutputCapture

Specify that the step will write its output files directly, and that stdout will not be captured in the step output.

StdOutCapture

Capture output to a file named out in the output directory.

CustomOutCapture (Path Rel File)

Capture output to a custom named file in the output directory.

Instances

Show OutputCapture

Defined in Control.Funflow.External

Methods

showsPrec :: Int -> OutputCapture -> ShowS

show :: OutputCapture -> String

showList :: [OutputCapture] -> ShowS

Generic OutputCapture

Defined in Control.Funflow.External

Associated Types

type Rep OutputCapture :: Type -> Type

Methods

from :: OutputCapture -> Rep OutputCapture x

to :: Rep OutputCapture x -> OutputCapture

ToJSON OutputCapture

Defined in Control.Funflow.External

Methods

toJSON :: OutputCapture -> Value

toEncoding :: OutputCapture -> Encoding

toJSONList :: [OutputCapture] -> Value

toEncodingList :: [OutputCapture] -> Encoding

FromJSON OutputCapture

Defined in Control.Funflow.External

Methods

parseJSON :: Value -> Parser OutputCapture

parseJSONList :: Value -> Parser [OutputCapture]

Store OutputCapture

Defined in Control.Funflow.External

Methods

size :: Size OutputCapture

poke :: OutputCapture -> Poke ()

peek :: Peek OutputCapture

ContentHashable IO OutputCapture

Defined in Control.Funflow.External

Methods

contentHashUpdate :: Context SHA256 -> OutputCapture -> IO (Context SHA256)

contentHash :: OutputCapture -> IO ContentHash

type Rep OutputCapture

Defined in Control.Funflow.External

type Rep OutputCapture = D1 (MetaData "OutputCapture" "Control.Funflow.External" "funflow-1.5.0-IcEGfJSp3ag8T7kfAGHQUp" False) (C1 (MetaCons "NoOutputCapture" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "StdOutCapture" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "CustomOutCapture" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Path Rel File)))))

outputCaptureToRelFile :: OutputCapture -> Maybe (Path Rel File)

Get the file to write output to, if this is desired.

data Env

Control the environment set for the external process. This can either inherit from the surrounding environment, or explicitly set things.

Constructors

EnvInherit

Inherit all environment variables from the surrounding shell. Note that the values of these variables will not be taken into account in the content hash, and so changes to them will not trigger a rerun of the step.

EnvExplicit [(Text, Param)]

Instances

Show Env

Defined in Control.Funflow.External

Methods

showsPrec :: Int -> Env -> ShowS

show :: Env -> String

showList :: [Env] -> ShowS

Generic Env

Defined in Control.Funflow.External

Associated Types

type Rep Env :: Type -> Type

Methods

from :: Env -> Rep Env x

to :: Rep Env x -> Env

ToJSON Env

Defined in Control.Funflow.External

Methods

toJSON :: Env -> Value

toEncoding :: Env -> Encoding

toJSONList :: [Env] -> Value

toEncodingList :: [Env] -> Encoding

FromJSON Env

Defined in Control.Funflow.External

Methods

parseJSON :: Value -> Parser Env

parseJSONList :: Value -> Parser [Env]

Store Env

Defined in Control.Funflow.External

Methods

size :: Size Env

poke :: Env -> Poke ()

peek :: Peek Env

ContentHashable IO Env

Defined in Control.Funflow.External

Methods

contentHashUpdate :: Context SHA256 -> Env -> IO (Context SHA256)

contentHash :: Env -> IO ContentHash

type Rep Env

Defined in Control.Funflow.External

type Rep Env = D1 (MetaData "Env" "Control.Funflow.External" "funflow-1.5.0-IcEGfJSp3ag8T7kfAGHQUp" False) (C1 (MetaCons "EnvInherit" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "EnvExplicit" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(Text, Param)])))

data ExternalTask

A monomorphic description of an external task. This is basically just a command which can be run.

Constructors

ExternalTask

Fields

• _etCommand :: Text
• _etParams :: [Param]

  Environment variables to set for the scope of the execution.

• _etEnv :: Env
• _etWriteToStdOut :: OutputCapture

Instances

Show ExternalTask

Defined in Control.Funflow.External

Methods

showsPrec :: Int -> ExternalTask -> ShowS

show :: ExternalTask -> String

showList :: [ExternalTask] -> ShowS

Generic ExternalTask

Defined in Control.Funflow.External

Associated Types

type Rep ExternalTask :: Type -> Type

Methods

from :: ExternalTask -> Rep ExternalTask x

to :: Rep ExternalTask x -> ExternalTask

ToJSON ExternalTask

Defined in Control.Funflow.External

Methods

toJSON :: ExternalTask -> Value

toEncoding :: ExternalTask -> Encoding

toJSONList :: [ExternalTask] -> Value

toEncodingList :: [ExternalTask] -> Encoding

FromJSON ExternalTask

Defined in Control.Funflow.External

Methods

parseJSON :: Value -> Parser ExternalTask

parseJSONList :: Value -> Parser [ExternalTask]

Store ExternalTask

Defined in Control.Funflow.External

Methods

size :: Size ExternalTask

poke :: ExternalTask -> Poke ()

peek :: Peek ExternalTask

ContentHashable IO ExternalTask

Defined in Control.Funflow.External

Methods

contentHashUpdate :: Context SHA256 -> ExternalTask -> IO (Context SHA256)

contentHash :: ExternalTask -> IO ContentHash

type Rep ExternalTask

Defined in Control.Funflow.External

type Rep ExternalTask = D1 (MetaData "ExternalTask" "Control.Funflow.External" "funflow-1.5.0-IcEGfJSp3ag8T7kfAGHQUp" False) (C1 (MetaCons "ExternalTask" PrefixI True) ((S1 (MetaSel (Just "_etCommand") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Just "_etParams") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Param])) :*: (S1 (MetaSel (Just "_etEnv") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Env) :*: S1 (MetaSel (Just "_etWriteToStdOut") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 OutputCapture))))

data TaskDescription

Constructors

TaskDescription

Fields

• _tdOutput :: ContentHash
• _tdTask :: ExternalTask

Instances

Show TaskDescription

Defined in Control.Funflow.External

Methods

showsPrec :: Int -> TaskDescription -> ShowS

show :: TaskDescription -> String

showList :: [TaskDescription] -> ShowS

Generic TaskDescription

Defined in Control.Funflow.External

Associated Types

type Rep TaskDescription :: Type -> Type

Methods

from :: TaskDescription -> Rep TaskDescription x

to :: Rep TaskDescription x -> TaskDescription

type Rep TaskDescription

Defined in Control.Funflow.External

type Rep TaskDescription = D1 (MetaData "TaskDescription" "Control.Funflow.External" "funflow-1.5.0-IcEGfJSp3ag8T7kfAGHQUp" False) (C1 (MetaCons "TaskDescription" PrefixI True) (S1 (MetaSel (Just "_tdOutput") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ContentHash) :*: S1 (MetaSel (Just "_tdTask") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ExternalTask)))

etWriteToStdOut :: Lens' ExternalTask OutputCapture

etParams :: Lens' ExternalTask [Param]

etEnv :: Lens' ExternalTask Env

etCommand :: Lens' ExternalTask Text

tdTask :: Lens' TaskDescription ExternalTask

tdOutput :: Lens' TaskDescription ContentHash