Test.Hspec.Megaparsec

Utility functions for testing Megaparsec parsers with Hspec.

Basic expectations

shouldParse

Arguments

:: (Ord t, ShowToken t, ShowErrorComponent e, Eq a, Show a)

=> Either (ParseError t e) a

Result of parsing as returned by function like parse

-> a

Desired result

-> Expectation

Create an expectation by saying what the result should be.

parse letterChar "" "x" `shouldParse` 'x'

parseSatisfies

Arguments

:: (Ord t, ShowToken t, ShowErrorComponent e, Show a)

=> Either (ParseError t e) a

Result of parsing as returned by function like parse

-> (a -> Bool)

Predicate

-> Expectation

Create an expectation by saying that the parser should successfully parse a value and that the value should satisfy some predicate.

parse (many punctuationChar) "" "?!!" `parseSatisfies` ((== 3) . length)

shouldSucceedOn

Arguments

:: (Ord t, ShowToken t, ShowErrorComponent e, Show a)

=> (s -> Either (ParseError t e) a)

Parser that takes stream and produces result or error message

-> s

Input that the parser should succeed on

-> Expectation

Check that a parser succeeds on some given input.

parse (char 'x') "" `shouldSucceedOn` "x"

shouldFailOn

Arguments

:: Show a

=> (s -> Either (ParseError t e) a)

Parser that takes stream and produces result or error message

-> s

Input that the parser should fail on

-> Expectation

Check that a parser fails on some given input.

parse (char 'x') "" `shouldFailOn` "a"

Testing of error messages

shouldFailWith :: (Ord t, ShowToken t, ShowErrorComponent e, Show a) => Either (ParseError t e) a -> ParseError t e -> Expectation

Create an expectation that parser should fail producing certain ParseError. Use functions from Text.Megaparsec.Error to construct parse errors to check against. See Text.Megaparsec.Pos for functions to construct textual positions.

parse (char 'x') "" "b" `shouldFailWith`
  newErrorMessages [Unexpected "'b'", Expected "'x'"] (initialPos "")

Incremental parsing

failsLeaving

Arguments

:: (Show a, Eq s, Show s, Stream s)

=> (State s, Either (ParseError (Token s) e) a)

Parser that takes stream and produces result along with actual state information

-> s

Part of input that should be left unconsumed

-> Expectation

Check that a parser fails and leaves certain part of input unconsumed. Use it with functions like runParser' and runParserT' that support incremental parsing.

runParser' (many (char 'x') <* eof) (initialState "xxa")
  `failsLeaving` "a"

See also: initialState.

succeedsLeaving

Arguments

:: (ShowToken (Token s), ShowErrorComponent e, Show a, Eq s, Show s, Stream s)

=> (State s, Either (ParseError (Token s) e) a)

Parser that takes stream and produces result along with actual state information

-> s

Part of input that should be left unconsumed

-> Expectation

Check that a parser succeeds and leaves certain part of input unconsumed. Use it with functions like runParser' and runParserT' that support incremental parsing.

runParser' (many (char 'x')) (initialState "xxa")
  `succeedsLeaving` "a"

See also: initialState.

initialState :: s -> State s

Given input for parsing, construct initial state for parser (that is, with empty file name, default tab width and position at 1 line and 1 column).