Propellor.Property.File

Documentation

type Line = String

hasContent :: FilePath -> [Line] -> Property NoInfo

Replaces all the content of a file.

hasContentProtected :: FilePath -> [Line] -> Property NoInfo

Replaces all the content of a file, ensuring that its modes do not allow it to be read or written by anyone other than the current user

hasPrivContent :: IsContext c => FilePath -> c -> Property HasInfo

Ensures a file has contents that comes from PrivData.

The file's permissions are preserved if the file already existed. Otherwise, they're set to 600.

hasPrivContentFrom :: (IsContext c, IsPrivDataSource s) => s -> FilePath -> c -> Property HasInfo

Like hasPrivContent, but allows specifying a source for PrivData, rather than using PrivDataSourceFile .

hasPrivContentExposed :: IsContext c => FilePath -> c -> Property HasInfo

Leaves the file at its default or current mode, allowing "private" data to be read.

Use with caution!

hasPrivContentExposedFrom :: (IsContext c, IsPrivDataSource s) => s -> FilePath -> c -> Property HasInfo

hasPrivContent' :: (IsContext c, IsPrivDataSource s) => (FilePath -> String -> IO ()) -> s -> FilePath -> c -> Property HasInfo

containsLine :: FilePath -> Line -> Property NoInfo

Ensures that a line is present in a file, adding it to the end if not.

containsLines :: FilePath -> [Line] -> Property NoInfo

lacksLine :: FilePath -> Line -> Property NoInfo

Ensures that a line is not present in a file. Note that the file is ensured to exist, so if it doesn't, an empty file will be written.

notPresent :: FilePath -> Property NoInfo

Removes a file. Does not remove symlinks or non-plain-files.

fileProperty :: Desc -> ([Line] -> [Line]) -> FilePath -> Property NoInfo

fileProperty' :: (FilePath -> String -> IO ()) -> Desc -> ([Line] -> [Line]) -> FilePath -> Property NoInfo

dirExists :: FilePath -> Property NoInfo

Ensures a directory exists.

newtype LinkTarget

The location that a symbolic link points to.

Constructors

LinkTarget FilePath

isSymlinkedTo :: FilePath -> LinkTarget -> Property NoInfo

Creates or atomically updates a symbolic link.

Does not overwrite regular files or directories.

ownerGroup :: FilePath -> User -> Group -> Property NoInfo

Ensures that a file/dir has the specified owner and group.

mode :: FilePath -> FileMode -> Property NoInfo

Ensures that a file/dir has the specfied mode.

stableTmpFor :: FilePath -> FilePath

A temp file to use when writing new content for a file.

This is a stable name so it can be removed idempotently.

It ends with "~" so that programs that read many config files from a directory will treat it as an editor backup file, and not read it.

viaStableTmp :: (MonadMask m, MonadIO m) => (FilePath -> m ()) -> FilePath -> m ()

Creates/updates a file atomically, running the action to create the stable tmp file, and then renaming it into place.