Safe Haskell	None

Puppet.Interpreter.Types

Synopsis

Documentation

metaparameters :: HashSet Text Source

type Nodename = Text Source

type Container = HashMap Text Source

data PValue Source

Constructors

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

Instances

Eq PValue
Show PValue
IsString PValue
ToJSON PValue
FromJSON PValue
Pretty PValue
FromRuby PValue
ToRuby PValue
StackValue PValue
AsNumber PValue

data HieraQueryType Source

The different kind of hiera queries

Constructors

Priority	standard hiera query
ArrayMerge	hiera_array
HashMerge	hiera_hash

type HieraQueryFunc = Container ScopeInformation -> Text -> HieraQueryType -> IO (Either Doc (Pair InterpreterWriter (Maybe PValue)))Source

The type of the Hiera API function

data RSearchExpression Source

Constructors

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

Instances

Eq RSearchExpression
Pretty RSearchExpression

data ClassIncludeType Source

Constructors

IncludeStandard
IncludeResource

Instances

Eq ClassIncludeType

type Scope = Text Source

type Facts = Container Text 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.
TopSpurious	This one is special. It represents top level statements that are not part of a node, define or class. It is defined as spurious because it is not what you are supposed to be. Also the caching system doesn't like them too much right now.

Instances

Eq TopLevelType
Generic TopLevelType
Pretty TopLevelType
Hashable TopLevelType

data ResDefaults Source

Constructors

ResDefaults
Fields _defType :: !Text _defSrcScope :: !Text _defValues :: !(Container PValue) _defPos :: !PPosition

Instances

Pretty ResDefaults
HasResDefaults ResDefaults

data CurContainerDesc Source

Constructors

ContRoot	Contained at node or root level
ContClass !Text	Contained in a class
ContDefine !Text !Text	Contained in a define
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
Ord CurContainerDesc
Generic CurContainerDesc
Pretty CurContainerDesc

data CurContainer Source

Constructors

CurContainer
Fields _cctype :: !CurContainerDesc _cctags :: !(HashSet Text)

Instances

Eq CurContainer
HasCurContainer CurContainer

data ResRefOverride Source

Constructors

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

Instances

Eq ResRefOverride
HasResRefOverride ResRefOverride

data ScopeInformation Source

Constructors

ScopeInformation
Fields _scopeVariables :: !(Container (Pair (Pair PValue PPosition) CurContainerDesc)) _scopeDefaults :: !(Container ResDefaults) _scopeExtraTags :: !(HashSet Text) _scopeContainer :: !CurContainer _scopeOverrides :: !(HashMap RIdentifier ResRefOverride) _scopeParent :: !(Maybe Text)

Instances

HasScopeInformation ScopeInformation

data InterpreterState Source

Constructors

InterpreterState
Fields _scopes :: !(Container ScopeInformation) _loadedClasses :: !(Container (Pair ClassIncludeType PPosition)) _definedResources :: !(HashMap RIdentifier Resource) _curScope :: ![CurContainerDesc] _curPos :: !PPosition _nestedDeclarations :: !(HashMap (TopLevelType, Text) Statement) _extraRelations :: ![LinkInformation] _resMod :: ![ResourceModifier]

Instances

HasInterpreterState InterpreterState

data InterpreterReader Source

Constructors

InterpreterReader
Fields _nativeTypes :: !(Container PuppetTypeMethods) _getStatement :: TopLevelType -> Text -> IO (Either Doc Statement) _computeTemplateFunction :: Either Text Text -> Text -> Container ScopeInformation -> IO (Either Doc Text) _pdbAPI :: PuppetDBAPI _externalFunctions :: Container ([PValue] -> InterpreterMonad PValue) _thisNodename :: Text _hieraQuery :: HieraQueryFunc

Instances

HasInterpreterReader InterpreterReader

newtype Warning Source

Constructors

Warning Doc

type InterpreterLog = Pair Priority Doc Source

type InterpreterWriter = [InterpreterLog]Source

warn :: (Monad m, MonadWriter InterpreterWriter m) => Doc -> m ()Source

debug :: (Monad m, MonadWriter InterpreterWriter m) => Doc -> m ()Source

logWriter :: (Monad m, MonadWriter InterpreterWriter m) => Priority -> Doc -> m ()Source

type InterpreterMonad = ErrorT Doc (RSST InterpreterReader InterpreterWriter InterpreterState IO)Source

data RIdentifier Source

Constructors

RIdentifier
Fields _itype :: !Text _iname :: !Text

Instances

Eq RIdentifier
Ord RIdentifier
Show RIdentifier
Generic RIdentifier
ToJSON RIdentifier
FromJSON RIdentifier
Pretty RIdentifier
Hashable RIdentifier
HasRIdentifier RIdentifier

data LinkType Source

Relationship link type.

Constructors

RNotify
RRequire
RBefore
RSubscribe

Instances

Eq LinkType
Show LinkType
Generic LinkType
ToJSON LinkType
FromJSON LinkType
Hashable LinkType

data ModifierType Source

Constructors

ModifierCollector	For collectors, optional resources
ModifierMustMatch	For stuff like realize

Instances

Eq ModifierType

data OverrideType Source

Constructors

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

data ResourceCollectorType Source

Constructors

RealizeVirtual
RealizeCollected
DontRealize

Instances

Eq ResourceCollectorType

data ResourceModifier Source

Constructors

ResourceModifier
Fields _rmResType :: !Text _rmModifierType :: !ModifierType _rmType :: !ResourceCollectorType _rmSearch :: !RSearchExpression _rmMutation :: !(Resource -> InterpreterMonad Resource) _rmDeclaration :: !PPosition

Instances

Pretty ResourceModifier
HasResourceModifier ResourceModifier

data LinkInformation Source

Constructors

LinkInformation
Fields _linksrc :: !RIdentifier _linkdst :: !RIdentifier _linkType :: !LinkType _linkPos :: !PPosition

Instances

HasLinkInformation LinkInformation

type EdgeMap = HashMap RIdentifier [LinkInformation]Source

data Resource Source

This is a fully resolved resource that will be used in the FinalCatalog.

Constructors

Resource

Fields

_rid :: !RIdentifier: Resource name.
_ralias :: !(HashSet Text): All the resource aliases
_rattributes :: !(Container PValue): Resource parameters.
_rrelations :: !(HashMap RIdentifier (HashSet LinkType)): Resource relations.
_rscope :: ![CurContainerDesc]: Resource scope when it was defined, the real container will be the first item
_rvirtuality :: !Virtuality
_rtags :: !(HashSet Text)
_rpos :: !PPosition: Source code position of the resource definition.
_rnode :: !Nodename: The node were this resource was created, if remote

Instances

Eq Resource
ToJSON Resource
FromJSON Resource
Pretty Resource
HasResource Resource
HasWResources WireCatalog (Vector Resource)

type PuppetTypeValidate = Resource -> Either Doc Resource Source

This is a function type than can be bound. It is the type of all subsequent validators.

data PuppetTypeMethods Source

Constructors

PuppetTypeMethods
Fields _puppetValidate :: PuppetTypeValidate _puppetFields :: HashSet Text

Instances

HasPuppetTypeMethods PuppetTypeMethods

type FinalCatalog = HashMap RIdentifier Resource Source

data DaemonMethods Source

Constructors

DaemonMethods
Fields _dGetCatalog :: Text -> Facts -> IO (Either Doc (FinalCatalog, EdgeMap, FinalCatalog)) _dParserStats :: MStats _dCatalogStats :: MStats _dTemplateStats :: MStats

Instances

HasDaemonMethods DaemonMethods

data PuppetEdge Source

Constructors

PuppetEdge RIdentifier RIdentifier LinkType

Instances

ToJSON PuppetEdge
FromJSON PuppetEdge
HasWEdges WireCatalog (Vector PuppetEdge)

data WireCatalog Source

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

Constructors

WireCatalog
Fields _wirecatalogNodename :: !Nodename _wirecatalogWVersion :: !Text _wirecatalogWEdges :: !(Vector PuppetEdge) _wirecatalogWResources :: !(Vector Resource) _wirecatalogTransactionUUID :: !Text

data PFactInfo Source

Constructors

PFactInfo
Fields _pfactinfoNodename :: !Text _pfactinfoFactname :: !Text _pfactinfoFactval :: !Text

Instances

ToJSON PFactInfo
FromJSON PFactInfo
HasNodename PFactInfo Text
HasFactval PFactInfo Text
HasFactname PFactInfo Text

data PNodeInfo Source

Constructors

PNodeInfo
Fields _pnodeinfoNodename :: !Nodename _pnodeinfoDeactivated :: !Bool _pnodeinfoCatalogT :: !(Maybe UTCTime) _pnodeinfoFactsT :: !(Maybe UTCTime) _pnodeinfoReportT :: !(Maybe UTCTime)

data PuppetDBAPI Source

Constructors

PuppetDBAPI

Fields

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

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)
FromJSON a => FromJSON (Query a)

data FactField Source

Fields for the fact endpoint

Constructors

FName
FValue
FCertname

Instances

ToJSON FactField
FromJSON FactField

data NodeField Source

Fields for the node endpoint

Constructors

NName
NFact Text

Instances

ToJSON NodeField
FromJSON NodeField

data ResourceField Source

Fields for the resource endpoint

Constructors

RTag
RCertname
RParameter Text
RType
RTitle
RExported
RFile
RLine

Instances

ToJSON ResourceField
FromJSON ResourceField

class HasRIdentifier t whereSource

Methods

rIdentifier :: Lens' t RIdentifier Source

iname :: Lens' t Text Source

itype :: Lens' t Text Source

Instances

HasRIdentifier RIdentifier

class HasResRefOverride t whereSource

Methods

resRefOverride :: Lens' t ResRefOverride Source

rrid :: Lens' t RIdentifier Source

rrparams :: Lens' t (Container PValue)Source

rrpos :: Lens' t PPosition Source

Instances

HasResRefOverride ResRefOverride

class HasLinkInformation t whereSource

Methods

linkInformation :: Lens' t LinkInformation Source

linkPos :: Lens' t PPosition Source

linkType :: Lens' t LinkType Source

linkdst :: Lens' t RIdentifier Source

linksrc :: Lens' t RIdentifier Source

Instances

HasLinkInformation LinkInformation

class HasResDefaults t whereSource

Methods

resDefaults :: Lens' t ResDefaults Source

defPos :: Lens' t PPosition Source

defSrcScope :: Lens' t Text Source

defType :: Lens' t Text Source

defValues :: Lens' t (Container PValue)Source

Instances

HasResDefaults ResDefaults

class HasResourceModifier t whereSource

Methods

resourceModifier :: Lens' t ResourceModifier Source

rmDeclaration :: Lens' t PPosition Source

rmModifierType :: Lens' t ModifierType Source

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

rmResType :: Lens' t Text Source

rmSearch :: Lens' t RSearchExpression Source

rmType :: Lens' t ResourceCollectorType Source

Instances

HasResourceModifier ResourceModifier

class HasDaemonMethods t whereSource

Methods

daemonMethods :: Lens' t DaemonMethods Source

dCatalogStats :: Lens' t MStats Source

dGetCatalog :: Lens' t (Text -> Facts -> IO (Either Doc (FinalCatalog, EdgeMap, FinalCatalog)))Source

dParserStats :: Lens' t MStats Source

dTemplateStats :: Lens' t MStats Source

Instances

HasDaemonMethods DaemonMethods

class HasPuppetTypeMethods t whereSource

Methods

puppetTypeMethods :: Lens' t PuppetTypeMethods Source

puppetFields :: Lens' t (HashSet Text)Source

puppetValidate :: Lens' t PuppetTypeValidate Source

Instances

HasPuppetTypeMethods PuppetTypeMethods

class HasScopeInformation t whereSource

Methods

scopeInformation :: Lens' t ScopeInformation Source

scopeContainer :: Lens' t CurContainer Source

scopeDefaults :: Lens' t (Container ResDefaults)Source

scopeExtraTags :: Lens' t (HashSet Text)Source

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

scopeParent :: Lens' t (Maybe Text)Source

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

Instances

HasScopeInformation ScopeInformation

class HasResource t whereSource

Methods

resource :: Lens' t Resource Source

ralias :: Lens' t (HashSet Text)Source

rattributes :: Lens' t (Container PValue)Source

rid :: Lens' t RIdentifier Source

rnode :: Lens' t Nodename Source

rpos :: Lens' t PPosition Source

rrelations :: Lens' t (HashMap RIdentifier (HashSet LinkType))Source

rscope :: Lens' t [CurContainerDesc]Source

rtags :: Lens' t (HashSet Text)Source

rvirtuality :: Lens' t Virtuality Source

Instances

HasResource Resource

class HasInterpreterState t whereSource

Methods

interpreterState :: Lens' t InterpreterState Source

curPos :: Lens' t PPosition Source

curScope :: Lens' t [CurContainerDesc]Source

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

extraRelations :: Lens' t [LinkInformation]Source

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

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

resMod :: Lens' t [ResourceModifier]Source

scopes :: Lens' t (Container ScopeInformation)Source

Instances

HasInterpreterState InterpreterState

class HasInterpreterReader t whereSource

Methods

interpreterReader :: Lens' t InterpreterReader Source

computeTemplateFunction :: Lens' t (Either Text Text -> Text -> Container ScopeInformation -> IO (Either Doc Text))Source

externalFunctions :: Lens' t (Container ([PValue] -> InterpreterMonad PValue))Source

getStatement :: Lens' t (TopLevelType -> Text -> IO (Either Doc Statement))Source

hieraQuery :: Lens' t HieraQueryFunc Source

nativeTypes :: Lens' t (Container PuppetTypeMethods)Source

pdbAPI :: Lens' t PuppetDBAPI Source

thisNodename :: Lens' t Text Source

Instances

HasInterpreterReader InterpreterReader

class HasCurContainer t whereSource

Methods

curContainer :: Lens' t CurContainer Source

cctags :: Lens' t (HashSet Text)Source

cctype :: Lens' t CurContainerDesc Source

Instances

HasCurContainer CurContainer

class HasNodename c e | c -> e whereSource

Methods

nodename :: Lens' c eSource

Instances

HasNodename PNodeInfo Nodename
HasNodename PFactInfo Text
HasNodename WireCatalog Nodename

class HasWVersion c e | c -> e whereSource

Methods

wVersion :: Lens' c eSource

Instances

HasWVersion WireCatalog Text

class HasWEdges c e | c -> e whereSource

Methods

wEdges :: Lens' c eSource

Instances

HasWEdges WireCatalog (Vector PuppetEdge)

class HasWResources c e | c -> e whereSource

Methods

wResources :: Lens' c eSource

Instances

HasWResources WireCatalog (Vector Resource)

class HasTransactionUUID c e | c -> e whereSource

Methods

transactionUUID :: Lens' c eSource

Instances

HasTransactionUUID WireCatalog Text

_wirecatalogWVersionLens :: Lens' WireCatalog Text Source

_wirecatalogWResourcesLens :: Lens' WireCatalog (Vector Resource)Source

_wirecatalogWEdgesLens :: Lens' WireCatalog (Vector PuppetEdge)Source

_wirecatalogTransactionUUIDLens :: Lens' WireCatalog Text Source

_wirecatalogNodenameLens :: Lens' WireCatalog Nodename Source

class HasFactname c e | c -> e whereSource

Methods

factname :: Lens' c eSource

Instances

HasFactname PFactInfo Text

class HasFactval c e | c -> e whereSource

Methods

factval :: Lens' c eSource

Instances

HasFactval PFactInfo Text

_pfactinfoNodenameLens :: Lens' PFactInfo Text Source

_pfactinfoFactvalLens :: Lens' PFactInfo Text Source

_pfactinfoFactnameLens :: Lens' PFactInfo Text Source

class HasDeactivated c e | c -> e whereSource

Methods

deactivated :: Lens' c eSource

Instances

HasDeactivated PNodeInfo Bool

class HasCatalogT c e | c -> e whereSource

Methods

catalogT :: Lens' c eSource

Instances

HasCatalogT PNodeInfo (Maybe UTCTime)

class HasFactsT c e | c -> e whereSource

Methods

factsT :: Lens' c eSource

Instances

HasFactsT PNodeInfo (Maybe UTCTime)

class HasReportT c e | c -> e whereSource

Methods

reportT :: Lens' c eSource

Instances

HasReportT PNodeInfo (Maybe UTCTime)

_pnodeinfoReportTLens :: Lens' PNodeInfo (Maybe UTCTime)Source

_pnodeinfoNodenameLens :: Lens' PNodeInfo Nodename Source

_pnodeinfoFactsTLens :: Lens' PNodeInfo (Maybe UTCTime)Source

_pnodeinfoDeactivatedLens :: Lens' PNodeInfo Bool Source

_pnodeinfoCatalogTLens :: Lens' PNodeInfo (Maybe UTCTime)Source

rcurcontainer :: Resource -> CurContainerDesc Source

throwPosError :: Doc -> InterpreterMonad aSource

getCurContainer :: InterpreterMonad CurContainer Source

scopeName :: CurContainerDesc -> Text Source

getScopeName :: InterpreterMonad Text Source

getScope :: InterpreterMonad CurContainerDesc Source

eitherDocIO :: IO (Either Doc a) -> IO (Either Doc a)Source

interpreterIO :: IO (Either Doc a) -> InterpreterMonad aSource

safeDecodeUtf8 :: ByteString -> InterpreterMonad Text Source

interpreterError :: InterpreterMonad (Either Doc a) -> InterpreterMonad aSource

resourceRelations :: Resource -> [(RIdentifier, LinkType)]Source

ifromList :: (Monoid m, At m) => [(Index m, IxValue m)] -> mSource

helper for hashmap, in case we want another kind of map ..

ikeys :: (Eq k, Hashable k) => HashMap k v -> HashSet kSource

isingleton :: (Monoid b, At b) => Index b -> IxValue b -> bSource

ifromListWith :: (Monoid m, At m) => (IxValue m -> IxValue m -> IxValue m) -> [(Index m, IxValue m)] -> mSource

iinsertWith :: At m => (IxValue m -> IxValue m -> IxValue m) -> Index m -> IxValue m -> m -> mSource

iunionWith :: (Hashable k, Eq k) => (v -> v -> v) -> HashMap k v -> HashMap k v -> HashMap k vSource

fnull :: (Eq x, Monoid x) => x -> Bool Source

rel2text :: LinkType -> Text Source

rid2text :: RIdentifier -> Text Source

text2Scientific :: Text -> Maybe Scientific Source

scientific2Number :: Scientific -> Number Source

text2Number :: Text -> Maybe Number Source

ToJSON WireCatalog
FromJSON WireCatalog
HasTransactionUUID WireCatalog Text
HasWVersion WireCatalog Text
HasNodename WireCatalog Nodename
HasWResources WireCatalog (Vector Resource)
HasWEdges WireCatalog (Vector PuppetEdge)

ToJSON PNodeInfo
FromJSON PNodeInfo
HasNodename PNodeInfo Nodename
HasDeactivated PNodeInfo Bool
HasReportT PNodeInfo (Maybe UTCTime)
HasFactsT PNodeInfo (Maybe UTCTime)
HasCatalogT PNodeInfo (Maybe UTCTime)