Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update test libraries #70

Merged
merged 1 commit into from
Oct 26, 2023
Merged

Update test libraries #70

merged 1 commit into from
Oct 26, 2023

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Oct 24, 2023 •
edited
Loading

Mend Renovate

This PR contains the following updates:

Package Type Update Change
github.com/onsi/ginkgo/v2 require minor v2.1.6 -> v2.13.0
github.com/onsi/gomega require minor v1.20.1 -> v1.29.0

Release Notes

onsi/ginkgo (github.com/onsi/ginkgo/v2)

v2.13.0

Compare Source

2.13.0

Features

Add PreviewSpect() to enable programmatic preview access to the suite report (fixes #​1225)

v2.12.1

Compare Source

2.12.1

Fixes
Maintenance

v2.12.0

Compare Source

2.12.0

Features
  • feat: allow MustPassRepeatedly decorator to be set at suite level (#​1266) [05de518]
Fixes
Maintenance

Various chores/dependency bumps.

v2.11.0

Compare Source

2.11.0

In prior versions of Ginkgo specs the CLI filter flags (e.g. --focus, --label-filter) would override any programmatic focus. This behavior has proved surprising and confusing in at least the following ways:

  • users cannot combine programmatic filters and CLI filters to more efficiently select subsets of tests
  • CLI filters can override programmatic focus on CI systems resulting in an exit code of 0 despite the presence of (incorrectly!) committed focused specs.

Going forward Ginkgo will AND all programmatic and CLI filters. Moreover, the presence of any programmatic focused tests will always result in a non-zero exit code.

This change is technically a change in Ginkgo's external contract and may require some users to make changes to successfully adopt. Specifically: it's possible some users were intentionally using CLI filters to override programmatic focus. If this is you please open an issue so we can explore solutions to the underlying problem you are trying to solve.

Fixes
  • Programmatic focus is no longer overwrriten by CLI filters [d6bba86]
Maintenance

v2.10.0

Compare Source

2.10.0

Features
  • feat(ginkgo/generators): add --tags flag (#​1216) [a782a77]
    adds a new --tags flag to ginkgo generate
Fixes
Maintenance

v2.9.7

Compare Source

2.9.7

Fixes
  • fix race when multiple defercleanups are called in goroutines [07fc3a0]

v2.9.6

Compare Source

2.9.6

Fixes
Maintenance

v2.9.5

Compare Source

2.9.5

Fixes
  • ensure the correct deterministic sort order is produced when ordered specs are generated by a helper function [7fa0b6b]
Maintenance

v2.9.4

Compare Source

2.9.4

Fixes

  • fix hang with ginkgo -p (#​1192) [15d4bdc] - this addresses a long standing issue related to Ginkgo hanging when a child process spawned by the test does not exit.

  • fix: fail fast may cause Serial spec or cleanup Node interrupted (#​1178) [8dea88b] - prior to this there was a small gap in which specs on other processes might start even if one process has tried to abort the suite.

Maintenance
  • Document run order when multiple setup nodes are at the same nesting level [903be81]

v2.9.3

Compare Source

2.9.3

Features
  • Add RenderTimeline to GinkgoT() [c0c77b6]
Fixes
Maintenance

v2.9.2

Compare Source

2.9.2

Maintenance

v2.9.1

Compare Source

2.9.1

Fixes

This release fixes a longstanding issue where ginkgo -coverpkg=./... would not work. This is now resolved and fixes #​1161 and #​995

  • Support -coverpkg=./... [26ca1b5]
  • document coverpkg a bit more clearly [fc44c3b]
Maintenance
  • bump various dependencies
  • Improve Documentation and fix typo (#​1158) [93de676]

v2.9.0

Compare Source

2.9.0

Features

  • AttachProgressReporter is an experimental feature that allows users to provide arbitrary information when a ProgressReport is requested [28801fe]

  • GinkgoT() has been expanded to include several Ginkgo-specific methods [2bd5a3b]

    The intent is to enable the development of third-party libraries that integrate deeply with Ginkgo using GinkgoT() to access Ginkgo's functionality.

v2.8.4

Compare Source

2.8.4

Features
Fixes
  • rename tools hack to see if it fixes things for downstream users [a8bb39a]
Maintenance

v2.8.3

Compare Source

2.8.3

Released to fix security issue in golang.org/x/net dependency

Maintenance
  • Bump golang.org/x/net from 0.6.0 to 0.7.0 (#​1141) [fc1a02e]
  • remove tools.go hack from documentation [0718693]

v2.8.2

Compare Source

2.8.2

Ginkgo now includes a tools.go file in the root directory of the ginkgo package. This should allow modules that simply go get github.com/onsi/ginkgo/v2 to also pull in the CLI dependencies. This obviates the need for consumers of Ginkgo to have their own tools.go file and makes it simpler to ensure that the version of the ginkgo CLI being used matches the version of the library. You can simply run go run github.com/onsi/ginkgo/v2/ginkgo to run the version of the cli associated with your package go.mod.

Maintenance

v2.8.1

Compare Source

2.8.1

Fixes
  • lock around default report output to avoid triggering the race detector when calling By from goroutines [2d5075a]
  • don't run ReportEntries through sprintf [febbe38]
Maintenance

v2.8.0

Compare Source

2.8.0

Features
  • Introduce GinkgoHelper() to track and exclude helper functions from potential CodeLocations [e19f556]

Modeled after testing.T.Helper(). Now, rather than write code like:

func helper(model Model) {
    Expect(model).WithOffset(1).To(BeValid())
    Expect(model.SerialNumber).WithOffset(1).To(MatchRegexp(/[a-f0-9]*/))
}

you can stop tracking offsets (which makes nesting composing helpers nearly impossible) and simply write:

func helper(model Model) {
    GinkgoHelper()
    Expect(model).To(BeValid())
    Expect(model.SerialNumber).To(MatchRegexp(/[a-f0-9]*/))
}
  • Introduce GinkgoLabelFilter() and Label().MatchesLabelFilter() to make it possible to programmatically match filters (fixes #​1119) [2f6597c]

You can now write code like this:

BeforeSuite(func() {
	if Label("slow").MatchesLabelFilter(GinkgoLabelFilter()) {
		// do slow setup
	}

	if Label("fast").MatchesLabelFilter(GinkgoLabelFilter()) {
		// do fast setup
	}
})

to programmatically check whether a given set of labels will match the configured --label-filter.

Maintenance

v2.7.1

Compare Source

2.7.1

Fixes
  • Bring back SuiteConfig.EmitSpecProgress to avoid compilation issue for consumers that set it manually [d2a1cb0]
Maintenance

v2.7.0

Compare Source

2.7.0

Features
  • Introduce ContinueOnFailure for Ordered containers [e0123ca] - Ordered containers that are also decorated with ContinueOnFailure will not stop running specs after the first spec fails.
  • Support for bootstrap commands to use custom data for templates (#​1110) [7a2b242]
  • Support for labels and pending decorator in ginkgo outline output (#​1113) [e6e3b98]
  • Color aliases for custom color support (#​1101) [49fab7a]
Fixes
  • correctly ensure deterministic spec order, even if specs are generated by iterating over a map [89dda20]
  • Fix a bug where timedout specs were not correctly treated as failures when determining whether or not to run AfterAlls in an Ordered container.
  • Ensure go test coverprofile outputs to the expected location (#​1105) [b0bd77b]

v2.6.1

Compare Source

2.6.1

Features
  • Override formatter colors from envvars - this is a new feature but an alternative approach involving config files might be taken in the future (#​1095) [60240d1]
Fixes
  • GinkgoRecover now supports ignoring panics that match a specific, hidden, interface [301f3e2]
Maintenance

v2.6.0

Compare Source

2.6.0

Features
  • ReportBeforeSuite provides access to the suite report before the suite begins.
  • Add junit config option for omitting leafnodetype (#​1088) [956e6d2]
  • Add support to customize junit report config to omit spec labels (#​1087) [de44005]
Fixes
  • Fix stack trace pruning so that it has a chance of working on windows [2165648]

v2.5.1

Compare Source

2.5.1

Fixes
Maintenance

v2.5.0

Compare Source

2.5.0

Ginkgo output now includes a timeline-view of the spec

This commit changes Ginkgo's default output. Spec details are now
presented as a timeline that includes events that occur during the spec
lifecycle interleaved with any GinkgoWriter content. This makes is much easier
to understand the flow of a spec and where a given failure occurs.

The --progress, --slow-spec-threshold, --always-emit-ginkgo-writer flags
and the SuppressProgressReporting decorator have all been deprecated. Instead
the existing -v and -vv flags better capture the level of verbosity to display. However,
a new --show-node-events flag is added to include node > Enter and < Exit events
in the spec timeline.

In addition, JUnit reports now include the timeline (rendered with -vv) and custom JUnit
reports can be configured and generated using
GenerateJUnitReportWithConfig(report types.Report, dst string, config JunitReportConfig)

Code should continue to work unchanged with this version of Ginkgo - however if you have tooling that
was relying on the specific output format of Ginkgo you may run into issues. Ginkgo's console output is not guaranteed to be stable for tooling and automation purposes. You should, instead, use Ginkgo's JSON format
to build tooling on top of as it has stronger guarantees to be stable from version to version.

Features
  • Provide details about which timeout expired [0f2fa27]
Fixes
  • Add Support Policy to docs [c70867a]
Maintenance

v2.4.0

Compare Source

2.4.0

Features
Fixes
Maintenance

v2.3.1

Compare Source

2.3.1

Fixes

Several users were invoking ginkgo by installing the latest version of the cli via go install github.com/onsi/ginkgo/v2/ginkgo@latest. When 2.3.0 was released this resulted in an influx of issues as CI systems failed due to a change in the internal contract between the Ginkgo CLI and the Ginkgo library. Ginkgo only supports running the same version of the library as the cli (which is why both are packaged in the same repository).

With this patch release, the ginkgo CLI can now identify a version mismatch and emit a helpful error message.

  • Ginkgo cli can identify version mismatches and emit a helpful error message [bc4ae2f]
  • further emphasize that a version match is required when running Ginkgo on CI and/or locally [2691dd8]

Maintenance

v2.3.0

Compare Source

2.3.0

Interruptible Nodes and Timeouts

Ginkgo now supports per-node and per-spec timeouts on interruptible nodes. Check out the documentation for all the details but the gist is you can now write specs like this:

It("is interruptible", func(ctx SpecContext) { // or context.Context instead of SpecContext, both are valid.
    // do things until `ctx.Done()` is closed, for example:
    req, err := http.NewRequestWithContext(ctx, "POST", "/build-widgets", nil)
    Expect(err).NotTo(HaveOccured())
    _, err := http.DefaultClient.Do(req)
    Expect(err).NotTo(HaveOccured())

    Eventually(client.WidgetCount).WithContext(ctx).Should(Equal(17))
}, NodeTimeout(time.Second*20), GracePeriod(5*time.Second))

and have Ginkgo ensure that the node completes before the timeout elapses. If it does elapse, or if an external interrupt is received (e.g. ^C) then Ginkgo will cancel the context and wait for the Grace Period for the node to exit before proceeding with any cleanup nodes associated with the spec. The ctx provided by Ginkgo can also be passed down to Gomega's Eventually to have all assertions within the node governed by a single deadline.

Features
  • Ginkgo now records any additional failures that occur during the cleanup of a failed spec. In prior versions this information was quietly discarded, but the introduction of a more rigorous approach to timeouts and interruptions allows Ginkgo to better track subsequent failures.
  • SpecContext also provides a mechanism for third-party libraries to provide additional information when a Progress Report is generated. Gomega uses this to provide the current state of an Eventually().WithContext() assertion when a Progress Report is requested.
  • DescribeTable now exits with an error if it is not passed any Entries [a4c9865]

Fixes

  • fixes crashes on newer Ruby 3 installations by upgrading github-pages gem dependency [92c88d5]
  • Make the outline command able to use the DSL import [1be2427]

Maintenance

  • chore(docs): delete no meaning d [57c373c]
  • chore(docs): Fix hyperlinks [30526d5]
  • chore(docs): fix code blocks without language settings [cf611c4]
  • fix intra-doc link [b541bcb]

v2.2.0

Compare Source

2.2.0
Generate real-time Progress Reports [f91377c]

Ginkgo can now generate Progress Reports to point users at the current running line of code (including a preview of the actual source code) and a best guess at the most relevant subroutines.

These Progress Reports allow users to debug stuck or slow tests without exiting the Ginkgo process. A Progress Report can be generated at any time by sending Ginkgo a SIGINFO (^T on MacOS/BSD) or SIGUSR1.

In addition, the user can specify --poll-progress-after and --poll-progress-interval to have Ginkgo start periodically emitting progress reports if a given node takes too long. These can be overriden/set on a per-node basis with the PollProgressAfter and PollProgressInterval decorators.

Progress Reports are emitted to stdout, and also stored in the machine-redable report formats that Ginkgo supports.

Ginkgo also uses this progress reporting infrastructure under the hood when handling timeouts and interrupts. This yields much more focused, useful, and informative stack traces than previously.

Features

  • BeforeSuite, AfterSuite, SynchronizedBeforeSuite, SynchronizedAfterSuite, and ReportAfterSuite now support (the relevant subset of) decorators. These can be passed in after the callback functions that are usually passed into these nodes.

    As a result the signature of these methods has changed and now includes a trailing args ...interface{}. For most users simply using the DSL, this change is transparent. However if you were assigning one of these functions to a custom variable (or passing it around) then your code may need to change to reflect the new signature.

Maintenance
  • Modernize the invocation of Ginkgo in github actions [0ffde58]
  • Update reocmmended CI settings in docs [896bbb9]
  • Speed up unnecessarily slow integration test [6d3a90e]
onsi/gomega (github.com/onsi/gomega)

v1.29.0

Compare Source

1.29.0

Features
  • MatchError can now take an optional func(error) bool + description [2b39142]

v1.28.1

Compare Source

1.28.1

Maintenance
  • Bump github.com/onsi/ginkgo/v2 from 2.12.0 to 2.13.0 [635d196]
  • Bump github.com/google/go-cmp from 0.5.9 to 0.6.0 [14f8859]
  • Bump golang.org/x/net from 0.14.0 to 0.17.0 [d8a6508]
  • #​703 doc(matchers): HaveEach() doc comment updated [2705bdb]
  • Minor typos (#​699) [375648c]

v1.28.0

Compare Source

1.28.0

Features
Fixes
  • Read Body for Newer Responses in HaveHTTPBodyMatcher (#​686) [18d6673]
Maintenance

v1.27.10

Compare Source

1.27.10

Fixes
  • fix: go 1.21 adding goroutine ID to creator+location (#​685) [bdc7803]

v1.27.9

Compare Source

v1.27.8

Compare Source

1.27.8

Fixes
  • HaveExactElement should not call FailureMessage if a submatcher returned an error [096f392]
Maintenance
  • Bump github.com/onsi/ginkgo/v2 from 2.9.5 to 2.9.7 (#​669) [8884bee]

v1.27.7

Compare Source

1.27.7

Fixes
  • fix: gcustom.MakeMatcher accepts nil as actual value (#​666) [57054d5]
Maintenance

v1.27.6

Compare Source

1.27.6

Fixes
  • Allow collections matchers to work correctly when expected has nil elements [60e7cf3]
Maintenance
  • updates MatchError godoc comment to also accept a Gomega matcher (#​654) [67b869d]

v1.27.5

Compare Source

1.27.5

Maintenance

v1.27.4

Compare Source

1.27.4

Fixes
  • improve error formatting and remove duplication of error message in Eventually/Consistently [854f075]
Maintenance
  • Bump github.com/onsi/ginkgo/v2 from 2.9.0 to 2.9.1 (#​650) [ccebd9b]

v1.27.3

Compare Source

1.27.3

Fixes
  • format.Object now always includes err.Error() when passed an error [86d97ef]
  • Fix HaveExactElements to work inside ContainElement or other collection matchers (#​648) [636757e]
Maintenance
  • Bump github.com/golang/protobuf from 1.5.2 to 1.5.3 (#​649) [cc16689]
  • Bump github.com/onsi/ginkgo/v2 from 2.8.4 to 2.9.0 (#​646) [e783366]

v1.27.2

Compare Source

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]

v1.27.1

Compare Source

1.27.1

Maintenance

v1.27.0

Compare Source

1.27.0

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

v1.26.0

Compare Source

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]

v1.25.0

Compare Source

1.25.0
Features
Maintenance

v1.24.2

Compare Source

1.24.2

Fixes
Maintenance

v1.24.1

Compare Source

v1.24.0

Compare Source

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]

v1.23.0

Compare Source

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

v1.22.1

Compare Source

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

v1.22.0

Compare Source

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

Compare Source

v1.21.1

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

v1.21.0

Compare Source

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]

v1.20.2

Compare Source

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]

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

👻 Immortal: This PR will be recreated if closed unmerged. Get config help if that's undesired.

  • If you want to rebase/retry this PR, check this box

This PR has been generated by Mend Renovate. View repository job log here.

@renovate renovate bot requested a review from a team as a code owner October 24, 2023 10:33
@renovate renovate bot added dependencies renovate This is an automated PR by RenovateBot labels Oct 24, 2023
@renovate renovate bot force-pushed the renovate/test-libraries branch 6 times, most recently from 13054c7 to d0089cf Compare October 25, 2023 18:53
@renovate renovate bot force-pushed the renovate/test-libraries branch from d0089cf to 08be13b Compare October 26, 2023 09:20
@fiunchinho fiunchinho merged commit ccb4dd4 into main Oct 26, 2023
2 checks passed
@fiunchinho fiunchinho deleted the renovate/test-libraries branch October 26, 2023 09:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@fiunchinho fiunchinho fiunchinho approved these changes

Assignees
No one assigned
Labels
dependencies renovate This is an automated PR by RenovateBot
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@fiunchinho