Eq RIdentifier Source
Ord RIdentifier Source
Show RIdentifier Source
Generic RIdentifier Source
Hashable RIdentifier Source
ToJSON RIdentifier Source
FromJSON RIdentifier Source
HasRIdentifier RIdentifier Source
type Rep RIdentifier Source

class HasScopeInformation c where Source

Minimal complete definition

scopeInformation

Methods

scopeInformation :: Lens' c ScopeInformation Source

scopeContainer :: Lens' c CurContainer Source

scopeExtraTags :: Lens' c (HashSet Text) Source

scopeOverrides :: Lens' c (HashMap RIdentifier ResRefOverride) Source

scopeParent :: Lens' c (Maybe Text) Source

scopeResDefaults :: Lens' c (Container ResDefaults) Source

scopeVariables :: Lens' c (Container (Pair (Pair PValue PPosition) CurContainerDesc)) Source

Instances

HasScopeInformation ScopeInformation Source

data ScopeInformation Source

Constructors

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

Instances

HasScopeInformation ScopeInformation Source

data ScopeEnteringContext Source

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

class HasResourceModifier c where Source

Minimal complete definition

resourceModifier

Methods

resourceModifier :: Lens' c ResourceModifier Source

rmDeclaration :: Lens' c PPosition Source

rmModifierType :: Lens' c ModifierType Source

rmMutation :: Lens' c (Resource -> InterpreterMonad Resource) Source

rmResType :: Lens' c Text Source

rmSearch :: Lens' c RSearchExpression Source

rmType :: Lens' c ResourceCollectorType Source

Instances

HasResourceModifier ResourceModifier Source

data ResourceModifier Source

Constructors

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

Instances

Show ResourceModifier Source
HasResourceModifier ResourceModifier Source

class HasIoMethods c m | c -> m where Source

Minimal complete definition

ioMethods

Methods

ioMethods :: Lens' c (IoMethods m) Source

ioGetCurrentCallStack :: Lens' c (m [String]) Source

ioReadFile :: Lens' c ([Text] -> m (Either String Text)) Source

ioTraceEvent :: Lens' c (String -> m ()) Source

Instances

HasIoMethods (IoMethods m) m Source

data IoMethods m Source

Constructors

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

Instances

HasIoMethods (IoMethods m) m Source

class HasCurContainer c where Source

Minimal complete definition

curContainer

Methods

curContainer :: Lens' c CurContainer Source

cctags :: Lens' c (HashSet Text) Source

cctype :: Lens' c CurContainerDesc Source

Instances

HasCurContainer CurContainer Source

data CurContainer Source

TODO related to Scope: explain ...

Constructors

CurContainer !CurContainerDesc !(HashSet Text)

Instances

Eq CurContainer Source
HasCurContainer CurContainer Source

class HasNativeTypeMethods c where Source

Minimal complete definition

nativeTypeMethods

Methods

nativeTypeMethods :: Lens' c NativeTypeMethods Source

puppetFields :: Lens' c (HashSet Text) Source

puppetValidate :: Lens' c NativeTypeValidate Source

Instances

HasNativeTypeMethods NativeTypeMethods Source

data NativeTypeMethods Source

Attributes (and providers) of a puppet resource type bundled with validation rules

Constructors

NativeTypeMethods NativeTypeValidate (HashSet Text)

Instances

HasNativeTypeMethods NativeTypeMethods Source

data NodeInfo Source

Constructors

NodeInfo !NodeName !Bool !(Maybe UTCTime) !(Maybe UTCTime) !(Maybe UTCTime)

Instances

ToJSON NodeInfo Source
FromJSON NodeInfo Source
HasNodeInfo NodeInfo Source

class HasNodeInfo c where Source

Minimal complete definition

nodeInfo

Methods

nodeInfo :: Lens' c NodeInfo Source

nodeInfoCatalogT :: Lens' c (Maybe UTCTime) Source

nodeInfoDeactivated :: Lens' c Bool Source

nodeInfoFactsT :: Lens' c (Maybe UTCTime) Source

nodeInfoName :: Lens' c NodeName Source

nodeInfoReportT :: Lens' c (Maybe UTCTime) Source

Instances

HasNodeInfo NodeInfo Source

data FactInfo Source

Constructors

FactInfo !NodeName !Text !PValue

Instances

ToJSON FactInfo Source
FromJSON FactInfo Source
HasFactInfo FactInfo Source

class HasFactInfo c where Source

Minimal complete definition

factInfo

Methods

factInfo :: Lens' c FactInfo Source

factInfoName :: Lens' c Text Source

factInfoNodename :: Lens' c NodeName Source

factInfoVal :: Lens' c PValue Source

Instances

HasFactInfo FactInfo Source

class HasWireCatalog c where Source

Minimal complete definition

wireCatalog

Methods

wireCatalog :: Lens' c WireCatalog Source

wireCatalogEdges :: Lens' c (Vector PuppetEdge) Source

wireCatalogNodename :: Lens' c NodeName Source

wireCatalogResources :: Lens' c (Vector Resource) Source

wireCatalogTransactionUUID :: Lens' c Text Source

wireCatalogVersion :: Lens' c Text Source

Instances

HasWireCatalog WireCatalog Source

Operational instructions

data InterpreterInstr a where Source

Constructors

GetNativeTypes :: InterpreterInstr (Container NativeTypeMethods)
GetStatement :: TopLevelType -> Text -> InterpreterInstr Statement
ComputeTemplate :: Either Text Text -> InterpreterState -> InterpreterInstr Text
ExternalFunction :: Text -> [PValue] -> InterpreterInstr PValue
GetNodeName :: InterpreterInstr Text
HieraQuery :: Container Text -> Text -> HieraQueryType -> InterpreterInstr (Maybe PValue)
GetCurrentCallStack :: InterpreterInstr [String]
IsIgnoredModule :: Text -> InterpreterInstr Bool
IsExternalModule :: Text -> InterpreterInstr Bool
IsStrict :: InterpreterInstr Bool
PuppetPaths :: InterpreterInstr PuppetDirPaths
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

MonadThrowPos InterpreterMonad Source
MonadWriter InterpreterWriter InterpreterMonad Source
MonadError PrettyError InterpreterMonad Source

class HasInterpreterReader c m | c -> m where Source

Minimal complete definition

interpreterReader

Methods

interpreterReader :: Lens' c (InterpreterReader m) Source

readerExternalFunc :: Lens' c (Container ([PValue] -> InterpreterMonad PValue)) Source

readerExternalModules :: Lens' c (HashSet Text) Source

readerGetStatement :: Lens' c (TopLevelType -> Text -> m (Either PrettyError Statement)) Source

readerGetTemplate :: Lens' c (Either Text Text -> InterpreterState -> InterpreterReader m -> m (Either PrettyError Text)) Source

readerHieraQuery :: Lens' c (HieraQueryFunc m) Source

readerIgnoredModules :: Lens' c (HashSet Text) Source

readerIoMethods :: Lens' c (IoMethods m) Source

readerIsStrict :: Lens' c Bool Source

readerNativeTypes :: Lens' c (Container NativeTypeMethods) Source

readerNodename :: Lens' c Text Source

readerPdbApi :: Lens' c (PuppetDBAPI m) Source

readerPuppetPaths :: Lens' c PuppetDirPaths Source

Instances

HasInterpreterReader (InterpreterReader m) m Source

data InterpreterReader m Source

Constructors

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

Instances

HasInterpreterReader (InterpreterReader m) m Source

class HasInterpreterState c where Source

Minimal complete definition

interpreterState

Methods

interpreterState :: Lens' c InterpreterState Source

curPos :: Lens' c PPosition Source

curScope :: Lens' c [CurContainerDesc] Source

definedResources :: Lens' c (HashMap RIdentifier Resource) Source

extraRelations :: Lens' c [LinkInformation] Source

loadedClasses :: Lens' c (Container (Pair ClassIncludeType PPosition)) Source

nestedDeclarations :: Lens' c (HashMap (TopLevelType, Text) Statement) Source

resMod :: Lens' c [ResourceModifier] Source

scopes :: Lens' c (Container ScopeInformation) Source

Instances

HasInterpreterState InterpreterState Source

data InterpreterState Source

Constructors

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

Instances

HasInterpreterState InterpreterState Source
MonadThrowPos InterpreterMonad Source
MonadWriter InterpreterWriter InterpreterMonad Source
MonadError PrettyError InterpreterMonad Source

Sum types

data PValue Source

Constructors

PBoolean !Bool
PUndef
PString !Text
PResourceReference !Text !Text
PArray !(Vector PValue)
PHash !(Container PValue)
PNumber !Scientific

Instances

Eq PValue Source
Show PValue Source
IsString PValue Source
ToJSON PValue Source
FromJSON PValue Source
AsNumber PValue Source
ToRuby PValue Source
FromRuby PValue Source

data CurContainerDesc Source

Constructors

ContRoot	Contained at node or root level
ContClass !Text	Contained in a class
ContDefine !Text !Text !PPosition	Contained in a define, along with the position where this define was ... defined
ContImported !CurContainerDesc	Dummy container for imported resources, so that we know we must update the nodename
ContImport !NodeName !CurContainerDesc	This one is used when finalizing imported resources, and contains the current node name

Instances

Eq CurContainerDesc Source
Ord CurContainerDesc Source
Show CurContainerDesc Source
Generic CurContainerDesc Source
type Rep CurContainerDesc Source

data ResourceCollectorType Source

Constructors

RealizeVirtual
RealizeCollected
DontRealize

Instances

Eq ResourceCollectorType Source
Show ResourceCollectorType Source

data RSearchExpression Source

Constructors

REqualitySearch !Text !PValue
RNonEqualitySearch !Text !PValue
RAndSearch !RSearchExpression !RSearchExpression
ROrSearch !RSearchExpression !RSearchExpression
RAlwaysTrue

Instances

Eq RSearchExpression Source
Show RSearchExpression Source

data Query a Source

Pretty straightforward way to define the various PuppetDB queries

Constructors

QEqual a Text
QG a Integer
QL a Integer
QGE a Integer
QLE a Integer
QMatch Text Text
QAnd [Query a]
QOr [Query a]
QNot (Query a)
QEmpty

Instances

ToJSON a => ToJSON (Query a) Source
FromJSON a => FromJSON (Query a) Source
ToJSON a => ToHttpApiData (Query a) Source

data ModifierType Source

Constructors

ModifierCollector	For collectors, optional resources
ModifierMustMatch	For stuff like realize

Instances

Eq ModifierType Source
Show ModifierType Source

data NodeField Source

Fields for the node endpoint

Instances

ToJSON NodeField Source
FromJSON NodeField Source

data Strictness Source

The intepreter can run in two modes : a strict mode (recommended), and a permissive mode. The permissive mode let known antipatterns work with the interpreter.

Constructors

Strict
Permissive

Instances

Eq Strictness Source
Show Strictness Source
FromJSON Strictness Source

data HieraQueryType Source

The different kind of hiera queries

Constructors

Priority	standard hiera query
ArrayMerge	hiera_array
HashMerge	hiera_hash

data WireCatalog Source

Wire format, see http://docs.puppetlabs.com/puppetdb/1.5/api/wire_format/catalog_format.html.

Constructors

WireCatalog
Fields _wireCatalogNodename :: !NodeName _wireCatalogVersion :: !Text _wireCatalogEdges :: !(Vector PuppetEdge) _wireCatalogResources :: !(Vector Resource) _wireCatalogTransactionUUID :: !Text

Instances

Show WireCatalog Source
ToJSON WireCatalog Source
FromJSON WireCatalog Source
HasWireCatalog WireCatalog Source

data TopLevelType Source

This type is used to differenciate the distinct top level types that are exposed by the DSL.

Constructors

TopNode	This is for node entries.
TopDefine	This is for defines.
TopClass	This is for classes.

Instances

Eq TopLevelType Source
Generic TopLevelType Source
Hashable TopLevelType Source
type Rep TopLevelType Source

data FactField Source

Fields for the fact endpoint

Constructors

FName
FValue
FCertname

Instances

ToJSON FactField Source
FromJSON FactField Source

data ResRefOverride Source

From the evaluation of Resource Override Declaration

Constructors

ResRefOverride
Fields _rrid :: !RIdentifier _rrparams :: !(Container PValue) _rrpos :: !PPosition

Instances

Eq ResRefOverride Source

data ResourceField Source

Fields for the resource endpoint

Constructors

RTag
RCertname
RParameter Text
RType
RTitle
RExported
RFile
RLine

Instances

ToJSON ResourceField Source
FromJSON ResourceField Source

data OverrideType Source

Constructors

CantOverride	Overriding forbidden, will throw an error
Replace	Can silently replace
CantReplace	Silently ignore errors
AppendAttribute	Can append values

Instances

Eq OverrideType Source
Show OverrideType Source

data ClassIncludeType Source

Puppet has two main ways to declare classes: include-like and resource-like https://docs.puppetlabs.com/puppet/latest/reference/lang_classes.html#include-like-vs-resource-like

Constructors

ClassIncludeLike	using the include or contain function
ClassResourceLike	resource like declaration

Instances

Eq ClassIncludeType Source

PuppetDB

data PuppetEdge Source

Used to represent a relationship between two resources within the wired format (json). See http://docs.puppetlabs.com/puppetdb/2.3/api/wire_format/catalog_format_v5.html#data-type-edge

Constructors

PuppetEdge RIdentifier RIdentifier LinkType

Instances

Show PuppetEdge Source
ToJSON PuppetEdge Source
FromJSON PuppetEdge Source

data PuppetDBAPI m Source

Constructors

PuppetDBAPI

Fields

pdbInformation :: m Doc
replaceCatalog :: WireCatalog -> ExceptT PrettyError m (): http://docs.puppetlabs.com/puppetdb/1.5/api/commands.html#replace-catalog-version-3
replaceFacts :: [(NodeName, Facts)] -> ExceptT PrettyError m (): http://docs.puppetlabs.com/puppetdb/1.5/api/commands.html#replace-facts-version-1
deactivateNode :: NodeName -> ExceptT PrettyError m (): http://docs.puppetlabs.com/puppetdb/1.5/api/commands.html#deactivate-node-version-1
getFacts :: Query FactField -> ExceptT PrettyError m [FactInfo]: http://docs.puppetlabs.com/puppetdb/1.5/api/query/v3/facts.html#get-v3facts
getResources :: Query ResourceField -> ExceptT PrettyError m [Resource]: http://docs.puppetlabs.com/puppetdb/1.5/api/query/v3/resources.html#get-v3resources
getNodes :: Query NodeField -> ExceptT PrettyError m [NodeInfo]
commitDB :: ExceptT PrettyError m (): This is only here to tell the test PuppetDB to save its content to disk.
getResourcesOfNode :: NodeName -> Query ResourceField -> ExceptT PrettyError m [Resource]

newtype & synonym

newtype PrettyError Source

Constructors

PrettyError
Fields getError :: Doc

Instances

Show PrettyError Source
IsString PrettyError Source
Exception PrettyError Source
Monoid PrettyError Source
MonadError PrettyError InterpreterMonad Source

type InterpreterMonad = ProgramT InterpreterInstr (State InterpreterState) Source

The main monad

type InterpreterWriter = [Pair Priority Doc] Source

Log

type FinalCatalog = HashMap RIdentifier Resource Source

type NativeTypeValidate = Resource -> Either PrettyError Resource Source

type NodeName = Text Source

type Container = HashMap Text Source

type HieraQueryFunc m Source

Arguments

= Container Text	All the variables that Hiera can interpolate, the top level ones being prefixed with ::
-> Text	The query
-> HieraQueryType
-> m (Either PrettyError (Maybe PValue))

The type of the Hiera API function

type Scope = Text Source

type Facts = Container PValue Source

type EdgeMap = HashMap RIdentifier [LinkInformation] Source

Classes

class Monad m => MonadThrowPos m where Source

Methods

throwPosError :: Doc -> m a Source

Instances

MonadThrowPos InterpreterMonad Source
MonadThrowPos (Either Doc) Source

definitions

metaparameters :: HashSet Text Source

showPos :: Position -> Doc Source