@devicelab/maestro-runner-darwin-x64 1.1.25

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Utilities/FBBaseActionsSynthesizer.m

@@ -0,0 +1,165 @@
+/**
+ * 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 "FBBaseActionsSynthesizer.h"
+
+#import "FBErrorBuilder.h"
+#import "FBLogger.h"
+#import "FBMacros.h"
+#import "FBMathUtils.h"
+#import "FBXCElementSnapshotWrapper+Helpers.h"
+#import "XCUIApplication+FBHelpers.h"
+#import "XCUIElement.h"
+#import "XCUIElement+FBIsVisible.h"
+#import "XCUIElement+FBCaching.h"
+#import "XCPointerEventPath.h"
+#import "XCSynthesizedEventRecord.h"
+#import "XCUIElement+FBUtilities.h"
+
+#if !TARGET_OS_TV
+@implementation FBBaseActionItem
+
++ (NSString *)actionName
+{
+  @throw [[FBErrorBuilder.builder withDescription:@"Override this method in subclasses"] build];
+  return nil;
+}
+
+- (NSArray<XCPointerEventPath *> *)addToEventPath:(XCPointerEventPath *)eventPath
+                                         allItems:(NSArray *)allItems
+                                 currentItemIndex:(NSUInteger)currentItemIndex
+                                            error:(NSError **)error
+{
+  @throw [[FBErrorBuilder.builder withDescription:@"Override this method in subclasses"] build];
+  return nil;
+}
+
+@end
+
+@implementation FBBaseGestureItem
+
+- (nullable XCUICoordinate *)hitpointWithElement:(nullable XCUIElement *)element
+                                  positionOffset:(nullable NSValue *)positionOffset
+                                           error:(NSError **)error
+{
+  if (nil == element) {
+    CGVector offset = CGVectorMake(positionOffset.CGPointValue.x, positionOffset.CGPointValue.y);
+    // Only absolute offset is defined
+    return [[self.application coordinateWithNormalizedOffset:CGVectorMake(0, 0)] coordinateWithOffset:offset];
+  }
+
+  // The offset relative to the element is defined
+  if (nil == positionOffset) {
+    if (element.hittable) {
+      // short circuit element hitpoint
+      return element.hitPointCoordinate;
+    }
+    [FBLogger logFmt:@"Will use the frame of '%@' for hit point calculation instead", element.debugDescription];
+  }
+  if (CGRectIsEmpty(element.frame)) {
+    [FBLogger log:self.application.fb_descriptionRepresentation];
+    NSString *description = [NSString stringWithFormat:@"The element '%@' is not visible on the screen and thus is not interactable",
+                             element.description];
+    if (error) {
+      *error = [[FBErrorBuilder.builder withDescription:description] build];
+    }
+    return nil;
+  }
+  if (nil == positionOffset) {
+    return [element coordinateWithNormalizedOffset:CGVectorMake(0.5, 0.5)];
+  }
+
+  CGVector offset = CGVectorMake(positionOffset.CGPointValue.x, positionOffset.CGPointValue.y);
+  // TODO: Shall we throw an exception if hitPoint is out of the element frame?
+  return [[element coordinateWithNormalizedOffset:CGVectorMake(0, 0)] coordinateWithOffset:offset];
+}
+
+@end
+
+
+@implementation FBBaseActionItemsChain
+
+- (instancetype)init
+{
+  self = [super init];
+  if (self) {
+    _items = [NSMutableArray array];
+    _durationOffset = 0.0;
+  }
+  return self;
+}
+
+- (void)addItem:(FBBaseActionItem *)item __attribute__((noreturn))
+{
+  @throw [[FBErrorBuilder.builder withDescription:@"Override this method in subclasses"] build];
+}
+
+- (nullable NSArray<XCPointerEventPath *> *)asEventPathsWithError:(NSError **)error
+{
+  if (0 == self.items.count) {
+    if (error) {
+      *error = [[FBErrorBuilder.builder withDescription:@"Action items list cannot be empty"] build];
+    }
+    return nil;
+  }
+  
+  NSMutableArray<XCPointerEventPath *> *result = [NSMutableArray array];
+  XCPointerEventPath *previousEventPath = nil;
+  XCPointerEventPath *currentEventPath = nil;
+  NSUInteger index = 0;
+  for (FBBaseActionItem *item in self.items.copy) {
+    NSArray<XCPointerEventPath *> *currentEventPaths = [item addToEventPath:currentEventPath
+                                                                   allItems:self.items.copy
+                                                           currentItemIndex:index++
+                                                                      error:error];
+    if (currentEventPaths == nil) {
+      return nil;
+    }
+
+    currentEventPath = currentEventPaths.lastObject;
+    if (nil == currentEventPath) {
+      currentEventPath = previousEventPath;
+    } else if (currentEventPath != previousEventPath) {
+      [result addObjectsFromArray:currentEventPaths];
+      previousEventPath = currentEventPath;
+    }
+  }
+  return result.copy;
+}
+
+@end
+
+
+@implementation FBBaseActionsSynthesizer
+
+- (instancetype)initWithActions:(NSArray *)actions
+                 forApplication:(XCUIApplication *)application
+                   elementCache:(nullable FBElementCache *)elementCache
+                          error:(NSError **)error
+{
+  self = [super init];
+  if (self) {
+    if ((nil == actions || 0 == actions.count) && error) {
+      *error = [[FBErrorBuilder.builder withDescription:@"Actions list cannot be empty"] build];
+      return nil;
+    }
+    _actions = actions;
+    _application = application;
+    _elementCache = elementCache;
+  }
+  return self;
+}
+
+- (nullable XCSynthesizedEventRecord *)synthesizeWithError:(NSError **)error
+{
+  @throw [[FBErrorBuilder.builder withDescription:@"Override synthesizeWithError method in subclasses"] build];
+  return nil;
+}
+
+@end
+#endif

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Utilities/FBCapabilities.h

@@ -0,0 +1,45 @@
+/**
+ * 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>
+
+/** Whether to use alternative elements visivility detection method */
+extern NSString* const FB_CAP_USE_TEST_MANAGER_FOR_VISIBLITY_DETECTION;
+/** Set the maximum amount of characters that could be typed within a minute (60 by default) */
+extern NSString* const FB_CAP_MAX_TYPING_FREQUENCY;
+/** this setting was needed for some legacy stuff */
+extern NSString* const FB_CAP_USE_SINGLETON_TEST_MANAGER;
+/** Whether to disable screneshots that XCTest automaticallly creates after each step */
+extern NSString* const FB_CAP_DISABLE_AUTOMATIC_SCREENSHOTS;
+/** Whether to terminate the application under test after the session ends */
+extern NSString* const FB_CAP_SHOULD_TERMINATE_APP;
+/** The maximum amount of seconds to wait for the event loop to become idle */
+extern NSString* const FB_CAP_EVENT_LOOP_IDLE_DELAY_SEC;
+/** Bundle identifier of the application to run the test for */
+extern NSString* const FB_CAP_BUNDLE_ID;
+/**
+ Usually an URL used as initial link to run Mobile Safari, but could be any other deep link.
+ This might also work together with `FB_CAP_BUNLDE_ID`, which tells XCTest to open
+ the given deep link in the particular app.
+ Only works since iOS 16.4
+ */
+extern NSString* const FB_CAP_INITIAL_URL;
+/** Whether to enforrce (re)start of the application under test on session startup */
+extern NSString* const FB_CAP_FORCE_APP_LAUNCH;
+/** Whether to wait for quiescence before starting interaction with apps laucnhes in scope of the test session */
+extern NSString* const FB_CAP_SHOULD_WAIT_FOR_QUIESCENCE;
+/** Array of command line arguments to be passed to the application under test */
+extern NSString* const FB_CAP_ARGUMENTS;
+/** Dictionary of environment variables to be passed to the application under test */
+extern NSString* const FB_CAP_ENVIRNOMENT;
+/** Whether to use native XCTest caching strategy */
+extern NSString* const FB_CAP_USE_NATIVE_CACHING_STRATEGY;
+/** Whether to enforce software keyboard presence on simulator */
+extern NSString* const FB_CAP_FORCE_SIMULATOR_SOFTWARE_KEYBOARD_PRESENCE;
+/** Sets the application state change timeout for the initial app startup */
+extern NSString* const FB_CAP_APP_LAUNCH_STATE_TIMEOUT_SEC;

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Utilities/FBCapabilities.m

@@ -0,0 +1,25 @@
+/**
+ * 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 "FBCapabilities.h"
+
+NSString* const FB_CAP_USE_TEST_MANAGER_FOR_VISIBLITY_DETECTION = @"shouldUseTestManagerForVisibilityDetection";
+NSString* const FB_CAP_MAX_TYPING_FREQUENCY = @"maxTypingFrequency";
+NSString* const FB_CAP_USE_SINGLETON_TEST_MANAGER = @"shouldUseSingletonTestManager";
+NSString* const FB_CAP_DISABLE_AUTOMATIC_SCREENSHOTS = @"disableAutomaticScreenshots";
+NSString* const FB_CAP_SHOULD_TERMINATE_APP = @"shouldTerminateApp";
+NSString* const FB_CAP_EVENT_LOOP_IDLE_DELAY_SEC = @"eventloopIdleDelaySec";
+NSString* const FB_CAP_BUNDLE_ID = @"bundleId";
+NSString* const FB_CAP_INITIAL_URL = @"initialUrl";
+NSString* const FB_CAP_FORCE_APP_LAUNCH = @"forceAppLaunch";
+NSString* const FB_CAP_SHOULD_WAIT_FOR_QUIESCENCE = @"shouldWaitForQuiescence";
+NSString* const FB_CAP_ARGUMENTS = @"arguments";
+NSString* const FB_CAP_ENVIRNOMENT = @"environment";
+NSString* const FB_CAP_USE_NATIVE_CACHING_STRATEGY = @"useNativeCachingStrategy";
+NSString* const FB_CAP_FORCE_SIMULATOR_SOFTWARE_KEYBOARD_PRESENCE = @"forceSimulatorSoftwareKeyboardPresence";
+NSString* const FB_CAP_APP_LAUNCH_STATE_TIMEOUT_SEC = @"appLaunchStateTimeoutSec";

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Utilities/FBClassChainQueryParser.h

@@ -0,0 +1,99 @@
+/**
+ * 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 <XCTest/XCTest.h>
+
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface FBAbstractPredicateItem : NSObject
+
+/*! The actual predicate value of an item */
+@property (nonatomic, readonly) NSPredicate *value;
+
+/**
+ Instance constructor, which allows to set item value on instance creation
+ 
+ @param value the actual predicate value
+ @return FBAbstractPredicateItem instance
+ */
+- (instancetype)initWithValue:(NSPredicate *)value;
+
+@end
+
+@interface FBSelfPredicateItem : FBAbstractPredicateItem
+
+@end
+
+@interface FBDescendantPredicateItem : FBAbstractPredicateItem
+
+@end
+
+@interface FBClassChainItem : NSObject
+
+/*! Element's position */
+@property (readonly, nonatomic, nullable) NSNumber *position;
+/*! Element's type */
+@property (readonly, nonatomic) XCUIElementType type;
+/*! Whether an element is a descendant of the previos element */
+@property (readonly, nonatomic) BOOL isDescendant;
+/*! The ordered list of matching predicates for the current element */
+@property (readonly, nonatomic) NSArray<FBAbstractPredicateItem *> *predicates;
+
+/**
+ Instance constructor, which allows to set element type and position
+ 
+ @param type on of supoported element types declared in XCUIElementType enum
+ @param position element position relative to its sibling element. Numeration
+   starts with 1. Zero value means that all sibling element should be selected.
+   Negative value means that numeration starts from the last element, for example
+   -1 is the last child element and -2 is the second last element.
+   nil value means that no element position has been set explicitly.
+ @param predicates the list of matching descendant/self predicates
+ @param isDescendant equals to YES if the element is a descendantt element of
+   the previous element in the chain. NO value means the element is the direct
+   child of the previous element
+ @return FBClassChainElement instance
+ */
+- (instancetype)initWithType:(XCUIElementType)type position:(nullable NSNumber *)position predicates:(NSArray<FBAbstractPredicateItem *> *)predicates isDescendant:(BOOL)isDescendant;
+
+@end
+
+@interface FBClassChain : NSObject
+
+/*! Array of parsed chain items */
+@property (readonly, nonatomic, copy) NSArray<FBClassChainItem *> *elements;
+
+/**
+ Instance constructor for parsed class chain instance
+ 
+ @param elements an array of parsed chains elements
+ @return FBClassChain instance
+ */
+- (instancetype)initWithElements:(NSArray<FBClassChainItem *> *)elements;
+
+@end
+
+@interface FBClassChainQueryParser : NSObject
+
+/**
+ Method used to interpret class chain queries
+ 
+ @param classChainQuery class chain query as string. See the documentation of
+   XCUIElement+FBClassChain category for more details about the expected query format
+ @param error standard NSError object, which is going to be initializaed if
+   there are query parsing errors
+ @return list of parsed primitives packed to FBClassChainElement class or nil in case
+   there was parsing error (the parameter will be initialized with detailed error description in such case)
+ @throws FBUnknownAttributeException if any of predicates in the chain contains unknown attribute 
+ */
++ (nullable FBClassChain*)parseQuery:(NSString*)classChainQuery error:(NSError **)error;
+
+@end
+
+NS_ASSUME_NONNULL_END