aboutsummaryrefslogtreecommitdiff
path: root/vendor/github.com/onsi/ginkgo/README.md
diff options
context:
space:
mode:
authordependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>2020-06-01 10:55:39 +0000
committerDaniel J Walsh <dwalsh@redhat.com>2020-06-02 07:22:54 -0400
commit288bb2e858521dc8b90c33c4b8bcd83ddba15997 (patch)
treecbb150575eb53efaef81c5038ff8f3bb31ab2553 /vendor/github.com/onsi/ginkgo/README.md
parent92f502983885566a0b7bca4ae6c1bc5a8414a482 (diff)
downloadpodman-288bb2e858521dc8b90c33c4b8bcd83ddba15997.tar.gz
podman-288bb2e858521dc8b90c33c4b8bcd83ddba15997.tar.bz2
podman-288bb2e858521dc8b90c33c4b8bcd83ddba15997.zip
Bump github.com/onsi/ginkgo from 1.12.2 to 1.12.3
Bumps [github.com/onsi/ginkgo](https://github.com/onsi/ginkgo) from 1.12.2 to 1.12.3. - [Release notes](https://github.com/onsi/ginkgo/releases) - [Changelog](https://github.com/onsi/ginkgo/blob/master/CHANGELOG.md) - [Commits](https://github.com/onsi/ginkgo/compare/v1.12.2...v1.12.3) Signed-off-by: dependabot-preview[bot] <support@dependabot.com> Signed-off-by: Daniel J Walsh <dwalsh@redhat.com>
Diffstat (limited to 'vendor/github.com/onsi/ginkgo/README.md')
-rw-r--r--vendor/github.com/onsi/ginkgo/README.md18
1 files changed, 17 insertions, 1 deletions
diff --git a/vendor/github.com/onsi/ginkgo/README.md b/vendor/github.com/onsi/ginkgo/README.md
index 2fda7b9eb..ddb0cd882 100644
--- a/vendor/github.com/onsi/ginkgo/README.md
+++ b/vendor/github.com/onsi/ginkgo/README.md
@@ -4,7 +4,23 @@
Jump to the [docs](https://onsi.github.io/ginkgo/) to learn more. To start rolling your Ginkgo tests *now* [keep reading](#set-me-up)!
-If you have a question, comment, bug report, feature request, etc. please open a GitHub issue.
+If you have a question, comment, bug report, feature request, etc. please open a GitHub issue, or visit the [Ginkgo Slack channel](https://app.slack.com/client/T029RQSE6/CQQ50BBNW).
+
+## TLDR
+Ginkgo builds on Go's `testing` package, allowing expressive [Behavior-Driven Development](https://en.wikipedia.org/wiki/Behavior-driven_development) ("BDD") style tests.
+It is typically (and optionally) paired with the [Gomega](https://github.com/onsi/gomega) matcher library.
+
+```go
+Describe("the strings package", func() {
+ Context("strings.Contains()", func() {
+ When("the string contains the substring in the middle", func() {
+ It("returns `true`", func() {
+ Expect(strings.Contains("Ginkgo is awesome", "is")).To(BeTrue())
+ })
+ })
+ })
+})
+```
## Feature List