testcentricity_web 4.4.1 → 4.4.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20ddb032add01d0bf8cbd1b2e5edfa456b31b3898dca0a1888720aa7cb23362a
-  data.tar.gz: 149f1b14ff524c3eb825081d5f6e695e4695dabefb1ac5218c9b91a38f33718f
+  metadata.gz: a8c968e47a6f1c58903fd78ecacef42a3a6897714fba982cdde8045c2079f80a
+  data.tar.gz: 3d863cb52a2384e6fdeb3128425797ebe9e42d6f53f58d222d3b4e680b19fec1
 SHA512:
-  metadata.gz: 93826b487631ebe3060aa63165333bbddfdbbca89e07e2d48984afe8880ac14c09f00cffa779c3de51fd35f0f2bfe0e7961aea3a433a166b209bed2f4e53303d
-  data.tar.gz: 355fcb18b798e95e79d28d5b0800bbb64a17d431e20db8fd750c56480d74f655246d81259a8546143a30026c9c9aa6fca908c9a9dc89271070f66988d37f1437
+  metadata.gz: 382f74e7baf7e34f7e2a02b602a91eb00029ced5bc518ddf967298ea95e18050592c03b51692372cf55b8f879d599155d07b1eaf5590d5c7a4376ee905613165
+  data.tar.gz: cd88dbd29452dcf44294a775e48ba939578cc2f1936229d630fffecaaf7afa0c2082e8b8ff2b6f1d530462d700e70128ab8f695587538872ef6724c2eecbb232

data/CHANGELOG.md

@@ -2,6 +2,19 @@
 All notable changes to this project will be documented in this file.
 
 
+## [4.4.3] - 24-DEC-2023
+
+### Changed
+* Changed Sauce Labs `DATA_CENTER` Environment Variable to `SL_DATA_CENTER`.
+
+
+## [4.4.2] - 23-DEC-2023
+
+### Added
+* Added support for specifying and connecting to web browsers on unsupported cloud hosting services using `custom` user-
+defined driver and capabilities.
+
+
 ## [4.4.0] - 22-DEC-2023
 
 ### Added

data/README.md

@@ -2327,7 +2327,7 @@ the following **Environment Variables** must be set as described in the table be
 | `DRIVER`                 | Must be set to `saucelabs`                                                                                                 |
 | `SL_USERNAME`            | Must be set to your Sauce Labs account user name or email address                                                          |
 | `SL_AUTHKEY`             | Must be set to your Sauce Labs account access key                                                                          |
-| `DATA_CENTER`            | Must be set to your Sauce Labs account Data Center assignment (`us-west-1`, `eu-central-1`, `apac-southeast-1`)            |
+| `SL_DATA_CENTER`         | Must be set to your Sauce Labs account Data Center assignment (`us-west-1`, `eu-central-1`, `apac-southeast-1`)            |
 | `SL_OS`                  | Refer to `platformName` capability in the Config Script section of the Platform Configurator page                          |
 | `SL_BROWSER`             | Must be set to `chrome`, `firefox`, `safari`, `internetExplorer`, or `MicrosoftEdge`                                       |
 | `SL_VERSION`             | Refer to `browserVersion` capability in the Config Script section of the Platform Configurator page                        |
@@ -2363,11 +2363,11 @@ When using the `options` hash, the following options and capabilities must be sp
 
 ℹ️ If an `endpoint:` is not specified in the `options` hash, then the default remote endpoint URL will be set to the following:
 
-`https://#{ENV['SL_USERNAME']}:#{ENV['SL_AUTHKEY']}@ondemand.#{ENV['DATA_CENTER']}.saucelabs.com:443/wd/hub`
+`https://#{ENV['SL_USERNAME']}:#{ENV['SL_AUTHKEY']}@ondemand.#{ENV['SL_DATA_CENTER']}.saucelabs.com:443/wd/hub`
 
 This default endpoint requires that the `SL_USERNAME` Environment Variable is set to your Sauce Labs account user name, the
