purescript-test-unit

An asynchronous unit test runner for PureScript.

Usage

module Test.Main where

import Test.Unit

main = runTest do
  test "arithmetic" do
    assert "two plus two isn't four" $ (2 + 2) == 4
    assertFalse "two plus two is five" $ (2 + 2) == 5
  test "async asserts" do
    -- run an assert function with a done callback
    assertFn "done callback got a falseness!" \done -> done true
    -- do it again but fail it if it hasn't completed within 100ms
    timeout 100 $ assertFn "yielded false" \done -> done true

Run tests using pulp test or just by compiling with --main Test.Main.

License

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.

You should have received a copy of the GNU Lesser General Public License along with this program. If not, see http://www.gnu.org/licenses/.

Module Test.Unit

Types

type Assertion e = TestUnit e

type Test e = TestUnit e

type TestResult = Either String Unit

type TestUnit e = ErrorT String (ContT Unit (Eff e)) Unit

Values

assert :: forall e. String -> Boolean -> Assertion e

assertC :: forall e. String -> ContT Unit (Eff e) Boolean -> Assertion e

assertFalse :: forall e. String -> Boolean -> Assertion e

assertFn :: forall e. String -> ((Boolean -> Eff e Unit) -> Eff e Unit) -> Assertion e

failure :: String -> TestResult

pickFirst :: forall e. TestUnit (ref :: Ref | e) -> TestUnit (ref :: Ref | e) -> TestUnit (ref :: Ref | e)

runTest :: forall e. Test (testOutput :: TestOutput | e) -> Eff (testOutput :: TestOutput | e) Unit

success :: TestResult

test :: forall e. String -> Assertion (testOutput :: TestOutput | e) -> Test (testOutput :: TestOutput | e)

testC :: forall e. ContT Unit (Eff e) TestResult -> Assertion e

testFn :: forall e. ((TestResult -> Eff e Unit) -> Eff e Unit) -> Assertion e

timeout :: forall e. Number -> TestUnit (ref :: Ref, timer :: Timer.Timer | e) -> TestUnit (ref :: Ref, timer :: Timer.Timer | e)

jonsterling / purescript-test-unit Goto Github PK