Propellor.Types

Core data types

data Host

Everything Propellor knows about a system: Its hostname, properties and their collected info.

Constructors

Host

Fields

• hostName :: HostName
• hostProperties :: [ChildProperty]
• hostInfo :: Info

Instances

Show Host

Defined in Propellor.Types.Core

Methods

showsPrec :: Int -> Host -> ShowS

show :: Host -> String

showList :: [Host] -> ShowS

IsContainer Host

Defined in Propellor.Container

Methods

containerProperties :: Host -> [ChildProperty]

containerInfo :: Host -> Info

setContainerProperties :: Host -> [ChildProperty] -> Host

Conductable Host

Defined in Propellor.Property.Conductor

Methods

conducts :: Host -> RevertableProperty (HasInfo + UnixLike) (HasInfo + UnixLike)

MonadReader Host Propellor

Defined in Propellor.Types.Core

Methods

ask :: Propellor Host

local :: (Host -> Host) -> Propellor a -> Propellor a

reader :: (Host -> a) -> Propellor a

Conductable [Host]

Defined in Propellor.Property.Conductor

Methods

conducts :: [Host] -> RevertableProperty (HasInfo + UnixLike) (HasInfo + UnixLike)

data Property metatypes

The core data type of Propellor, this represents a property that the system should have, with a description, and an action to ensure it has the property.

There are different types of properties that target different OS's, and so have different metatypes. For example: "Property DebianLike" and "Property FreeBSD".

Also, some properties have associated Info, which is indicated in their type: "Property (HasInfo + DebianLike)"

There are many associated type families, which are mostly used internally, so you needn't worry about them.

Constructors

Property metatypes Desc (Maybe (Propellor Result)) Info [ChildProperty]

Instances

TightenTargets Property

Defined in Propellor.Types

Methods

tightenTargets :: forall (untightened :: [MetaType]) (tightened :: [MetaType]). (TightenTargetsAllowed untightened tightened, SingI tightened) => Property (MetaTypes untightened) -> Property (MetaTypes tightened)

Checkable Property i

Defined in Propellor.Types.ResultCheck

Methods

checkedProp :: Property i -> Property i

preCheckedProp :: Property i -> Property i

SingI metatypes => Monoid (Property (MetaTypes metatypes))

Any type of Property is a Monoid.

Defined in Propellor.Types

Methods

mempty :: Property (MetaTypes metatypes)

mappend :: Property (MetaTypes metatypes) -> Property (MetaTypes metatypes) -> Property (MetaTypes metatypes)

mconcat :: [Property (MetaTypes metatypes)] -> Property (MetaTypes metatypes)

SingI metatypes => Semigroup (Property (MetaTypes metatypes))

Any type of Property is a Semigroup. When properties x and y are appended together, the resulting property has a description like "x and y". Note that when x fails to be ensured, it will not try to ensure y.

Defined in Propellor.Types

Methods

(<>) :: Property (MetaTypes metatypes) -> Property (MetaTypes metatypes) -> Property (MetaTypes metatypes)

sconcat :: NonEmpty (Property (MetaTypes metatypes)) -> Property (MetaTypes metatypes)

stimes :: Integral b => b -> Property (MetaTypes metatypes) -> Property (MetaTypes metatypes)

Show (Property metatypes)

Defined in Propellor.Types

Methods

showsPrec :: Int -> Property metatypes -> ShowS

show :: Property metatypes -> String

showList :: [Property metatypes] -> ShowS

IsProp (Property metatypes)

Defined in Propellor.Types

Methods

setDesc :: Property metatypes -> Desc -> Property metatypes

getDesc :: Property metatypes -> Desc

getChildren :: Property metatypes -> [ChildProperty]

addChildren :: Property metatypes -> [ChildProperty] -> Property metatypes

getInfoRecursive :: Property metatypes -> Info

getInfo :: Property metatypes -> Info

toChildProperty :: Property metatypes -> ChildProperty

getSatisfy :: Property metatypes -> Maybe (Propellor Result)

(CheckCombinable x y, SingI (Combine x y)) => Combines (Property (MetaTypes x)) (Property (MetaTypes y))

Defined in Propellor.Types

Methods

combineWith :: ResultCombiner -> ResultCombiner -> Property (MetaTypes x) -> Property (MetaTypes y) -> CombinedType (Property (MetaTypes x)) (Property (MetaTypes y))

(CheckCombinable x y, SingI (Combine x y)) => Combines (Property (MetaTypes x)) (RevertableProperty (MetaTypes y) (MetaTypes y'))

Defined in Propellor.Types

Methods

combineWith :: ResultCombiner -> ResultCombiner -> Property (MetaTypes x) -> RevertableProperty (MetaTypes y) (MetaTypes y') -> CombinedType (Property (MetaTypes x)) (RevertableProperty (MetaTypes y) (MetaTypes y'))

(CheckCombinable x y, SingI (Combine x y)) => Combines (RevertableProperty (MetaTypes x) (MetaTypes x')) (Property (MetaTypes y))

Defined in Propellor.Types

Methods

combineWith :: ResultCombiner -> ResultCombiner -> RevertableProperty (MetaTypes x) (MetaTypes x') -> Property (MetaTypes y) -> CombinedType (RevertableProperty (MetaTypes x) (MetaTypes x')) (Property (MetaTypes y))

property :: SingI metatypes => Desc -> Propellor Result -> Property (MetaTypes metatypes)

Constructs a Property, from a description and an action to run to ensure the Property is met.

Due to the polymorphic return type of this function, most uses will need to specify a type signature. This lets you specify what OS the property targets, etc.

For example:

 foo :: Property Debian
 foo = property "foo" $ do
	...
 	return MadeChange

property'' :: SingI metatypes => Desc -> Maybe (Propellor Result) -> Property (MetaTypes metatypes)

type Desc = String

data RevertableProperty setupmetatypes undometatypes

A property that can be reverted. The first Property is run normally and the second is run when it's reverted.

See Versioned for a way to use RevertableProperty to define different versions of a host.

Constructors

RevertableProperty

Fields

• setupRevertableProperty :: Property setupmetatypes
• undoRevertableProperty :: Property undometatypes

Instances

(CheckCombinable x y, SingI (Combine x y)) => Combines (Property (MetaTypes x)) (RevertableProperty (MetaTypes y) (MetaTypes y'))

Defined in Propellor.Types

Methods

combineWith :: ResultCombiner -> ResultCombiner -> Property (MetaTypes x) -> RevertableProperty (MetaTypes y) (MetaTypes y') -> CombinedType (Property (MetaTypes x)) (RevertableProperty (MetaTypes y) (MetaTypes y'))

(Monoid (Property (MetaTypes setupmetatypes)), Monoid (Property (MetaTypes undometatypes)), SingI setupmetatypes, SingI undometatypes) => Monoid (RevertableProperty (MetaTypes setupmetatypes) (MetaTypes undometatypes))

Defined in Propellor.Types

Methods

mempty :: RevertableProperty (MetaTypes setupmetatypes) (MetaTypes undometatypes)

mappend :: RevertableProperty (MetaTypes setupmetatypes) (MetaTypes undometatypes) -> RevertableProperty (MetaTypes setupmetatypes) (MetaTypes undometatypes) -> RevertableProperty (MetaTypes setupmetatypes) (MetaTypes undometatypes)

mconcat :: [RevertableProperty (MetaTypes setupmetatypes) (MetaTypes undometatypes)] -> RevertableProperty (MetaTypes setupmetatypes) (MetaTypes undometatypes)

(Semigroup (Property (MetaTypes setupmetatypes)), Semigroup (Property (MetaTypes undometatypes)), SingI setupmetatypes, SingI undometatypes) => Semigroup (RevertableProperty (MetaTypes setupmetatypes) (MetaTypes undometatypes))

Any type of RevertableProperty is a Semigroup. When revertable properties x and y are appended together, the resulting revertable property has a description like "x and y". Note that when x fails to be ensured, it will not try to ensure y.

Defined in Propellor.Types

Methods

(<>) :: RevertableProperty (MetaTypes setupmetatypes) (MetaTypes undometatypes) -> RevertableProperty (MetaTypes setupmetatypes) (MetaTypes undometatypes) -> RevertableProperty (MetaTypes setupmetatypes) (MetaTypes undometatypes)

sconcat :: NonEmpty (RevertableProperty (MetaTypes setupmetatypes) (MetaTypes undometatypes)) -> RevertableProperty (MetaTypes setupmetatypes) (MetaTypes undometatypes)

stimes :: Integral b => b -> RevertableProperty (MetaTypes setupmetatypes) (MetaTypes undometatypes) -> RevertableProperty (MetaTypes setupmetatypes) (MetaTypes undometatypes)

Show (RevertableProperty setupmetatypes undometatypes)

Defined in Propellor.Types

Methods

showsPrec :: Int -> RevertableProperty setupmetatypes undometatypes -> ShowS

show :: RevertableProperty setupmetatypes undometatypes -> String

showList :: [RevertableProperty setupmetatypes undometatypes] -> ShowS

IsProp (RevertableProperty setupmetatypes undometatypes)

Defined in Propellor.Types

Methods

setDesc :: RevertableProperty setupmetatypes undometatypes -> Desc -> RevertableProperty setupmetatypes undometatypes

getDesc :: RevertableProperty setupmetatypes undometatypes -> Desc

getChildren :: RevertableProperty setupmetatypes undometatypes -> [ChildProperty]

addChildren :: RevertableProperty setupmetatypes undometatypes -> [ChildProperty] -> RevertableProperty setupmetatypes undometatypes

getInfoRecursive :: RevertableProperty setupmetatypes undometatypes -> Info

getInfo :: RevertableProperty setupmetatypes undometatypes -> Info

toChildProperty :: RevertableProperty setupmetatypes undometatypes -> ChildProperty

getSatisfy :: RevertableProperty setupmetatypes undometatypes -> Maybe (Propellor Result)

(CheckCombinable x y, SingI (Combine x y)) => Combines (RevertableProperty (MetaTypes x) (MetaTypes x')) (Property (MetaTypes y))

Defined in Propellor.Types

Methods

combineWith :: ResultCombiner -> ResultCombiner -> RevertableProperty (MetaTypes x) (MetaTypes x') -> Property (MetaTypes y) -> CombinedType (RevertableProperty (MetaTypes x) (MetaTypes x')) (Property (MetaTypes y))

(CheckCombinable x y, CheckCombinable x' y', SingI (Combine x y), SingI (Combine x' y')) => Combines (RevertableProperty (MetaTypes x) (MetaTypes x')) (RevertableProperty (MetaTypes y) (MetaTypes y'))

Defined in Propellor.Types

Methods

combineWith :: ResultCombiner -> ResultCombiner -> RevertableProperty (MetaTypes x) (MetaTypes x') -> RevertableProperty (MetaTypes y) (MetaTypes y') -> CombinedType (RevertableProperty (MetaTypes x) (MetaTypes x')) (RevertableProperty (MetaTypes y) (MetaTypes y'))

(<!>) :: Property setupmetatypes -> Property undometatypes -> RevertableProperty setupmetatypes undometatypes

Shorthand to construct a revertable property from any two Properties.

newtype Propellor p

Propellor's monad provides read-only access to info about the host it's running on, and a writer to accumulate EndActions.

Constructors

Propellor

Fields

• runWithHost :: RWST Host [EndAction] () IO p

Instances

MonadIO Propellor

Defined in Propellor.Types.Core

Methods

liftIO :: IO a -> Propellor a

Applicative Propellor

Defined in Propellor.Types.Core

Methods

pure :: a -> Propellor a

(<*>) :: Propellor (a -> b) -> Propellor a -> Propellor b

liftA2 :: (a -> b -> c) -> Propellor a -> Propellor b -> Propellor c

(*>) :: Propellor a -> Propellor b -> Propellor b

(<*) :: Propellor a -> Propellor b -> Propellor a

Functor Propellor

Defined in Propellor.Types.Core

Methods

fmap :: (a -> b) -> Propellor a -> Propellor b

(<$) :: a -> Propellor b -> Propellor a

Monad Propellor

Defined in Propellor.Types.Core

Methods

(>>=) :: Propellor a -> (a -> Propellor b) -> Propellor b

(>>) :: Propellor a -> Propellor b -> Propellor b

return :: a -> Propellor a

MonadCatch Propellor

Defined in Propellor.Types.Core

Methods

catch :: Exception e => Propellor a -> (e -> Propellor a) -> Propellor a

MonadMask Propellor

Defined in Propellor.Types.Core

Methods

mask :: ((forall a. Propellor a -> Propellor a) -> Propellor b) -> Propellor b

uninterruptibleMask :: ((forall a. Propellor a -> Propellor a) -> Propellor b) -> Propellor b

generalBracket :: Propellor a -> (a -> ExitCase b -> Propellor c) -> (a -> Propellor b) -> Propellor (b, c)

MonadThrow Propellor

Defined in Propellor.Types.Core

Methods

throwM :: Exception e => e -> Propellor a

LiftPropellor Propellor

Defined in Propellor.Types.Core

Methods

liftPropellor :: Propellor a -> Propellor a

MonadReader Host Propellor

Defined in Propellor.Types.Core

Methods

ask :: Propellor Host

local :: (Host -> Host) -> Propellor a -> Propellor a

reader :: (Host -> a) -> Propellor a

Monoid (Propellor Result)

Defined in Propellor.Types.Core

Methods

mempty :: Propellor Result

mappend :: Propellor Result -> Propellor Result -> Propellor Result

mconcat :: [Propellor Result] -> Propellor Result

Semigroup (Propellor Result)

When two actions are appended together, the second action is only run if the first action does not fail.

Defined in Propellor.Types.Core

Methods

(<>) :: Propellor Result -> Propellor Result -> Propellor Result

sconcat :: NonEmpty (Propellor Result) -> Propellor Result

stimes :: Integral b => b -> Propellor Result -> Propellor Result

MonadWriter [EndAction] Propellor

Defined in Propellor.Types.Core

Methods

writer :: (a, [EndAction]) -> Propellor a

tell :: [EndAction] -> Propellor ()

listen :: Propellor a -> Propellor (a, [EndAction])

pass :: Propellor (a, [EndAction] -> [EndAction]) -> Propellor a

class LiftPropellor m where

Methods

liftPropellor :: m a -> Propellor a

Instances

LiftPropellor IO

Defined in Propellor.Types.Core

Methods

liftPropellor :: IO a -> Propellor a

LiftPropellor Propellor

Defined in Propellor.Types.Core

Methods

liftPropellor :: Propellor a -> Propellor a

data Info

Information about a Host, which can be provided by its properties.

Many different types of data can be contained in the same Info value at the same time. See toInfo and fromInfo.

Instances

Monoid Info

Defined in Propellor.Types.Info

Methods

mempty :: Info

mappend :: Info -> Info -> Info

mconcat :: [Info] -> Info

Semigroup Info

Defined in Propellor.Types.Info

Methods

(<>) :: Info -> Info -> Info

sconcat :: NonEmpty Info -> Info

stimes :: Integral b => b -> Info -> Info

Show Info

Defined in Propellor.Types.Info

Methods

showsPrec :: Int -> Info -> ShowS

show :: Info -> String

showList :: [Info] -> ShowS

Types of properties

type UnixLike = MetaTypes '['Targeting 'OSDebian, 'Targeting 'OSBuntish, 'Targeting 'OSArchLinux, 'Targeting 'OSFreeBSD]

Any unix-like system

type Linux = MetaTypes '['Targeting 'OSDebian, 'Targeting 'OSBuntish, 'Targeting 'OSArchLinux]

Any linux system

type DebianLike = MetaTypes '['Targeting 'OSDebian, 'Targeting 'OSBuntish]

Debian and derivatives.

type Debian = MetaTypes '['Targeting 'OSDebian]

type Buntish = MetaTypes '['Targeting 'OSBuntish]

type ArchLinux = MetaTypes '['Targeting 'OSArchLinux]

type FreeBSD = MetaTypes '['Targeting 'OSFreeBSD]

type HasInfo = MetaTypes '['WithInfo]

Used to indicate that a Property adds Info to the Host where it's used.

type family a + b :: Type where ...

Convenience type operator to combine two MetaTypes lists.

For example:

HasInfo + Debian

Which is shorthand for this type:

MetaTypes '[WithInfo, Targeting OSDebian]

Equations

(MetaTypes a) + (MetaTypes b) = MetaTypes (Concat a b)

class TightenTargets p where

Methods

tightenTargets :: (TightenTargetsAllowed untightened tightened, SingI tightened) => p (MetaTypes untightened) -> p (MetaTypes tightened)

Tightens the MetaType list of a Property (or similar), to contain fewer targets.

For example, to make a property that uses apt-get, which is only available on DebianLike systems:

upgraded :: Property DebianLike
upgraded = tightenTargets $ cmdProperty "apt-get" ["upgrade"]

Instances

TightenTargets Property

Defined in Propellor.Types

Methods

tightenTargets :: forall (untightened :: [MetaType]) (tightened :: [MetaType]). (TightenTargetsAllowed untightened tightened, SingI tightened) => Property (MetaTypes untightened) -> Property (MetaTypes tightened)

TightenTargets UncheckedProperty

Defined in Propellor.Types.ResultCheck

Methods

tightenTargets :: forall (untightened :: [MetaType]) (tightened :: [MetaType]). (TightenTargetsAllowed untightened tightened, SingI tightened) => UncheckedProperty (MetaTypes untightened) -> UncheckedProperty (MetaTypes tightened)

type family TightenTargetsAllowed untightened tightened :: Constraint where ...

Equations

TightenTargetsAllowed untightened tightened = If ((Targets tightened `IsSubset` Targets untightened) && (NonTargets untightened `IsSubset` NonTargets tightened)) ('True ~ 'True) (IfStuck (Targets tightened) (DelayError ('Text "Unable to infer desired Property type in this use of tightenTargets." :$$: 'Text "Consider adding a type annotation.")) (DelayErrorFcf ('Text "This use of tightenTargets would widen, not narrow, adding: " :$$: PrettyPrintMetaTypes (Difference (Targets tightened) (Targets untightened)))))

Combining and modifying properties

class Combines x y where

Methods

combineWith

Arguments

:: ResultCombiner

How to combine the actions to satisfy the properties.

-> ResultCombiner

Used when combining revertable properties, to combine their reversion actions.

-> x

-> y

-> CombinedType x y

Combines together two properties, yielding a property that has the description and info of the first, and that has the second property as a child property.

Instances

(CheckCombinable x y, SingI (Combine x y)) => Combines (Property (MetaTypes x)) (Property (MetaTypes y))

Defined in Propellor.Types

Methods

combineWith :: ResultCombiner -> ResultCombiner -> Property (MetaTypes x) -> Property (MetaTypes y) -> CombinedType (Property (MetaTypes x)) (Property (MetaTypes y))

(CheckCombinable x y, SingI (Combine x y)) => Combines (Property (MetaTypes x)) (RevertableProperty (MetaTypes y) (MetaTypes y'))

Defined in Propellor.Types

Methods

combineWith :: ResultCombiner -> ResultCombiner -> Property (MetaTypes x) -> RevertableProperty (MetaTypes y) (MetaTypes y') -> CombinedType (Property (MetaTypes x)) (RevertableProperty (MetaTypes y) (MetaTypes y'))

(CheckCombinable x y, SingI (Combine x y)) => Combines (RevertableProperty (MetaTypes x) (MetaTypes x')) (Property (MetaTypes y))

Defined in Propellor.Types

Methods

combineWith :: ResultCombiner -> ResultCombiner -> RevertableProperty (MetaTypes x) (MetaTypes x') -> Property (MetaTypes y) -> CombinedType (RevertableProperty (MetaTypes x) (MetaTypes x')) (Property (MetaTypes y))

(CheckCombinable x y, CheckCombinable x' y', SingI (Combine x y), SingI (Combine x' y')) => Combines (RevertableProperty (MetaTypes x) (MetaTypes x')) (RevertableProperty (MetaTypes y) (MetaTypes y'))

Defined in Propellor.Types

Methods

combineWith :: ResultCombiner -> ResultCombiner -> RevertableProperty (MetaTypes x) (MetaTypes x') -> RevertableProperty (MetaTypes y) (MetaTypes y') -> CombinedType (RevertableProperty (MetaTypes x) (MetaTypes x')) (RevertableProperty (MetaTypes y) (MetaTypes y'))

type family CombinedType x y where ...

Type level calculation of the type that results from combining two types of properties.

Equations

CombinedType (Property (MetaTypes x)) (Property (MetaTypes y)) = Property (MetaTypes (Combine x y))

CombinedType (RevertableProperty (MetaTypes x) (MetaTypes x')) (RevertableProperty (MetaTypes y) (MetaTypes y')) = RevertableProperty (MetaTypes (Combine x y)) (MetaTypes (Combine x' y'))

CombinedType (RevertableProperty (MetaTypes x) (MetaTypes x')) (Property (MetaTypes y)) = Property (MetaTypes (Combine x y))

CombinedType (Property (MetaTypes x)) (RevertableProperty (MetaTypes y) (MetaTypes y')) = Property (MetaTypes (Combine x y))

type ResultCombiner = Maybe (Propellor Result) -> Maybe (Propellor Result) -> Maybe (Propellor Result)

adjustPropertySatisfy :: Property metatypes -> (Propellor Result -> Propellor Result) -> Property metatypes

Changes the action that is performed to satisfy a property.

Other included types

module Propellor.Types.OS

module Propellor.Types.ConfigurableValue

module Propellor.Types.Dns

module Propellor.Types.Result

module Propellor.Types.ZFS