testcentricity_mobile 4.0.1 → 4.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a0905d797751e541ce6f8a2c6c6dd26d5d5584e628f163628a210b9a5798bcf1
-  data.tar.gz: 53ae41335c32637957051f14aeb2641c6d8fd3e8b3dd439a11097bd7ec035043
+  metadata.gz: 8d1c72189a3ecb6043ddb0ce1d7b16f1f2e67469522a97afbce050dcb75ab13f
+  data.tar.gz: 35348b22511759c81c7cce36f293f8eaa902fede99436b6803043db1ecc3c2bc
 SHA512:
-  metadata.gz: 1d7a071d804e24f74c6933cf6f747893ebaef6a7b185f8182cc671b3ac9700b366da763ba0c1ca76e5392341c996ad0c51c6df23ca6269aeb5b237196e00f1f4
-  data.tar.gz: dccfa0b3227f0d87025b1cd69236f739f1c2802ed7a2ce076312c07e4b107e2022a4db50401f8b5d0163a22792b38d27831c469b79ed240ea5be6b6d18c5dbaf
+  metadata.gz: 65dd7f632f96537cd043fb0e1246859e029b987fffbab216948818307c2ae1ed1ca57db8ef17883392d5ffeaa759b656602c696399a08431b83527f5862aedca
+  data.tar.gz: ae61adcb122c74499f17e930ad9457a0790547cac3a9c9807bf954d7bd62d34af8d431549d6e0b37c926ce1c30aadb41765091cc98467c831d1510861cb5e09a

data/CHANGELOG.md

@@ -2,6 +2,21 @@
 All notable changes to this project will be documented in this file.
 
 
+## [4.0.3] - 05-APR-2024
+
+### Fixed
+
+* `AppiumConnect.initialize_appium`, `AppiumServer.start`, and `AppiumServer.running?` methods now support Appium version 2.x.
+Backward compatibility with Appium version 1.x is provided if `APPIUM_SERVER_VERSION` Environment Variable is set to `1`.
+
+
+## [4.0.2] - 27-MAR-2024
+
+### Changed
+
+* Updated `selenium-webdriver` gem to version 4.19.0.
+
+
 ## [4.0.0] - 26-MAR-2024
 
 ### Fixed

data/README.md

@@ -8,7 +8,7 @@
 
 
 The TestCentricity™ Mobile core framework for native mobile iOS and Android app testing implements a Screen Object Model
-DSL for use with Cucumber (version 7.x or greater) and Appium. It also facilitates the configuration of the appropriate
+DSL for use with Cucumber (version 7.x or greater) and Appium 2.x. It also facilitates the configuration of the appropriate
 Appium capabilities and driver required to establish a connection with locally or cloud hosted iOS and Android real devices
 or simulators.
 
@@ -28,6 +28,15 @@ A complete history of bug fixes and new features can be found in the {file:CHANG
 
 The RubyDocs for this gem can be found [here](https://www.rubydoc.info/gems/testcentricity_mobile/).
 
+Two example projects that demonstrates the implementation of a screen object model framework using Cucumber and TestCentricity™
+Mobile can be found at the following:
+  * [tc_mobile_react_native_demo](https://github.com/TestCentricity/tc_mobile_react_native_demo)
+  * [tc_mobile_wdio_demo](https://github.com/TestCentricity/tc_mobile_wdio_demo)
+
+Refer to [this wiki page](https://github.com/TestCentricity/testcentricity_mobile/wiki/XCUItest-driver-bug-impacts-iOS-dialogs-managed-by-com.apple.springboard) for
+information on a bug with the latest versions of the XCUItest driver that affects Appium's ability to interact with and
+verify iOS system level modal dialogs.
+
 
 ### Which gem should I use?
 
@@ -310,9 +319,11 @@ Refer to the [Speeding Up Tests With Deep Links](https://appiumpro.com/editions/
 A `ScreenSection` is a collection of **UI Elements** that may appear in multiple locations on a screen, or on multiple
 screens in an app. It is a collection of **UI Elements** that represent a conceptual area of functionality, like a menu,
 a navigation bar, or a search capability. **UI Elements** and functional behavior are confined to the scope of a `ScreenSection`
-object.
+object. A `ScreenSection` may contain other `ScreenSection` objects.
 
-A `ScreenSection` may contain other `ScreenSection` objects.
+Below is an example of a footer navigation bar feature that is common to multiple screen -
+
+![Navigation Footer](https://raw.githubusercontent.com/TestCentricity/testcentricity_mobile/main/.github/images/NavBar1.png "Navigation Footer")       ![Navigation Footer](https://raw.githubusercontent.com/TestCentricity/testcentricity_mobile/main/.github/images/NavBar2.png "Navigation Footer")
 
 
 ### Defining a ScreenSection
@@ -472,11 +483,20 @@ Single `AppUIElement` declarations have the following format:
     elementType :elementName, { locator_strategy: locator_identifier }
 
 * The `elementName` is the unique name that you will use to refer to the UI element and is specified as a `Symbol`.
-* The `locator_strategy` specifies the [selector strategy](https://appium.io/docs/en/commands/element/find-elements/index.html#selector-strategies) 
-that Appium will use to find the `AppUIElement`. Valid selectors are `accessibility_id:`, `id:`, `name:`, `class:`, `xpath:`, 
-`predicate:` (iOS only), `class_chain:` (iOS only), and `css:` (WebViews in hybrid apps only).
+* The `locator_strategy` specifies the selector strategy that Appium will use to find the `AppUIElement`. Valid selectors are:
+  - `accessibility_id:`
+  - `id:`
+  - `name:`
+  - `class:`
+  - `xpath:`
+  - `predicate:` (iOS only)
+  - `class_chain:` (iOS only)
+  - `css:` (WebViews in hybrid apps only).
 * The `locator_identifier` is the value or attribute that uniquely and unambiguously identifies the `AppUIElement`.
 
+Refer to [this page](https://appium.github.io/appium-xcuitest-driver/5.12/locator-strategies/) for information on selector strategies for iOS.
+Refer to [this page](https://github.com/appium/appium-uiautomator2-driver?tab=readme-ov-file#element-location) for information on selector strategies for Android.
+
 Multiple `AppUIElement` declarations for a collection of elements of the same type can be performed by passing a hash table
 containing the names and locators of each individual element.
 
@@ -687,38 +707,44 @@ The `verify_ui_states` method also supports I18n string translations using prope
     :translate_capitalize String
     :translate_titlecase  String
 
-The example below depicts the usage of the `verify_ui_states` method to verify that the captions for menu items are correctly
-translated.
+The example below depicts the usage of the `verify_ui_states` method to verify that the captions for navigation menu items
+are correctly translated.
+
+![Localized UI](https://raw.githubusercontent.com/TestCentricity/testcentricity_mobile/main/.github/images/LocalizedUI.png "Localized UI")
 ```ruby
     def verify_menu
       ui = {
-        account_settings_item => {
+        menu_title => {
+          visible: true,
+          caption: { translate: 'NavMenu.title' }
+        },
+        recipes_item => {
           visible: true,
-          caption: { translate: 'Settings.account' }
+          caption: { translate: 'NavMenu.recipes' }
         },
-        help_item => {
+        browser_item => {
           visible: true,
-          caption: { translate: 'Settings.help' }
+          caption: { translate: 'NavMenu.browser' }
         },
-        feedback_item => {
+        groceries_item => {
           visible: true,
-          caption: { translate: 'Settings.feedback' }
+          caption: { translate: 'NavMenu.groceries' }
         },
-        legal_item => {
+        pantry_item => {
           visible: true,
-          caption: { translate: 'Settings.legal' }
+          caption: { translate: 'NavMenu.pantry' }
         },
-        configurations_item => {
+        meals_item => {
           visible: true,
-          caption: { translate: 'Settings.configurations' }
+          caption: { translate: 'NavMenu.meals' }
         },
-        contact_us_item => {
+        menus_item => {
           visible: true,
-          caption: { translate: 'Settings.contact' }
+          caption: { translate: 'NavMenu.menus' }
         },
-        sign_out_item => {
+        settings_item => {
           visible: true,
-          caption: { translate: 'Settings.sign_out' }
+          caption: { translate: 'NavMenu.settings' }
         }
       }
       verify_ui_states(ui)
@@ -730,38 +756,41 @@ menu example above, the translated strings for English, Spanish, and French are
 **English** - `en.yml`
 ```yaml
     en:
-      Settings:
-        account: 'Account'
-        help: 'Help'
-        feedback: 'Feedback'
-        legal: 'Legal'
-        configurations: 'Configurations'
-        contact: 'Contact'
-        sign_out: 'Sign out'
+      NavMenu:
+        title: 'Main Menu'
+        recipes: 'Recipes'
+        browser: 'Browser'
+        groceries: 'Groceries'
+        pantry: 'Pantry'
+        meals: 'Meals'
+        menus: 'Menus'
+        settings: 'Settings'
 ```
 **Spanish** - `es.yml`
 ```yaml
     es:
-      Settings:
-        account: 'Cuenta'
-        help: 'Ayuda'
-        feedback: 'Comentario'
-        legal: 'Legal'
-        configurations: 'Configuraciones'
-        contact: 'Contacto'
-        sign_out: 'Cerrar sesión'
+      NavMenu:
+        title: 'Menú principal'
+        recipes: 'Recetas'
+        browser: 'Navegador'
+        groceries: 'Compra'
+        pantry: 'Despensa'
+        meals: 'Comidas'
+        menus: 'Menús'
+        settings: 'Ajustes'
 ```
 **French** - `fr.yml`
 ```yaml
     fr:
-      Settings:
-        account: 'Compte'
-        help: 'Aide'
-        feedback: 'Retour'
-        legal: 'Légal'
-        configurations: 'Configurations'
-        contact: 'Contact'
-        sign_out: 'Fermer la session'
+      NavMenu:
+        title: 'Menu principal'
+        recipes: 'Recettes'
+        browser: 'Navigateur'
+        groceries: 'Courses'
+        pantry: 'Provisions'
+        meals: 'Repas'
+        menus: 'Menus'
+        settings: 'Réglades'
 ```
 
 Each supported language/locale combination has a corresponding `.yml` file. I18n `.yml` file naming convention uses
@@ -963,6 +992,10 @@ Refer to [this page](https://appium.io/docs/en/2.4/guides/caps/) for information
 to invoking Cucumber to run your features/scenarios on locally hosted iOS or Android simulators or physical devices. Refer
 to [**section 8.2.3 (Starting and Stopping Appium Server)**](#starting-and-stopping-appium-server) below.
 
+⚠️ If you are running locally hosted mobile tests on iOS or Android simulators or devices using version 1.x of the Appium
+server, the `APPIUM_SERVER_VERSION` environment variable must be set to `1` in order to ensure that the correct Appium server
+endpoint is used.
+
 #### Connecting to Locally Hosted iOS Simulators or Physical Devices
 
 You can run your automated tests on locally hosted iOS simulators or physically connected devices using Appium and XCode
@@ -1179,6 +1212,13 @@ starting your Cucumber test suite(s):
 
     run_appium: APPIUM_SERVER=run
 
+If you are running locally hosted mobile tests on iOS or Android simulators or devices using version 1.x of the Appium server,
+the `APPIUM_SERVER_VERSION` environment variable must be set to `1` in order to ensure that the correct Appium server endpoint
+is used. This can be set by adding the following to your `cucumber.yml` file and including `-p appium_1x` in your command line
+when starting your Cucumber test suite(s):
+
+    appium_1x: APPIUM_SERVER_VERSION=1
+
 Refer to [**section 8.4 (Using Configuration Specific Profiles in `cucumber.yml`)**](#using-configuration-specific-profiles-in-cucumber-yml) below.
 
 
@@ -1199,6 +1239,10 @@ body of an example group:
       $server.stop if Environ.driver == :appium && $server.running?
     end
 ```
+If you are running locally hosted mobile tests on iOS or Android simulators or devices using version 1.x of the Appium server,
+the `APPIUM_SERVER_VERSION` environment variable must be set to `1` in order to ensure that the correct Appium server endpoint
+is used.
+
 
 ###  Connecting to Remote Cloud Hosted iOS and Android Simulators or Physical Devices
 
@@ -1621,6 +1665,7 @@ with access to your version control system.
     # physical devices
     #==============
     run_appium: APPIUM_SERVER=run
+    appium_1x: APPIUM_SERVER_VERSION=1
 
 
     #==============
@@ -1718,6 +1763,11 @@ You can ensure that Appium Server is running by including `-p run_appium` in you
 
     cucumber -p ipad_pro_12_15_sim -p portrait -p run_appium
 
+If you are running locally hosted mobile tests using version 1.x of Appium server, you must include `-p appium_1x` in
+your command line:
+
+    cucumber -p ipad_pro_12_15_sim -p landscape -p run_appium -p appium_1x
+
 
 The following command specifies that Cucumber will run tests against a cloud hosted iPhone 13 Pro Max running iOS 15.4 on the
 BrowserStack service:

data/lib/testcentricity_mobile/app_core/appium_connect_helper.rb

@@ -390,7 +390,13 @@ module TestCentricity
 
     def self.appium_local_capabilities
       # specify endpoint url
-      @endpoint = 'http://127.0.0.1:4723/wd/hub' if @endpoint.nil?
+      if @endpoint.nil?
+        @endpoint = if ENV['APPIUM_SERVER_VERSION'] && ENV['APPIUM_SERVER_VERSION'].to_i == 1
+                      'http://127.0.0.1:4723/wd/hub'
+                    else
+                      'http://127.0.0.1:4723'
+                    end
+      end
       # define local Appium capabilities
       if @capabilities.nil?
         Environ.device_name = ENV['APP_DEVICE']
@@ -459,11 +465,7 @@ module TestCentricity
         Environ.device_name = @capabilities[:'appium:deviceName']
         Environ.device_os_version = @capabilities[:'appium:platformVersion']
         Environ.device_orientation = @capabilities[:'appium:orientation']
-        Environ.device = if @capabilities[:'appium:udid']
-                           :device
-                         else
-                           :simulator
-                         end
+        Environ.device = @capabilities[:'appium:udid'] ? :device : :simulator
         @capabilities
       end
     end

data/lib/testcentricity_mobile/appium_server.rb

@@ -38,9 +38,14 @@ module TestCentricity
     # Check to see if Appium Server is running
     #
     def running?
+      endpoint = if ENV['APPIUM_SERVER_VERSION'] && ENV['APPIUM_SERVER_VERSION'].to_i == 1
+                   'http://0.0.0.0:4723/wd/hub/sessions'
+                 else
+                   'http://0.0.0.0:4723/sessions'
+                 end
       response = false
       begin
-        response = Net::HTTP.get_response(URI('http://0.0.0.0:4723/wd/hub/sessions'))
+        response = Net::HTTP.get_response(URI(endpoint))
       rescue
       end
       response && response.code_type == Net::HTTPOK

data/lib/testcentricity_mobile/version.rb

@@ -1,3 +1,3 @@
 module TestCentricityMobile
-  VERSION = '4.0.1'
+  VERSION = '4.0.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testcentricity_mobile
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.0.3
 platform: ruby
 authors:
 - A.J. Mrozinski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-26 00:00:00.000000000 Z
+date: 2024-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -212,14 +212,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.18.1
+        version: 4.19.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.18.1
+        version: 4.19.0
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement