mirror of
https://github.com/facebook/react-native.git
synced 2025-11-01 09:14:26 +00:00
Andres Suarez
8bd3edec88
Reviewed By: aaronabramov Differential Revision: D33367752 fbshipit-source-id: 4ce94d184485e5ee0a62cf67ad2d3ba16e285c8f
117 lines
4.3 KiB
Objective-C
117 lines
4.3 KiB
Objective-C
/*
|
|
* Copyright (c) Meta Platforms, Inc. and affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*/
|
|
|
|
#import <Foundation/Foundation.h>
|
|
#import <UIKit/UIKit.h>
|
|
|
|
typedef NS_ENUM(NSInteger, FBSnapshotTestControllerErrorCode) {
|
|
FBSnapshotTestControllerErrorCodeUnknown,
|
|
FBSnapshotTestControllerErrorCodeNeedsRecord,
|
|
FBSnapshotTestControllerErrorCodePNGCreationFailed,
|
|
FBSnapshotTestControllerErrorCodeImagesDifferentSizes,
|
|
FBSnapshotTestControllerErrorCodeImagesDifferent,
|
|
};
|
|
/**
|
|
Errors returned by the methods of FBSnapshotTestController use this domain.
|
|
*/
|
|
extern NSString *const FBSnapshotTestControllerErrorDomain;
|
|
|
|
/**
|
|
Errors returned by the methods of FBSnapshotTestController sometimes contain this key in the `userInfo` dictionary.
|
|
*/
|
|
extern NSString *const FBReferenceImageFilePathKey;
|
|
|
|
/**
|
|
Provides the heavy-lifting for FBSnapshotTestCase. It loads and saves images, along with performing the actual pixel-
|
|
by-pixel comparison of images.
|
|
Instances are initialized with the test class, and directories to read and write to.
|
|
*/
|
|
@interface FBSnapshotTestController : NSObject
|
|
|
|
/**
|
|
Record snapshots.
|
|
**/
|
|
@property (readwrite, nonatomic, assign) BOOL recordMode;
|
|
|
|
/**
|
|
@param testClass The subclass of FBSnapshotTestCase that is using this controller.
|
|
@returns An instance of FBSnapshotTestController.
|
|
*/
|
|
- (id)initWithTestClass:(Class)testClass;
|
|
|
|
/**
|
|
Designated initializer.
|
|
@param testName The name of the tests.
|
|
@returns An instance of FBSnapshotTestController.
|
|
*/
|
|
- (id)initWithTestName:(NSString *)testName;
|
|
|
|
/**
|
|
Performs the comparison of the view.
|
|
@param view The view to snapshot.
|
|
@param selector selector
|
|
@param identifier An optional identifier, used is there are multiple snapshot tests in a given -test method.
|
|
@param errorPtr An error to log in an XCTAssert() macro if the method fails (missing reference image, images differ,
|
|
etc).
|
|
@returns YES if the comparison (or saving of the reference image) succeeded.
|
|
*/
|
|
- (BOOL)compareSnapshotOfView:(UIView *)view
|
|
selector:(SEL)selector
|
|
identifier:(NSString *)identifier
|
|
error:(NSError **)errorPtr;
|
|
|
|
/**
|
|
The directory in which reference images are stored.
|
|
*/
|
|
@property (readwrite, nonatomic, copy) NSString *referenceImagesDirectory;
|
|
|
|
/**
|
|
Loads a reference image.
|
|
@param selector The test method being run.
|
|
@param identifier The optional identifier, used when multiple images are tested in a single -test method.
|
|
@param error An error, if this methods returns nil, the error will be something useful.
|
|
@returns An image.
|
|
*/
|
|
- (UIImage *)referenceImageForSelector:(SEL)selector identifier:(NSString *)identifier error:(NSError **)error;
|
|
|
|
/**
|
|
Saves a reference image.
|
|
@param selector The test method being run.
|
|
@param identifier The optional identifier, used when multiple images are tested in a single -test method.
|
|
@param errorPtr An error, if this methods returns NO, the error will be something useful.
|
|
@returns An image.
|
|
*/
|
|
- (BOOL)saveReferenceImage:(UIImage *)image
|
|
selector:(SEL)selector
|
|
identifier:(NSString *)identifier
|
|
error:(NSError **)errorPtr;
|
|
|
|
/**
|
|
Performs a pixel-by-pixel comparison of the two images.
|
|
@param referenceImage The reference (correct) image.
|
|
@param image The image to test against the reference.
|
|
@param errorPtr An error that indicates why the comparison failed if it does.
|
|
@returns YES if the comparison succeeded and the images are the same.
|
|
*/
|
|
- (BOOL)compareReferenceImage:(UIImage *)referenceImage toImage:(UIImage *)image error:(NSError **)errorPtr;
|
|
|
|
/**
|
|
Saves the reference image and the test image to `failedOutputDirectory`.
|
|
@param referenceImage The reference (correct) image.
|
|
@param testImage The image to test against the reference.
|
|
@param selector The test method being run.
|
|
@param identifier The optional identifier, used when multiple images are tested in a single -test method.
|
|
@param errorPtr An error that indicates why the comparison failed if it does.
|
|
@returns YES if the save succeeded.
|
|
*/
|
|
- (BOOL)saveFailedReferenceImage:(UIImage *)referenceImage
|
|
testImage:(UIImage *)testImage
|
|
selector:(SEL)selector
|
|
identifier:(NSString *)identifier
|
|
error:(NSError **)errorPtr;
|
|
@end
|