@devicelab/maestro-runner-darwin-x64 1.1.25

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Categories/XCUIApplication+FBTouchAction.h

@@ -0,0 +1,29 @@
+/**
+ * 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>
+#import "FBElementCache.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface XCUIApplication (FBTouchAction)
+
+/**
+ Perform complex touch action in scope of the current application.
+ 
+ @param actions Array of dictionaries, whose format is described in W3C spec (https://github.com/jlipps/simple-wd-spec#perform-actions)
+ @param elementCache Cached elements mapping for the currrent application. The method assumes all elements are already represented by their actual instances if nil value is set
+ @param error If there is an error, upon return contains an NSError object that describes the problem
+ @return YES If the touch action has been successfully performed without errors
+ */
+- (BOOL)fb_performW3CActions:(NSArray *)actions elementCache:(nullable FBElementCache *)elementCache error:(NSError * _Nullable*)error;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Categories/XCUIApplication+FBTouchAction.m

@@ -0,0 +1,75 @@
+/**
+ * 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 "XCUIApplication+FBTouchAction.h"
+
+#import "FBBaseActionsSynthesizer.h"
+#import "FBConfiguration.h"
+#import "FBExceptions.h"
+#import "FBLogger.h"
+#import "FBRunLoopSpinner.h"
+#import "FBW3CActionsSynthesizer.h"
+#import "FBXCTestDaemonsProxy.h"
+#import "XCEventGenerator.h"
+#import "XCUIElement+FBUtilities.h"
+
+#if !TARGET_OS_TV
+
+@implementation XCUIApplication (FBTouchAction)
+
++ (BOOL)handleEventSynthesWithError:(NSError *)error
+{
+  if ([error.localizedDescription containsString:@"not visible"]) {
+    [[NSException exceptionWithName:FBElementNotVisibleException
+                             reason:error.localizedDescription
+                           userInfo:error.userInfo] raise];
+  }
+  return NO;
+}
+
+- (BOOL)fb_performActionsWithSynthesizerType:(Class)synthesizerType
+                                     actions:(NSArray *)actions
+                                elementCache:(FBElementCache *)elementCache
+                                       error:(NSError **)error
+{
+  FBBaseActionsSynthesizer *synthesizer = [[synthesizerType alloc] initWithActions:actions
+                                                                    forApplication:self
+                                                                      elementCache:elementCache
+                                                                             error:error];
+  if (nil == synthesizer) {
+    return NO;
+  }
+  XCSynthesizedEventRecord *eventRecord = [synthesizer synthesizeWithError:error];
+  if (nil == eventRecord) {
+    return [self.class handleEventSynthesWithError:*error];
+  }
+  return [self fb_synthesizeEvent:eventRecord error:error];
+}
+
+- (BOOL)fb_performW3CActions:(NSArray *)actions
+                elementCache:(FBElementCache *)elementCache
+                       error:(NSError **)error
+{
+  if (![self fb_performActionsWithSynthesizerType:FBW3CActionsSynthesizer.class
+                                          actions:actions
+                                     elementCache:elementCache
+                                            error:error]) {
+    return NO;
+  }
+  [self fb_waitUntilStableWithTimeout:FBConfiguration.animationCoolOffTimeout];
+  return YES;
+}
+
+- (BOOL)fb_synthesizeEvent:(XCSynthesizedEventRecord *)event error:(NSError *__autoreleasing*)error
+{
+  return [FBXCTestDaemonsProxy synthesizeEventWithRecord:event error:error];
+}
+
+@end
+#endif

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Categories/XCUIApplication+FBUIInterruptions.h

@@ -0,0 +1,22 @@
+/**
+ * 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 XCUIApplication (FBUIInterruptions)
+
+/**
+ * Disables automatic UI interruptions handling for all applications.
+ */
++ (void)fb_disableUIInterruptionsHandling;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Categories/XCUIApplication+FBUIInterruptions.m

@@ -0,0 +1,31 @@
+/**
+ * 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 "XCUIApplication+FBUIInterruptions.h"
+
+#import "FBReflectionUtils.h"
+#import "XCUIApplication.h"
+
+@implementation XCUIApplication (FBUIInterruptions)
+
+- (BOOL)fb_doesNotHandleUIInterruptions
+{
+  return YES;
+}
+
++ (void)fb_disableUIInterruptionsHandling
+{
+  static dispatch_once_t onceToken;
+  dispatch_once(&onceToken, ^{
+    FBReplaceMethod([self class],
+                    @selector(doesNotHandleUIInterruptions),
+                    @selector(fb_doesNotHandleUIInterruptions));
+  });
+}
+
+@end

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Categories/XCUIApplicationProcess+FBQuiescence.h

@@ -0,0 +1,27 @@
+/**
+ * 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>
+
+#import "XCUIApplicationProcess.h"
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface XCUIApplicationProcess (FBQuiescence)
+
+/*! Defines wtether the process should perform quiescence checks. YES by default */
+@property (nonatomic) NSNumber* fb_shouldWaitForQuiescence;
+
+/**
+ @param waitForAnimations Set it to YES if XCTest should also wait for application animations to complete
+ */
+- (void)fb_waitForQuiescenceIncludingAnimationsIdle:(bool)waitForAnimations;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Categories/XCUIApplicationProcess+FBQuiescence.m

@@ -0,0 +1,118 @@
+/**
+ * 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 "XCUIApplicationProcess+FBQuiescence.h"
+
+#import <objc/runtime.h>
+
+#import "FBConfiguration.h"
+#import "FBExceptions.h"
+#import "FBLogger.h"
+#import "FBSettings.h"
+
+static void (*original_waitForQuiescenceIncludingAnimationsIdle)(id, SEL, BOOL);
+static void (*original_waitForQuiescenceIncludingAnimationsIdlePreEvent)(id, SEL, BOOL, BOOL);
+
+static void swizzledWaitForQuiescenceIncludingAnimationsIdle(id self, SEL _cmd, BOOL includingAnimations)
+{
+  NSString *bundleId = [self bundleID];
+  if (![[self fb_shouldWaitForQuiescence] boolValue] || FBConfiguration.waitForIdleTimeout < DBL_EPSILON) {
+    [FBLogger logFmt:@"Quiescence checks are disabled for %@ application. Making it to believe it is idling",
+     bundleId];
+    return;
+  }
+
+  NSTimeInterval desiredTimeout = FBConfiguration.waitForIdleTimeout;
+  NSTimeInterval previousTimeout = _XCTApplicationStateTimeout();
+  _XCTSetApplicationStateTimeout(desiredTimeout);
+  [FBLogger logFmt:@"Waiting up to %@s until %@ is in idle state (%@ animations)",
+   @(desiredTimeout), bundleId, includingAnimations ? @"including" : @"excluding"];
+  @try {
+    original_waitForQuiescenceIncludingAnimationsIdle(self, _cmd, includingAnimations);
+  } @finally {
+    _XCTSetApplicationStateTimeout(previousTimeout);
+  }
+}
+
+static void swizzledWaitForQuiescenceIncludingAnimationsIdlePreEvent(id self, SEL _cmd, BOOL includingAnimations, BOOL isPreEvent)
+{
+  NSString *bundleId = [self bundleID];
+  if (![[self fb_shouldWaitForQuiescence] boolValue] || FBConfiguration.waitForIdleTimeout < DBL_EPSILON) {
+    [FBLogger logFmt:@"Quiescence checks are disabled for %@ application. Making it to believe it is idling",
+     bundleId];
+    return;
+  }
+
+  NSTimeInterval desiredTimeout = FBConfiguration.waitForIdleTimeout;
+  NSTimeInterval previousTimeout = _XCTApplicationStateTimeout();
+  _XCTSetApplicationStateTimeout(desiredTimeout);
+  [FBLogger logFmt:@"Waiting up to %@s until %@ is in idle state (%@ animations)",
+   @(desiredTimeout), bundleId, includingAnimations ? @"including" : @"excluding"];
+  @try {
+    original_waitForQuiescenceIncludingAnimationsIdlePreEvent(self, _cmd, includingAnimations, isPreEvent);
+  } @finally {
+    _XCTSetApplicationStateTimeout(previousTimeout);
+  }
+}
+
+@implementation XCUIApplicationProcess (FBQuiescence)
+
+#pragma clang diagnostic push
+#pragma clang diagnostic ignored "-Wobjc-load-method"
+#pragma clang diagnostic ignored "-Wcast-function-type-strict"
+
++ (void)load
+{
+  Method waitForQuiescenceIncludingAnimationsIdleMethod = class_getInstanceMethod(self.class, @selector(waitForQuiescenceIncludingAnimationsIdle:));
+  Method waitForQuiescenceIncludingAnimationsIdlePreEventMethod = class_getInstanceMethod(self.class, @selector(waitForQuiescenceIncludingAnimationsIdle:isPreEvent:));
+  if (nil != waitForQuiescenceIncludingAnimationsIdleMethod) {
+    IMP swizzledImp = (IMP)swizzledWaitForQuiescenceIncludingAnimationsIdle;
+    original_waitForQuiescenceIncludingAnimationsIdle = (void (*)(id, SEL, BOOL)) method_setImplementation(waitForQuiescenceIncludingAnimationsIdleMethod, swizzledImp);
+  } else if (nil != waitForQuiescenceIncludingAnimationsIdlePreEventMethod) {
+    IMP swizzledImp = (IMP)swizzledWaitForQuiescenceIncludingAnimationsIdlePreEvent;
+    original_waitForQuiescenceIncludingAnimationsIdlePreEvent = (void (*)(id, SEL, BOOL, BOOL)) method_setImplementation(waitForQuiescenceIncludingAnimationsIdlePreEventMethod, swizzledImp);
+  } else {
+    [FBLogger log:@"Could not find method -[XCUIApplicationProcess waitForQuiescenceIncludingAnimationsIdle:]"];
+  }
+}
+
+#pragma clang diagnostic pop
+
+static char XCUIAPPLICATIONPROCESS_SHOULD_WAIT_FOR_QUIESCENCE;
+
+@dynamic fb_shouldWaitForQuiescence;
+
+- (NSNumber *)fb_shouldWaitForQuiescence
+{
+  id result = objc_getAssociatedObject(self, &XCUIAPPLICATIONPROCESS_SHOULD_WAIT_FOR_QUIESCENCE);
+  if (nil == result) {
+    return @(YES);
+  }
+  return (NSNumber *)result;
+}
+
+- (void)setFb_shouldWaitForQuiescence:(NSNumber *)value
+{
+  objc_setAssociatedObject(self, &XCUIAPPLICATIONPROCESS_SHOULD_WAIT_FOR_QUIESCENCE, value, OBJC_ASSOCIATION_RETAIN_NONATOMIC);
+}
+
+- (void)fb_waitForQuiescenceIncludingAnimationsIdle:(bool)waitForAnimations
+{
+  if ([self respondsToSelector:@selector(waitForQuiescenceIncludingAnimationsIdle:)]) {
+    [self waitForQuiescenceIncludingAnimationsIdle:waitForAnimations];
+  } else if ([self respondsToSelector:@selector(waitForQuiescenceIncludingAnimationsIdle:isPreEvent:)]) {
+    [self waitForQuiescenceIncludingAnimationsIdle:waitForAnimations isPreEvent:NO];
+  } else {
+    @throw [NSException exceptionWithName:FBIncompatibleWdaException
+                                   reason:@"The current WebDriverAgent build is not compatible to your device OS version"
+                                 userInfo:@{}];
+  }
+}
+
+
+@end

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Categories/XCUIDevice+FBHealthCheck.h

@@ -0,0 +1,30 @@
+/**
+ * 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 XCUIDevice (FBHealthCheck)
+
+/**
+ Checks health of XCTest by:
+ 1) Querying application for some elements,
+ 2) Triggering some device events.
+
+ !!! Health check might modify simulator state so it should only be called in-between testing sessions
+
+ @param application application used to issue queries
+ @return YES if the operation succeeds, otherwise NO.
+ */
+- (BOOL)fb_healthCheckWithApplication:(nullable XCUIApplication *)application;
+
+@end
+
+NS_ASSUME_NONNULL_END

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Categories/XCUIDevice+FBHealthCheck.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.
+ */
+
+#import "XCUIDevice+FBHealthCheck.h"
+
+#import "XCUIDevice+FBRotation.h"
+#import "XCUIApplication+FBHelpers.h"
+
+@implementation XCUIDevice (FBHealthCheck)
+
+- (BOOL)fb_healthCheckWithApplication:(nullable XCUIApplication *)application
+{
+  if (![self fb_elementQueryCheckWithApplication:application]) {
+    return NO;
+  }
+  if (![self fb_deviceInteractionCheck]) {
+    return NO;
+  }
+  return YES;
+}
+
+- (BOOL)fb_elementQueryCheckWithApplication:(nullable XCUIApplication *)application
+{
+  if (!application) {
+    return NO;
+  }
+  if (!application.label) {
+    return NO;
+  }
+  if ([application descendantsMatchingType:XCUIElementTypeAny].count == 0 ) {
+    return NO;
+  }
+  return YES;
+}
+
+- (BOOL)fb_deviceInteractionCheck
+{
+  [self pressButton:XCUIDeviceButtonHome];
+  return YES;
+}
+
+@end

package/drivers/ios/WebDriverAgent/WebDriverAgentLib/Categories/XCUIDevice+FBHelpers.h

@@ -0,0 +1,193 @@
+/**
+ * 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>
+
+#if !TARGET_OS_TV
+#import <CoreLocation/CoreLocation.h>
+#endif
+
+NS_ASSUME_NONNULL_BEGIN
+
+typedef NS_ENUM(NSUInteger, FBUIInterfaceAppearance) {
+  FBUIInterfaceAppearanceUnspecified,
+  FBUIInterfaceAppearanceLight,
+  FBUIInterfaceAppearanceDark
+};
+
+@interface XCUIDevice (FBHelpers)
+
+/**
+ Matches or mismatches TouchID request
+
+ @param shouldMatch determines if TouchID should be matched
+ @return YES if the operation succeeds, otherwise NO.
+ */
+- (BOOL)fb_fingerTouchShouldMatch:(BOOL)shouldMatch;
+
+/**
+ Forces the device under test to switch to the home screen
+
+ @param error If there is an error, upon return contains an NSError object that describes the problem.
+ @return YES if the operation succeeds, otherwise NO.
+ */
+- (BOOL)fb_goToHomescreenWithError:(NSError **)error;
+
+/**
+ Checks if the screen is locked or not.
+ 
+ @return YES if screen is locked
+ */
+- (BOOL)fb_isScreenLocked;
+
+/**
+ Forces the device under test to switch to the lock screen. An immediate return will happen if the device is already locked and an error is going to be thrown if the screen has not been locked after the timeout.
+ 
+ @param error If there is an error, upon return contains an NSError object that describes the problem.
+ @return YES if the operation succeeds, otherwise NO.
+ */
+- (BOOL)fb_lockScreen:(NSError **)error;
+
+/**
+ Forces the device under test to unlock. An immediate return will happen if the device is already unlocked and an error is going to be thrown if the screen has not been unlocked after the timeout.
+ 
+ @param error If there is an error, upon return contains an NSError object that describes the problem.
+ @return YES if the operation succeeds, otherwise NO.
+ */
+- (BOOL)fb_unlockScreen:(NSError **)error;
+
+/**
+ Returns screenshot
+ @param error If there is an error, upon return contains an NSError object that describes the problem.
+ @return Device screenshot as PNG-encoded data or nil in case of failure
+ */
+- (nullable NSData *)fb_screenshotWithError:(NSError*__autoreleasing*)error;
+
+/**
+ Returns device's current wifi ip4 address
+ */
+- (nullable NSString *)fb_wifiIPAddress;
+
+/**
+ Opens the particular url scheme using the default application assigned to it.
+ This API only works since XCode 14.3/iOS 16.4
+ Older Xcode/iOS version try to use Siri fallback.
+ 
+ @param url The url scheme represented as a string, for example https://apple.com
+ @param error If there is an error, upon return contains an NSError object that describes the problem.
+ @return YES if the operation was successful
+ */
+- (BOOL)fb_openUrl:(NSString *)url error:(NSError **)error;
+
+/**
+ Opens the particular url scheme using the given application
+ This API only works since XCode 14.3/iOS 16.4
+
+ @param url The url scheme represented as a string, for example https://apple.com
+ @param bundleId The bundle identifier of an application to use in order to open the given URL
+ @param error If there is an error, upon return contains an NSError object that describes the problem.
+ @return YES if the operation was successful
+ */
+- (BOOL)fb_openUrl:(NSString *)url withApplication:(NSString *)bundleId error:(NSError **)error;
+
+/**
+ Presses the corresponding hardware button on the device with duration.
+
+ @param buttonName One of the supported button names: volumeUp (real devices only), volumeDown (real device only), home
+ @param duration Duration in seconds or nil.
+                This argument works only on tvOS. When this argument is nil on tvOS,
+                https://developer.apple.com/documentation/xctest/xcuiremote/1627476-pressbutton will be called.
+                Others are https://developer.apple.com/documentation/xctest/xcuiremote/1627475-pressbutton.
+                A single tap when this argument is `nil` is equal to when the duration is 0.005 seconds in XCTest.
+                On iOS, this value will be ignored. It always calls https://developer.apple.com/documentation/xctest/xcuidevice/1619052-pressbutton
+ @return YES if the button has been pressed
+ */
+- (BOOL)fb_pressButton:(NSString *)buttonName forDuration:(nullable NSNumber *)duration error:(NSError **)error;
+
+
+/**
+ Activates Siri service voice recognition with the given text to parse
+
+ @param text The actual string to parse
+ @param error If there is an error, upon return contains an NSError object that describes the problem.
+ @return YES the command has been successfully executed by Siri voice recognition service
+ */
+- (BOOL)fb_activateSiriVoiceRecognitionWithText:(NSString *)text error:(NSError **)error;
+
+/**
+ Emulated triggering of the given low-level IOHID device event. The constants for possible events are defined
+ in https://unix.superglobalmegacorp.com/xnu/newsrc/iokit/IOKit/hidsystem/IOHIDUsageTables.h.html
+ Popular constants:
+ - kHIDPage_Consumer = 0x0C
+ - kHIDUsage_Csmr_VolumeIncrement  = 0xE9 (Volume Up)
+ - kHIDUsage_Csmr_VolumeDecrement  = 0xEA (Volume Down)
+ - kHIDUsage_Csmr_Menu = 0x40 (Home)
+ - kHIDUsage_Csmr_Power  = 0x30 (Power)
+ - kHIDUsage_Csmr_Snapshot  = 0x65 (Power + Home)
+
+ @param page The event page identifier
+ @param usage The event usage identifier (usages are defined per-page)
+ @param duration The event duration in float seconds (XCTest uses 0.005 for a single press event)
+ @param error If there is an error, upon return contains an NSError object that describes the problem.
+ @return YES the event has successfully been triggered
+ */
+- (BOOL)fb_performIOHIDEventWithPage:(unsigned int)page
+                               usage:(unsigned int)usage
+                            duration:(NSTimeInterval)duration
+                               error:(NSError **)error;
+
+/**
+ Allows to set device appearance
+
+ @param appearance The desired appearance value
+ @param error If there is an error, upon return contains an NSError object that describes the problem.
+ @return YES if the appearance has been successfully set
+ */
+- (BOOL)fb_setAppearance:(FBUIInterfaceAppearance)appearance error:(NSError **)error;
+
+/**
+ Get current appearance prefefence.
+
+ @return 0 (automatic), 1 (light) or 2 (dark), or nil
+ */
+- (nullable NSNumber *)fb_getAppearance;
+
+#if !TARGET_OS_TV
+/**
+ Allows to set a simulated geolocation coordinates.
+ Only works since Xcode 14.3/iOS 16.4
+
+ @param location The simlated location coordinates to set
+ @param error If there is an error, upon return contains an NSError object that describes the problem.
+ @return YES if the simulated location has been successfully set
+ */
+- (BOOL)fb_setSimulatedLocation:(CLLocation *)location error:(NSError **)error;
+
+/**
+ Allows to get a simulated geolocation coordinates.
+ Only works since Xcode 14.3/iOS 16.4
+
+ @param error If there is an error, upon return contains an NSError object that describes the problem.
+ @return The current simulated location or nil in case of failure or if no location has previously been seet
+ (the returned error will be nil in the latter case)
+ */
+- (nullable CLLocation *)fb_getSimulatedLocation:(NSError **)error;
+
+/**
+ Allows to clear a previosuly set simulated geolocation coordinates.
+ Only works since Xcode 14.3/iOS 16.4
+
+ @param error If there is an error, upon return contains an NSError object that describes the problem.
+ @return YES if the simulated location has been successfully cleared
+ */
+- (BOOL)fb_clearSimulatedLocation:(NSError **)error;
+#endif
+
+@end
+
+NS_ASSUME_NONNULL_END