taf 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0bf4d7c1477f373307a3dd922e833020a20eef9152c03ecf7c5700093f6e0ea2
-  data.tar.gz: '028efb2643375ac7cff7d03f96a02e08301505ccc9583c7cd1a6c2552054a664'
+  metadata.gz: f86ace5ef3a38a6e2dd38706ebe56e20afb50bdf5ec78d6db1f2bd63271340f9
+  data.tar.gz: 0e448aaa2850b5209d132fb8e94e0bec7f3fb39716395494d064ed4069c64c17
 SHA512:
-  metadata.gz: def47ec8aea263fdfafb0b26130fe9c157f2815f0c6bd069a336b9a9c658f3d1ab7874e784b49adb09f38ffb621fbe1e41461845f501689ba7f78b2ef2504519
-  data.tar.gz: 19ae836691ad2a6952fac705b0fc87832b3a151b3e0f24451551d74f8f96001c004d4b67248ece9f28c32cbd5ae01ccad63ced97d732e1fbeb93c96007292ba2
+  metadata.gz: e08b8accbbf33503870b9478f2175c88f7d12c4f764b481f2520a4853c509c757d2f95a8c9be2ab92e8faff8abe267efb0796950005a2800b3427e955d219686
+  data.tar.gz: 5e58ff283dff6a4c88409b550b5fb68f7a857d8c66595cafbacfcde673af4ee939e8cb4db0a91cce2f4abfb6eba2a351b50c82d9fddd7276fc8b4b2729fac11c

data/lib/functions/handlers/base_handler.rb

@@ -22,7 +22,7 @@ module TestSteps
           login_button
           sleep 3
         else
-          Report.results.puts("User: #{user} has failed to log in.")
+          MyLog.log.warn("User: #{user} has failed to log in.")
         end
       end
 
@@ -32,16 +32,16 @@ module TestSteps
         elsif Browser.b.button(value: 'Log in').exist?
           Browser.b.button(value: 'Log in').wait_until.click
         else
-          Report.results.puts("User: #{user} has failed to log in.")
+          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)
-          Report.results.puts("User: #{user} has logged in successful.")
+          MyLog.log.info("User: #{user} has logged in successful.")
           true
         else
-          Report.results.puts("User: #{user} has failed to log in.")
+          MyLog.log.warn("User: #{user} has failed to log in.")
           false
         end
       end
@@ -50,10 +50,10 @@ module TestSteps
         if Browser.b.title.eql?('Memorable word - UKCloud Portal')
           portal_mem_word(user, b_title_sucess)
         elsif Browser.b.title.eql?(b_title_sucess)
-          Report.results.puts("User: #{user} has logged in successful.")
+          MyLog.log.info("User: #{user} has logged in successful.")
           true
         else
-          Report.results.puts("User: #{user} has failed to log in.")
+          MyLog.log.warn("User: #{user} has failed to log in.")
           false
         end
       end
@@ -77,10 +77,10 @@ module TestSteps
 
         Browser.b.button(value: 'Sign in').wait_until.click
         if Browser.b.title.eql?(b_title_sucess)
-          Report.results.puts("User: #{user} has logged in successful.")
+          MyLog.log.info("User: #{user} has logged in successful.")
           return true
         else
-          Report.results.puts("User: #{user} has failed to log in.")
+          MyLog.log.warn("User: #{user} has failed to log in.")
           return false
         end
       end

data/lib/functions/handlers/browser_back.rb

@@ -7,10 +7,10 @@ module TestSteps
 
       def perform(step_attributes)
         Browser.b.back
-        Report.results.puts('Browser navigated back')
+        MyLog.log.info('Browser navigated back')
         true
       rescue StandardError
-        Report.results.puts('Browser failed to navigate back')
+        MyLog.log.warn('Browser failed to navigate back')
         false
       end
     end

data/lib/functions/handlers/browser_forward.rb

@@ -7,10 +7,10 @@ module TestSteps
 
       def perform(step_attributes)
         Browser.b.forward
-        Report.results.puts('Browser navigated forward')
+        MyLog.log.info('Browser navigated forward')
         true
       rescue StandardError
-        Report.results.puts('Browser failed to navigate forward')
+        MyLog.log.warn('Browser failed to navigate forward')
         false
       end
     end

data/lib/functions/handlers/browser_quit.rb

@@ -7,10 +7,10 @@ module TestSteps
 
       def perform(step_attributes)
         Browser.b.quit
-        Report.results.puts('Browser has closed successfully')
+        MyLog.log.info('Browser has closed successfully')
         true
       rescue StandardError
-        Report.results.puts('Browser has failed to close')
+        MyLog.log.warn('Browser has failed to close')
         false
       end
     end

data/lib/functions/handlers/browser_refresh.rb

@@ -7,10 +7,10 @@ module TestSteps
 
       def perform(step_attributes)
         Browser.b.refresh
-        Report.results.puts('The Browser has been refreshed')
+        MyLog.log.info('The Browser has been refreshed')
         true
       rescue StandardError
-        Report.results.puts('The Browser failed to refresh')
+        MyLog.log.warn('The Browser failed to refresh')
         false
       end
     end

data/lib/functions/handlers/capture_alert.rb

@@ -8,10 +8,10 @@ module TestSteps
       def perform(step_attributes)
         Browser.b.div(class: 'alert').exist?
         alertmsg = Browser.b.div(class: 'alert').text
-        Report.results.puts("Alert shown: #{alertmsg}")
+        MyLog.log.info("Alert shown: #{alertmsg}")
         true
       rescue StandardError
-        Report.results.puts('No Alert Found')
+        MyLog.log.warn('No Alert Found')
         false
       end
     end

data/lib/functions/handlers/check_box.rb

@@ -10,10 +10,10 @@ module TestSteps
         locate = step_attributes[:locate]
 
         Browser.b.checkbox(:"#{locate}" => checkbox).wait_until.click
-        Report.results.puts("Check box: #{checkbox} has been selected")
+        MyLog.log.info("Check box: #{checkbox} has been selected")
         true
       rescue StandardError
-        Report.results.puts("Check box: #{checkbox} does not exist")
+        MyLog.log.warn("Check box: #{checkbox} does not exist")
         false
       end
     end

data/lib/functions/handlers/check_boxdata.rb

@@ -25,13 +25,13 @@ module TestSteps
           Browser.b.text_field(:"#{locate}" => box).wait_until
           (Browser.b.text_field(:"#{locate}" => box).value == value)
         end
-        Report.results.puts("Textbox: #{box} has the correct value: #{value}")
+        MyLog.log.info("Textbox: #{box} has the correct value: #{value}")
         true
       rescue StandardError
-        Report.results.puts("Textbox: #{box} has the incorrect value: #{value}")
+        MyLog.log.warn("Textbox: #{box} has the incorrect value: #{value}")
         false
       rescue StandardError
-        Report.results.puts("Textbox: #{box} does not exist")
+        MyLog.log.warn("Textbox: #{box} does not exist")
         false
       end
     end

data/lib/functions/handlers/check_browser_title.rb

@@ -10,10 +10,10 @@ module TestSteps
 
         sleep 2
         if Browser.b.title.eql?(text_check)
-          Report.results.puts("Browser title: #{text_check}")
+          MyLog.log.info("Browser title: #{text_check}")
           return true
         else
-          Report.results.puts("Title not found: #{text_check}")
+          MyLog.log.warn("Title not found: #{text_check}")
           return false
         end
       end

data/lib/functions/handlers/check_logs.rb

@@ -11,10 +11,10 @@ module TestSteps
 
         blog_result = system 'egrep -i ' + text + ' ' + file + ' > ' + output
         if blog_result == true
-          Report.results.puts("Data has matched: #{text} in LogFile: #{file}")
+          MyLog.log.info("Data has matched: #{text} in LogFile: #{file}")
           return true
         else
-          Report.results.puts("Problem finding: #{text} in LogFile: #{file}")
+          MyLog.log.warn("Problem finding: #{text} in LogFile: #{file}")
           return false
         end
       end

data/lib/functions/handlers/check_screendata.rb

@@ -10,10 +10,10 @@ module TestSteps
 
         sleep 5
         if Browser.b.text.include?(text_check)
-          Report.results.puts("Found text: #{text_check}")
+          MyLog.log.info("Found text: #{text_check}")
           return true
         else
-          Report.results.puts("NOT found text: #{text_check}")
+          MyLog.log.warn("NOT found text: #{text_check}")
           return false
         end
       end

data/lib/functions/handlers/check_url.rb

@@ -9,10 +9,10 @@ module TestSteps
         url = step_attributes[:testvalue]
 
         if Browser.b.url == url
-          Report.results.puts("URL: #{url} is correct")
+          MyLog.log.info("URL: #{url} is correct")
           true
         else
-          Report.results.puts("URL: #{url} is incorrect")
+          MyLog.log.warn("URL: #{url} is incorrect")
           false
         end
       end

data/lib/functions/handlers/click_button.rb

@@ -41,10 +41,10 @@ module TestSteps
         when 9
           Browser.b.h4(:"#{locate}" => button).wait_until.click
         end
-        Report.results.puts("Button: #{button} has been selected")
+        MyLog.log.info("Button: #{button} has been selected")
         true
       rescue StandardError
-        Report.results.puts("Button: #{button} does not exist")
+        MyLog.log.warn("Button: #{button} does not exist")
         false
       end
     end

data/lib/functions/handlers/execute_system_command.rb

@@ -10,10 +10,10 @@ module TestSteps
 
         b_result = system syst_cmd
         if b_result == true
-          Report.results.puts("Cmd has been executed sucessfully #{syst_cmd}")
+          MyLog.log.info("Cmd has been executed sucessfully #{syst_cmd}")
           return true
         else
-          Report.results.puts("Theres a problem executing command #{syst_cmd}")
+          MyLog.log.warn("Theres a problem executing command #{syst_cmd}")
           return false
         end
       end

data/lib/functions/handlers/handle_browser_window.rb

@@ -11,10 +11,10 @@ module TestSteps
         Browser.b.window(title: text_check.to_s).use
         sleep 3
         Browser.b.title.eql?(text_check.to_s)
-        Report.results.puts("Window title: #{text_check} is correct")
+        MyLog.log.info("Window title: #{text_check} is correct")
         true
       rescue StandardError
-        Report.results.puts("Window not found: #{text_check}")
+        MyLog.log.warn("Window not found: #{text_check}")
         false
       end
     end

data/lib/functions/handlers/insert_value_config.rb

@@ -13,13 +13,13 @@ module TestSteps
 
         Browser.b.text_field(:"#{locate}" => box).wait_until.set value
         (Browser.b.text_field(:"#{locate}" => box).value == value)
-        Report.results.puts("Textbox: #{box} has correct value: #{value}")
+        MyLog.log.info("Textbox: #{box} has correct value: #{value}")
         true
       rescue StandardError
-        Report.results.puts("Textbox: #{box} has the incorrect value: #{value}")
+        MyLog.log.warn("Textbox: #{box} has the incorrect value: #{value}")
         false
       rescue StandardError
-        Report.results.puts("Textbox: #{box} does not exist")
+        MyLog.log.warn("Textbox: #{box} does not exist")
         false
       end
     end

data/lib/functions/handlers/ipause.rb

@@ -9,10 +9,10 @@ module TestSteps
         wait_time = step_attributes[:testvalue]
 
         sleep(wait_time.to_i)
-        Report.results.puts('Wait completed for seconds: ' + wait_time.to_s)
+        MyLog.log.info('Wait completed for seconds: ' + wait_time.to_s)
         true
       rescue StandardError
-        Report.results.puts('Wait failed for seconds: ' + wait_time.to_s)
+        MyLog.log.warn('Wait failed for seconds: ' + wait_time.to_s)
         false
       end
     end

data/lib/functions/handlers/list_all_dropdowns_values.rb

@@ -11,11 +11,11 @@ module TestSteps
 
         Browser.b.element(:"#{locate}" => dropdown).wait_until
         Browser.b.select_list(:"#{locate}" => dropdown).options.each do |i|
-        Report.results.puts("List of dropdown for #{dropdown} are: #{i.text}")
+          MyLog.log.info("List of dropdown for #{dropdown} are: #{i.text}")
         return true
         end
       rescue StandardError
-        Report.results.puts("List dropdown: #{dropdown} does not exist")
+        MyLog.log.warn("List dropdown: #{dropdown} does not exist")
         false
       end
     end

data/lib/functions/handlers/open_portal_url.rb

@@ -12,10 +12,10 @@ module TestSteps
         Browser.b.goto(url)
         url_nme = Browser.b.url
         if url_nme == url
-          Report.results.puts("opened URL: #{url}")
+          MyLog.log.info("opened URL: #{url}")
           return true
         else
-          Report.results.puts("URL not open: #{url} - opened #{url_nme} instead")
+          MyLog.log.warn("URL not open: #{url} - opened #{url_nme} instead")
           return false
         end
       end

data/lib/functions/handlers/open_url.rb

@@ -13,10 +13,10 @@ module TestSteps
         sleep 2
         url_nme = Browser.b.url
         if url_nme == url
-          Report.results.puts("opened URL: #{url}")
+          MyLog.log.info("Opened URL: #{url}")
           return true
         else
-          Report.results.puts("URL not open: #{url} - opened #{url_nme} instead")
+          MyLog.log.warn("URL not open: #{url} - opened #{url_nme} instead")
           return false
         end
       end

data/lib/functions/handlers/ping_test.rb

@@ -13,11 +13,11 @@ module TestSteps
           sleep 5
           if check.ping? == true
             # website alive
-            Report.results.puts("pinged: #{url}")
+            MyLog.log.info("pinged: #{url}")
             return true
           else
             # website not responding
-            Report.results.puts("Failed to ping: #{url}")
+            MyLog.log.warn("Failed to ping: #{url}")
             return false
           end
         end

data/lib/functions/handlers/radio_button.rb

@@ -13,10 +13,10 @@ module TestSteps
 
         Browser.b.radio(:"#{locate}" => radio).wait_until
         Browser.b.radio(:"#{locate}" => radio, :"#{locate2}" => "#{value2}").set
-        Report.results.puts("Radio button: #{radio} has been selected")
+        MyLog.log.info("Radio button: #{radio} has been selected")
         true
       rescue StandardError
-        Report.results.puts("Radio button: #{radio} does not exist")
+        MyLog.log.warn("Radio button: #{radio} does not exist")
         false
       end
     end

data/lib/functions/handlers/select_dropdown.rb

@@ -13,13 +13,13 @@ module TestSteps
 
         Browser.b.select_list(:"#{locate}" => dropdown).wait_until
         Browser.b.select_list(:"#{locate}" => dropdown).option(:"#{locate2}" => "#{value2}").select
-        Report.results.puts("Dropdown item: #{value2} has been selected")
+        MyLog.log.info("Dropdown item: #{value2} has been selected")
         true
       rescue StandardError
-        Report.results.puts("Dropdown item: #{value2} has NOT been selected")
+        MyLog.log.warn("Dropdown item: #{value2} has NOT been selected")
         false
       rescue StandardError
-        Report.results.puts("the dropdown: #{dropdown} does not exist")
+        MyLog.log.warn("the dropdown: #{dropdown} does not exist")
         false
       end
     end

data/lib/functions/handlers/send_special_keys.rb

@@ -10,10 +10,10 @@ module TestSteps
 
         Browser.b.send_keys :"#{special_key}"
         sleep 1
-        Report.results.puts("Browser Sent key: :#{special_key} successfully")
+        MyLog.log.info("Browser Sent key: :#{special_key} successfully")
         true
       rescue StandardError
-        Report.results.puts("Browser Failed to Send key: :#{special_key}")
+        MyLog.log.warn("Browser Failed to Send key: :#{special_key}")
         false
       end
     end

data/lib/functions/handlers/write_box_data.rb

@@ -25,13 +25,13 @@ module TestSteps
           Browser.b.text_field(:"#{locate}" => box).wait_until.set value
           (Browser.b.text_field(:"#{locate}" => box).value == value)
         end
-        Report.results.puts("Textbox: #{box} has correct value: #{value}")
+        MyLog.log.info("Textbox: #{box} has correct value: #{value}")
         true
       rescue StandardError
-        Report.results.puts("Textbox: #{box} has the incorrect value: #{value}")
+        MyLog.log.warn("Textbox: #{box} has the incorrect value: #{value}")
         false
       rescue StandardError
-        Report.results.puts("Textbox: #{box} does not exist")
+        MyLog.log.warn("Textbox: #{box} does not exist")
         false
       end
     end

data/lib/functions/handlers/write_to_editor.rb

@@ -12,13 +12,13 @@ module TestSteps
 
         Browser.b.iframe(:"#{locate}" => iframe).wait_until
         Browser.b.iframe(:"#{locate}" => iframe).send_keys value
-        Report.results.puts("Editor box: #{iframe} has correct value: #{value}")
+        MyLog.log.info("Editor box: #{iframe} has correct value: #{value}")
         true
       rescue StandardError
-        Report.results.puts("Editor box: #{iframe} has wrong value: #{value}")
+        MyLog.log.warn("Editor box: #{iframe} has wrong value: #{value}")
         false
       rescue StandardError
-        Report.results.puts("Editor box: #{iframe} does not exist")
+        MyLog.log.warn("Editor box: #{iframe} does not exist")
         false
       end
     end

data/lib/main.rb

@@ -32,11 +32,11 @@ module Main
       # Testsuite File and Browser.
       if ARGV.length < 2
         $testSuiteFile = ARGV[0]
-        puts 'Only one argument needed: {TestSuite File}'
+        MyLog.log.info 'Only one argument needed: {TestSuite File}'
       elsif ARGV.length < 3
         $testSuiteFile = ARGV[0]
         $browserType = ARGV[1]
-        puts 'Only 2 arguments needed: {TestSuite File} {Browser}'
+        MyLog.log.info 'Only 2 arguments needed: {TestSuite File} {Browser}'
       else
         # unable to open file as not supplied as command-line parameter
         $testSuiteFile = 'unknown'
@@ -50,11 +50,11 @@ module Main
   # unable to read the test file then handle the error and terminate
   rescue StandardError => error
     warn error
-    $stdout.puts error
+    MyLog.log.warn error
     abort
   end
 
-    puts "There are: #{$numberOfTestSpecs} test files to process \n"
+    MyLog.log.info "There are: #{$numberOfTestSpecs} test files to process \n"
 
     # process the test files to execute the tests
     TestEngine.process_testfiles

data/lib/parser/parser.rb

@@ -14,7 +14,7 @@ module Parser
   def self.read_test_suite_data
     # check if the file list exists and is readable
     if (File.file?($testSuiteFile) & File.readable?($testSuiteFile))
-      puts "\nProcessing test suite file: #{$testSuiteFile}"
+      MyLog.log.info "Processing test suite file: #{$testSuiteFile}"
       # get the file type
       fileType = File.extname($testSuiteFile)
       # extract the test data from the test suite
@@ -60,8 +60,8 @@ module Parser
     # get the file type
     fileType = File.extname(testFileName)
     if (fileType.casecmp(@XlsxFileNameType) == 0)
-      puts "Processing test file: #{testFileName}"
-      puts "Browser Type: #{$browserType}"
+      MyLog.log.info "Processing test file: #{testFileName}"
+      MyLog.log.info "Browser Type: #{$browserType}"
       $xlsxDoc = RubyXL::Parser.parse(testFileName)
       XlsxParser.parse_xlxs_test_header_data
       return 'XLSX'

data/lib/parser/xlsx_parser.rb

@@ -52,8 +52,8 @@ module XlsxParser
     worksheet = $xlsxDoc[0]
     # get the remaining test data
     $testDes      = worksheet.sheet_data[4][1].value
-    puts "Number of test steps: #{$numberOfTestSteps}"
-    puts "Test Description: #{$testDes}"
+    MyLog.log.info "Number of test steps: #{$numberOfTestSteps}"
+    MyLog.log.info "Test Description: #{$testDes}"
     
   end
 

data/lib/report/junit_report.rb

@@ -59,7 +59,7 @@ module JunitReport
     if !File.exist?($TestSuiteSummaryXML) || $TestSuiteSummaryXML.closed?
       $testSuiteSummaryFile_xml = File.open($TestSuiteSummaryXML, 'w+')
       $testSuiteSummaryFile_xml.write builder.to_xml
-    elsif $log.puts "test suite summary file xml name: #{$TestSuiteSummaryXML} is already open"
+    elsif MyLog.log.warn "test suite summary file xml name: #{$TestSuiteSummaryXML} is already open"
     end
 
     # if the file is open then close it

data/lib/report/report.rb

@@ -6,54 +6,15 @@
 # Versions:
 # 1.0 - Baseline
 #
-# report.rb - methods for accessing and writing to the test report file(s)
+# report.rb - methods for outputting console.
 module Report
   require_relative '../taf_config.rb'
   # setup the test results output file
-  def self.open_test_report_file
-    # open a new file for writing
-    $log.puts("Opening Test Result file: #{$testResultFileName} \n")
-
-    # open test results file for writing if not already open
-    if !File.exist?($testResultFileName) || $testResultFileName.closed?
-      @results_file = File.open($testResultFileName, 'w')
-    elsif $log.puts "test results file name: #{$testResultFileName} is already open"
-    end
-  end
-
-  # close_testresults_file
-  def self.close_test_results_file
-    # if the file is open then close it
-    Report.results.close unless Report.results.closed?
-  end
-
   # results file variable
   def self.results
     results_file = @results_file
   end
 
-  def self.open_log_file
-    # open a new file for writing
-    $stdout.puts "Opening log file: #{$logFileName} \n"
-
-    # create a new log file and set the mode as 'append'
-    $log = File.open($logFileName, 'w+')
-  end
-
-  def self.close_log_file
-    # if the file is open then close it
-    $log.close unless $log.closed?
-  end
-
-  # print the main test header info to the test results file
-  def self.print_test_header
-    Report.results.puts("Project Name: #{$projectName} Project ID: #{$projectId} Sprint: #{$sprint}")
-    Report.results.puts("Test ID: #{$testId} Test Description: #{$testDes}")
-    Report.results.puts("Executed with browser: #{$browserType}")
-    Report.results.puts("Test suite: #{$testSuiteFile}")
-    Report.results.puts("Tester: #{$tester}", "\n \n")
-  end
-
   # get the current time in the format Day - Month - Date - Time (HH:MM:SS)
   def self.current_time
     time = Time.new
@@ -63,10 +24,8 @@ module Report
 
   # print the test Step info to the test results file
   def self.print_test_step_header(test_file_name, testStepIndex)
-    Report.results.puts("\n" + "Test start time: #{f_time = current_time}")
-    Report.results.puts("Test step: #{$testStep} : #{$testStepDes} \n")
-    puts "\nTest start time: #{f_time = current_time}   \n"
-    puts "Test step: #{$testStep} : #{$testStepDes}  "
+    MyLog.log.info "Test start time: #{f_time = current_time}"
+    MyLog.log.info "Test step: #{$testStep} : #{$testStepDes}"
 
     step = {
       'id' => $testStep,
@@ -89,14 +48,12 @@ module Report
       $previousTestFail = $currentTestFail
       $currentTestFail = false
       $testStepPasses += 1
-      Report.results.puts("Test #{$testStep} has Passed")
-      puts "Test #{$testStep} has Passed ".green
+      MyLog.log.info "Test #{$testStep} has Passed ".green
     elsif passFail == false
       $previousTestFail = $currentTestFail
       $currentTestFail = true
       $testStepFailures += 1
-      Report.results.puts("Test #{$testStep} has FAILED")
-      puts "Test #{$testStep} has FAILED ".red
+      MyLog.log.info "Test #{$testStep} has FAILED ".red
       failstep = {
         'message' => 'SuiteID: ' + $testId.to_s + ' Test Step: ' + $testStep.to_s + ' Test has FAILED - Check logs',
         'type' => 'FAILURE',
@@ -112,8 +69,7 @@ module Report
     else
       $currentTestFail = false
       $testStepNotrun += 1
-      Report.results.puts("Test #{$testStep} no checks performed")
-      puts "Test #{$testStep} no checks performed ".blue
+      MyLog.log.info "Test #{$testStep} no checks performed ".blue
       skipstep = {
         'message' => 'SuiteID: ' + $testId.to_s + ' Test Step: ' + $testStep.to_s + ' No checks performed - Check logs',
         'type' => 'SKIPPED',
@@ -127,8 +83,7 @@ module Report
       $skiptestStep_xml[test_file_name] ||= []
       $skiptestStep_xml[test_file_name][testStepIndex] = skipstep
   end
-    Report.results.puts("Test end time: #{f_time = current_time}\n")
-    puts "Test end time: #{f_time = current_time} \n"
+    MyLog.log.info "Test end time: #{f_time = current_time}"
   end
 
   # check if the test failure threshold has been reached for total failures or consecutive failures.
@@ -142,11 +97,9 @@ module Report
     end
 
     if @consecutiveTestFail >= consecutiveFailThreshold
-      Report.results.puts("\nTerminating the current test case as the test failure threshold (#{consecutiveFailThreshold} ) has been reached")
-
-      # write info to $stderr
-      $stderr.puts "Terminating the current test case: #{test_file_name} as the test failure threshold (#{consecutiveFailThreshold}) has been reached."
-      $stderr.puts '...continuing with the next test case (if there is one)'
+      # 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)'
 
       raise FailureThresholdExceeded,
             "#{consecutiveFailThreshold} Test Steps Failed."

data/lib/report/report_summary.rb

@@ -14,7 +14,7 @@ module ReportSummary
   # output the test results summary for the current test case
   def self.test_step_summary(test_file_name, test_file_name_index)
     # construct the test step report summary
-    @testStepReportSummary[test_file_name_index] = "\n" 'Test file:', test_file_name,\
+    @testStepReportSummary[test_file_name_index] = 'Test file:', test_file_name,\
     "\n" 'Browser type:', $browserType, \
     "\n" 'Browser version:', Browser.browser_version.to_s, \
     "\n" 'Environment:', $env_type, \
@@ -25,38 +25,35 @@ module ReportSummary
     "\n" 'There are:', $testStepNotrun, 'Skipped Tests' "\n"
     # ... and save in a format that is printable
     @testStepReportSummary[test_file_name_index] = @testStepReportSummary[test_file_name_index].join(' ')
-    Report.results.puts ''
-    Report.results.puts("Test Summary: #{@testStepReportSummary[test_file_name_index]}")
-    Report.results.puts("Test end time: #{$test_case_end_time} \n")
   end
 
   # output the overall test results summary
   def self.print_overall_test_summary
     # output to the console
 
-    puts "\nFinished processing all test files - executed via test suite: #{$testSuiteFile} by tester: #{$tester}"
-    puts "\nOverall Test Summary:"
+    MyLog.log.info "Finished processing all test files - executed via test suite: #{$testSuiteFile} by tester: #{$tester}"
+    MyLog.log.info "Overall Test Summary:"
     @testStepReportSummary.each do |testStepReportSummary|
-      puts testStepReportSummary
+      MyLog.log.info  testStepReportSummary
     end
 
-    puts "\nTotal Tests started at: #{$test_start_time}"
-    puts "Total Tests finished at: #{$test_end_time}"
-    puts ('Total Tests duration: ' + TimeDifference.between($test_end_time, $test_start_time).humanize)
-    puts "Total Tests Passed: #{$totalTestPasses}".green
-    puts "Total Tests Failed: #{$totalTestFailures}".red
-    puts "Total Tests Skipped: #{$totalTestNotrun}".blue
+    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 duration: ' + TimeDifference.between($test_end_time, $test_start_time).humanize)
+    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
-    puts "Total Tests: #{$totalTests}\n"
+    MyLog.log.info "Total Tests: #{$totalTests}\n"
 
     # output to the suite summary file
 
     # open the suite summary file for writing if not already open
     if !File.exist?($testSuiteSummaryFileName) || $testSuiteSummaryFileName.closed?
       testSuiteSummaryFile = File.open($testSuiteSummaryFileName, 'w')
-      puts "\nTest Suite Summary file located at:"
-      puts "#{$testSuiteSummaryFileName}\n"
-    elsif $log.puts "test suite summary file name: #{$testSuiteSummarylFileName} is already open"
+      MyLog.log.info"Test Suite Summary file located at:"
+      MyLog.log.info "#{$testSuiteSummaryFileName}\n"
+    elsif MyLog.log.warn "test suite summary file name: #{$testSuiteSummarylFileName} is already open"
     end
 
     testSuiteSummaryFile.puts "Finished processing all test files - executed via test suite: #{$testSuiteFile} by tester: #{$tester} \n"

data/lib/taf_config.rb

@@ -25,6 +25,7 @@ require_relative './utils/test_steps'
 require_relative './report/report'
 require_relative './utils/browser'
 require_relative './utils/create_directories'
+require_relative './utils/logger'
 require_relative './utils/test_engine'
 require_relative './utils/exceptions'
 require_relative './report/junit_report'

data/lib/utils/browser.rb

@@ -24,7 +24,7 @@ module Browser
     when 'safari'
       safari
     else
-      puts "unable to open selected browser: #{lc_browser_type}"
+      MyLog.log.error "unable to open selected browser: #{lc_browser_type}"
       raise BrowserFailedOpen
     end
   rescue BrowserFailedOpen => error
@@ -126,15 +126,15 @@ module Browser
 
       # Screenshot capture for websites
       Browser.b.screenshot.save scFileName
-      Report.results.puts("Screenshot saved to: #{scFileName}")
+      MyLog.log.info("Screenshot saved to: #{scFileName} \n")
       else
-        Report.results.puts 'No screenshot requested'
+        MyLog.log.debug "No screenshot requested \n"
       end
 
     # if any issues with saving the screenshot then log a warning
     rescue StandardError => error
     # construct the error message from custom text and the actual system
     # error message (converted to a string).
-    $log.puts("Error saving the screenshot: #{scFileName}   #{error.to_s}")
+    MyLog.log.warn("Error saving the screenshot: #{scFileName}   #{error.to_s}")
   end
 end

data/lib/utils/create_directories.rb

@@ -20,8 +20,6 @@ module CreateDirectories
   #
   # ---------->directory named after test_id (with browser type identified)
   #
-  # ------------->directory named 'Test_Results'
-  #
   # ------------->directory named 'Screenshots'
 
   def self.construct_projectdirs
@@ -53,18 +51,10 @@ module CreateDirectories
     screenshot_dir = testid_dir + '/' + 'Screenshots' + '/'
     Dir.mkdir(screenshot_dir)
 
-    # create a test results directory under the 'test run' directory - it will always need creating
-    test_res_dir = testid_dir + '/' + 'Test_Results' + '/'
-    Dir.mkdir(test_res_dir)
-
     # create absolute paths to the screenshots, test results and test suite summary directories
     abs_path_screenshot_dir = File.absolute_path(screenshot_dir)
-    abs_path_test_res_dir    = File.absolute_path(test_res_dir)
     abs_path_run_no_dir      = File.absolute_path($runNoDir)
 
-    # the test results file name will be 'testId'_Res.txt
-    $testResultFileName = abs_path_test_res_dir + '/' + $testId + '_Res.txt'
-
     # the test suite summary file name will be 'suite_summary.txt'
     $testSuiteSummaryFileName = abs_path_run_no_dir + '/suite_summary.txt'
 
@@ -76,11 +66,9 @@ module CreateDirectories
     $TestSuiteSummaryXML = 'Results/' + $projectId + '/' + f_date + '_' + f_time + '_test_result.xml'
 
     # the log file name will be under the test ID directory
-    $logFileName = testid_dir + '/TestLogFile.txt'
 
-    puts "TestId: #{$testId}"
-    puts "Screenshot directory: #{abs_path_screenshot_dir}"
-    puts "Test result directory: #{abs_path_test_res_dir}"
+    MyLog.log.info "TestId: #{$testId}"
+    MyLog.log.info "Screenshot directory: #{abs_path_screenshot_dir} \n"
 
   # if any issues then set error message and re-raise the exception
   rescue Exception => error

data/lib/utils/logger.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# Created on 04 Feb 2019
+# @author: Andy Perrett
+#
+# Versions:
+# 1.0 - Baseline
+#
+# logger.rb - logger file
+
+module MyLog
+  require_relative '../taf_config.rb'
+  def self.log
+    if @logger.nil?
+      @logger = Logger.new STDOUT
+      @logger.level = Logger::DEBUG
+      @logger.datetime_format = '%Y-%m-%d %H:%M:%S '
+    end
+    @logger
+  end
+end

data/lib/utils/test_engine.rb

@@ -36,13 +36,10 @@ module TestEngine
 
         if ARGV.length < 2
           $browserType = test_suite[:browser]
-          puts ''
-          puts "Will use the following browser from Test Suite: #{$browserType}"
-          puts ''
+          MyLog.log.info "Will use the following browser from Test Suite: #{$browserType}"
         elsif ARGV.length < 3
           $browserType = ARGV[1]
-          puts "\nWill use the following browser from CMD line: " + ARGV[1]
-          puts ''
+          MyLog.log.info "Will use the following browser from CMD line: " + ARGV[1]
         else
           raise IOError, 'Unable to open browser'  
         end
@@ -56,37 +53,27 @@ module TestEngine
           # if unable to read the test data, show the error and move onto the
           # next file (if there is one)
         rescue StandardError => error
-          $stderr.puts "Terminating the current test case: " \
+          MyLog.log.warn "Terminating the current test case: " \
                        "#{test_file_name} #{error}"
-          $stderr.puts '...continuing with the next test case (if there is one)'
+          MyLog.log.info '...continuing with the next test case (if there is one)'
         end # of rescue block for readTestData
 
         # create the project directories, returns the screenshot directory name
         begin # start of rescue block for construct_projectdirs
           # create test spec directories - these need creating once per testspec
           full_sc_dirname = CreateDirectories.construct_testspecdirs
-          # open the log file
-          Report.open_log_file
           # if an error then show the error and terminate
         rescue StandardError => error
           warn error
-          $stdout.puts error
+          MyLog.log.warn error
           abort
         end
 
-        # open the test results output file
-        Report.open_test_report_file
-
-        # print the main test header
-        Report.print_test_header
-
         # loop through the test file
         if testFileType != 'XLSX'
           puts 'Not a valid XLSX File Type'
         end
 
-        Report.results.puts("Number of test steps: #{$numberOfTestSteps}")
-
         # get the test case start time
         $test_case_start_time = Report.current_time
         # initialise the test end time
@@ -118,12 +105,6 @@ module TestEngine
         ReportSummary.test_step_summary(test_file_name, test_file_name_index)
         JunitReport.test_step_summary_xml(test_file_name, test_file_name_index)
 
-        # close the test results file for the current test case
-        Report.close_test_results_file
-
-        # close the log file
-        Report.close_log_file
-
         # close the browser if created
         Browser.b.quit
 

data/lib/utils/test_steps.rb

@@ -30,8 +30,7 @@ module TestSteps
       Report.check_failure_threshold(test_file_name, teststepindex)
       return true
     else
-      Report.results.puts("\nUnable to match function: #{step_function}")
-      puts "\nUnable to match function: #{step_function}"
+      MyLog.log.warn "\nUnable to match function: #{step_function}"
       raise UnknownTestStep, "Unknown test step: #{step_function}"
       return false
     end

data/lib/version.rb

@@ -3,7 +3,7 @@
 module Taf
   # This module holds the TAF version information.
   module Version
-    STRING = '0.1.5'.freeze
+    STRING = '0.1.6'.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.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Andy Perrett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-11 00:00:00.000000000 Z
+date: 2019-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -211,6 +211,7 @@ files:
 - lib/utils/browser.rb
 - lib/utils/create_directories.rb
 - lib/utils/exceptions.rb
+- lib/utils/logger.rb
 - lib/utils/test_engine.rb
 - lib/utils/test_steps.rb
 - lib/version.rb