taf 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e890ccd6ddebb08f0ce354fd689f01197d6f3118612d73cbabc413f885f9d15d
-  data.tar.gz: ed95d60fa534d3e6a67c9640329b785df2d6ae599007782027ed0f2f089a9a65
+  metadata.gz: 689534e9c30efe0f07355bb190dc79fc71adc06152a5fda8d79c601e9b1de97d
+  data.tar.gz: 59998580a22f1c1bda658b136aa77a25da75c9b53e5854c9b7b82f8d513c8191
 SHA512:
-  metadata.gz: 511758778621850bb660c4d1112cd90adf82ff095a97e817d3070ea29d139fee111e15cfa2ee0f992c92b246d6f8167d4017adb0568fddc701939595a4b6bf60
-  data.tar.gz: fee2faa59db43f0a57cdf8a00c47a47cc4ab50130bb5343b2d7db92c6f5b26e199fef739542a63d0333aa783da2f6c19703acbd2db1f300aca2f4fddafacc127
+  metadata.gz: b0c9a37bee50a842f2b125dcc1ad091219c8b13a87364d71b23e937851faaa88195e2667542c02fbcc87380663d9ecb5dec1c9724179243f025d90251be462d7
+  data.tar.gz: 06ac73be34a9561fe388747ae48f69649d6961393d34e817fd0f34db7356ebb97d4e6436b56d3e4d8c24dbe1930b68778124fe09f3b06897a8f09af3e06ef4db

data/lib/functions/handlers/base_handler.rb

@@ -6,12 +6,19 @@ module TestSteps
   module Handlers
     # All Login functions function.
     class Base
+      def initialize(step_attributes)
+        @value =  step_attributes[:testvalue]
+        @value2 = step_attributes[:testvalue2]
+        @locate = step_attributes[:locate]
+        @locate2 = step_attributes[:locate2]
+      end
+
       def self.register(name)
         TestSteps.handlers[name.to_s] = self
       end
 
       def self.perform(*args)
-        new.perform(*args)
+        new(*args).perform
       end
 
       def open_url_process(url)
@@ -23,23 +30,14 @@ module TestSteps
         if Browser.b.title.eql?(b_title)
           Browser.b.text_field(id: user_elm).wait_until(&:exists?).set user
           Browser.b.text_field(id: pass_elm).wait_until(&:exists?).set pass
-          login_button
+          button = 'Sign in' || 'Log in'
+          Browser.b.button(value: button).wait_until(&:exists?).click
           sleep 1
         else
           MyLog.log.warn("User: #{user} has failed to log in.")
         end
       end
 
-      def login_button
-        if Browser.b.button(value: 'Sign in').exist?
-          Browser.b.button(value: 'Sign in').wait_until(&:exists?).click
-        elsif Browser.b.button(value: 'Log in').exist?
-          Browser.b.button(value: 'Log in').wait_until(&:exists?).click
-        else
-          MyLog.log.warn("User: #{user} has failed to log in.")
-        end
-      end
-
       def login_check(b_title_sucess, user)
         if Browser.b.title.eql?(b_title_sucess)
           MyLog.log.info("User: #{user} has logged in successful.")
@@ -51,7 +49,7 @@ module TestSteps
       end
 
       def mem_word_check(user, b_title_sucess)
-        if Browser.b.title.eql?('Memorable word Portal')
+        if Browser.b.title.eql?('Memorable word')
           portal_mem_word(user, b_title_sucess)
         elsif Browser.b.title.eql?(b_title_sucess)
           MyLog.log.info("User: #{user} has logged in successful.")

data/lib/functions/handlers/browser_back.rb

@@ -8,7 +8,7 @@ module TestSteps
     class BrowserBack < Base
       register :browser_back
 
-      def perform(_step_attributes)
+      def perform
         Browser.b.back
         MyLog.log.info('Browser navigated back')
         true

data/lib/functions/handlers/browser_forward.rb

@@ -8,7 +8,7 @@ module TestSteps
     class BrowserForward < Base
       register :browser_forward
 
-      def perform(_step_attributes)
+      def perform
         Browser.b.forward
         MyLog.log.info('Browser navigated forward')
         true

data/lib/functions/handlers/browser_quit.rb

@@ -8,7 +8,7 @@ module TestSteps
     class BrowserQuit < Base
       register :browser_quit
 
-      def perform(_step_attributes)
+      def perform
         Browser.b.quit
         MyLog.log.info('Browser has closed successfully')
         true

data/lib/functions/handlers/browser_refresh.rb

@@ -8,7 +8,7 @@ module TestSteps
     class BrowserRefresh < Base
       register :browser_refresh
 
-      def perform(_step_attributes)
+      def perform
         Browser.b.refresh
         MyLog.log.info('The Browser has been refreshed')
         true

data/lib/functions/handlers/capture_alert.rb

@@ -8,7 +8,7 @@ module TestSteps
     class CaptureAlert < Base
       register :capture_alert
 
-      def perform(_step_attributes)
+      def perform
         Browser.b.div(class: 'alert').exist?
         alertmsg = Browser.b.div(class: 'alert').text
         MyLog.log.info("Alert shown: #{alertmsg}")

data/lib/functions/handlers/check_box.rb

@@ -8,15 +8,12 @@ module TestSteps
     class CheckBox < Base
       register :check_box
 
-      def perform(step_attributes)
-        checkbox = step_attributes[:testvalue]
-        locate = step_attributes[:locate]
-
-        Browser.b.checkbox("#{locate}": checkbox).wait_until(&:exists?).click
-        MyLog.log.info("Check box: #{checkbox} has been selected")
+      def perform
+        Browser.b.checkbox("#{@locate}": @value).wait_until(&:exists?).click
+        MyLog.log.info("Check box: #{@value} has been selected")
         true
       rescue StandardError
-        MyLog.log.warn("Check box: #{checkbox} does not exist")
+        MyLog.log.warn("Check box: #{@value} does not exist")
         false
       end
     end

data/lib/functions/handlers/check_boxdata.rb

@@ -8,35 +8,26 @@ module TestSteps
     class CheckBoxdata < Base
       register :check_box_data
 
-      def perform(step_attributes)
-        box = step_attributes[:testvalue]
-        value = step_attributes[:testvalue2]
-        locate = step_attributes[:locate]
+      def perform
+        elms = %i[textarea text_field iframe]
 
-        found_box = [
-          Browser.b.textarea("#{locate}": box).exist?,
-          Browser.b.text_field("#{locate}": box).exist?
-        ]
+        found_box = elms.map do |elm|
+          Browser.b.send(elm, "#{@locate}": @value).exists?
+        end.compact
 
         raise 'Multiple matches' if found_box.select { |i| i }.empty?
 
         index = found_box.index(true)
         return unless index
 
-        if index.zero?
-          Browser.b.textarea("#{locate}": box).wait_until(&:exists?)
-          (Browser.b.textarea("#{locate}": box).value == value)
-        elsif index == 1
-          Browser.b.text_field("#{locate}": box).wait_until(&:exists?)
-          (Browser.b.text_field("#{locate}": box).value == value)
-        end
-        MyLog.log.info("Textbox: #{box} has the correct value: #{value}")
+        ele = Browser.b.send(elms[index], "#{@locate}": @value)
+
+        ele.wait_until(&:exists?)
+        (ele.value == @value2)
+        MyLog.log.info("Textbox: #{@value} has correct value: #{value2}")
         true
       rescue StandardError
-        MyLog.log.warn("Textbox: #{box} has the incorrect value: #{value}")
-        false
-      rescue StandardError
-        MyLog.log.warn("Textbox: #{box} does not exist")
+        MyLog.log.warn("Textbox: #{@value} does not exist")
         false
       end
     end

data/lib/functions/handlers/check_browser_title.rb

@@ -8,14 +8,12 @@ module TestSteps
     class CheckTitle < Base
       register :check_browser_title
 
-      def perform(step_attributes)
-        b_title = step_attributes[:testvalue]
-
-        Browser.b.wait_until { Browser.b.title.eql? b_title }
-        MyLog.log.info("Browser title: #{b_title}")
+      def perform
+        Browser.b.wait_until { Browser.b.title.eql? @value }
+        MyLog.log.info("Browser title: #{@value}")
         true
       rescue StandardError
-        MyLog.log.warn("Title not found: #{b_title}")
+        MyLog.log.warn("Title not found: #{@value}")
         false
       end
     end

data/lib/functions/handlers/check_logs.rb

@@ -8,16 +8,13 @@ module TestSteps
     class CheckLogs < Base
       register :check_log_file
 
-      def perform(step_attributes)
-        text = step_attributes[:testvalue]
-        file = step_attributes[:testvalue2]
-
-        blog_result = system 'egrep -i ' + text + ' ' + file + ' > ' + output
-        if blog_result == true
-          MyLog.log.info("Data has matched: #{text} in LogFile: #{file}")
+      def perform
+        result = system 'egrep -i ' + @value + ' ' + @value2 + ' > ' + output
+        if result == true
+          MyLog.log.info("Data has matched: #{@value} in LogFile: #{@value2}")
           return true
         else
-          MyLog.log.warn("Problem finding: #{text} in LogFile: #{file}")
+          MyLog.log.warn("Problem finding: #{@value} in LogFile: #{@value2}")
           return false
         end
       end

data/lib/functions/handlers/check_screendata.rb

@@ -8,14 +8,12 @@ module TestSteps
     class CheckScreendata < Base
       register :check_screen_data
 
-      def perform(step_attributes)
-        check_text = step_attributes[:testvalue]
-
-        Browser.b.wait_until { Browser.b.element.text.include? check_text }
-        MyLog.log.info("Text found: #{check_text}")
+      def perform
+        Browser.b.wait_until { Browser.b.element.text.include? @value }
+        MyLog.log.info("Text found: #{@value}")
         true
       rescue StandardError
-        MyLog.log.warn("Text not found: #{check_text}")
+        MyLog.log.warn("Text not found: #{@value}")
         false
       end
     end

data/lib/functions/handlers/check_url.rb

@@ -8,14 +8,12 @@ module TestSteps
     class CheckUrl < Base
       register :check_url
 
-      def perform(step_attributes)
-        url = step_attributes[:testvalue]
-
-        if Browser.b.url == url
-          MyLog.log.info("URL: #{url} is correct")
+      def perform
+        if Browser.b.url == @value
+          MyLog.log.info("URL: #{@value} is correct")
           true
         else
-          MyLog.log.warn("URL: #{url} is incorrect")
+          MyLog.log.warn("URL: #{@value} is incorrect")
           false
         end
       end

data/lib/functions/handlers/click_button.rb

@@ -8,14 +8,11 @@ module TestSteps
     class ClickButton < Base
       register :click_button
 
-      def perform(step_attributes)
-        button = step_attributes[:testvalue]
-        locate = step_attributes[:locate]
-
+      def perform
         elms = %i[button span a div link image h1 h2 h3 h4]
 
         found_button = elms.map do |elm|
-          Browser.b.send(elm, "#{locate}": button).exists?
+          Browser.b.send(elm, "#{@locate}": @value).exists?
         end.compact
 
         raise 'Multiple matches' if found_button.select { |i| i }.empty?
@@ -23,12 +20,12 @@ module TestSteps
         index = found_button.index(true)
         return unless index
 
-        Browser.b.send(elms[index], "#{locate}": button)
+        Browser.b.send(elms[index], "#{@locate}": @value)
                .wait_until(&:exists?).click
-        MyLog.log.info("Button: #{button} has been selected")
+        MyLog.log.info("Button: #{@value} has been selected")
         true
       rescue StandardError
-        MyLog.log.warn("Button: #{button} does not exist")
+        MyLog.log.warn("Button: #{@value} does not exist")
         false
       end
     end

data/lib/functions/handlers/execute_system_command.rb

@@ -8,15 +8,13 @@ module TestSteps
     class ExecuteSystemCommand < Base
       register :execute_system_command
 
-      def perform(step_attributes)
-        syst_cmd = step_attributes[:testvalue]
-
-        b_result = system syst_cmd
+      def perform
+        b_result = system @value
         if b_result == true
-          MyLog.log.info("Cmd has been executed sucessfully #{syst_cmd}")
+          MyLog.log.info("Cmd has been executed sucessfully #{@value}")
           return true
         else
-          MyLog.log.warn("Theres a problem executing command #{syst_cmd}")
+          MyLog.log.warn("Theres a problem executing command #{@value}")
           return false
         end
       end

data/lib/functions/handlers/handle_browser_window.rb

@@ -8,16 +8,14 @@ module TestSteps
     class HandleBrowserWindow < Base
       register :handle_browser_window
 
-      def perform(step_attributes)
-        text_check = step_attributes[:testvalue]
-
-        Browser.b.window(title: text_check.to_s).use
+      def perform
+        Browser.b.window(title: @value.to_s).use
         sleep 3
-        Browser.b.title.eql?(text_check.to_s)
-        MyLog.log.info("Window title: #{text_check} is correct")
+        Browser.b.title.eql?(@value.to_s)
+        MyLog.log.info("Window title: #{@value} is correct")
         true
       rescue StandardError
-        MyLog.log.warn("Window not found: #{text_check}")
+        MyLog.log.warn("Window not found: #{@value}")
         false
       end
     end

data/lib/functions/handlers/ipause.rb

@@ -8,14 +8,12 @@ module TestSteps
     class Ipause < Base
       register :ipause
 
-      def perform(step_attributes)
-        wait_time = step_attributes[:testvalue]
-
-        sleep(wait_time.to_i)
-        MyLog.log.info('Wait completed for seconds: ' + wait_time.to_s)
+      def perform
+        sleep(@value.to_i)
+        MyLog.log.info('Wait completed for seconds: ' + @value.to_s)
         true
       rescue StandardError
-        MyLog.log.warn('Wait failed for seconds: ' + wait_time.to_s)
+        MyLog.log.warn('Wait failed for seconds: ' + @value.to_s)
         false
       end
     end

data/lib/functions/handlers/list_all_dropdowns_values.rb

@@ -8,17 +8,14 @@ module TestSteps
     class ListAllDropdownValues < Base
       register :list_all_dropdown_values
 
-      def perform(step_attributes)
-        dropdown = step_attributes[:testvalue]
-        locate = step_attributes[:locate]
-
-        Browser.b.element("#{locate}": dropdown).wait_until(&:exists?)
-        Browser.b.select_list("#{locate}": dropdown).options.each do |i|
-          MyLog.log.info("List of dropdown for #{dropdown} are: #{i.text}")
+      def perform
+        Browser.b.element("#{@locate}": @value).wait_until(&:exists?)
+        Browser.b.select_list("#{@locate}": @value).options.each do |i|
+          MyLog.log.info("List of dropdown for #{@value} are: #{i.text}")
           return true
         end
       rescue StandardError
-        MyLog.log.warn("List dropdown: #{dropdown} does not exist")
+        MyLog.log.warn("List dropdown: #{@value} does not exist")
         false
       end
     end

data/lib/functions/handlers/login.rb

@@ -8,20 +8,22 @@ module TestSteps
     class Login < Base
       register :login
 
-      def perform(step_attributes)
-        login_type = step_attributes[:testvalue]
-        user = step_attributes[:testvalue2]
+      def perform
+        user = @value2
         user = ENV[user.to_s] if ENV[user.to_s]
 
-        lc_login_type = login_type.downcase
-        case lc_login_type
+        login_user(user)
+      rescue StandardError
+        MyLog.log.error "unable to find login: #{@value}"
+        raise LoginTypeFailed
+      end
+
+      def login_user(user)
+        case @value.downcase
         when 'portal_login'
           portal_login(user)
         when 'sso_login'
           sso_login(user)
-        else
-          MyLog.log.error "unable to find login: #{lc_login_type}"
-          raise LoginTypeFailed
         end
       end
 

data/lib/functions/handlers/open_url.rb

@@ -8,15 +8,13 @@ module TestSteps
     class OpenUrl < Base
       register :open_url
 
-      def perform(step_attributes)
-        url = step_attributes[:testvalue]
-
+      def perform
         Browser.open_browser
 
-        url = if ENV[url]
-                ENV[url.to_s]
+        url = if ENV[@value]
+                ENV[@value.to_s]
               else
-                step_attributes[:testvalue]
+                @value
               end
         Browser.b.goto(url)
         OpenUrl.check_current_url(url)

data/lib/functions/handlers/ping_test.rb

@@ -9,18 +9,16 @@ module TestSteps
       register :ping_test
 
       # TODO: retry every 'x' until timeout reached.
-      def perform(step_attributes)
-        url = step_attributes[:testvalue]
-
-        check = Net::Ping::HTTP.new(url)
+      def perform
+        check = Net::Ping::HTTP.new(@value)
 
         check.ping?
         sleep 5
         if check.ping?
-          MyLog.log.info("pinged: #{url}")
+          MyLog.log.info("pinged: #{@value}")
           return true
         else
-          MyLog.log.warn("Failed to ping: #{url}")
+          MyLog.log.warn("Failed to ping: #{@value}")
           return false
         end
       end

data/lib/functions/handlers/radio_button.rb

@@ -8,18 +8,13 @@ module TestSteps
     class RadioButton < Base
       register :radio_button
 
-      def perform(step_attributes)
-        radio = step_attributes[:testvalue]
-        value2 = step_attributes[:testvalue2]
-        locate = step_attributes[:locate]
-        locate2 = step_attributes[:locate2]
-
-        Browser.b.radio("#{locate}": radio).wait_until(&:exists?)
-        Browser.b.radio("#{locate}": radio, "#{locate2}": value2.to_s).set
-        MyLog.log.info("Radio button: #{radio} has been selected")
+      def perform
+        Browser.b.radio("#{@locate}": @value).wait_until(&:exists?)
+        Browser.b.radio("#{@locate}": @value, "#{@locate2}": @value2.to_s).set
+        MyLog.log.info("Radio button: #{@value2} has been selected")
         true
       rescue StandardError
-        MyLog.log.warn("Radio button: #{radio} does not exist")
+        MyLog.log.warn("Radio button: #{@value2} does not exist")
         false
       end
     end

data/lib/functions/handlers/select_dropdown.rb

@@ -8,19 +8,15 @@ module TestSteps
     class SelectDropdown < Base
       register :select_dropdown
 
-      def perform(step_attributes)
-        dropdown = step_attributes[:testvalue]
-        value2 = step_attributes[:testvalue2]
-        locate = step_attributes[:locate]
-        locate2 = step_attributes[:locate2]
+      def perform
+        ele = Browser.b.select_list("#{@locate}": @value)
 
-        Browser.b.select_list("#{locate}": dropdown).wait_until(&:exists?)
-        Browser.b.select_list("#{locate}": dropdown).option("#{locate2}":
-                                                          value2.to_s).select
-        MyLog.log.info("Dropdown item: #{value2} has been selected")
+        ele.wait_until(&:exists?)
+        ele.option("#{@locate2}": @value2.to_s).select
+        MyLog.log.info("Dropdown item: #{@value2} has been selected")
         true
       rescue StandardError
-        MyLog.log.warn("Dropdown item: #{value2} has NOT been selected")
+        MyLog.log.warn("Dropdown item: #{@value2} has NOT been selected")
         false
       end
     end

data/lib/functions/handlers/send_special_keys.rb

@@ -8,15 +8,13 @@ module TestSteps
     class SendSpecialKeys < Base
       register :send_special_keys
 
-      def perform(step_attributes)
-        special_key = step_attributes[:testvalue]
-
-        Browser.b.send_keys :"#{special_key}"
+      def perform
+        Browser.b.send_keys :"#{@value}"
         sleep 1
-        MyLog.log.info("Browser Sent key: :#{special_key} successfully")
+        MyLog.log.info("Browser Sent key: :#{@value} successfully")
         true
       rescue StandardError
-        MyLog.log.warn("Browser Failed to Send key: :#{special_key}")
+        MyLog.log.warn("Browser Failed to Send key: :#{@value}")
         false
       end
     end

data/lib/functions/handlers/write_box_data.rb

@@ -8,16 +8,13 @@ module TestSteps
     class WriteBoxdata < Base
       register :write_box_data
 
-      def perform(step_attributes)
-        box = step_attributes[:testvalue]
-        value = step_attributes[:testvalue2]
-        locate = step_attributes[:locate]
-        txt = ENV[value.to_s] || step_attributes[:testvalue2]
-
+      def perform
+        txt = @value2
+        txt = ENV[txt.to_s] if ENV[txt.to_s]
         elms = %i[textarea text_field iframe]
 
         found_box = elms.map do |elm|
-          Browser.b.send(elm, "#{locate}": box).exists?
+          Browser.b.send(elm, "#{@locate}": @value).exists?
         end.compact
 
         raise 'Multiple matches' if found_box.select { |i| i }.empty?
@@ -25,12 +22,12 @@ module TestSteps
         index = found_box.index(true)
         return unless index
 
-        Browser.b.send(elms[index], "#{locate}": box)
+        Browser.b.send(elms[index], "#{@locate}": @value)
                .wait_until(&:exists?).send_keys txt
-        MyLog.log.info("Textbox: #{box} has correct value: #{txt}")
+        MyLog.log.info("Textbox: #{@value} has correct value: #{txt}")
         true
       rescue StandardError
-        MyLog.log.warn("Textbox: #{box} does not exist")
+        MyLog.log.warn("Textbox: #{@value} does not exist")
         false
       end
     end

data/lib/main.rb

@@ -10,30 +10,24 @@
 module Main
   require_relative './taf_config.rb'
 
-  begin
-     # variables to manage the failure reporting
-     $testStepPasses = 0
-     $testStepFailures   = 0
-     $testStepNotrun     = 0
-     $totalTestPasses    = 0
-     $totalTestFailures  = 0
-     $totalTestNotrun = 0
-     $previousTestFail = false
-     $currentTestFail = false
-     # parses the cmd line imput into the taf
-     CMDLine.cmdline_input
-   end
+  # parses the cmd line imput into the taf
+  CMDLine.cmdline_input
+
+  # get the overall test suite end time
+  ts_start_time = Report.current_time
 
   # process the test files to execute the tests
-  TestEngine.process_testfiles
+  total_passes, total_failures, total_skipped = TestEngine.process_testfiles
 
-  # get the overall test end time
-  $test_end_time = Report.current_time
+  # get the overall test suite end time
+  ts_end_time = Report.current_time
 
   # output the overall test summary
-  ReportSummary.print_overall_test_summary
-  JunitReport.test_summary_junit
+  ReportSummary.overall_test_summary(ts_start_time, ts_end_time, total_passes,
+                                     total_failures, total_skipped)
+  JunitReport.test_summary_junit(ts_start_time, ts_end_time, total_passes,
+                                 total_failures, total_skipped)
 
   # Exit status code.
-  Process.exit($totalTestFailures.zero? ? 0 : 1)
+  Process.exit(total_failures.zero? ? 0 : 1)
 end

data/lib/parser/json_parser.rb

@@ -12,14 +12,22 @@ module JsonParser
 
   def self.parse_test_header_data(parse_json)
     # get the number of test steps in the file
-    $numberOfTestSteps = parse_json['steps'].count
+    number_test_steps = parse_json['steps'].count
     # get the remaining test data
-    $testId = parse_json['testId']
-    $projectId    = parse_json['projectId']
-    $testDes      = parse_json['testDescription']
-    MyLog.log.info "Number of test steps: #{$numberOfTestSteps}"
-    MyLog.log.info "Test Description: #{$testDes}"
-    MyLog.log.info "TestID: #{$testId} \n"
+    @test_id = parse_json['testId']
+    @project_id = parse_json['projectId']
+    test_des = parse_json['testDescription']
+    MyLog.log.info "Number of test steps: #{number_test_steps}"
+    MyLog.log.info "Test Description: #{test_des}"
+    MyLog.log.info "TestID: #{@test_id} \n"
+  end
+
+  def self.test_id
+    @test_id
+  end
+
+  def self.project_id
+    @project_id
   end
 
   # parseTestStepData
@@ -31,7 +39,6 @@ module JsonParser
       locate: parse_json['value1'] || 'id',
       testvalue2: parse_json['value2'],
       locate2: parse_json['value3'] || 'id',
-      screenShotData: parse_json['screenshot'] == 'yes',
       skipTestCase: parse_json['skipTestCase'] == 'yes'
     }
 

data/lib/parser/parser.rb

@@ -11,7 +11,7 @@ module Parser
   require_relative '../taf_config.rb'
 
   def self.test_files
-    @test_files ||= Dir.glob("#{$testcasesFolder}/*.json").reject do |file|
+    @test_files ||= Dir.glob("#{CMDLine.tests_folder}/*.json").reject do |file|
       File.basename(file).start_with?('~$')
     end.sort
   end
@@ -22,7 +22,6 @@ module Parser
     file_type = File.extname(test_file_name)
     if file_type.casecmp('.json').zero?
       MyLog.log.info "Processing test file: #{test_file_name}"
-      MyLog.log.info "Browser Type: #{$browserType}"
       json = File.read(test_file_name)
       parse_json = JSON.parse(json)
 

data/lib/report/junit_report.rb

@@ -12,31 +12,35 @@ module JunitReport
   # holds printable test report summary for all the executed tests
   @test_step_report_summary2 = []
   # construct the test suite header for junit
-  def self.test_step_summary_xml(test_file_name, test_file_name_index)
+  def self.test_step_summary_xml(test_file_name, test_file_name_index,
+                                 tc_start, tc_end, metrics)
+    number_test_steps = [metrics.stepFailures, metrics.stepPasses,
+                         metrics.stepSkipped].sum
     @test_step_report_summary2[test_file_name_index] = {
       'classname' => test_file_name,
       'name' => test_file_name,
-      'assertions' => $numberOfTestSteps,
-      'failures' => $testStepFailures,
-      'tests' => $testStepPasses,
-      'skipped' => $testStepNotrun,
+      'assertions' => number_test_steps,
+      'failures' => metrics.stepFailures,
+      'tests' => metrics.stepPasses,
+      'skipped' => metrics.stepSkipped,
       'time' => TimeDifference.between(
-        $test_case_end_time, $test_case_start_time
+        tc_end, tc_start
       ).in_seconds
     }
   end
 
-  def self.test_summary_junit
+  def self.test_summary_junit(ts_start_time, ts_end_time, total_passes,
+                              total_failures, total_skipped)
     # output to XML file format for Junit for CI.
     builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
       testsuite_attrs = {
-        'classname' => $testcasesFolder.to_s,
-        'name' => $testcasesFolder.to_s,
-        'tests' => $totalTests.to_s,
-        'failures' => $totalTestFailures.to_s,
-        'timestamp' => $test_start_time.to_s,
-        'skipped' => $totalTestNotrun.to_s,
-        'time' => TimeDifference.between($test_end_time, $test_start_time)
+        'classname' => CMDLine.tests_folder.to_s,
+        'name' => CMDLine.tests_folder.to_s,
+        'tests' => total_passes.to_s,
+        'failures' => total_failures.to_s,
+        'timestamp' => ts_start_time.to_s,
+        'skipped' => total_skipped.to_s,
+        'time' => TimeDifference.between(ts_end_time, ts_start_time)
                                 .in_seconds
       }
       xml.testsuites(testsuite_attrs) do |testsuites|
@@ -58,7 +62,11 @@ module JunitReport
       end
     end
 
-    ts_summary_file_xml = File.open($TestSuiteSummaryXML, 'w')
+    # the test suite summary is a XML report generated will be called
+    # 'report_uuid.xml'
+    ts_xml_file = "#{$project_iddir}/report_#{SecureRandom.uuid}.xml"
+
+    ts_summary_file_xml = File.open(ts_xml_file, 'w')
     ts_summary_file_xml.write builder.to_xml
     ts_summary_file_xml.close
   end

data/lib/report/report.rb

@@ -22,8 +22,8 @@ module Report
 
     step = {
       'id' => test_step_idx,
-      'classname' => "SuiteID: #{$testId} Test Step: #{test_step_idx} "\
-      "#{test_desc}",
+      'classname' => "SuiteID: #{JsonParser.test_id}" \
+      " Test Step: #{test_step_idx} #{test_desc}",
       'name' => test_desc,
       'file' => test_file_name
     }
@@ -38,20 +38,20 @@ module Report
   end
 
   # print the Pass / Fail status of a test to the test results file
-  def self.test_pass_fail(pass_fail, test_file_name, test_step_idx)
+  def self.test_pass_fail(pass_fail, test_file_name, test_step_idx, metrics)
     if pass_fail == true
-      $previousTestFail = $currentTestFail
       $currentTestFail = false
-      $testStepPasses += 1
+      metrics.stepPasses += 1
       MyLog.log.info "Test #{test_step_idx} has Passed ".green
     elsif pass_fail == false
-      $previousTestFail = $currentTestFail
       $currentTestFail = true
-      $testStepFailures += 1
+      metrics.stepFailures += 1
       MyLog.log.info "Test #{test_step_idx} has FAILED ".red
+      sc_file_name = Screenshot.save_screenshot(test_step_idx)
       failstep = {
-        'message' => "SuiteID: #{$testId} Test Step: #{test_step_idx} Test has"\
-         ' FAILED - Check logs',
+        'message' => "SuiteID: #{JsonParser.test_id}" \
+        " Test Step: #{test_step_idx} Test has" \
+         " FAILED - Check logs, see Screenshot: #{sc_file_name}",
         'type' => 'FAILURE',
         'file' => test_file_name
       }
@@ -65,10 +65,11 @@ module Report
       $failtestStep_xml[test_file_name][test_step_idx] = failstep
     else
       $currentTestFail = false
-      $testStepNotrun += 1
+      metrics.stepSkipped += 1
       MyLog.log.info "Test #{test_step_idx} no checks performed ".blue
       skipstep = {
-        'message' => "SuiteID: #{$testId} Test Step: #{test_step_idx} No"\
+        'message' => "SuiteID: #{JsonParser.test_id}" \
+        " Test Step: #{test_step_idx} No" \
           ' checks performed - Check logs',
         'type' => 'SKIPPED',
         'file' => test_file_name
@@ -87,7 +88,7 @@ module Report
     test_duration = TimeDifference.between(
       test_end_time, @test_start_time
     ).humanize || 0
-    MyLog.log.info "Test step duration: #{test_duration}"
+    MyLog.log.info "Test step duration: #{test_duration} \n"
   end
 
   # check if the test failure threshold has been reached for total failures
@@ -95,7 +96,7 @@ module Report
   # If a certain number of consecutive tests fail then throw an exception
   def self.check_failure_threshold(test_file_name)
     consecutive_fail_threshold = 5
-    if $previousTestFail && $currentTestFail
+    if $currentTestFail
       @consecutive_test_fail += 1
     else
       @consecutive_test_fail = 0
@@ -105,11 +106,11 @@ module Report
 
     # write info to stdout
     MyLog.log.warn "Terminating the current test file: #{test_file_name} as" \
-      " the test failure threshold (#{$testStepFailures}) has been" \
+      " the test failure threshold (#{@consecutive_test_fail}) has been" \
       ' reached.'
     MyLog.log.warn '...continuing with the next test file (if there is one)'
 
     raise FailureThresholdExceeded,
-          "#{$testStepFailures} Test Steps Failed."
+          "test failure threshold (#{@consecutive_test_fail}) has been reached"
   end
 end

data/lib/report/report_summary.rb

@@ -12,23 +12,24 @@ module ReportSummary
   # holds printable test report summary for all the executed tests
   @test_step_report_summary = []
   # output the test results summary for the current test case
-  def self.test_step_summary(test_file_name, test_file_name_index)
+  def self.test_step_summary(test_file_name, test_file_name_index, metrics)
     @test_step_report_summary[test_file_name_index] = <<~TEXT
       Test file executed: #{test_file_name}
-      Browser type used: #{$browserType}
-      Browser version: #{Browser.browser_version}
-      There are: #{$testStepPasses} Passes
-      There are: #{$testStepFailures} Failures
-      There are: #{$testStepNotrun} Skipped Tests \n
+      Browser Type: #{CMDLine.browser_type}
+      Browser Version: #{Browser.browser_version}
+      There are: #{metrics.stepPasses} Passes
+      There are: #{metrics.stepFailures} Failures
+      There are: #{metrics.stepSkipped} Skipped Tests \n
     TEXT
   end
 
   # output the overall test results summary
-  def self.print_overall_test_summary
+  def self.overall_test_summary(ts_start_time, ts_end_time, total_passes,
+                                total_failures, total_skipped)
     # output to the console
 
     MyLog.log.info 'Finished processing all test files ' \
-      "from the following test folder: #{$testcasesFolder}"
+      "from the following test folder: #{CMDLine.tests_folder}"
     MyLog.log.info "Overall Test Summary: \n"
     @test_step_report_summary.each do |test_step_report_summary|
       test_step_report_summary.each_line do |line|
@@ -37,16 +38,17 @@ module ReportSummary
     end
 
     duration = TimeDifference.between(
-      $test_end_time, $test_start_time
+      ts_end_time, ts_start_time
     ).humanize || 0
 
-    MyLog.log.info "Total Tests started at: #{$test_start_time}"
-    MyLog.log.info "Total Tests finished at: #{$test_end_time}"
+    MyLog.log.info "Total Tests started at: #{ts_start_time}"
+    MyLog.log.info "Total Tests finished at: #{ts_end_time}"
     MyLog.log.info "Total Tests duration: #{duration}"
-    MyLog.log.info "Total Tests Passed: #{$totalTestPasses}".green
-    MyLog.log.info "Total Tests Failed: #{$totalTestFailures}".red
-    MyLog.log.info "Total Tests Skipped: #{$totalTestNotrun}".blue
-    $totalTests = [$totalTestPasses, $totalTestFailures, $totalTestNotrun].sum
-    MyLog.log.info "Total Tests: #{$totalTests}\n"
+    MyLog.log.info "Total Tests Passed: #{total_passes}".green
+    MyLog.log.info "Total Tests Failed: #{total_failures}".red
+    MyLog.log.info "Total Tests Skipped: #{total_skipped}".blue
+    total_tests = [total_passes, total_failures,
+                   total_skipped].sum
+    MyLog.log.info "Total Tests: #{total_tests}\n"
   end
 end

data/lib/utils/browser.rb

@@ -11,7 +11,7 @@ module Browser
   require_relative '../taf_config.rb'
   # open_browser function
   def self.open_browser
-    lc_browser_type = $browserType.downcase
+    lc_browser_type = CMDLine.browser_type.downcase
     case lc_browser_type
     when 'chrome'
       chrome
@@ -38,7 +38,6 @@ module Browser
     @browser = Watir::Browser.new :chrome, switches: %w[
       --acceptInsecureCerts-true --start-maximized --window-size=1920,1080
     ]
-    browser_version
   end
 
   # chrome headless browser details
@@ -47,7 +46,6 @@ module Browser
       --start-maximized --disable-gpu --headless --acceptInsecureCerts-true
       --no-sandbox --window-size=1920,1080
     ]
-    browser_version
   end
 
   # firefox browser details
@@ -57,7 +55,6 @@ module Browser
     driver = Selenium::WebDriver.for(:firefox, desired_capabilities: caps)
     @browser = Watir::Browser.new(driver)
     browser_full_screen
-    browser_version
   end
 
   # firefox headless browser details
@@ -71,8 +68,6 @@ module Browser
     # makes the browser full screen.
     @browser.driver.manage.window.resize_to(1920, 1200)
     @browser.driver.manage.window.move_to(0, 0)
-    browser_version
-    # browser
   end
 
   # makes the browser full screen.
@@ -90,7 +85,13 @@ module Browser
 
   # Check browser version
   def self.browser_version
-    @browser.driver.capabilities[:version]
+    browser_name = CMDLine.browser_type.downcase
+    case browser_name
+    when 'chrome', 'chrome-headless'
+      @browser.driver.capabilities[:version]
+    when 'firefox', 'firefox-headless'
+      @browser.execute_script('return navigator.userAgent;').split('/')[-1]
+    end
   rescue StandardError
     'No Browser version'
   end

data/lib/utils/cmd_line.rb

@@ -36,9 +36,9 @@ module CMDLine
         ' chrome-headless, firefox, firefox-headless'
       ) do |b|
         options[:browser] = b
-        $browserType = options[:browser]
+        @browser_type = options[:browser]
         unless ['chrome', 'chrome-headless', 'firefox', 'firefox-headless']
-               .include?($browserType)
+               .include?(@browser_type)
           MyLog.log.warn 'A valid Browser has not been supplied as a' \
             ' command-line parameter as expected'
           Process.exit
@@ -47,7 +47,7 @@ module CMDLine
 
       parser.on('-t', '--tests testfolder', 'i.e. tests/') do |t|
         options[:testfolder] = t
-        $testcasesFolder = options[:testfolder]
+        @tests_folder = options[:testfolder]
         if Parser.test_files.size.positive?
           MyLog.log.info "There are: #{Parser.test_files.size}" \
             ' test files to process'
@@ -60,4 +60,12 @@ module CMDLine
       end
     end.parse!
   end
+
+  def self.browser_type
+    @browser_type
+  end
+
+  def self.tests_folder
+    @tests_folder
+  end
 end

data/lib/utils/create_directories.rb

@@ -17,25 +17,16 @@ module CreateDirectories
   #
   # ------->directory named after the test run ID UUID
 
-  def self.time_now
-    Time.new.strftime('%d-%b-%Y_%H_%M')
-  end
-
   def self.construct_projectdirs
     # create top-level directory if it doesn't already exist:
     # Results/Project_id
-    project_id = $projectId.delete(' ')
+    project_id = JsonParser.project_id.delete(' ')
     $project_iddir = File.join('Results', project_id)
 
     FileUtils.mkdir_p($project_iddir)
 
     # Generate UUID
     $run_uuid = SecureRandom.uuid
-
-    # the test suite summary is a XML report generated will be called
-    # 'suite_summary.xml'
-    $TestSuiteSummaryXML = "Results/#{project_id}/#{time_now}" \
-                           '_test_result.xml'
   end
 
   def self.construct_testspecdirs

data/lib/utils/screenshot.rb

@@ -10,30 +10,18 @@
 module Screenshot
   require_relative '../taf_config.rb'
 
