mock.AssertNumberOfCalls: improve error msg #1743

3scalation · 2025-05-15T21:16:37Z

Summary

Improve the error message raised my AssertNumberOfCalls.
This specify exactly what method mock is failing the test.

Motivation

When running my tests, I did not see any clear information of the exact method that was not correctly mocked. So I wanted to fix it.

Example of the new error message:


=== RUN   Test_Mock_AssertNumberOfCalls
    /tmp/testify/mock/mock_test.go:1644:
                Error Trace:    /tmp/testify/mock/mock_test.go:1644
                Error:          Not equal:
                                expected: 2
                                actual  : 3
                Test:           Test_Mock_AssertNumberOfCalls
                Messages:       Expected number of calls (2) of method (Test_Mock_AssertNumberOfCalls) does not match the actual number of calls (3).
    /tmp/testify/mock/mock_test.go:1644:
                Error Trace:    /tmp/testify/mock/mock_test.go:1644
                Error:          Should be true
                Test:           Test_Mock_AssertNumberOfCalls
--- FAIL: Test_Mock_AssertNumberOfCalls (0.00s)

dolmen · 2025-05-22T08:25:46Z

@3scalation Please take more care in chosing your PR title: there are 139 PR opened on this project which is about 4 different Go packages, and many of the PR are about wording.

dolmen

Formatting can be improved.

mock/mock.go

3scalation · 2025-05-22T13:33:29Z

Indeed you're right, I'll be more careful in the future !
Let me know if there anything else to adjust 👍

dolmen · 2025-05-25T04:09:45Z

Could you improve the tes suite to add checks for the message?

Co-authored-by: Olivier Mengué <dolmen@cpan.org>

…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>

3scalation marked this pull request as ready for review May 15, 2025 21:19

dolmen added the pkg-mock Any issues related to Mock label May 22, 2025

dolmen requested changes May 22, 2025

View reviewed changes

mock/mock.go Outdated Show resolved Hide resolved

dolmen changed the title ~~improve error msg~~ mock.AssertNumberOfCalls: improve error msg May 22, 2025

dolmen assigned 3scalation May 22, 2025

dolmen added the enhancement label May 22, 2025

dolmen approved these changes Jun 16, 2025

View reviewed changes

dolmen force-pushed the feat/improve_error_msg branch from 9a65b84 to 37236db Compare June 16, 2025 10:58

api-card and others added 2 commits June 30, 2025 18:15

improve error msg

4ec70c9

mock: improve formatting of error message

56a3723

Co-authored-by: Olivier Mengué <dolmen@cpan.org>

dolmen force-pushed the feat/improve_error_msg branch from 5a4a07b to 56a3723 Compare June 30, 2025 16:15

dolmen merged commit aafb604 into stretchr:master Jun 30, 2025
8 checks passed

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!

mock.AssertNumberOfCalls: improve error msg #1743

mock.AssertNumberOfCalls: improve error msg #1743

3scalation commented May 15, 2025 •

edited

Loading

Uh oh!

dolmen commented May 22, 2025 •

edited

Loading

Uh oh!

dolmen left a comment

Uh oh!

Uh oh!

3scalation commented May 22, 2025

Uh oh!

dolmen commented May 25, 2025

Uh oh!

Uh oh!

Uh oh!

mock.AssertNumberOfCalls: improve error msg #1743

mock.AssertNumberOfCalls: improve error msg #1743

Conversation

3scalation commented May 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Motivation

Uh oh!

dolmen commented May 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

dolmen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

3scalation commented May 22, 2025

Uh oh!

dolmen commented May 25, 2025

Uh oh!

Uh oh!

Uh oh!

3scalation commented May 15, 2025 •

edited

Loading

dolmen commented May 22, 2025 •

edited

Loading