Propellor.Property.File

Documentation

type Line = String

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

Replaces all the content of a file.

containsLine :: FilePath -> Line -> Property UnixLike

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

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

lacksLine :: FilePath -> Line -> Property UnixLike

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.

lacksLines :: FilePath -> [Line] -> Property UnixLike

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

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 + UnixLike)

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 + UnixLike)

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

hasPrivContentExposed :: IsContext c => FilePath -> c -> Property (HasInfo + UnixLike)

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 + UnixLike)

hasPrivContent' :: (IsContext c, IsPrivDataSource s) => FileWriteMode -> s -> FilePath -> c -> Property (HasInfo + UnixLike)

basedOn :: FilePath -> (FilePath, [Line] -> [Line]) -> Property UnixLike

Replaces the content of a file with the transformed content of another file

notPresent :: FilePath -> Property UnixLike

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

dirExists :: FilePath -> Property UnixLike

Ensures a directory exists.

newtype LinkTarget

The location that a symbolic link points to.

Constructors

LinkTarget FilePath

isSymlinkedTo :: FilePath -> LinkTarget -> Property UnixLike

Creates or atomically updates a symbolic link.

Does not overwrite regular files or directories.

isCopyOf :: FilePath -> FilePath -> Property UnixLike

Ensures that a file is a copy of another (regular) file.

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

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

mode :: FilePath -> FileMode -> Property UnixLike

Ensures that a file/dir has the specfied mode.

class FileContent c where

Minimal complete definition

emptyFileContent, readFileContent, writeFileContent

Methods

emptyFileContent :: c

readFileContent :: FilePath -> IO c

writeFileContent :: FileWriteMode -> FilePath -> c -> IO ()

Instances

FileContent ByteString

Methods

emptyFileContent :: ByteString

readFileContent :: FilePath -> IO ByteString

writeFileContent :: FileWriteMode -> FilePath -> ByteString -> IO ()

FileContent [Line]

Methods

emptyFileContent :: [Line]

readFileContent :: FilePath -> IO [Line]

writeFileContent :: FileWriteMode -> FilePath -> [Line] -> IO ()

data FileWriteMode

Constructors

NormalWrite

ProtectedWrite

fileProperty :: (FileContent c, Eq c) => Desc -> (c -> c) -> FilePath -> Property UnixLike

A property that applies a pure function to the content of a file.

fileProperty' :: (FileContent c, Eq c) => FileWriteMode -> Desc -> (c -> c) -> FilePath -> Property UnixLike

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.