You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
95 lines
2.5 KiB
95 lines
2.5 KiB
5 years ago
|
Remix Assert Library
|
||
|
|
====================
|
||
|
|
|
||
|
|
* [Assert.ok(value[, message])](#assert-ok-value-message)
|
||
|
|
* [Assert.equal(actual, expected[, message])](#assert-equal-actual-expected-message)
|
||
|
|
* [Assert.notEqual(actual, expected[, message])](#assert-notequal-actual-expected-message)
|
||
|
|
* [Assert.greaterThan(value1, value2[, message])](#assert-greaterthan-value1-value2-message)
|
||
|
|
* [Assert.lesserThan(value1, value2[, message])](#assert-lesserthan-value1-value2-message)
|
||
|
|
|
||
|
|
|
||
|
|
## Assert
|
||
|
|
|
||
|
|
### Assert.ok(value[, message])
|
||
|
|
* `value`: \<bool\>
|
||
|
|
* `message`: \<string\>
|
||
|
|
|
||
|
|
Tests if value is truthy. `message` is returned in case of failure.
|
||
|
|
|
||
|
|
Examples:
|
||
|
|
```
|
||
|
|
Assert.ok(true);
|
||
|
|
// OK
|
||
|
|
Assert.ok(false, "it\'s false");
|
||
|
|
// error: it's false
|
||
|
|
```
|
||
|
|
|
||
|
|
### Assert.equal(actual, expected[, message])
|
||
|
|
* `actual`: \<uint | int | bool | address | bytes32 | string\>
|
||
|
|
* `expected`: \<uint | int | bool | address | bytes32 | string\>
|
||
|
|
* `message`: \<string\>
|
||
|
|
|
||
|
|
Tests if `actual` & `expected` values are same. `message` is returned in case of failure.
|
||
|
|
|
||
|
|
Examples:
|
||
|
|
```
|
||
|
|
Assert.equal(string("a"), "a");
|
||
|
|
// OK
|
||
|
|
Assert.equal(uint(100), 100);
|
||
|
|
// OK
|
||
|
|
foo.set(200)
|
||
|
|
Assert.equal(foo.get(), 200);
|
||
|
|
// OK
|
||
|
|
Assert.equal(foo.get(), 100, "value should be 200");
|
||
|
|
// error: value should be 200
|
||
|
|
```
|
||
|
|
|
||
|
|
### Assert.notEqual(actual, expected[, message])
|
||
|
|
* `actual`: \<uint | int | bool | address | bytes32 | string\>
|
||
|
|
* `expected`: \<uint | int | bool | address | bytes32 | string\>
|
||
|
|
* `message`: \<string\>
|
||
|
|
|
||
|
|
Tests if `actual` & `expected` values are not same. `message` is returned in case of failure.
|
||
|
|
|
||
|
|
Examples:
|
||
|
|
```
|
||
|
|
Assert.notEqual(string("a"), "b");
|
||
|
|
// OK
|
||
|
|
foo.set(200)
|
||
|
|
Assert.notEqual(foo.get(), 200, "value should not be 200");
|
||
|
|
// error: value should not be 200
|
||
|
|
```
|
||
|
|
|
||
|
|
### Assert.greaterThan(value1, value2[, message])
|
||
|
|
* `value1`: \<uint | int\>
|
||
|
|
* `value2`: \<uint | int\>
|
||
|
|
* `message`: \<string\>
|
||
|
|
|
||
|
|
Tests if `value1` is greater than `value2`. `message` is returned in case of failure.
|
||
|
|
|
||
|
|
Examples:
|
||
|
|
```
|
||
|
|
Assert.greaterThan(uint(2), uint(1));
|
||
|
|
// OK
|
||
|
|
Assert.greaterThan(uint(-2), uint(1));
|
||
|
|
// OK
|
||
|
|
Assert.greaterThan(int(2), int(1));
|
||
|
|
// OK
|
||
|
|
Assert.greaterThan(int(-2), int(-1), "-2 is not greater than -1");
|
||
|
|
// error: -2 is not greater than -1
|
||
|
|
```
|
||
|
|
|
||
|
|
### Assert.lesserThan(value1, value2[, message])
|
||
|
|
* `value1`: \<uint | int\>
|
||
|
|
* `value2`: \<uint | int\>
|
||
|
|
* `message`: \<string\>
|
||
|
|
|
||
|
|
Tests if `value1` is lesser than `value2`. `message` is returned in case of failure.
|
||
|
|
|
||
|
|
Examples:
|
||
|
|
```
|
||
|
|
Assert.lesserThan(int(-2), int(-1));
|
||
|
|
// OK
|
||
|
|
Assert.lesserThan(int(2), int(1), "2 is not lesser than 1");
|
||
|
|
// error: 2 is not greater than 1
|
||
|
|
```
|