ci: add ci (#1037)

* add ci

* increase timeout

* default timeout

* tweak default arg

* fix the usage

* increased wdaLaunchTimeout

* tweak tests

* fix test

Author: KazuCocoa

.github/workflows/functional-test.yml

@@ -0,0 +1,77 @@
+name: Functional Tests
+
+on:
+  # Run by manual at this time
+  workflow_dispatch:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  ios_test:
+    runs-on: macos-14
+    env:
+          XCODE_VERSION: 15.3
+          IOS_VERSION: 17.4
+          IOS_DEVICE_NAME: iPhone 15 Plus
+
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Install Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: 'lts/*'
+
+    - name: Select Xcode
+      uses: maxim-lobanov/setup-xcode@v1
+      with:
+        xcode-version: ${{ env.XCODE_VERSION }}
+    - run: defaults write com.apple.iphonesimulator PasteboardAutomaticSync -bool false
+
+    - uses: futureware-tech/simulator-action@v3
+      with:
+      # https://github.com/actions/runner-images/blob/main/images/macos/macos-14-arm64-Readme.md
+        model: ${{ env.IOS_DEVICE_NAME }}
+        os_version: ${{ env.IOS_VERSION }}
+
+    - name: Preparing other environment
+      run: |
+        brew install ffmpeg
+        brew tap wix/brew
+        brew install applesimutils
+
+    # Start Appium
+    - name: Install appium and mjpeg-consumer
+      run: |
+        npm install -g appium
+        npm install -g mjpeg-consumer
+    - run: |
+        appium driver install xcuitest
+        appium plugin install images@2.1.8
+        appium plugin install execute-driver
+        nohup appium --use-plugins=images,execute-driver --relaxed-security --log-timestamp --log-no-colors --base-path=/wd/hub > appium.log &
+
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.2
+    - run: |
+        bundle install
+        rake ios
+      name: Run tests
+      working-directory: ios_tests
+
+    - name: Save server output
+      if: ${{ always() }}
+      uses: actions/upload-artifact@master
+      with:
+        name: appium-ios_test_with_other_deps.log
+        path: |
+          appium.log
+          test/report/

android_tests/lib/run.rb

@@ -43,10 +43,6 @@ def start_driver(caps)
   driver.start_driver
 end
 
-# Sanity check
-a = OpenStruct.new x: 'ok'
-raise 'x issue' unless a.x == 'ok'
-
 dir = File.expand_path(File.join(Dir.pwd, 'lib'))
 appium_txt = File.join(Dir.pwd, 'appium.txt')
 device = ARGV[0].downcase.strip

ios_tests/appium.txt

@@ -1,10 +1,12 @@
 [caps]
 platformName = "ios"
-platformVersion = "17.2"
-deviceName ="iPhone 15"
+platformVersion = "17.4"
+deviceName ="iPhone 15 Plus"
 automationName = 'XCUITest'
 app = "../test_apps/UICatalog.app.zip"
 someCapability = "some_capability"
+simulatorStartupTimeout = 600000
+wdaLaunchTimeout = 600000
 
 [appium_lib]
 wait = 30

ios_tests/lib/common.rb

@@ -38,6 +38,10 @@ def catalog
   'UICatalog'
 end
 
+def target_bundle_id
+  'com.example.apple-samplecode.UICatalog'
+end
+
 def ui_ios
   UI.new($driver)
 end

ios_tests/lib/ios/specs/common/command/command.rb

@@ -18,6 +18,9 @@ class Common
     class Command
       class Command < Minitest::Test
         def test_01_command
+          driver.terminate_app target_bundle_id
+          driver.activate_app target_bundle_id
+
           File.delete 'syslog.log' if File.exist? 'syslog.log'
 
           # A number of systemlog is quite small than Android.

ios_tests/lib/ios/specs/common/element/window.rb

@@ -19,6 +19,8 @@ class Common
     class Element
       class Window < Minitest::Test
         def before_first
+          driver.terminate_app target_bundle_id
+          driver.activate_app target_bundle_id
           assert_equal screen, catalog
         end
 

ios_tests/lib/ios/specs/common/helper.rb

@@ -21,6 +21,8 @@ def setup
       end
 
       def test_01_before_first
+        driver.terminate_app target_bundle_id
+        driver.activate_app target_bundle_id
         assert_equal screen, catalog
       end
 

ios_tests/lib/ios/specs/common/patch.rb

@@ -22,6 +22,8 @@ class IosTest
   class Common
     class Patch < Minitest::Test
       def test_01_before_first
+        driver.terminate_app target_bundle_id
+        driver.activate_app target_bundle_id
         assert_equal screen, catalog
       end
 

ios_tests/lib/ios/specs/common/web_context.rb

@@ -19,6 +19,8 @@ class IosTest
   class Common
     class WebContext < Minitest::Test
       def test_01_before_first
+        driver.terminate_app target_bundle_id
+        driver.activate_app target_bundle_id
         assert_equal screen, catalog
       end
 

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

@@ -24,6 +24,8 @@ def go_back
       end
 
       def test_01_before_first
+        driver.terminate_app target_bundle_id
+        driver.activate_app target_bundle_id
         assert_equal screen, catalog
       end
 

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

@@ -24,7 +24,8 @@ def test_image_comparison
         # Equal to `$driver.driver.find_image_occurrence`
         # Equal to `driver.find_image_occurrence`
         find_result = find_image_occurrence full_image: image1, partial_image: image2
-        assert_equal({ 'rect' => { 'x' => 0, 'y' => 0, 'width' => 750, 'height' => 1334 } }, find_result)
+        rect = find_result['rect']
+        assert_equal({ 'x' => 0, 'y' => 0, 'width' => 750, 'height' => 1334 }, rect)
       end
     end
   end

ios_tests/lib/ios/specs/driver.rb

@@ -16,6 +16,8 @@
 class IosTest
   class Driver < Minitest::Test
     def test_01_before_first
+      driver.terminate_app target_bundle_id
+      driver.activate_app target_bundle_id
       assert_equal screen, catalog
     end
 
@@ -95,7 +97,7 @@ def test_09_driver_class
     end
 
     def test_10_status
-      assert_equal appium_server_version['build'].keys.sort, %w(built git-sha version)
+      assert appium_server_version['build'].keys.member?('version')
     end
 
     def test_11_server_version
@@ -119,7 +121,7 @@ def test_14_driver
     end
 
     def test_15_automation_name_is_xcuitest?
-      assert_equal automation_name_is_xcuitest?, automation_name_is_xcuitest?
+      assert_equal automation_name_is_xcuitest?, true
     end
 
     #
@@ -189,5 +191,9 @@ def test_24_events
       log_event vendor: 'appium', event: 'funEvent'
       log_events
     end
+
+    def test_25_device_is_ios
+      assert_equal device_is_ios?, true
+    end
   end
 end

ios_tests/lib/ios/specs/ios/command/multi_app_handler.rb

@@ -19,7 +19,10 @@ class Command
       class MultiAppHandler < Minitest::Test
         # Only for Xcode 9+
         def test_multip_app_handler
-          test_app_bundle = 'com.example.apple-samplecode.UICatalog'
+          driver.terminate_app target_bundle_id
+          driver.activate_app target_bundle_id
+
+          test_app_bundle = target_bundle_id
 
           assert_equal xcuitest_query_app_status(bundle_id: test_app_bundle), :running_in_foreground
 

ios_tests/lib/ios/specs/ios/command/pasteboard.rb

@@ -18,6 +18,9 @@ class Ios
     class Command
       class Pasteboard < Minitest::Test
         def test_pasteboard
+          driver.terminate_app target_bundle_id
+          driver.activate_app target_bundle_id
+
           # set blank before testing because pasteboard is remaining during launching simulators
           set_pasteboard content: 'before'
           assert_equal get_pasteboard, 'before'

ios_tests/lib/ios/specs/ios/element/alert.rb

@@ -25,6 +25,9 @@ def open_alert
         end
 
         def test_01_before
+          driver.terminate_app target_bundle_id
+          driver.activate_app target_bundle_id
+
           assert_equal screen, catalog
           wait_true do
             find_element(:name, 'Alert Views').click

ios_tests/lib/ios/specs/ios/element/button.rb

@@ -31,6 +31,9 @@ def after_last
         end
 
         def test_01_before_first
+          driver.terminate_app target_bundle_id
+          driver.activate_app target_bundle_id
+
           before_first
         end
 

ios_tests/lib/ios/specs/ios/element/generic.rb

@@ -27,6 +27,9 @@ def verify(element)
         end
 
         def test_01_before_first
+          driver.terminate_app target_bundle_id
+          driver.activate_app target_bundle_id
+
           assert_equal screen, catalog
         end
 

ios_tests/lib/ios/specs/ios/element/text.rb

@@ -26,6 +26,9 @@ def uiview_steppers
         end
 
         def test_01_before_first
+          driver.terminate_app target_bundle_id
+          driver.activate_app target_bundle_id
+
           assert_equal screen, catalog
         end
 

ios_tests/lib/ios/specs/ios/element/textfield.rb

@@ -25,6 +25,9 @@ def enter_password
       end
 
       def test_01_before_first
+        driver.terminate_app target_bundle_id
+        driver.activate_app target_bundle_id
+        assert_equal screen, catalog
         go_to_textfields
       end
 

ios_tests/lib/ios/specs/ios/helper.rb

@@ -17,6 +17,9 @@ class IosTest
   class Ios
     class Helper < Minitest::Test
       def test_01_before_first
+        driver.terminate_app target_bundle_id
+        driver.activate_app target_bundle_id
+
         assert_equal screen, catalog
       end
 

ios_tests/lib/ios/specs/ios/mobile_methods.rb

@@ -17,6 +17,8 @@ class IosTest
   class Ios
     class MobileMethods < Minitest::Test
       def test_01_before_first
+        driver.terminate_app target_bundle_id
+        driver.activate_app target_bundle_id
         assert_equal screen, catalog
       end
 

ios_tests/lib/ios/specs/ios/patch.rb

@@ -15,8 +15,10 @@
 # rake "ios[ios/patch]"
 class IosTest
   class Ios
-    class MobileMethods < Minitest::Test
+    class Patch < Minitest::Test
       def test_01_before_first
+        driver.terminate_app target_bundle_id
+        driver.activate_app target_bundle_id
         assert_equal screen, catalog
         go_to_textfields
       end

ios_tests/lib/ios/specs/ios/xcuitest_gestures.rb

@@ -31,6 +31,8 @@ def open_alert_custom
       end
 
       def test_01_before_first
+        driver.terminate_app target_bundle_id
+        driver.activate_app target_bundle_id
         assert_equal screen, catalog
       end