testcentricity_web 4.4.1 → 4.4.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20ddb032add01d0bf8cbd1b2e5edfa456b31b3898dca0a1888720aa7cb23362a
-  data.tar.gz: 149f1b14ff524c3eb825081d5f6e695e4695dabefb1ac5218c9b91a38f33718f
+  metadata.gz: e92bc217ff919e7d3d53cd50cf535636d62e13a71314608d2942c104e3438a29
+  data.tar.gz: 2a7aeb90967173c977ceddf1cc61f3f10e17d5d4420a2cf666b53431d9482907
 SHA512:
-  metadata.gz: 93826b487631ebe3060aa63165333bbddfdbbca89e07e2d48984afe8880ac14c09f00cffa779c3de51fd35f0f2bfe0e7961aea3a433a166b209bed2f4e53303d
-  data.tar.gz: 355fcb18b798e95e79d28d5b0800bbb64a17d431e20db8fd750c56480d74f655246d81259a8546143a30026c9c9aa6fca908c9a9dc89271070f66988d37f1437
+  metadata.gz: f9cabcb32923ec4a5fb41bcc469ceb27118900b5feb54f88d16d623c8b70ecef2a80ecce52f12716ae629dee9b0fd6ed7b97971cb1c3c5878dc2b54d532cf4b6
+  data.tar.gz: 2b112b60bee132159ef62204065976ff92ee28b60c47c007946a2501831d9c18f34230338fedadac266dd76f80ac411354f44b07ac6c76c0982c91c9d5bd3665

data/CHANGELOG.md

@@ -2,6 +2,13 @@
 All notable changes to this project will be documented in this file.
 
 
+## [4.4.2] - 22-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

@@ -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

data/lib/testcentricity_web/version.rb

@@ -1,3 +1,3 @@
 module TestCentricityWeb
-  VERSION = '4.4.1'
+  VERSION = '4.4.2'
 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
@@ -683,6 +694,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.2
 platform: ruby
 authors:
 - A.J. Mrozinski
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-22 00:00:00.000000000 Z
+date: 2023-12-23 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: