Support library test bundles #13
Merged
Conversation
This file contains 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
bielski
reviewed
Feb 7, 2018
| * `UIWindow` — You cannot make a `UIWindow` you created during your test the 'key window' because `makeKeyAndVisible` crashes at test run time. One workaround is to instead set `hidden` to `false` on the `UIWindow` instance you created. However there still won't be a 'key window' so if you have code that adds a `UIView` as a subview of the `keyWindow` then that will break. | ||
|
|
||
| ### Library tests | ||
| Unit tests that test parts of a framework or libary should be part of a Library test bundle. This does not require a Test Host or a Simulator (though in Xcode 9, Apple still launches a Simulator for these tests). |
| " host sets up a key window at launch (either via storyboards or programmatically) and doesn't" | ||
| " do anything to remove it while snapshot tests are running."]; | ||
| } | ||
| NSString *message = @"Snapshot tests should be hosted by an application with a key window. Please ensure your test host sets up a key window at launch (either via storyboards or programmatically) and doesn't do anything to remove it while snapshot tests are running."; |
There was a problem hiding this comment.
Why to log this message if keyWindow exists? Maybe you should keep it in if statement?
Also, you didn't update a comment in a header file about raising an exception.
(not sure if this method should still contain strict word in the name...)
|
|
||
| ### Application tests | ||
|
|
||
| Unit tests that test parts of an application (such as UIViewControllers, UIWindows, UIViews) should typically be part of an Application test bundle. An Application test bundle requires a Test Host and at test run time, a Simulator too. |
There was a problem hiding this comment.
Library tests also need to be run in the context of a simulator to access ios sdk specific API's. The increased functionality that the test host gives is an app context, which provides access to api's around app/viewcontroller lifecycle, functionality requiring entitlements.
| * `-[UIControl sendActionsForControlEvents:]` — This API is commonly used to trigger actions at runtime and sometimes you might want to use it inside a test to trigger a particular code path which is ordinarily run when a user performs an action. While it does not work inside a Library test bundle, [we've written our own version for unit tests](FBSnapshotTestCase/Categories/UIControl+SendActions.h) that works well for this need. If you decide to use that category, make sure it can only be seen inside unit tests and not all of your code. | ||
| * `UIAppearance` — Most `UIAppearance` APIs break when there is no test host present. | ||
| * `UIWindow` — You cannot make a `UIWindow` you created during your test the 'key window' because `makeKeyAndVisible` crashes at test run time. One workaround is to instead set `hidden` to `false` on the `UIWindow` instance you created. However there still won't be a 'key window' so if you have code that adds a `UIView` as a subview of the `keyWindow` then that will break. | ||
|
|
There was a problem hiding this comment.
I think we also had some tests requiring keychain access that needed to be run with a test host.
alanzeino
force-pushed
the
libraryvsapplication
branch
from
0581324 to
71bbf33
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
...the library has historically been quite strict about enforcing that snapshots are run inside an Application test bundle with a Test Host. However as I discussed in the old repository, this can be relaxed for some cases:
facebookarchive/ios-snapshot-test-case#235