Modulehedgehog-extras-0.10.1.0Haskell2010

Hedgehog.Extras.Test.File

Synopsis

value createDirectoryIfMissing
value createDirectoryIfMissing_
value createSubdirectoryIfMissing
value createSubdirectoryIfMissing_
value copyFile
value renameFile
value createFileLink
value listDirectory
value appendFile
value writeFile
value openFile
value readFile
value lbsWriteFile
value lbsReadFile
value textWriteFile
value textReadFile
value copyRewriteJsonFile
value readJsonFile
value readJsonFileOk
value rewriteJsonFile
value rewriteLbsJson
value copyRewriteYamlFile
value readYamlFile
value readYamlFileOk
value rewriteYamlFile
value rewriteLbsYaml
value cat
value assertIsJsonFile
value assertIsYamlFile
value assertFileExists
value assertFilesExist
value assertFileMissing
value assertFilesMissing
value assertFileOccurences
value assertFileLines
value assertEndsWithSingleNewline
value appendFileTimeDelta
value assertDirectoryMissing
value assertDirectoryExists

Packagehedgehog-extras-0.10.1.0
Exports39
LanguageHaskell2010
LicenceApache-2.0
SourceFile.hs

valuecreateDirectoryIfMissing

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> m FilePath

Source#

Create the directory directory if it is missing.

valuecreateDirectoryIfMissing_

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> m ()

Source#

Create the directory directory if it is missing.

valuecreateSubdirectoryIfMissing

:: (HasCallStack, MonadTest m, MonadIO m)
=> FilePath
-> FilePath
-> m FilePath

Source#

Create the subdirectory subdirectory if it is missing. The subdirectory is returned.

valuecreateSubdirectoryIfMissing_

:: (HasCallStack, MonadTest m, MonadIO m)
=> FilePath
-> FilePath
-> m ()

Source#

Create the subdirectory subdirectory if it is missing. The subdirectory is returned.

valuecopyFile

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> FilePath
-> m ()

Source#

Copy the contents of the src file to the dst file.

valuerenameFile

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> FilePath
-> m ()

Source#

Rename the src file to dst.

valuecreateFileLink

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> FilePath
-> m ()

Source#

Create a symbolic link from dst to src.

valuelistDirectory

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> m [FilePath]

Source#

List p directory.

valueappendFile

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> String
-> m ()

Source#

Append contents to the filePath file.

valuewriteFile

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> String
-> m ()

Source#

Write contents to the filePath file.

valueopenFile

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> IOMode
-> m Handle

Source#

Open a handle to the filePath file.

valuereadFile :: (MonadTest m, MonadIO m, HasCallStack) => FilePath -> m String

Source#

Read the contents of the filePath file.

valuelbsWriteFile

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> ByteString
-> m ()

Source#

Write contents to the filePath file.

valuelbsReadFile

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> m ByteString

Source#

Read the contents of the filePath file.

valuetextWriteFile

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> Text
-> m ()

Source#

Write contents to the filePath file.

valuetextReadFile :: (MonadTest m, MonadIO m, HasCallStack) => FilePath -> m Text

Source#

Read the contents of the filePath file.

valuecopyRewriteJsonFile

:: (MonadTest m, MonadIO m, FromJSON a, ToJSON a, HasCallStack)
=> FilePath
-> FilePath
-> a -> a
-> m ()

Source#

Rewrite the filePath JSON file using the function f.

valuereadJsonFile

:: (MonadTest m, MonadIO m, FromJSON a, HasCallStack)
=> FilePath
-> m (Either String a)

Source#

Read the filePath file as JSON. Use readJsonFile @Value to decode into Value.

valuereadJsonFileOk

:: (MonadTest m, MonadIO m, FromJSON a, HasCallStack)
=> FilePath
-> m a

Source#

Read the filePath file as JSON. Same as readJsonFile but fails on error. Use readJsonFileOk @Value to decode into Value.

valuerewriteJsonFile

:: (MonadTest m, MonadIO m, FromJSON a, ToJSON a, HasCallStack)
=> FilePath
-> a -> a
-> m ()

Source#

Rewrite the filePath JSON file using the function f.

valuerewriteLbsJson

:: (MonadTest m, FromJSON a, ToJSON a, HasCallStack)
=> a -> a
-> ByteString
-> m ByteString

valuecopyRewriteYamlFile

:: (MonadTest m, MonadIO m, FromJSON a, ToJSON a, HasCallStack)
=> FilePath
-> FilePath
-> a -> a
-> m ()

Source#

Rewrite the filePath YAML file using the function f.

valuereadYamlFile

:: (MonadTest m, MonadIO m, FromJSON a, HasCallStack)
=> FilePath
-> m (Either ParseException a)

Source#

Read the filePath file as YAML.

valuereadYamlFileOk

:: (MonadTest m, MonadIO m, FromJSON a, HasCallStack)
=> FilePath
-> m a

Source#

Read the filePath file as YAML. Same as readYamlFile but fails on error.

valuerewriteYamlFile

:: (MonadTest m, MonadIO m, FromJSON a, ToJSON a, HasCallStack)
=> FilePath
-> a -> a
-> m ()

Source#

Rewrite the filePath YAML file using the function f.

valuerewriteLbsYaml

:: (MonadTest m, FromJSON a, ToJSON a, HasCallStack)
=> a -> a
-> ByteString
-> m ByteString

valuecat :: (MonadTest m, MonadIO m, HasCallStack) => FilePath -> m ()

Source#

Annotate the contents of the filePath file.

valueassertIsJsonFile

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> m ()

Source#

Assert the filePath can be parsed as JSON.

valueassertIsYamlFile

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> m ()

Source#

Assert the filePath can be parsed as YAML.

valueassertFileExists

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> m ()

Source#

Asserts that the given file exists.

valueassertFilesExist

:: (MonadTest m, MonadIO m, HasCallStack)
=> [FilePath]
-> m ()

Source#

Asserts that all of the given files exist.

valueassertFileMissing

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> m ()

Source#

Asserts that the given file is missing.

valueassertFilesMissing

:: (MonadTest m, MonadIO m, HasCallStack)
=> [FilePath]
-> m ()

Source#

Asserts that all of the given files are missing.

valueassertFileOccurences

:: (MonadTest m, MonadIO m, HasCallStack)
=> Int
-> String
-> FilePath
-> m ()

Source#

Assert the file contains the given number of occurrences of the given string

valueassertFileLines

:: (MonadTest m, MonadIO m, HasCallStack)
=> Int -> Bool
-> FilePath
-> m ()

Source#

Assert the file contains the given number of occurrences of the given string

valueassertEndsWithSingleNewline

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> m ()

Source#

Assert the file contains the given number of occurrences of the given string

valueappendFileTimeDelta

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> UTCTime
-> m ()

Source#

Write contents to the filePath file.

valueassertDirectoryMissing

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> m ()

Source#

Asserts that the given directory is missing.

valueassertDirectoryExists

:: (MonadTest m, MonadIO m, HasCallStack)
=> FilePath
-> m ()

Source#

Asserts that the given directory exists.