Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/restuwahyu13/gocek
Gocek is a simple tools for BDD / TDD testing assertion library for golang.
https://github.com/restuwahyu13/gocek
assertions bdd go gocek golang golang-library integration-testing tdd testing-tool toolkit unit-testing
Last synced: 6 days ago
JSON representation
Gocek is a simple tools for BDD / TDD testing assertion library for golang.
- Host: GitHub
- URL: https://github.com/restuwahyu13/gocek
- Owner: restuwahyu13
- License: mit
- Created: 2022-11-23T10:11:50.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2022-12-17T16:25:20.000Z (almost 2 years ago)
- Last Synced: 2024-06-20T22:34:33.191Z (5 months ago)
- Topics: assertions, bdd, go, gocek, golang, golang-library, integration-testing, tdd, testing-tool, toolkit, unit-testing
- Language: Go
- Homepage:
- Size: 78.1 KB
- Stars: 8
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Gocek
[](https://goreportcard.com/report/github.com/restuwahyu13/gocek)
[](https://github.com/restuwahyu13/gocek/blob/master/CONTRIBUTING.md)
**Gocek** is a simple tools for BDD / TDD testing assertion library for golang, that can be delightfully paired with any golang testing framework or without framework.
## Table Of Content
- [Gocek](#gocek)
- [Table Of Content](#table-of-content)
- [Installation](#installation)
- [API Reference](#api-reference)
- [Testing](#testing)
- [Bugs](#bugs)
- [Contributing](#contributing)
- [License](#license)
## Installation
```bash
go get github.com/restuwahyu13/gocek
```
## API Reference
| **Method** | **Params** | **Type Data** | **Description** |
| -------------------------- | ---------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------- |
| **Expect** | **value** | **interface{}** | `Expect` function is used every time you want to test a value. |
| **Not** | **none** | **-** | `Not` If you know how to test something, .not lets you test its opposite |
| **ToBe** | **value** | **interface{}** | `ToBe` to compare primitive values, but not support for type object like slice, map, struct or array. |
| **ToBeFalsy** | **none** | **-** | `ToBeFalsy` when you don't care what a value is and you want to ensure a value is false in a boolean context. |
| **ToBeGreaterThan** | **value** | **interface{}** | `ToBeGreaterThan `to compare received > expected for number or big integer values |
| **ToBeGreaterThanOrEqual** | **value** | **interface{}** | `ToBeGreaterThan` to compare received >= expected for number or big integer values |
| **ToBeInstanceOf** | **value** | **reflect.Kind** | `ToBeInstanceOf` to check that an object is an instance of a class. This matcher uses instanceof underneath |
| **ToBeLessThan** | **value** | **interface{}** | `ToBeLessThan`to compare received < expected for number or big integer values |
| **ToBeLessThanOrEqual** | **value** | **interface{}** | `ToBeLessThanOrEqual` to compare received <= expected for number or big integer values |
| **ToBeMinus** | **none** | **-** | `ToBeMinus` when you don't care what a value is and you want to ensure a value is minus in a float or integer context. |
| **ToBeNil** | **none** | **-** | `ToBeNil` when you don't care what a value is and you want to ensure a value is nil context. |
| **ToBeTruthy** | **none** | **-** | `ToBeTruthy` when you don't care what a value is and you want to ensure a value is false in a boolean context. |
| **ToBeZero** | **none** | **-** | `ToBeZero` when you don't care what a value is and you want to ensure a value is zero in a integer or float context. |
| **ToContain** | **value** | **string** | `ToContain` when you want to check that an item is in an string |
| **ToEqual** | **value** | **interface{}** | `ToEqual` to compare recursively primitive values or all properties of object instances like slice, map, struct or array. |
| **ToHaveLength** | **value** | **int** | `ToHaveLength` to check that an object has a length property and it is set to a certain numeric value. |
| **ToHaveReturned** | **none** | **-** | `ToHaveReturned` to check function returned value or not |
| **ToMatchObject** | **value** | **interface{}** | `ToMatchObject` to check that a slice, map, struct or array matches a subset of the properties of an object. |
| **ToMatch** | **regex** | **string** | `ToMatch` to check that a string matches a regular expression. |
| **ToBeError** | **none** | **-** | `ToBeError` when you don't care what a value is and you want to ensure a value is error context. |
| **ToHaveReturnedTimes** | **value** | **interface{}** | `ToHaveReturnedTimes` to ensure that a function returned successfully an exact number of times. |
## Testing
- Testing Via Local
```sh
go test .
```
- Testing Via Docker
```sh
docker build -t gocek --compress . && docker run gocek go test --cover -v --failfast .
```
## Bugs
For information on bugs related to package libraries, please visit [here](https://github.com/restuwahyu13/gocek/issues)
## Contributing
Want to make **gocek** more perfect ? Let's contribute and follow the
[contribution guide.](https://github.com/restuwahyu13/gocek/blob/main/CONTRIBUTING.md)
## License
- [MIT License](https://github.com/restuwahyu13/gocek/blob/master/LICENSE.md)