Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/llorllale/cactoos-matchers
Elegant object-oriented hamcrest matchers
https://github.com/llorllale/cactoos-matchers
cactoos elegantobjects hamcrest-matchers java junit oop unit-test
Last synced: 21 days ago
JSON representation
Elegant object-oriented hamcrest matchers
- Host: GitHub
- URL: https://github.com/llorllale/cactoos-matchers
- Owner: llorllale
- License: other
- Created: 2018-05-07T19:32:13.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2021-06-27T15:15:05.000Z (over 3 years ago)
- Last Synced: 2024-04-15T02:09:08.277Z (7 months ago)
- Topics: cactoos, elegantobjects, hamcrest-matchers, java, junit, oop, unit-test
- Language: Java
- Homepage:
- Size: 482 KB
- Stars: 32
- Watchers: 10
- Forks: 21
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://www.0crat.com/p/C63314D6Z)
[](https://www.0crat.com/contrib/C63314D6Z)
[](http://www.elegantobjects.org)
[](http://www.rultor.com/p/llorllale/cactoos-matchers)
[](https://github.com/llorllale/cactoos-matchers/actions)
[](http://www.javadoc.io/doc/org.llorllale/cactoos-matchers)
[](http://www.0pdd.com/p?name=llorllale/cactoos-matchers)
[](https://maven-badges.herokuapp.com/maven-central/org.llorllale/cactoos-matchers)
[](https://github.com/llorllale/cactoos-matchers/blob/master/LICENSE.txt)
[](https://codecov.io/github/llorllale/cactoos-matchers?branch=master)
[](https://sonarcloud.io/dashboard?id=org.llorllale%3Acactoos-matchers)
[](#contributors-)
## What it is
**cactoos-matchers** is an object-oriented wrapper around hamcrest's matchers.
## Principles
[Design principles](http://www.elegantobjects.org#principles) behind cactoos-matchers.
## How to use
This library depends on [cactoos](https://github.com/yegor256/cactoos) and [hamcrest](https://github.com/hamcrest/JavaHamcrest).
Get the latest version [here](https://github.com/llorllale/cactoos-matchers/releases):
```xml
org.llorllale
cactoos-matchers
${version}
```
Java version required: 1.8+.
## cactoos-matchers versus Hamcrest + JUnit
cactoos-matchers | Hamcrest (static method) | Hamcrest (object) | JUnit
------ | ------ | ------ | ------
`Assertion` | `MatcherAssert.assertThat` | - | `Assert.assertThat`
`Throws` | - | - | `@expected` + `ExpectedException`
`EndsWith` | `Matchers.endsWith` | `StringEndsWith` | -
`StartsWith` | `Matcers.startsWith` | `StringStartsWith` | -
`TextIs` | `Matchers.is` | `IsEqual` | -
`HasLines` | - | - | -
`MatchesRegex` | - | - | -
`TextHasString` | `Matchers.stringContainsInOrder` | `StringContains` | -
`FuncApplies` | - | - | -
`HasValues` | `Matchers.containsInAnyOrder` | `IsIterableContainingInAnyOrder` | -
`HasValuesMatching` | `Matchers.containsInAnyOrder` | `IsIterableContainingInAnyOrder` | -
`InputHasContent` | - | - | -
`IsTrue` | - | - | `Assert.assertTrue`
`Matches` | - | - | -
`RunsInThreads` | - | - | -
`ScalarHasValue` | - | - | -
## How to use
Use our matchers inside your JUnit [`@Test`](http://junit.sourceforge.net/javadoc/org/junit/Test.html) case. We also provide `Assertion` in which you can compose the behavior under test and the test case's matcher, and attempt to affirm it.
We provide matchers for several different domains:
### Text
Examples:
```java
@Test
public void textHasPrefix() {
final String prefix = "Application startup";
new Assertion<>(
"must have the prefix",
new TextOf(new File("some.log")),
new StartsWith(prefix)
).affirm();
}
@Test
public void csvLineHasCorrectFormat() throws Exception {
final String fields = "^[^|]+|[^|]+|[^|]+$";
new Assertion<>(
"must match the expected pattern",
new FirstOf<>(
line -> true,
new Split(
new TextOf(new File("report.csv")),
"\n"
),
() -> new TextOf("")
).value(),
new MatchesRegex(fields)
).affirm();
}
@Test
public void textIsBlank(){
new Assertion<>(
"must be blank",
new TextOf(
new File("file.txt")
),
new IsBlank()
).affirm();
}
```
### Concurrency
Examples:
*RunsInThreads*
```java
/**
* Want some assurance that your object is thread-safe?
*/
@Test
public void threadSafety() {
new Assertion<>(
"must be able to modify the map concurrently",
map -> {
boolean success = true;
try {
map.forEach(
(key, value) -> {
map.remove(key);
final Random r = new Random();
map.put(r.nextInt(), r.nextInt());
}
);
} catch (ConcurrentModificationException ex) {
success = false;
}
return success;
},
new RunsInThreads<>(new ConcurrentHashMap<>(), 100)
).affirm();
}
```
### Matching errors
Examples:
```java
@Test
public void throwIllegalArgumentExceptionIfLessThan10() throws Exception {
final Func test = input -> {
if (input < 10) {
throw new IllegalArgumentException();
}
return input * 10;
};
new Assertion<>(
"must throw illegalargumentexception if input is less than 10",
() -> test.apply(5),
new Throws<>(IllegalArgumentException.class)
).affirm();
}
```
### Meta-matching: a matcher to test your matchers
Examples:
Use `Matches` to test matchers themselves:
```java
@Test
public void matchExactString() {
new Assertion<>(
"must match the exact text",
new TextIs("abc"), // matcher being tested
new Matches<>(new TextOf("abc")) // reference against which the matcher is tested
).affirm();
}
```
## How to contribute?
Just fork the repo and send us a pull request.
Request to add yourself to the list of [contributors](#contributors-) below with
the [`@all-contributors bot`](https://allcontributors.org/docs/en/bot/usage#all-contributors-add).
Make sure your branch builds without any warnings/issues:
```
mvn clean install -Pqulice
```
Note: [Checkstyle](https://en.wikipedia.org/wiki/Checkstyle) is used as a static code analyze tool with
[checks list](http://checkstyle.sourceforge.net/checks.html) in GitHub precommits.
## License (MIT)
Copyright (c) for portions of project cactoos-matchers are held by
Yegor Bugayenko, 2017-2018, as part of project cactoos.
All other copyright for project cactoos-matchers are held by
George Aristy, 2018-2020.
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included
in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
## Contributors ✨
George Aristy
💻
Yegor Bugayenko
💻
Roman Proshin
💻
Yurii Dubinka
💻
andreoss
💻
Victor Noël
💻
Dominik
💻
Stefano Cristalli
💻
Fevzi Anifieiev
💻
Paulo Lobo
💻
Vedran Grgo Vatavuk
💻
Alexander
💻
vzurauskas
💻
jsoroka
💻