Add Helper() method in internal mocks and assert.CollectT #1423

dolmen · 2023-07-13T11:12:33Z

Summary

Start to extend our definition of testing.TB to include its Helper() method. See #1422 for details.

Changes

Add an Helper() method on all internal mocks of testing.T.
Add an Helper() method on type assert.CollectT.

Motivation

These are steps 1 and 2 of #1422.

assert/assertions.go

brackendawson

Given this doesn't change the interface I don't want to block progress, so approving.

But I think @craig65535 is right, ideally re-base this and add consolidate the new internal type using one of those approaches.

Add an Helper() method to all mocks in tests of package 'assert'.

Add Helper() method to CollectT like testing.T as we intend to add Helper() to the assert.TestingT interface.

ccoVeille

I've read the issue and I agree with the plan and the implementation

…nercloud/fleeting-plugin-hetzner!273) This MR contains the following updates: | Package | Change | Age | Confidence | |---|---|---|---| | [github.com/stretchr/testify](https://github.com/stretchr/testify) | `v1.10.0` -> `v1.11.0` | [![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fstretchr%2ftestify/v1.11.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fstretchr%2ftestify/v1.10.0/v1.11.0?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>stretchr/testify (github.com/stretchr/testify)</summary> ### [`v1.11.0`](https://github.com/stretchr/testify/releases/tag/v1.11.0) [Compare Source](stretchr/testify@v1.10.0...v1.11.0) #### What's Changed ##### Functional Changes v1.11.0 Includes a number of performance improvements. - Call stack perf change for CallerInfo by [@mikeauclair](https://github.com/mikeauclair) in [#1614](stretchr/testify#1614) - Lazily render mock diff output on successful match by [@mikeauclair](https://github.com/mikeauclair) in [#1615](stretchr/testify#1615) - assert: check early in Eventually, EventuallyWithT, and Never by [@cszczepaniak](https://github.com/cszczepaniak) in [#1427](stretchr/testify#1427) - assert: add IsNotType by [@bartventer](https://github.com/bartventer) in [#1730](stretchr/testify#1730) - assert.JSONEq: shortcut if same strings by [@dolmen](https://github.com/dolmen) in [#1754](stretchr/testify#1754) - assert.YAMLEq: shortcut if same strings by [@dolmen](https://github.com/dolmen) in [#1755](stretchr/testify#1755) - assert: faster and simpler isEmpty using reflect.Value.IsZero by [@dolmen](https://github.com/dolmen) in [#1761](stretchr/testify#1761) - suite: faster methods filtering (internal refactor) by [@dolmen](https://github.com/dolmen) in [#1758](stretchr/testify#1758) ##### Fixes - assert.ErrorAs: log target type by [@craig65535](https://github.com/craig65535) in [#1345](stretchr/testify#1345) - Fix failure message formatting for Positive and Negative asserts in [#1062](stretchr/testify#1062) - Improve ErrorIs message when error is nil but an error was expected by [@tsioftas](https://github.com/tsioftas) in [#1681](stretchr/testify#1681) - fix Subset/NotSubset when calling with mixed input types by [@siliconbrain](https://github.com/siliconbrain) in [#1729](stretchr/testify#1729) - Improve ErrorAs failure message when error is nil by [@ccoVeille](https://github.com/ccoVeille) in [#1734](stretchr/testify#1734) - mock.AssertNumberOfCalls: improve error msg by [@3scalation](https://github.com/3scalation) in [#1743](stretchr/testify#1743) ##### Documentation, Build & CI - docs: Fix typo in README by [@alexandear](https://github.com/alexandear) in [#1688](stretchr/testify#1688) - Replace deprecated io/ioutil with io and os by [@alexandear](https://github.com/alexandear) in [#1684](stretchr/testify#1684) - Document consequences of calling t.FailNow() by [@greg0ire](https://github.com/greg0ire) in [#1710](stretchr/testify#1710) - chore: update docs for Unset [#1621](stretchr/testify#1621) by [@techfg](https://github.com/techfg) in [#1709](stretchr/testify#1709) - README: apply gofmt to examples by [@alexandear](https://github.com/alexandear) in [#1687](stretchr/testify#1687) - refactor: use %q and %T to simplify fmt.Sprintf by [@alexandear](https://github.com/alexandear) in [#1674](stretchr/testify#1674) - Propose Christophe Colombier (ccoVeille) as approver by [@brackendawson](https://github.com/brackendawson) in [#1716](stretchr/testify#1716) - Update documentation for the Error function in assert or require package by [@architagr](https://github.com/architagr) in [#1675](stretchr/testify#1675) - assert: remove deprecated build constraints by [@alexandear](https://github.com/alexandear) in [#1671](stretchr/testify#1671) - assert: apply gofumpt to internal test suite by [@ccoVeille](https://github.com/ccoVeille) in [#1739](stretchr/testify#1739) - CI: fix shebang in .ci.\*.sh scripts by [@dolmen](https://github.com/dolmen) in [#1746](stretchr/testify#1746) - assert,require: enable parallel testing on (almost) all top tests by [@dolmen](https://github.com/dolmen) in [#1747](stretchr/testify#1747) - suite.Passed: add one more status test report by [@Ararsa-Derese](https://github.com/Ararsa-Derese) in [#1706](stretchr/testify#1706) - Add Helper() method in internal mocks and assert.CollectT by [@dolmen](https://github.com/dolmen) in [#1423](stretchr/testify#1423) - assert.Same/NotSame: improve usage of Sprintf by [@ccoVeille](https://github.com/ccoVeille) in [#1742](stretchr/testify#1742) - mock: enable parallel testing on internal testsuite by [@dolmen](https://github.com/dolmen) in [#1756](stretchr/testify#1756) - suite: cleanup use of 'testing' internals at runtime by [@dolmen](https://github.com/dolmen) in [#1751](stretchr/testify#1751) - assert: check test failure message for Empty and NotEmpty by [@ccoVeille](https://github.com/ccoVeille) in [#1745](stretchr/testify#1745) - deps: fix dependency cycle with objx (again) by [@dolmen](https://github.com/dolmen) in [#1567](stretchr/testify#1567) - assert.Empty: comprehensive doc of "Empty"-ness rules by [@dolmen](https://github.com/dolmen) in [#1753](stretchr/testify#1753) - doc: improve godoc of top level 'testify' package by [@dolmen](https://github.com/dolmen) in [#1760](stretchr/testify#1760) - assert.ErrorAs: simplify retrieving the type name by [@ccoVeille](https://github.com/ccoVeille) in [#1740](stretchr/testify#1740) - assert.EqualValues: improve test coverage to 100% by [@dolmen](https://github.com/dolmen) in [#1763](stretchr/testify#1763) - suite.Run: simplify running of Setup/TeardownSuite by [@renzoarreaza](https://github.com/renzoarreaza) in [#1769](stretchr/testify#1769) - assert.CallerInfo: micro optimization by using LastIndexByte by [@dolmen](https://github.com/dolmen) in [#1767](stretchr/testify#1767) - assert.CallerInfo: micro cleanup by [@dolmen](https://github.com/dolmen) in [#1768](stretchr/testify#1768) - assert: refactor Test*FileExists and Test*DirExists tests to enable parallel testing by [@dolmen](https://github.com/dolmen) in [#1766](stretchr/testify#1766) - suite.Run: refactor handling of stats for improved readability by [@dolmen](https://github.com/dolmen) in [#1764](stretchr/testify#1764) - tests: improve captureTestingT helper by [@ccoVeille](https://github.com/ccoVeille) in [#1741](stretchr/testify#1741) - build(deps): bump actions/checkout from 4 to 5 by [@dependabot](https://github.com/dependabot)\[bot] in [#1778](stretchr/testify#1778) #### New Contributors - [@greg0ire](https://github.com/greg0ire) made their first contribution in [#1710](stretchr/testify#1710) - [@techfg](https://github.com/techfg) made their first contribution in [#1709](stretchr/testify#1709) - [@mikeauclair](https://github.com/mikeauclair) made their first contribution in [#1614](stretchr/testify#1614) - [@cszczepaniak](https://github.com/cszczepaniak) made their first contribution in [#1427](stretchr/testify#1427) - [@architagr](https://github.com/architagr) made their first contribution in [#1675](stretchr/testify#1675) - [@tsioftas](https://github.com/tsioftas) made their first contribution in [#1681](stretchr/testify#1681) - [@siliconbrain](https://github.com/siliconbrain) made their first contribution in [#1729](stretchr/testify#1729) - [@bartventer](https://github.com/bartventer) made their first contribution in [#1730](stretchr/testify#1730) - [@Ararsa-Derese](https://github.com/Ararsa-Derese) made their first contribution in [#1706](stretchr/testify#1706) - [@renzoarreaza](https://github.com/renzoarreaza) made their first contribution in [#1769](stretchr/testify#1769) - [@3scalation](https://github.com/3scalation) made their first contribution in [#1743](stretchr/testify#1743) **Full Changelog**: <stretchr/testify@v1.10.0...v1.11.0> </details> --- ### 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 MR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this MR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this MR, check this box --- This MR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).

This PR contains the following updates: | Package | Change | Age | Confidence | |---|---|---|---| | [github.com/stretchr/testify](https://github.com/stretchr/testify) | `v1.10.0` -> `v1.11.1` | [![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fstretchr%2ftestify/v1.11.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fstretchr%2ftestify/v1.10.0/v1.11.1?slim=true)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>stretchr/testify (github.com/stretchr/testify)</summary> ### [`v1.11.1`](https://github.com/stretchr/testify/releases/tag/v1.11.1) [Compare Source](stretchr/testify@v1.11.0...v1.11.1) This release fixes [#1785](stretchr/testify#1785) introduced in v1.11.0 where expected argument values implementing the stringer interface (`String() string`) with a method which mutates their value, when passed to mock.Mock.On (`m.On("Method", <expected>).Return()`) or actual argument values passed to mock.Mock.Called may no longer match one another where they previously did match. The behaviour prior to v1.11.0 where the stringer is always called is restored. Future testify releases may not call the stringer method at all in this case. #### What's Changed - Backport [#1786](stretchr/testify#1786) to release/1.11: mock: revert to pre-v1.11.0 argument matching behavior for mutating stringers by [@brackendawson](https://github.com/brackendawson) in [#1788](stretchr/testify#1788) **Full Changelog**: <stretchr/testify@v1.11.0...v1.11.1> ### [`v1.11.0`](https://github.com/stretchr/testify/releases/tag/v1.11.0) [Compare Source](stretchr/testify@v1.10.0...v1.11.0) #### What's Changed ##### Functional Changes v1.11.0 Includes a number of performance improvements. - Call stack perf change for CallerInfo by [@mikeauclair](https://github.com/mikeauclair) in [#1614](stretchr/testify#1614) - Lazily render mock diff output on successful match by [@mikeauclair](https://github.com/mikeauclair) in [#1615](stretchr/testify#1615) - assert: check early in Eventually, EventuallyWithT, and Never by [@cszczepaniak](https://github.com/cszczepaniak) in [#1427](stretchr/testify#1427) - assert: add IsNotType by [@bartventer](https://github.com/bartventer) in [#1730](stretchr/testify#1730) - assert.JSONEq: shortcut if same strings by [@dolmen](https://github.com/dolmen) in [#1754](stretchr/testify#1754) - assert.YAMLEq: shortcut if same strings by [@dolmen](https://github.com/dolmen) in [#1755](stretchr/testify#1755) - assert: faster and simpler isEmpty using reflect.Value.IsZero by [@dolmen](https://github.com/dolmen) in [#1761](stretchr/testify#1761) - suite: faster methods filtering (internal refactor) by [@dolmen](https://github.com/dolmen) in [#1758](stretchr/testify#1758) ##### Fixes - assert.ErrorAs: log target type by [@craig65535](https://github.com/craig65535) in [#1345](stretchr/testify#1345) - Fix failure message formatting for Positive and Negative asserts in [#1062](stretchr/testify#1062) - Improve ErrorIs message when error is nil but an error was expected by [@tsioftas](https://github.com/tsioftas) in [#1681](stretchr/testify#1681) - fix Subset/NotSubset when calling with mixed input types by [@siliconbrain](https://github.com/siliconbrain) in [#1729](stretchr/testify#1729) - Improve ErrorAs failure message when error is nil by [@ccoVeille](https://github.com/ccoVeille) in [#1734](stretchr/testify#1734) - mock.AssertNumberOfCalls: improve error msg by [@3scalation](https://github.com/3scalation) in [#1743](stretchr/testify#1743) ##### Documentation, Build & CI - docs: Fix typo in README by [@alexandear](https://github.com/alexandear) in [#1688](stretchr/testify#1688) - Replace deprecated io/ioutil with io and os by [@alexandear](https://github.com/alexandear) in [#1684](stretchr/testify#1684) - Document consequences of calling t.FailNow() by [@greg0ire](https://github.com/greg0ire) in [#1710](stretchr/testify#1710) - chore: update docs for Unset [#1621](stretchr/testify#1621) by [@techfg](https://github.com/techfg) in [#1709](stretchr/testify#1709) - README: apply gofmt to examples by [@alexandear](https://github.com/alexandear) in [#1687](stretchr/testify#1687) - refactor: use %q and %T to simplify fmt.Sprintf by [@alexandear](https://github.com/alexandear) in [#1674](stretchr/testify#1674) - Propose Christophe Colombier (ccoVeille) as approver by [@brackendawson](https://github.com/brackendawson) in [#1716](stretchr/testify#1716) - Update documentation for the Error function in assert or require package by [@architagr](https://github.com/architagr) in [#1675](stretchr/testify#1675) - assert: remove deprecated build constraints by [@alexandear](https://github.com/alexandear) in [#1671](stretchr/testify#1671) - assert: apply gofumpt to internal test suite by [@ccoVeille](https://github.com/ccoVeille) in [#1739](stretchr/testify#1739) - CI: fix shebang in .ci.\*.sh scripts by [@dolmen](https://github.com/dolmen) in [#1746](stretchr/testify#1746) - assert,require: enable parallel testing on (almost) all top tests by [@dolmen](https://github.com/dolmen) in [#1747](stretchr/testify#1747) - suite.Passed: add one more status test report by [@Ararsa-Derese](https://github.com/Ararsa-Derese) in [#1706](stretchr/testify#1706) - Add Helper() method in internal mocks and assert.CollectT by [@dolmen](https://github.com/dolmen) in [#1423](stretchr/testify#1423) - assert.Same/NotSame: improve usage of Sprintf by [@ccoVeille](https://github.com/ccoVeille) in [#1742](stretchr/testify#1742) - mock: enable parallel testing on internal testsuite by [@dolmen](https://github.com/dolmen) in [#1756](stretchr/testify#1756) - suite: cleanup use of 'testing' internals at runtime by [@dolmen](https://github.com/dolmen) in [#1751](stretchr/testify#1751) - assert: check test failure message for Empty and NotEmpty by [@ccoVeille](https://github.com/ccoVeille) in [#1745](stretchr/testify#1745) - deps: fix dependency cycle with objx (again) by [@dolmen](https://github.com/dolmen) in [#1567](stretchr/testify#1567) - assert.Empty: comprehensive doc of "Empty"-ness rules by [@dolmen](https://github.com/dolmen) in [#1753](stretchr/testify#1753) - doc: improve godoc of top level 'testify' package by [@dolmen](https://github.com/dolmen) in [#1760](stretchr/testify#1760) - assert.ErrorAs: simplify retrieving the type name by [@ccoVeille](https://github.com/ccoVeille) in [#1740](stretchr/testify#1740) - assert.EqualValues: improve test coverage to 100% by [@dolmen](https://github.com/dolmen) in [#1763](stretchr/testify#1763) - suite.Run: simplify running of Setup/TeardownSuite by [@renzoarreaza](https://github.com/renzoarreaza) in [#1769](stretchr/testify#1769) - assert.CallerInfo: micro optimization by using LastIndexByte by [@dolmen](https://github.com/dolmen) in [#1767](stretchr/testify#1767) - assert.CallerInfo: micro cleanup by [@dolmen](https://github.com/dolmen) in [#1768](stretchr/testify#1768) - assert: refactor Test*FileExists and Test*DirExists tests to enable parallel testing by [@dolmen](https://github.com/dolmen) in [#1766](stretchr/testify#1766) - suite.Run: refactor handling of stats for improved readability by [@dolmen](https://github.com/dolmen) in [#1764](stretchr/testify#1764) - tests: improve captureTestingT helper by [@ccoVeille](https://github.com/ccoVeille) in [#1741](stretchr/testify#1741) - build(deps): bump actions/checkout from 4 to 5 by [@dependabot](https://github.com/dependabot)\[bot] in [#1778](stretchr/testify#1778) #### New Contributors - [@greg0ire](https://github.com/greg0ire) made their first contribution in [#1710](stretchr/testify#1710) - [@techfg](https://github.com/techfg) made their first contribution in [#1709](stretchr/testify#1709) - [@mikeauclair](https://github.com/mikeauclair) made their first contribution in [#1614](stretchr/testify#1614) - [@cszczepaniak](https://github.com/cszczepaniak) made their first contribution in [#1427](stretchr/testify#1427) - [@architagr](https://github.com/architagr) made their first contribution in [#1675](stretchr/testify#1675) - [@tsioftas](https://github.com/tsioftas) made their first contribution in [#1681](stretchr/testify#1681) - [@siliconbrain](https://github.com/siliconbrain) made their first contribution in [#1729](stretchr/testify#1729) - [@bartventer](https://github.com/bartventer) made their first contribution in [#1730](stretchr/testify#1730) - [@Ararsa-Derese](https://github.com/Ararsa-Derese) made their first contribution in [#1706](stretchr/testify#1706) - [@renzoarreaza](https://github.com/renzoarreaza) made their first contribution in [#1769](stretchr/testify#1769) - [@3scalation](https://github.com/3scalation) made their first contribution in [#1743](stretchr/testify#1743) **Full Changelog**: <stretchr/testify@v1.10.0...v1.11.0> </details> --- ### Configuration 📅 **Schedule**: Branch creation - Between 12:00 AM and 03:59 AM ( * 0-3 * * * ) (UTC), Automerge - Between 12:00 AM and 03:59 AM ( * 0-3 * * * ) (UTC). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).    - other - [PR](https://code.forgejo.org/forgejo/runner/pulls/915): Update module github.com/stretchr/testify to v1.11.1  Reviewed-on: https://code.forgejo.org/forgejo/runner/pulls/915 Reviewed-by: earl-warren <earl-warren@noreply.code.forgejo.org> Co-authored-by: Renovate Bot <bot@kriese.eu> Co-committed-by: Renovate Bot <bot@kriese.eu>

dolmen self-assigned this Jul 13, 2023

dolmen changed the title ~~Add helper method in tests~~ Add Helper() method in internal mocks and assert.CollectT Jul 13, 2023

dolmen added pkg-mock Any issues related to Mock pkg-assert Change related to package testify/assert pkg-require Change related to package testify/require labels Jul 13, 2023

dolmen requested a review from brackendawson July 25, 2023 01:09

dolmen added TB.Helper Related to hiding testify calls in stack using testing.TB.Helper assert.Eventually About assert.Eventually/EventuallyWithT labels Jul 31, 2023

dolmen mentioned this pull request Jul 31, 2023

fix: make EventuallyWithT concurrency safe #1395

Merged

dolmen mentioned this pull request Oct 16, 2023

assert: IsIncreasing et al can return false w/out failing #1430

Closed

dolmen force-pushed the add-Helper-method-in-tests branch from 1d5a0dd to f79712c Compare October 16, 2023 19:03

dolmen added the hacktoberfest-accepted Hacktoberfest label Oct 16, 2023

dolmen force-pushed the add-Helper-method-in-tests branch from f79712c to da99481 Compare October 30, 2023 22:16

dolmen added the ready-for-merge label Oct 30, 2023

craig65535 approved these changes Oct 31, 2023

View reviewed changes

assert/assertions.go Show resolved Hide resolved

brackendawson previously approved these changes Feb 15, 2024

View reviewed changes

brackendawson modified the milestones: v1.8.5, v1.9.0, v1.9.1, v1.10 Feb 23, 2024

brackendawson modified the milestones: v1.10, v1.11 Dec 13, 2024

dolmen dismissed brackendawson’s stale review via 47f16f2 May 13, 2025 08:21

dolmen force-pushed the add-Helper-method-in-tests branch 2 times, most recently from 47f16f2 to 5c4ea9d Compare May 13, 2025 08:32

dolmen requested review from craig65535 and brackendawson May 13, 2025 08:34

dolmen added 4 commits May 25, 2025 21:56

assert/tests: add Helper() in all testing.T mocks

bf47cc8

Add an Helper() method to all mocks in tests of package 'assert'.

require/tests: add Helper() method to all mocks of *testing.T

b534400

mock/tests: add method Helper() to all mock of *testing.T

e2ad959

assert.CollectT: add Helper() method

8f73f15

Add Helper() method to CollectT like testing.T as we intend to add Helper() to the assert.TestingT interface.

dolmen force-pushed the add-Helper-method-in-tests branch from 5c4ea9d to 8f73f15 Compare May 25, 2025 19:56

dolmen requested review from ccoVeille and craig65535 and removed request for craig65535 May 25, 2025 19:58

ccoVeille approved these changes May 25, 2025

View reviewed changes

brackendawson merged commit c98ef6e into master May 27, 2025
16 checks passed

brackendawson deleted the add-Helper-method-in-tests branch May 27, 2025 06:22

yashuatla mentioned this pull request Jun 25, 2025

Feature implementation from commits 11522a0..0ff4bb4 yashuatla/testify#2

Open

SaveTheRbtz mentioned this pull request Aug 26, 2025

build(deps): bump github.com/stretchr/testify from 1.10.0 to 1.11.0 in /pkg SaveTheRbtz/zstd-seekable-format-go#210

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Add Helper() method in internal mocks and assert.CollectT #1423

Add Helper() method in internal mocks and assert.CollectT #1423

dolmen commented Jul 13, 2023

Uh oh!

Uh oh!

brackendawson left a comment

Uh oh!

ccoVeille left a comment

Uh oh!

Uh oh!

Uh oh!

Add Helper() method in internal mocks and assert.CollectT #1423

Add Helper() method in internal mocks and assert.CollectT #1423

Conversation

dolmen commented Jul 13, 2023

Summary

Changes

Motivation

Uh oh!

Uh oh!

brackendawson left a comment

Choose a reason for hiding this comment

Uh oh!

ccoVeille left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!