taf 0.3.7 → 0.3.8

data/lib/taf_config.rb

@@ -1,46 +0,0 @@
-# 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 'optparse'
-require 'fileutils'
-require 'securerandom'
-require 'json'
-
-# list of all the required files
-require_relative './utils/test_steps'
-require_relative './report/report'
-require_relative './utils/browser'
-require_relative './utils/cmd_line'
-require_relative './utils/create_directories'
-require_relative './utils/logger'
-require_relative './utils/test_engine'
-require_relative './utils/screenshot'
-require_relative './utils/exceptions'
-require_relative './report/junit_report'
-require_relative './report/report_summary'
-require_relative './parser/parser'
-require_relative './parser/json_parser'
-
-# Require all test step handlers, which register themselves with
-# TestStep.handlers when the files are required.
-require_relative './functions/handlers'
-
-# Watir config. set wait:
-Watir.default_timeout = 60

data/lib/utils/browser.rb

@@ -1,98 +0,0 @@
-# frozen_string_literal: true
-
-# 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 = CMDLine.browser_type.downcase
-    case lc_browser_type
-    when 'chrome'
-      chrome
-    when 'chrome-headless'
-      chrome_headless
-    when 'firefox'
-      firefox
-    when 'firefox-headless'
-      firefox_headless
-    else
-      MyLog.log.error "unable to open selected browser: #{lc_browser_type}"
-      raise BrowserFailedOpen
-    end
-  rescue BrowserFailedOpen => e
-    # 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} " + e.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
-    ]
-  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
-    ]
-  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
-  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)
-  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
-  end
-
-  # Check browser version
-  def self.browser_version
-    browser_name = CMDLine.browser_type.downcase
-    case browser_name
-    when 'chrome', 'chrome-headless'
-      @browser.driver.capabilities[:version]
-    when 'firefox', 'firefox-headless'
-      @browser.execute_script('return navigator.userAgent;').split('/')[-1]
-    end
-  rescue StandardError
-    'No Browser version'
-  end
-end

data/lib/utils/cmd_line.rb

@@ -1,71 +0,0 @@
-# frozen_string_literal: true
-
-# Created on 13 May 2019
-# @author: Andy Perrett
-#
-# Versions:
-# 1.0 - Baseline
-#
-# cmd_line.rb - command line script Script
-module CMDLine
-  require_relative '../taf_config.rb'
-
-  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
-
-      parser.on(
-        '-b',
-        '--browser browser',
-        'Supported Browsers: chrome,' \
-        ' chrome-headless, firefox, firefox-headless'
-      ) do |b|
-        options[:browser] = b
-        @browser_type = options[:browser]
-        unless ['chrome', 'chrome-headless', 'firefox', 'firefox-headless']
-               .include?(@browser_type)
-          MyLog.log.warn 'A valid Browser has not been supplied as a' \
-            ' command-line parameter as expected'
-          Process.exit
-        end
-      end
-
-      parser.on('-t', '--tests testfolder', 'i.e. tests/') do |t|
-        options[:testfolder] = t
-        @tests_folder = 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
-    end.parse!
-  end
-
-  def self.browser_type
-    @browser_type
-  end
-
-  def self.tests_folder
-    @tests_folder
-  end
-end

data/lib/utils/create_directories.rb

@@ -1,50 +0,0 @@
-# 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,
-  # 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 ID UUID
-
-  def self.construct_projectdirs
-    # create top-level directory if it doesn't already exist:
-    # Results/Project_id
-    project_id = JsonParser.project_id.delete(' ')
-    project_dir = File.join('Results', project_id)
-
-    FileUtils.mkdir_p(project_dir)
-
-    # Generate UUID
-    @run_uuid = SecureRandom.uuid
-  end
-
-  def self.construct_testspecdirs
-    # create directories for each test spec for screenshots:
-    # Results/Project_id/Run_ID_UUID
-    project_id = JsonParser.project_id.delete(' ')
-    screenshot_dir = File.join('Results', project_id, "Run_ID_#{@run_uuid}")
-
-    abs_path_screenshot_dir = File.absolute_path(screenshot_dir)
-    FileUtils.mkdir_p(abs_path_screenshot_dir)
-    # if any issues then set error message and re-raise the exception
-  rescue StandardError => e
-    # construct the error message from custom text and the actual system error
-    # message (converted to a string)
-    error_to_display = 'Error creating directory:' + e.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

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

data/lib/utils/logger.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-# Created on 04 Feb 2019
-# @author: Andy Perrett
-#
-# Versions:
-# 1.0 - Baseline
-#
-# logger.rb - logger file
-# Logger function.
-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/screenshot.rb

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-# Created on 07 May 2019
-# @author: Andy Perrett
-#
-# Versions:
-# 1.0 - Baseline
-#
-# screenshot.rb - a screenshot save function
-module Screenshot
-  require_relative '../taf_config.rb'
-
-  # create screenshot filename and save the screenshot if the test has failed.
-  def self.save_screenshot(test_step_idx)
-    time = Time.now.strftime('%H%M')
-    sc_dir = CreateDirectories.construct_testspecdirs
-
-    sc_file_name = "#{sc_dir}/Test_ID-#{JsonParser.test_id.delete(' ')}"\
-                      "_Test_step-#{test_step_idx}_Failed_#{time}.png"
-
-    # Screenshot capture for websites
-    Browser.b.screenshot.save sc_file_name
-    MyLog.log.info("Screenshot saved to: #{sc_file_name} \n")
-    sc_file_name
-  rescue StandardError => e
-    # construct the error message from custom text and the actual system
-    # error message (converted to a string).
-    MyLog.log.warn("Error saving the screenshot: #{sc_file_name}   #{e}")
-  end
-end

data/lib/utils/test_engine.rb

@@ -1,77 +0,0 @@
-# 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
-    total_passes = 0
-    total_failures = 0
-    total_skipped = 0
-
-    # loop through all the available test files to execute the tests
-    Parser.test_files.each_with_index do |test_file_name, test_file_index|
-      metrics = Struct.new(:stepPasses, :stepFailures, :stepSkipped)
-                      .new(0, 0, 0)
-
-      begin
-        # read in the test data
-        tests = Parser.read_test_data(test_file_name)
-        # if unable to read the test data, show the error and move onto the
-        # next file (if there is one)
-      rescue StandardError => e
-        MyLog.log.warn 'Terminating the current test spec: ' \
-                     "#{test_file_name} #{e}"
-        MyLog.log.info '...continuing with the next test file (if there is one)'
-      end
-
-      # create project folders - these only need creating once per test suite
-      CreateDirectories.construct_projectdirs
-
-      # get the test case start time
-      tc_start = Report.current_time
-
-      begin
-        tests['steps'].each_with_index do |test_step, test_step_idx|
-          test_step_idx += 1
-
-          parsed_steps = Parser.parse_test_step_data(test_step)
-
-          # process the test step data
-          TestSteps.process_test_steps(test_file_name, test_step_idx,
-                                       parsed_steps, metrics)
-        end
-      rescue TafError => e
-        warn e
-        MyLog.log.warn e
-      end
-
-      # get the test case end time
-      tc_end = Report.current_time
-
-      # output the test results summary for the current test case,
-      # pass in the test file number to save the summary against it's testfile
-      ReportSummary.test_step_summary(test_file_name, test_file_index, metrics)
-      JunitReport.test_step_summary_xml(test_file_name, test_file_index,
-                                        tc_start, tc_end, metrics)
-
-      # close the browser if created
-      Browser.b.quit
-
-      # record total passes and failures and reset the failure counters for
-      # the test steps
-      total_passes   += metrics.stepPasses
-      total_failures += metrics.stepFailures
-      total_skipped  += metrics.stepSkipped
-    end
-
-    [total_passes, total_failures, total_skipped]
-  end
-end

data/lib/utils/test_steps.rb

@@ -1,38 +0,0 @@
-# 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, test_step_idx, step_attributes,
-                              metrics)
-    # print the test step information
-    Report.print_test_step_header(test_file_name, test_step_idx,
-                                  step_attributes[:testdesc])
-    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, test_step_idx, metrics)
-      Report.check_failure_threshold(test_file_name)
-      return true
-    else
-      MyLog.log.warn "\nUnable to match function: #{step_function}"
-      raise UnknownTestStep, "Unknown test step: #{step_function}"
-    end
-  end
-end