mock: in order mock calls #1637

ReyOrtiz · 2024-09-06T13:23:11Z

Summary

Add helper method to declare the order of the mock calls.

Changes

add InOrder(calls ...*Call) helper method to declare the order of mock calls by calling NotBefore()

Motivation

This is probably the only feature I miss from gomock.InOrder(), it is more intuitive and cleaner to declare the order of the mock calls. Probably most cases can be satisfied with this method.

InOrder(
	mockedService1.On("TheExampleMethod", 1, 2, 3).Return(4, nil),
	mockedService2.On("TheExampleMethod2", true).Return(),
	mockedService3.On("TheExampleMethod3", "abc", 3).Return(false, nil),
)

Related issues

Closes #1639

brackendawson

Can we get a unit test, please.

ReyOrtiz · 2024-09-25T15:28:44Z

unit test added

brackendawson

Positive and negative tests, nice one. 👍 Just a couple of small comments.

brackendawson · 2024-09-25T15:40:27Z

mock/mock_test.go

+		c,
+	)
+
+	require.Equal(t, []*Call{b, c}, mockedService.ExpectedCalls)


This line is testing the implementation. A cost effective test would only test the behaviour, as you are doing just fine after this line.

If you remove this assertion then we are free to change the implementation of the intended behaviour without breaking the test. It also removes the need to declare b and c, so the test can be written as InOrder is intended to be used.

Also, it's just comparing pointer values. If InOrder did literally nothing then that assertion would still pass.

mock/mock.go

(requested changes applied)

ReyOrtiz · 2024-09-25T16:05:30Z

Good comments, thanks! Requested changes applied.

brackendawson

Looks good to me, should be helpful to all the developers moving from gomock. I'll give some time for other maintainers to review before I merge.

jybp · 2024-09-26T08:55:59Z

Ah you beat me to it, thanks! And missed that existing PR

ReyOrtiz · 2024-10-02T15:43:20Z

Hello, any ETA on merging this PR?

brackendawson · 2024-10-02T16:25:37Z

Thanks @ReyOrtiz. This can be consumed now by gomock expats with: go get github.com/stretchr/testify@master. Once testify v1.10 is released it can be consumed as per the README. I'll have a look at drafting a release soon.

ReyOrtiz · 2024-10-02T16:27:25Z

Thanks @brackendawson for all the help! 🙏

…nercloud/fleeting-plugin-hetzner!175) This MR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/stretchr/testify](https://github.com/stretchr/testify) | require | minor | `v1.9.0` -> `v1.10.0` | --- ### Release Notes <details> <summary>stretchr/testify (github.com/stretchr/testify)</summary> ### [`v1.10.0`](https://github.com/stretchr/testify/releases/tag/v1.10.0) [Compare Source](stretchr/testify@v1.9.0...v1.10.0) #### What's Changed ##### Functional Changes - Add PanicAssertionFunc by [@fahimbagar](https://github.com/fahimbagar) in stretchr/testify#1337 - assert: deprecate CompareType by [@dolmen](https://github.com/dolmen) in stretchr/testify#1566 - assert: make YAML dependency pluggable via build tags by [@dolmen](https://github.com/dolmen) in stretchr/testify#1579 - assert: new assertion NotElementsMatch by [@hendrywiranto](https://github.com/hendrywiranto) in stretchr/testify#1600 - mock: in order mock calls by [@ReyOrtiz](https://github.com/ReyOrtiz) in stretchr/testify#1637 - Add assertion for NotErrorAs by [@palsivertsen](https://github.com/palsivertsen) in stretchr/testify#1129 - Record Return Arguments of a Call by [@jayd3e](https://github.com/jayd3e) in stretchr/testify#1636 - assert.EqualExportedValues: accepts everything by [@redachl](https://github.com/redachl) in stretchr/testify#1586 ##### Fixes - assert: make tHelper a type alias by [@dolmen](https://github.com/dolmen) in stretchr/testify#1562 - Do not get argument again unnecessarily in Arguments.Error() by [@TomWright](https://github.com/TomWright) in stretchr/testify#820 - Fix time.Time compare by [@myxo](https://github.com/myxo) in stretchr/testify#1582 - assert.Regexp: handle \[]byte array properly by [@kevinburkesegment](https://github.com/kevinburkesegment) in stretchr/testify#1587 - assert: collect.FailNow() should not panic by [@marshall-lee](https://github.com/marshall-lee) in stretchr/testify#1481 - mock: simplify implementation of FunctionalOptions by [@dolmen](https://github.com/dolmen) in stretchr/testify#1571 - mock: caller information for unexpected method call by [@spirin](https://github.com/spirin) in stretchr/testify#1644 - suite: fix test failures by [@stevenh](https://github.com/stevenh) in stretchr/testify#1421 - Fix issue [#1662](stretchr/testify#1662) (comparing infs should fail) by [@ybrustin](https://github.com/ybrustin) in stretchr/testify#1663 - NotSame should fail if args are not pointers [#1661](stretchr/testify#1661) by [@sikehish](https://github.com/sikehish) in stretchr/testify#1664 - Increase timeouts in Test_Mock_Called_blocks to reduce flakiness in CI by [@sikehish](https://github.com/sikehish) in stretchr/testify#1667 - fix: compare functional option names for indirect calls by [@arjun-1](https://github.com/arjun-1) in stretchr/testify#1626 ##### Documantation, Build & CI - .gitignore: ignore "go test -c" binaries by [@dolmen](https://github.com/dolmen) in stretchr/testify#1565 - mock: improve doc by [@dolmen](https://github.com/dolmen) in stretchr/testify#1570 - mock: fix FunctionalOptions docs by [@snirye](https://github.com/snirye) in stretchr/testify#1433 - README: link out to the excellent testifylint by [@brackendawson](https://github.com/brackendawson) in stretchr/testify#1568 - assert: fix typo in comment by [@JohnEndson](https://github.com/JohnEndson) in stretchr/testify#1580 - Correct the EventuallyWithT and EventuallyWithTf example by [@JonCrowther](https://github.com/JonCrowther) in stretchr/testify#1588 - CI: bump softprops/action-gh-release from 1 to 2 by [@dependabot](https://github.com/dependabot) in stretchr/testify#1575 - mock: document more alternatives to deprecated AnythingOfTypeArgument by [@dolmen](https://github.com/dolmen) in stretchr/testify#1569 - assert: Correctly document EqualValues behavior by [@brackendawson](https://github.com/brackendawson) in stretchr/testify#1593 - fix: grammar in godoc by [@miparnisari](https://github.com/miparnisari) in stretchr/testify#1607 - .github/workflows: Run tests for Go 1.22 by [@HaraldNordgren](https://github.com/HaraldNordgren) in stretchr/testify#1629 - Document suite's lack of support for t.Parallel by [@brackendawson](https://github.com/brackendawson) in stretchr/testify#1645 - assert: fix typos in comments by [@alexandear](https://github.com/alexandear) in stretchr/testify#1650 - mock: fix doc comment for NotBefore by [@alexandear](https://github.com/alexandear) in stretchr/testify#1651 - Generate better comments for require package by [@Neokil](https://github.com/Neokil) in stretchr/testify#1610 - README: replace Testify V2 notice with [@dolmen](https://github.com/dolmen)'s V2 manifesto by [@hendrywiranto](https://github.com/hendrywiranto) in stretchr/testify#1518 #### New Contributors - [@fahimbagar](https://github.com/fahimbagar) made their first contribution in stretchr/testify#1337 - [@TomWright](https://github.com/TomWright) made their first contribution in stretchr/testify#820 - [@snirye](https://github.com/snirye) made their first contribution in stretchr/testify#1433 - [@myxo](https://github.com/myxo) made their first contribution in stretchr/testify#1582 - [@JohnEndson](https://github.com/JohnEndson) made their first contribution in stretchr/testify#1580 - [@JonCrowther](https://github.com/JonCrowther) made their first contribution in stretchr/testify#1588 - [@miparnisari](https://github.com/miparnisari) made their first contribution in stretchr/testify#1607 - [@marshall-lee](https://github.com/marshall-lee) made their first contribution in stretchr/testify#1481 - [@spirin](https://github.com/spirin) made their first contribution in stretchr/testify#1644 - [@ReyOrtiz](https://github.com/ReyOrtiz) made their first contribution in stretchr/testify#1637 - [@stevenh](https://github.com/stevenh) made their first contribution in stretchr/testify#1421 - [@jayd3e](https://github.com/jayd3e) made their first contribution in stretchr/testify#1636 - [@Neokil](https://github.com/Neokil) made their first contribution in stretchr/testify#1610 - [@redachl](https://github.com/redachl) made their first contribution in stretchr/testify#1586 - [@ybrustin](https://github.com/ybrustin) made their first contribution in stretchr/testify#1663 - [@sikehish](https://github.com/sikehish) made their first contribution in stretchr/testify#1664 - [@arjun-1](https://github.com/arjun-1) made their first contribution in stretchr/testify#1626 **Full Changelog**: stretchr/testify@v1.9.0...v1.10.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 MR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/stretchr/testify](https://github.com/stretchr/testify) | require | minor | `v1.9.0` -> `v1.10.0` | --- ### Release Notes <details> <summary>stretchr/testify (github.com/stretchr/testify)</summary> ### [`v1.10.0`](https://github.com/stretchr/testify/releases/tag/v1.10.0) [Compare Source](stretchr/testify@v1.9.0...v1.10.0) #### What's Changed ##### Functional Changes - Add PanicAssertionFunc by [@fahimbagar](https://github.com/fahimbagar) in stretchr/testify#1337 - assert: deprecate CompareType by [@dolmen](https://github.com/dolmen) in stretchr/testify#1566 - assert: make YAML dependency pluggable via build tags by [@dolmen](https://github.com/dolmen) in stretchr/testify#1579 - assert: new assertion NotElementsMatch by [@hendrywiranto](https://github.com/hendrywiranto) in stretchr/testify#1600 - mock: in order mock calls by [@ReyOrtiz](https://github.com/ReyOrtiz) in stretchr/testify#1637 - Add assertion for NotErrorAs by [@palsivertsen](https://github.com/palsivertsen) in stretchr/testify#1129 - Record Return Arguments of a Call by [@jayd3e](https://github.com/jayd3e) in stretchr/testify#1636 - assert.EqualExportedValues: accepts everything by [@redachl](https://github.com/redachl) in stretchr/testify#1586 ##### Fixes - assert: make tHelper a type alias by [@dolmen](https://github.com/dolmen) in stretchr/testify#1562 - Do not get argument again unnecessarily in Arguments.Error() by [@TomWright](https://github.com/TomWright) in stretchr/testify#820 - Fix time.Time compare by [@myxo](https://github.com/myxo) in stretchr/testify#1582 - assert.Regexp: handle \[]byte array properly by [@kevinburkesegment](https://github.com/kevinburkesegment) in stretchr/testify#1587 - assert: collect.FailNow() should not panic by [@marshall-lee](https://github.com/marshall-lee) in stretchr/testify#1481 - mock: simplify implementation of FunctionalOptions by [@dolmen](https://github.com/dolmen) in stretchr/testify#1571 - mock: caller information for unexpected method call by [@spirin](https://github.com/spirin) in stretchr/testify#1644 - suite: fix test failures by [@stevenh](https://github.com/stevenh) in stretchr/testify#1421 - Fix issue [#1662](stretchr/testify#1662) (comparing infs should fail) by [@ybrustin](https://github.com/ybrustin) in stretchr/testify#1663 - NotSame should fail if args are not pointers [#1661](stretchr/testify#1661) by [@sikehish](https://github.com/sikehish) in stretchr/testify#1664 - Increase timeouts in Test_Mock_Called_blocks to reduce flakiness in CI by [@sikehish](https://github.com/sikehish) in stretchr/testify#1667 - fix: compare functional option names for indirect calls by [@arjun-1](https://github.com/arjun-1) in stretchr/testify#1626 ##### Documantation, Build & CI - .gitignore: ignore "go test -c" binaries by [@dolmen](https://github.com/dolmen) in stretchr/testify#1565 - mock: improve doc by [@dolmen](https://github.com/dolmen) in stretchr/testify#1570 - mock: fix FunctionalOptions docs by [@snirye](https://github.com/snirye) in stretchr/testify#1433 - README: link out to the excellent testifylint by [@brackendawson](https://github.com/brackendawson) in stretchr/testify#1568 - assert: fix typo in comment by [@JohnEndson](https://github.com/JohnEndson) in stretchr/testify#1580 - Correct the EventuallyWithT and EventuallyWithTf example by [@JonCrowther](https://github.com/JonCrowther) in stretchr/testify#1588 - CI: bump softprops/action-gh-release from 1 to 2 by [@dependabot](https://github.com/dependabot) in stretchr/testify#1575 - mock: document more alternatives to deprecated AnythingOfTypeArgument by [@dolmen](https://github.com/dolmen) in stretchr/testify#1569 - assert: Correctly document EqualValues behavior by [@brackendawson](https://github.com/brackendawson) in stretchr/testify#1593 - fix: grammar in godoc by [@miparnisari](https://github.com/miparnisari) in stretchr/testify#1607 - .github/workflows: Run tests for Go 1.22 by [@HaraldNordgren](https://github.com/HaraldNordgren) in stretchr/testify#1629 - Document suite's lack of support for t.Parallel by [@brackendawson](https://github.com/brackendawson) in stretchr/testify#1645 - assert: fix typos in comments by [@alexandear](https://github.com/alexandear) in stretchr/testify#1650 - mock: fix doc comment for NotBefore by [@alexandear](https://github.com/alexandear) in stretchr/testify#1651 - Generate better comments for require package by [@Neokil](https://github.com/Neokil) in stretchr/testify#1610 - README: replace Testify V2 notice with [@dolmen](https://github.com/dolmen)'s V2 manifesto by [@hendrywiranto](https://github.com/hendrywiranto) in stretchr/testify#1518 #### New Contributors - [@fahimbagar](https://github.com/fahimbagar) made their first contribution in stretchr/testify#1337 - [@TomWright](https://github.com/TomWright) made their first contribution in stretchr/testify#820 - [@snirye](https://github.com/snirye) made their first contribution in stretchr/testify#1433 - [@myxo](https://github.com/myxo) made their first contribution in stretchr/testify#1582 - [@JohnEndson](https://github.com/JohnEndson) made their first contribution in stretchr/testify#1580 - [@JonCrowther](https://github.com/JonCrowther) made their first contribution in stretchr/testify#1588 - [@miparnisari](https://github.com/miparnisari) made their first contribution in stretchr/testify#1607 - [@marshall-lee](https://github.com/marshall-lee) made their first contribution in stretchr/testify#1481 - [@spirin](https://github.com/spirin) made their first contribution in stretchr/testify#1644 - [@ReyOrtiz](https://github.com/ReyOrtiz) made their first contribution in stretchr/testify#1637 - [@stevenh](https://github.com/stevenh) made their first contribution in stretchr/testify#1421 - [@jayd3e](https://github.com/jayd3e) made their first contribution in stretchr/testify#1636 - [@Neokil](https://github.com/Neokil) made their first contribution in stretchr/testify#1610 - [@redachl](https://github.com/redachl) made their first contribution in stretchr/testify#1586 - [@ybrustin](https://github.com/ybrustin) made their first contribution in stretchr/testify#1663 - [@sikehish](https://github.com/sikehish) made their first contribution in stretchr/testify#1664 - [@arjun-1](https://github.com/arjun-1) made their first contribution in stretchr/testify#1626 **Full Changelog**: stretchr/testify@v1.9.0...v1.10.0 </details> --- - [ ] If you want to rebase/retry this MR, check this box ---    See merge request alpine/infra/build-server-status!18

mock: in order mock calls

7268a5b

brackendawson closed this Sep 25, 2024

brackendawson reopened this Sep 25, 2024

brackendawson requested changes Sep 25, 2024

View reviewed changes

mock: in order mock calls

bdb1271

ReyOrtiz requested a review from brackendawson September 25, 2024 15:28

brackendawson requested changes Sep 25, 2024

View reviewed changes

mock: in order mock calls

f17409f

(requested changes applied)

ReyOrtiz requested a review from brackendawson September 25, 2024 16:05

brackendawson approved these changes Sep 25, 2024

View reviewed changes

Merge branch 'master' into master

85a5268

brackendawson merged commit c4b8421 into stretchr:master Oct 2, 2024
7 checks passed

renovate bot mentioned this pull request Jan 2, 2025

fix(deps): update all patch and minor mvisonneau/mmds#675

Open

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

mock: in order mock calls #1637

mock: in order mock calls #1637

ReyOrtiz commented Sep 6, 2024 •

edited by brackendawson

Loading

brackendawson left a comment

ReyOrtiz commented Sep 25, 2024

brackendawson left a comment

brackendawson Sep 25, 2024

brackendawson Sep 25, 2024

ReyOrtiz commented Sep 25, 2024

brackendawson left a comment

jybp commented Sep 26, 2024 •

edited

Loading

ReyOrtiz commented Oct 2, 2024

brackendawson commented Oct 2, 2024

ReyOrtiz commented Oct 2, 2024

mock: in order mock calls #1637

mock: in order mock calls #1637

Conversation

ReyOrtiz commented Sep 6, 2024 • edited by brackendawson Loading

Summary

Changes

Motivation

Related issues

brackendawson left a comment

Choose a reason for hiding this comment

ReyOrtiz commented Sep 25, 2024

brackendawson left a comment

Choose a reason for hiding this comment

brackendawson Sep 25, 2024

Choose a reason for hiding this comment

brackendawson Sep 25, 2024

Choose a reason for hiding this comment

ReyOrtiz commented Sep 25, 2024

brackendawson left a comment

Choose a reason for hiding this comment

jybp commented Sep 26, 2024 • edited Loading

ReyOrtiz commented Oct 2, 2024

brackendawson commented Oct 2, 2024

ReyOrtiz commented Oct 2, 2024

ReyOrtiz commented Sep 6, 2024 •

edited by brackendawson

Loading

jybp commented Sep 26, 2024 •

edited

Loading