Skip to content

Commit ab3b91e

Browse files
committed
Make it so.
0 parents  commit ab3b91e

File tree

8 files changed

+1086
-0
lines changed

8 files changed

+1086
-0
lines changed

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
/.psci_modules/
2+
/bower_components/
3+
/output/

COPYING

+674
Large diffs are not rendered by default.

COPYING.LESSER

+165
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,165 @@
1+
GNU LESSER GENERAL PUBLIC LICENSE
2+
Version 3, 29 June 2007
3+
4+
Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
5+
Everyone is permitted to copy and distribute verbatim copies
6+
of this license document, but changing it is not allowed.
7+
8+
9+
This version of the GNU Lesser General Public License incorporates
10+
the terms and conditions of version 3 of the GNU General Public
11+
License, supplemented by the additional permissions listed below.
12+
13+
0. Additional Definitions.
14+
15+
As used herein, "this License" refers to version 3 of the GNU Lesser
16+
General Public License, and the "GNU GPL" refers to version 3 of the GNU
17+
General Public License.
18+
19+
"The Library" refers to a covered work governed by this License,
20+
other than an Application or a Combined Work as defined below.
21+
22+
An "Application" is any work that makes use of an interface provided
23+
by the Library, but which is not otherwise based on the Library.
24+
Defining a subclass of a class defined by the Library is deemed a mode
25+
of using an interface provided by the Library.
26+
27+
A "Combined Work" is a work produced by combining or linking an
28+
Application with the Library. The particular version of the Library
29+
with which the Combined Work was made is also called the "Linked
30+
Version".
31+
32+
The "Minimal Corresponding Source" for a Combined Work means the
33+
Corresponding Source for the Combined Work, excluding any source code
34+
for portions of the Combined Work that, considered in isolation, are
35+
based on the Application, and not on the Linked Version.
36+
37+
The "Corresponding Application Code" for a Combined Work means the
38+
object code and/or source code for the Application, including any data
39+
and utility programs needed for reproducing the Combined Work from the
40+
Application, but excluding the System Libraries of the Combined Work.
41+
42+
1. Exception to Section 3 of the GNU GPL.
43+
44+
You may convey a covered work under sections 3 and 4 of this License
45+
without being bound by section 3 of the GNU GPL.
46+
47+
2. Conveying Modified Versions.
48+
49+
If you modify a copy of the Library, and, in your modifications, a
50+
facility refers to a function or data to be supplied by an Application
51+
that uses the facility (other than as an argument passed when the
52+
facility is invoked), then you may convey a copy of the modified
53+
version:
54+
55+
a) under this License, provided that you make a good faith effort to
56+
ensure that, in the event an Application does not supply the
57+
function or data, the facility still operates, and performs
58+
whatever part of its purpose remains meaningful, or
59+
60+
b) under the GNU GPL, with none of the additional permissions of
61+
this License applicable to that copy.
62+
63+
3. Object Code Incorporating Material from Library Header Files.
64+
65+
The object code form of an Application may incorporate material from
66+
a header file that is part of the Library. You may convey such object
67+
code under terms of your choice, provided that, if the incorporated
68+
material is not limited to numerical parameters, data structure
69+
layouts and accessors, or small macros, inline functions and templates
70+
(ten or fewer lines in length), you do both of the following:
71+
72+
a) Give prominent notice with each copy of the object code that the
73+
Library is used in it and that the Library and its use are
74+
covered by this License.
75+
76+
b) Accompany the object code with a copy of the GNU GPL and this license
77+
document.
78+
79+
4. Combined Works.
80+
81+
You may convey a Combined Work under terms of your choice that,
82+
taken together, effectively do not restrict modification of the
83+
portions of the Library contained in the Combined Work and reverse
84+
engineering for debugging such modifications, if you also do each of
85+
the following:
86+
87+
a) Give prominent notice with each copy of the Combined Work that
88+
the Library is used in it and that the Library and its use are
89+
covered by this License.
90+
91+
b) Accompany the Combined Work with a copy of the GNU GPL and this license
92+
document.
93+
94+
c) For a Combined Work that displays copyright notices during
95+
execution, include the copyright notice for the Library among
96+
these notices, as well as a reference directing the user to the
97+
copies of the GNU GPL and this license document.
98+
99+
d) Do one of the following:
100+
101+
0) Convey the Minimal Corresponding Source under the terms of this
102+
License, and the Corresponding Application Code in a form
103+
suitable for, and under terms that permit, the user to
104+
recombine or relink the Application with a modified version of
105+
the Linked Version to produce a modified Combined Work, in the
106+
manner specified by section 6 of the GNU GPL for conveying
107+
Corresponding Source.
108+
109+
1) Use a suitable shared library mechanism for linking with the
110+
Library. A suitable mechanism is one that (a) uses at run time
111+
a copy of the Library already present on the user's computer
112+
system, and (b) will operate properly with a modified version
113+
of the Library that is interface-compatible with the Linked
114+
Version.
115+
116+
e) Provide Installation Information, but only if you would otherwise
117+
be required to provide such information under section 6 of the
118+
GNU GPL, and only to the extent that such information is
119+
necessary to install and execute a modified version of the
120+
Combined Work produced by recombining or relinking the
121+
Application with a modified version of the Linked Version. (If
122+
you use option 4d0, the Installation Information must accompany
123+
the Minimal Corresponding Source and Corresponding Application
124+
Code. If you use option 4d1, you must provide the Installation
125+
Information in the manner specified by section 6 of the GNU GPL
126+
for conveying Corresponding Source.)
127+
128+
5. Combined Libraries.
129+
130+
You may place library facilities that are a work based on the
131+
Library side by side in a single library together with other library
132+
facilities that are not Applications and are not covered by this
133+
License, and convey such a combined library under terms of your
134+
choice, if you do both of the following:
135+
136+
a) Accompany the combined library with a copy of the same work based
137+
on the Library, uncombined with any other library facilities,
138+
conveyed under the terms of this License.
139+
140+
b) Give prominent notice with the combined library that part of it
141+
is a work based on the Library, and explaining where to find the
142+
accompanying uncombined form of the same work.
143+
144+
6. Revised Versions of the GNU Lesser General Public License.
145+
146+
The Free Software Foundation may publish revised and/or new versions
147+
of the GNU Lesser General Public License from time to time. Such new
148+
versions will be similar in spirit to the present version, but may
149+
differ in detail to address new problems or concerns.
150+
151+
Each version is given a distinguishing version number. If the
152+
Library as you received it specifies that a certain numbered version
153+
of the GNU Lesser General Public License "or any later version"
154+
applies to it, you have the option of following the terms and
155+
conditions either of that published version or of any later version
156+
published by the Free Software Foundation. If the Library as you
157+
received it does not specify a version number of the GNU Lesser
158+
General Public License, you may choose any version of the GNU Lesser
159+
General Public License ever published by the Free Software Foundation.
160+
161+
If the Library as you received it specifies that a proxy can decide
162+
whether future versions of the GNU Lesser General Public License shall
163+
apply, that proxy's public statement of acceptance of any version is
164+
permanent authorization for you to choose that version for the
165+
Library.

README.md

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# purescript-test-unit
2+
3+
An asynchronous unit test runner for PureScript.
4+
5+
## Usage
6+
7+
```purescript
8+
module Test.Main where
9+
10+
import Test.Unit
11+
12+
main = runTest do
13+
test "arithmetic" do
14+
assert "two plus two isn't four" $ (2 + 2) == 4
15+
assertFalse "two plus two is five" $ (2 + 2) == 5
16+
test "async asserts" do
17+
assertFn "done callback got a falseness!" \done -> done true
18+
```
19+
20+
Run tests using [`pulp test`](https://github.com/bodil/pulp) or just
21+
by compiling with `--main Test.Main`.
22+
23+
## License
24+
25+
Copyright 2014 Bodil Stokke
26+
27+
This program is free software: you can redistribute it and/or modify
28+
it under the terms of the GNU Lesser General Public License as
29+
published by the Free Software Foundation, either version 3 of the
30+
License, or (at your option) any later version.
31+
32+
This program is distributed in the hope that it will be useful, but
33+
WITHOUT ANY WARRANTY; without even the implied warranty of
34+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
35+
Lesser General Public License for more details.
36+
37+
You should have received a copy of the GNU Lesser General Public
38+
License along with this program. If not, see
39+
<http://www.gnu.org/licenses/>.
40+
41+
## Module Test.Unit
42+
43+
### Types
44+
45+
type Assertion e = TestUnit e
46+
47+
type Test e = TestUnit e
48+
49+
type TestResult = Either String Unit
50+
51+
type TestUnit e = ErrorT String (ContT Unit (Eff e)) Unit
52+
53+
54+
### Values
55+
56+
assert :: forall e. String -> Boolean -> Assertion e
57+
58+
assertC :: forall e. String -> ContT Unit (Eff e) Boolean -> Assertion e
59+
60+
assertFalse :: forall e. String -> Boolean -> Assertion e
61+
62+
assertFn :: forall e. String -> ((Boolean -> Eff e Unit) -> Eff e Unit) -> Assertion e
63+
64+
failure :: String -> TestResult
65+
66+
runTest :: forall e. Test (testOutput :: TestOutput | e) -> Eff (testOutput :: TestOutput | e) Unit
67+
68+
success :: TestResult
69+
70+
test :: forall e. String -> Assertion (testOutput :: TestOutput | e) -> Test (testOutput :: TestOutput | e)
71+
72+
testC :: forall e. ContT Unit (Eff e) TestResult -> Assertion e
73+
74+
testFn :: forall e. ((TestResult -> Eff e Unit) -> Eff e Unit) -> Assertion e

bower.json

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
{
2+
"name": "purescript-test-unit",
3+
"version": "1.0.0",
4+
"license": "LGPL-3.0+",
5+
"moduleType": [
6+
"node"
7+
],
8+
"ignore": [
9+
"**/.*",
10+
"node_modules",
11+
"bower_components",
12+
"output"
13+
],
14+
"dependencies": {
15+
"purescript-transformers": "~0.3.0"
16+
}
17+
}

src/Test/Unit.purs

+91
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
module Test.Unit
2+
( TestUnit(..)
3+
, Test(..)
4+
, Assertion(..)
5+
, TestResult(..)
6+
, success
7+
, failure
8+
, assert
9+
, assertFalse
10+
, testC
11+
, testFn
12+
, assertC
13+
, assertFn
14+
, test
15+
, runTest
16+
) where
17+
18+
import Control.Monad.Cont.Trans
19+
import Control.Monad.Eff
20+
import Control.Monad.Error.Trans
21+
import Data.Either
22+
import Test.Unit.Console
23+
24+
type TestResult = Either String Unit
25+
type TestUnit e = ErrorT String (ContT Unit (Eff e)) Unit
26+
type Assertion e = TestUnit e
27+
type Test e = TestUnit e
28+
29+
success :: TestResult
30+
success = Right unit
31+
32+
failure :: String -> TestResult
33+
failure = Left
34+
35+
assert :: forall e. String -> Boolean -> Assertion e
36+
assert _ true = ErrorT $ ContT \cb -> cb success
37+
assert reason false = ErrorT $ ContT \cb -> cb $ failure reason
38+
39+
assertFalse :: forall e. String -> Boolean -> Assertion e
40+
assertFalse _ false = ErrorT $ ContT \cb -> cb success
41+
assertFalse reason true = ErrorT $ ContT \cb -> cb $ failure reason
42+
43+
testC :: forall e. (ContT Unit (Eff e) TestResult) -> Assertion e
44+
testC c = ErrorT $ ContT \cb -> runContT c cb
45+
46+
testFn :: forall e. ((TestResult -> Eff e Unit) -> Eff e Unit) -> Assertion e
47+
testFn f = testC $ ContT f
48+
49+
assertC :: forall e. String -> (ContT Unit (Eff e) Boolean) -> Assertion e
50+
assertC reason c = ErrorT $ ContT \cb -> runContT c \res -> if res then cb (Right unit) else cb (Left reason)
51+
52+
assertFn :: forall e. String -> ((Boolean -> Eff e Unit) -> Eff e Unit) -> Assertion e
53+
assertFn reason f = assertC reason $ ContT f
54+
55+
test :: forall e. String -> Assertion (testOutput :: TestOutput | e) -> Test (testOutput :: TestOutput | e)
56+
test l t =
57+
ErrorT $ ContT run
58+
where run cb = do
59+
savePos
60+
print "→ Running: "
61+
printLabel l
62+
runContT (runErrorT t) handler
63+
where handler (Right _) = do
64+
restorePos
65+
eraseLine
66+
printPass "✓ Passed: "
67+
printLabel l
68+
print "\n"
69+
cb success
70+
handler error@(Left reason) = do
71+
restorePos
72+
eraseLine
73+
printFail "☠ Failed: "
74+
printLabel l
75+
print " because "
76+
printFail reason
77+
print "\n"
78+
cb error
79+
80+
foreign import exit """
81+
function exit(rv) {
82+
return function() {
83+
process.exit(rv);
84+
}
85+
}""" :: forall e. Number -> Eff (testOutput :: TestOutput | e) Unit
86+
87+
runTest :: forall e. Test (testOutput :: TestOutput | e) -> Eff (testOutput :: TestOutput | e) Unit
88+
runTest t =
89+
runContT (runErrorT t) handler
90+
where handler (Left reason) = exit 1
91+
handler _ = return unit

0 commit comments

Comments
 (0)