Update deactive app for xcuitest (#502)

* update deactive app for XCUITest

* add checking appium server version for background_app

* add comments

* remove a redundant line

* add comment

Author: KazuCocoa

ios_tests/lib/ios/specs/device/device.rb

@@ -52,6 +52,11 @@ def go_back
     tag(UI::Inventory.navbar).name.must_equal 'UICatalog'
   end
 
+  t 'background_app homescreen' do
+    background_app(-1) # background_app(nil) should work as same.
+    screen.must_raise ::Selenium::WebDriver::Error::NoSuchElementError
+  end
+
   t 'reset' do
     reset
   end

lib/appium_lib/device/device.rb

@@ -13,7 +13,13 @@ module Device
     # @!method background_app
     #  Backgrounds the app for a set number of seconds.
     #  This is a blocking application
-    # @param seconds (int) How many seconds to background the app for.
+    # @param [Integer] seconds How many seconds to background the app for.
+    #
+    #   ```ruby
+    #   background_app
+    #   background_app(5)
+    #   background_app(-1) #=> the app never come back. https://github.com/appium/appium/issues/7741
+    #   ```
 
     # @!method current_activity
 
@@ -202,8 +208,14 @@ def app_installed?(app_id)
         end
 
         add_endpoint_method(:background_app) do
-          def background_app(duration)
-            execute :background_app, {}, seconds: duration
+          def background_app(duration = 0)
+            # https://github.com/appium/ruby_lib/issues/500, https://github.com/appium/appium/issues/7741
+            if $driver.automation_name_is_xcuitest? && $driver.appium_server_status['build']['version'] >= '1.6.4'
+              duration_milli_sec = duration.nil? ? nil : duration * 1000
+              execute :background_app, {}, seconds: { timeout: duration_milli_sec }
+            else
+              execute :background_app, {}, seconds: duration
+            end
           end
         end
 

lib/appium_lib/driver.rb

@@ -299,7 +299,7 @@ class Driver
     # If automation_name is nil, it is not set both client side and server side.
     attr_reader :automation_name
     # Appium's server version
-    attr_reader :appium_server_version
+    attr_reader :appium_server_status
     # Boolean debug mode for the Appium Ruby bindings
     attr_accessor :appium_debug
     # instance of AbstractEventListener for logging support
@@ -476,7 +476,7 @@ def automation_name_is_xcuitest?
     # If the Appium server is under REQUIRED_VERSION_XCUITEST, then error is raised.
     # @return [Boolean]
     def check_server_version_xcuitest
-      if automation_name_is_xcuitest? && (@appium_server_version['build']['version'] < REQUIRED_VERSION_XCUITEST)
+      if automation_name_is_xcuitest? && (@appium_server_status['build']['version'] < REQUIRED_VERSION_XCUITEST)
         raise Appium::Error::NotSupportedAppiumServer, "XCUITest requires Appium version >= #{REQUIRED_VERSION_XCUITEST}"
       end
       true
@@ -618,7 +618,7 @@ def start_driver
         raise "ERROR: Unable to connect to Appium. Is the server running on #{server_url}?"
       end
 
-      @appium_server_version = appium_server_version
+      @appium_server_status = appium_server_version
 
       check_server_version_xcuitest
       set_automation_name_if_nil