B9.B9Config

Static B9 configuration. Read, write and merge configurable properties. The properties are independent of specific build targets.

Documentation

data B9Config

Constructors

B9Config

Fields

• _verbosity :: Maybe LogLevel
• _logFile :: Maybe FilePath
• _buildDirRoot :: Maybe FilePath
• _keepTempDirs :: Bool
• _execEnvType :: ExecEnvType
• _profileFile :: Maybe FilePath
• _envVars :: BuildVariables
• _uniqueBuildDirs :: Bool
• _repositoryCache :: Maybe SystemPath
• _repository :: Maybe String
• _interactive :: Bool
• _maxLocalSharedImageRevisions :: Maybe Int
• _libVirtLXCConfigs :: Maybe LibVirtLXCConfig
• _remoteRepos :: [RemoteRepo]

Instances

Show B9Config

Methods

showsPrec :: Int -> B9Config -> ShowS

show :: B9Config -> String

showList :: [B9Config] -> ShowS

Semigroup B9Config

Methods

(<>) :: B9Config -> B9Config -> B9Config

sconcat :: NonEmpty B9Config -> B9Config

stimes :: Integral b => b -> B9Config -> B9Config

Monoid B9Config

Methods

mempty :: B9Config

mappend :: B9Config -> B9Config -> B9Config

mconcat :: [B9Config] -> B9Config

verbosity :: Lens' B9Config (Maybe LogLevel)

logFile :: Lens' B9Config (Maybe FilePath)

buildDirRoot :: Lens' B9Config (Maybe FilePath)

keepTempDirs :: Lens' B9Config Bool

execEnvType :: Lens' B9Config ExecEnvType

profileFile :: Lens' B9Config (Maybe FilePath)

envVars :: Lens' B9Config BuildVariables

uniqueBuildDirs :: Lens' B9Config Bool

repositoryCache :: Lens' B9Config (Maybe SystemPath)

repository :: Lens' B9Config (Maybe String)

interactive :: Lens' B9Config Bool

libVirtLXCConfigs :: Lens' B9Config (Maybe LibVirtLXCConfig)

remoteRepos :: Lens' B9Config [RemoteRepo]

maxLocalSharedImageRevisions :: Lens' B9Config (Maybe Int)

data B9ConfigOverride

Override b9 configuration items and/or the path of the b9 configuration file. This is useful, i.e. when dealing with command line parameters.

Constructors

B9ConfigOverride

Fields

• _customB9ConfigPath :: Maybe SystemPath
• _customB9Config :: B9Config

Instances

Show B9ConfigOverride

Methods

showsPrec :: Int -> B9ConfigOverride -> ShowS

show :: B9ConfigOverride -> String

showList :: [B9ConfigOverride] -> ShowS

noB9ConfigOverride :: B9ConfigOverride

An empty default B9ConfigOverride value, that will neither apply any additional B9Config nor change the path of the configuration file.

data B9ConfigAction m a

A monad that gives access to the (transient) B9Config to be used to _runtime_ with askRuntimeConfig or localRuntimeConfig, and that allows to write permanent B9Config changes back to the configuration file using modifyPermanentConfig. Execute a B9ConfigAction by invoking either invokeB9 (which is simple) or execB9ConfigAction.

Instances

Monad m => Monad (B9ConfigAction m)

Methods

(>>=) :: B9ConfigAction m a -> (a -> B9ConfigAction m b) -> B9ConfigAction m b

(>>) :: B9ConfigAction m a -> B9ConfigAction m b -> B9ConfigAction m b

return :: a -> B9ConfigAction m a

fail :: String -> B9ConfigAction m a

Functor m => Functor (B9ConfigAction m)

Methods

fmap :: (a -> b) -> B9ConfigAction m a -> B9ConfigAction m b

(<$) :: a -> B9ConfigAction m b -> B9ConfigAction m a

Applicative m => Applicative (B9ConfigAction m)

Methods

pure :: a -> B9ConfigAction m a

(<*>) :: B9ConfigAction m (a -> b) -> B9ConfigAction m a -> B9ConfigAction m b

liftA2 :: (a -> b -> c) -> B9ConfigAction m a -> B9ConfigAction m b -> B9ConfigAction m c

(*>) :: B9ConfigAction m a -> B9ConfigAction m b -> B9ConfigAction m b

(<*) :: B9ConfigAction m a -> B9ConfigAction m b -> B9ConfigAction m a

MonadIO m => MonadIO (B9ConfigAction m)

Methods

liftIO :: IO a -> B9ConfigAction m a

execB9ConfigAction :: MonadIO m => B9ConfigAction m a -> B9ConfigOverride -> m a

Execute a B9ConfigAction. It will take a B9ConfigOverride as input. The B9Config in that value is treated as the _runtime_ configuration, and the _customConfigPath is used as the alternative location of the configuration file. The configuration file is read from either the path in _customB9ConfigPath or from defaultB9ConfigFile. Every modification done via modifyPermanentConfig is applied to the **contents** of the configuration file and written back to that file, note that these changes are ONLY reflected in the configuration file and **not** in the _runtime configuration_.

