Fix Call.Unset() panic (issue #1236) #1250

lisitsky · 2022-08-15T20:58:49Z

Summary

Unset() doesn't work as expected in documentation. Instead of unsetting call specification it causes panic.

Reason: During call specification filtering Unset() changes len of a ExpectedCalls slice while using index from original slice. Under some circumstances it tries to reslice elements beyond of the slice boundaries. That causes panic.

Changes

The proposed solution uses independent write index to count elements kept in result slice.
Tests (the simplest and a more complicated cases) and comments are included.

Motivation

Because core functionality required by users to write tests doesn't work as expected.

// Unset removes a mock handler from being called.
test.On("func", mock.Anything).Return(nil)  // OK
test.On("func", mock.Anything).Unset()      // panic

Related issues

Closes #1236

Unset changes len of a `ExpectedCalls` slice during iteration while using index from original slice, and under some conditions it tries to reslice element beyond of the slice boundaries. That causes panic. The proposed solution uses independent write index to count elements kept in output slice. Tests (the simplest and more complicated cases) and comments are included.

lisitsky · 2022-08-27T08:16:22Z

Hello, @glesica , @boyan-soubachov , @mvdkleijn !
Could you please check this MR - it closes panic and makes tests behavior as it is documented.
Thank you very much!

mweibel · 2022-11-02T09:10:36Z

ping - that'd be great to have fixed 👍

felixliou · 2022-11-11T08:49:46Z

mock/mock.go

-	for i, call := range c.Parent.ExpectedCalls {
+	// in-place filter slice for calls to be removed - iterate from 0'th to last skipping unnecessary ones
+	var index int // write index
+	for _, call := range c.Parent.ExpectedCalls {


modify looks good to me

Hello, @felixliou!
Perhaps I misunderstood you.
Do you mean "looks ok now, and ready for merge" or you ask me modify the code?
If so, could you pls clarify which modifications are required? Thank you.

looks ok now, and ready for merge，but I have not authorized to merge this PR.

Thank you for your feedback. Do you know anybody (possibly maintainers?) who can do it? Could you ping they please?

Hi，
@ernesto-jimenez
@matryer
@boyan-soubachov

Please check this pull request.

Thank you very much

lisitsky · 2022-11-14T03:46:02Z

ping - that'd be great to have fixed 👍

@mweibel, yes, but how to promote it to accept? )

boyan-soubachov

Thank you for this contribution, approved and merging :)

lefinal · 2023-02-13T15:20:28Z

When can we expect this to be released?

This MR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [github.com/stretchr/testify](https://github.com/stretchr/testify) | require | minor | `v1.8.0` -> `v1.9.0` | --- ### Release Notes <details> <summary>stretchr/testify (github.com/stretchr/testify)</summary> ### [`v1.9.0`](https://github.com/stretchr/testify/releases/tag/v1.9.0) [Compare Source](stretchr/testify@v1.8.4...v1.9.0) #### What's Changed - Fix Go modules version by [@SuperQ](https://github.com/SuperQ) in stretchr/testify#1394 - Document that require is not safe to call in created goroutines by [@programmer04](https://github.com/programmer04) in stretchr/testify#1392 - Remove myself from MAINTAINERS.md by [@mvdkleijn](https://github.com/mvdkleijn) in stretchr/testify#1367 - Correct spelling/grammar by [@echarrod](https://github.com/echarrod) in stretchr/testify#1389 - docs: Update URLs in README by [@davidjb](https://github.com/davidjb) in stretchr/testify#1349 - Update mockery link to Github Pages in README by [@LandonTClipp](https://github.com/LandonTClipp) in stretchr/testify#1346 - docs: Fix typos in tests and comments by [@alexandear](https://github.com/alexandear) in stretchr/testify#1410 - CI: tests from go1.17 by [@SuperQ](https://github.com/SuperQ) in stretchr/testify#1409 - Fix adding ? when no values passed by [@lesichkovm](https://github.com/lesichkovm) in stretchr/testify#1320 - codegen: use standard header for generated files by [@dolmen](https://github.com/dolmen) in stretchr/testify#1406 - mock: AssertExpectations log reason only on failure by [@hikyaru-suzuki](https://github.com/hikyaru-suzuki) in stretchr/testify#1360 - assert: fix flaky TestNeverTrue by [@dolmen](https://github.com/dolmen) in stretchr/testify#1417 - README: fix typos "set up" vs "setup" by [@ossan-dev](https://github.com/ossan-dev) in stretchr/testify#1428 - mock: move regexp compilation outside of `Called` by [@aud10slave](https://github.com/aud10slave) in stretchr/testify#631 - assert: refactor internal func getLen() by [@dolmen](https://github.com/dolmen) in stretchr/testify#1445 - mock: deprecate type AnythingOfTypeArgument ([#1434](stretchr/testify#1434)) by [@dolmen](https://github.com/dolmen) in stretchr/testify#1441 - Remove no longer needed assert.canConvert by [@alexandear](https://github.com/alexandear) in stretchr/testify#1470 - assert: ObjectsAreEqual: use time.Equal for time.Time types by [@tscales](https://github.com/tscales) in stretchr/testify#1464 - Bump actions/checkout from 3 to 4 by [@dependabot](https://github.com/dependabot) in stretchr/testify#1466 - Bump actions/setup-go from 3.2.0 to 4.1.0 by [@dependabot](https://github.com/dependabot) in stretchr/testify#1451 - fix: make EventuallyWithT concurrency safe by [@czeslavo](https://github.com/czeslavo) in stretchr/testify#1395 - assert: fix httpCode and HTTPBody occur panic when http.Handler read Body by [@hidu](https://github.com/hidu) in stretchr/testify#1484 - assert.EqualExportedValues: fix handling of arrays by [@zrbecker](https://github.com/zrbecker) in stretchr/testify#1473 - .github: use latest Go versions by [@kevinburkesegment](https://github.com/kevinburkesegment) in stretchr/testify#1489 - assert: Deprecate EqualExportedValues by [@HaraldNordgren](https://github.com/HaraldNordgren) in stretchr/testify#1488 - suite: refactor test assertions by [@alexandear](https://github.com/alexandear) in stretchr/testify#1474 - suite: fix SetupSubTest and TearDownSubTest execution order by [@linusbarth](https://github.com/linusbarth) in stretchr/testify#1471 - docs: Fix deprecation comments for http package by [@alexandear](https://github.com/alexandear) in stretchr/testify#1335 - Add map support doc comments to Subset and NotSubset by [@jedevc](https://github.com/jedevc) in stretchr/testify#1306 - TestErrorIs/TestNotErrorIs: check error message contents by [@craig65535](https://github.com/craig65535) in stretchr/testify#1435 - suite: fix subtest names (fix [#1501](stretchr/testify#1501)) by [@dolmen](https://github.com/dolmen) in stretchr/testify#1504 - assert: improve unsafe.Pointer tests by [@dolmen](https://github.com/dolmen) in stretchr/testify#1505 - assert: simplify isNil implementation by [@dolmen](https://github.com/dolmen) in stretchr/testify#1506 - assert.InEpsilonSlice: fix expected/actual order and other improvements by [@dolmen](https://github.com/dolmen) in stretchr/testify#1483 - Fix dependency cycle with objx [#1292](stretchr/testify#1292) by [@dolmen](https://github.com/dolmen) in stretchr/testify#1453 - mock: refactor TestIsArgsEqual by [@dolmen](https://github.com/dolmen) in stretchr/testify#1444 - mock: optimize argument matching checks by [@dolmen](https://github.com/dolmen) in stretchr/testify#1416 - assert: fix TestEventuallyTimeout by [@dolmen](https://github.com/dolmen) in stretchr/testify#1412 - CI: add go 1.21 in GitHub Actions by [@dolmen](https://github.com/dolmen) in stretchr/testify#1450 - suite: fix recoverAndFailOnPanic to report test failure at the right location by [@dolmen](https://github.com/dolmen) in stretchr/testify#1502 - Update maintainers by [@brackendawson](https://github.com/brackendawson) in stretchr/testify#1533 - assert: Fix EqualValues to handle overflow/underflow by [@arjunmahishi](https://github.com/arjunmahishi) in stretchr/testify#1531 - assert: better formatting for Len() error by [@kevinburkesegment](https://github.com/kevinburkesegment) in stretchr/testify#1485 - Ensure AssertExpectations does not fail in skipped tests by [@ianrose14](https://github.com/ianrose14) in stretchr/testify#1331 - suite: fix deadlock in suite.Require()/Assert() by [@arjunmahishi](https://github.com/arjunmahishi) in stretchr/testify#1535 - Revert "assert: ObjectsAreEqual: use time.Equal for time.Time type" by [@brackendawson](https://github.com/brackendawson) in stretchr/testify#1537 - \[chore] Add issue templates by [@arjunmahishi](https://github.com/arjunmahishi) in stretchr/testify#1538 - Update the build status badge by [@brackendawson](https://github.com/brackendawson) in stretchr/testify#1540 - Update Github workflows setup-go to V5 by [@hendrywiranto](https://github.com/hendrywiranto) in stretchr/testify#1545 - Support Pointer to Struct in EqualExportedValues by [@Lucaber](https://github.com/Lucaber) in stretchr/testify#1517 - README: drop link to gorc by [@guettli](https://github.com/guettli) in stretchr/testify#1248 - http_assertions: honour the msgAndArgs provided with each assertion by [@arjunmahishi](https://github.com/arjunmahishi) in stretchr/testify#1548 - fix typos in comments and tests by [@ccoVeille](https://github.com/ccoVeille) in stretchr/testify#1247 - Include the auto-release notes in releases by [@brackendawson](https://github.com/brackendawson) in stretchr/testify#1550 - Add `NotImplements` and variants by [@hslatman](https://github.com/hslatman) in stretchr/testify#1385 - Add support to compare uintptr by [@bogdandrutu](https://github.com/bogdandrutu) in stretchr/testify#1339 - build(deps): bump github.com/stretchr/objx from 0.5.1 to 0.5.2 by [@dependabot](https://github.com/dependabot) in stretchr/testify#1552 #### New Contributors - [@SuperQ](https://github.com/SuperQ) made their first contribution in stretchr/testify#1394 - [@programmer04](https://github.com/programmer04) made their first contribution in stretchr/testify#1392 - [@echarrod](https://github.com/echarrod) made their first contribution in stretchr/testify#1389 - [@davidjb](https://github.com/davidjb) made their first contribution in stretchr/testify#1349 - [@LandonTClipp](https://github.com/LandonTClipp) made their first contribution in stretchr/testify#1346 - [@alexandear](https://github.com/alexandear) made their first contribution in stretchr/testify#1410 - [@lesichkovm](https://github.com/lesichkovm) made their first contribution in stretchr/testify#1320 - [@dolmen](https://github.com/dolmen) made their first contribution in stretchr/testify#1406 - [@hikyaru-suzuki](https://github.com/hikyaru-suzuki) made their first contribution in stretchr/testify#1360 - [@ossan-dev](https://github.com/ossan-dev) made their first contribution in stretchr/testify#1428 - [@aud10slave](https://github.com/aud10slave) made their first contribution in stretchr/testify#631 - [@tscales](https://github.com/tscales) made their first contribution in stretchr/testify#1464 - [@czeslavo](https://github.com/czeslavo) made their first contribution in stretchr/testify#1395 - [@hidu](https://github.com/hidu) made their first contribution in stretchr/testify#1484 - [@zrbecker](https://github.com/zrbecker) made their first contribution in stretchr/testify#1473 - [@kevinburkesegment](https://github.com/kevinburkesegment) made their first contribution in stretchr/testify#1489 - [@linusbarth](https://github.com/linusbarth) made their first contribution in stretchr/testify#1471 - [@jedevc](https://github.com/jedevc) made their first contribution in stretchr/testify#1306 - [@craig65535](https://github.com/craig65535) made their first contribution in stretchr/testify#1435 - [@arjunmahishi](https://github.com/arjunmahishi) made their first contribution in stretchr/testify#1531 - [@ianrose14](https://github.com/ianrose14) made their first contribution in stretchr/testify#1331 - [@hendrywiranto](https://github.com/hendrywiranto) made their first contribution in stretchr/testify#1545 - [@Lucaber](https://github.com/Lucaber) made their first contribution in stretchr/testify#1517 - [@guettli](https://github.com/guettli) made their first contribution in stretchr/testify#1248 - [@ccoVeille](https://github.com/ccoVeille) made their first contribution in stretchr/testify#1247 - [@hslatman](https://github.com/hslatman) made their first contribution in stretchr/testify#1385 - [@bogdandrutu](https://github.com/bogdandrutu) made their first contribution in stretchr/testify#1339 **Full Changelog**: stretchr/testify@v1.8.4...v1.9.0 ### [`v1.8.4`](https://github.com/stretchr/testify/releases/tag/v1.8.4) [Compare Source](stretchr/testify@v1.8.3...v1.8.4) #### What's Changed - Create GitHub release when new release tag is pushed by [@aldas](https://github.com/aldas) in stretchr/testify#1354 #### New Contributors - [@aldas](https://github.com/aldas) made their first contribution in stretchr/testify#1354 **Full Changelog**: stretchr/testify@v1.8.3...v1.8.4 ### [`v1.8.3`](https://github.com/stretchr/testify/releases/tag/v1.8.3) [Compare Source](stretchr/testify@v1.8.2...v1.8.3) #### What's Changed - Compare public elements of struct by [@mchlp](https://github.com/mchlp) in stretchr/testify#1309 - assert: fix error message formatting for NotContains by [@wwade](https://github.com/wwade) in stretchr/testify#1362 - allow testing for functional options by [@nbaztec](https://github.com/nbaztec) in stretchr/testify#1023 - add EventuallyWithT assertion by [@tobikris](https://github.com/tobikris) in stretchr/testify#1264 - EqualExportedValues: Handle nested pointer, slice and map fields by [@HaraldNordgren](https://github.com/HaraldNordgren) in stretchr/testify#1379 #### New Contributors - [@mchlp](https://github.com/mchlp) made their first contribution in stretchr/testify#1309 - [@wwade](https://github.com/wwade) made their first contribution in stretchr/testify#1362 - [@nbaztec](https://github.com/nbaztec) made their first contribution in stretchr/testify#1023 - [@tobikris](https://github.com/tobikris) made their first contribution in stretchr/testify#1264 **Full Changelog**: stretchr/testify@v1.8.2...v1.8.3 ### [`v1.8.2`](https://github.com/stretchr/testify/releases/tag/v1.8.2) [Compare Source](stretchr/testify@v1.8.1...v1.8.2) #### What's Changed - Add opportunity to trigger setup/teardown for subtest by [@qerdcv](https://github.com/qerdcv) in stretchr/testify#1246 - fix: fix bug for check unsafe.Pointer isNil by [@sunpe](https://github.com/sunpe) in stretchr/testify#1319 - Fix Call.Unset() panic (issue [#1236](stretchr/testify#1236)) by [@lisitsky](https://github.com/lisitsky) in stretchr/testify#1250 - Fix `CallerInfo()` source file paths by [@bozaro](https://github.com/bozaro) in stretchr/testify#1288 - assert: Fix Subset/NotSubset when map is missing keys from the subset by [@danielwhite](https://github.com/danielwhite) in stretchr/testify#1261 #### New Contributors - [@qerdcv](https://github.com/qerdcv) made their first contribution in stretchr/testify#1246 - [@sunpe](https://github.com/sunpe) made their first contribution in stretchr/testify#1319 - [@lisitsky](https://github.com/lisitsky) made their first contribution in stretchr/testify#1250 - [@bozaro](https://github.com/bozaro) made their first contribution in stretchr/testify#1288 - [@danielwhite](https://github.com/danielwhite) made their first contribution in stretchr/testify#1261 **Full Changelog**: stretchr/testify@v1.8.1...v1.8.2 ### [`v1.8.1`](https://github.com/stretchr/testify/releases/tag/v1.8.1) [Compare Source](stretchr/testify@v1.8.0...v1.8.1) #### What's Changed - Bump github.com/stretchr/objx from 0.4.0 to 0.5.0 by [@dependabot](https://github.com/dependabot) in stretchr/testify#1283 **Full Changelog**: stretchr/testify@v1.8.0...v1.8.1 </details> --- - [ ] If you want to rebase/retry this MR, check this box ---    See merge request alpine/infra/build-server-status!12

lisitsky mentioned this pull request Aug 15, 2022

mockCall.Unset cause panic #1236

Closed

lisitsky force-pushed the issue-1236-fix-unset-panic branch from d830d5b to d659ea1 Compare August 16, 2022 05:35

felixliou reviewed Nov 11, 2022

View reviewed changes

boyan-soubachov approved these changes Jan 3, 2023

View reviewed changes

boyan-soubachov merged commit 2b00d33 into stretchr:master Jan 3, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix Call.Unset() panic (issue #1236) #1250

Fix Call.Unset() panic (issue #1236) #1250

lisitsky commented Aug 15, 2022 •

edited

lisitsky commented Aug 27, 2022

mweibel commented Nov 2, 2022

felixliou Nov 11, 2022

lisitsky Nov 11, 2022

lisitsky Nov 15, 2022

felixliou Nov 22, 2022

lisitsky Nov 22, 2022

felixliou Nov 22, 2022

lisitsky commented Nov 14, 2022

boyan-soubachov left a comment

lefinal commented Feb 13, 2023

Fix Call.Unset() panic (issue #1236) #1250

Fix Call.Unset() panic (issue #1236) #1250

Conversation

lisitsky commented Aug 15, 2022 • edited

Summary

Changes

Motivation

Related issues

lisitsky commented Aug 27, 2022

mweibel commented Nov 2, 2022

felixliou Nov 11, 2022

Choose a reason for hiding this comment

lisitsky Nov 11, 2022

Choose a reason for hiding this comment

lisitsky Nov 15, 2022

Choose a reason for hiding this comment

felixliou Nov 22, 2022

Choose a reason for hiding this comment

lisitsky Nov 22, 2022

Choose a reason for hiding this comment

felixliou Nov 22, 2022

Choose a reason for hiding this comment

lisitsky commented Nov 14, 2022

boyan-soubachov left a comment

Choose a reason for hiding this comment

lefinal commented Feb 13, 2023

lisitsky commented Aug 15, 2022 •

edited