This release fixes #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 to release/1.11: mock: revert to pre-v1.11.0 argument matching behavior for mutating stringers by @brackendawson in #1788

Full Changelog: v1.11.0...v1.11.1

What's Changed

Functional Changes

v1.11.0 Includes a number of performance improvements.

• Call stack perf change for CallerInfo by @mikeauclair in #1614
• Lazily render mock diff output on successful match by @mikeauclair in #1615
• assert: check early in Eventually, EventuallyWithT, and Never by @cszczepaniak in #1427
• assert: add IsNotType by @bartventer in #1730
• assert.JSONEq: shortcut if same strings by @dolmen in #1754
• assert.YAMLEq: shortcut if same strings by @dolmen in #1755
• assert: faster and simpler isEmpty using reflect.Value.IsZero by @dolmen in #1761
• suite: faster methods filtering (internal refactor) by @dolmen in #1758

Fixes

• assert.ErrorAs: log target type by @craig65535 in #1345
• Fix failure message formatting for Positive and Negative asserts in #1062
• Improve ErrorIs message when error is nil but an error was expected by @tsioftas in #1681
• fix Subset/NotSubset when calling with mixed input types by @siliconbrain in #1729
• Improve ErrorAs failure message when error is nil by @ccoVeille in #1734
• mock.AssertNumberOfCalls: improve error msg by @3scalation in #1743

Documentation, Build & CI

• docs: Fix typo in README by @alexandear in #1688
• Replace deprecated io/ioutil with io and os by @alexandear in #1684
• Document consequences of calling t.FailNow() by @greg0ire in #1710
• chore: update docs for Unset #1621 by @techfg in #1709
• README: apply gofmt to examples by @alexandear in #1687
• refactor: use %q and %T to simplify fmt.Sprintf by @alexandear in #1674
• Propose Christophe Colombier (ccoVeille) as approver by @brackendawson in #1716
• Update documentation for the Error function in assert or require package by @architagr in #1675
• assert: remove deprecated build constraints by @alexandear in #1671
• assert: apply gofumpt to internal test suite by @ccoVeille in #1739
• CI: fix shebang in .ci.*.sh scripts by @dolmen in #1746
• assert,require: enable parallel testing on (almost) all top tests by @dolmen in #1747
• suite.Passed: add one more status test report by @Ararsa-Derese in #1706
• Add Helper() method in internal mocks and assert.CollectT by @dolmen in #1423
• assert.Same/NotSame: improve usage of Sprintf by @ccoVeille in #1742
• mock: enable parallel testing on internal testsuite by @dolmen in #1756
• suite: cleanup use of 'testing' internals at runtime by @dolmen in #1751
• assert: check test failure message for Empty and NotEmpty by @ccoVeille in #1745
• deps: fix dependency cycle with objx (again) by @dolmen in #1567
• assert.Empty: comprehensive doc of "Empty"-ness rules by @dolmen in #1753
• doc: improve godoc of top level 'testify' package by @dolmen in #1760
• assert.ErrorAs: simplify retrieving the type name by @ccoVeille in #1740
• assert.EqualValues: improve test coverage to 100% by @dolmen in #1763
• suite.Run: simplify running of Setup/TeardownSuite by @renzoarreaza in #1769
• assert.CallerInfo: micro optimization by using LastIndexByte by @dolmen in #1767
• assert.CallerInfo: micro cleanup by @dolmen in #1768
• assert: refactor TestFileExists and TestDirExists tests to enable parallel testing by @dolmen in #1766
• suite.Run: refactor handling of stats for improved readability by @dolmen in #1764
• tests: improve captureTestingT helper by @ccoVeille in #1741
• build(deps): bump actions/checkout from 4 to 5 by @dependabot[bot] in #1778

New Contributors

• @greg0ire made their first contribution in #1710
• @techfg made their first contribution in #1709
• @mikeauclair made their first contribution in #1614
• @cszczepaniak made their first contribution in #1427
• @architagr made their first contribution in #1675
• @tsioftas made their first contribution in #1681
• @siliconbrain made their first contribution in #1729
• @bartventer made their first contribution in #1730
• @Ararsa-Derese made their first contribution in #1706
• @renzoarreaza made their first contribution in #1769
• @3scalation made their first contribution in #1743

Full Changelog: v1.10.0...v1.11.0

What's Changed

Functional Changes

• Add PanicAssertionFunc by @fahimbagar in #1337
• assert: deprecate CompareType by @dolmen in #1566
• assert: make YAML dependency pluggable via build tags by @dolmen in #1579
• assert: new assertion NotElementsMatch by @hendrywiranto in #1600
• mock: in order mock calls by @ReyOrtiz in #1637
• Add assertion for NotErrorAs by @palsivertsen in #1129
• Record Return Arguments of a Call by @jayd3e in #1636
• assert.EqualExportedValues: accepts everything by @redachl in #1586

Fixes

• assert: make tHelper a type alias by @dolmen in #1562
• Do not get argument again unnecessarily in Arguments.Error() by @TomWright in #820
• Fix time.Time compare by @myxo in #1582
• assert.Regexp: handle []byte array properly by @kevinburkesegment in #1587
• assert: collect.FailNow() should not panic by @marshall-lee in #1481
• mock: simplify implementation of FunctionalOptions by @dolmen in #1571
• mock: caller information for unexpected method call by @spirin in #1644
• suite: fix test failures by @stevenh in #1421
• Fix issue #1662 (comparing infs should fail) by @ybrustin in #1663
• NotSame should fail if args are not pointers #1661 by @sikehish in #1664
• Increase timeouts in Test_Mock_Called_blocks to reduce flakiness in CI by @sikehish in #1667
• fix: compare functional option names for indirect calls by @arjun-1 in #1626

Documentation, Build & CI

• .gitignore: ignore "go test -c" binaries by @dolmen in #1565
• mock: improve doc by @dolmen in #1570
• mock: fix FunctionalOptions docs by @snirye in #1433
• README: link out to the excellent testifylint by @brackendawson in #1568
• assert: fix typo in comment by @JohnEndson in #1580
• Correct the EventuallyWithT and EventuallyWithTf example by @JonCrowther in #1588
• CI: bump softprops/action-gh-release from 1 to 2 by @dependabot in #1575
• mock: document more alternatives to deprecated AnythingOfTypeArgument by @dolmen in #1569
• assert: Correctly document EqualValues behavior by @brackendawson in #1593
• fix: grammar in godoc by @miparnisari in #1607
• .github/workflows: Run tests for Go 1.22 by @HaraldNordgren in #1629
• Document suite's lack of support for t.Parallel by @brackendawson in #1645
• assert: fix typos in comments by @alexandear in #1650
• mock: fix doc comment for NotBefore by @alexandear in #1651
• Generate better comments for require package by @Neokil in #1610
• README: replace Testify V2 notice with @dolmen's V2 manifesto by @hendrywiranto in #1518

New Contributors

• @fahimbagar made their first contribution in #1337
• @TomWright made their first contribution in #820
• @snirye made their first contribution in #1433
• @myxo made their first contribution in #1582
• @JohnEndson made their first contribution in #1580
• @JonCrowther made their first contribution in #1588
• @miparnisari made their first contribution in #1607
• @marshall-lee made their first contribution in #1481
• @spirin made their first contribution in #1644
• @ReyOrtiz made their first contribution in #1637
• @stevenh made their first contribution in #1421
• @jayd3e made their first contribution in #1636
• @Neokil made their first contribution in #1610
• @redachl made their first contribution in #1586
• @ybrustin made their first contribution in #1663
• @sikehish made their first contribution in #1664
• @arjun-1 made their first contribution in #1626

Full Changelog: v1.9.0...v1.10.0

What's Changed

• Fix Go modules version by @SuperQ in #1394
• Document that require is not safe to call in created goroutines by @programmer04 in #1392
• Remove myself from MAINTAINERS.md by @mvdkleijn in #1367
• Correct spelling/grammar by @echarrod in #1389
• docs: Update URLs in README by @davidjb in #1349
• Update mockery link to Github Pages in README by @LandonTClipp in #1346
• docs: Fix typos in tests and comments by @alexandear in #1410
• CI: tests from go1.17 by @SuperQ in #1409
• Fix adding ? when no values passed by @lesichkovm in #1320
• codegen: use standard header for generated files by @dolmen in #1406
• mock: AssertExpectations log reason only on failure by @hikyaru-suzuki in #1360
• assert: fix flaky TestNeverTrue by @dolmen in #1417
• README: fix typos "set up" vs "setup" by @ossan-dev in #1428
• mock: move regexp compilation outside of Called by @aud10slave in #631
• assert: refactor internal func getLen() by @dolmen in #1445
• mock: deprecate type AnythingOfTypeArgument (#1434) by @dolmen in #1441
• Remove no longer needed assert.canConvert by @alexandear in #1470
• assert: ObjectsAreEqual: use time.Equal for time.Time types by @tscales in #1464
• Bump actions/checkout from 3 to 4 by @dependabot in #1466
• Bump actions/setup-go from 3.2.0 to 4.1.0 by @dependabot in #1451
• fix: make EventuallyWithT concurrency safe by @czeslavo in #1395
• assert: fix httpCode and HTTPBody occur panic when http.Handler read Body by @hidu in #1484
• assert.EqualExportedValues: fix handling of arrays by @zrbecker in #1473
• .github: use latest Go versions by @kevinburkesegment in #1489
• assert: Deprecate EqualExportedValues by @HaraldNordgren in #1488
• suite: refactor test assertions by @alexandear in #1474
• suite: fix SetupSubTest and TearDownSubTest execution order by @linusbarth in #1471
• docs: Fix deprecation comments for http package by @alexandear in #1335
• Add map support doc comments to Subset and NotSubset by @jedevc in #1306
• TestErrorIs/TestNotErrorIs: check error message contents by @craig65535 in #1435
• suite: fix subtest names (fix #1501) by @dolmen in #1504
• assert: improve unsafe.Pointer tests by @dolmen in #1505
• assert: simplify isNil implementation by @dolmen in #1506
• assert.InEpsilonSlice: fix expected/actual order and other improvements by @dolmen in #1483
• Fix dependency cycle with objx #1292 by @dolmen in #1453
• mock: refactor TestIsArgsEqual by @dolmen in #1444
• mock: optimize argument matching checks by @dolmen in #1416
• assert: fix TestEventuallyTimeout by @dolmen in #1412
• CI: add go 1.21 in GitHub Actions by @dolmen in #1450
• suite: fix recoverAndFailOnPanic to report test failure at the right location by @dolmen in #1502
• Update maintainers by @brackendawson in #1533
• assert: Fix EqualValues to handle overflow/underflow by @arjunmahishi in #1531
• assert: better formatting for Len() error by @kevinburkesegment in #1485
• Ensure AssertExpectations does not fail in skipped tests by @ianrose14 in #1331
• suite: fix deadlock in suite.Require()/Assert() by @arjunmahishi in #1535
• Revert "assert: ObjectsAreEqual: use time.Equal for time.Time type" by @brackendawson in #1537
• [chore] Add issue templates by @arjunmahishi in #1538
• Update the build status badge by @brackendawson in #1540
• Update Github workflows setup-go to V5 by @hendrywiranto in #1545
• Support Pointer to Struct in EqualExportedValues by @Lucaber in #1517
• README: drop link to gorc by @guettli in #1248
• http_assertions: honour the msgAndArgs provided with each assertion by @arjunmahishi in #1548
• fix typos in comments and tests by @ccoVeille in #1247
• Include the auto-release notes in releases by @brackendawson in #1550
• Add NotImplements and variants by @hslatman in #1385
• Add support to compare uintptr by @bogdandrutu in #1339
• build(deps): bump github.com/stretchr/objx from 0.5.1 to 0.5.2 by @dependabot in #1552

New Contributors

• @SuperQ made their first contribution in #1394
• @programmer04 made their first contribution in #1392
• @echarrod made their first contribution in #1389
• @davidjb made their first contribution in #1349
• @LandonTClipp made their first contribution in #1346
• @alexandear made their first contribution in #1410
• @lesichkovm made their first contribution in #1320
• @dolmen made their first contribution in #1406
• @hikyaru-suzuki made their first contribution in #1360
• @ossan-dev made their first contribution in #1428
• @aud10slave made their first contribution in #631
• @tscales made their first contribution in #1464
• @czeslavo made their first contribution in #1395
• @hidu made their first contribution in #1484
• @zrbecker made their first contribution in #1473
• @kevinburkesegment made their first contribution in #1489
• @linusbarth made their first contribution in #1471
• @jedevc made their first contribution in #1306
• @craig65535 made their first contribution in #1435
• @arjunmahishi made their first contribution in #1531
• @ianrose14 made their first contribution in #1331
• @hendrywiranto made their first contribution in #1545
• @Lucaber made their first contribution in #1517
• @guettli made their first contribution in #1248
• @ccoVeille made their first contribution in #1247
• @hslatman made their first contribution in #1385
• @bogdandrutu made their first contribution in #1339

Full Changelog: v1.8.4...v1.9.0

What's Changed

• Create GitHub release when new release tag is pushed by @aldas in #1354

New Contributors

• @aldas made their first contribution in #1354

Full Changelog: v1.8.3...v1.8.4

What's Changed

• Compare public elements of struct by @mchlp in #1309
• assert: fix error message formatting for NotContains by @wwade in #1362
• allow testing for functional options by @nbaztec in #1023
• add EventuallyWithT assertion by @tobikris in #1264
• EqualExportedValues: Handle nested pointer, slice and map fields by @HaraldNordgren in #1379

New Contributors

• @mchlp made their first contribution in #1309
• @wwade made their first contribution in #1362
• @nbaztec made their first contribution in #1023
• @tobikris made their first contribution in #1264

Full Changelog: v1.8.2...v1.8.3

What's Changed

• Add opportunity to trigger setup/teardown for subtest by @qerdcv in #1246
• fix: fix bug for check unsafe.Pointer isNil by @sunpe in #1319
• Fix Call.Unset() panic (issue #1236) by @lisitsky in #1250
• Fix CallerInfo() source file paths by @bozaro in #1288
• assert: Fix Subset/NotSubset when map is missing keys from the subset by @danielwhite in #1261

New Contributors

• @qerdcv made their first contribution in #1246
• @sunpe made their first contribution in #1319
• @lisitsky made their first contribution in #1250
• @bozaro made their first contribution in #1288
• @danielwhite made their first contribution in #1261

Full Changelog: v1.8.1...v1.8.2

What's Changed

• Bump github.com/stretchr/objx from 0.4.0 to 0.5.0 by @dependabot in #1283

Full Changelog: v1.8.0...v1.8.1

What's Changed

• Add WithinTimeRange method by @moolmanruan in #1188
• fix: assert.MapSubset (or just support maps in assert.Subset) by @OladapoAjala in #1178
• Allow mock expectations to be ordered by @brackendawson in #1106
• impr: CallerInfo should print full paths to the terminal by @stdedos in #1201

New Contributors

• @moolmanruan made their first contribution in #1188
• @OladapoAjala made their first contribution in #1178
• @stdedos made their first contribution in #1201

Full Changelog: v1.7.5...v1.8.0

What's Changed

• Support comparing byte slice by @rleungx in #1202
• Add .Unset method to mock by @pdufour in #982
• fix(suite) correctly set stats on test panic by @nicoche in #1195
• Mock can be deadlocked by a panic by @brackendawson in #1157
• fixing panic in calls to assertion with nil m.mutex by @sfc-gh-eraigosa in #1212

New Contributors

• @rleungx made their first contribution in #1202
• @pdufour made their first contribution in #982
• @nicoche made their first contribution in #1195
• @sfc-gh-eraigosa made their first contribution in #1212

Full Changelog: v1.7.4...v1.7.5