@devicelab/maestro-runner-darwin-x64 1.1.25

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Commands/FBFindElementCommands.h

@@ -0,0 +1,18 @@
+/**
+ * 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.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import <WebDriverAgentLib/FBCommandHandler.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface FBFindElementCommands : NSObject <FBCommandHandler>
+@end
+
+NS_ASSUME_NONNULL_END

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Commands/FBFindElementCommands.m

@@ -0,0 +1,186 @@
+/**
+ * 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.
+ */
+
+#import "FBFindElementCommands.h"
+
+#import "FBAlert.h"
+#import "FBConfiguration.h"
+#import "FBElementCache.h"
+#import "FBExceptions.h"
+#import "FBMacros.h"
+#import "FBRouteRequest.h"
+#import "FBSession.h"
+#import "XCTestPrivateSymbols.h"
+#import "XCUIApplication+FBHelpers.h"
+#import "XCUIElement+FBClassChain.h"
+#import "XCUIElement+FBFind.h"
+#import "XCUIElement+FBIsVisible.h"
+#import "XCUIElement+FBUID.h"
+#import "XCUIElement+FBUtilities.h"
+#import "XCUIElement+FBWebDriverAttributes.h"
+
+static id<FBResponsePayload> FBNoSuchElementErrorResponseForRequest(FBRouteRequest *request)
+{
+  return FBResponseWithStatus([FBCommandStatus noSuchElementErrorWithMessage:[NSString stringWithFormat:@"unable to find an element using '%@', value '%@'", request.arguments[@"using"], request.arguments[@"value"]]
+                                                                   traceback:[NSString stringWithFormat:@"%@", NSThread.callStackSymbols]]);
+}
+
+@implementation FBFindElementCommands
+
+#pragma mark - <FBCommandHandler>
+
++ (NSArray *)routes
+{
+  return
+  @[
+    [[FBRoute POST:@"/element"] respondWithTarget:self action:@selector(handleFindElement:)],
+    [[FBRoute POST:@"/elements"] respondWithTarget:self action:@selector(handleFindElements:)],
+    [[FBRoute POST:@"/element/:uuid/element"] respondWithTarget:self action:@selector(handleFindSubElement:)],
+    [[FBRoute POST:@"/element/:uuid/elements"] respondWithTarget:self action:@selector(handleFindSubElements:)],
+    [[FBRoute GET:@"/wda/element/:uuid/getVisibleCells"] respondWithTarget:self action:@selector(handleFindVisibleCells:)],
+#if TARGET_OS_TV
+    [[FBRoute GET:@"/element/active"] respondWithTarget:self action:@selector(handleGetFocusedElement:)],
+#else
+    [[FBRoute GET:@"/element/active"] respondWithTarget:self action:@selector(handleGetActiveElement:)],
+#endif
+  ];
+}
+
+
+#pragma mark - Commands
+
++ (id<FBResponsePayload>)handleFindElement:(FBRouteRequest *)request
+{
+  FBSession *session = request.session;
+  XCUIElement *element = [self.class elementUsing:request.arguments[@"using"]
+                                        withValue:request.arguments[@"value"]
+                                            under:session.activeApplication];
+  if (!element) {
+    return FBNoSuchElementErrorResponseForRequest(request);
+  }
+  return FBResponseWithCachedElement(element, request.session.elementCache, FBConfiguration.shouldUseCompactResponses);
+}
+
++ (id<FBResponsePayload>)handleFindElements:(FBRouteRequest *)request
+{
+  FBSession *session = request.session;
+  NSArray *elements = [self.class elementsUsing:request.arguments[@"using"]
+                                      withValue:request.arguments[@"value"]
+                                          under:session.activeApplication
+                    shouldReturnAfterFirstMatch:NO];
+  return FBResponseWithCachedElements(elements, request.session.elementCache, FBConfiguration.shouldUseCompactResponses);
+}
+
++ (id<FBResponsePayload>)handleFindVisibleCells:(FBRouteRequest *)request
+{
+  FBElementCache *elementCache = request.session.elementCache;
+  XCUIElement *element = [elementCache elementForUUID:(NSString *)request.parameters[@"uuid"]];
+  id<FBXCElementSnapshot> snapshot = [element fb_customSnapshot];
+  NSArray<id<FBXCElementSnapshot>> *visibleCellSnapshots = [snapshot descendantsByFilteringWithBlock:^BOOL(id<FBXCElementSnapshot> shot) {
+    return shot.elementType == XCUIElementTypeCell
+      && [FBXCElementSnapshotWrapper ensureWrapped:shot].wdVisible;
+  }];
+  NSArray *cells = [element fb_filterDescendantsWithSnapshots:visibleCellSnapshots
+                                                 onlyChildren:NO];
+  return FBResponseWithCachedElements(cells, request.session.elementCache, FBConfiguration.shouldUseCompactResponses);
+}
+
++ (id<FBResponsePayload>)handleFindSubElement:(FBRouteRequest *)request
+{
+  FBElementCache *elementCache = request.session.elementCache;
+  XCUIElement *element = [elementCache elementForUUID:(NSString *)request.parameters[@"uuid"]
+                                       checkStaleness:NO];
+  XCUIElement *foundElement = [self.class elementUsing:request.arguments[@"using"]
+                                             withValue:request.arguments[@"value"]
+                                                 under:element];
+  if (!foundElement) {
+    return FBNoSuchElementErrorResponseForRequest(request);
+  }
+  return FBResponseWithCachedElement(foundElement, request.session.elementCache, FBConfiguration.shouldUseCompactResponses);
+}
+
++ (id<FBResponsePayload>)handleFindSubElements:(FBRouteRequest *)request
+{
+  FBElementCache *elementCache = request.session.elementCache;
+  XCUIElement *element = [elementCache elementForUUID:(NSString *)request.parameters[@"uuid"]
+                                       checkStaleness:NO];
+  NSArray *foundElements = [self.class elementsUsing:request.arguments[@"using"]
+                                           withValue:request.arguments[@"value"]
+                                               under:element
+                         shouldReturnAfterFirstMatch:NO];
+  return FBResponseWithCachedElements(foundElements, request.session.elementCache, FBConfiguration.shouldUseCompactResponses);
+}
+
++ (id<FBResponsePayload>)handleGetActiveElement:(FBRouteRequest *)request
+{
+  XCUIElement *element = request.session.activeApplication.fb_activeElement;
+  if (nil == element) {
+    return FBNoSuchElementErrorResponseForRequest(request);
+  }
+  return FBResponseWithCachedElement(element, request.session.elementCache, FBConfiguration.shouldUseCompactResponses);
+}
+
+#if TARGET_OS_TV
++ (id<FBResponsePayload>)handleGetFocusedElement:(FBRouteRequest *)request
+{
+  XCUIElement *element = request.session.activeApplication.fb_focusedElement;
+  return element == nil
+    ? FBNoSuchElementErrorResponseForRequest(request)
+    : FBResponseWithCachedElement(element, request.session.elementCache, FBConfiguration.shouldUseCompactResponses);
+}
+#endif
+
+#pragma mark - Helpers
+
++ (XCUIElement *)elementUsing:(NSString *)usingText withValue:(NSString *)value under:(XCUIElement *)element
+{
+  return [[self elementsUsing:usingText
+                    withValue:value
+                        under:element
+  shouldReturnAfterFirstMatch:YES] firstObject];
+}
+
++ (NSArray *)elementsUsing:(NSString *)usingText
+                 withValue:(NSString *)value
+                     under:(XCUIElement *)element
+shouldReturnAfterFirstMatch:(BOOL)shouldReturnAfterFirstMatch
+{
+  if ([usingText isEqualToString:@"partial link text"]
+      || [usingText isEqualToString:@"link text"]) {
+    NSArray *components = [value componentsSeparatedByString:@"="];
+    NSString *propertyValue = components.lastObject;
+    NSString *propertyName = (components.count < 2 ? @"name" : components.firstObject);
+    return [element fb_descendantsMatchingProperty:propertyName
+                                             value:propertyValue
+                                     partialSearch:[usingText containsString:@"partial"]];
+  } else if ([usingText isEqualToString:@"class name"]) {
+    return [element fb_descendantsMatchingClassName:value
+                        shouldReturnAfterFirstMatch:shouldReturnAfterFirstMatch];
+  } else if ([usingText isEqualToString:@"class chain"]) {
+    return [element fb_descendantsMatchingClassChain:value
+                         shouldReturnAfterFirstMatch:shouldReturnAfterFirstMatch];
+  } else if ([usingText isEqualToString:@"xpath"]) {
+    return [element fb_descendantsMatchingXPathQuery:value
+                         shouldReturnAfterFirstMatch:shouldReturnAfterFirstMatch];
+  } else if ([usingText isEqualToString:@"predicate string"]) {
+    return [element fb_descendantsMatchingPredicate:[NSPredicate predicateWithFormat:value]
+                        shouldReturnAfterFirstMatch:shouldReturnAfterFirstMatch];
+  } else if ([usingText isEqualToString:@"name"]
+             || [usingText isEqualToString:@"id"]
+             || [usingText isEqualToString:@"accessibility id"]) {
+    return [element fb_descendantsMatchingIdentifier:value
+                         shouldReturnAfterFirstMatch:shouldReturnAfterFirstMatch];
+  } else {
+    @throw [NSException exceptionWithName:FBElementAttributeUnknownException
+                                   reason:[NSString stringWithFormat:@"Invalid locator requested: %@", usingText]
+                                 userInfo:nil];
+  }
+}
+
+@end
+

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Commands/FBOrientationCommands.h

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import <WebDriverAgentLib/FBCommandHandler.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface FBOrientationCommands : NSObject <FBCommandHandler>
+
+@end
+
+NS_ASSUME_NONNULL_END

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Commands/FBOrientationCommands.m

@@ -0,0 +1,185 @@
+/**
+ * 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.
+ */
+
+#import "FBOrientationCommands.h"
+#import "XCUIDevice+FBRotation.h"
+#import "FBRouteRequest.h"
+#import "FBMacros.h"
+#import "FBSession.h"
+#import "XCUIApplication.h"
+#import "XCUIApplication+FBHelpers.h"
+#import "XCUIDevice.h"
+
+extern const struct FBWDOrientationValues {
+  FBLiteralString portrait;
+  FBLiteralString landscapeLeft;
+  FBLiteralString landscapeRight;
+  FBLiteralString portraitUpsideDown;
+} FBWDOrientationValues;
+
+const struct FBWDOrientationValues FBWDOrientationValues = {
+  .portrait = @"PORTRAIT",
+  .landscapeLeft = @"LANDSCAPE",
+  .landscapeRight = @"UIA_DEVICE_ORIENTATION_LANDSCAPERIGHT",
+  .portraitUpsideDown = @"UIA_DEVICE_ORIENTATION_PORTRAIT_UPSIDEDOWN",
+};
+
+#if !TARGET_OS_TV
+
+@implementation FBOrientationCommands
+
+#pragma mark - <FBCommandHandler>
+
++ (NSArray *)routes
+{
+  return
+  @[
+    [[FBRoute GET:@"/orientation"] respondWithTarget:self action:@selector(handleGetOrientation:)],
+    [[FBRoute GET:@"/orientation"].withoutSession respondWithTarget:self action:@selector(handleGetOrientation:)],
+    [[FBRoute POST:@"/orientation"] respondWithTarget:self action:@selector(handleSetOrientation:)],
+    [[FBRoute POST:@"/orientation"].withoutSession respondWithTarget:self action:@selector(handleSetOrientation:)],
+    [[FBRoute GET:@"/rotation"] respondWithTarget:self action:@selector(handleGetRotation:)],
+    [[FBRoute GET:@"/rotation"].withoutSession respondWithTarget:self action:@selector(handleGetRotation:)],
+    [[FBRoute POST:@"/rotation"] respondWithTarget:self action:@selector(handleSetRotation:)],
+    [[FBRoute POST:@"/rotation"].withoutSession respondWithTarget:self action:@selector(handleSetRotation:)],
+  ];
+}
+
+
+#pragma mark - Commands
+
++ (id<FBResponsePayload>)handleGetOrientation:(FBRouteRequest *)request
+{
+  XCUIApplication *application = request.session.activeApplication ?: XCUIApplication.fb_activeApplication;
+  NSString *orientation = [self.class interfaceOrientationForApplication:application];
+  return FBResponseWithObject([[self _wdOrientationsMapping] objectForKey:orientation]);
+}
+
++ (id<FBResponsePayload>)handleSetOrientation:(FBRouteRequest *)request
+{
+  XCUIApplication *application = request.session.activeApplication ?: XCUIApplication.fb_activeApplication;
+  if ([self.class setDeviceOrientation:request.arguments[@"orientation"] forApplication:application]) {
+    return FBResponseWithOK();
+  }
+
+  return FBResponseWithUnknownErrorFormat(@"Unable To Rotate Device");
+}
+
++ (id<FBResponsePayload>)handleGetRotation:(FBRouteRequest *)request
+{
+  XCUIDevice *device = [XCUIDevice sharedDevice];
+  XCUIApplication *application = request.session.activeApplication ?: XCUIApplication.fb_activeApplication;
+  UIInterfaceOrientation orientation = application.interfaceOrientation;
+  return FBResponseWithObject(device.fb_rotationMapping[@(orientation)]);
+}
+
++ (id<FBResponsePayload>)handleSetRotation:(FBRouteRequest *)request
+{
+  if (nil == request.arguments[@"x"] || nil == request.arguments[@"y"] || nil == request.arguments[@"z"]) {
+    NSString *errMessage = [NSString stringWithFormat:@"x, y and z arguments must exist in the request body: %@", request.arguments];
+    return FBResponseWithStatus([FBCommandStatus invalidArgumentErrorWithMessage:errMessage
+                                                                       traceback:nil]);
+  }
+
+  NSDictionary* rotation = @{
+    @"x": request.arguments[@"x"] ?: @0,
+    @"y": request.arguments[@"y"] ?: @0,
+    @"z": request.arguments[@"z"] ?: @0,
+  };
+  NSArray<NSDictionary *> *supportedRotations = XCUIDevice.sharedDevice.fb_rotationMapping.allValues;
+  if (![supportedRotations containsObject:rotation]) {
+    NSString *errMessage = [
+      NSString stringWithFormat:@"%@ rotation is not supported. Only the following values are supported: %@",
+      rotation, supportedRotations
+    ];
+    return FBResponseWithStatus([FBCommandStatus invalidArgumentErrorWithMessage:errMessage
+                                                                       traceback:nil]);
+  }
+
+  XCUIApplication *application = request.session.activeApplication ?: XCUIApplication.fb_activeApplication;
+  if (![self.class setDeviceRotation:request.arguments forApplication:application]) {
+    NSString *errMessage = [
+      NSString stringWithFormat:@"The current rotation cannot be set to %@. Make sure the %@ application supports it",
+      rotation, application.bundleID
+    ];
+    return FBResponseWithStatus([FBCommandStatus invalidElementStateErrorWithMessage:errMessage
+                                                                           traceback:nil]);
+  }
+  return FBResponseWithOK();
+}
+
+
+#pragma mark - Helpers
+
++ (NSString *)interfaceOrientationForApplication:(XCUIApplication *)application
+{
+  NSNumber *orientation = @(application.interfaceOrientation);
+  NSSet *keys = [[self _orientationsMapping] keysOfEntriesPassingTest:^BOOL(id key, NSNumber *obj, BOOL *stop) {
+    return [obj isEqualToNumber:orientation];
+  }];
+  if (keys.count == 0) {
+    return @"Unknown orientation";
+  }
+  return keys.anyObject;
+}
+
++ (BOOL)setDeviceRotation:(NSDictionary *)rotationObj forApplication:(XCUIApplication *)application
+{
+  return [[XCUIDevice sharedDevice] fb_setDeviceRotation:rotationObj];
+}
+
++ (BOOL)setDeviceOrientation:(NSString *)orientation forApplication:(XCUIApplication *)application
+{
+  NSNumber *orientationValue = [[self _orientationsMapping] objectForKey:[orientation uppercaseString]];
+  if (orientationValue == nil) {
+    return NO;
+  }
+  return [[XCUIDevice sharedDevice] fb_setDeviceInterfaceOrientation:orientationValue.integerValue];
+}
+
++ (NSDictionary *)_orientationsMapping
+{
+  static NSDictionary *orientationMap;
+  static dispatch_once_t onceToken;
+  dispatch_once(&onceToken, ^{
+    orientationMap =
+    @{
+      FBWDOrientationValues.portrait : @(UIDeviceOrientationPortrait),
+      FBWDOrientationValues.portraitUpsideDown : @(UIDeviceOrientationPortraitUpsideDown),
+      FBWDOrientationValues.landscapeLeft : @(UIDeviceOrientationLandscapeLeft),
+      FBWDOrientationValues.landscapeRight : @(UIDeviceOrientationLandscapeRight),
+      };
+  });
+  return orientationMap;
+}
+
+/*
+ We already have FBWDOrientationValues as orientation descriptions, however the strings are not valid
+ WebDriver responses. WebDriver can only receive 'portrait' or 'landscape'. So we can pass the keys
+ through this additional filter to ensure we get one of those. It's essentially a mapping from
+ FBWDOrientationValues to the valid subset of itself we can return to the client
+ */
++ (NSDictionary *)_wdOrientationsMapping
+{
+  static NSDictionary *orientationMap;
+  static dispatch_once_t onceToken;
+  dispatch_once(&onceToken, ^{
+    orientationMap =
+    @{
+      FBWDOrientationValues.portrait : FBWDOrientationValues.portrait,
+      FBWDOrientationValues.portraitUpsideDown : FBWDOrientationValues.portrait,
+      FBWDOrientationValues.landscapeLeft : FBWDOrientationValues.landscapeLeft,
+      FBWDOrientationValues.landscapeRight : FBWDOrientationValues.landscapeLeft,
+      };
+  });
+  return orientationMap;
+}
+
+@end
+
+#endif

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Commands/FBScreenshotCommands.h

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import <WebDriverAgentLib/FBCommandHandler.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface FBScreenshotCommands : NSObject <FBCommandHandler>
+
+@end
+
+NS_ASSUME_NONNULL_END

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Commands/FBScreenshotCommands.m

@@ -0,0 +1,40 @@
+/**
+ * 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.
+ */
+
+#import "FBScreenshotCommands.h"
+
+#import "XCUIDevice+FBHelpers.h"
+
+@implementation FBScreenshotCommands
+
+#pragma mark - <FBCommandHandler>
+
++ (NSArray *)routes
+{
+  return
+  @[
+    [[FBRoute GET:@"/screenshot"].withoutSession respondWithTarget:self action:@selector(handleGetScreenshot:)],
+    [[FBRoute GET:@"/screenshot"] respondWithTarget:self action:@selector(handleGetScreenshot:)],
+  ];
+}
+
+
+#pragma mark - Commands
+
++ (id<FBResponsePayload>)handleGetScreenshot:(FBRouteRequest *)request
+{
+  NSError *error;
+  NSData *screenshotData = [[XCUIDevice sharedDevice] fb_screenshotWithError:&error];
+  if (nil == screenshotData) {
+    return FBResponseWithStatus([FBCommandStatus unableToCaptureScreenErrorWithMessage:error.description traceback:nil]);
+  }
+  NSString *screenshot = [screenshotData base64EncodedStringWithOptions:0];
+  return FBResponseWithObject(screenshot);
+}
+
+@end

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Commands/FBSessionCommands.h

@@ -0,0 +1,19 @@
+/**
+ * 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.
+ */
+
+#import <Foundation/Foundation.h>
+
+#import <WebDriverAgentLib/FBCommandHandler.h>
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface FBSessionCommands : NSObject <FBCommandHandler>
+
+@end
+
+NS_ASSUME_NONNULL_END