appium-webdriveragent 5.15.7 → 5.15.9

package/WebDriverAgentLib/FBApplication.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. An additional grant
+ * of patent rights can be found in the PATENTS file in the same directory.
+ */
+
+#import "FBApplication.h"
+
+#import "FBXCAccessibilityElement.h"
+#import "FBLogger.h"
+#import "FBExceptions.h"
+#import "FBRunLoopSpinner.h"
+#import "FBMacros.h"
+#import "FBActiveAppDetectionPoint.h"
+#import "FBXCodeCompatibility.h"
+#import "FBXCTestDaemonsProxy.h"
+#import "XCUIApplication.h"
+#import "XCUIApplication+FBHelpers.h"
+#import "XCUIApplicationImpl.h"
+#import "XCUIApplicationProcess.h"
+#import "XCUIElement.h"
+#import "XCUIElementQuery.h"
+#import "FBXCAXClientProxy.h"
+
+
+static const NSTimeInterval APP_STATE_CHANGE_TIMEOUT = 5.0;
+
+@interface FBApplication ()
+@end
+
+@implementation FBApplication
+
++ (instancetype)fb_activeApplication
+{
+  return [self fb_activeApplicationWithDefaultBundleId:nil];
+}
+
++ (NSArray<FBApplication *> *)fb_activeApplications
+{
+  NSArray<id<FBXCAccessibilityElement>> *activeApplicationElements = [FBXCAXClientProxy.sharedClient activeApplications];
+  NSMutableArray<FBApplication *> *result = [NSMutableArray array];
+  if (activeApplicationElements.count > 0) {
+    for (id<FBXCAccessibilityElement> applicationElement in activeApplicationElements) {
+      FBApplication *app = [FBApplication fb_applicationWithPID:applicationElement.processIdentifier];
+      if (nil != app) {
+        [result addObject:app];
+      }
+    }
+  }
+  return result.count > 0 ? result.copy : @[self.class.fb_systemApplication];
+}
+
++ (instancetype)fb_activeApplicationWithDefaultBundleId:(nullable NSString *)bundleId
+{
+  NSArray<id<FBXCAccessibilityElement>> *activeApplicationElements = [FBXCAXClientProxy.sharedClient activeApplications];
+  id<FBXCAccessibilityElement> activeApplicationElement = nil;
+  id<FBXCAccessibilityElement> currentElement = nil;
+  if (nil != bundleId) {
+    currentElement = FBActiveAppDetectionPoint.sharedInstance.axElement;
+    if (nil != currentElement) {
+      NSArray<NSDictionary *> *appInfos = [self fb_appsInfoWithAxElements:@[currentElement]];
+      [FBLogger logFmt:@"Detected on-screen application: %@", appInfos.firstObject[@"bundleId"]];
+      if ([[appInfos.firstObject objectForKey:@"bundleId"] isEqualToString:(id)bundleId]) {
+        activeApplicationElement = currentElement;
+      }
+    }
+  }
+  if (nil == activeApplicationElement && activeApplicationElements.count > 1) {
+    if (nil != bundleId) {
+      NSArray<NSDictionary *> *appInfos = [self fb_appsInfoWithAxElements:activeApplicationElements];
+      NSMutableArray<NSString *> *bundleIds = [NSMutableArray array];
+      for (NSDictionary *appInfo in appInfos) {
+        [bundleIds addObject:(NSString *)appInfo[@"bundleId"]];
+      }
+      [FBLogger logFmt:@"Detected system active application(s): %@", bundleIds];
+      // Try to select the desired application first
+      for (NSUInteger appIdx = 0; appIdx < appInfos.count; appIdx++) {
+        if ([[[appInfos objectAtIndex:appIdx] objectForKey:@"bundleId"] isEqualToString:(id)bundleId]) {
+          activeApplicationElement = [activeApplicationElements objectAtIndex:appIdx];
+          break;
+        }
+      }
+    }
+    // Fall back to the "normal" algorithm if the desired application is either
+    // not set or is not active
+    if (nil == activeApplicationElement) {
+      if (nil == currentElement) {
+        currentElement = FBActiveAppDetectionPoint.sharedInstance.axElement;
+      }
+      if (nil == currentElement) {
+        [FBLogger log:@"Cannot precisely detect the current application. Will use the system's recently active one"];
+        if (nil == bundleId) {
+          [FBLogger log:@"Consider changing the 'defaultActiveApplication' setting to the bundle identifier of the desired application under test"];
+        }
+      } else {
+        for (id<FBXCAccessibilityElement> appElement in activeApplicationElements) {
+          if (appElement.processIdentifier == currentElement.processIdentifier) {
+            activeApplicationElement = appElement;
+            break;
+          }
+        }
+      }
+    }
+  }
+
+  if (nil != activeApplicationElement) {
+    FBApplication *application = [FBApplication fb_applicationWithPID:activeApplicationElement.processIdentifier];
+    if (nil != application) {
+      return application;
+    }
+    [FBLogger log:@"Cannot translate the active process identifier into an application object"];
+  }
+
+  if (activeApplicationElements.count > 0) {
+    [FBLogger logFmt:@"Getting the most recent active application (out of %@ total items)", @(activeApplicationElements.count)];
+    for (id<FBXCAccessibilityElement> appElement in activeApplicationElements) {
+      FBApplication *application = [FBApplication fb_applicationWithPID:appElement.processIdentifier];
+      if (nil != application) {
+        return application;
+      }
+    }
+  }
+
+  [FBLogger log:@"Cannot retrieve any active applications. Assuming the system application is the active one"];
+  return [self fb_systemApplication];
+}
+
++ (instancetype)fb_systemApplication
+{
+  return [self fb_applicationWithPID:
+   [[FBXCAXClientProxy.sharedClient systemApplication] processIdentifier]];
+}
+
++ (instancetype)applicationWithPID:(pid_t)processID
+{
+  if ([NSProcessInfo processInfo].processIdentifier == processID) {
+    return nil;
+  }
+  return (FBApplication *)[FBXCAXClientProxy.sharedClient monitoredApplicationWithProcessIdentifier:processID];
+}
+
+- (void)launch
+{
+  [super launch];
+  if (![self fb_waitForAppElement:APP_STATE_CHANGE_TIMEOUT]) {
+    [FBLogger logFmt:@"The application '%@' is not running in foreground after %.2f seconds", self.bundleID, APP_STATE_CHANGE_TIMEOUT];
+  }
+}
+
+- (void)terminate
+{
+  [super terminate];
+  if (![self waitForState:XCUIApplicationStateNotRunning timeout:APP_STATE_CHANGE_TIMEOUT]) {
+    [FBLogger logFmt:@"The active application is still '%@' after %.2f seconds timeout", self.bundleID, APP_STATE_CHANGE_TIMEOUT];
+  }
+}
+
++ (BOOL)fb_switchToSystemApplicationWithError:(NSError **)error
+{
+  FBApplication *systemApp = self.fb_systemApplication;
+  @try {
+    if ([systemApp fb_state] < 2) {
+      [systemApp launch];
+    } else {
+      [systemApp fb_activate];
+    }
+  } @catch (NSException *e) {
+    return [[[FBErrorBuilder alloc]
+             withDescription:nil == e ? @"Cannot open the home screen" : e.reason]
+            buildError:error];
+  }
+  return [[[[FBRunLoopSpinner new]
+            timeout:5]
+           timeoutErrorMessage:@"Timeout waiting until the home screen is visible"]
+          spinUntilTrue:^BOOL{
+    FBApplication *activeApp = self.fb_activeApplication;
+    return nil != activeApp && [activeApp.bundleID isEqualToString:systemApp.bundleID];
+  }
+          error:error];
+}
+
+@end

package/WebDriverAgentLib/Routing/FBSession.h

@@ -9,8 +9,8 @@
 
 #import <Foundation/Foundation.h>
 
+@class FBApplication;
 @class FBElementCache;
-@class XCUIApplication;
 
 NS_ASSUME_NONNULL_BEGIN
 
@@ -20,16 +20,16 @@ NS_ASSUME_NONNULL_BEGIN
 @interface FBSession : NSObject
 
 /*! Application tested during that session */
-@property (nonatomic, readonly) XCUIApplication *activeApplication;
+@property (nonatomic, strong, readonly) FBApplication *activeApplication;
 
 /*! Session's identifier */
-@property (nonatomic, readonly) NSString *identifier;
+@property (nonatomic, copy, readonly) NSString *identifier;
 
 /*! Element cache related to that session */
-@property (nonatomic, readonly) FBElementCache *elementCache;
+@property (nonatomic, strong, readonly) FBElementCache *elementCache;
 
 /*! The identifier of the active application */
-@property (nonatomic) NSString *defaultActiveApplication;
+@property (nonatomic, copy) NSString *defaultActiveApplication;
 
 /*! The action to apply to unexpected alerts. Either "accept"/"dismiss" or nil/empty string (by default) to do nothing */
 @property (nonatomic, nullable) NSString *defaultAlertAction;
