testcentricity_web 3.0.6 → 3.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c1b260cf07c5bbde1a8e388a38605c85da10263
-  data.tar.gz: 001ed7c67c0146160a1fd7d1636fd9b5feb054e9
+  metadata.gz: 9740d09f5ae251d5d16505b76876418ac8d64dfd
+  data.tar.gz: bfbb4d31516bb66df59855505678317b88938ce8
 SHA512:
-  metadata.gz: 0014e310b243eb33481428654b7918d8ff46bcbf70d28912aacd4b09969bdeb1cf0f759ba7ebd6b0a8c54dcc917f4156484ca98810c134b8a65fa9312a30cb6a
-  data.tar.gz: 179a4593392024d766230348ac9b049bf503006fc7bf3ead0d0384dc996ed75a1eebc1e7db6bb90794649afc0bfa3003cddaab4c7aae95afe532c0cba3ada175
+  metadata.gz: ee417aeb72511576084eb0cd2820c38c1ebc86cfaeeee3c9d275300ec789f885ea8bec537d61f19b666c61e2e48cb6ad41a78df9cd69d7bee1c4706ca4c08b9c
+  data.tar.gz: d6711b2fd8ff0e84963596650a292380b807d0dfd34344cb6e09e5fabbcba9731a9f7a881c24e23811cdb1ebb95cdc8679f71b31d5710836e9c01c196f00423f

data/HISTORY.md

@@ -1,5 +1,12 @@
 # HISTORY
 
+###Version 3.0.7
+
+* Added support for connecting to and running your tests in desktop and emulated mobile web browsers hosted on Selenium Grid and Dockerized Selenium
+Grid environments.
+* Added `Environ.report_header` method that can be used to provide formatted test environment information in HTML test results.
+* Deprecated `TestCentricity::WebDriverConnect.set_webdriver_path` method because the correct WebDriver is now automatically set.
+
 ###Version 3.0.6
 
 * Added support for connecting to and running your tests on cloud hosted browsers on the Gridlastic cloud platform.

data/README.md

@@ -12,6 +12,7 @@ The TestCentricity™ Web gem supports running automated tests against the follo
 * locally hosted desktop browsers (Firefox, Chrome, Safari, or IE)
 * locally hosted emulated iOS Mobile Safari, Android, Windows Phone, or Blackberry mobile browsers (running within a local instance of Chrome)
 * locally hosted "headless" Chrome or Firefox browsers
+* desktop and emulated mobile web browsers hosted on Selenium Grid and Dockerized Selenium Grid environments
 * mobile Safari browsers on iOS device simulators or physical iOS devices (using Appium and XCode on OS X)
 * mobile Chrome or Android browsers on Android Studio virtual device emulators (using Appium and Android Studio on OS X)
 * cloud hosted desktop (Firefox, Chrome, Safari, IE, or Edge) or mobile (iOS Mobile Safari or Android) web browsers using the [Browserstack](https://www.browserstack.com/list-of-browsers-and-platforms?product=automate),
@@ -25,6 +26,13 @@ The TestCentricity™ Web gem supports running automated tests against the follo
 
 A complete history of bug fixes and new features can be found in the {file:HISTORY.md HISTORY} file.
 
+###Version 3.0.7
+
+* Added support for connecting to and running your tests in desktop and emulated mobile web browsers hosted on Selenium Grid and Dockerized Selenium
+Grid environments.
+* Added `Environ.report_header` method that can be used to provide formatted test environment information in HTML test results.
+* Deprecated `TestCentricity::WebDriverConnect.set_webdriver_path` method because the correct WebDriver is now automatically set.
+
 ###Version 3.0.6
 
 * Added support for connecting to and running your tests on cloud hosted browsers on the Gridlastic cloud platform.
@@ -798,6 +806,18 @@ To use a local instance of the Chrome desktop browser to host the emulated mobil
 to `chrome`.
 
 
+### Selenium Grid and Dockerized Selenium Grid hosted desktop and emulated mobile web browsers
+
+For desktop and emulated mobile web browsers running on Selenium Grid or Dockerized Selenium Grid environments, the following **Environment Variables** must be set
+as described in the table below.
+
+**Environment Variable** | **Description**
+---------------   | ----------------
+`WEB_BROWSER`     | Must be set to one of the following desktop browsers - `chrome`, `chrome_headless`, `firefox`, `ie`, `edge`, or `safari` or any of the mobile web browsers described above.
+`SELENIUM`        | Must be set to `remote`
+`REMOTE_ENDPOINT` | Must be set to the URL of the Grid hub, which is usually `http://localhost:4444/wd/hub`
+
+
 ### Mobile Safari browser on iOS Simulators or iOS Physical Devices
 
 You can run your mobile web tests against the mobile Safari browser on simulated iOS devices or physically connected iOS devices using Appium and XCode on
@@ -1050,9 +1070,10 @@ target web browsers is to create browser specific **Profiles** that set the appr
 in your `cucumber.yml` file.
 
 Below is a list of Cucumber **Profiles** for supported locally and remotely hosted desktop and mobile web browsers (put these in in your
-`cucumber.yml` file). Before you can use the BrowserStack, CrossBrowserTesting, Sauce Labs, or TestingBot services, you will need to
+`cucumber.yml` file). Before you can use the BrowserStack, CrossBrowserTesting, Sauce Labs, TestingBot, or Gridlastic services, you will need to
 replace the *INSERT USER NAME HERE* and *INSERT PASSWORD HERE* placeholder text with your user account and authorization code for the cloud
-service(s) that you intend to connect with.
+service(s) that you intend to connect with. When using the Gridlastic service, you will also need replace the *INSERT SUBDOMAIN HERE* placeholder
+text with the Subdomain specified on the Grid Configuration Parameters section of the Gridlastic Dashboard.
 
 
     <% desktop          = "--tags @desktop --require features BROWSER_TILE=true BROWSER_SIZE=1500,1000" %>
@@ -1072,6 +1093,11 @@ service(s) that you intend to connect with.
     firefox_headless:   WEB_BROWSER=firefox_headless <%= desktop %>
     firefox_legacy:     WEB_BROWSER=firefox_legacy   <%= desktop %>
 
+    #==============
+    # profile for Selenium Grid and Dockerized Selenium Grid hosted desktop web browsers
+    #==============
+    grid:               SELENIUM=remote REMOTE_ENDPOINT="http://localhost:4444/wd/hub"
+
 
     #==============
     # profiles for locally hosted mobile web browsers (emulated locally in Chrome browser)
@@ -1462,13 +1488,18 @@ service(s) that you intend to connect with.
 
 
 To specify a locally hosted target browser using a profile at runtime, you use the flag `--profile` or `-p` followed by the profile name when
-invoking Cucumber in the command line. For instance, the following command invokes Cucumber and specifies that a local instance of Chrome
+invoking Cucumber in the command line. For instance, the following command invokes Cucumber and specifies that a local instance of Firefox
 will be used as the target web browser:
     
-    $ cucumber -p chrome
+    $ cucumber -p firefox
+
+
+The following command specifies that Cucumber will run tests against an instance of Chrome hosted within a Dockerized Selenium Grid environment"
+    
+    $ cucumber -p chrome -p grid
 
 
-The following command specifies that Cucumber will run tests against a local instance of Firefox, which will be used to emulate an iPad Pro
+The following command specifies that Cucumber will run tests against a local instance of Chrome, which will be used to emulate an iPad Pro
 in landscape orientation:
     
     $ cucumber -p ipad_pro -p landscape
@@ -1497,7 +1528,7 @@ landscape orientation running on the BrowserStack service:
 
 ## Web Test Automation Framework Implementation
 
- <img src="http://i.imgur.com/RvpxjzW.jpg" width="1024" alt="Web Framework Overview" title="Web Framework Overview">
+ <img src="https://i.imgur.com/Ca6XPCS.jpg" width="1024" alt="Web Framework Overview" title="Web Framework Overview">
 
 
 

data/lib/testcentricity_web/data_objects/environment.rb

@@ -39,6 +39,7 @@ module TestCentricity
     attr_accessor :device_orientation
     attr_accessor :platform
     attr_accessor :driver
+    attr_accessor :grid
     attr_accessor :tunneling
 
     attr_accessor :signed_in
@@ -205,6 +206,14 @@ module TestCentricity
       @driver
     end
 
+    def self.grid=(type)
+      @grid = type
+    end
+
+    def self.grid
+      @grid
+    end
+
     def self.tunneling=(state)
       @tunneling = state
     end
@@ -268,5 +277,20 @@ module TestCentricity
     def self.reset_contexts
       @screen_shots = []
     end
+
+    def self.report_header
+      report_header = "\n<b><u>TEST ENVIRONMENT</u>:</b> #{ENV['TEST_ENVIRONMENT']}\n"\
+      "  <b>Browser:</b>\t #{Environ.browser.capitalize}\n"
+      report_header = "#{report_header}  <b>Device:</b>\t\t #{Environ.device_name}\n" if Environ.device_name
+      report_header = "#{report_header}  <b>Device OS:</b>\t #{Environ.device_os}\n" if Environ.device_os
+      report_header = "#{report_header}  <b>Device type:</b>\t #{Environ.device_type}\n" if Environ.device_type
+      report_header = "#{report_header}  <b>Driver:</b>\t\t #{Environ.driver}\n" if Environ.driver
+      report_header = "#{report_header}  <b>Grid:</b>\t\t #{Environ.grid}\n" if Environ.grid
+      report_header = "#{report_header}  <b>OS:</b>\t\t\t #{Environ.os}\n" if Environ.os
+      report_header = "#{report_header}  <b>Locale:</b>\t\t #{ENV['LOCALE']}\n" if ENV['LOCALE']
+      report_header = "#{report_header}  <b>Language:</b>\t #{ENV['LANGUAGE']}\n" if ENV['LANGUAGE']
+      report_header = "#{report_header}  <b>Country:</b>\t #{ENV['COUNTRY']}\n" if ENV['COUNTRY']
+      "#{report_header}\n\n"
+    end
   end
 end

data/lib/testcentricity_web/version.rb

@@ -1,3 +1,3 @@
 module TestCentricityWeb
-  VERSION = '3.0.6'
+  VERSION = '3.0.7'
 end

data/lib/testcentricity_web/web_core/webdriver_helper.rb

@@ -1,13 +1,13 @@
 require 'selenium-webdriver'
 require 'os'
 require 'browserstack/local'
+require 'webdrivers'
 
 
 module TestCentricity
   module WebDriverConnect
     include Capybara::DSL
 
-    attr_accessor :webdriver_path
     attr_accessor :bs_local
 
     def self.initialize_web_driver(app_host = nil)
@@ -44,7 +44,7 @@ module TestCentricity
       else
         if ENV['SELENIUM'] == 'remote'
           initialize_remote
-          context = 'Selenium Grid2'
+          context = 'Selenium Grid'
         else
           initialize_local_browser
           context = 'local browser instance'
@@ -64,68 +64,10 @@ module TestCentricity
       Capybara.app_host = url
     end
 
+    # @deprecated Correct webdriver is now automatically loaded
     # Set the WebDriver path for Chrome, Firefox, IE, or Edge browsers
     def self.set_webdriver_path(project_path)
-      path_to_driver = nil
-      # check for existence of /webdrivers or /features/support/drivers folders
-      base_path = 'features/support/drivers'
-      unless File.directory?(File.join(project_path, base_path))
-        base_path = 'webdrivers'
-        unless File.directory?(File.join(project_path, base_path))
-          raise 'Could not find WebDriver files in /webdrivers or /features/support/drivers folders'
-        end
-      end
-      # set WebDriver path based on browser and operating system
-      case ENV['WEB_BROWSER'].downcase.to_sym
-      when :chrome, :chrome_headless
-        if OS.osx?
-          path_to_driver = 'mac/chromedriver'
-        elsif OS.windows?
-          path_to_driver = 'windows/chromedriver.exe'
-        end
-        @webdriver_path = File.join(project_path, base_path, path_to_driver)
-        Selenium::WebDriver::Chrome.driver_path = @webdriver_path
-      when :firefox, :firefox_headless
-        if OS.osx?
-          path_to_driver = 'mac/geckodriver'
-        elsif OS.windows?
-          path_to_driver = 'windows/geckodriver.exe'
-        end
-        @webdriver_path = File.join(project_path, base_path, path_to_driver)
-        Selenium::WebDriver::Firefox.driver_path = @webdriver_path
-      when :ie
-        path_to_driver = 'windows/IEDriverServer.exe'
-        @webdriver_path = File.join(project_path, base_path, path_to_driver)
-        Selenium::WebDriver::IE.driver_path = @webdriver_path
-      when :edge
-        path_to_driver = 'windows/MicrosoftWebDriver.exe'
-        @webdriver_path = File.join(project_path, base_path, path_to_driver)
-        Selenium::WebDriver::Edge.driver_path = @webdriver_path
-      else
-        if ENV['HOST_BROWSER']
-          case ENV['HOST_BROWSER'].downcase.to_sym
-          when :chrome
-            if OS.osx?
-              path_to_driver = 'mac/chromedriver'
-            elsif OS.windows?
-              path_to_driver = 'windows/chromedriver.exe'
-            end
-            @webdriver_path = File.join(project_path, base_path, path_to_driver)
-            Selenium::WebDriver::Chrome.driver_path = @webdriver_path
-          when :firefox
-            if OS.osx?
-              path_to_driver = 'mac/geckodriver'
-            elsif OS.windows?
-              path_to_driver = 'windows/geckodriver.exe'
-            end
-            @webdriver_path = File.join(project_path, base_path, path_to_driver)
-            Selenium::WebDriver::Firefox.driver_path = @webdriver_path
-          else
-            raise "#{ENV['HOST_BROWSER']} is not a valid host browser for mobile browser emulation"
-          end
-        end
-      end
-      puts "The webdriver path is: #{@webdriver_path}" unless path_to_driver.nil?
+      warn "[DEPRECATION] 'TestCentricity::WebDriverConnect.set_webdriver_path' is deprecated. Correct webdrivers are now automatically loaded."
     end
 
     def self.initialize_browser_size
@@ -260,11 +202,7 @@ module TestCentricity
           profile['intl.accept_languages'] = ENV['LOCALE'] if ENV['LOCALE']
           options = Selenium::WebDriver::Firefox::Options.new(profile: profile)
           options.args << '--headless' if browser == :firefox_headless
-          if @webdriver_path.blank?
-            Capybara::Selenium::Driver.new(app, browser: :firefox, options: options)
-          else
-            Capybara::Selenium::Driver.new(app, browser: :firefox, options: options, driver_path: @webdriver_path)
-          end
+          Capybara::Selenium::Driver.new(app, browser: :firefox, options: options)
         when :chrome, :chrome_headless
           (browser == :chrome) ?
               options = Selenium::WebDriver::Chrome::Options.new :
@@ -273,25 +211,15 @@ module TestCentricity
           options.add_argument("--lang=#{ENV['LOCALE']}") if ENV['LOCALE']
           Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
         else
-          user_agent = Browsers.mobile_device_agent(ENV['WEB_BROWSER'])
-          ENV['HOST_BROWSER'] ? host_browser = ENV['HOST_BROWSER'].downcase.to_sym : host_browser = :chrome
-          case host_browser
-          when :firefox
-            profile = Selenium::WebDriver::Firefox::Profile.new
-            profile['general.useragent.override'] = user_agent
-            profile['intl.accept_languages'] = ENV['LOCALE'] if ENV['LOCALE']
-            options = Selenium::WebDriver::Firefox::Options.new(profile: profile)
-            if @webdriver_path.blank?
-              Capybara::Selenium::Driver.new(app, browser: :firefox, options: options)
-            else
-              Capybara::Selenium::Driver.new(app, browser: :firefox, options: options, driver_path: @webdriver_path)
-            end
-          when :chrome
+          if ENV['HOST_BROWSER'] && ENV['HOST_BROWSER'].downcase.to_sym == :chrome
+            user_agent = Browsers.mobile_device_agent(ENV['WEB_BROWSER'])
             options = Selenium::WebDriver::Chrome::Options.new
             options.add_argument('--disable-infobars')
             options.add_argument("--user-agent='#{user_agent}'")
             options.add_argument("--lang=#{ENV['LOCALE']}") if ENV['LOCALE']
             Capybara::Selenium::Driver.new(app, browser: :chrome, options: options)
+          else
+            raise "Requested browser '#{browser}' is not supported"
           end
         end
       end
@@ -300,6 +228,7 @@ module TestCentricity
 
     def self.initialize_browserstack
       browser = ENV['BS_BROWSER']
+      Environ.grid = :browserstack
 
       if ENV['BS_REAL_MOBILE'] || ENV['BS_PLATFORM']
         Environ.platform    = :mobile
@@ -397,6 +326,7 @@ module TestCentricity
 
     def self.initialize_crossbrowser
       browser = ENV['CB_BROWSER']
+      Environ.grid = :crossbrowser
 
       if ENV['CB_OS']
         Environ.os = ENV['CB_OS']
@@ -432,6 +362,7 @@ module TestCentricity
 
     def self.initialize_gridlastic
       browser = ENV['GL_BROWSER']
+      Environ.grid = :gridlastic
       Environ.os = ENV['GL_OS']
       endpoint = "http://#{ENV['GL_USERNAME']}:#{ENV['GL_AUTHKEY']}@#{ENV['GL_SUBDOMAIN']}.gridlastic.com:80/wd/hub"
 
@@ -448,6 +379,8 @@ module TestCentricity
         Capybara::Selenium::Driver.new(app, http_client: client, browser: :remote, url: endpoint, desired_capabilities: capabilities)
       end
 
+      Environ.browser = browser
+
       Capybara.default_driver = :selenium
       Capybara.run_server = false
 
@@ -458,10 +391,30 @@ module TestCentricity
     end
 
     def self.initialize_remote
-      browser = ENV['WEB_BROWSER']
+      Environ.grid = :selenium_grid
+      browser  = ENV['WEB_BROWSER'].downcase.to_sym
       endpoint = ENV['REMOTE_ENDPOINT'] || 'http://127.0.0.1:4444/wd/hub'
-      capabilities = Selenium::WebDriver::Remote::Capabilities.send(browser.downcase.to_sym)
       Capybara.register_driver :remote_browser do |app|
+        case browser
+        when :firefox, :safari, :ie, :edge
+          capabilities = Selenium::WebDriver::Remote::Capabilities.send(browser)
+        when :chrome, :chrome_headless
+          (browser == :chrome) ?
+              options = %w[--disable-infobars] :
+              options = %w[headless disable-gpu no-sandbox --disable-infobars]
+          options.push("--lang=#{ENV['LOCALE']}") if ENV['LOCALE']
+          capabilities = Selenium::WebDriver::Remote::Capabilities.chrome('goog:chromeOptions' => { args: options })
+        else
+          if ENV['HOST_BROWSER'] && ENV['HOST_BROWSER'].downcase.to_sym == :chrome
+            user_agent = Browsers.mobile_device_agent(ENV['WEB_BROWSER'])
+            options = %w[--disable-infobars]
+            options.push("--user-agent='#{user_agent}'")
+            options.push("--lang=#{ENV['LOCALE']}") if ENV['LOCALE']
+            capabilities = Selenium::WebDriver::Remote::Capabilities.chrome('goog:chromeOptions' => { args: options })
+          else
+            raise "Requested browser '#{browser}' is not supported on Selenium Grid"
+          end
+        end
         Capybara::Selenium::Driver.new(app, browser: :remote, url: endpoint, desired_capabilities: capabilities)
       end
       Capybara.current_driver = :remote_browser
@@ -470,6 +423,7 @@ module TestCentricity
 
     def self.initialize_saucelabs
       browser = ENV['SL_BROWSER']
+      Environ.grid = :saucelabs
 
       if ENV['SL_OS']
         Environ.platform = :desktop
@@ -508,6 +462,7 @@ module TestCentricity
 
     def self.initialize_testingbot
       browser = ENV['TB_BROWSER']
+      Environ.grid = :testingbot
 
       Environ.os = ENV['TB_OS']
       if ENV['TB_PLATFORM']

data/testcentricity_web.gemspec

@@ -41,6 +41,6 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'i18n'
   spec.add_runtime_dependency 'browserstack-local'
   spec.add_runtime_dependency 'appium_lib'
-
+  spec.add_runtime_dependency 'webdrivers', '~> 3.3'
   spec.add_runtime_dependency 'childprocess', '~> 0.5'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: testcentricity_web
 version: !ruby/object:Gem::Version
-  version: 3.0.6
+  version: 3.0.7
 platform: ruby
 authors:
 - A.J. Mrozinski
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-06-14 00:00:00.000000000 Z
+date: 2018-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -184,6 +184,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: webdrivers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: childprocess
   requirement: !ruby/object:Gem::Requirement