taf 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c5a4ea4d70ac8bd18bd9e90fa0b0b1615e036669df29d789105cec6aa5d74e09
-  data.tar.gz: 4d62ee8db6590f1ed95be8dbabdb2db2e220d9e5f5bad68d73b1266eb8cf084b
+  metadata.gz: 47c34f68219bf7188b916a891f7a86f4d14b08a437d08201382e7f3202e21143
+  data.tar.gz: 501befb0dc3bf630031a1094df678c1fa100e3be6c31d799dd914ac173e83938
 SHA512:
-  metadata.gz: e7f1b953e22f15a8152110c5621c824535efb13e0921c6961a07e90cb1f3165a0ead74a87ccf8502c0c086a4c7899c74c55a4934cf2952d271f2045df28647d0
-  data.tar.gz: dddad76d0929978d394fa1e8639288b84ecf445fa4d79a03e81d34b7a1168445c08dbbdb82f2ab71168ca3324ff4702b5db2b0c3a9104e5aa88c37b9e8ce3d56
+  metadata.gz: d1a1b0383b4d37a35b566a2739601f8818f887b9b8ac6e25702fde9ffa39416595c5f806fa8e6f550e008da6b7cbbb486fe105de60abb0b29dd53cfcb87f77b8
+  data.tar.gz: a3c32e949362a648f88e797185fa0883a8d010085b21d18a390ad5e6274f298eb31c6234bce00c15933dddb6ae01ed46a6cafb69c7b43fe00071db44918254ac

data/lib/functions/handlers/base_handler.rb

@@ -62,18 +62,18 @@ module TestSteps
         password = ENV['PORTAL_MEM']
         nums = (1..256).to_a
         found_mem_nums = nums.each_with_object([]) do |num_val, mem_word|
-        elm_id = "user_memorable_parts_#{num_val}"
-        mem_word.push(num_val) if Browser.b.select(:id => elm_id).exist?
+          elm_id = "user_memorable_parts_#{num_val}"
+          mem_word.push(num_val) if Browser.b.select(id: elm_id).exist?
         end.compact
 
         array_password = password.split('')
         array_password.map!(&:upcase)
 
-        found_mem_nums.each { |mem_num|
-        char = array_password[(mem_num-1)]
-        elm_id = "user_memorable_parts_#{mem_num}"
-        Browser.b.select_list(:id => elm_id).option(:value => "#{char}").select
-        }
+        found_mem_nums.each do |mem_num|
+          char = array_password[(mem_num - 1)]
+          elm_id = "user_memorable_parts_#{mem_num}"
+          Browser.b.select_list(id: elm_id).option(value: char.to_s).select
+        end
 
         Browser.b.button(value: 'Sign in').wait_until(&:exists?).click
         if Browser.b.title.eql?(b_title_sucess)
@@ -84,6 +84,6 @@ module TestSteps
           return false
         end
       end
-    end 
+    end
   end
-end
+end

data/lib/functions/handlers/browser_back.rb

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

data/lib/functions/handlers/browser_forward.rb

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

data/lib/functions/handlers/browser_quit.rb

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

data/lib/functions/handlers/browser_refresh.rb

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

data/lib/functions/handlers/capture_alert.rb

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

data/lib/functions/handlers/check_box.rb

@@ -18,4 +18,4 @@ module TestSteps
       end
     end
   end
-end
+end

data/lib/functions/handlers/check_boxdata.rb

@@ -14,10 +14,12 @@ module TestSteps
           Browser.b.textarea(:"#{locate}" => box).exist?,
           Browser.b.text_field(:"#{locate}" => box).exist?
         ]
-    
+
         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)
@@ -36,4 +38,4 @@ module TestSteps
       end
     end
   end
-end
+end

data/lib/functions/handlers/check_browser_title.rb

@@ -8,7 +8,7 @@ module TestSteps
       def perform(step_attributes)
         b_title = step_attributes[:testvalue]
 
-        Browser.b.wait_until { Browser.b.title.eql? (b_title)}
+        Browser.b.wait_until { Browser.b.title.eql? b_title }
         MyLog.log.info("Browser title: #{b_title}")
         true
       rescue StandardError

data/lib/functions/handlers/check_logs.rb

@@ -20,4 +20,4 @@ module TestSteps
       end
     end
   end
-end
+end

data/lib/functions/handlers/check_screendata.rb

@@ -8,7 +8,7 @@ module TestSteps
       def perform(step_attributes)
         check_text = step_attributes[:testvalue]
 
-        Browser.b.wait_until { Browser.b.element.text.include? (check_text)}
+        Browser.b.wait_until { Browser.b.element.text.include? check_text }
         MyLog.log.info("Text found: #{check_text}")
         true
       rescue StandardError

data/lib/functions/handlers/check_url.rb

@@ -18,4 +18,4 @@ module TestSteps
       end
     end
   end
-end
+end

data/lib/functions/handlers/click_button.rb

@@ -9,13 +9,14 @@ module TestSteps
         button = step_attributes[:testvalue]
         locate = step_attributes[:locate]
 
-        elms = %i{button span a div link image h1 h2 h3 h4}
+        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?
         end.compact
 
         raise 'Multiple matches' if found_button.select { |i| i }.empty?
+
         index = found_button.index(true)
         return unless index
 
@@ -49,4 +50,4 @@ module TestSteps
       end
     end
   end
-end
+end

data/lib/functions/handlers/execute_system_command.rb

@@ -19,4 +19,4 @@ module TestSteps
       end
     end
   end
-end
+end

data/lib/functions/handlers/handle_browser_window.rb

@@ -19,4 +19,4 @@ module TestSteps
       end
     end
   end
-end
+end

data/lib/functions/handlers/insert_value_config.rb

@@ -24,4 +24,4 @@ module TestSteps
       end
     end
   end
-end
+end

data/lib/functions/handlers/ipause.rb

@@ -17,4 +17,4 @@ module TestSteps
       end
     end
   end
-end
+end

data/lib/functions/handlers/list_all_dropdowns_values.rb

@@ -12,7 +12,7 @@ module TestSteps
         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}")
-        return true
+          return true
         end
       rescue StandardError
         MyLog.log.warn("List dropdown: #{dropdown} does not exist")
@@ -20,4 +20,4 @@ module TestSteps
       end
     end
   end
-end
+end

data/lib/functions/handlers/open_portal_url.rb

@@ -21,4 +21,4 @@ module TestSteps
       end
     end
   end
-end
+end

data/lib/functions/handlers/open_url.rb

@@ -22,4 +22,4 @@ module TestSteps
       end
     end
   end
-end
+end

data/lib/functions/handlers/ping_test.rb

@@ -5,21 +5,20 @@ module TestSteps
     class PingTest < Base
       register :ping_test
 
+      # TODO: retry every 'x' until timeout reached.
       def perform(step_attributes)
         url = step_attributes[:testvalue]
 
-        while check = Net::Ping::HTTP.new(url)
-          check.ping?
-          sleep 5
-          if check.ping? == true
-            # website alive
-            MyLog.log.info("pinged: #{url}")
-            return true
-          else
-            # website not responding
-            MyLog.log.warn("Failed to ping: #{url}")
-            return false
-          end
+        check = Net::Ping::HTTP.new(url)
+
+        check.ping?
+        sleep 5
+        if check.ping?
+          MyLog.log.info("pinged: #{url}")
+          return true
+        else
+          MyLog.log.warn("Failed to ping: #{url}")
+          return false
         end
       end
     end

data/lib/functions/handlers/portal_login.rb

@@ -15,7 +15,7 @@ module TestSteps
         b_title_sucess = 'Home '
         user_elm = 'user_email'
         pass_elm = 'user_password'
-        
+
         open_url_process(url)
         login_process(b_title, user_elm, pass_elm, user, pass)
         mem_word_check(user, b_title_sucess)

data/lib/functions/handlers/radio_button.rb

@@ -12,7 +12,7 @@ module TestSteps
         locate2 = step_attributes[:locate2]
 
         Browser.b.radio(:"#{locate}" => radio).wait_until(&:exists?)
-        Browser.b.radio(:"#{locate}" => radio, :"#{locate2}" => "#{value2}").set
+        Browser.b.radio(:"#{locate}" => radio, :"#{locate2}" => value2.to_s).set
         MyLog.log.info("Radio button: #{radio} has been selected")
         true
       rescue StandardError
@@ -21,4 +21,4 @@ module TestSteps
       end
     end
   end
-end
+end

data/lib/functions/handlers/select_dropdown.rb

@@ -12,7 +12,7 @@ module TestSteps
         locate2 = step_attributes[:locate2]
 
         Browser.b.select_list(:"#{locate}" => dropdown).wait_until(&:exists?)
-        Browser.b.select_list(:"#{locate}" => dropdown).option(:"#{locate2}" => "#{value2}").select
+        Browser.b.select_list(:"#{locate}" => dropdown).option(:"#{locate2}" => value2.to_s).select
         MyLog.log.info("Dropdown item: #{value2} has been selected")
         true
       rescue StandardError
@@ -24,4 +24,4 @@ module TestSteps
       end
     end
   end
-end
+end

data/lib/functions/handlers/send_special_keys.rb

@@ -18,4 +18,4 @@ module TestSteps
       end
     end
   end
-end
+end

data/lib/functions/handlers/write_box_data.rb

@@ -14,10 +14,12 @@ module TestSteps
           Browser.b.textarea(:"#{locate}" => box).exist?,
           Browser.b.text_field(:"#{locate}" => box).exist?
         ]
-    
+
         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?).set value
           (Browser.b.textarea(:"#{locate}" => box).value == value)
@@ -36,4 +38,4 @@ module TestSteps
       end
     end
   end
-end
+end

data/lib/functions/handlers/write_to_editor.rb

@@ -23,4 +23,4 @@ module TestSteps
       end
     end
   end
-end
+end

data/lib/main.rb

@@ -10,58 +10,70 @@
 module Main
   require_relative './taf_config.rb'
 
-  begin
-    # holds list of test file names read from the input file
-    test_file_names = []
+  def self.cmdline_input
+    # check if the test suite file name exists on the command line
+    # allow a user to input 2 arguments in to CMD line the 2 values are:
+    # Testcase Folder and Browser.
+    options = {}
+    ARGV.push('-h') if ARGV.empty?
+    OptionParser.new do |parser|
+      # Whenever we see -b, -t or --browser, or --tests with an
+      # argument, save the argument.
+      parser.banner = 'Usage: taf [options]'
+      parser.on('-h', '--help', "2 arguments are required: {Browser} {Testcase folder}'") do
+        puts parser
+        Process.exit
+      end
 
-    # variables to manage the failure reporting
-    $testStepPasses     = 0
-    $testStepFailures   = 0
-    $testStepNotrun     = 0
-    $totalTestPasses    = 0
-    $totalTestFailures  = 0
-    $totalTestNotrun = 0
-    $previousTestFail = false
-    $currentTestFail = false
-    # initialised stores for the input xlsx test data
-    $XlsxDoc = ''
+      parser.on('-b', '--browser browser', 'Supported Browsers: chrome, chrome-headless, firefox, firefox-headless.') do |b|
+        options[:browser] = b
+        $browserType = options[:browser]
+        unless ['chrome', 'chrome-headless', 'firefox', 'firefox-headless'].include?($browserType)
+          MyLog.log.warn 'A valid Browser has not been supplied as a command-line parameter as expected'
+          Process.exit
+        end
+      end
 
-    begin
-      # check if the test suite file name exists on the command line
-      # allow a user to input 2 arguments in to CMD line the 2 values are:
-      # Testcase Folder and Browser.
-      if ARGV.length < 3
-        $testcasesFolder = ARGV[0]
-        $browserType = ARGV[1]
-        MyLog.log.info '2 arguments are required: {Testcase folder} {Browser}'
-      else
-        # unable to open file as not supplied as command-line parameter
-        $testcasesFolder = 'unknown'
-        error_to_display = 'Test case location has not been supplied as a command-line parameter as expected'
-        $browserType = 'unknown'
-        error_to_display = 'Browser has not been supplied as a command-line parameter as expected'
-        raise IOError, error_to_display  
+      parser.on('-t', '--tests testfolder', 'i.e. tests/') do |t|
+        options[:testfolder] = t
+        $testcasesFolder = options[:testfolder]
+        if Parser.test_files.size.positive?
+          MyLog.log.info "There are: #{Parser.test_files.size} test files to process"
+          MyLog.log.info "List of Tests files: #{Parser.test_files} \n"
+        else
+          MyLog.log.warn 'A valid Test case location has not been supplied as a command-line parameter as expected'
+          Process.exit
+        end
       end
-  # unable to read the test file then handle the error and terminate
-  rescue StandardError => error
-    warn error
-    MyLog.log.warn error
-    abort
+    end.parse!
   end
 
-    MyLog.log.info "There are: #{Parser.test_files.size} test files to process \n"
+  begin
+     # variables to manage the failure reporting
+     $testStepPasses     = 0
+     $testStepFailures   = 0
+     $testStepNotrun     = 0
+     $totalTestPasses    = 0
+     $totalTestFailures  = 0
+     $totalTestNotrun = 0
+     $previousTestFail = false
+     $currentTestFail = false
+     # initialised stores for the input xlsx test data
+     $XlsxDoc = ''
+     # parses the cmd line imput into the taf
+     Main.cmdline_input
+   end
 
-    # process the test files to execute the tests
-    TestEngine.process_testfiles
+  # process the test files to execute the tests
+  TestEngine.process_testfiles
 
-    # get the overall test end time
-    $test_end_time = Report.current_time
+  # get the overall test end time
+  $test_end_time = Report.current_time
 
-    # output the overall test summary
-    ReportSummary.print_overall_test_summary
-    JunitReport.test_summary_junit
+  # output the overall test summary
+  ReportSummary.print_overall_test_summary
+  JunitReport.test_summary_junit
 
-    # Exit status code.
-    Process.exit($totalTestFailures.zero? ? 0 : 1 )
-  end
+  # Exit status code.
+  Process.exit($totalTestFailures.zero? ? 0 : 1)
 end

data/lib/parser/parser.rb

@@ -8,7 +8,7 @@
 module Parser
   require_relative '../taf_config.rb'
   # variables:
-  @XlsxFileNameType = '.xlsx'
+  @xlsx_file_name_type = '.xlsx'
 
   def self.test_files
     @test_files ||= Dir.glob("#{$testcasesFolder}/*.xlsx").reject do |file|
@@ -17,20 +17,20 @@ module Parser
   end
 
   # readTestData
-  def self.read_test_data(testFileName)
+  def self.read_test_data(test_file_name)
     # get the file type
-    fileType = File.extname(testFileName)
-    if (fileType.casecmp(@XlsxFileNameType) == 0)
-      MyLog.log.info "Processing test file: #{testFileName}"
+    file_type = File.extname(test_file_name)
+    if file_type.casecmp(@xlsx_file_name_type).zero?
+      MyLog.log.info "Processing test file: #{test_file_name}"
       MyLog.log.info "Browser Type: #{$browserType}"
-      $xlsxDoc = RubyXL::Parser.parse(testFileName)
+      $xlsxDoc = RubyXL::Parser.parse(test_file_name)
       XlsxParser.parse_xlxs_test_header_data
       return 'XLSX'
     else
       # if unable to read the test file list then construct a custom error
       # message and raise an exception.
-      error_to_display = "Test File Name: '#{testFileName}' " \
-                         "type not recognised (must be .xslx)"
+      error_to_display = "Test File Name: '#{test_file_name}' " \
+                         'type not recognised (must be .xslx)'
       raise IOError, error_to_display
     end
 
@@ -41,7 +41,7 @@ module Parser
   end
 
   # parseTestStepData
-  def self.parse_test_step_data(testFileType)
-    XlsxParser.parse_test_step_data(testFileType)
+  def self.parse_test_step_data(test_file_type)
+    XlsxParser.parse_test_step_data(test_file_type)
   end
 end

data/lib/report/junit_report.rb

@@ -39,10 +39,10 @@ module JunitReport
       xml.testsuites(testsuite_attrs) do |testsuites|
         @testStepReportSummary2.each do |testStepReportSummary2|
           testsuites.testsuite(testStepReportSummary2) do |testsuite|
-            $testStep_xml[testStepReportSummary2['name']].each do |testStepIndex, testStep_xml|
+            $testStep_xml[testStepReportSummary2['name']].each do |test_step_index, testStep_xml|
               testsuite.testcase(testStep_xml) do |testcase|
-                failure = $failtestStep_xml&.[](testStepReportSummary2['name'])&.[](testStepIndex)
-                skipped = $skiptestStep_xml&.[](testStepReportSummary2['name'])&.[](testStepIndex)
+                failure = $failtestStep_xml&.[](testStepReportSummary2['name'])&.[](test_step_index)
+                skipped = $skiptestStep_xml&.[](testStepReportSummary2['name'])&.[](test_step_index)
                 testcase.failure(failure) if failure
                 testcase.skipped(skipped) if skipped
               end

data/lib/report/report.rb

@@ -9,53 +9,47 @@
 # report.rb - methods for outputting console.
 module Report
   require_relative '../taf_config.rb'
-  # setup the test results output file
-  # results file variable
-  def self.results
-    results_file = @results_file
-  end
 
   # get the current time in the format Day - Month - Date - Time (HH:MM:SS)
   def self.current_time
-    time = Time.new
-    f_time = time.strftime('%a %b %d %H:%M:%S %Z')
-    f_time
+    Time.new.strftime('%a %b %d %H:%M:%S %Z')
   end
 
   # print the test Step info to the test results file
-  def self.print_test_step_header(test_file_name, testStepIndex)
-    MyLog.log.info "Test start time: #{f_time = current_time}"
-    MyLog.log.info "Test step: #{$testStep} : #{$testStepDes}"
+  def self.print_test_step_header(test_file_name, test_step_index)
+    MyLog.log.info "Test start time: #{current_time}"
+    MyLog.log.info "Test step: #{$test_step} : #{$test_step_des}"
 
     step = {
-      'id' => $testStep,
-      'classname' => 'SuiteID: ' + $testId.to_s + ' Test Step: ' + $testStep.to_s + ' ' + $testStepDes.to_s,
-      'name' => $testStepDes,
+      'id' => $test_step,
+      'classname' => 'SuiteID: ' + $testId.to_s + ' Test Step: ' + $test_step.to_s + ' ' + $test_step_des.to_s,
+      'name' => $test_step_des,
       'file' => test_file_name
     }
     # output to console to show test step
     # puts step
 
     return unless test_file_name
+
     $testStep_xml ||= {}
     $testStep_xml[test_file_name] ||= {}
-    $testStep_xml[test_file_name][testStepIndex] = step
+    $testStep_xml[test_file_name][test_step_index] = step
   end
 
   # print the Pass / Fail status of a test to the test results file
-  def self.test_pass_fail(passFail, test_file_name, testStepIndex)
-    if passFail == true
+  def self.test_pass_fail(pass_fail, test_file_name, test_step_index)
+    if pass_fail == true
       $previousTestFail = $currentTestFail
       $currentTestFail = false
       $testStepPasses += 1
-      MyLog.log.info "Test #{$testStep} has Passed ".green
-    elsif passFail == false
+      MyLog.log.info "Test #{$test_step} has Passed ".green
+    elsif pass_fail == false
       $previousTestFail = $currentTestFail
       $currentTestFail = true
       $testStepFailures += 1
-      MyLog.log.info "Test #{$testStep} has FAILED ".red
+      MyLog.log.info "Test #{$test_step} has FAILED ".red
       failstep = {
-        'message' => 'SuiteID: ' + $testId.to_s + ' Test Step: ' + $testStep.to_s + ' Test has FAILED - Check logs',
+        'message' => 'SuiteID: ' + $testId.to_s + ' Test Step: ' + $test_step.to_s + ' Test has FAILED - Check logs',
         'type' => 'FAILURE',
         'file' => test_file_name
       }
@@ -63,15 +57,16 @@ module Report
       # puts failstep
 
       return unless test_file_name
+
       $failtestStep_xml ||= {}
       $failtestStep_xml[test_file_name] ||= []
-      $failtestStep_xml[test_file_name][testStepIndex] = failstep
+      $failtestStep_xml[test_file_name][test_step_index] = failstep
     else
       $currentTestFail = false
       $testStepNotrun += 1
-      MyLog.log.info "Test #{$testStep} no checks performed ".blue
+      MyLog.log.info "Test #{$test_step} no checks performed ".blue
       skipstep = {
-        'message' => 'SuiteID: ' + $testId.to_s + ' Test Step: ' + $testStep.to_s + ' No checks performed - Check logs',
+        'message' => 'SuiteID: ' + $testId.to_s + ' Test Step: ' + $test_step.to_s + ' No checks performed - Check logs',
         'type' => 'SKIPPED',
         'file' => test_file_name
       }
@@ -79,30 +74,33 @@ module Report
       # puts skipstep
 
       return unless test_file_name
+
       $skiptestStep_xml ||= {}
       $skiptestStep_xml[test_file_name] ||= []
-      $skiptestStep_xml[test_file_name][testStepIndex] = skipstep
-  end
-    MyLog.log.info "Test end time: #{f_time = current_time}"
+      $skiptestStep_xml[test_file_name][test_step_index] = skipstep
+    end
+    MyLog.log.info "Test end time: #{current_time}"
   end
 
   # check if the test failure threshold has been reached for total failures or consecutive failures.
   # If a certain number of consecutive tests fail then throw an exception
-  def self.check_failure_threshold(test_file_name, testStepIndex)
-    consecutiveFailThreshold = 5
+  def self.check_failure_threshold(test_file_name, _test_step_index)
+    consecutive_fail_threshold = 5
     if $previousTestFail && $currentTestFail
-      @consecutiveTestFail += 1
+      @consecutive_test_fail += 1
     else
-      @consecutiveTestFail = 0
+      @consecutive_test_fail = 0
     end
 
-    if @consecutiveTestFail >= consecutiveFailThreshold
-      # write info to stdout
-      MyLog.log.warn "Terminating the current test case: #{test_file_name} as the test failure threshold (#{consecutiveFailThreshold}) has been reached."
-      MyLog.log.warn '...continuing with the next test case (if there is one)'
+    return if @consecutive_test_fail < consecutive_fail_threshold
 
-      raise FailureThresholdExceeded,
-            "#{consecutiveFailThreshold} Test Steps Failed."
-    end
+    # write info to stdout
+    MyLog.log.warn "Terminating the current test case: #{test_file_name} as" \
+      " the test failure threshold (#{consecutive_fail_threshold}) has been " \
+      ' reached.'
+    MyLog.log.warn '...continuing with the next test case (if there is one)'
+
+    raise FailureThresholdExceeded,
+          "#{consecutive_fail_threshold} Test Steps Failed."
   end
 end

data/lib/report/report_summary.rb

@@ -30,7 +30,7 @@ module ReportSummary
     # output to the console
 
     MyLog.log.info "Finished processing all test files - executed via test suite: #{$testcasesFolder}"
-    MyLog.log.info "Overall Test Summary:"
+    MyLog.log.info "Overall Test Summary: \n"
     @testStepReportSummary.each do |testStepReportSummary|
       testStepReportSummary.each_line do |line|
         MyLog.log.info(line.strip)

data/lib/taf_config.rb

@@ -19,6 +19,7 @@ require 'nokogiri'
 require 'time_difference'
 require 'colored'
 require 'rubyXL'
+require 'optparse'
 
 # list of all the required files
 require_relative './utils/test_steps'

data/lib/utils/browser.rb

@@ -30,7 +30,7 @@ module Browser
   rescue BrowserFailedOpen => error
     # construct the error message from custom text and the actual system error
     # message (converted to a string)
-    error_text = "Unable to open"\
+    error_text = 'Unable to open'\
                   "the requested browser: #{lc_browser_type} " + error.to_s
     raise error_text
   end
@@ -68,7 +68,7 @@ module Browser
     options = Selenium::WebDriver::Firefox::Options.new(args: ['-headless'])
     caps['acceptInsecureCerts'] = true
     driver = Selenium::WebDriver.for(:firefox, options: options,
-                                    desired_capabilities: caps)
+                                               desired_capabilities: caps)
     @browser = Watir::Browser.new(driver)
     # makes the browser full screen.
     @browser.driver.manage.window.resize_to(1920, 1200)
@@ -101,42 +101,40 @@ module Browser
 
   # define browser value
   def self.b
-    browser = @browser
+    @browser
   end
 
   # Check browser version
   def self.browser_version
-    browserversion = @browser.driver.capabilities[:version]
+    @browser.driver.capabilities[:version]
   rescue StandardError
-    browserversion = 'No Browser version'
+    'No Browser version'
   end
 
   # create screenshot filename and save the screenshot if the test has failed or
   # if explictly required
   def self.check_save_screenshot(screen_shot)
-    if ($currentTestFail || screen_shot)
+    if $currentTestFail || screen_shot
       time = Time.now.strftime('%H%M')
-      if ($currentTestFail)
-        full_sc_dirname = CreateDirectories.construct_testspecdirs
-        scFileName = full_sc_dirname + "/Test_step-#{$testStep}_Failed_"\
-                                        "#{time}.png"
-      else
-        # file name will be teststep.png
-        full_sc_dirname = CreateDirectories.construct_testspecdirs
-        scFileName = full_sc_dirname + "/Test_step-#{$testStep}_#{time}.png"
-      end
+      sc_dir = CreateDirectories.construct_testspecdirs
+
+      sc_file_name = if $currentTestFail
+                       "#{sc_dir}/Test_step-#{$test_step}_Failed_#{time}.png"
+                     else
+                       "#{sc_dir}/Test_step-#{$test_step}_#{time}.png"
+                     end
 
       # Screenshot capture for websites
-      Browser.b.screenshot.save scFileName
-      MyLog.log.info("Screenshot saved to: #{scFileName} \n")
-      else
-        MyLog.log.debug "No screenshot requested \n"
-      end
+      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
-    rescue StandardError => error
+  rescue StandardError => error
     # construct the error message from custom text and the actual system
     # error message (converted to a string).
-    MyLog.log.warn("Error saving the screenshot: #{scFileName}   #{error.to_s}")
+    MyLog.log.warn("Error saving the screenshot: #{sc_file_name}   #{error}")
   end
 end

data/lib/utils/create_directories.rb

@@ -41,7 +41,6 @@ module CreateDirectories
   end
 
   def self.construct_testspecdirs
-
     time = Time.new
     f_date = time.strftime('%d-%b-%Y')
     f_time = time.strftime('%H_%M_%S')
@@ -60,10 +59,9 @@ module CreateDirectories
 
     # create absolute paths to the screenshots and test suite summary directories
     abs_path_screenshot_dir = File.absolute_path(screenshot_dir)
-    abs_path_run_no_dir      = File.absolute_path($runNoDir)
 
   # if any issues then set error message and re-raise the exception
-  rescue Exception => error
+  rescue StandardError => error
     # construct the error message from custom text and the actual system error message (converted to a string)
     error_to_display = 'Error creating the test directory structure or opening the test results file : ' + error.to_s
     raise error_to_display

data/lib/utils/test_engine.rb

@@ -17,22 +17,22 @@ module TestEngine
 
     # loop through all the available test files to execute the tests
     Parser.test_files.each_with_index do |test_file_name, test_file_index|
-      begin # start of rescue block for readTestData
+      begin
         # read in the test data
-        testFileType = Parser.read_test_data(test_file_name)
+        test_file_type = Parser.read_test_data(test_file_name)
         # if unable to read the test data, show the error and move onto the
         # next file (if there is one)
       rescue StandardError => error
         MyLog.log.warn 'Terminating the current test case: ' \
                      "#{test_file_name} #{error}"
         MyLog.log.info '...continuing with the next test case (if there is one)'
-      end # of rescue block for readTestData
+      end
 
       # create project folders - these only need creating once per test suite
       CreateDirectories.construct_projectdirs
 
       # loop through the test file
-      MyLog.log.info 'Not a valid XLSX File Type' if testFileType != 'XLSX'
+      MyLog.log.info 'Not a valid XLSX File Type' if test_file_type != 'XLSX'
 
       # get the test case start time
       $test_case_start_time = Report.current_time
@@ -40,12 +40,12 @@ module TestEngine
       $test_case_end_time = Report.current_time
 
       begin
-        test_steps = Parser.parse_test_step_data(testFileType)
+        test_steps = Parser.parse_test_step_data(test_file_type)
 
         test_steps.each_with_index do |test_step, step_index|
-          $testStep         = test_step[:testStep]
-          $testStepDes      = test_step[:testdesc]
-          screen_shot       = test_step[:screenShotData]
+          $test_step     = test_step[:testStep]
+          $test_step_des = test_step[:testdesc]
+          screen_shot    = test_step[:screenShotData]
 
           # process the test step data
           TestSteps.process_test_steps(test_file_name, step_index, test_step)
@@ -77,5 +77,5 @@ module TestEngine
       $testStepFailures = 0
       $testStepNotrun   = 0
     end
-  end # while loop for test files
+  end
 end

data/lib/utils/test_steps.rb

@@ -9,30 +9,29 @@
 # test_steps.rb - process the required test step functions
 module TestSteps
   require_relative '../taf_config.rb'
-  
+
   def self.handlers
     @handlers ||= {}
   end
 
   # 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, teststepindex, step_attributes)
+  def self.process_test_steps(test_file_name, test_step_index, step_attributes)
     # print the test step information
-    Report.print_test_step_header(test_file_name, teststepindex)
- 
+    Report.print_test_step_header(test_file_name, test_step_index)
+
     runtest = step_attributes[:skipTestCase]
     step_function = step_attributes[:testFunction]
     handler = handlers[step_function.to_s]
 
     if handler.respond_to?(:perform)
       func = handler.perform(step_attributes) if runtest == false
-      Report.test_pass_fail(func, test_file_name, teststepindex)
-      Report.check_failure_threshold(test_file_name, teststepindex)
+      Report.test_pass_fail(func, test_file_name, test_step_index)
+      Report.check_failure_threshold(test_file_name, test_step_index)
       return true
     else
       MyLog.log.warn "\nUnable to match function: #{step_function}"
       raise UnknownTestStep, "Unknown test step: #{step_function}"
-      return false
     end
   end
 end

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taf
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Andy Perrett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-13 00:00:00.000000000 Z
+date: 2019-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler