Skip to content

Latest commit

 

History

History
334 lines (270 loc) · 22 KB

CHANGELOG.md

File metadata and controls

334 lines (270 loc) · 22 KB
Raw

5.2.0 (Apr 2024)

  • [UPDATE] Upgrade website build to jekyll 3.9.0 and add link to edit website pages (#767, #769; thanks to @brad)
  • [UPDATE] Build improvements:
    • migrate to GitHub Actions and update doc dependencies (#754, #774; thanks to @alexandrnikitin)
    • improve test platform coverage; add .NET 8 to test platforms (#742, #756; thanks to @Romfos)
    • source code format improvements; check format on CI (#758, ##761, #762, #763; thanks again to @Romfos)
  • [NEW] Support for Sourcelink and Deterministic Build. Thanks @304NotModified! (#737)

Many thanks to @alexandrnikitin, @Romfos, @brad, and @304NotModified for their contributions!

5.1.0 (Sep 2023)

  • [DOC] Add clickable headings. Thanks @jheinath! (#729)
  • [UPDATE] Update Castle.Core to 5.1.1-* to support C# 9 covariants. Thanks @siblount to tracking this down. (#730)
  • [UPDATE] Improved support for testing ILogger. Thanks to @zlangner for this contribution, and also thanks to @Saibamen for reviewing this PR. (#732)
  • [NEW] Add Arg.AnyType for matching calls with generic parameters. Thanks @icalvo for implementing and documenting this! (#634, #715, #733)

5.0.0 (Feb 2023)

  • [UPDATE][BREAKING] Drop unsupported platforms. Now supported platforms are .NET 6+, .NET Framework 4.6.2+, .NET Standard 2.0.

4.4.0 (Jul 2022)

  • [FIX] Fix issue checking for constructor args on null object. Thanks to @phongphanq, and @appel1! Thanks also to @Mandroide for code review. (#683, #685)
  • [UPDATE] Update to Castle Core v5. Thanks @Havunen! (#690, #673)
  • [NEW] Add .ThrowsAsync() that will correctly mock exception on async methods. Thanks @Socolin! (#609, #663)

4.3.0 (Jan 2021)

  • [NEW] Add .NET 5 (#636) and .NET 6 (#674) support. Thanks to @zvirja and @Havunen!

4.2.2 (Jun 2020)

  • [UPDATE] Build update to run on non-Windows platforms. Thanks @joaopgrassi! (#592, #335)
  • [FIX] Fix NSubstitute could fail in concurrent environment due to auto-value providers initialization. (#600, @zvirja)

4.2.1 (July 2019)

  • [FIX] It might be impossible to assign ref and out arguments using type-compatible value. (#577, @zvirja)
  • [FIX] Configured result is returned in the Received.InOrder check causing tests to fail sometimes. (#569, @zvirja)

4.2.0 (May 2019)

  • [FIX] Raise events for delegates taking single array argument of reference element type. (#560, @zvirja)
  • [NEW] Quantity.Within(min, max) to assert a call was received within a range of times. This is available in the NSubstitute.ReceivedExtensions namespace. (#558)

4.1.0 (May 2019)

  • [FIX] Re-throw captured NSubstitute exceptions when configuring async methods. (#533, @zvirja)
  • [UPDATE] Various performance improvements. (#536, #542, #547, @zvirja)
  • [UPDATE] Use Castle.Proxy library to generate delegate proxies. (#537, @zvirja)
  • [FIX] Do not fail on nested generic type formatting. (#515, @zvirja)
  • [FIX] Fix event handling for code created by non-ECMA compliant compilers. (#500, #525, @zvirja)
  • [UPDATE] Thanks to Julian Verdurmen (@304NotModified) for updating our website and links to HTTPS! All links to the NSub website should now go through https://nsubstitute.github.io, and other web links in the project also go through to HTTPS where supported.
  • [UPDATE] Documentation updates (#516 thanks to Michael Freidgeim @MNF; #530, #531 thanks to @304NotModified; #540, #549)

4.0.0 (January 2019)

Promoted 4.0.0 Release Candidate 1 with no code changes. See the release candidate's notes for a full list of changes since 3.1.0.

4.0.0 Release Candidate 1 (November 2018)

Thanks to core team member Alex Povar (@zvirja) for putting a huge amount of work into defining and implementing features, fixes and refactoring for this release! Also thanks to @tpodolak for the new NSubstitute.Analyzers project! Finally, thanks to everyone who submitted PRs, raised or commented on issues, or took the time to help answer questions on StackOverflow.

Major new features and improvements

  • [NEW] NSubstitute.Analyzers project. Uses Roslyn to detect potential problems with NSubstitute configurations, such as trying to substitute for non-virtual members. Whenever you add NSubstitute to your C# or VB project, don't forget to also add the corresponding NSubstitute.Analyzers package! Thanks to @tpodolak for starting and running this project!
  • [NEW] CallBase for enabling base method calls for specific methods. (#449, @zvirja)
  • [NEW][BREAKING] Arg matchers (Arg.Is etc) can now be used for ref and out arguments. See BreakingChanges.md if you are still using pre-C#7. (#404, @zvirja)
  • [NEW] Configure() extension in NSubstitute.Extensions.ConfigurationExtensions to ensure NSubstitute handles the next call as a configuration/specification. (#350, @zvirja)
  • [UPDATE] Performance improvements. (@zvirja)
    • CallResults performance optimisation
    • Delegate proxy generation improvements (#362)
    • Minimise allocations and LINQ use on hot code paths (#390)
    • Optimise array allocation (#395)
  • [UPDATE][BREAKING] Calls made with one or more argument matchers (Arg.Is or Arg.Any) will no longer return previously configured results. NSubstitute will assume the call is being configured and avoid running logic configured via previous Returns() calls. This helps fix some problems with overlapping configurations. See #345 and BreakingChanges.md for more information. (@zvirja)

New and improved debugging, errors and error messages

  • [NEW] Raise CouldNotConfigureBaseMethodException when trying to configure a call to call a base method that does not exist. (#429, @zvirja)
  • [NEW] Raise RedundantArgumentMatcherException if extra arg matchers are detected. This is a huge help for immediately identifying misconfigured tests. (@zvirja)
  • [UPDATE] Improved AmbiguousArgumentsException behaviour and errors. (#403 and others; @zvirja)
  • [NEW] Improve debugging experience with proxy ids. (#39, @zvirja)
  • [UPDATE] Improved display of MatchArgs to help with debugging. (@zvirja)
  • [NEW][BREAKING] Detection of unused argument matchers. This helps to identify errors in tests due to incorrectly used argument matchers. (#361, #89, #279; @zvirja)

And lots, lots more!

Including (but not limited to):

  • [NEW] Support for netstandard-2.0. (#447, @zvirja)
  • [FIX] Improved handling of virtual calls in constructors. (#423, @zvirja)
  • [NEW] Added a set of When() overloads to configure async methods without compilation warnings. (#468, @zvirja)
  • [FIX] Fixed potential for ArgumentNullException on finalizer thread. (#382, @zvirja)
  • [UPDATE] Now using Castle.Core 4.3.1+. We ❤️ you Castle.Core! (Thanks for the PR Alexandr Nikitin!)
  • [NEW] Expose .Received(Quantity) in NSubstitute.ReceivedExtensions namespace. Thanks to @firelizzard18 for this suggestion.
  • [UPDATE] Made substitute setup and verification more robust in the concurrent environments. (#462, @zvirja)
  • [UPDATE] Removed NSubstitute.Core.Extensions.Zip (no longer require NET35 support). (#336)
  • [FIX] Restored XML documentation. (#345)
  • [NEW] Made global NSubstitute customization more easier. (#448, @zvirja)
  • [UPDATE] Documentation updates and fixes. Thanks to @jsbed, Chris Maddock, Jim Aho (#369), and Mathias Lorenzen.
  • [UPDATE] Updated builds thanks to Alexandr Nikitin.
  • [UPDATE] Significant refactoring thanks to Alex Povar. (#448 and many, many other PRs)

3.1.0 (October 2017)

  • [FIX] Reduced packages required when referencing from NET45 and NET46. (#331)
  • [UPDATE] Reintroduced support for NET45. (#329)
  • [NEW] Support for auto-substituting ValueTask<T> results. Thanks to @KrzysztofBranicki for this change. (#325)

3.0.1 (October 2017)

  • [FIX] Signing 3.x release to prevent problems with other packages that work with different versions of NSubstitute. Thanks Alex Povar for raising this. (#324)
  • [UPDATE] Readme and other docs converted to markdown (.md) rather than plain text. Thanks to Stefan Kert for this PR.

3.0.0 (October 2017)

  • [FIX] Fixed warning about System.ComponentModel.TypeConverter 4.0.1 (#311). Thanks to Stefan Kert for this PR.
  • [UPDATE] [BREAKING] Migrated to new csproj format, targeting .NET Standard 1.3. Dropped support for older .NET platforms (pre-.NET46). Uses NuGet for dependencies rather than shipping them ilmerged. Thanks to Alexandr Nikitin for this work. Also thanks to @StefanKert and @robertcoltheart for review feedback.
  • [UPDATE] Stopped shipping ZIP distribution, now exclusively using NuGet. (#319)
  • [UPDATE] Stopped shipping documentation with the NuGet package. This information is available in the source repository. (#319)

2.0.3 (April 2017)

  • [FIX] Fixed issue with stubbing multiple return values and then accessing them in parallel. (#282, #294). Thanks to Janusz Białobrzewski (@jbialobr) for implementing this, and to Alexandr Nikitin and Alex Povar for reviewing and contributing to Janusz' PR.
  • [UPDATE] .NET Core build now targets netstandard-1.3 (was 1.5). Thanks to Ian Johnson (@ipjohnson) for this change. (#303)
  • [UPDATE] .NET Core build is now signed, which removes a warning when referencing .NET standard library. Thanks to Connie Yau (@conniey) for this change. (#302)
  • [FIX] Removed redundant .NET standard dependencies when referencing NSubstitute as a .NET Framework library. Thanks to Alex Povar (@zvirja). (#295)

2.0.2 (February 2017)

  • Dropped Release Candidate tag now that Castle.Core 4.0.0 final has been released.
  • [UPDATE] Updated all builds to use Castle Core 4.0.0 release.
  • [NEW] Task-compatible ReturnsNull extension method added to ReturnsExtensions (#270). Thanks to Michael Wolfenden for implementing this.
  • [NEW] Support for delegates with out/ref parameters (#271, #273). Thanks to Oleg Sych for raising this, and to Alexandr Nikitin for this fix. (Implemented for NET40/45/Core, not for NET35 at present)

2.0.1 RC (December 2016)

  • [NEW] Initial custom handler support (#259). Mainly for integration with libraries like AutoFixture, this allows some basic fallback logic to be injected into a substitute's call handling pipeline. Thanks to Alex Povar (@zvirja) for implementing this and incorporating review comments, and also to Marcio Rinaldi (@mrinaldi) for his initial work on this in #234. Also thanks to @alexandrnikitin for a related spike (#156), and his work with Alex and Marcio in refining this feature and reviewing and merging the final PR.
  • [UPDATE] Improved concurrency support, relating to how NSubstitute tracks the last call and queued call specifications (#264). Thanks a lot to Alex Povar (@Zvirja) for designing and implementing this improvement. Thanks to Alexandr Nikitin for reviewing this PR.

2.0.0 RC (August 2016)

  • Build: 2.0.0.0
  • [NEW] Initial .NET Core support. Thanks to @alexandrnikitin for tonnes of work on this. Thanks also to Peter Jas (@jasonwilliams200OK) for both .NET Core code contributions and help with CI setup. And thanks to everyone who contributed to the conversation and testing in #197.
  • [NEW] Clear substitute configuration using sub.ClearSubstitute(ClearOptions). This extension can be brought in to scope via using NSubstitute.ClearExtensions;. Thanks to @trullock for defining and implementing this change, and to @alexandrnikitin for review feedback. (#157, #235, #179)
  • [DOC] Improved CallInfo.ArgAt documentation, thanks to asbjornu. (#231)
  • [FIX] Fix an issue with Received.InOrder when an exception is thrown. Thanks to @m3zercat for finding and fixing this. (#237)

1.10.0 (March 2016)

  • [NEW] Callbacks builder for more control over When..Do callbacks. Thanks to bartoszgolek. (#202, #200)
  • [NEW] Auto-substitute for IQueryable. Thanks to emragins. (#67)
  • [FIX] Fix bug when showing params arguments for value types (#214)
  • [FIX] Fix bug when showing params arguments for Received.InOrder calls (#211)

1.9.2 (October 2015)

  • [UPDATE] Mark Exceptions as [Serializable]. Thanks to David Mann. (#201)
  • [FIX] Fix bug with concurrently creating delegate substitutes. Thanks to Alexandr Nikitin. (#205)

1.9.1 (October 2015)

  • [FIX] Fix bug introduced in 1.9.0 that made checking a call was Received() clear previously stubbed values for that call.

1.9.0 (October 2015)

  • [NEW] Allow awaiting of async methods with Received()/DidNotReceive(). Thanks to Marcio Rinaldi for this contribution. (#190, #191)
  • [NEW] Task-specific Returns methods to make it easier to stub async methods. Thanks to Antony Koch for implementing this, and thanks to Marius Gundersen and Alexandr Nikitin for the suggestion and discussion regarding the change. (#189) (Also thanks to Jake Ginnivan who tried adding this back in #91, but I didn't merge that part of the PR in. Sorry!)
  • [NEW] ReturnsForAll extension method. Thanks to Mike Hanson for this contribution. (#198, #196)

1.8.2 (May 2015)

  • [NEW] Convenience .ReturnsNull() extensions in NSubstitute.ReturnsExtensions. Thanks to Michal Wereda for this contribution. (#181)
  • [NEW] CallInfo.ArgAt(int) added to match argument at a given position and cast to the required type. Thanks to @jotabe-net for this contribution. (#175)
  • [NEW] Convenience Throws() extensions in NSubstitute.ExceptionExtensions (sub.MyCall().Throws(ex)). Thanks to Michal Wereda for this contribution. Thanks also to Geir Sagberg for helpful suggestions relating to this feature. (#172)

1.8.1 (December 2014)

  • [FIX] Fix for methods returning multidimensional arrays. Thanks to Alexandr Nikitin. (#170)

1.8.0 (November 2014)

  • [NEW] Convenience methods for throwing exceptions with When-Do. Thanks to Geir Sagberg for this contribution.
  • [FIX] Throw exception when arg matcher used within Returns. (#149)

1.7.2 (March 2014)

  • [FIX] Basic support for types that return dynamic. Thanks to Alexandr Nikitin. (#75)
  • [NEW] Auto-subbing for observables. Thanks to Paul Betts.

1.7.1 (January 2014)

  • [FIX] Ambiguous arg exception with out/ref parameters. Thanks to Alexandr Nikitin. (#129)

1.7.0 (January 2014)

  • [NEW] Partial subs (Substitute.ForPartsOf()). Thanks to Alexandr Nikitin for tonnes of hard work on this feature (and for putting up with a vacillating project owner :)).
  • [UPDATE] Received.InOrder moved out of Experimental namespace.
  • [FIX] Argument matching with optional parameters. Thanks to Peter Wiles. (#111)
  • [FIX] Argument matching with out/ref. Thanks to Kevin Bosman. (#111)
  • [FIX] The default return value for any call that returns a concrete type that is purely virtual, but also has at least one public static method in it will be a substitute rather than null. Thanks to Robert Moore (@robdmoore) for this contribution. (#118)

1.6.1 (June 2013)

  • [FIX] Detect and throw on type mismatches in Returns() caused by Returns(ConfigureOtherSub()).
  • [FIX] Support raising exceptions that do not implement a serialisation constructor (#110). Thanks to Alexandr Nikitin for this contribution.

1.6.0 (April 2013)

  • [NEW] .AndDoes() method for chaining a callback after a Returns(). (#98)
  • [FIX] Handling calls with params argument of value types, thanks to Eric Winkler.
  • [FIX] Can now substitute for interfaces implementing System.Windows.IDataObject, thanks to Johan Appelgren.
  • [UPDATE] Improved XML doc comments, thanks to David Gardiner.

1.5.0 (January 2013)

  • [EXPERIMENTAL] Asserting ordered call sequences
  • [FIX] Arg.Invoke with four arguments now passes fourth arg correctly (#88). Thanks to Ville Salonen (@VilleSalonen) for finding and patching this.
  • [FIX] Substitute objects now use actual implementation for base object methods (Equals, GetHashCode, ToString). Thanks to Robert Moore (@robdmoore) for this contribution. (#77)
  • [NEW] Auto-substitute for Task/Task. Task will use substitute rules that T would use. Thanks to Jake Ginnivan (@JakeGinnivan) for this contribution.
  • [NEW] Match derived types for generic calls (#97). Thanks to Iain Ballard for this contribution.
  • [NEW] Returns now supports passing multiple callbacks, which makes it easier to combine stubbing multiple return values followed by throwing an exception (#99). Thanks to Alexandr Nikitin for this contribution.

1.4.3 (August 2012)

  • [FIX] Updated to Castle.Core 3.1.0 to fix an issue proxying generic methods with a struct constraint (#83).

1.4.2 (July 2012)

  • [FIX] Issue using NET40 build on Mono (due to NET45 build tools incompatibility)

1.4.1 (June 2012)

  • [FIX] Fix matching Nullable arguments when arg value is null. Thanks to Magnus Olstad Hansen (@maggedotno) for this contribution. (#78)
  • [UPDATE] Updated to Castle.Core 3.0.0.

1.4.0 (May 2012)

  • [NEW] [BREAKING] Auto-substitute for types returned from substitutes of delegates/Funcs (follows same auto-substitute rules as for methods and properties). Thanks to Sauli Tähkäpää for implementing this feature. (#52)
  • [NEW] Show details of params arguments when displaying received calls. Thanks to Sauli Tähkäpää for implementing this feature. (#65)
  • [FIX] Race condition between checking received calls and building the exception could cause nonsensical exception messages like "Expected 5, actually received 5" when called concurrently. (#64)

1.3.0 (Nov 2011)

  • [NEW] Support for Received(times) to assert a call was received a certain number of times. Thanks to Abi Bellamkonda for this contribution. (#63)
  • [FIX] Improved support for calling substitutes from multiple threads. (#62)

1.2.1 (Oct 2011)

  • [FIX] Some combinations of Arg.Do and Returns() caused incorrect values to be returned. (#59)
  • [UPDATE] WCF ServiceContractAttribute no longer applied to proxies. (#60)
  • [FIX] Passing null could cause argument actions to fail. (#61)
  • [FIX] Calls to virtual methods from constructors of classes being substituted for are no longer recorded, to prevent non-obvious behaviour when calling Returns() on an auto-substituted value. (#57)

1.2.0 (Sep 2011)

  • [NEW] Arg.Do() syntax for capturing arguments passed to a method and performing some action with them whenever the method is called.
  • [NEW] Arg.Invoke() syntax for invoking callbacks passed as arguments to a method whenever the method is called.
  • [NEW] Basic support for setting out/ref parameters.
  • [FIX] Property behaviour for indexed properties (Issue #53)
  • [UPDATE] [BREAKING] Auto-substitute for pure virtual classes, including common ASP.NET web abstractions. Use .Returns(x=>null) to explicitly return null from these members if required. Thanks to Tatham Oddie for original idea and patch, and Krzysztof Kozmic for suggesting and defining which classes would be safe to automatically proxy.
  • [UPDATE] Changed layout of package for eventual support for multiple framework targets.
  • [FIX] Failure to match calls with ref arguments using ReceivedWithAnyArgs().
  • [FIX] Incorrect ambiguous args exception when supplying value type arg specs for object arguments.

1.1.0 (May 2011)

  • [UPDATE] Updated to Castle.Core 2.5.3.
  • [FIX] Fixed bug when raising a delegate event with a null argument.
  • [FIX] CallInfo.Arg() now works more reliably, including for null arguments.
  • [FIX] Better exception when accidentally calling substitute extension method with a null reference (e.g. foo.Received().Call() when foo is null)
  • [UPDATE] Exceptions thrown in custom argument matchers (Arg.Is(x => ...)) will now silently fail to match the argument, rather than allowing exceptions to bubble up.
  • [NEW] Support for test fixtures run in parallel.

1.0.0 (Dec 2010)

  • [FIX] Using Returns(null) for value types throws, rather than returning default(T).

0.9.5 Release Candidate

  • [FIX] Fixed bug when trying to return null from a call to a substitute.
  • [FIX] Equals() for class substitutes fixed by not intercepting Object methods Equals(), ToString() and GetHashCode().
  • [NEW] Raise.Event() methods to raise any type of event, including delegates.
  • [BREAKING] Raise.Action() methods removed. Use Raise.Event() (e.g. Raise.Event>()).
  • [BREAKING] Renamed Raise.Event() methods to Raise.EventWith().
  • [UPDATE] Arg matchers can be specified using more specific, compatible type (Arg.Is(..) for arg of type object).
  • [NEW] NSubstitute website and documentation https://nsubstitute.github.io
  • [FIX] Formating for argument matchers that take predicate functions.
  • [FIX] Match single argument matcher passed to params arg (#34)
  • [FIX] Detect ambiguous arg matchers in additional case (#31)
  • [FIX] Can modify event handler subscriptions from within event callback
  • [UPDATE] Update to Castle.Core 2.5.2
  • [FIX] Can substitute for SynchronizationContext in .NET4 (fixed in Castle.Core)
  • [NEW] NSubstitute available as NuPack package

0.9.0 Beta 1

  • [FIX] Now handles argument specifiers used for params arguments correctly
  • [UPDATE] Updated to Castle.Core 2.5 final.

0.1.3 alpha 4

  • [NEW] Support auto/recursive substituting for members that return interfaces or delegates.
  • [NEW] Support auto substituting for members that return arrays and strings (return empty values rather than null).
  • [NEW] Raise.Event() will now attempt to construct arguments with default ctors, so in most cases they will not need to be explictly provided.
  • [UPDATE] Added support for raising events with custom delegate types.
  • [UPDATE] Formatting for event subscription and unsubscription calls in call received/not received exceptions.
  • [UPDATE] Updated to pre-release build of Castle.Core 2.5 to get dynamic proxy to support modopts.
  • [FIX] Throw correct exception when raising an event and event handler throws. (Fix by Rodrigo Perera)
  • [FIX] Record call as received when it throws an exception from the When..Do callback.

0.1.2 alpha 3

  • [NEW] Marked non-matching parameters in the actual calls listed for CallNotReceivedException messages.
  • [NEW] Added WhenForAnyArgs..Do syntax for callbacks.
  • [UPDATE] Updated arg matching to be smarter when matchers are not used for all args.
  • [FIX] Fixed bug when substituting for delegates with multiple parameters.
  • [FIX] Removed redundant cast operator which sometimes caused the compiler trouble in resolving Raise.Event().

0.1.1 alpha 2

  • [NEW] Added ReturnsForAnyArgs() extension methods
  • [FIX] Compiled for Any CPU to run on x64 platforms

0.1.0 alpha

  • Initial release