Puppet.Interpreter

Documentation

interpretCatalog

Arguments

:: Monad m

=> InterpreterReader m

The whole environment required for computing catalog.

-> NodeName

-> Facts

-> Container Text

Server settings

-> m (Pair (Either PrettyError (FinalCatalog, EdgeMap, FinalCatalog, [Resource])) [Pair Priority Doc])

Call the operational interpretMonad function to compute the catalog. Returns either an error, or a tuple containing all the resources, dependency map, exported resources, and defined resources alongside with all messages that have been generated by the compilation process.

The later defined resources (eg. all class declarations) are pulled out of the InterpreterState and might not be up to date. There are only useful for coverage testing (checking dependencies for instance).

computeCatalog :: NodeName -> InterpreterMonad (FinalCatalog, EdgeMap, FinalCatalog, [Resource])

Main internal entry point, this function completes the interpretation

evaluateStatement :: Statement -> InterpreterMonad [Resource]

Utils

initialState

Arguments

:: Facts

-> Container Text

Server settings

-> InterpreterState

extractScope :: InterpreterState -> Maybe (Text, Container ScopeInformation)

containerModName :: CurContainerDesc -> Text

askFact :: Text -> InterpreterMonad (Maybe PValue)

Ask the value of a fact given a specified key The fact set comes from the reader used by the interpreter monad.

Operational state

data InterpreterState

Constructors

InterpreterState !(Container ScopeInformation) !(Container (Pair ClassIncludeType PPosition)) !(HashMap RIdentifier Resource) ![CurContainerDesc] !PPosition !(HashMap (TopLevelType, Text) Statement) ![LinkInformation] ![ResourceModifier]

Instances

MonadFail InterpreterMonad

Defined in Puppet.Interpreter.Types

Methods

fail :: String -> InterpreterMonad a

MonadThrowPos InterpreterMonad

Defined in Puppet.Interpreter.Types

Methods

throwPosError :: Doc -> InterpreterMonad a

MonadError PrettyError InterpreterMonad

Defined in Puppet.Interpreter.Types

Methods

throwError :: PrettyError -> InterpreterMonad a

catchError :: InterpreterMonad a -> (PrettyError -> InterpreterMonad a) -> InterpreterMonad a

MonadWriter InterpreterWriter InterpreterMonad

Defined in Puppet.Interpreter.Types

Methods

writer :: (a, InterpreterWriter) -> InterpreterMonad a

tell :: InterpreterWriter -> InterpreterMonad ()

listen :: InterpreterMonad a -> InterpreterMonad (a, InterpreterWriter)

pass :: InterpreterMonad (a, InterpreterWriter -> InterpreterWriter) -> InterpreterMonad a

scopes :: Lens' InterpreterState (Container ScopeInformation)

definedResources :: Lens' InterpreterState (HashMap RIdentifier Resource)

nestedDeclarations :: Lens' InterpreterState (HashMap (TopLevelType, Text) Statement)

resModifiers :: Lens' InterpreterState [ResourceModifier]

extraRelations :: Lens' InterpreterState [LinkInformation]

curScope :: Lens' InterpreterState [CurContainerDesc]

curPos :: Lens' InterpreterState PPosition

loadedClasses :: Lens' InterpreterState (Container (Pair ClassIncludeType PPosition))

Operational reader

data InterpreterReader m

Constructors

InterpreterReader !(Container NativeTypeMethods) (TopLevelType -> Text -> m (Either PrettyError Statement)) (TemplateSource -> InterpreterState -> InterpreterReader m -> m (Either PrettyError Text)) (PuppetDBAPI m) (Container ([PValue] -> InterpreterMonad PValue)) Text (HieraQueryLayers m) (IoMethods m) (HashSet Text) (HashSet Text) Bool PuppetDirPaths (Maybe FilePath) (Container PValue)

readerNativeTypes :: forall m. Lens' (InterpreterReader m) (Container NativeTypeMethods)

readerGetStatement :: forall m. Lens' (InterpreterReader m) (TopLevelType -> Text -> m (Either PrettyError Statement))

readerGetTemplate :: forall m. Lens' (InterpreterReader m) (TemplateSource -> InterpreterState -> InterpreterReader m -> m (Either PrettyError Text))

readerPdbApi :: forall m. Lens' (InterpreterReader m) (PuppetDBAPI m)

readerExternalFunc :: forall m. Lens' (InterpreterReader m) (Container ([PValue] -> InterpreterMonad PValue))

readerNodename :: forall m. Lens' (InterpreterReader m) Text

readerHieraQuery :: forall m. Lens' (InterpreterReader m) (HieraQueryLayers m)

readerIoMethods :: forall m. Lens' (InterpreterReader m) (IoMethods m)

readerIgnoredModules :: forall m. Lens' (InterpreterReader m) (HashSet Text)

readerExternalModules :: forall m. Lens' (InterpreterReader m) (HashSet Text)

readerIsStrict :: forall m. Lens' (InterpreterReader m) Bool

readerPuppetPaths :: forall m. Lens' (InterpreterReader m) PuppetDirPaths

readerFacts :: forall m. Lens' (InterpreterReader m) (Container PValue)

readerRebaseFile :: forall m. Lens' (InterpreterReader m) (Maybe FilePath)

Interpreter monad

type InterpreterMonad = ProgramT InterpreterInstr (State InterpreterState)

The main monad

type InterpreterWriter = [Pair Priority Doc]

Log

data InterpreterInstr a where

Constructors

GetNativeTypes :: InterpreterInstr (Container NativeTypeMethods)

GetStatement :: TopLevelType -> Text -> InterpreterInstr Statement

ComputeTemplate :: TemplateSource -> InterpreterState -> InterpreterInstr Text

ExternalFunction :: Text -> [PValue] -> InterpreterInstr PValue

Facts :: InterpreterInstr (Container PValue)

GetNodeName :: InterpreterInstr Text

HieraQuery :: Container PValue -> Text -> HieraQueryType -> InterpreterInstr (Maybe PValue)

GetCurrentCallStack :: InterpreterInstr [String]

IsIgnoredModule :: Text -> InterpreterInstr Bool

IsExternalModule :: Text -> InterpreterInstr Bool

IsStrict :: InterpreterInstr Bool

PuppetPaths :: InterpreterInstr PuppetDirPaths

RebaseFile :: InterpreterInstr (Maybe FilePath)

ErrorThrow :: PrettyError -> InterpreterInstr a

ErrorCatch :: InterpreterMonad a -> (PrettyError -> InterpreterMonad a) -> InterpreterInstr a

WriterTell :: InterpreterWriter -> InterpreterInstr ()

WriterPass :: InterpreterMonad (a, InterpreterWriter -> InterpreterWriter) -> InterpreterInstr a

WriterListen :: InterpreterMonad a -> InterpreterInstr (a, InterpreterWriter)

PDBInformation :: InterpreterInstr Doc

PDBReplaceCatalog :: WireCatalog -> InterpreterInstr ()

PDBReplaceFacts :: [(NodeName, Facts)] -> InterpreterInstr ()

PDBDeactivateNode :: NodeName -> InterpreterInstr ()

PDBGetFacts :: Query FactField -> InterpreterInstr [FactInfo]

PDBGetResources :: Query ResourceField -> InterpreterInstr [Resource]

PDBGetNodes :: Query NodeField -> InterpreterInstr [NodeInfo]

PDBCommitDB :: InterpreterInstr ()

PDBGetResourcesOfNode :: NodeName -> Query ResourceField -> InterpreterInstr [Resource]

ReadFile :: [Text] -> InterpreterInstr Text

TraceEvent :: String -> InterpreterInstr ()

Instances

MonadFail InterpreterMonad

Defined in Puppet.Interpreter.Types

Methods

fail :: String -> InterpreterMonad a

MonadThrowPos InterpreterMonad

Defined in Puppet.Interpreter.Types

Methods

throwPosError :: Doc -> InterpreterMonad a

MonadError PrettyError InterpreterMonad

Defined in Puppet.Interpreter.Types

Methods

throwError :: PrettyError -> InterpreterMonad a

catchError :: InterpreterMonad a -> (PrettyError -> InterpreterMonad a) -> InterpreterMonad a

MonadWriter InterpreterWriter InterpreterMonad

Defined in Puppet.Interpreter.Types

Methods

writer :: (a, InterpreterWriter) -> InterpreterMonad a

tell :: InterpreterWriter -> InterpreterMonad ()

listen :: InterpreterMonad a -> InterpreterMonad (a, InterpreterWriter)

pass :: InterpreterMonad (a, InterpreterWriter -> InterpreterWriter) -> InterpreterMonad a

Pretty (InterpreterInstr a)

Defined in Puppet.Interpreter.PrettyPrinter

Methods

pretty :: InterpreterInstr a -> Doc

prettyList :: [InterpreterInstr a] -> Doc

data Strictness

The intepreter can run in two modes : a strict mode (recommended), and a permissive mode.

Constructors

Strict

Permissive

Instances

Eq Strictness

Defined in Puppet.Interpreter.Types

Methods

(==) :: Strictness -> Strictness -> Bool

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

Show Strictness

Defined in Puppet.Interpreter.Types

Methods

showsPrec :: Int -> Strictness -> ShowS

show :: Strictness -> String

showList :: [Strictness] -> ShowS

FromJSON Strictness

Defined in Puppet.Interpreter.Types

Methods

parseJSON :: Value -> Parser Strictness

parseJSONList :: Value -> Parser [Strictness]

Io methods

data IoMethods m

Constructors

IoMethods (m [String]) ([Text] -> m (Either String Text)) (String -> m ())

ioGetCurrentCallStack :: forall m. Lens' (IoMethods m) (m [String])

ioReadFile :: forall m. Lens' (IoMethods m) ([Text] -> m (Either String Text))

ioTraceEvent :: forall m. Lens' (IoMethods m) (String -> m ())

class Monad m => MonadThrowPos m where

Methods

throwPosError :: Doc -> m a

Instances

MonadThrowPos InterpreterMonad

Defined in Puppet.Interpreter.Types

Methods

throwPosError :: Doc -> InterpreterMonad a

MonadThrowPos (Either Doc)

Defined in Puppet.Interpreter.Types

Methods

throwPosError :: Doc -> Either Doc a

Resource modifier

data ResourceModifier

Constructors

ResourceModifier !Text !ModifierType !ResourceCollectorType !RSearchExpression !(Resource -> InterpreterMonad Resource) !PPosition

Instances

Show ResourceModifier

Defined in Puppet.Interpreter.Types

Methods

showsPrec :: Int -> ResourceModifier -> ShowS

show :: ResourceModifier -> String

showList :: [ResourceModifier] -> ShowS

Pretty ResourceModifier

Defined in Puppet.Interpreter.PrettyPrinter

Methods

pretty :: ResourceModifier -> Doc

prettyList :: [ResourceModifier] -> Doc

rmResType :: Lens' ResourceModifier Text

rmDeclaration :: Lens' ResourceModifier PPosition

rmSearch :: Lens' ResourceModifier RSearchExpression

rmType :: Lens' ResourceModifier ResourceCollectorType

rmMutation :: Lens' ResourceModifier (Resource -> InterpreterMonad Resource)

rmModifierType :: Lens' ResourceModifier ModifierType

data ModifierType

Constructors

ModifierCollector

For collectors, optional resources

ModifierMustMatch

For stuff like realize

Instances

Eq ModifierType

Defined in Puppet.Interpreter.Types

Methods

(==) :: ModifierType -> ModifierType -> Bool

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

Show ModifierType

Defined in Puppet.Interpreter.Types

Methods

showsPrec :: Int -> ModifierType -> ShowS

show :: ModifierType -> String

showList :: [ModifierType] -> ShowS

data OverrideType

Constructors

CantOverride

Overriding forbidden, will throw an error

Replace

Can silently replace

CantReplace

Silently ignore errors

AppendAttribute

Can append values

Instances

Eq OverrideType

Defined in Puppet.Interpreter.Types

Methods

(==) :: OverrideType -> OverrideType -> Bool

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

Show OverrideType

Defined in Puppet.Interpreter.Types

Methods

showsPrec :: Int -> OverrideType -> ShowS

show :: OverrideType -> String

showList :: [OverrideType] -> ShowS

data ResourceCollectorType

Constructors

RealizeVirtual

RealizeCollected

DontRealize

Instances

Eq ResourceCollectorType

Defined in Puppet.Interpreter.Types

Methods

(==) :: ResourceCollectorType -> ResourceCollectorType -> Bool

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

Show ResourceCollectorType

Defined in Puppet.Interpreter.Types

Methods

showsPrec :: Int -> ResourceCollectorType -> ShowS

show :: ResourceCollectorType -> String

showList :: [ResourceCollectorType] -> ShowS

data ClassIncludeType

Puppet has two main ways to declare classes: include-like and resource-like.

See puppet reference.

Constructors

ClassIncludeLike

Using the include or contain function

ClassResourceLike

Resource like declaration

Instances

Eq ClassIncludeType

Defined in Puppet.Interpreter.Types

Methods

(==) :: ClassIncludeType -> ClassIncludeType -> Bool

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

data RSearchExpression

Constructors

REqualitySearch !Text !PValue

RNonEqualitySearch !Text !PValue

RAndSearch !RSearchExpression !RSearchExpression

ROrSearch !RSearchExpression !RSearchExpression

RAlwaysTrue

Instances

Eq RSearchExpression

Defined in Puppet.Interpreter.Types

Methods

(==) :: RSearchExpression -> RSearchExpression -> Bool

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

Show RSearchExpression

Defined in Puppet.Interpreter.Types

Methods

showsPrec :: Int -> RSearchExpression -> ShowS

show :: RSearchExpression -> String

showList :: [RSearchExpression] -> ShowS

Pretty RSearchExpression

Defined in Puppet.Interpreter.PrettyPrinter

Methods

pretty :: RSearchExpression -> Doc

prettyList :: [RSearchExpression] -> Doc

Scope information

data ScopeInformation

Constructors

ScopeInformation !(Container (Pair (Pair PValue PPosition) CurContainerDesc)) !(Container ResDefaults) !(HashSet Text) !CurContainer !(HashMap RIdentifier ResRefOverride) !(Maybe Text)

scopeResDefaults :: Lens' ScopeInformation (Container ResDefaults)

scopeVariables :: Lens' ScopeInformation (Container (Pair (Pair PValue PPosition) CurContainerDesc))

scopeParent :: Lens' ScopeInformation (Maybe Text)

scopeOverrides :: Lens' ScopeInformation (HashMap RIdentifier ResRefOverride)

scopeContainer :: Lens' ScopeInformation CurContainer

scopeExtraTags :: Lens' ScopeInformation (HashSet Text)

data CurContainer

The type of the container together with its tags.

Constructors

CurContainer !CurContainerDesc !(HashSet Text)

Instances

Eq CurContainer

Defined in Puppet.Interpreter.Types

Methods

(==) :: CurContainer -> CurContainer -> Bool

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

cctype :: Lens' CurContainer CurContainerDesc

cctags :: Lens' CurContainer (HashSet Text)

Resource default

data ResDefaults

From the evaluation of Resource Default Declaration.

Constructors

ResDefaults !Text !Text !(Container PValue) !PPosition

Instances

Pretty ResDefaults

Defined in Puppet.Interpreter.PrettyPrinter

Methods

pretty :: ResDefaults -> Doc

prettyList :: [ResDefaults] -> Doc

resDefValues :: Lens' ResDefaults (Container PValue)

resDefSrcScope :: Lens' ResDefaults Text

resDefPos :: Lens' ResDefaults PPosition

resDefType :: Lens' ResDefaults Text

data ResRefOverride

From the evaluation of Resource Override Declaration.

Constructors

ResRefOverride

Fields

• _rrid :: !RIdentifier
• _rrparams :: !(Container PValue)
• _rrpos :: !PPosition

Instances

Eq ResRefOverride

Defined in Puppet.Interpreter.Types

Methods

(==) :: ResRefOverride -> ResRefOverride -> Bool

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

data ScopeEnteringContext

Constructors

SENormal

SEChild !Text

We enter the scope as the child of another class

SEParent !Text

We enter the scope as the parent of another class

data TopLevelType

Differentiate the distinct top level types such as node, define or class.

Constructors

TopNode

For node entries

TopDefine

For defines

TopClass

For classes

Instances

Eq TopLevelType

Defined in Puppet.Interpreter.Types

Methods

(==) :: TopLevelType -> TopLevelType -> Bool

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

Generic TopLevelType

Defined in Puppet.Interpreter.Types

Associated Types

type Rep TopLevelType :: Type -> Type

Methods

from :: TopLevelType -> Rep TopLevelType x

to :: Rep TopLevelType x -> TopLevelType

Hashable TopLevelType

Defined in Puppet.Interpreter.Types

Methods

hashWithSalt :: Int -> TopLevelType -> Int

hash :: TopLevelType -> Int

Pretty TopLevelType

Defined in Puppet.Interpreter.PrettyPrinter

Methods

pretty :: TopLevelType -> Doc

prettyList :: [TopLevelType] -> Doc

type Rep TopLevelType

Defined in Puppet.Interpreter.Types

type Rep TopLevelType = D1 (MetaData "TopLevelType" "Puppet.Interpreter.Types" "language-puppet-1.4.5-5ocbCGkY0q25Rp10ZMtz6b" False) (C1 (MetaCons "TopNode" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "TopDefine" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "TopClass" PrefixI False) (U1 :: Type -> Type)))

Hiera

data HieraQueryLayers m

All available queries including the global and module layer The environment layer is not implemented.

The datatype belongs to the Puppet.Interpreter module because it serves to implement how Hiera is used within Puppet.

Constructors

HieraQueryLayers

Fields

• _globalLayer :: HieraQueryFunc m
• _environmentLayer :: HieraQueryFunc m
• _moduleLayer :: Container (HieraQueryFunc m)

globalLayer :: forall m. Lens' (HieraQueryLayers m) (HieraQueryFunc m)

environmentLayer :: forall m. Lens' (HieraQueryLayers m) (HieraQueryFunc m)

moduleLayer :: forall m. Lens' (HieraQueryLayers m) (Container (HieraQueryFunc m))

Template

data TemplateSource

Whether the template source is specified inline or loaded from a file.

Constructors

Inline Text

Filename FilePath

Instances

Pretty TemplateSource

Defined in Puppet.Interpreter.PrettyPrinter

Methods

pretty :: TemplateSource -> Doc

prettyList :: [TemplateSource] -> Doc

Re-export

module Puppet.Language

Pure resolution functions

getVariable

Arguments

:: Container ScopeInformation

The whole scope data.

-> Text

Current scope name.

-> Text

Full variable name.

-> Either Doc PValue

A pure function for resolving variables.

pValue2Bool :: PValue -> Bool

Turns a PValue into a Bool as explained in the reference documentation.

Monadic resolution functions

resolveVariable :: Text -> InterpreterMonad PValue

Resolves a variable, or throws an error if it can't.

resolveExpression :: Expression -> InterpreterMonad PValue

The main resolution function : turns an Expression into a PValue, if possible.

resolveValue :: UnresolvedValue -> InterpreterMonad PValue

Resolves an UnresolvedValue (terminal for the Expression data type) into a PValue

resolvePValueString :: PValue -> InterpreterMonad Text

Turns strings, numbers and booleans into Text, or throws an error.

resolvePValueNumber :: PValue -> InterpreterMonad Scientific

Turns everything it can into a number, or throws an error

resolveExpressionString :: Expression -> InterpreterMonad Text

resolveExpressionString = resolveExpression >=> resolvePValueString

resolveExpressionStrings :: Expression -> InterpreterMonad [Text]

Just like resolveExpressionString, but accepts arrays.

resolveFunction' :: Text -> [PValue] -> InterpreterMonad PValue

resolveDataType :: UDataType -> InterpreterMonad DataType

runHiera :: Text -> HieraQueryType -> InterpreterMonad (Maybe PValue)

A hiera helper function, that will throw all Hiera errors and log messages to the main monad.

isNativeType :: Text -> InterpreterMonad Bool

A simple helper that checks if a given type is native or a define.

Search expression management

resolveSearchExpression :: SearchExpression -> InterpreterMonad RSearchExpression

Turns an unresolved SearchExpression from the parser into a fully resolved RSearchExpression.

checkSearchExpression :: RSearchExpression -> Resource -> Bool

Checks whether a given Resource matches a RSearchExpression. Note that the expression doesn't check for type, so you must filter the resources by type beforehand, if needs be.

searchExpressionToPuppetDB :: Text -> RSearchExpression -> Query ResourceField

Turns a resource type and RSearchExpression into something that can be used in a PuppetDB query.

Higher order puppet functions handling

hfGenerateAssociations :: HOLambdaCall -> InterpreterMonad [[(Text, PValue)]]

Generates variable associations for evaluation of blocks. Each item corresponds to an iteration in the calling block.

hfSetvars :: [(Text, PValue)] -> InterpreterMonad (Container (Pair (Pair PValue PPosition) CurContainerDesc))

Sets the proper variables, and returns the scope variables the way they were before being modified. This is a hack that ensures that variables are local to the new scope.

It doesn't work at all like other Puppet parts, but consistency isn't really expected here ...

hfRestorevars :: Container (Pair (Pair PValue PPosition) CurContainerDesc) -> InterpreterMonad ()

Restores what needs restoring. This will erase all allocations.

fixResourceName

Arguments

:: Text

Resource type

-> Text

Resource name

-> Text

Converts class resource names to lowercase (fix for the jenkins plugin).

datatypeMatch :: DataType -> PValue -> Bool

Checks that a value matches a puppet datatype

checkMatch :: DataType -> PValue -> InterpreterMonad ()

typeOf :: PValue -> DataType

interpretMonad :: Monad m => InterpreterReader m -> InterpreterState -> InterpreterMonad a -> m (Either PrettyError a, InterpreterState, InterpreterWriter)

The operational interpreter function