Futhark.Test.Spec

Definition and parsing of a test specification.

Documentation

testSpecFromProgram :: FilePath -> IO (Either String ProgramTest)

Read the test specification from the given Futhark program.

testSpecFromProgramOrDie :: FilePath -> IO ProgramTest

Like testSpecFromProgram, but exits the process on error.

testSpecsFromPaths :: [FilePath] -> IO (Either String [(FilePath, ProgramTest)])

Read test specifications from the given paths, which can be a files or directories containing .fut files and further directories.

testSpecsFromPathsOrDie :: [FilePath] -> IO [(FilePath, ProgramTest)]

Like testSpecsFromPaths, but kills the process on errors.

testSpecFromFile :: FilePath -> IO (Either String ProgramTest)

Read a test specification from a file. Expects only a single block, and no comment prefixes.

testSpecFromFileOrDie :: FilePath -> IO ProgramTest

Like testSpecFromFile, but kills the process on errors.

data ProgramTest

Description of a test to be carried out on a Futhark program. The Futhark program is stored separately.

Constructors

ProgramTest

Fields

• testDescription :: Text
• testTags :: [Text]
• testAction :: TestAction

Instances

Show ProgramTest

Defined in Futhark.Test.Spec

Methods

showsPrec :: Int -> ProgramTest -> ShowS

show :: ProgramTest -> String

showList :: [ProgramTest] -> ShowS

data StructureTest

A structure test specifies a compilation pipeline, as well as metrics for the program coming out the other end.

Constructors

StructureTest StructurePipeline AstMetrics

Instances

Show StructureTest

Defined in Futhark.Test.Spec

Methods

showsPrec :: Int -> StructureTest -> ShowS

show :: StructureTest -> String

showList :: [StructureTest] -> ShowS

data StructurePipeline

How a program can be transformed.

Constructors

GpuPipeline

MCPipeline

SOACSPipeline

SeqMemPipeline

GpuMemPipeline

MCMemPipeline

NoPipeline

Instances

Show StructurePipeline

Defined in Futhark.Test.Spec

Methods

showsPrec :: Int -> StructurePipeline -> ShowS

show :: StructurePipeline -> String

showList :: [StructurePipeline] -> ShowS

data WarningTest

A warning test requires that a warning matching the regular expression is produced. The program must also compile succesfully.

Constructors

ExpectedWarning Text Regex

Instances

Show WarningTest

Defined in Futhark.Test.Spec

Methods

showsPrec :: Int -> WarningTest -> ShowS

show :: WarningTest -> String

showList :: [WarningTest] -> ShowS

data TestAction

How to test a program.

Constructors

CompileTimeFailure ExpectedError

RunCases [InputOutputs] [StructureTest] [WarningTest]

Instances

Show TestAction

Defined in Futhark.Test.Spec

Methods

showsPrec :: Int -> TestAction -> ShowS

show :: TestAction -> String

showList :: [TestAction] -> ShowS

data ExpectedError

The error expected for a negative test.

Constructors

AnyError

ThisError Text Regex

Instances

Show ExpectedError

Defined in Futhark.Test.Spec

Methods

showsPrec :: Int -> ExpectedError -> ShowS

show :: ExpectedError -> String

showList :: [ExpectedError] -> ShowS

data InputOutputs

Input and output pairs for some entry point(s).

Constructors

InputOutputs

Fields

• iosEntryPoint :: Text
• iosTestRuns :: [TestRun]

Instances

Show InputOutputs

Defined in Futhark.Test.Spec

Methods

showsPrec :: Int -> InputOutputs -> ShowS

show :: InputOutputs -> String

showList :: [InputOutputs] -> ShowS

data TestRun

A condition for execution, input, and expected result.

Constructors

TestRun

Fields

• runTags :: [String]
• runInput :: Values
• runExpectedResult :: ExpectedResult Success
• runIndex :: Int
• runDescription :: Text

Instances

Show TestRun

Defined in Futhark.Test.Spec

Methods

showsPrec :: Int -> TestRun -> ShowS

show :: TestRun -> String

showList :: [TestRun] -> ShowS

data ExpectedResult values

How a test case is expected to terminate.

Constructors

Succeeds (Maybe values)

Execution suceeds, with or without expected result values.

RunTimeFailure ExpectedError

Execution fails with this error.

Instances

Show values => Show (ExpectedResult values)

Defined in Futhark.Test.Spec

Methods

showsPrec :: Int -> ExpectedResult values -> ShowS

show :: ExpectedResult values -> String

showList :: [ExpectedResult values] -> ShowS

data Success

The result expected from a succesful execution.

Constructors

SuccessValues Values

These values are expected.

SuccessGenerateValues

Compute expected values from executing a known-good reference implementation.

Instances

Show Success

Defined in Futhark.Test.Spec

Methods

showsPrec :: Int -> Success -> ShowS

show :: Success -> String

showList :: [Success] -> ShowS

data Values

Several values - either literally, or by reference to a file, or to be generated on demand. All paths are relative to test program.

Constructors

Values [Value]

InFile FilePath

GenValues [GenValue]

ScriptValues Exp

ScriptFile FilePath

Instances

Show Values

Defined in Futhark.Test.Spec

Methods

showsPrec :: Int -> Values -> ShowS

show :: Values -> String

showList :: [Values] -> ShowS

data GenValue

How to generate a single random value.

Constructors

GenValue ValueType

Generate a value of the given rank and primitive type. Scalars are considered 0-ary arrays.

GenPrim Value

A fixed non-randomised primitive value.

Instances

Show GenValue

Defined in Futhark.Test.Spec

Methods

showsPrec :: Int -> GenValue -> ShowS

show :: GenValue -> String

showList :: [GenValue] -> ShowS

genValueType :: GenValue -> Text

A prettyprinted representation of type of value produced by a GenValue.