Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/objectionary/eo-hamcrest
Hamcrest Matchers for EO Programming Language
https://github.com/objectionary/eo-hamcrest
eolang hamcrest hamcrest-extensions hamcrest-matchers java tdd testing
Last synced: 3 months ago
JSON representation
Hamcrest Matchers for EO Programming Language
- Host: GitHub
- URL: https://github.com/objectionary/eo-hamcrest
- Owner: objectionary
- License: mit
- Created: 2022-04-20T15:53:00.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-27T16:44:48.000Z (7 months ago)
- Last Synced: 2024-06-27T20:13:26.890Z (7 months ago)
- Topics: eolang, hamcrest, hamcrest-extensions, hamcrest-matchers, java, tdd, testing
- Language: Java
- Homepage:
- Size: 366 KB
- Stars: 15
- Watchers: 3
- Forks: 7
- Open Issues: 33
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://www.elegantobjects.org)
[](http://www.rultor.com/p/objectionary/eo-hamcrest)
[](https://www.jetbrains.com/idea/)
[](https://github.com/objectionary/eo-hamcrest/actions/workflows/mvn.yml)
[](http://www.0pdd.com/p?name=objectionary/eo-hamcrest)
[](https://maven-badges.herokuapp.com/maven-central/org.eolang/eo-hamcrest)
[](https://codecov.io/gh/objectionary/eo-hamcrest)
[](https://github.com/Graur/eo-tests/blob/master/LICENSE.txt)
[](https://codeclimate.com/github/objectionary/eo-hamcrest/maintainability)
[](https://hitsofcode.com/github/graur/eo-hamcrest/view)
This is a collection of test matchers for [EO](https://www.eolang.org) in [Hamcrest](http://hamcrest.org) style, which allow you to make unit tests declarative and elegant. Here is an example of a unit test:
```
+package org.eolang
+alias org.eolang.hamcrest.assert-that
+tests
[] > my-first-test
assert-that > @
4.plus 4
$.all-of
$.equal-to 8
$.less-than 100
"sum of two numbers"
```
The ```assert-that``` object is a stylized sentence for making a test assertion.
In this example, the subject of the assertion is the object ```4.plus 4``` that is the first method parameter. The second method parameter is a `matcher` for the first parameter, here a matcher that checks one object is equal and less than to another objects. The third parameter is an optional string description of the test case (```sum of two numbers```). The test passes since all conditions are ```TRUE```.
### Matchers
Hamcrest comes with a library of useful matchers. Here are some of the most important ones:
###### Core
```
+package org.eolang
+alias org.eolang.hamcrest.assert-that
+tests
[] > core-matchers-test
assert-that > @
5.times 4
$.is
$.anything
"multiply of two numbers"
```
```.anything``` - always matches, useful if you don’t care what the object under test is
```.described-as``` - decorator to adding custom failure description
```.is``` - decorator to improve readability
###### Logical
```
+package org.eolang
+alias org.eolang.hamcrest.assert-that
+tests
[] > logical-matchers-test
assert-that > @
50.minus 10
$.all-of
$.not
$.equal-to 5
$.any-of
$.less-than 100
$.greater-than 1
"substract one number from another"
```
```.all-of``` - matches if all matchers match, short circuits (like Java &&)
```.any-of``` - matches if any matchers match, short circuits (like Java ||)
```.not``` - matches if the wrapped matcher doesn’t match and vice versa
###### Object
```.equal-to``` - the subject of the assertion is equal to some object
###### Collections
```
+package org.eolang
+alias org.eolang.hamcrest.assert-that
+tests
[] > collections-test
assert-that > @
* 50 "t" "smth"
$.array-each
$.equal-to 50
$.equal-to "t"
$.equal-to "smth"
```
```array-each``` - test an array’s elements against an array of matchers
```
+package org.eolang
+alias org.eolang.hamcrest.assert-that
+tests
[] > collections-test
assert-that > @
* 1 5 "f" 12
$.has-item
$.less-than 4
```
```.has-item```, ```.has-items``` - test a collection contains elements
###### Number
```
+package org.eolang
+alias org.eolang.hamcrest.assert-that
+tests
[] > numbers-matchers-test
assert-that > @
31.div 3
$.any-of
$.close-to 10.0 0.1
$.less-than 20
$.greater-than 355
"number of floating point number matchers"
```
```.close-to``` - test floating point values are close to a given value
```.greater-than```, ```.less-than``` - test ordering
###### Text
```
+package org.eolang
+alias org.eolang.hamcrest.assert-that
+tests
[] > text-matchers-test
assert-that > @
"Vice versa!"
$.all-of
$.equal-to-ignoring-case "vice versa!"
$.starts-with "Vice"
$.ends-with "versa!"
$.contains-string "ver"
"text matchers test"
```
```.equal-to-ignoring-case``` - test string equality ignoring case
```.equal-to-ignoring-white-space``` - test string equality ignoring differences in runs of whitespace
```.contains-string,``` ```.ends-with```, ```.starts-with``` - test string matching
More examples are [here](https://github.com/Graur/eo-hamcrest/tree/main/src/test/eo/org/rolang/hamcrest)
## Custom matchers
You can also implement your own matcher by passing parameter to the ```assert-that``` object:
```
+package org.eolang
+alias org.eolang.hamcrest.assert-that
+tests
[] > my-custom-matcher-test
assert-that > @
my-object
my-custom-matcher obj
[obj] > my-custom-matcher
[x] > match
eq. > @
x
obj
[] > describe-mismatch
"mismatch description message" > @
[] > description-of
"expected value description" > @
```
## How to Contribute
Fork this repository, make changes, send us a [pull request](https://www.yegor256.com/2014/04/15/github-guidelines.html).
We will review your changes and apply them to the `master` branch shortly,
provided they don't violate our quality standards. To avoid frustration,
before sending us your pull request please run full Maven build:
```bash
$ mvn clean install -Pqulice
```
You will need Maven 3.3+ and Java 8+.