taf 0.1.1

data/lib/parser/xlsx_parser.rb

@@ -0,0 +1,126 @@
+# Created on 02 Aug 2018
+# @author: Andy Perrett
+#
+# Versions:
+# 1.0 - Baseline
+#
+# xlsx_parser.rb - xlsx parser functions
+module XlsxParser
+  require_relative '../taf_config.rb'
+  def self.parse_xlxs_test_suite_header_data
+    begin
+      # get the number of test specifications in the file (number of
+      # occurences of "Test_Specification"
+      $numberOfTestSpecs = $XlsxSuiteDoc[0].sheet_data.size - 7
+
+      worksheet = $XlsxSuiteDoc[0]
+      $projectName = worksheet.sheet_data[1][0].value
+      $projectId = worksheet.sheet_data[1][1].value
+      $sprint = worksheet.sheet_data[1][2].value
+
+      $testSuiteId = worksheet.sheet_data[4][0].value
+      $testSuiteDes = worksheet.sheet_data[4][1].value
+      $tester  = worksheet.sheet_data[4][2].value
+    end
+ end
+
+  def self.parse_xlxs_test_suite_data(testSpecIndex)
+    worksheet = $XlsxSuiteDoc[0]
+
+    worksheet[7..$numberOfTestSpecs+7].map do |row|
+      suite = {
+        id: row[0].value,
+        specdesc: row[1].value,
+        env: row[3].value,
+      }
+
+      if ARGV.length < 2
+        suite[:browser] = row[2].value
+        suite[:securitytest] = row[4].value
+      elsif ARGV.length < 3
+        suite[:browser] = ARGV[1]
+      elsif ARGV.length < 4
+        suite[:browser] = ARGV[1]
+        suite[:securitytest] = ARGV[2]
+      else
+        raise IOError, 'Unable to open browser or Unable to run Securtiy Test.'  
+      end
+
+      # if ARGV.length < 3
+      #   suite[:securitytest] = row[4].value
+      # elsif ARGV.length < 4
+      #   suite[:securitytest] = 'securtiy=' + ARGV[2]
+      # else
+      #   raise IOError, 'Unable to run Securtiy Test.'  
+      # end
+
+      suite
+    end
+  end
+
+  def self.parse_xlxs_test_header_data
+    # get the number of test steps in the file
+    $numberOfTestSteps = ($xlsxDoc[0].sheet_data.size) - 7
+    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}"
+    
+  end
+
+  # parseTestStepData
+  def self.parse_test_step_data(testFileType)
+    begin
+    worksheet = $xlsxDoc[0]
+    worksheet[7..$numberOfTestSteps+7].map do |row|
+      test = {
+        testStep: row[0].value,
+        testdesc: row[1].value,
+        testFunction: row[2].value,
+        testvalue: row[3].value,
+        locate: row[4].value,
+        testvalue2: row[5].value,
+        locate2: row[6].value,
+        screenShotData: row[7].value,
+        skipTestCase: row[8].value,
+      }
+
+      # convert test step, screenshot and skip test case functions to lowercase.
+      test[:testFunction].downcase!
+
+      # get screenshot request, check for a null value and default to 'N'
+
+      if (test[:screenShotData] == 'Y')
+        test[:screenShotData] = true
+      elsif (test[:screenShotData] == 'N')
+        test[:screenShotData] = false
+      else
+        test[:screenShotData] = false
+      end
+
+      if (test[:skipTestCase] == 'Y')
+        test[:skipTestCase] = true
+      elsif(test[:skipTestCase] == 'N')
+        test[:skipTestCase] = false
+      else
+        test[:skipTestCase] = false
+      end
+
+      # if there is an element locator then use it, otherwise use an ID
+      if (test[:locate].to_s == '')
+        test[:locate] = 'id'
+      end
+
+      if (test[:locate2].to_s == '')
+        test[:locate2] = 'id'
+      end
+
+      test
+     # if an error reading the test step data then re-raise the exception
+    rescue StandardError => error
+      raise
+    end
+  end
+end
+end

data/lib/report/junit_report.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+# Created on 20 Sept 2017
+# @author: Andy Perrett
+#
+# Versions:
+# 1.0 - Baseline
+#
+# junit_report.rb - methods for writing to the summary xml junit report.
+module JunitReport
+  require_relative '../taf_config.rb'
+  # holds printable test report summary for all the executed tests
+  @testStepReportSummary2 = []
+  # construct the test suite header for junit
+  def self.test_step_summary_xml(test_file_name, test_file_name_index)
+    @testStepReportSummary2[test_file_name_index] = {
+      'classname' => test_file_name,
+      'name' => test_file_name,
+      'assertions' => $numberOfTestSteps,
+      'failures' => $testStepFailures,
+      'tests' => $testStepPasses,
+      'skipped' => $testStepNotrun,
+      'time' => TimeDifference.between($test_case_end_time, $test_case_start_time).in_seconds
+    }
+  end
+
+  def self.test_summary_junit
+    # output to XML file format for Junit for CI.
+    builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
+      testsuite_attrs = {
+        'classname' => $testSuiteFile.to_s,
+        'name' => $testSuiteFile.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).in_seconds
+      }
+      xml.testsuites(testsuite_attrs) do |testsuites|
+        @testStepReportSummary2.each do |testStepReportSummary2|
+          testsuites.testsuite(testStepReportSummary2) do |testsuite|
+            $testStep_xml[testStepReportSummary2['name']].each do |testStepIndex, testStep_xml|
+              testsuite.testcase(testStep_xml) do |testcase|
+                failure = $failtestStep_xml&.[](testStepReportSummary2['name'])&.[](testStepIndex)
+                skipped = $skiptestStep_xml&.[](testStepReportSummary2['name'])&.[](testStepIndex)
+                testcase.failure(failure) if failure
+                testcase.skipped(skipped) if skipped
+              end
+            end
+          end
+        end
+      end
+    end
+
+    # output XML content to console for debug
+    # puts builder.to_xml
+
+    # open the suite summary file for writing if not already open
+    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"
+    end
+
+    # if the file is open then close it
+    $testSuiteSummaryFile_xml.close unless $testSuiteSummaryFile_xml.closed?
+  end
+end

data/lib/report/report.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+# Created on 20 Sept 2017
+# @author: Andy Perrett
+#
+# Versions:
+# 1.0 - Baseline
+#
+# report.rb - methods for accessing and writing to the test report file(s)
+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
+    f_time = time.strftime('%a %b %d %H:%M:%S %Z')
+    f_time
+  end
+
+  # 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}  "
+
+    step = {
+      'id' => $testStep,
+      'classname' => 'SuiteID: ' + $testId.to_s + ' Test Step: ' + $testStep.to_s + ' ' + $testStepDes.to_s,
+      'name' => $testStepDes,
+      '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
+  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
+      $previousTestFail = $currentTestFail
+      $currentTestFail = false
+      $testStepPasses += 1
+      Report.results.puts("Test #{$testStep} has Passed")
+      puts "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
+      failstep = {
+        'message' => 'SuiteID: ' + $testId.to_s + ' Test Step: ' + $testStep.to_s + ' Test has FAILED - Check logs',
+        'type' => 'FAILURE',
+        'file' => test_file_name
+      }
+      # output to console to show test step failure
+      # puts failstep
+
+      return unless test_file_name
+      $failtestStep_xml ||= {}
+      $failtestStep_xml[test_file_name] ||= []
+      $failtestStep_xml[test_file_name][testStepIndex] = failstep
+    else
+      $currentTestFail = false
+      $testStepNotrun += 1
+      Report.results.puts("Test #{$testStep} no checks performed")
+      puts "Test #{$testStep} no checks performed ".blue
+      skipstep = {
+        'message' => 'SuiteID: ' + $testId.to_s + ' Test Step: ' + $testStep.to_s + ' No checks performed - Check logs',
+        'type' => 'SKIPPED',
+        'file' => test_file_name
+      }
+      # output to console to show test step failure
+      # puts skipstep
+
+      return unless test_file_name
+      $skiptestStep_xml ||= {}
+      $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"
+  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
+    if $previousTestFail && $currentTestFail
+      @consecutiveTestFail += 1
+    else
+      @consecutiveTestFail = 0
+    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)'
+
+      raise FailureThresholdExceeded,
+            "#{consecutiveFailThreshold} Test Steps Failed."
+    end
+  end
+end

data/lib/report/report_summary.rb

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+# Created on 20 Sept 2017
+# @author: Andy Perrett
+#
+# Versions:
+# 1.0 - Baseline
+#
+# report_summary.rb - methods for writing to the test summary report file
+module ReportSummary
+  require_relative '../taf_config.rb'
+  # holds printable test report summary for all the executed tests
+  @testStepReportSummary = []
+  # 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,\
+    "\n" 'Browser type:', $browserType, \
+    "\n" 'Browser version:', Browser.browser_version.to_s, \
+    "\n" 'Environment:', $env_type, \
+    "\n" 'Started at:', $test_case_start_time, \
+    "\n" 'Finished at:', $test_case_end_time, \
+    "\n" 'There are:', $testStepPasses, 'Passes' \
+    "\n" 'There are:', $testStepFailures, 'Failures' \
+    "\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:"
+    @testStepReportSummary.each do |testStepReportSummary|
+      puts 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
+    $totalTests = [$totalTestPasses, $totalTestFailures, $totalTestNotrun].sum
+    puts "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"
+    end
+
+    testSuiteSummaryFile.puts "Finished processing all test files - executed via test suite: #{$testSuiteFile} by tester: #{$tester} \n"
+    testSuiteSummaryFile.puts "\nOverall Test Summary:"
+    @testStepReportSummary.each do |testStepReportSummary|
+      testSuiteSummaryFile.puts testStepReportSummary
+    end
+    testSuiteSummaryFile.puts("\nTotal Tests started at: #{$test_start_time}")
+    testSuiteSummaryFile.puts("Total Tests finished at: #{$test_end_time}")
+    testSuiteSummaryFile.puts('Total Tests duration: ' + TimeDifference.between($test_end_time, $test_start_time).humanize)
+    testSuiteSummaryFile.puts("Total Tests Passed: #{$totalTestPasses}")
+    testSuiteSummaryFile.puts("Total Tests Failed: #{$totalTestFailures}")
+    testSuiteSummaryFile.puts("Total Tests Skipped: #{$totalTestNotrun}")
+    testSuiteSummaryFile.puts("Total Tests: #{$totalTests} \n")
+
+    # if the file is open then close it
+    testSuiteSummaryFile.close unless testSuiteSummaryFile.closed?
+  end
+end

data/lib/taf_config.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Created on 20 Sept 2017
+# @author: Andy Perrett
+#
+# Versions:
+# 1.0 - Baseline
+#
+# taf_config.rb - Framework Config file
+
+# list of all the required gems.
+require 'selenium-webdriver'
+require 'watir'
+require 'rubygems'
+require 'fileutils'
+require 'logger'
+require 'net/ping'
+require 'nokogiri'
+require 'time_difference'
+require 'colored'
+require 'rubyXL'
+
+# list of all the required files
+require_relative './utils/test_steps'
+require_relative './report/report'
+require_relative './utils/browser'
+require_relative './utils/create_directories'
+require_relative './utils/test_engine'
+require_relative './utils/exceptions'
+require_relative './report/junit_report'
+require_relative './report/report_summary'
+require_relative './parser/parser'
+require_relative './parser/xlsx_parser'
+
+# Require all test step handlers, which register themselves with
+# TestStep.handlers when the files are required.
+require_relative './functions/handlers'