https://github.com/leanovate/gopter

GOlang Property TestER
https://github.com/leanovate/gopter

golang golang-property-tester property-based-testing

Last synced: 15 days ago
JSON representation

GOlang Property TestER

• Host: GitHub
• URL: https://github.com/leanovate/gopter
• Owner: leanovate
• License: mit
• Created: 2016-02-11T07:20:49.000Z (almost 9 years ago)
• Default Branch: master
• Last Pushed: 2024-04-03T11:46:02.000Z (7 months ago)
• Last Synced: 2024-08-01T15:06:15.814Z (3 months ago)
• Topics: golang, golang-property-tester, property-based-testing
• Language: Go
• Homepage:
• Size: 366 KB
• Stars: 599
• Watchers: 11
• Forks: 41
• Open Issues: 15
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# GOPTER

... the GOlang Property TestER

[![Build Status](https://travis-ci.org/leanovate/gopter.svg?branch=master)](https://travis-ci.org/leanovate/gopter)

[![codecov](https://codecov.io/gh/leanovate/gopter/branch/master/graph/badge.svg)](https://codecov.io/gh/leanovate/gopter)

[![GoDoc](https://godoc.org/github.com/leanovate/gopter?status.png)](https://godoc.org/github.com/leanovate/gopter)

[![Go Report Card](https://goreportcard.com/badge/github.com/leanovate/gopter)](https://goreportcard.com/report/github.com/leanovate/gopter)

[Change Log](CHANGELOG.md)

## Synopsis

Gopter tries to bring the goodness of [ScalaCheck](https://www.scalacheck.org/) (and implicitly, the goodness of [QuickCheck](http://hackage.haskell.org/package/QuickCheck)) to Go.

It can also be seen as a more sophisticated version of the testing/quick package.

Main differences to ScalaCheck:

* It is Go ... duh

* ... nevertheless: Do not expect the same typesafety and elegance as in ScalaCheck.

* For simplicity [Shrink](https://javadoc.io/doc/org.scalacheck/scalacheck_2.11/1.14.1/index.html#org.scalacheck.Shrink) has become part of the generators. They can still be easily changed if necessary.

* There is no [Pretty](https://javadoc.io/doc/org.scalacheck/scalacheck_2.11/1.14.1/index.html#org.scalacheck.util.Pretty) ... so far gopter feels quite comfortable being ugly.

* A generator for regex matches

* No parallel commands ... yet?

Main differences to the testing/quick package:

* Much tighter control over generators

* Shrinkers, i.e. automatically find the minimum value falsifying a property

* A generator for regex matches (already mentioned that ... but it's cool)

* Support for stateful tests

## Documentation

Current godocs:

* [gopter](https://godoc.org/github.com/leanovate/gopter):  Main interfaces

* [gopter/gen](https://godoc.org/github.com/leanovate/gopter/gen): All commonly used generators

* [gopter/prop](https://godoc.org/github.com/leanovate/gopter/prop): Common helpers to create properties from a condition function and specific generators

* [gopter/arbitrary](https://godoc.org/github.com/leanovate/gopter/arbitrary): Helpers automatically combine generators for arbitrary types

* [gopter/commands](https://godoc.org/github.com/leanovate/gopter/commands): Helpers to create stateful tests based on arbitrary commands

* [gopter/convey](https://godoc.org/github.com/leanovate/gopter/convey): Helpers used by gopter inside goconvey tests

## License

[MIT Licence](http://opensource.org/licenses/MIT)