-`SL_AUTHKEY` Environment Variable is set to your Sauce Labs access key, and the `DATA_CENTER` Environment Variable is set to
-your Sauce Labs account Data Center assignment (`us-west-1`, `eu-central-1`, `apac-southeast-1`).
+`SL_AUTHKEY` Environment Variable is set to your Sauce Labs access key, and the `SL_DATA_CENTER` Environment Variable is
+set to your Sauce Labs account Data Center assignment (`us-west-1`, `eu-central-1`, `apac-southeast-1`).
 
 Below is an example of an `options` hash for specifying a connection to the latest version of an Edge desktop web browser
 running on macOS Ventura hosted on Sauce Labs. The `options` hash includes options for specifying the driver name, setting
@@ -2418,7 +2418,7 @@ the following **Environment Variables** must be set as described in the table be
 | `DEVICE_TYPE`            | Must be set to `phone` or `tablet`                                                                              |
 | `SL_USERNAME`            | Must be set to your Sauce Labs account user name or email address                                               |
 | `SL_AUTHKEY`             | Must be set to your Sauce Labs account access key                                                               |
-| `DATA_CENTER`            | Must be set to your Sauce Labs account Data Center assignment (`us-west-1`, `eu-central-1`, `apac-southeast-1`) |
+| `SL_DATA_CENTER`         | Must be set to your Sauce Labs account Data Center assignment (`us-west-1`, `eu-central-1`, `apac-southeast-1`) |
 | `ORIENTATION`            | [Optional] Set to `PORTRAIT` or `LANDSCAPE`                                                                     |
 
 
@@ -2456,11 +2456,11 @@ When using the `options` hash, the following options and capabilities must be sp
 
 ℹ️ If an `endpoint:` is not specified in the `options` hash, then the default remote endpoint URL will be set to the following:
 
-`https://#{ENV['SL_USERNAME']}:#{ENV['SL_AUTHKEY']}@ondemand.#{ENV['DATA_CENTER']}.saucelabs.com:443/wd/hub`
+`https://#{ENV['SL_USERNAME']}:#{ENV['SL_AUTHKEY']}@ondemand.#{ENV['SL_DATA_CENTER']}.saucelabs.com:443/wd/hub`
 
 This default endpoint requires that the `SL_USERNAME` Environment Variable is set to your Sauce Labs account user name, the
-`SL_AUTHKEY` Environment Variable is set to your Sauce Labs access key, and the `DATA_CENTER` Environment Variable is set to
-your Sauce Labs account Data Center assignment (`us-west-1`, `eu-central-1`, `apac-southeast-1`).
+`SL_AUTHKEY` Environment Variable is set to your Sauce Labs access key, and the `SL_DATA_CENTER` Environment Variable is
+set to your Sauce Labs account Data Center assignment (`us-west-1`, `eu-central-1`, `apac-southeast-1`).
 
 Below is an example of an `options` hash for specifying a connection to a mobile Safari web browser running on an iPad
 tablet hosted on Sauce Labs. The `options` hash includes options for specifying the driver name, and capabilities for setting
@@ -2690,7 +2690,7 @@ When using the `options` hash, the following options and capabilities must be sp
         browserName: browser_name_from_chart,
         browserVersion: browser_version_from_chart,
         'LT:Options': {
-          userName: lt_account_user_name,
+          username: lt_account_user_name,
           accessKey: lt_account_access_key,
           platformName: platformName_from_chart
         }
