Propellor.Property

Documentation

property :: Desc -> Propellor Result -> Property

propertyList :: Desc -> [Property] -> Property

Combines a list of properties, resulting in a single property that when run will run each property in the list in turn, and print out the description of each as it's run. Does not stop on failure; does propigate overall success/failure.

combineProperties :: Desc -> [Property] -> Property

Combines a list of properties, resulting in one property that ensures each in turn. Does not stop on failure; does propigate overall success/failure.

before :: Property -> Property -> Property

Combines together two properties, resulting in one property that ensures the first, and if the first succeeds, ensures the second. The property uses the description of the first property.

flagFile :: Property -> FilePath -> Property

Makes a perhaps non-idempotent Property be idempotent by using a flag file to indicate whether it has run before. Use with caution.

flagFile' :: Property -> IO FilePath -> Property

onChange :: Property -> Property -> Property

(==>) :: Desc -> Property -> Property infixl 1

check :: IO Bool -> Property -> Property

Makes a Property only need to do anything when a test succeeds.

trivial :: Property -> Property

Marks a Property as trivial. It can only return FailedChange or NoChange.

Useful when it's just as expensive to check if a change needs to be made as it is to just idempotently assure the property is satisfied. For example, chmodding a file.

doNothing :: Property

withOS :: Desc -> (Maybe System -> Propellor Result) -> Property

Makes a property that is satisfied differently depending on the host's operating system.

Note that the operating system may not be declared for some hosts.

boolProperty :: Desc -> IO Bool -> Property

revert :: RevertableProperty -> RevertableProperty

Undoes the effect of a property.

host :: HostName -> Host

Starts accumulating the properties of a Host.

host "example.com"
	& someproperty
	! oldproperty
	& otherproperty

(&) :: IsProp p => Host -> p -> Host infixl 1

Adds a property to a Host

Can add Properties and RevertableProperties

(!) :: Host -> RevertableProperty -> Host infixl 1

Adds a property to the Host in reverted form.

(&^) :: IsProp p => Host -> p -> Host infixl 1

Like (&), but adds the property as the first property of the host. Normally, property order should not matter, but this is useful when it does.

adjustProperty :: Property -> (Propellor Result -> Propellor Result) -> Property

combineInfo :: (IsProp p, IsProp q) => p -> q -> Info

combineInfos :: IsProp p => [p] -> Info

makeChange :: IO () -> Propellor Result

noChange :: Propellor Result