Skip to content

Commit

Permalink
rename to tester
Browse files Browse the repository at this point in the history
  • Loading branch information
hydrolarus committed May 10, 2021
1 parent bfd7870 commit 2dbaa8a
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 14 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ SPDX-FileCopyrightText: 2021 The test-idr developers
SPDX-License-Identifier: CC0-1.0
-->

# `test-idr`
# `tester-idr`

A testing framework for Idris 2.

Expand All @@ -13,27 +13,27 @@ A testing framework for Idris 2.
At least version `0.3.0` of the Idris 2 compiler is required.

```sh
idris2 --install test.ipkg
idris2 --install tester.ipkg
```

## Usage

After installing the package, add `test` to the `depends` section in the `.ipkg` file.
After installing the package, add `tester` to the `depends` section in the `.ipkg` file.

To construct a `Test`, use the `test` function from the `Test` module.
To construct a `Test`, use the `test` function from the `Tester` module.

Multiple assertion functions are provided in the `Test` module as well.
Multiple assertion functions are provided in the `Tester` module as well.

```idris
itWorks = test "it works" $ do
assertEq (1 + 1) 2
```

To run a series of tests, the `runTests` function in `Test.Runner` can be used.
To run a series of tests, the `runTests` function in `Tester.Runner` can be used.

```idris
import Test
import Test.Runner
import Tester
import Tester.Runner
tests : List Test
tests = [
Expand Down
2 changes: 1 addition & 1 deletion src/Test.idr → src/Tester.idr
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
--
-- SPDX-License-Identifier: MPL-2.0

module Test
module Tester

import public Control.Monad.Either
import Data.Strings
Expand Down
4 changes: 2 additions & 2 deletions src/Test/Runner.idr → src/Tester/Runner.idr
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@
--
-- SPDX-License-Identifier: MPL-2.0

module Test.Runner
module Tester.Runner

import Test
import Tester
import Data.List


Expand Down
7 changes: 4 additions & 3 deletions test.ipkg → tester.ipkg
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,13 @@
--
-- SPDX-License-Identifier: CC0-1.0

package test
package tester
version = 0.1.0

depends = contrib

modules =
Test,
Test.Runner
Tester,
Tester.Runner

sourcedir = "src"

0 comments on commit 2dbaa8a

Please sign in to comment.