@@ -2722,7 +2722,7 @@ test configuration options.
         browserVersion: '119.0',
         'LT:Options': {
           platformName: 'macOS Sonoma',
-          userName: ENV['LT_USERNAME'],
+          username: ENV['LT_USERNAME'],
           accessKey: ENV['LT_AUTHKEY'],
           project: 'ALP AP',
           build: "Test Build {ENV['BUILD_NUM']}",
@@ -2739,6 +2739,74 @@ test configuration options.
     WebDriverConnect.initialize_web_driver(options)
 
 
+#### Remote Browsers on Unsupported Cloud Hosting Services
+
+Limited support is provided for executing automated tests against remotely hosted desktop and mobile web browsers on currently
+unsupported cloud hosting services. You must call the `TestCentricity::WebDriverConnect.initialize_web_driver` method with
+an `options` hash - Environment Variables cannot be used to specify a user-defined custom WebDriver instance.
+
+The following options and capabilities must be specified:
+- `driver:` must be set to `:custom`
+- `endpoint:` must be set to the endpoint URL configuration specified by the hosting service
+- `browserName:` in the `capabilities:` hash must be set to name from capability specified by the hosting service
+
+All other required capabilities specified by the hosting service configuration documentation should be included in the
+`capabilities:` hash.
+
+    options = {
+      driver: :custom,
+      endpoint: endpoint_url,
+      capabilities: { browserName: browser_name_from_chart }
+    }
+    WebDriverConnect.initialize_web_driver(options)
+
+ℹ️ If an optional user defined `driver_name:` is not specified in the `options` hash, the default driver name will be set to
+`:custom_<browserName>` - e.g. `:custom_chrome` or `:custom_safari`.
+
+Prior to calling the `TestCentricity::WebDriverConnect.initialize_web_driver` method, you must set `Environ.platform` to
+either `:desktop` or `:mobile`, and `Environ.device` to either `:web` or `:device` dependent on whether the target browser
+is a desktop browser or a mobile browser running on a mobile device or simulator.
+
+Below is an example for specifying a connection to a Firefox desktop web browser on an unsupported hosting service:
+
+      # specify desktop platform
+      Environ.platform = :desktop
+      Environ.device = :web
+      # instantiate a cloud hosted desktop web browser on an unsupported hosting service
+      options = {
+        driver: :custom,
+        driver_name: :user_defined,
+        browser_size: [1400, 1100],
+        endpoint: endpoint_url,
+        capabilities: {
+          browserName: 'Firefox',
+          browser_version: browser_version_from_chart
+          #  other capabilities go here
+        }
+      }
+      WebDriverConnect.initialize_web_driver(options)
+
+Below is an example for specifying a connection to a mobile Safari web browser running on an iPad on an unsupported hosting
+service:
+
+      # specify mobile platform, device type, and device name
+      Environ.platform = :mobile
+      Environ.device = :device
+      Environ.device_name = device_name_from_chart
+      # instantiate a cloud hosted mobile browser on a device on an unsupported hosting service
+      options = {
+        driver: :custom,
+        driver_name: :user_defined,
+        device_type: :tablet,
+        endpoint: endpoint_url,
+        capabilities: {
+          browserName: 'Safari',
+          #  other capabilities go here
+        }
+      }
+      WebDriverConnect.initialize_web_driver(options)
+
+
 ### Closing Browser and Driver Instances
 
 #### Closing Instances Using Cucumber
@@ -2925,7 +2993,7 @@ with access to your version control system.
     #          access to your version control system
     #==============
 
-    saucelabs:  DRIVER=saucelabs SL_USERNAME="<INSERT USER NAME HERE>" SL_AUTHKEY="<INSERT PASSWORD HERE>" DATA_CENTER="<INSERT DATA CENTER HERE"
+    saucelabs:  DRIVER=saucelabs SL_USERNAME="<INSERT USER NAME HERE>" SL_AUTHKEY="<INSERT PASSWORD HERE>" SL_DATA_CENTER="<INSERT DATA CENTER HERE"
     sl_desktop: --profile saucelabs <%= desktop %>
     sl_mobile:  --profile saucelabs <%= mobile %>
 

data/lib/testcentricity_web/version.rb

@@ -1,3 +1,3 @@
 module TestCentricityWeb
-  VERSION = '4.4.1'
+  VERSION = '4.4.3'
 end

data/lib/testcentricity_web/web_core/webdriver_helper.rb

@@ -43,7 +43,11 @@ module TestCentricity
         Environ.browser = ENV['WEB_BROWSER'] if ENV['WEB_BROWSER']
         Environ.device_orientation = ENV['ORIENTATION'] if ENV['ORIENTATION']
       else
-        Environ.browser = @capabilities[:browserName]
+        if @capabilities[:browserName]
+          Environ.browser = @capabilities[:browserName]
+        else
+          raise 'Missing :browserName in @capabilities'
+        end
         Environ.device_orientation = @capabilities[:orientation] if @capabilities[:orientation]
         Environ.device_orientation = @capabilities[:'appium:orientation'] if @capabilities[:'appium:orientation']
       end
@@ -51,10 +55,12 @@ module TestCentricity
       Environ.driver = :webdriver if Environ.driver.nil?
       Environ.device_type = ENV['DEVICE_TYPE'] if ENV['DEVICE_TYPE']
       # assume that we're testing within a local desktop web browser
-      Environ.platform    = :desktop
-      Environ.headless    = false
-      Environ.device      = :web
-      Environ.device_name = 'browser'
+      unless Environ.driver == :custom
+        Environ.platform    = :desktop
+        Environ.headless    = false
+        Environ.device      = :web
+        Environ.device_name = 'browser'
+      end
 
       context = case Environ.driver
                 when :appium
@@ -80,6 +86,11 @@ module TestCentricity
                   initialize_lambdatest
                   'LambdaTest cloud service'
                   # :nocov:
+                when :custom
+                  raise 'User-defined webdriver requires that you define options' if options.nil?
+
+                  initialize_custom_driver
+                  'custom user-defined webdriver'
                 else
                   raise "#{Environ.driver} is not a supported driver"
                 end
@@ -571,7 +582,7 @@ module TestCentricity
       end
       # specify endpoint url
       if @endpoint.nil?
-        @endpoint = "https://#{ENV['SL_USERNAME']}:#{ENV['SL_AUTHKEY']}@ondemand.#{ENV['DATA_CENTER']}.saucelabs.com:443/wd/hub"
+        @endpoint = "https://#{ENV['SL_USERNAME']}:#{ENV['SL_AUTHKEY']}@ondemand.#{ENV['SL_DATA_CENTER']}.saucelabs.com:443/wd/hub"
       end
       # define SauceLab options
       options = if @capabilities.nil?
@@ -642,15 +653,16 @@ module TestCentricity
                   Environ.os = ENV['LT_OS']
                   # define the required set of LambdaTest options
                   lt_options = {
-                    user: ENV['LT_USERNAME'],
+                    username: ENV['LT_USERNAME'],
                     accessKey: ENV['LT_AUTHKEY'],
-                    build: test_context_message,
                     platformName: ENV['LT_OS'],
                     resolution: ENV['RESOLUTION'],
+                    name: test_context_message,
                     selenium_version: '4.13.0',
                   }
                   # define the optional LambdaTest options
-                  lt_options[:name] = ENV['AUTOMATE_PROJECT'] if ENV['AUTOMATE_PROJECT']
+                  lt_options[:project] = ENV['AUTOMATE_PROJECT'] if ENV['AUTOMATE_PROJECT']
+                  lt_options[:build] = ENV['AUTOMATE_BUILD'] if ENV['AUTOMATE_BUILD']
                   lt_options[:headless] = ENV['HEADLESS'] if ENV['HEADLESS']
                   lt_options[:timezone] = ENV['TIME_ZONE'] if ENV['TIME_ZONE']
                   lt_options[:geoLocation] = ENV['GEO_LOCATION'] if ENV['GEO_LOCATION']
@@ -683,6 +695,15 @@ module TestCentricity
     end
     # :nocov:
 
+    def self.initialize_custom_driver
+      raise 'User-defined webdriver requires that you provide capabilities' if @capabilities.nil?
+      raise 'User-defined webdriver requires that you provide an endpoint' if @endpoint.nil?
+
+      Environ.browser = @capabilities[:browserName]
+      Environ.grid = :custom
+      register_remote_driver(Environ.browser, @capabilities)
+    end
+
     def self.chrome_edge_options(browser)
       options = case browser
                 when :chrome, :chrome_headless

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testcentricity_web
 version: !ruby/object:Gem::Version
-  version: 4.4.1
+  version: 4.4.3
 platform: ruby
 authors:
 - A.J. Mrozinski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-22 00:00:00.000000000 Z
+date: 2023-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -376,7 +376,7 @@ metadata:
   changelog_uri: https://github.com/TestCentricity/testcentricity_web/blob/main/CHANGELOG.md
   bug_tracker_uri: https://github.com/TestCentricity/testcentricity_web/issues
   wiki_uri: https://github.com/TestCentricity/testcentricity_web/wiki
-  documentation_uri: https://www.rubydoc.info/gems/testcentricity_web/4.4.1
+  documentation_uri: https://www.rubydoc.info/gems/testcentricity_web
 post_install_message:
 rdoc_options: []
 require_paths: