Added a hook on SLTest exposing failures that are encountered during a test run. #220
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| // | ||
| // SLTestState.h | ||
| // Subliminal | ||
| // | ||
| // Created by Jacob Relkin on 8/22/14. | ||
| // Copyright (c) 2014 Inkling. All rights reserved. | ||
| // | ||
|
|
||
| #import <Foundation/Foundation.h> | ||
|
|
||
| @class SLTestFailure; | ||
|
|
||
| /** | ||
| SLTestState objects define the state of a Subliminal test or test case. | ||
| */ | ||
|
|
||
| @interface SLTestState : NSObject | ||
|
|
||
| /** | ||
| Denotes whether the test or test case failed | ||
| */ | ||
| @property (nonatomic, readonly) BOOL failed; | ||
|
|
||
| /** | ||
| If the test or test case failure was expected. | ||
| */ | ||
| @property (nonatomic, readonly) BOOL failureWasExpected; | ||
|
|
||
| /** | ||
| Sets the properties above, from the failure's description. | ||
| The value of `failureWasExpected` is determined by the first failure that was encountered. | ||
|
|
||
| @param failure The test failure to record. | ||
| */ | ||
| - (void)recordFailure:(SLTestFailure *)failure; | ||
|
|
||
| @end |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| // | ||
| // SLTestState.m | ||
| // Subliminal | ||
| // | ||
| // Created by Jacob Relkin on 8/22/14. | ||
| // Copyright (c) 2014 Inkling. All rights reserved. | ||
| // | ||
|
|
||
| #import "SLTestState.h" | ||
| #import "SLTestFailure.h" | ||
|
|
||
| @interface SLTestState () | ||
|
|
||
| @property (nonatomic, readwrite) BOOL failed; | ||
| @property (nonatomic, readwrite) BOOL failureWasExpected; | ||
|
|
||
| @end | ||
|
|
||
| @implementation SLTestState | ||
|
|
||
| - (void)recordFailure:(SLTestFailure *)failure { | ||
| NSParameterAssert(failure); | ||
|
|
||
| if (!self.failed) { | ||
| self.failureWasExpected = failure.isExpected; | ||
| } | ||
|
|
||
| self.failed = YES; | ||
| } | ||
|
|
||
| @end |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| // | ||
| // SLTestCaseFailure.h | ||
| // Subliminal | ||
| // | ||
| // Created by Jacob Relkin on 6/20/14. | ||
| // Copyright (c) 2014 Inkling. All rights reserved. | ||
| // | ||
|
|
||
| #import <Foundation/Foundation.h> | ||
|
|
||
| typedef NS_ENUM(NSUInteger, SLTestFailurePhase) { | ||
| SLTestFailurePhaseTestSetup, | ||
| SLTestFailurePhaseTestCaseSetup, | ||
| SLTestFailurePhaseTestCaseExecution, | ||
| SLTestFailurePhaseTestCaseTeardown, | ||
| SLTestFailurePhaseTestTeardown | ||
| }; | ||
|
|
||
| /** | ||
| SLTestFailure objects hold failure information for Subliminal test and test cases. | ||
| */ | ||
|
|
||
| @interface SLTestFailure : NSObject | ||
|
|
||
| /** | ||
| @param exception The exception that was thrown to cause this failure. | ||
| @param phase The phase in the test lifecycle in which the failure happened. | ||
| @param testCaseSelector The failed test case's selector. (can be NULL) | ||
| @return A new SLTestFailure object. | ||
| */ | ||
| + (instancetype)failureWithException:(NSException *)exception phase:(SLTestFailurePhase)phase testCaseSelector:(SEL)testCaseSelector; | ||
|
|
||
| /** | ||
| The phase in the test lifecycle in which the failure happened. | ||
| */ | ||
| @property (nonatomic, readonly, assign) SLTestFailurePhase phase; | ||
|
|
||
| /** | ||
| The failed test case's selector. (can be NULL) | ||
| */ | ||
| @property (nonatomic, readonly, assign) SEL testCaseSelector; | ||
|
|
||
| /** | ||
| The exception that was thrown to cause this failure. | ||
| */ | ||
| @property (nonatomic, readonly, strong) NSException *exception; | ||
|
|
||
| /** | ||
| If the failure was expected. | ||
| */ | ||
| @property (nonatomic, readonly, getter = isExpected) BOOL expected; | ||
|
|
||
| @end |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| // | ||
| // SLTestCaseFailure.m | ||
| // Subliminal | ||
| // | ||
| // Created by Jacob Relkin on 6/20/14. | ||
| // Copyright (c) 2014 Inkling. All rights reserved. | ||
| // | ||
|
|
||
| #import "SLTestFailure.h" | ||
| #import "SLTest.h" | ||
|
|
||
| @interface SLTestFailure () | ||
|
|
||
| @property (nonatomic, readwrite, strong) NSException *exception; | ||
| @property (nonatomic, readwrite, assign) SEL testCaseSelector; | ||
| @property (nonatomic, readwrite, assign) SLTestFailurePhase phase; | ||
|
|
||
| @end | ||
|
|
||
| @implementation SLTestFailure | ||
|
|
||
| + (instancetype)failureWithException:(NSException *)exception phase:(SLTestFailurePhase)phase testCaseSelector:(SEL)testCaseSelector { | ||
| SLTestFailure *failure = [self new]; | ||
| failure.phase = phase; | ||
| failure.exception = exception; | ||
| failure.testCaseSelector = testCaseSelector; | ||
| return failure; | ||
| } | ||
|
|
||
| - (BOOL)isEqual:(id)object { | ||
| if (![object isKindOfClass:[SLTestFailure class]]) { | ||
|
There was a problem hiding this comment.
|
||
| return NO; | ||
| } | ||
|
|
||
| SLTestFailure *otherObject = object; | ||
| return (otherObject.phase == self.phase && | ||
| otherObject.testCaseSelector == self.testCaseSelector && | ||
| otherObject.isExpected == self.isExpected && | ||
| [otherObject.exception.name isEqualToString:self.exception.name] && | ||
| [otherObject.exception.reason isEqualToString:self.exception.reason]); | ||
| } | ||
|
|
||
| - (BOOL)isExpected { | ||
| return [self.exception.name isEqualToString:SLTestAssertionFailedException]; | ||
| } | ||
|
|
||
| @end | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I admire the impulse to keep
SLTestas stateless as possible though it does make naming this method tricky, haha.What do you think about
-reportFailureWithException:inPhase:withTestCaseSelector:state:? The idea being to keep the test state parameters contiguous. This mirrorsSLTestFailure's initializer too.