HasCommands (Env m r) Source #
Instance details Defined in Shrun.Configuration.Env.Types Methods getCleanup :: Env m r -> Maybe CommandCleanup Source # getCommandDepGraph :: Env m r -> CommandGraph Source # getCommandStatusMap :: Env m r -> TCommandStatusMap Source #

data CommandCleanup Source #

Constructors

MkCommandCleanup
Fields findPidsExe :: FilePath killPidsExe :: FilePath

Instances

Instances details

Show CommandCleanup Source #
Instance details Defined in Shrun.Configuration.Env.Types Methods showsPrec :: Int -> CommandCleanup -> ShowS # show :: CommandCleanup -> String # showList :: [CommandCleanup] -> ShowS #
Eq CommandCleanup Source #
Instance details Defined in Shrun.Configuration.Env.Types Methods (==) :: CommandCleanup -> CommandCleanup -> Bool # (/=) :: CommandCleanup -> CommandCleanup -> Bool #
(k ~ A_Lens, a ~ FilePath, b ~ FilePath) => LabelOptic "findPidsExe" k CommandCleanup CommandCleanup a b Source #
Instance details Defined in Shrun.Configuration.Env.Types Methods labelOptic :: Optic k NoIx CommandCleanup CommandCleanup a b Source #
(k ~ A_Lens, a ~ FilePath, b ~ FilePath) => LabelOptic "killPidsExe" k CommandCleanup CommandCleanup a b Source #
Instance details Defined in Shrun.Configuration.Env.Types Methods labelOptic :: Optic k NoIx CommandCleanup CommandCleanup a b Source #

updateCommandStatus :: (HasCallStack, HasCommands env, MonadAtomic m, MonadReader env m, MonadThrow m) => CommandP1 -> CommandStatus -> m () Source #

Prepends a completed command.

getReadCommandStatus :: (HasCallStack, HasCommands env, MonadAtomic m, MonadReader env m) => m CommandStatusMap Source #

Retrieves the entire status map in a single STM transaction.

class HasCommandLogging env where Source #

Methods

getCommandLogging :: env -> CommandLoggingEnv Source #

Instances

Instances details

HasCommandLogging (Env m r) Source #
Instance details Defined in Shrun.Configuration.Env.Types Methods getCommandLogging :: Env m r -> CommandLoggingEnv Source #

class HasCommonLogging env where Source #

Methods

getCommonLogging :: env -> CommonLoggingEnv Source #

Instances

Instances details

HasCommonLogging (Env m r) Source #
Instance details Defined in Shrun.Configuration.Env.Types Methods getCommonLogging :: Env m r -> CommonLoggingEnv Source #

class HasConsoleLogging env r where Source #

Methods

getConsoleLogging :: env -> (ConsoleLoggingEnv, TBQueue (LogRegion r), IORef (Maybe r)) Source #

Instances

Instances details

HasConsoleLogging (Env m r) r Source #
Instance details Defined in Shrun.Configuration.Env.Types Methods getConsoleLogging :: Env m r -> (ConsoleLoggingEnv, TBQueue (LogRegion r), IORef (Maybe r)) Source #

class HasFileLogging env where Source #

Methods

getFileLogging :: env -> Maybe FileLoggingEnv Source #

Instances

Instances details

HasFileLogging (Env m r) Source #
Instance details Defined in Shrun.Configuration.Env.Types Methods getFileLogging :: Env m r -> Maybe FileLoggingEnv Source #

class HasTimeout env where Source #

Timeout, if any.

Methods

getTimeout :: env -> WithDisabled Timeout Source #

getHasTimedOut :: env -> TVar Bool Source #

Instances

Instances details

HasTimeout (Env m r) Source #
Instance details Defined in Shrun.Configuration.Env.Types Methods getTimeout :: Env m r -> WithDisabled Timeout Source # getHasTimedOut :: Env m r -> TVar Bool Source #

setTimedOut :: (HasTimeout env, MonadAtomic m, MonadReader env m) => m () Source #

Sets timedout to true.

whenTimedOut :: (HasTimeout env, MonadAtomic m, MonadReader env m) => m () -> m () Source #

Run the action when shrun has timed out.

class HasInit env where Source #

Init, if any.

Methods

getInit :: env -> Maybe Text Source #

Instances

Instances details

HasInit (Env m r) Source #
Instance details Defined in Shrun.Configuration.Env.Types Methods getInit :: Env m r -> Maybe Text Source #

class HasAnyError env where Source #

Methods

getAnyError :: env -> TVar Bool Source #

Retrieves the anyError flag.

Instances

Instances details

HasAnyError (Env m r) Source #
Instance details Defined in Shrun.Configuration.Env.Types Methods getAnyError :: Env m r -> TVar Bool Source #

setAnyErrorTrue :: (HasAnyError env, HasCallStack, MonadAtomic m, MonadReader env m) => m () Source #

Set anyError to True.

class HasNotifyConfig env r where Source #

Class for retrieving the notify config.

Methods

getNotifyConfig :: env -> Maybe (NotificationEnv r) Source #

Retrieves the notify config.

Instances

Instances details

HasNotifyConfig (Env notifyEnv r) notifyEnv Source #
Instance details Defined in Shrun.Configuration.Env.Types Methods getNotifyConfig :: Env notifyEnv r -> Maybe (NotificationEnv notifyEnv) Source #

Aggregate

type HasLogging env (m :: Type -> Type) = (HasCommandLogging env, HasCommonLogging env, HasConsoleLogging env (Region m), HasFileLogging env) Source #

Alias for all logging config.

Types

data Env notifyEnv logRegion Source #

The main Env type used by Shrun.

Constructors

MkEnv

Fields

anyError :: TVar Bool
Holds the anyError flag, signaling if any command exited with an error.
commandCleanup :: Maybe CommandCleanup
Functions to clean up running commands.
commands :: NESeq CommandP1
Holds notification environment. | Commands
commandGraph :: CommandGraph
Command graph.
commandStatusMap :: TCommandStatusMap
Map from CommandIndex to Command and its status. Used for determining e.g. which commands have completed failed not run.
The statuses are TVars since they are mutable, though the map itself can be pure since its structure is fixed at initialization. In fact, we could probably swap TVar for IORef since we only update the status from a single thread (each command has its own thread).
config :: CoreConfigP 'ConfigPhaseEnv notifyEnv
Core config.
consoleLogQueue :: ~(TBQueue (LogRegion logRegion))
Console log queue.
hasTimedOut :: TVar Bool
timerRegion :: IORef (Maybe logRegion)
Timer region. It's an IORef only because it is not initialized on startup. Once it is set it is no longer mutated.

Instances

Instances details

(k ~ A_Lens, a ~ TVar Bool, b ~ TVar Bool) => LabelOptic "anyError" k (Env m r) (Env m r) a b Source #

Instance details

Defined in Shrun.Configuration.Env.Types

Methods

labelOptic :: Optic k NoIx (Env m r) (Env m r) a b Source #

(k ~ A_Lens, a ~ Maybe CommandCleanup, b ~ Maybe CommandCleanup) => LabelOptic "commandCleanup" k (Env m r) (Env m r) a b Source #

Instance details

Defined in Shrun.Configuration.Env.Types

Methods

labelOptic :: Optic k NoIx (Env m r) (Env m r) a b Source #

(k ~ A_Lens, a ~ CommandGraph, b ~ CommandGraph) => LabelOptic "commandGraph" k (Env m r) (Env m r) a b Source #

Instance details

Defined in Shrun.Configuration.Env.Types

Methods

labelOptic :: Optic k NoIx (Env m r) (Env m r) a b Source #

(k ~ A_Lens, a ~ TCommandStatusMap, b ~ TCommandStatusMap) => LabelOptic "commandStatusMap" k (Env m r) (Env m r) a b Source #

Instance details

Defined in Shrun.Configuration.Env.Types

Methods

labelOptic :: Optic k NoIx (Env m r) (Env m r) a b Source #

(k ~ A_Lens, a ~ NESeq CommandP1, b ~ NESeq CommandP1) => LabelOptic "commands" k (Env m r) (Env m r) a b Source #

Instance details

Defined in Shrun.Configuration.Env.Types

Methods

labelOptic :: Optic k NoIx (Env m r) (Env m r) a b Source #

(k ~ A_Lens, a ~ CoreConfigP 'ConfigPhaseEnv notifyEnv, b ~ CoreConfigP 'ConfigPhaseEnv notifyEnv) => LabelOptic "config" k (Env notifyEnv r) (Env notifyEnv r) a b Source #

Instance details

Defined in Shrun.Configuration.Env.Types

Methods

labelOptic :: Optic k NoIx (Env notifyEnv r) (Env notifyEnv r) a b Source #

(k ~ A_Lens, a ~ TBQueue (LogRegion r), b ~ TBQueue (LogRegion r)) => LabelOptic "consoleLogQueue" k (Env m r) (Env m r) a b Source #

Instance details

Defined in Shrun.Configuration.Env.Types

Methods

labelOptic :: Optic k NoIx (Env m r) (Env m r) a b Source #

(k ~ A_Lens, a ~ TVar Bool, b ~ TVar Bool) => LabelOptic "hasTimedOut" k (Env m r) (Env m r) a b Source #

Instance details

Defined in Shrun.Configuration.Env.Types

Methods

labelOptic :: Optic k NoIx (Env m r) (Env m r) a b Source #

(k ~ A_Lens, a ~ IORef (Maybe r), b ~ IORef (Maybe r)) => LabelOptic "timerRegion" k (Env m r) (Env m r) a b Source #

Instance details

Defined in Shrun.Configuration.Env.Types

Methods

labelOptic :: Optic k NoIx (Env m r) (Env m r) a b Source #

HasAnyError (Env m r) Source #

Instance details

Defined in Shrun.Configuration.Env.Types

Methods

getAnyError :: Env m r -> TVar Bool Source #

HasCommandLogging (Env m r) Source #

Instance details

Defined in Shrun.Configuration.Env.Types

Methods

getCommandLogging :: Env m r -> CommandLoggingEnv Source #

HasCommands (Env m r) Source #

Instance details

Defined in Shrun.Configuration.Env.Types

Methods

getCleanup :: Env m r -> Maybe CommandCleanup Source #

getCommandDepGraph :: Env m r -> CommandGraph Source #

getCommandStatusMap :: Env m r -> TCommandStatusMap Source #

HasCommonLogging (Env m r) Source #

Instance details

Defined in Shrun.Configuration.Env.Types

Methods

getCommonLogging :: Env m r -> CommonLoggingEnv Source #

HasFileLogging (Env m r) Source #

Instance details

Defined in Shrun.Configuration.Env.Types

Methods

getFileLogging :: Env m r -> Maybe FileLoggingEnv Source #

HasInit (Env m r) Source #

Instance details

Defined in Shrun.Configuration.Env.Types

Methods

getInit :: Env m r -> Maybe Text Source #

HasTimeout (Env m r) Source #

Instance details

Defined in Shrun.Configuration.Env.Types

Methods

getTimeout :: Env m r -> WithDisabled Timeout Source #

getHasTimedOut :: Env m r -> TVar Bool Source #

MonadRegionLogger m => MonadRegionLogger (ShellT (Env notifyEnv r) m) Source #

Instance details

Defined in Shrun.ShellT

Associated Types

type Region (ShellT (Env notifyEnv r) m)
Instance details Defined in Shrun.ShellT type Region (ShellT (Env notifyEnv r) m) = Region (ReaderT (Env notifyEnv r) m)

Methods

logGlobal :: Text -> ShellT (Env notifyEnv r) m () Source #

logRegion :: LogMode -> Region (ShellT (Env notifyEnv r) m) -> Text -> ShellT (Env notifyEnv r) m () Source #

withRegion :: HasCallStack => RegionLayout -> (Region (ShellT (Env notifyEnv r) m) -> ShellT (Env notifyEnv r) m a) -> ShellT (Env notifyEnv r) m a Source #

displayRegions :: HasCallStack => ShellT (Env notifyEnv r) m a -> ShellT (Env notifyEnv r) m a Source #

regionList :: ShellT (Env notifyEnv r) m (TMVar [Region (ShellT (Env notifyEnv r) m)]) Source #

HasConsoleLogging (Env m r) r Source #

Instance details

Defined in Shrun.Configuration.Env.Types

Methods

getConsoleLogging :: Env m r -> (ConsoleLoggingEnv, TBQueue (LogRegion r), IORef (Maybe r)) Source #

HasNotifyConfig (Env notifyEnv r) notifyEnv Source #

Instance details

Defined in Shrun.Configuration.Env.Types

Methods

getNotifyConfig :: Env notifyEnv r -> Maybe (NotificationEnv notifyEnv) Source #

type Region (ShellT (Env notifyEnv r) m) Source #

Instance details

Defined in Shrun.ShellT

type Region (ShellT (Env notifyEnv r) m) = Region (ReaderT (Env notifyEnv r) m)

whenDebug :: (HasCommonLogging env, MonadReader env m) => m () -> m () Source #

Run the action when the debug flag is active.