@@ -57,7 +57,7 @@ NS_ASSUME_NONNULL_BEGIN
  @param application The application that we want to create session for
  @return new session
  */
-+ (instancetype)initWithApplication:(nullable XCUIApplication *)application;
++ (instancetype)initWithApplication:(nullable FBApplication *)application;
 
 /**
  Creates and saves new session for application with default alert handling behaviour
@@ -66,8 +66,7 @@ NS_ASSUME_NONNULL_BEGIN
  @param defaultAlertAction The default reaction to on-screen alert. Either 'accept' or 'dismiss'
  @return new session
  */
-+ (instancetype)initWithApplication:(nullable XCUIApplication *)application
-                 defaultAlertAction:(NSString *)defaultAlertAction;
++ (instancetype)initWithApplication:(nullable FBApplication *)application defaultAlertAction:(NSString *)defaultAlertAction;
 
 /**
  Kills application associated with that session and removes session
@@ -83,11 +82,12 @@ NS_ASSUME_NONNULL_BEGIN
  @param arguments The optional array of application command line arguments. The arguments are going to be applied if the application was not running before.
  @param environment The optional dictionary of environment variables for the application, which is going to be executed. The environment variables are going to be applied if the application was not running before.
  @return The application instance
+ @throws FBApplicationMethodNotSupportedException if the method is not supported with the current XCTest SDK
  */
-- (XCUIApplication *)launchApplicationWithBundleId:(NSString *)bundleIdentifier
-                           shouldWaitForQuiescence:(nullable NSNumber *)shouldWaitForQuiescence
-                                         arguments:(nullable NSArray<NSString *> *)arguments
-                                       environment:(nullable NSDictionary <NSString *, NSString *> *)environment;
+- (FBApplication *)launchApplicationWithBundleId:(NSString *)bundleIdentifier
+                         shouldWaitForQuiescence:(nullable NSNumber *)shouldWaitForQuiescence
+                                       arguments:(nullable NSArray<NSString *> *)arguments
+                                     environment:(nullable NSDictionary <NSString *, NSString *> *)environment;
 
 /**
  Activate an application with given bundle identifier in scope of current session.
@@ -95,8 +95,9 @@ NS_ASSUME_NONNULL_BEGIN
 
  @param bundleIdentifier Valid bundle identifier of the application to be activated
  @return The application instance
+ @throws FBApplicationMethodNotSupportedException if the method is not supported with the current XCTest SDK
  */
-- (XCUIApplication *)activateApplicationWithBundleId:(NSString *)bundleIdentifier;
+- (FBApplication *)activateApplicationWithBundleId:(NSString *)bundleIdentifier;
 
 /**
  Terminate an application with the given bundle id. The application should be previously

package/WebDriverAgentLib/Routing/FBSession.m

@@ -14,6 +14,7 @@
 
 #import "FBXCAccessibilityElement.h"
 #import "FBAlertsMonitor.h"
+#import "FBApplication.h"
 #import "FBConfiguration.h"
 #import "FBElementCache.h"
 #import "FBExceptions.h"
@@ -30,7 +31,7 @@
 NSString *const FBDefaultApplicationAuto = @"auto";
 
 @interface FBSession ()
-@property (nullable, nonatomic) XCUIApplication *testedApplication;
+@property (nonatomic) NSString *testedApplicationBundleId;
 @property (nonatomic) BOOL isTestedApplicationExpectedToRun;
 @property (nonatomic) BOOL shouldAppsWaitForQuiescence;
 @property (nonatomic, nullable) FBAlertsMonitor *alertsMonitor;
@@ -95,7 +96,7 @@ static FBSession *_activeSession = nil;
   return _activeSession;
 }
 
-+ (instancetype)initWithApplication:(XCUIApplication *)application
++ (instancetype)initWithApplication:(FBApplication *)application
 {
   FBSession *session = [FBSession new];
   session.useNativeCachingStrategy = YES;
@@ -104,10 +105,10 @@ static FBSession *_activeSession = nil;
   session.elementsVisibilityCache = [NSMutableDictionary dictionary];
   session.identifier = [[NSUUID UUID] UUIDString];
   session.defaultActiveApplication = FBDefaultApplicationAuto;
-  session.testedApplication = nil;
+  session.testedApplicationBundleId = nil;
   session.isTestedApplicationExpectedToRun = nil != application && application.running;
   if (application) {
-    session.testedApplication = application;
+    session.testedApplicationBundleId = application.bundleID;
     session.shouldAppsWaitForQuiescence = application.fb_shouldWaitForQuiescence;
   }
   session.elementCache = [FBElementCache new];
@@ -115,7 +116,7 @@ static FBSession *_activeSession = nil;
   return session;
 }
 
-+ (instancetype)initWithApplication:(nullable XCUIApplication *)application
++ (instancetype)initWithApplication:(nullable FBApplication *)application
                  defaultAlertAction:(NSString *)defaultAlertAction
 {
   FBSession *session = [self.class initWithApplication:application];
@@ -137,78 +138,81 @@ static FBSession *_activeSession = nil;
     self.alertsMonitor = nil;
   }
 
-  if (nil != self.testedApplication
-      && FBConfiguration.shouldTerminateApp
-      && self.testedApplication.running
-      && ![self.testedApplication fb_isSameAppAs:XCUIApplication.fb_systemApplication]) {
-    @try {
-      [self.testedApplication terminate];
-    } @catch (NSException *e) {
-      [FBLogger logFmt:@"%@", e.description];
+  if (self.testedApplicationBundleId && [FBConfiguration shouldTerminateApp]
+      && ![self.testedApplicationBundleId isEqualToString:FBApplication.fb_systemApplication.bundleID]) {
+    FBApplication *app = [[FBApplication alloc] initWithBundleIdentifier:self.testedApplicationBundleId];
+    if ([app running]) {
+      @try {
+        [app terminate];
+      } @catch (NSException *e) {
+        [FBLogger logFmt:@"%@", e.description];
+      }
     }
   }
 
   _activeSession = nil;
 }
 
-- (XCUIApplication *)activeApplication
+- (FBApplication *)activeApplication
 {
-  if (nil != self.testedApplication) {
-    XCUIApplicationState testedAppState = self.testedApplication.state;
-    if (testedAppState >= XCUIApplicationStateRunningForeground) {
-      return (XCUIApplication *)self.testedApplication;
-    }
-    if (self.isTestedApplicationExpectedToRun && testedAppState <= XCUIApplicationStateNotRunning) {
-      NSString *description = [NSString stringWithFormat:@"The application under test with bundle id '%@' is not running, possibly crashed", self.testedApplication.bundleID];
-      @throw [NSException exceptionWithName:FBApplicationCrashedException reason:description userInfo:nil];
-    }
-  }
-
   NSString *defaultBundleId = [self.defaultActiveApplication isEqualToString:FBDefaultApplicationAuto]
     ? nil
     : self.defaultActiveApplication;
-  return [XCUIApplication fb_activeApplicationWithDefaultBundleId:defaultBundleId];
+  FBApplication *application = [FBApplication fb_activeApplicationWithDefaultBundleId:defaultBundleId];
+  FBApplication *testedApplication = nil;
+  if (self.testedApplicationBundleId && self.isTestedApplicationExpectedToRun) {
+    testedApplication = nil != application.bundleID && [application.bundleID isEqualToString:self.testedApplicationBundleId]
+      ? application
+      : [[FBApplication alloc] initWithBundleIdentifier:self.testedApplicationBundleId];
+  }
+  if (testedApplication && !testedApplication.running) {
+    NSString *description = [NSString stringWithFormat:@"The application under test with bundle id '%@' is not running, possibly crashed", self.testedApplicationBundleId];
+    [[NSException exceptionWithName:FBApplicationCrashedException reason:description userInfo:nil] raise];
+  }
+  return application;
 }
 
-- (XCUIApplication *)launchApplicationWithBundleId:(NSString *)bundleIdentifier
-                           shouldWaitForQuiescence:(nullable NSNumber *)shouldWaitForQuiescence
-                                         arguments:(nullable NSArray<NSString *> *)arguments
-                                       environment:(nullable NSDictionary <NSString *, NSString *> *)environment
+- (FBApplication *)launchApplicationWithBundleId:(NSString *)bundleIdentifier
+                         shouldWaitForQuiescence:(nullable NSNumber *)shouldWaitForQuiescence
+                                       arguments:(nullable NSArray<NSString *> *)arguments
+                                     environment:(nullable NSDictionary <NSString *, NSString *> *)environment
 {
-  XCUIApplication *app = [self makeApplicationWithBundleId:bundleIdentifier];
+  FBApplication *app = [[FBApplication alloc] initWithBundleIdentifier:bundleIdentifier];
   if (nil == shouldWaitForQuiescence) {
     // Iherit the quiescence check setting from the main app under test by default
-    app.fb_shouldWaitForQuiescence = nil != self.testedApplication && self.shouldAppsWaitForQuiescence;
+    app.fb_shouldWaitForQuiescence = nil != self.testedApplicationBundleId && self.shouldAppsWaitForQuiescence;
   } else {
     app.fb_shouldWaitForQuiescence = [shouldWaitForQuiescence boolValue];
   }
-  if (!app.running) {
+  if (app.fb_state < 2) {
     app.launchArguments = arguments ?: @[];
     app.launchEnvironment = environment ?: @{};
     [app launch];
   } else {
-    [app activate];
+    [app fb_activate];
   }
-  if ([app fb_isSameAppAs:self.testedApplication]) {
+  if (nil != self.testedApplicationBundleId
+      && [bundleIdentifier isEqualToString:(NSString *)self.testedApplicationBundleId]) {
     self.isTestedApplicationExpectedToRun = YES;
   }
   return app;
 }
 
-- (XCUIApplication *)activateApplicationWithBundleId:(NSString *)bundleIdentifier
+- (FBApplication *)activateApplicationWithBundleId:(NSString *)bundleIdentifier
 {
-  XCUIApplication *app = [self makeApplicationWithBundleId:bundleIdentifier];
-  [app activate];
+  FBApplication *app = [[FBApplication alloc] initWithBundleIdentifier:bundleIdentifier];
+  [app fb_activate];
   return app;
 }
 
 - (BOOL)terminateApplicationWithBundleId:(NSString *)bundleIdentifier
 {
-  XCUIApplication *app = [self makeApplicationWithBundleId:bundleIdentifier];
-  if ([app fb_isSameAppAs:self.testedApplication]) {
+  FBApplication *app = [[FBApplication alloc] initWithBundleIdentifier:bundleIdentifier];
+  if (nil != self.testedApplicationBundleId
+      && [bundleIdentifier isEqualToString:(NSString *)self.testedApplicationBundleId]) {
     self.isTestedApplicationExpectedToRun = NO;
   }
-  if (app.running) {
+  if (app.fb_state >= 2) {
     [app terminate];
     return YES;
   }
@@ -217,14 +221,7 @@ static FBSession *_activeSession = nil;
 
 - (NSUInteger)applicationStateWithBundleId:(NSString *)bundleIdentifier
 {
-  return [self makeApplicationWithBundleId:bundleIdentifier].state;
-}
-
-- (XCUIApplication *)makeApplicationWithBundleId:(NSString *)bundleIdentifier
-{
-  return nil != self.testedApplication && [bundleIdentifier isEqualToString:(NSString *)self.testedApplication.bundleID]
-    ? self.testedApplication
-    : [[XCUIApplication alloc] initWithBundleIdentifier:bundleIdentifier];
+  return [[FBApplication alloc] initWithBundleIdentifier:bundleIdentifier].fb_state;
 }
 
 @end

package/WebDriverAgentLib/Utilities/FBAlertsMonitor.m

@@ -10,9 +10,9 @@
 #import "FBAlertsMonitor.h"
 
 #import "FBAlert.h"
+#import "FBApplication.h"
 #import "FBLogger.h"
 #import "XCUIApplication+FBAlert.h"
-#import "XCUIApplication+FBHelpers.h"
 
 static const NSTimeInterval FB_MONTORING_INTERVAL = 2.0;
 
@@ -49,8 +49,8 @@ static const NSTimeInterval FB_MONTORING_INTERVAL = 2.0;
   }
 
   dispatch_async(dispatch_get_main_queue(), ^{
-    NSArray<XCUIApplication *> *activeApps = XCUIApplication.fb_activeApplications;
-    for (XCUIApplication *activeApp in activeApps) {
+    NSArray<FBApplication *> *activeApps = FBApplication.fb_activeApplications;
+    for (FBApplication *activeApp in activeApps) {
       XCUIElement *alertElement = nil;
       @try {
         alertElement = activeApp.fb_alertElement;

package/WebDriverAgentLib/Utilities/FBKeyboard.m

@@ -9,6 +9,8 @@
 
 #import "FBKeyboard.h"
 
+
+#import "FBApplication.h"
 #import "FBConfiguration.h"
 #import "FBXCTestDaemonsProxy.h"
 #import "FBErrorBuilder.h"
@@ -23,13 +25,10 @@
 
 @implementation FBKeyboard
 
-+ (BOOL)waitUntilVisibleForApplication:(XCUIApplication *)app 
-                               timeout:(NSTimeInterval)timeout
-                                 error:(NSError **)error
++ (BOOL)waitUntilVisibleForApplication:(XCUIApplication *)app timeout:(NSTimeInterval)timeout error:(NSError **)error
 {
   BOOL (^isKeyboardVisible)(void) = ^BOOL(void) {
-    XCUIElement *keyboard = app.keyboards.fb_firstMatch;
-    if (nil == keyboard) {
+    if (!app.keyboard.exists) {
       return NO;
     }
 
@@ -37,7 +36,7 @@
                                                                             NSDictionary *bindings) {
       return snapshot.label.length > 0;
     }];
-    XCUIElement *firstKey = [[keyboard descendantsMatchingType:XCUIElementTypeKey]
+    XCUIElement *firstKey = [[app.keyboard descendantsMatchingType:XCUIElementTypeKey]
                              matchingPredicate:keySearchPredicate].allElementsBoundByIndex.firstObject;
     return firstKey.exists && firstKey.hittable;
   };

package/WebDriverAgentLib/Utilities/FBMjpegServer.m

@@ -13,6 +13,7 @@
 @import UniformTypeIdentifiers;
 
 #import "GCDAsyncSocket.h"
+#import "FBApplication.h"
 #import "FBConfiguration.h"
 #import "FBLogger.h"
 #import "FBScreenshot.h"

package/WebDriverAgentLib/Utilities/FBPasteboard.m

@@ -11,9 +11,9 @@
 
 #import <mach/mach_time.h>
 #import "FBAlert.h"
+#import "FBApplication.h"
 #import "FBErrorBuilder.h"
 #import "FBMacros.h"
-#import "XCUIApplication+FBHelpers.h"
 #import "XCUIApplication+FBAlert.h"
 
 #define ALERT_TIMEOUT_SEC 30
@@ -101,7 +101,7 @@
       break;
     }
 
-    XCUIElement *alertElement = XCUIApplication.fb_systemApplication.fb_alertElement;
+    XCUIElement *alertElement = FBApplication.fb_systemApplication.fb_alertElement;
     if (nil != alertElement) {
       FBAlert *alert = [FBAlert alertWithElement:alertElement];
       [alert acceptWithError:nil];

package/WebDriverAgentLib/Utilities/FBScreen.m

@@ -8,6 +8,7 @@
  */
 
 #import "FBScreen.h"
+#import "FBApplication.h"
 #import "XCUIElement+FBIsVisible.h"
 #import "FBXCodeCompatibility.h"
 #import "XCUIScreen.h"
@@ -21,7 +22,7 @@
 
 + (CGSize)statusBarSizeForApplication:(XCUIApplication *)application
 {
-  XCUIApplication *app = XCUIApplication.fb_systemApplication;
+  XCUIApplication *app = FBApplication.fb_systemApplication;
   // Since iOS 13 the status bar is no longer part of the application, it’s part of the SpringBoard
   XCUIElement *mainStatusBar = app.statusBars.allElementsBoundByIndex.firstObject;
   if (nil == mainStatusBar) {

package/WebDriverAgentLib/Utilities/FBTVNavigationTracker.m

@@ -10,6 +10,7 @@
 #import "FBTVNavigationTracker.h"
 #import "FBTVNavigationTracker-Private.h"
 
+#import "FBApplication.h"
 #import "FBMathUtils.h"
 #import "XCUIElement+FBCaching.h"
 #import "XCUIElement+FBUtilities.h"
@@ -68,7 +69,7 @@
 
 - (FBTVDirection)directionToFocusedElement
 {
-  XCUIElement *focused = XCUIApplication.fb_activeApplication.fb_focusedElement;
+  XCUIElement *focused = FBApplication.fb_activeApplication.fb_focusedElement;
 
   CGPoint focusedCenter = FBRectGetCenter(focused.wdFrame);
   FBTVNavigationItem *item = [self navigationItemWithElement:focused];

package/WebDriverAgentLib/Utilities/FBXCodeCompatibility.h

@@ -28,6 +28,39 @@ NSInteger FBTestmanagerdVersion(void);
 
 NS_ASSUME_NONNULL_BEGIN
 
+/**
+ The exception happends if one tries to call application method,
+ which is not supported in the current iOS version
+ */
+extern NSString *const FBApplicationMethodNotSupportedException;
+
+@interface XCUIApplication (FBCompatibility)
+
++ (nullable instancetype)fb_applicationWithPID:(pid_t)processID;
+
+/**
+ Get the state of the application. This method only returns reliable results on Xcode SDK 9+
+
+ @return State value as enum item. See https://developer.apple.com/documentation/xctest/xcuiapplicationstate?language=objc for more details.
+ */
+- (NSUInteger)fb_state;
+
+/**
+ Activate the application by restoring it from the background.
+ Nothing will happen if the application is already in foreground.
+ This method is only supported since Xcode9.
+
+ @throws FBTimeoutException if the app is still not active after the timeout
+ */
+- (void)fb_activate;
+
+/**
+ Terminate the application and wait until it disappears from the list of active apps
+ */
+- (void)fb_terminate;
+
+@end
+
 @interface XCUIElementQuery (FBCompatibility)
 
 /* Performs short-circuit UI tree traversion in iOS 11+ to get the first element matched by the query. Equals to nil if no matching elements are found */

package/WebDriverAgentLib/Utilities/FBXCodeCompatibility.m

@@ -9,7 +9,6 @@
 
 #import "FBXCodeCompatibility.h"
 
-#import "FBXCAXClientProxy.h"
 #import "FBConfiguration.h"
 #import "FBErrorBuilder.h"
 #import "FBLogger.h"
@@ -18,6 +17,45 @@
 #import "FBXCTestDaemonsProxy.h"
 #import "XCTestManager_ManagerInterface-Protocol.h"
 
+static const NSTimeInterval APP_STATE_CHANGE_TIMEOUT = 5.0;
+
+NSString *const FBApplicationMethodNotSupportedException = @"FBApplicationMethodNotSupportedException";
+
+@implementation XCUIApplication (FBCompatibility)
+
++ (instancetype)fb_applicationWithPID:(pid_t)processID
+{
+  if (0 == processID) {
+    return nil;
+  }
+
+  return [self applicationWithPID:processID];
+}
+
+- (void)fb_activate
+{
+  [self activate];
+  if (![self waitForState:XCUIApplicationStateRunningForeground timeout:APP_STATE_CHANGE_TIMEOUT / 2] || ![self fb_waitForAppElement:APP_STATE_CHANGE_TIMEOUT / 2]) {
+    [FBLogger logFmt:@"The application '%@' is not running in foreground after %.2f seconds", self.bundleID, APP_STATE_CHANGE_TIMEOUT];
+  }
+}
+
+- (void)fb_terminate
+{
+  [self terminate];
+  if (![self waitForState:XCUIApplicationStateNotRunning timeout:APP_STATE_CHANGE_TIMEOUT]) {
+    [FBLogger logFmt:@"The active application is still '%@' after %.2f seconds timeout", self.bundleID, APP_STATE_CHANGE_TIMEOUT];
+  }
+}
+
+- (NSUInteger)fb_state
+{
+  return [[self valueForKey:@"state"] intValue];
+}
+
+@end
+
+
 @implementation XCUIElementQuery (FBCompatibility)
 
 - (XCElementSnapshot *)fb_uniqueSnapshotWithError:(NSError **)error
@@ -51,7 +89,7 @@
   static dispatch_once_t hasIncludingNonModalElements;
   static BOOL result;
   dispatch_once(&hasIncludingNonModalElements, ^{
-    result = [XCUIApplication.fb_systemApplication.query respondsToSelector:@selector(includingNonModalElements)];
+    result = [FBApplication.fb_systemApplication.query respondsToSelector:@selector(includingNonModalElements)];
   });
   return result;
 }

package/WebDriverAgentLib/WebDriverAgentLib.h

@@ -16,6 +16,7 @@ FOUNDATION_EXPORT double WebDriverAgentLib_VersionNumber;
 FOUNDATION_EXPORT const unsigned char WebDriverAgentLib_VersionString[];
 
 #import <WebDriverAgentLib/FBAlert.h>
+#import <WebDriverAgentLib/FBApplication.h>
 #import <WebDriverAgentLib/FBCommandHandler.h>
 #import <WebDriverAgentLib/FBCommandStatus.h>
 #import <WebDriverAgentLib/FBConfiguration.h>