Delay Wait in a test case of Xcode UI testing

Question

I am trying to write a test case using the new UI Testing available in Xcode 7 beta 2  The App has a login screen where it makes a call to the server to login  There is a delay associated with this as it is an asynchronous operation   Is there a way to cause a delay or wait mechanism in the XCTestCase before proceeding to further steps   There is no proper documentation available and I went through the Header files of the classes  Was not able to find anything related to this   Any ideas suggestions

User · Answer

As of Xcode 8 3  we can use XCTWaiter http   masilotti com xctest-waiting   func waitForElementToAppear   element  XCUIElement  - gt  Bool       let predicate   NSPredicate format   exists    true       let expectation   expectation for  predicate  evaluatedWith  element                                     handler  nil       let result   XCTWaiter   wait for   expectation   timeout  5      return result     completed     Another trick is to write a wait function  credit goes to John Sundell for showing it to me  extension XCTestCase      func wait for duration  TimeInterval        let waitExpectation   expectation description   Waiting        let when   DispatchTime now     duration     DispatchQueue main asyncAfter deadline  when          waitExpectation fulfill                 We use a buffer here to avoid flakiness with Timer on CI     waitForExpectations timeout  duration   0 5          and use it like  func testOpenLink       let delegate   UIApplication shared delegate as  AppDelegate   let route   RouteMock     UIApplication shared open linkUrl  options       completionHandler  nil     wait for  1     XCTAssertNotNil route location

User · Answer

iOS 11   Xcode 9   lt  yourElement  gt  waitForExistence timeout  5    This is a great replacement for all the custom implementations on this site   Be sure to have a look at my answer here  https   stackoverflow com a 48937714 971329  There I describe an alternative to waiting for requests which will greatly reduce the time your tests are running

User · Answer

sleep will block the thread   No run loop processing occurs while the thread is blocked    you can use waitForExistence  let app   XCUIApplication   app launch    if let label   app staticTexts  Hello  world      label waitForExistence timeout  5

User · Answer

Xcode 9 introduced new tricks with XCTWaiter  Test case waits explicitly  wait for   documentExpectation   timeout  10    Waiter instance delegates to test  XCTWaiter delegate  self  wait for   documentExpectation   timeout  10    Waiter class returns result  let result   XCTWaiter wait for   documentExpectation   timeout  10  switch result    case  completed        all expectations were fulfilled before timeout  case  timedOut        timed out before all of its expectations were fulfilled case  incorrectOrder        expectations were not fulfilled in the required order case  invertedFulfillment        an inverted expectation was fulfilled case  interrupted        waiter was interrupted before completed or timedOut     sample usage  Before Xcode 9  Objective C  -  void waitForElementToAppear  XCUIElement   element withTimeout  NSTimeInterval timeout       NSUInteger line     LINE        NSString  file    NSString stringWithUTF8String   FILE         NSPredicate  existsPredicate    NSPredicate predicateWithFormat   exists    true          self expectationForPredicate existsPredicate evaluatedWithObject element handler nil         self waitForExpectationsWithTimeout timeout handler   NSError    Nullable error            if  error    nil                NSString  message    NSString stringWithFormat   Failed to find    after  f seconds  element timeout                self recordFailureWithDescription message inFile file atLine line expected YES                         USAGE  XCUIElement  element   app staticTexts  Name of your element     self waitForElementToAppear element withTimeout 5     Swift  func waitForElementToAppear element  XCUIElement  timeout  NSTimeInterval   5   file  String    file  line  UInt    line            let existsPredicate   NSPredicate format   exists    true            expectationForPredicate existsPredicate                  evaluatedWithObject  element  handler  nil           waitForExpectationsWithTimeout timeout     error  - gt  Void in             if  error    nil                    let message    Failed to find   element  after   timeout  seconds                   self recordFailureWithDescription message  inFile  file  atLine  line  expected  true                                  USAGE  let element   app staticTexts  Name of your element   self waitForElementToAppear element    or   let element   app staticTexts  Name of your element   self waitForElementToAppear element  timeout  10    SOURCE

User · Answer

Based on  Ted s answer  I ve used this extension  extension XCTestCase           Based on https   stackoverflow com a 33855219     func waitFor lt T gt  object  T  timeout  TimeInterval   5  file  String    file  line  UInt    line  expectationPredicate   escaping  T  - gt  Bool            let predicate   NSPredicate   obj    in             expectationPredicate obj as  T                    expectation for  predicate  evaluatedWith  object  handler  nil           waitForExpectations timeout  timeout    error in             if  error    nil                    let message    quot Failed to fulful expectation block for   object  after   timeout  seconds  quot                  let location   XCTSourceCodeLocation filePath  file  lineNumber  line                  let issue   XCTIssue type   assertionFailure  compactDescription  message  detailedDescription  nil  sourceCodeContext   init location  location   associatedError  nil  attachments                      self record issue                                    You can use it like this let element   app staticTexts  quot Name of your element quot   waitFor object  element     0 exists    It also allows for waiting for an element to disappear  or any other property to change  by using the appropriate block  waitFor object  element      0 exists      Wait for it to disappear

User · Answer

Edit   It actually just occurred to me that in Xcode 7b4  UI testing now has  expectationForPredicate evaluatedWithObject handler    Original   Another way is to spin the run loop for a set amount of time   Really only useful if you know how much  estimated  time you ll need to wait for  Obj-C    NSRunLoop currentRunLoop  runMode NSDefaultRunLoopMode beforeDate  NSDate dateWithTimeIntervalSinceNow   lt  lt time to wait in seconds gt  gt     Swift  NSRunLoop currentRunLoop   runMode NSDefaultRunLoopMode  beforeDate  NSDate timeIntervalSinceNow   lt  lt time to wait in seconds gt  gt     This is not super useful if you need to test some conditions in order to continue your test   To run conditional checks  use a while loop

User · Answer

The following code just works with Objective C   -  void wait  NSUInteger interval        XCTestExpectation  expectation    self expectationWithDescription   wait        dispatch after dispatch time DISPATCH TIME NOW   int64 t  interval   NSEC PER SEC    dispatch get main queue                expectation fulfill                self waitForExpectationsWithTimeout interval handler nil       Just make call to this function as given below    self wait  10

User · Answer

This will create a delay without putting the thread to sleep or throwing an error on timeout   let delayExpectation   XCTestExpectation   delayExpectation isInverted   true wait for   delayExpectation   timeout  5    Because the expectation is inverted  it will timeout quietly

User · Answer

In my case sleep created side effect so I used wait  let     XCTWaiter wait for   XCTestExpectation description   Hello World      timeout  2 0

User · Answer

According to the API for XCUIElement  exists can be used to check if a query exists or not so the following syntax could be useful in some cases   let app   XCUIApplication   app launch    let label   app staticTexts  Hello  world    while  label exists       sleep 1      If you are confident that your expectation will be met eventually you could try running this  It should be noted that crashing might be preferable if the wait is too long in which case waitForExpectationsWithTimeout   handler    from  Joe Masilotti s post should be used

User · Answer

Additionally  you can just sleep   sleep 10    Since the UITests run in another process  this works  I don   t know how advisable it is  but it works

User · Answer

Asynchronous UI Testing was introduced in Xcode 7 Beta 4  To wait for a label with the text  Hello  world   to appear you can do the following   let app   XCUIApplication   app launch    let label   app staticTexts  Hello  world    let exists   NSPredicate format   exists    1    expectationForPredicate exists  evaluatedWithObject  label  handler  nil  waitForExpectationsWithTimeout 5  handler  nil    More details about UI Testing can be found on my blog

[ios] Delay/Wait in a test case of Xcode UI testing

Examples related to ios

Examples related to ios9

Examples related to xcode-ui-testing

Examples related to xcode7-beta2

Examples related to xctwaiter