mirror of
https://github.com/zaphar/ucg.git
synced 2025-07-22 18:19:54 -04:00
92 lines
2.4 KiB
Markdown
92 lines
2.4 KiB
Markdown
+++
|
|
title = "UCG Testing Modules"
|
|
weight = 3
|
|
sort_by = "weight"
|
|
in_search_index = true
|
|
+++
|
|
|
|
The UCG testing modules can be imported like so `let t = import "std/testing.ucg";`
|
|
It has a number of helpful assertions you can use in unit testing.
|
|
|
|
## The asserts modules
|
|
|
|
The asserts module exposes a number of asserts. It contains nested modules for each
|
|
available assertion. You can configure the asserts module with a default description if desired.
|
|
|
|
Each of the asserts results in a `result` field that is a tuple with the shape that
|
|
the assert statement expects.
|
|
|
|
The asserts module has one parameter.
|
|
|
|
* `default_description` which is optional and defaults to "TODO description"
|
|
|
|
### ok assertion
|
|
|
|
The `ok` assertion module tests that something is true. It has two parameters.
|
|
|
|
* `test` which is required and is represents the expression to test.
|
|
* `desc` which is an optional description to output for your test. This defaults to
|
|
the `default_description` that the `asserts` modules was set to.
|
|
|
|
```
|
|
let t = import "std/testing.ucg".asserts{};
|
|
|
|
assert t.ok{
|
|
test=true,
|
|
};
|
|
```
|
|
|
|
### no_ok assertion
|
|
|
|
The `not_ok` assertion module tests that something is not true. It has two
|
|
parameters.
|
|
|
|
* `test` which is required and is represents the expression to test.
|
|
* `desc` which is an optional description to output for your test. This defaults to
|
|
the `default_description` that the `asserts` modules was set to.
|
|
|
|
```
|
|
let t = import "std/testing.ucg".asserts{};
|
|
|
|
assert t.ok{
|
|
test=true,
|
|
};
|
|
```
|
|
|
|
### equal assertion
|
|
|
|
The `equal` assertion module tests that two items are equal. It has three
|
|
parameters.
|
|
|
|
* `left` which is required and is the left hand side expression to compare
|
|
* `right` which is required is the right hand side expression to compare.
|
|
* `desc` which is an optional description to output for your test. This defaults to
|
|
a description created from the compared values.
|
|
|
|
```
|
|
let t = import "std/testing.ucg".asserts{};
|
|
|
|
assert t.equal{
|
|
left=1,
|
|
right=1,
|
|
};
|
|
```
|
|
|
|
### not_equal assertion
|
|
|
|
The `not_equal` assertion module tests that two items are not equal. It has two
|
|
parameters.
|
|
|
|
* `left` which is required and is the left hand side expression to compare
|
|
* `right` which is required is the right hand side expression to compare.
|
|
* `desc` which is an optional description to output for your test. This defaults to
|
|
a description created from the compared values.
|
|
|
|
```
|
|
let t = import "std/testing.ucg".asserts{};
|
|
|
|
assert t.not_equal{
|
|
left=1,
|
|
right=2,
|
|
};
|
|
``` |