See also invokeB9, which does not need the B9ConfigOverride parameter.

invokeB9 :: MonadIO m => B9ConfigAction m a -> m a

Run a B9ConfigAction using noB9ConfigOverride. See execB9ConfigAction for more details.

askRuntimeConfig :: Monad m => B9ConfigAction m B9Config

Return the runtime configuration, that should be the configuration merged from all configuration sources. This is the configuration to be used during a VM image build.

localRuntimeConfig :: Monad m => (B9Config -> B9Config) -> B9ConfigAction m a -> B9ConfigAction m a

Run an action with an updated runtime configuration.

modifyPermanentConfig :: Monad m => Endo B9Config -> B9ConfigAction m ()

Add a modification to the permanent configuration file.

customB9Config :: Lens' B9ConfigOverride B9Config

customB9ConfigPath :: Lens' B9ConfigOverride (Maybe SystemPath)

overrideB9ConfigPath :: SystemPath -> B9ConfigOverride -> B9ConfigOverride

Convenience utility to override the B9 configuration file path.

overrideB9Config :: (B9Config -> B9Config) -> B9ConfigOverride -> B9ConfigOverride

Modify the runtime configuration.

overrideWorkingDirectory :: FilePath -> B9ConfigOverride -> B9ConfigOverride

Define the current working directory to be used when building.

overrideVerbosity :: LogLevel -> B9ConfigOverride -> B9ConfigOverride

Overwrite the verbosity settings in the configuration with those given.

overrideKeepBuildDirs :: Bool -> B9ConfigOverride -> B9ConfigOverride

Overwrite the keepTempDirs flag in the configuration with those given.

defaultB9ConfigFile :: SystemPath

defaultRepositoryCache :: SystemPath

defaultB9Config :: B9Config

openOrCreateB9Config :: MonadIO m => Maybe SystemPath -> m CPDocument

Open the configuration file that contains the B9Config. If the configuration does not exist, write a default configuration file, and create a all missing directories.

writeB9CPDocument :: MonadIO m => Maybe SystemPath -> CPDocument -> m ()

Write the configuration in the CPDocument to either the user supplied configuration file path or to defaultB9ConfigFile. Create all missing (parent) directories.

readB9Config :: MonadIO m => Maybe SystemPath -> m CPDocument

parseB9Config :: CPDocument -> Either CPError B9Config

appendPositionalArguments :: [String] -> B9Config -> B9Config

If environment variables arg_1 .. arg_n are bound and a list of k additional values are passed to this function, store them with keys arg_(n+1) .. arg_(n+k).

modifyCPDocument :: CPDocument -> Endo B9Config -> Either CPError CPDocument

Parse a B9Config, modify it, and merge it back to the given CPDocument.

b9ConfigToCPDocument :: B9Config -> Either CPError CPDocument

Append a config file section for the B9Config to an empty CPDocument.

data LogLevel

Constructors

LogTrace

LogDebug

LogInfo

LogError

LogNothing

Instances

Eq LogLevel

Methods

(==) :: LogLevel -> LogLevel -> Bool

(/=) :: LogLevel -> LogLevel -> Bool

Ord LogLevel

Methods

compare :: LogLevel -> LogLevel -> Ordering

(<) :: LogLevel -> LogLevel -> Bool

(<=) :: LogLevel -> LogLevel -> Bool

(>) :: LogLevel -> LogLevel -> Bool

(>=) :: LogLevel -> LogLevel -> Bool

max :: LogLevel -> LogLevel -> LogLevel

min :: LogLevel -> LogLevel -> LogLevel

Read LogLevel

Methods

readsPrec :: Int -> ReadS LogLevel

readList :: ReadS [LogLevel]

readPrec :: ReadPrec LogLevel

readListPrec :: ReadPrec [LogLevel]

Show LogLevel

Methods

showsPrec :: Int -> LogLevel -> ShowS

show :: LogLevel -> String

showList :: [LogLevel] -> ShowS

data ExecEnvType

Constructors

LibVirtLXC

Instances

Eq ExecEnvType

Methods

(==) :: ExecEnvType -> ExecEnvType -> Bool

(/=) :: ExecEnvType -> ExecEnvType -> Bool

Ord ExecEnvType

Methods

compare :: ExecEnvType -> ExecEnvType -> Ordering

(<) :: ExecEnvType -> ExecEnvType -> Bool

(<=) :: ExecEnvType -> ExecEnvType -> Bool

(>) :: ExecEnvType -> ExecEnvType -> Bool

(>=) :: ExecEnvType -> ExecEnvType -> Bool

max :: ExecEnvType -> ExecEnvType -> ExecEnvType

min :: ExecEnvType -> ExecEnvType -> ExecEnvType

Read ExecEnvType

Methods

readsPrec :: Int -> ReadS ExecEnvType

readList :: ReadS [ExecEnvType]

readPrec :: ReadPrec ExecEnvType

readListPrec :: ReadPrec [ExecEnvType]

Show ExecEnvType

Methods

showsPrec :: Int -> ExecEnvType -> ShowS

show :: ExecEnvType -> String

showList :: [ExecEnvType] -> ShowS

type BuildVariables = [(String, String)]