gomega

1.27.2

Fixes

• improve poll progress message when polling a consistently that has been passing [28a319b]

Maintenance

• bump ginkgo
• remove tools.go hack as Ginkgo 2.8.2 automatically pulls in the cli dependencies [81443b3]

1.27.1

Maintenance

• Bump golang.org/x/net from 0.6.0 to 0.7.0 (#640) [bc686cd]

1.27.0

Features

• Add HaveExactElements matcher (#634) [9d50783]
• update Gomega docs to discuss GinkgoHelper() [be32774]

Maintenance

• Bump github.com/onsi/ginkgo/v2 from 2.8.0 to 2.8.1 (#639) [296a68b]
• Bump golang.org/x/net from 0.5.0 to 0.6.0 (#638) [c2b098b]
• Bump github-pages from 227 to 228 in /docs (#636) [a9069ab]
• test: update matrix for Go 1.20 (#635) [6bd25c8]
• Bump github.com/onsi/ginkgo/v2 from 2.7.0 to 2.8.0 (#631) [5445f8b]
• Bump webrick from 1.7.0 to 1.8.1 in /docs (#630) [03e93bb]
• codeql: add ruby language (#626) [63c7d21]
• dependabot: add bundler package-ecosystem for docs (#625) [d92f963]

1.26.0

Features

• When a polled function returns an error, keep track of the actual and report on the matcher state of the last non-errored actual [21f3090]
• improve eventually failure message output [c530fb3]

Fixes

• fix several documentation spelling issues [e2eff1f]

1.25.0

Features

• add MustPassRepeatedly(int) to asyncAssertion (#619) [4509f72]
• compare unwrapped errors using DeepEqual (#617) [aaeaa5d]

Maintenance

• Bump golang.org/x/net from 0.4.0 to 0.5.0 (#614) [c7cfea4]
• Bump github.com/onsi/ginkgo/v2 from 2.6.1 to 2.7.0 (#615) [71b8adb]
• Docs: Fix typo "MUltiple" -> "Multiple" (#616) [9351dda]
• clean up go.sum [cd1dc1d]

1.24.2

Fixes

• Correctly handle assertion failure panics for eventually/consistnetly "g Gomega"s in a goroutine [78f1660]
• docs:Fix typo "you an" -> "you can" (#607) [3187c1f]
• fixes issue #600 (#606) [808d192]

Maintenance

• Bump golang.org/x/net from 0.2.0 to 0.4.0 (#611) [6ebc0bf]
• Bump nokogiri from 1.13.9 to 1.13.10 in /docs (#612) [258cfc8]
• Bump github.com/onsi/ginkgo/v2 from 2.5.0 to 2.5.1 (#609) [e6c3eb9]

1.24.0

Features

Introducting gcustom - a convenient mechanism for building custom matchers.

This is an RC release for gcustom. The external API may be tweaked in response to feedback however it is expected to remain mostly stable.

Maintenance

• Update BeComparableTo documentation [756eaa0]

1.23.0

Features

• Custom formatting on a per-type basis can be provided using format.RegisterCustomFormatter() -- see the docs here

• Substantial improvement have been made to StopTrying():

  • Users can now use StopTrying().Wrap(err) to wrap errors and StopTrying().Attach(description, object) to attach arbitrary objects to the StopTrying() error
  • StopTrying() is now always interpreted as a failure. If you are an early adopter of StopTrying() you may need to change your code as the prior version would match against the returned value even if StopTrying() was returned. Going forward the StopTrying() api should remain stable.
  • StopTrying() and StopTrying().Now() can both be used in matchers - not just polled functions.

• TryAgainAfter(duration) is used like StopTrying() but instructs Eventually and Consistently that the poll should be tried again after the specified duration. This allows you to dynamically adjust the polling duration.

• ctx can now be passed-in as the first argument to Eventually and Consistently.

Maintenance

• Bump github.com/onsi/ginkgo/v2 from 2.3.0 to 2.3.1 (#597) [afed901]
• Bump nokogiri from 1.13.8 to 1.13.9 in /docs (#599) [7c691b3]
• Bump github.com/google/go-cmp from 0.5.8 to 0.5.9 (#587) [ff22665]

1.22.1

Fixes

• When passed a context and no explicit timeout, Eventually will only timeout when the context is cancelled [e5105cf]
• Allow StopTrying() to be wrapped [bf3cba9]

Maintenance

• bump to ginkgo v2.3.0 [c5d5c39]

1.22.0

Features

Several improvements have been made to Eventually and Consistently in this and the most recent releases:

• Eventually and Consistently can take a context.Context [65c01bc]
  This enables integration with Ginkgo 2.3.0's interruptible nodes and node timeouts.
• Eventually and Consistently that are passed a SpecContext can provide reports when an interrupt occurs [0d063c9]
• Eventually/Consistently will forward an attached context to functions that ask for one [e2091c5]
• Eventually/Consistently supports passing arguments to functions via WithArguments() [a2dc7c3]
• Eventually and Consistently can now be stopped early with StopTrying(message) and StopTrying(message).Now() [52976bb]

These improvements are all documented in Gomega's docs

v1.21.1

Features

• Eventually and Consistently that are passed a SpecContext can provide reports when an interrupt occurs [0d063c9]

1.21.0

Features

• Eventually and Consistently can take a context.Context [65c01bc]
  This enables integration with Ginkgo 2.3.0's interruptible nodes and node timeouts.
• Introduces Eventually.Within.ProbeEvery with tests and documentation (#591) [f633800]
• New BeKeyOf matcher with documentation and unit tests (#590) [fb586b3]

Fixes

• Cover the entire gmeasure suite with leak detection [8c54344]
• Fix gmeasure leak [119d4ce]
• Ignore new Ginkgo ProgressSignal goroutine in gleak [ba548e2]

Maintenance

• Fixes crashes on newer Ruby 3 installations by upgrading github-pages gem dependency (#596) [12469a0]

1.20.2

Fixes

• label specs that rely on remote access; bump timeout on short-circuit test to make it less flaky [35eeadf]
• gexec: allow more headroom for SIGABRT-related unit tests (#581) [5b78f40]
• Enable reading from a closed gbytes.Buffer (#575) [061fd26]

Maintenance

• Bump github.com/onsi/ginkgo/v2 from 2.1.5 to 2.1.6 (#583) [55d895b]
• Bump github.com/onsi/ginkgo/v2 from 2.1.4 to 2.1.5 (#582) [346de7c]

1.20.1

Fixes

• fix false positive gleaks when using ginkgo -p (#577) [cb46517]
• Fix typos in gomega_dsl.go (#569) [5f71ed2]
• don't panic on Eventually(nil), fixing #555 (#567) [9d1186f]
• vet optional description args in assertions, fixing #560 (#566) [8e37808]

Maintenance

• test: add new Go 1.19 to test matrix (#571) [40d7efe]
• Bump tzinfo from 1.2.9 to 1.2.10 in /docs (#564) [5f26371]

Features

• New gleak experimental goroutine leak detection package! (#538) [85ba7bc]
• New BeComparableTo matcher(#546) that uses gocmp to make comparisons [e77ea75]
• New HaveExistingField matcher (#553) [fd130e1]
• Document how to wrap Gomega (#539) [56714a4]

Fixes

• Support pointer receivers in HaveField; fixes #543 (#544) [8dab36e]

Maintenance

• Bump various dependencies:
  • Upgrade to yaml.v3 (#556) [f5a83b1]
  • Bump github/codeql-action from 1 to 2 (#549) [52f5adf]
  • Bump github.com/google/go-cmp from 0.5.7 to 0.5.8 (#551) [5f3942d]
  • Bump nokogiri from 1.13.4 to 1.13.6 in /docs (#554) [eb4b4c2]
  • Use latest ginkgo (#535) [1c29028]
  • Bump nokogiri from 1.13.3 to 1.13.4 in /docs (#541) [1ce84d5]
  • Bump actions/setup-go from 2 to 3 (#540) [755485e]
  • Bump nokogiri from 1.12.5 to 1.13.3 in /docs (#522) [4fbb0dc]
  • Bump actions/checkout from 2 to 3 (#526) [ac49202]

1.19.0

Features

• New HaveEach matcher to ensure that each and every element in an array, slice, or map satisfies the passed in matcher. (#523) [9fc2ae2] (#524) [c8ba582]
• Users can now wrap the Gomega interface to implement custom behavior on each assertion. (#521) [1f2e714]
• ContainElement now accepts an additional pointer argument. Elements that satisfy the matcher are stored in the pointer enabling developers to easily add subsequent, more detailed, assertions against the matching element. (#527) [1a4e27f]

Fixes

• update RELEASING instructions to match ginkgo [0917cde]
• Bump github.com/onsi/ginkgo/v2 from 2.0.0 to 2.1.3 (#519) [49ab4b0]
• Fix CVE-2021-38561 (#534) [f1b4456]
• Fix max number of samples in experiments on non-64-bit systems. (#528) [1c84497]
• Remove dependency on ginkgo v1.16.4 (#530) [4dea8d5]
• Fix for Go 1.18 (#532) [56d2a29]
• Document precendence of timeouts (#533) [b607941]

Features

• New HaveEach matcher to ensure that each and every element in an array, slice, or map satisfies the passed in matcher. (#523) [9fc2ae2] (#524) [c8ba582]
• Users can now wrap the Gomega interface to implement custom behavior on each assertion. (#521) [1f2e714]
• ContainElement now accepts an additional pointer argument. Elements that satisfy the matcher are stored in the pointer enabling developers to easily add subsequent, more detailed, assertions against the matching element. (#527) [1a4e27f]

Fixes

• update RELEASING instructions to match ginkgo [0917cde]
• Bump github.com/onsi/ginkgo/v2 from 2.0.0 to 2.1.3 (#519) [49ab4b0]
• Fix CVE-2021-38561 (#534) [f1b4456]
• Fix max number of samples in experiments on non-64-bit systems. (#528) [1c84497]
• Remove dependency on ginkgo v1.16.4 (#530) [4dea8d5]
• Fix for Go 1.18 (#532) [56d2a29]
• Document precendence of timeouts (#533) [b607941]

• add pointer support to HaveField matcher (#495) [79e41a3]

Features

• Docs now live on the master branch in the docs folder which will make for easier PRs. The docs also use Ginkgo 2.0's new docs html/css/js. [2570272]
• New HaveValue matcher can handle actuals that are either values (in which case they are passed on unscathed) or pointers (in which case they are indirected). Docs here. (#485) [bdc087c]
• Gmeasure has been declared GA [360db9d]

Fixes

• Gomega now uses ioutil for Go 1.15 and lower (#492) - official support is only for the most recent two major versions of Go but this will unblock users who need to stay on older unsupported versions of Go. [c29c1c0]

Maintenace

• Remove Travis workflow (#491) [72e6040]
• Upgrade to Ginkgo 2.0.0 GA [f383637]
• chore: fix description of HaveField matcher (#487) [2b4b2c0]
• use tools.go to ensure Ginkgo cli dependencies are included [f58a52b]
• remove dockerfile and simplify github actions to match ginkgo's actions [3f8160d]

1.17.0

Features

• Add HaveField matcher [3a26311]
• add Error() assertions on the final error value of multi-return values (#480) [2f96943]
• separate out offsets and timeouts (#478) [18a4723]
• fix transformation error reporting (#479) [e001fab]
• allow transform functions to report errors (#472) [bf93408]

Fixes

Stop using deprecated ioutil package (#467) [07f405d]