taf 0.1.1

data/lib/utils/browser.rb

@@ -0,0 +1,140 @@
+# Created on 02 Aug 2018
+# @author: Andy Perrett
+#
+# Versions:
+# 1.0 - Baseline
+#
+# browser_setup.rb - a browser functions
+module Browser
+  require_relative '../taf_config.rb'
+  # open_browser function
+  def self.open_browser
+    lc_browser_type = $browserType.downcase
+    case lc_browser_type
+    when 'chrome'
+      chrome
+    when 'chrome-headless'
+      chrome_headless
+    when 'firefox'
+      firefox
+    when 'firefox-headless'
+      firefox_headless
+    when 'ie'
+      ie
+    when 'safari'
+      safari
+    else
+      puts "unable to open selected browser: #{lc_browser_type}"
+      raise BrowserFailedOpen
+    end
+  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"\
+                  "the requested browser: #{lc_browser_type} " + error.to_s
+    raise error_text
+  end
+
+  # chrome browser details
+  def self.chrome
+    @browser = Watir::Browser.new :chrome, switches: %w[
+      --acceptInsecureCerts-true --start-maximized --window-size=1920,1080
+    ]
+    browser_version
+  end
+
+  # chrome headless browser details
+  def self.chrome_headless
+    @browser = Watir::Browser.new :chrome, switches: %w[
+      --start-maximized --disable-gpu --headless --acceptInsecureCerts-true
+      --no-sandbox --window-size=1920,1080
+    ]
+    browser_version
+  end
+
+  # firefox browser details
+  def self.firefox
+    caps = Selenium::WebDriver::Remote::Capabilities.firefox
+    caps['acceptInsecureCerts'] = true
+    driver = Selenium::WebDriver.for(:firefox, desired_capabilities: caps)
+    @browser = Watir::Browser.new(driver)
+    browser_full_screen
+    browser_version
+  end
+
+  # firefox headless browser details
+  def self.firefox_headless
+    caps = Selenium::WebDriver::Remote::Capabilities.firefox
+    options = Selenium::WebDriver::Firefox::Options.new(args: ['-headless'])
+    caps['acceptInsecureCerts'] = true
+    driver = Selenium::WebDriver.for(:firefox, options: options,
+                                    desired_capabilities: caps)
+    @browser = Watir::Browser.new(driver)
+    # makes the browser full screen.
+    @browser.driver.manage.window.resize_to(1920, 1200)
+    @browser.driver.manage.window.move_to(0, 0)
+    browser_version
+    # browser
+  end
+
+  # ie browser details
+  def self.ie
+    @browser = Watir::Browser.new :ie
+    browser_full_screen
+    browser_version
+  end
+
+  # sarfari headless browser details
+  def self.safari
+    @browser = Watir::Browser.new :safari
+    browser_full_screen
+    browser_version
+  end
+
+  # makes the browser full screen.
+  def self.browser_full_screen
+    screen_width = @browser.execute_script('return screen.width;')
+    screen_height = @browser.execute_script('return screen.height;')
+    @browser.driver.manage.window.resize_to(screen_width, screen_height)
+    @browser.driver.manage.window.move_to(0, 0)
+  end
+
+  # define browser value
+  def self.b
+    browser = @browser
+  end
+
+  # Check browser version
+  def self.browser_version
+    browserversion = @browser.driver.capabilities[:version]
+  rescue StandardError
+    browserversion = '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(full_sc_dirname, screen_shot)
+    if ($currentTestFail || screen_shot)
+      time = Time.now.strftime('%H%M')
+      if ($currentTestFail)
+        scFileName = full_sc_dirname + "/Test_step-#{$testStep}_Failed_"\
+                                        "#{time}.png"
+      else
+        # file name will be teststep.png
+        scFileName = full_sc_dirname + "/Test_step-#{$testStep}_#{time}.png"
+      end
+
+      # Screenshot capture for websites
+      Browser.b.screenshot.save scFileName
+      Report.results.puts("Screenshot saved to: #{scFileName}")
+      else
+        Report.results.puts 'No screenshot requested'
+      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}")
+  end
+end

data/lib/utils/create_directories.rb

@@ -0,0 +1,94 @@
+# frozen_string_literal: true
+
+# Created on 20 Sept 2017
+# @author: Andy Perrett
+#
+# Versions:
+# 1.0 - Baseline
+#
+# create_directories.rb - Creates folder structures.
+module CreateDirectories
+  # create the project directories and open the test results file,
+  # returns the screenshot directory name, the screenshot will be placed in a
+  # unique filename based upon the testStep.
+  # A single top-level directory named after the Project ID will be used and the
+  # target sub-directories will be created for each run of the test
+  #
+  # ----> Project directory (working directory)
+  #
+  # ------->directory named after the test run number
+  #
+  # ---------->directory named after test_id (with browser type identified)
+  #
+  # ------------->directory named 'Test_Results'
+  #
+  # ------------->directory named 'Screenshots'
+
+  def self.construct_projectdirs
+    # create top-level 'Results' directory if it doesn't already exist
+    result_home = 'Results'
+    Dir.mkdir(result_home) unless File.directory? result_home
+
+    # create the 'Project' directory if it doesn't already exist
+    project_id = $projectId.delete(' ')
+    project_iddir = result_home + '/' + project_id
+    Dir.mkdir(project_iddir) unless File.directory? project_iddir
+
+    # Creates a folder Ran_on_Time with the time as of now.
+    time = Time.new
+    f_date = time.strftime('%d-%b-%Y')
+    f_time = time.strftime('%H_%M_%S')
+    $runNoDir = project_iddir + '/' + 'Ran_on_' + f_date + '_' + f_time
+    Dir.mkdir($runNoDir)
+  end
+
+  def self.construct_testspecdirs
+    # create directories for each test spec
+    # create a sub-directory named from the 'testId' (with any spaces taken out)
+    # if it doesn't already exist plus the browser type
+    testid_dir = $runNoDir + '/' + $testId.delete(' ') + '_' + $browserType.capitalize
+    Dir.mkdir(testid_dir) unless File.directory? testid_dir
+
+    # create a screenshot directory under the 'testId' directory - it will always need creating
+    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'
+
+    # the test suite summary is a XML report generated will be called 'suite_summary.xml'
+    time = Time.new
+    f_date = time.strftime('%d-%b-%Y')
+    f_time = time.strftime('%H_%M_%S')
+
+    $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}"
+
+  # if any issues then set error message and re-raise the exception
+  rescue Exception => 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
+  else
+    # if no exception then return the screenshot file directory path
+    abs_path_screenshot_dir
+  end
+end

data/lib/utils/exceptions.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class TafError < StandardError; end
+class UnknownTestStep < TafError; end
+class FailureThresholdExceeded < TafError; end
+class BrowserFailedOpen < TafError; end
+class SecurityFailedOpen < TafError; end

data/lib/utils/test_engine.rb

@@ -0,0 +1,164 @@
+# frozen_string_literal: true
+
+# Created on 20 Sept 2017
+# @author: Andy Perrett
+#
+# Versions:
+# 1.0 - Baseline
+#
+# test_engine.rb - controls the iteration through the test suite and specs
+module TestEngine
+  require_relative '../taf_config.rb'
+
+  # process the test files to execute the tests
+  def self.process_testfiles
+    test_file_name = ''
+
+    # initialise the index for reading the list of test file names
+    test_file_name_index = 0
+
+    # get the overall test start time
+    $test_start_time = Report.current_time
+
+    # create project folders - these only need creating once per test suite
+    CreateDirectories.construct_projectdirs
+
+    # loop through all the available test files to execute the tests
+    while test_file_name_index < $numberOfTestSpecs
+      # get the next test spec data from the test suite doc
+      test_suites = Parser.parse_test_suite_data(test_file_name_index)
+
+      test_suites.each do |test_suite|
+        $testId = test_suite[:id]
+        $testSpecDesc = test_suite[:specdesc]
+        $env_type = test_suite[:env]
+        $browserType = test_suite[:browser]
+        $securityTest = test_suite[:securitytest]
+
+        if ARGV.length < 2
+          $browserType = test_suite[:browser]
+          $securityTest = test_suite[:securitytest]
+          puts ''
+          puts "Will use the following browser from Test Suite: #{$browserType}"
+          puts ''
+        elsif ARGV.length < 3
+          $browserType = ARGV[1]
+          $securityTest = ARGV[2]
+          puts "\nWill use the following browser from CMD line: " + ARGV[1]
+          puts ''
+        elsif ARGV.length < 4
+          $securityTest = ARGV[2]
+          puts "\nWill use the following browser from CMD line: " + ARGV[2]
+          puts ''
+        else
+          raise IOError, 'Unable to open browser'  
+        end
+
+        # if ARGV.length < 2
+        #   $browserType = test_suite[:browser]
+        #   puts ''
+        #   puts "Will use the following browser from Test Suite: #{$browserType}"
+        #   puts ''
+        # elsif ARGV.length < 3
+        #   $browserType = ARGV[1]
+        #   puts "\nWill use the following browser from CMD line: " + ARGV[1]
+        #   puts ''
+        # else
+        #   raise IOError, 'Unable to open browser'  
+        # end
+
+        # remove any unwanted end-of-line characters from the file name
+        test_file_name = $testSpecDesc
+
+        begin # start of rescue block for readTestData
+          # read in the test data
+          testFileType = 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
+          $stderr.puts "Terminating the current test case: " \
+                       "#{test_file_name} #{error}"
+          $stderr.puts '...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
+          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
+        $test_case_end_time = Report.current_time
+
+        begin
+          test_steps = Parser.parse_test_step_data(testFileType)
+
+          test_steps.each_with_index do |test_step, index|
+            $testStep         = test_step[:testStep]
+            $testStepDes      = test_step[:testdesc]
+            screen_shot       = test_step[:screenShotData]
+
+            # process the test step data
+            TestSteps.process_test_steps(test_file_name, index, test_step)
+            # see if screenshot required
+            Browser.check_save_screenshot(full_sc_dirname, screen_shot)
+          end
+        rescue TafError => error
+          warn error
+          $log.puts error
+        end
+
+        # get the test case end time
+        $test_case_end_time = 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_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
+
+        # increment loop counter to move onto next test file
+        test_file_name_index += 1
+
+        # 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
+      end
+    end # while loop for test files
+  end
+end

data/lib/utils/test_steps.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# Created on 20 Sept 2017
+# @author: Andy Perrett
+#
+# Versions:
+# 1.0 - Baseline
+#
+# 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)
+    # print the test step information
+    Report.print_test_step_header(test_file_name, teststepindex)
+ 
+    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)
+      return true
+    else
+      Report.results.puts("\nUnable to match function: #{step_function}")
+      puts "\nUnable to match function: #{step_function}"
+      raise UnknownTestStep, "Unknown test step: #{step_function}"
+      return false
+    end
+  end
+end

data/lib/utils/zap.rb

@@ -0,0 +1,131 @@
+# Created on 22 Oct 2018
+# @author: Andy Perrett
+#
+# Versions:
+# 1.0 - Baseline
+#
+# Zap.rb - Zap functions
+module Zap
+  # require './taf_config.rb'
+  # zap_check function
+  def self.zap_check
+    security_test = $securityTest.downcase
+    case security_test
+    when 'yes'
+      run_zap
+    when 'no'
+      puts "No Security Test required."
+    else
+      puts "unable to run security test: #{security_test}"
+      raise SecurityFailedOpen
+    end
+  rescue SecurityFailedOpen => error
+    # construct the error message from custom text and the actual system error
+    # message (converted to a string)
+    error_text = "unable to run security test: #{security_test} " + error.to_s
+    raise error_text
+  end
+
+  # run zap security test
+  def self.run_zap
+    @browser = Watir::Browser.new :chrome, switches: %w[
+      --acceptInsecureCerts-true --start-maximized --window-size=1920,1080
+    ]
+    browser_version
+  end
+
+  # chrome headless browser details
+  def self.chrome_headless
+    @browser = Watir::Browser.new :chrome, switches: %w[
+      --start-maximized --disable-gpu --headless --acceptInsecureCerts-true
+      --no-sandbox --window-size=1920,1080
+    ]
+    browser_version
+  end
+
+  # firefox browser details
+  def self.firefox
+    caps = Selenium::WebDriver::Remote::Capabilities.firefox
+    caps['acceptInsecureCerts'] = true
+    driver = Selenium::WebDriver.for(:firefox, desired_capabilities: caps)
+    @browser = Watir::Browser.new(driver)
+    browser_full_screen
+    browser_version
+  end
+
+  # firefox headless browser details
+  def self.firefox_headless
+    caps = Selenium::WebDriver::Remote::Capabilities.firefox
+    options = Selenium::WebDriver::Firefox::Options.new(args: ['-headless'])
+    caps['acceptInsecureCerts'] = true
+    driver = Selenium::WebDriver.for(:firefox, options: options,
+                                    desired_capabilities: caps)
+    @browser = Watir::Browser.new(driver)
+    # makes the browser full screen.
+    @browser.driver.manage.window.resize_to(1920, 1200)
+    @browser.driver.manage.window.move_to(0, 0)
+    browser_version
+    # browser
+  end
+
+  # ie browser details
+  def self.ie
+    @browser = Watir::Browser.new :ie
+    browser_full_screen
+    browser_version
+  end
+
+  # sarfari headless browser details
+  def self.safari
+    @browser = Watir::Browser.new :safari
+    browser_full_screen
+    browser_version
+  end
+
+  # makes the browser full screen.
+  def self.browser_full_screen
+    screen_width = @browser.execute_script('return screen.width;')
+    screen_height = @browser.execute_script('return screen.height;')
+    @browser.driver.manage.window.resize_to(screen_width, screen_height)
+    @browser.driver.manage.window.move_to(0, 0)
+  end
+
+  # define browser value
+  def self.b
+    browser = @browser
+  end
+
+  # Check browser version
+  def self.browser_version
+    browserversion = @browser.driver.capabilities[:version]
+  rescue StandardError
+    browserversion = '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(full_sc_dirname, screen_shot)
+    if ($currentTestFail || screen_shot)
+      time = Time.now.strftime('%H%M')
+      if ($currentTestFail)
+        scFileName = full_sc_dirname + "/Test_step-#{$testStep}_Failed_"\
+                                        "#{time}.png"
+      else
+        # file name will be teststep.png
+        scFileName = full_sc_dirname + "/Test_step-#{$testStep}_#{time}.png"
+      end
+
+      # Screenshot capture for websites
+      Browser.b.screenshot.save scFileName
+      Report.results.puts("Screenshot saved to: #{scFileName}")
+      else
+        Report.results.puts 'No screenshot requested'
+      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}")
+  end
+end