taf 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0501ee31ac5742b113c9e33b359bc324dae96b87e7a2caf82495113d6e6a3222
-  data.tar.gz: f9021907fd6dec231fe807e0afd32e2879ce44a9789f0bfd89ab62febb326e05
+  metadata.gz: 31c202a157c5f26907dacb3a08df58921f03cea0a5eb9bcc75523cdd7b44c148
+  data.tar.gz: 22aefc58b15a5b6ea4c0396c82528ff335d9cd1ca05e7dfae6978c44b7d902a2
 SHA512:
-  metadata.gz: 527cb4c93cce55d055bf5bb3d28026db1d5733ad8ba11c9bd91e2b091e1cedc3851169f889a2a6f4dc8ea6f932bbeb7f9fd23eb87e1f819c296ce76b106d8596
-  data.tar.gz: 16061dd456c4449a343261651e50b1c9de3509ef982acb965f9778a4f5f3d3bcd4a9abd9f1abeb757bcbdfb5921da21c92418939a898c60632a6ce1125c20d47
+  metadata.gz: db6b224929133960d7adebe1a6069773f97bb170a0a7a620d9320a04d74e4736be1dfe4c53f56ffb67e94d343e1c839aad043ba9acc790a3c14915826259f893
+  data.tar.gz: 95ee60dfb7b653b4110d8c8652e84c8eb4bce57b2cb4a7432901fe40308dc6d12e61561532ae1c52eb7eb5e24adc39ea94604cf6701bd1e1742c4c99e180b7f3

data/lib/taf/browser.rb

@@ -9,7 +9,7 @@
 module Taf
   # browser_setup.rb - a browser functions
   module Browser
-    # Suppoerted Browser names
+    # Supported Browser names
     @chrome_name = 'chrome'
     @chrome_headless_name = 'chrome-headless'
     @firefox_name = 'firefox'
@@ -17,61 +17,46 @@ module Taf
 
     # open_browser function
     def self.open_browser
-      browser = Taf::CMDLine.browser_type.downcase
-      case browser
-      when @chrome_name then chrome
-      when @chrome_headless_name then chrome_headless
-      when @firefox_name then firefox
-      when @firefox_headless_name then firefox_headless
+      @browser_name = Taf::CMDLine.browser_type.downcase
+      case @browser_name
+      when @chrome_name, @chrome_headless_name then chrome
+      when @firefox_name, @firefox_headless_name then firefox
       else
         raise Taf::BrowserFailedOpen,
-              "unable to open selected browser: #{browser}"
+              "unable to open selected browser: #{@browser_name}"
       end
     end
 
     # chrome browser details
     def self.chrome
-      @browser = Watir::Browser.new :chrome, switches: %w[
-        --acceptInsecureCerts-true --start-maximized --window-size=1920,1080
-      ]
-    end
-
-    # chrome headless browser details
-    def self.chrome_headless
-      @browser = Watir::Browser.new :chrome, switches: %w[
-        --start-maximized --disable-gpu --headless --acceptInsecureCerts-true
-        --no-sandbox --window-size=1920,1080
-      ]
+      case @browser_name
+      when @chrome_name
+        chrome_values = %w[
+          --acceptInsecureCerts-true --start-maximized --window-size=1920,1080
+        ]
+      when @chrome_headless_name
+        chrome_values = %w[
+          --start-maximized --disable-gpu --headless --acceptInsecureCerts-true
+          --no-sandbox --window-size=1920,1080
+        ]
+      end
+      @browser = Watir::Browser.new :chrome, switches: chrome_values
     end
 
     # firefox browser details
     def self.firefox
       caps = Selenium::WebDriver::Remote::Capabilities.firefox
       caps['acceptInsecureCerts'] = true
-      driver = Selenium::WebDriver.for(:firefox, desired_capabilities: caps)
-      @browser = Watir::Browser.new(driver)
-      browser_full_screen
-    end
-
-    # firefox headless browser details
-    def self.firefox_headless
-      caps = Selenium::WebDriver::Remote::Capabilities.firefox
-      options = Selenium::WebDriver::Firefox::Options.new(args: ['-headless'])
-      caps['acceptInsecureCerts'] = true
-      driver = Selenium::WebDriver.for(:firefox, options: options,
-                                                 desired_capabilities: caps)
+      case @browser_name
+      when @firefox_name
+        driver = Selenium::WebDriver.for(:firefox, desired_capabilities: caps)
+      when @firefox_headless_name
+        options = Selenium::WebDriver::Firefox::Options.new(args: ['-headless'])
+        driver = Selenium::WebDriver.for(:firefox, options: options,
+                                                   desired_capabilities: caps)
+      end
       @browser = Watir::Browser.new(driver)
-      # makes the browser full screen.
-      @browser.driver.manage.window.resize_to(1920, 1200)
-      @browser.driver.manage.window.move_to(0, 0)
-    end
-
-    # makes the browser full screen.
-    def self.browser_full_screen
-      screen_width = @browser.execute_script('return screen.width;')
-      screen_height = @browser.execute_script('return screen.height;')
-      @browser.driver.manage.window.resize_to(screen_width, screen_height)
-      @browser.driver.manage.window.move_to(0, 0)
+      @browser.driver.manage.window.maximize
     end
 
     # define browser value
@@ -81,8 +66,7 @@ module Taf
 
     # Check browser version
     def self.browser_version
-      browser_name = Taf::CMDLine.browser_type.downcase
-      case browser_name
+      case @browser_name
       when @chrome_name, @chrome_headless_name
         @browser.driver.capabilities[:version]
       when @firefox_name, @firefox_headless_name
@@ -94,8 +78,7 @@ module Taf
 
     # Check platform
     def self.browser_platform
-      browser_name = Taf::CMDLine.browser_type.downcase
-      case browser_name
+      case @browser_name
       when @chrome_name, @chrome_headless_name
         @browser.execute_script('return navigator.userAgent;')
                 .split(';')[1].split(')')[0]

data/lib/taf/json_parser.rb

@@ -36,7 +36,6 @@ module Taf
                       testvalue: parse_json['value0'],
                       locate: parse_json['value1'] || 'id',
                       testvalue2: parse_json['value2'],
-                      locate2: parse_json['value3'] || 'id',
                       skipTestCase: parse_json['skipTestCase'] == 'yes' }
 
       parsed_step

data/lib/taf/test_steps/handlers/base.rb

@@ -9,10 +9,7 @@ module Taf
         def initialize(step_attributes)
           @value =  step_attributes[:testvalue]
           @value2 = step_attributes[:testvalue2]
-          @value3 = step_attributes[:testvalue3]
           @locate = step_attributes[:locate]
-          @locate2 = step_attributes[:locate2]
-          @locate3 = step_attributes[:locate3]
         end
 
         def self.register(name)
@@ -28,28 +25,25 @@ module Taf
             Taf::Browser.b.text_field(id: user_elm).wait_until(&:exists?)
                         .set user
             Taf::Browser.b.text_field(id: pass_elm).set pass
-            button = 'Sign in' || 'Log in'
-            Taf::Browser.b.button(value: button).wait_until(&:exists?).click
+            Taf::Browser.b.button(value: 'Sign in').wait_until(&:exists?).click
             sleep 1
           else
             Taf::MyLog.log.warn("User: #{user} has failed to log in.")
           end
         end
 
-        def login_check(b_title_sucess, user)
-          if Taf::Browser.b.title.eql?(b_title_sucess)
-            Taf::MyLog.log.info("User: #{user} has logged in successful.")
+        def url_check(url)
+          if Taf::Browser.b.url == url
+            Taf::MyLog.log.info("URL: #{url} is correct.")
             true
           else
-            Taf::MyLog.log.warn("User: #{user} has failed to log in.")
+            Taf::MyLog.log.warn("URL: #{url} is incorrect.")
             false
           end
         end
 
-        def mem_word_check(user, b_title_sucess)
-          if Taf::Browser.b.title.eql?('Memorable word Portal')
-            portal_mem_word(user, b_title_sucess)
-          elsif Taf::Browser.b.title.eql?(b_title_sucess)
+        def login_check(b_title_success, user)
+          if Taf::Browser.b.title.eql?(b_title_success)
             Taf::MyLog.log.info("User: #{user} has logged in successful.")
             true
           else
@@ -58,7 +52,7 @@ module Taf
           end
         end
 
-        def portal_mem_word(user, b_title_sucess)
+        def portal_mem_word(user, b_title_success)
           password = ENV['PORTAL_MEM']
           nums = (1..256).to_a
           found_mem_nums = nums.each_with_object([]) do |num_val, mem_word|
@@ -77,7 +71,7 @@ module Taf
           end
 
           Taf::Browser.b.button(value: 'Sign in').wait_until(&:exists?).click
-          if Taf::Browser.b.title.eql?(b_title_sucess)
+          if Taf::Browser.b.title.eql?(b_title_success)
             Taf::MyLog.log.info("User: #{user} has logged in successful.")
             return true
           else

data/lib/taf/test_steps/handlers/base/click_button.rb

@@ -7,25 +7,21 @@ module Taf
       class ClickButton < Base
         register :click_button
 
-        def check
-          @elms = %i[button span a div link image h1 h2 h3 h4]
-
-          found_button = @elms.map do |elm|
-            Taf::Browser.b.send(elm, "#{@locate}": @value).exists?
-          end.compact
+        def perform
+          # Optimisation: if we can immediately find the target in the DOM
+          # under a specific tag we should use it.
+          @tag = %i[button span a div link image h1 h2 h3 h4].find do |e|
+            Taf::Browser.b.send(e, "#{@locate}": @value).exists?
+          end
 
-          raise 'Multiple matches' if found_button.select { |i| i }.empty?
+          # Otherwise, fallback to locating across the entire DOM.
+          # This can be necessary for when content rendering is deferred
+          # (e.g., a loader in a SPA) or if the user wants to use CSS or XPath.
+          @tag ||= :element
 
-          index = found_button.index(true)
-          return unless index
+          Taf::Browser.b.send(@tag, "#{@locate}": @value).wait_until(&:exists?)
+                      .click
 
-          index
-        end
-
-        def perform
-          index = check
-          Taf::Browser.b.send(@elms[index], "#{@locate}": @value)
-                      .wait_until(&:exists?).click
           Taf::MyLog.log.info("Button: #{@value} has been selected")
           true
         rescue StandardError

data/lib/taf/test_steps/handlers/base/{ping_test.rb → health_check.rb}

@@ -3,24 +3,25 @@
 module Taf
   module TestSteps
     module Handlers
-      # Png Test function.
-      class PingTest < Base
-        register :ping_test
+      # Health Check function to check the status of a web address or ip.
+      class HealthCheck < Base
+        register :health_check
 
         def perform
           tries ||= 20
-          Faraday.get(@value)
+          res = Faraday.get(@value)
+          status = res.status
         rescue Faraday::Error
           if (tries -= 1).positive?
             sleep 1
             puts "Failed to ping: #{@value} - Retries left: #{tries}"
             retry
           else
-            Taf::MyLog.log.warn("Failed to ping: #{@value}")
+            Taf::MyLog.log.warn("Site Error: #{@value} status code: #{status}")
             false
           end
         else
-          Taf::MyLog.log.info("Pinged successfully: #{@value}")
+          Taf::MyLog.log.info("Site: #{@value} status code: #{status}")
           true
         end
       end

data/lib/taf/test_steps/handlers/base/login.rb

@@ -16,9 +16,7 @@ module Taf
 
         def login_user(user)
           case @value.downcase
-          when 'admin_portal_login' then admin_portal_login(user)
           when 'portal_login' then portal_login(user)
-          when 'sint_login' then sint_login(user)
           when 'sso_login' then sso_login(user)
           else
             Taf::MyLog.log.error "unable to find login: #{@value}"
@@ -28,56 +26,53 @@ module Taf
 
         private
 
-        def admin_portal_login(user)
-          url = ENV['ADMINL_URL']
-          pass = ENV['ADMIN_USER_PASS']
-          b_title = 'Log in Portal Admin'
-          b_title_sucess = 'Home Admin Portal'
-          user_elm = 'admin_username'
-          pass_elm = 'admin_password'
-
-          Taf::Browser.b.goto(url)
-          login_process(b_title, user_elm, pass_elm, user, pass)
-          login_check(b_title_sucess, user)
-        end
-
         def portal_login(user)
           url = ENV['PORTAL_URL']
           pass = ENV['PORTAL_USER_PASS']
-          b_title = 'Log in Portal'
-          b_title_sucess = 'Home Portal'
+          b_title = 'Log in'
+          b_title_success = 'Home'
+          memorable_word_title = 'Memorable word'
           user_elm = 'user_email'
           pass_elm = 'user_password'
+          max_retry = 2
 
-          Taf::Browser.b.goto(url)
-          login_process(b_title, user_elm, pass_elm, user, pass)
-          mem_word_check(user, b_title_sucess)
+          max_retry.times do
+            Taf::Browser.b.goto(url)
+            url_check(url)
+            login_process(b_title, user_elm, pass_elm, user, pass)
+
+            begin
+              Taf::Browser.b.wait_until(timeout: 30) do |b|
+                b.title == b_title_success || b.title == memorable_word_title
+              end
+            rescue Watir::Wait::TimeoutError
+              Taf::MyLog.log.warn('Retrying login process...')
+              next
+            end
+
+            success = true
+
+            if Taf::Browser.b.title.eql?(memorable_word_title)
+              success = portal_mem_word(user, b_title_success)
+            end
+
+            return success
+          end
+
+          false
         end
 
         def sso_login(user)
           pass = ENV['SSO_USER_PASS']
-          # b_title = 'Log in to rh-sso'
-          # b_title_sucess = 'RHS-SSO Admin Console'
           b_title = ''
-          b_title_sucess = ''
+          b_title_success = ''
           user_elm = 'username'
           pass_elm = 'password'
 
-          login_process(b_title, user_elm, pass_elm, user, pass)
-          login_check(b_title_sucess, user)
-        end
-
-        def sint_login(user)
-          url = ENV['SINT_URL']
-          pass = ENV['SINT_USER_PASS']
-          b_title = 'SINT'
-          b_title_sucess = 'SINT'
-          user_elm = 'user_username'
-          pass_elm = 'user_password'
-
           Taf::Browser.b.goto(url)
+          url_check(url)
           login_process(b_title, user_elm, pass_elm, user, pass)
-          login_check(b_title_sucess, user)
+          login_check(b_title_success, user)
         end
       end
     end

data/lib/taf/test_steps/handlers/base/radio_button.rb

@@ -8,14 +8,11 @@ module Taf
         register :radio_button
 
         def perform
-          Taf::Browser.b.radio("#{@locate}": @value).wait_until(&:exists?)
-          Taf::Browser.b
-                      .radio("#{@locate}": @value, "#{@locate2}": @value2.to_s)
-                      .set
-          Taf::MyLog.log.info("Radio button: #{@value2} has been selected")
+          Taf::Browser.b.radio("#{@locate}": @value).wait_until(&:exists?).set
+          Taf::MyLog.log.info("Radio button: #{@value} has been selected")
           true
         rescue StandardError
-          Taf::MyLog.log.warn("Radio button: #{@value2} does not exist")
+          Taf::MyLog.log.warn("Radio button: #{@value} does not exist")
           false
         end
       end

data/lib/taf/test_steps/handlers/base/select_dropdown.rb

@@ -10,8 +10,7 @@ module Taf
         def perform
           ele = Taf::Browser.b.select_list("#{@locate}": @value)
 
-          ele.wait_until(&:exists?)
-          ele.option("#{@locate2}": @value2.to_s).select
+          ele.wait_until(&:exists?).select @value2.to_s
           Taf::MyLog.log.info("Dropdown item: #{@value2} has been selected")
           true
         rescue StandardError

data/lib/taf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Taf
-  VERSION = '0.4.4'
+  VERSION = '0.5.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taf
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Andy Perrett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-08-15 00:00:00.000000000 Z
+date: 2019-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -204,11 +204,11 @@ files:
 - lib/taf/test_steps/handlers/base/execute_system_command.rb
 - lib/taf/test_steps/handlers/base/generate_token.rb
 - lib/taf/test_steps/handlers/base/handle_browser_window.rb
+- lib/taf/test_steps/handlers/base/health_check.rb
 - lib/taf/test_steps/handlers/base/ipause.rb
 - lib/taf/test_steps/handlers/base/list_all_dropdowns_values.rb
 - lib/taf/test_steps/handlers/base/login.rb
 - lib/taf/test_steps/handlers/base/open_url.rb
-- lib/taf/test_steps/handlers/base/ping_test.rb
 - lib/taf/test_steps/handlers/base/radio_button.rb
 - lib/taf/test_steps/handlers/base/select_dropdown.rb
 - lib/taf/test_steps/handlers/base/send_special_keys.rb