Releases: Quick/Nimble
v4.0.1
v4.0.0
Breaking Changes
- Remove
FullMatcherFunc
. UseMatcher
orMatcherFunc
instead. More
breaking changes around the protocols will probably occur in the future.
Features
beEmpty()
supportsNSIndexSet
- Expose
stringify()
which Nimble matchers use to convert values to string.- You can add custom support to stringify by conforming your type to
TestDebugStringConvertible
- You can add custom support to stringify by conforming your type to
Bug Fixes
- Fix bug where exceptions weren't properly caught for cocoapods users
- Resolve warnings for Xcode 7.3
Nimble v3.2.0
Nimble v3.2.0
This release includes bug fixes, minor enhancements, and a couple of new matchers. This release targets Xcode 7.2.x and Swift 2.1. It also generally works with Xcode 7.3 betas and Swift 2.2 (thanks @NachoSoto!), although many deprecation warnings are emitted.
Additionally, initial support is available for using Nimble with the Swift Package Manager on both OS X and Linux. This should be considered a technical preview as SwiftPM and the do not yet have any stable releases.
New Matcher: postNotifications
This matcher allows testing that an expression causes one or more NSNotification
s to be posted to a notification center. Thanks to @bgerstle for this work! (#228)
expect {
NSNotificationCenter.defaultCenter().postNotification(myNotification)
}.to(postNotifications(equal([myNotification]))
New Matcher: beVoid
This matcher allows testing whether an optional value of type Void?
contains a value, or is nil
. Thanks to @inamiy for this! (#250)
expect(() as ()?).to(beVoid())
Asynchronous Expectation Defaults
It is now possible to modify the global default values for the timeout and poll interval used by toEventually
. Thanks @mjbeauregard! (#256)
AsyncDefaults.Timeout = 2
AsyncDefaults.PollInterval = 0.05
Swift Package Manager
It is now possible to reference Nimble as a package dependency in a Package.swift
file for use with the Swift Package Manager. As SwiftPM is not yet stable, this integration should be considered an early preview and may break.
Linux Support
Complementing SwiftPM support, Nimble can now be used on Linux, with the caveat that not all behaviors and matchers are supported. Features that rely on the Objective-C runtime are disabled in this environment. On Linux, Nimble integrates with the swift-corelibs-xctest library.
Miscellaneous
be
can now be used as an alias for thebeIdenticalTo
matcher. Thanks @jwfriese! (#241)- The compiler will now produce a warning if
expect
is used without being followed up byto
,toNot
, etc. Thanks @pcantrell! (#245) NSData
now has a special string representation to prevent failure messages from including excessively long data descriptions. Thanks @inket! (#263)
Nimble v3.1.0
This is a bug fix + feature addition release. Thanks to @jwfriese for the work in this release.
Note that this release does not include a pre-built binary for Carthage. Xcode doesn't gaurantee binary compatibility for pre-built frameworks. See more details: Carthage/Carthage#924.
On to the changes...
New Matcher: || (aka - satisfyAnyOf)
Matchers can be combined using the ||
operator:
expect(value).to(equal(2) || equal(3))
This expects value
to be either 2 or 3. Using ||
can be useful in complex expectations or integration tests, where less-specific expectations are usually utilized.
Warning: Conditionals in expectations are generally considered bad practice. Using ||
is a form of conditional that weakens the strength of the assertion. This matcher should be used sparingly if at all.
Updated Matcher: Equals + Optional Collections
Equals now supports optional collections:
let a: [String?] = ["a", "b", nil]
let b: [String?] = ["a", "b", nil]
expect(a).to(equal(b))
Previously, the above code caused a compiler error. Now this will work like non-optional collection types.
Asynchronous Expectations
Async expectations have been rewritten to reduce flakiness. The public API remains the same but uses lower-level features to avoid complex interactions with common run loop features.
Async expectations are any waitUntil
or expect(..).toEventually(..)
forms.
Also, Nimble emits errors on invalid usages of async expectations:
- Async expectations must be done on the main thread.
- Async expectations cannot be nested.
This is because async requires controlling the main run loop. These limitations were part of the old implementation, but left the test writer to discover them via flaky tests. The new implementation will immediately fail.
Nimble v3.0.0
This release supports Xcode 7.1 with better tvOS support.
Changes:
- tvOS is a separate build target from iOS.
- updated import headers to be relative from module-based for Xcode 7.1
- revert waitUntil variadic completion function to avoid ambiguities for some edge cases
- fix haveCount matcher's expected and actual values reversed in expectation message
Nimble v2.0.0
This release is compatible with Xcode 7.0 (Swift 2.0). If you're looking for the swift-2.0
branch, it is now the master
branch.
Breaking Changes from RCs
There's one breaking changes besides the upgrade to Swift 2.0 if you haven't be using the release candidates.
Weak Linking to XCTest
Nimble is now weakly linked to XCTest. If you're not explicitly linking to XCTest (either via import or explicitly linking frameworks), you must now do so or else XCTest may not be automatically linked into your project. The default behavior of test bundles will link XCTest correctly.
The README documents using Nimble without XCTest, if you choose to integrate Nimble to your own test runner or framework.
Changes from RCs
- Added tvOS support
- Added
haveCount
matcher which is a convenience to check for length. - Added
NSMapTable
support forbeEmpty
.haveCount
also supports
NSMapTable
. - Fix warning of missing reference to
$SDKROOT/Developer/Library/Frameworks
- waitUntil's done argument now accepts variadic arguments to allow passing
directly to completion blocks that requires other arguments.
Past Release Candidate Changes
For convenience, here's the list of changes between the release candidates to 1.x.x versions.
Backwards Incompatible Changes
- Backwards incompatible changes for Swift 2.0
- swift: Expectations now properly handle the new Swift error handling syntax.
This means expectations implicitly allow throws and will fail with a useful
error message if a closure throws one:
expect { try throwError() }.to(equal(1)) // Failed - Expected to equal 1, got an unexpected error thrown: ...
- objc:
expectAction()
is now a macro that requires an Objective-C block instead of building an implicit block:
Old:
expectAction([obj raiseException]).to(raiseException(...));
New:
expectAction(^{ [obj raiseException]; }).to(raiseException(...));
Changes in Release Candidates
beEmpty()
matcher is now defined specifically for StringbeCloseTo
now works withNSDate
without having to convert it- Cocoapod users can now run Nimble in devices
- objc: Added
fail()
andfailWithMessage()
functions - You can now specify custom error messages for expectations. This is useful
for large integration tests, where an expectation is usually a sanity check to
a larger operation:
expect(1).to(equal(2), description: "Just checking equality!") // failed - Just checking equality!
- swift: Fixed
≈
precedence - swift:
beAKindOf()
andbeAnInstanceOf()
emits useful errors when trying to
compare against Swift Types. This is not allowed in Nimble because the Swift
compiler already enforces this. - swift: Added
throwError()
matcher for verifying the behavior of closures that throw an error:
expect { try somethingDangerous() }.to(throwError())
- objc:
NMBObjCMatcher
initializers are now public - objc:
contain()
matcher now accepts variadic arguments. Each value passed to contain() is expected to be in the container:
expect(@[@1, @2, @3]).to(contain(@1, @2)); // passes
Nimble v2.0.0 Release Candidate 3
This release is compatible with Xcode 7 beta 6 (Swift 2.0).
Note to carthage Users: You must explicitly give this version for Carthage to install.
github "Quick/Nimble" "v2.0.0-rc.3"
Changes
- Updated for Xcode 7 beta 6
beCloseTo
now works withNSDate
without having to convert it- Cocoapod users can now run Nimble in physical devices
- objc: Added
fail()
andfailWithMessage()
functions
Also, Quick has been updated for Xcode 7 beta 6.
Nimble 2.0.0 Release Candidate 2
This release is compatible with Xcode 7 beta 4 (Swift 2.0).
Note to Carthage Users: You must explicitly give this version for Carthage to install.
github "Quick/Nimble" "v2.0.0-rc.2"
Backwards Incompatible Changes
- swift: Expectations now properly handle the new Swift error handling syntax.
This means expectations implicitly allow throws and will fail with a useful
error message if a closure throws one:
// Failed - Expected to equal 1, got an unexpected error thrown: ...
expect { try throwAnError() }.to(equal(1))
- objc: expectAction() is now a macro that requires an Objective-C block instead of building an implicit block:
// Old-style before RC 2
expectAction([obj raiseException]).to(raiseException(...));
// New-style in RC 2
expectAction(^{ [obj raiseException]; }).to(raiseException(...));
Additions
- You can now specify custom error messages for expectations. This is useful
for large integration tests, where an expectation is usually a sanity check to
a larger operation:
// failed - Just checking equality!
expect(1).to(equal(2), description: "Just checking equality!")
- swift: Fixed
≈
precedence - swift:
beAKindOf()
andbeAnInstanceOf()
emits useful errors when trying to
compare against Swift Types. This is not allowed in Nimble because the Swift
compiler already enforces this. - swift: Added
throwError()
matcher for verifying the behavior of closures that throw an error:
expect { try somethingDangerous() }.to(throwError())
- objc:
NMBObjCMatcher
initializers are now public - objc:
contain()
matcher now accepts variadic arguments. Each value passed to contain() is expected to be in the container:
expect(@[@1, @2, @3]).to(contain(@1, @2)); // passes
Nimble v1.0.0 Final
Final version release! From now on, Nimble will follow semantic versioning rules.
Remember that version 1.0.0 of Nimble tracks with the stable Swift (1.2) / Xcode (6).
If you're using Swift 2.0 / Xcode 7, please use 2.0.0-rc.1
instead.
Diff from Release Candidate 1 to Final
Changes:
- beAKindOf and beAnInstanceOf raise errors when used with swift native types instead of producing obscure compiler errors.
- Publicize NMBObjCMatcher constructors
- Updated README to use
@import Nimble;
instead of#import <Nimble/Nimble.h>
for Objective-C.
Diff in Release Candidate 1
Repeated from 1.0.0-RC1 release notes.
Changes:
- FailureMessage.stringValue is now a property. It can be assigned to override other values.
- beTruthy() and beFalsy() matchers now work for nil types and Swift
- raiseException() no longer accepts matchers. Use the closure form instead.
- AssertionHandler protocol recieves FailureMessage instead of a String.
- Expectation.verify() now uses FailureMessage instead of String.
- Renamed NMB_wait* builder functions to be more consistent with rest of Nimble.
- fail() with no args passes through line number and file information
- NMBObjCMatcher closure no long accepts source location directly. Use actualExpression.location instead.
- FullMatcherFunc no longer negates doesNotMatch() when invoking its given closure.
Removed:
- NMBWait class is now private.
- Removed BasicMatcherWrapper
- Removed NonNilBasicMatcherWrapper
- Removed NonNilMatcherWrapper, use NonNilMatcherFunc for the same behavior.
- Removed FullMatcherWrapper
Nimble v2.0.0 Release Candidate 1
Release Candidate for 2.0.0, which supports Xcode 7 and Swift 2.0. Please try it out and report any issues. If all is well, then this version may migrate to final 2.0.0.
Note to Carthage Users: You must explicitly give this version for Carthage to install.
github "Quick/Nimble" "v2.0.0-rc.1"
Changes:
- Backwards incompatible changes for Swift 2.0.
- beEmpty() matcher is now defined specifically for String--in Swift 1.2 a
definition for NSString was sufficient.