testcentricity_web 4.5.4 → 4.5.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d652328a11ab7fbe472b45ddf6a1cd1076d84e1d79b2c94df4ebf96e4298aab9
-  data.tar.gz: 90090a047692e7cbd9f8f9ca2f7a024dbe9d96731f317de3a41486e2380fd4d2
+  metadata.gz: c31b1f64ff5e1d6a67b734e1ad80dbfb2afa80d4a4277de9b44425dad6319b31
+  data.tar.gz: 73655e352a0b5b832fb3b8d676b728aed18416517edaee563cfe92bcde3bccc9
 SHA512:
-  metadata.gz: d707e97a372e12396c12186ade43db6ca754dc939462cc0304ec05d6c7706f6bba388e711834f95c23ee9ca008d911ca8f5514a57948de7178cab4b4da5e68f3
-  data.tar.gz: 1ae3f3f4b196ccd58cd5089027d745a61d2378c50f4f91d3d0badc1322d257524ef2f44568c0680e51719273e9ce1ef41071a7188972948115940086c67dba0b
+  metadata.gz: 14ec23c082cf6fd35bef526677b6601697fb72b56cef53743d302c55c2c21c1baa4358a836a2fbda9ef69bece089444aec1a29159256af9d8bc3303aeb7a8071
+  data.tar.gz: d6294de35865dfb7f753da0e84028a37a259a13c4a49ece60e6a4844e6a6d5acc85d90983632c0bbd938f39e64f77b2a4224edd2f0859dd35f85c60ebbf2ba88

data/CHANGELOG.md

@@ -2,6 +2,22 @@
 All notable changes to this project will be documented in this file.
 
 
+## [4.5.6] - 02-APR-2024
+
+### Fixed
+
+* `WebDriverConnect.initialize_web_driver`, `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.5.5] - 27-MAR-2024
+
+### Changed
+
+* Updated `selenium-webdriver` gem to version 4.19.0.
+
+
 ## [4.5.4] - 04-MAR-2024
 
 ### Changed

data/README.md

@@ -8,15 +8,15 @@
 
 
 The TestCentricity™ Web core framework for desktop and mobile web browser-based app testing implements a Page Object Model
-DSL for use with Cucumber (version 7.x or greater) or RSpec, and Selenium-Webdriver (version 4.18). It also facilitates the
-configuration of the appropriate Selenium-Webdriver capabilities required to establish connections with one or more local
-or cloud hosted desktop or mobile web browsers.
+DSL for use with Cucumber (version 7.x or greater) or RSpec, and Selenium-Webdriver. It also facilitates the configuration
+of the appropriate Selenium-Webdriver capabilities required to establish connections with one or more local or cloud hosted
+desktop or mobile web browsers.
 
 The TestCentricity™ Web gem supports connecting to, and running automated tests against the following target web browsers:
 * locally hosted desktop browsers (Chrome, Edge, Firefox, or Safari)
 * locally hosted "headless" Chrome, Firefox, or Edge browsers
 * remote desktop and emulated mobile web browsers hosted on Selenium Grid 4 and Dockerized Selenium Grid 4 environments
-* mobile Safari browsers on iOS device simulators or physical iOS devices (using Appium and XCode on macOS)
+* mobile Safari browsers on iOS device simulators or physical iOS devices (using Appium 2.x and XCode on macOS)
 * mobile Chrome or Android browsers on Android Studio virtual device emulators (using Appium and Android Studio)
 * cloud hosted desktop (Firefox, Chrome, Safari, IE, or Edge) or mobile (iOS Mobile Safari or Android Chrome) web browsers using the following service:
   * [Browserstack](https://www.browserstack.com/list-of-browsers-and-platforms?product=automate)
@@ -40,8 +40,8 @@ can be found [here](https://github.com/TestCentricity/tc_multi_webdriver_sample)
 
 ### Which gem should I use?
 
-* The TestCentricity **Web** gem only supports testing of web interfaces via desktop and mobile web browsers
-* The TestCentricity **Mobile** gem only supports testing of native iOS and/or Android mobile apps
+* The [TestCentricity **Web** gem](https://rubygems.org/gems/testcentricity_web) only supports testing of web interfaces via desktop and mobile web browsers
+* The [TestCentricity **Mobile** gem](https://rubygems.org/gems/testcentricity_mobile) only supports testing of native iOS and/or Android mobile apps
 * The TestCentricity gem supports testing of native mobile apps and/or web interfaces via desktop and mobile web browsers.
 
 | Tested platforms                                   | TestCentricity Web | TestCentricity Mobile | TestCentricity |
@@ -1880,6 +1880,10 @@ Below is an example of an `options` hash for specifying a connection to a grid h
 
 Refer to [this page](https://appium.io/docs/en/2.2/guides/caps/) for information regarding specifying Appium capabilities.
 
+⚠️ If you are running locally hosted mobile web 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.
+
 #### Mobile Safari Browser on iOS Simulators or iOS Physical Devices
 
 You can run your mobile web tests against the mobile Safari browser on iOS device simulators or physically connected iOS
@@ -1955,7 +1959,7 @@ When using the `options` hash, the following options and capabilities must be sp
 > ℹ️ If an optional user defined `driver_name:` is not specified in the `options` hash, the default driver name will be set to
 `appium_safari`.
 > 
-> ℹ️ If an `endpoint:` is not specified in the `options` hash, then the default remote endpoint URL of `http://localhost:4723/wd/hub`
+> ℹ️ If an `endpoint:` is not specified in the `options` hash, then the default remote endpoint URL of `http://localhost:4723`
 will be used.
 
 Below is an example of an `options` hash for specifying a connection to a locally hosted mobile Safari web browser running
@@ -2042,7 +2046,7 @@ When using the `options` hash, the following options and capabilities must be sp
 > ℹ️ If an optional user defined `driver_name:` is not specified in the `options` hash, the default driver name will be set to
 `appium_chrome`.
 > 
-> ℹ️ If an `endpoint:` is not specified in the `options` hash, then the default remote endpoint URL of `http://localhost:4723/wd/hub`
+> ℹ️ If an `endpoint:` is not specified in the `options` hash, then the default remote endpoint URL of `http://localhost:4723`
 will be used.
 
 Below is an example of an `options` hash for specifying a connection to a locally hosted mobile Chrome web browser running
@@ -2096,6 +2100,13 @@ starting your Cucumber test suite(s):
 
     run_appium: APPIUM_SERVER=run
 
+If you are running locally hosted mobile web 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.9 (Using Browser Specific Profiles in `cucumber.yml`)**](#using-browser-specific-profiles-in-cucumber-yml) below.
 
 
@@ -2116,6 +2127,10 @@ body of an example group:
       $server.stop if Environ.driver == :appium && $server.running?
     end
 ```
+If you are running locally hosted mobile web 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.
+
 
 ### Remote Cloud Hosted Desktop and Mobile Web Browsers
 
@@ -2936,6 +2951,7 @@ with access to your version control system.
     #==============
 
     run_appium: APPIUM_SERVER=run
+    appium_1x: APPIUM_SERVER_VERSION=1
 
 
     #==============
@@ -3099,6 +3115,11 @@ You can ensure that Appium Server is running by including `-p run_appium` in you
 
     cucumber -p ipad_pro_12_15_sim -p landscape -p run_appium
 
+If you are running locally hosted mobile web 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 remotely hosted Safari web browser running on a macOS
 Sonoma virtual machine on the BrowserStack service:

data/lib/testcentricity_web/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_web/version.rb

@@ -1,3 +1,3 @@
 module TestCentricityWeb
-  VERSION = '4.5.4'
+  VERSION = '4.5.6'
 end

data/lib/testcentricity_web/web_core/webdriver_helper.rb

@@ -293,7 +293,7 @@ module TestCentricity
                  # :nocov:
                else
                  caps[:'appium:wdaLocalPort'] = ENV['WDA_LOCAL_PORT'] if ENV['WDA_LOCAL_PORT']
-                 caps[:'appium:systemPort']   = ENV['SYSTEM_PORT'] if ENV['SYSTEM_PORT']
+                 caps[:'appium:systemPort'] = ENV['SYSTEM_PORT'] if ENV['SYSTEM_PORT']
                end
                caps
              else
@@ -303,8 +303,13 @@ module TestCentricity
                @capabilities
              end
       # specify endpoint url
-      @endpoint = 'http://localhost: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
       register_remote_driver(Environ.browser, caps)
     end
 
@@ -481,7 +486,7 @@ module TestCentricity
                   else
                     # define desktop browser options
                     bs_options[:resolution] = ENV['RESOLUTION'] if ENV['RESOLUTION']
-                    bs_options[:seleniumVersion] = '4.16.1'
+                    bs_options[:seleniumVersion] = '4.18.1'
                     {
                       browserName: browser,
                       browserVersion: ENV['BS_VERSION'],

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testcentricity_web
 version: !ruby/object:Gem::Version
-  version: 4.5.4
+  version: 4.5.6
 platform: ruby
 authors:
 - A.J. Mrozinski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-03 00:00:00.000000000 Z
+date: 2024-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -268,14 +268,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
@@ -307,8 +307,8 @@ dependencies:
 description: |2-
 
       The TestCentricity™ Web core framework for desktop and mobile web browser-based app testing implements a Page Object
-      Model DSL for use with Cucumber or RSpec, and Selenium-Webdriver v4.18. The gem also facilitates the configuration of
-      the appropriate Selenium-Webdriver capabilities required to establish connections to locally hosted desktop browsers,
+      Model DSL for use with Cucumber or RSpec, and Selenium-Webdriver. The gem also facilitates the configuration of the
+      appropriate Selenium-Webdriver capabilities required to establish connections to locally hosted desktop browsers,
       locally hosted emulated mobile browsers (iOS, Android, etc.) running within a local instance of Chrome, mobile Safari
       browsers on iOS device simulators or physical iOS devices, mobile Chrome browsers on Android Studio virtual device
       emulators, or cloud hosted desktop or mobile web browsers (using BrowserStack, Sauce Labs, TestingBot, or