-  # create screenshot filename and save the screenshot if the test has failed or
-  # if explictly required
-  def self.save_screenshot(screen_shot, test_step_idx)
-    if $currentTestFail || screen_shot
-      time = Time.now.strftime('%H%M')
-      sc_dir = CreateDirectories.construct_testspecdirs
+  # create screenshot filename and save the screenshot if the test has failed.
+  def self.save_screenshot(test_step_idx)
+    time = Time.now.strftime('%H%M')
+    sc_dir = CreateDirectories.construct_testspecdirs
 
-      sc_file_name = if $currentTestFail
-                       "#{sc_dir}/Test_ID-#{$testId.delete(' ')}"\
-                        "_Test_step-#{test_step_idx}_Failed"\
-                        "_#{time}.png"
-                     else
-                       "#{sc_dir}/Test_ID-#{$testId.delete(' ')}"\
-                        "_Test_step-#{test_step_idx}_#{time}.png"
-                     end
+    sc_file_name = "#{sc_dir}/Test_ID-#{JsonParser.test_id.delete(' ')}"\
+                      "_Test_step-#{test_step_idx}_Failed_#{time}.png"
 
-      # Screenshot capture for websites
-      Browser.b.screenshot.save sc_file_name
-      MyLog.log.info("Screenshot saved to: #{sc_file_name} \n")
-    else
-      MyLog.log.debug "No screenshot requested \n"
-    end
-
-    # if any issues with saving the screenshot then log a warning
+    # Screenshot capture for websites
+    Browser.b.screenshot.save sc_file_name
+    MyLog.log.info("Screenshot saved to: #{sc_file_name} \n")
+    sc_file_name
   rescue StandardError => e
     # construct the error message from custom text and the actual system
     # error message (converted to a string).

data/lib/utils/test_engine.rb

@@ -12,11 +12,15 @@ module TestEngine
 
   # process the test files to execute the tests
   def self.process_testfiles
-    # get the overall test start time
-    $test_start_time = Report.current_time
+    total_passes = 0
+    total_failures = 0
+    total_skipped = 0
 
     # loop through all the available test files to execute the tests
     Parser.test_files.each_with_index do |test_file_name, test_file_index|
+      metrics = Struct.new(:stepPasses, :stepFailures, :stepSkipped)
+                      .new(0, 0, 0)
+
       begin
         # read in the test data
         tests = Parser.read_test_data(test_file_name)
@@ -32,9 +36,7 @@ module TestEngine
       CreateDirectories.construct_projectdirs
 
       # get the test case start time
-      $test_case_start_time = Report.current_time
-      # initialise the test end time
-      $test_case_end_time = Report.current_time
+      tc_start = Report.current_time
 
       begin
         tests['steps'].each_with_index do |test_step, test_step_idx|
@@ -44,10 +46,7 @@ module TestEngine
 
           # process the test step data
           TestSteps.process_test_steps(test_file_name, test_step_idx,
-                                       parsed_steps)
-          # see if screenshot required
-          Screenshot.save_screenshot(parsed_steps[:screenShotData],
-                                     test_step_idx)
+                                       parsed_steps, metrics)
         end
       rescue TafError => e
         warn e
@@ -55,24 +54,24 @@ module TestEngine
       end
 
       # get the test case end time
-      $test_case_end_time = Report.current_time
+      tc_end = Report.current_time
 
       # output the test results summary for the current test case,
       # pass in the test file number to save the summary against it's testfile
-      ReportSummary.test_step_summary(test_file_name, test_file_index)
-      JunitReport.test_step_summary_xml(test_file_name, test_file_index)
+      ReportSummary.test_step_summary(test_file_name, test_file_index, metrics)
+      JunitReport.test_step_summary_xml(test_file_name, test_file_index,
+                                        tc_start, tc_end, metrics)
 
       # close the browser if created
       Browser.b.quit
 
       # record total passes and failures and reset the failure counters for
       # the test steps
-      $totalTestPasses   += $testStepPasses
-      $totalTestFailures += $testStepFailures
-      $totalTestNotrun   += $testStepNotrun
-      $testStepPasses   = 0
-      $testStepFailures = 0
-      $testStepNotrun   = 0
+      total_passes   += metrics.stepPasses
+      total_failures += metrics.stepFailures
+      total_skipped  += metrics.stepSkipped
     end
+
+    [total_passes, total_failures, total_skipped]
   end
 end

data/lib/utils/test_steps.rb

@@ -16,7 +16,8 @@ module TestSteps
 
   # process the test step data by matching the test step functions and
   # processing the associated data accordingly
-  def self.process_test_steps(test_file_name, test_step_idx, step_attributes)
+  def self.process_test_steps(test_file_name, test_step_idx, step_attributes,
+                              metrics)
     # print the test step information
     Report.print_test_step_header(test_file_name, test_step_idx,
                                   step_attributes[:testdesc])
@@ -26,7 +27,7 @@ module TestSteps
 
     if handler.respond_to?(:perform)
       func = handler.perform(step_attributes) if runtest == false
-      Report.test_pass_fail(func, test_file_name, test_step_idx)
+      Report.test_pass_fail(func, test_file_name, test_step_idx, metrics)
       Report.check_failure_threshold(test_file_name)
       return true
     else

data/lib/version.rb

@@ -3,7 +3,7 @@
 module Taf
   # This module holds the TAF version information.
   module Version
-    STRING = '0.3.5'
+    STRING = '0.3.6'
 
     MSG = '%<version>s (using Parser %<parser_version>s, running on ' \
           '%<ruby_engine>s %<ruby_version>s %<ruby_platform>s)'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taf
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - Andy Perrett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-16 00:00:00.000000000 Z
+date: 2019-05-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler