Add matcher to check whether an assertion was failed

.gitignore

@@ -1,5 +1,7 @@
 .DS_Store
-xcuserdata/
+**/xcuserdata/*
+**/*.xccheckout
+**/*.xcscmblueprint
 build/
 .idea
 DerivedData/

CONTRIBUTING.md

@@ -46,6 +46,14 @@ Be sure to include in your issue:
 
 - Use `Nimble.xcodeproj` to work on Nimble.
 
+## Running the Swift Package Manager tests
+
+1. Install `swiftenv` by running a line from the build script (`.travis.yml`):
+
+    eval "$(curl -sL https://gist.githubusercontent.com/kylef/5c0475ff02b7c7671d2a/raw/02090c7ede5a637b76e6df1710e83cd0bbe7dcdf/swiftenv-install.sh)"
+
+2. Run `./test swiftpm`
+
 ## Pull Requests
 
 - Nothing is trivial. Submit pull requests for anything: typos,

Package.swift

@@ -1,5 +1,8 @@
 import PackageDescription
 
 let package = Package(
-    name: "Nimble"
+    name: "Nimble",
+    exclude: ["Sources/Lib",
+              "Sources/Nimble/Matchers/ThrowAssertion.swift",
+              "Tests/Nimble/Matchers/ThrowAssertionTest.swift"]
 )

README.md

@@ -681,6 +681,23 @@ expect(actual).to(beFalse());
 expect(actual).to(beNil());
 ```
 
+## Swift Assertions
+
+If you're using Swift, you can use the `throwAssertion` matcher to check if an assertion is thrown (e.g. `fatalError()`). This is made possible by [@mattgallagher](https://github.com/mattgallagher)'s [CwlPreconditionTesting](https://github.com/mattgallagher/CwlPreconditionTesting) library
+
+```swift
+// Swift
+
+// Passes if somethingThatThrows() fails an assertion, such as calling fatalError():
+expect{ try somethingThatThrows() }.to(throwAssertion())
+```
+
+Notes:
+
+* This feature is only available in Swift.
+* It is only supported for `x86_64` binaries, meaning _you cannot run this matcher on iOS devices, only simulators_.
+* The tvOS simulator is supported, but using a different mechanism, requiring you to turn off the `Debug executable` scheme setting for your tvOS scheme's Test configuration.
+
 ## Swift Error Handling
 
 If you're using Swift 2.0+, you can use the `throwError` matcher to check if an error is thrown.
@@ -948,10 +965,10 @@ expect(actual).to(satisfyAnyOf(beLessThan(@10), beGreaterThan(@20)))
 expect(@6).to(satisfyAnyOf(equal(@2), equal(@3), equal(@4), equal(@5), equal(@6), equal(@7)))
 ```
 
-Note: This matcher allows you to chain any number of matchers together. This provides flexibility, 
-      but if you find yourself chaining many matchers together in one test, consider whether you  
-      could instead refactor that single test into multiple, more precisely focused tests for 
-      better coverage. 
+Note: This matcher allows you to chain any number of matchers together. This provides flexibility,
+      but if you find yourself chaining many matchers together in one test, consider whether you
+      could instead refactor that single test into multiple, more precisely focused tests for
+      better coverage.
 
 # Writing Your Own Matchers
 

Sources/Lib/CwlPreconditionTesting/CwlCatchException/CwlCatchException/CwlCatchException.h

@@ -0,0 +1,29 @@
+//
+//  CwlCatchException.h
+//  CwlCatchException
+//
+//  Created by Matt Gallagher on 2016/01/10.
+//  Copyright © 2016 Matt Gallagher ( http://cocoawithlove.com ). All rights reserved.
+//
+//  Permission to use, copy, modify, and/or distribute this software for any purpose with or without
+//  fee is hereby granted, provided that the above copyright notice and this permission notice
+//  appear in all copies.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
+//  SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+//  AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+//  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+//  NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+//  OF THIS SOFTWARE.
+//
+
+#import <Foundation/Foundation.h>
+
+//! Project version number for CwlCatchException.
+FOUNDATION_EXPORT double CwlCatchExceptionVersionNumber;
+
+//! Project version string for CwlCatchException.
+FOUNDATION_EXPORT const unsigned char CwlCatchExceptionVersionString[];
+
+__attribute__((visibility("hidden")))
+NSException* __nullable catchExceptionOfKind(Class __nonnull type, __attribute__((noescape)) void (^ __nonnull inBlock)());

Sources/Lib/CwlPreconditionTesting/CwlCatchException/CwlCatchException/CwlCatchException.m

@@ -0,0 +1,34 @@
+//
+//  CwlCatchException.m
+//  CwlAssertionTesting
+//
+//  Created by Matt Gallagher on 2016/01/10.
+//  Copyright © 2016 Matt Gallagher ( http://cocoawithlove.com ). All rights reserved.
+//
+//  Permission to use, copy, modify, and distribute this software for any purpose with or without
+//  fee is hereby granted, provided that the above copyright notice and this permission notice
+//  appear in all copies.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
+//  SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+//  AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+//  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+//  NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+//  OF THIS SOFTWARE.
+//
+
+#import "CwlCatchException.h"
+
+__attribute__((visibility("hidden")))
+NSException* catchExceptionOfKind(Class __nonnull type, __attribute__((noescape)) void (^ __nonnull inBlock)()) {
+	@try {
+		inBlock();
+	} @catch (NSException *exception)	{
+		if ([exception isKindOfClass:type]) {
+			return exception;
+		} else {
+			@throw;
+		}
+	}
+	return nil;
+}

Sources/Lib/CwlPreconditionTesting/CwlCatchException/CwlCatchException/CwlCatchException.swift

@@ -0,0 +1,31 @@
+//
+//  CwlCatchException.swift
+//  CwlAssertionTesting
+//
+//  Created by Matt Gallagher on 2016/01/10.
+//  Copyright © 2016 Matt Gallagher ( http://cocoawithlove.com ). All rights reserved.
+//
+//  Permission to use, copy, modify, and/or distribute this software for any purpose with or without
+//  fee is hereby granted, provided that the above copyright notice and this permission notice
+//  appear in all copies.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
+//  SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+//  AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+//  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+//  NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+//  OF THIS SOFTWARE.
+//
+
+import Foundation
+
+// We can't simply cast to Self? in the catchInBlock method so we need this generic function wrapper to do the conversion for us. Mildly annoying.
+private func catchReturnTypeConverter<T: NSException>(t: T.Type, @noescape block: () -> Void) -> T? {
+	return catchExceptionOfKind(t, block) as? T
+}
+
+extension NSException {
+	public static func catchException(@noescape block: () -> Void) -> Self? {
+		return catchReturnTypeConverter(self, block: block)
+	}
+}

Sources/Lib/CwlPreconditionTesting/CwlPreconditionTesting/CwlBadInstructionException.swift

@@ -0,0 +1,69 @@
+//
+//  CwlBadInstructionException.swift
+//  CwlPreconditionTesting
+//
+//  Created by Matt Gallagher on 2016/01/10.
+//  Copyright © 2016 Matt Gallagher ( http://cocoawithlove.com ). All rights reserved.
+//
+//  Permission to use, copy, modify, and distribute this software for any purpose with or without
+//  fee is hereby granted, provided that the above copyright notice and this permission notice
+//  appear in all copies.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
+//  SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+//  AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+//  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+//  NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+//  OF THIS SOFTWARE.
+//
+
+import Foundation
+
+#if arch(x86_64)
+
+private func raiseBadInstructionException() {
+	BadInstructionException().raise()
+}
+
+/// A simple NSException subclass. It's not required to subclass NSException (since the exception type is represented in the name) but this helps for identifying the exception through runtime type.
+@objc public class BadInstructionException: NSException {
+	static var name: String = "com.cocoawithlove.BadInstruction"
+
+	init() {
+		super.init(name: BadInstructionException.name, reason: nil, userInfo: nil)
+	}
+
+	required public init?(coder aDecoder: NSCoder) {
+		super.init(coder: aDecoder)
+	}
+
+	/// An Objective-C callable function, invoked from the `mach_exc_server` callback function `catch_mach_exception_raise_state` to push the `raiseBadInstructionException` function onto the stack.
+	public class func catch_mach_exception_raise_state(exception_port: mach_port_t, exception: exception_type_t, code: UnsafePointer<mach_exception_data_type_t>, codeCnt: mach_msg_type_number_t, flavor: UnsafeMutablePointer<Int32>, old_state: UnsafePointer<natural_t>, old_stateCnt: mach_msg_type_number_t, new_state: thread_state_t, new_stateCnt: UnsafeMutablePointer<mach_msg_type_number_t>) -> kern_return_t {
+
+		// Make sure we've been given enough memory
+		if old_stateCnt != x86_THREAD_STATE64_COUNT || new_stateCnt.memory < x86_THREAD_STATE64_COUNT {
+			return KERN_INVALID_ARGUMENT
+		}
+
+		// Read the old thread state
+		var state = UnsafePointer<x86_thread_state64_t>(old_state).memory
+
+		// 1. Decrement the stack pointer
+		state.__rsp -= __uint64_t(sizeof(Int))
+
+		// 2. Save the old Instruction Pointer to the stack.
+		UnsafeMutablePointer<__uint64_t>(bitPattern: UInt(state.__rsp)).memory = state.__rip
+
+		// 3. Set the Instruction Pointer to the new function's address
+		var f: @convention(c) () -> Void = raiseBadInstructionException
+		withUnsafePointer(&f) { state.__rip = UnsafePointer<__uint64_t>($0).memory }
+
+		// Write the new thread state
+		UnsafeMutablePointer<x86_thread_state64_t>(new_state).memory = state
+		new_stateCnt.memory = x86_THREAD_STATE64_COUNT
+
+		return KERN_SUCCESS
+	}
+}
+
+#endif

Sources/Lib/CwlPreconditionTesting/CwlPreconditionTesting/CwlCatchBadInstruction.h

@@ -0,0 +1,60 @@
+//
+//  CwlCatchBadInstruction.h
+//  CwlPreconditionTesting
+//
+//  Created by Matt Gallagher on 2016/01/10.
+//  Copyright © 2016 Matt Gallagher ( http://cocoawithlove.com ). All rights reserved.
+//
+//  Permission to use, copy, modify, and distribute this software for any purpose with or without
+//  fee is hereby granted, provided that the above copyright notice and this permission notice
+//  appear in all copies.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
+//  SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+//  AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+//  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+//  NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+//  OF THIS SOFTWARE.
+//
+
+#if defined(__x86_64__)
+
+#import <Foundation/Foundation.h>
+#import <mach/mach.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+// The request_mach_exception_raise_t struct is passed to mach_msg which assumes its exact layout. To avoid problems with different layouts, we keep the definition in C rather than Swift.
+typedef struct
+{
+	mach_msg_header_t Head;
+	/* start of the kernel processed data */
+	mach_msg_body_t msgh_body;
+	mach_msg_port_descriptor_t thread;
+	mach_msg_port_descriptor_t task;
+	/* end of the kernel processed data */
+	NDR_record_t NDR;
+	exception_type_t exception;
+	mach_msg_type_number_t codeCnt;
+	int64_t code[2];
+	int flavor;
+	mach_msg_type_number_t old_stateCnt;
+	natural_t old_state[224];
+} request_mach_exception_raise_t;
+
+// The reply_mach_exception_raise_state_t struct is passed to mach_msg which assumes its exact layout. To avoid problems with different layouts, we keep the definition in C rather than Swift.
+typedef struct
+{
+	mach_msg_header_t Head;
+	NDR_record_t NDR;
+	kern_return_t RetCode;
+	int flavor;
+	mach_msg_type_number_t new_stateCnt;
+	natural_t new_state[224];
+} reply_mach_exception_raise_state_t;
+
+extern boolean_t mach_exc_server(mach_msg_header_t *InHeadP, mach_msg_header_t *OutHeadP);
+
+NS_ASSUME_NONNULL_END
+
+#endif

Sources/Lib/CwlPreconditionTesting/CwlPreconditionTesting/CwlCatchBadInstruction.m

@@ -0,0 +1,49 @@
+//
+//  CwlCatchBadInstruction.m
+//  CwlPreconditionTesting
+//
+//  Created by Matt Gallagher on 2016/01/10.
+//  Copyright © 2016 Matt Gallagher ( http://cocoawithlove.com ). All rights reserved.
+//
+//  Permission to use, copy, modify, and distribute this software for any purpose with or without
+//  fee is hereby granted, provided that the above copyright notice and this permission notice
+//  appear in all copies.
+//
+//  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS
+//  SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
+//  AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+//  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
+//  NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
+//  OF THIS SOFTWARE.
+//
+
+#if defined(__x86_64__)
+
+#import "CwlCatchBadInstruction.h"
+
+// Assuming the "PRODUCT_NAME" macro is defined, this will create the name of the Swift generated header file
+#define STRINGIZE_NO_EXPANSION(A) #A
+#define STRINGIZE_WITH_EXPANSION(A) STRINGIZE_NO_EXPANSION(A)
+#define SWIFT_INCLUDE STRINGIZE_WITH_EXPANSION(PRODUCT_NAME-Swift.h)
+
+// Include the Swift generated header file
+#import SWIFT_INCLUDE
+
+/// A basic function that receives callbacks from mach_exc_server and relays them to the Swift implemented BadInstructionException.catch_mach_exception_raise_state.
+kern_return_t catch_mach_exception_raise_state(mach_port_t exception_port, exception_type_t exception, const mach_exception_data_t code, mach_msg_type_number_t codeCnt, int *flavor, const thread_state_t old_state, mach_msg_type_number_t old_stateCnt, thread_state_t new_state, mach_msg_type_number_t *new_stateCnt) {
+    return [BadInstructionException catch_mach_exception_raise_state:exception_port exception:exception code:code codeCnt:codeCnt flavor:flavor old_state:old_state old_stateCnt:old_stateCnt new_state:new_state new_stateCnt:new_stateCnt];
+}
+
+// The mach port should be configured so that this function is never used.
+kern_return_t catch_mach_exception_raise(mach_port_t exception_port, mach_port_t thread, mach_port_t task, exception_type_t exception, mach_exception_data_t code, mach_msg_type_number_t codeCnt) {
+	assert(false);
+    return KERN_FAILURE;
+}
+
+// The mach port should be configured so that this function is never used.
+kern_return_t catch_mach_exception_raise_state_identity(mach_port_t exception_port, mach_port_t thread, mach_port_t task, exception_type_t exception, mach_exception_data_t code, mach_msg_type_number_t codeCnt, int *flavor, thread_state_t old_state, mach_msg_type_number_t old_stateCnt, thread_state_t new_state, mach_msg_type_number_t *new_stateCnt) {
+	assert(false);
+    return KERN_FAILURE;
+}
+
+#endif