taf 0.3.7 → 0.3.8

data/lib/functions/handlers/select_dropdown.rb

@@ -1,24 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base_handler'
-
-module TestSteps
-  module Handlers
-    # Select Dropdown function.
-    class SelectDropdown < Base
-      register :select_dropdown
-
-      def perform
-        ele = Browser.b.select_list("#{@locate}": @value)
-
-        ele.wait_until(&:exists?)
-        ele.option("#{@locate2}": @value2.to_s).select
-        MyLog.log.info("Dropdown item: #{@value2} has been selected")
-        true
-      rescue StandardError
-        MyLog.log.warn("Dropdown item: #{@value2} has NOT been selected")
-        false
-      end
-    end
-  end
-end

data/lib/functions/handlers/send_special_keys.rb

@@ -1,22 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base_handler'
-
-module TestSteps
-  module Handlers
-    # Send a Special Key function.
-    class SendSpecialKeys < Base
-      register :send_special_keys
-
-      def perform
-        Browser.b.send_keys :"#{@value}"
-        sleep 1
-        MyLog.log.info("Browser Sent key: :#{@value} successfully")
-        true
-      rescue StandardError
-        MyLog.log.warn("Browser Failed to Send key: :#{@value}")
-        false
-      end
-    end
-  end
-end

data/lib/functions/handlers/write_box_data.rb

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-require_relative 'base_handler'
-
-module TestSteps
-  module Handlers
-    # Write box data function.
-    class WriteBoxdata < Base
-      register :write_box_data
-
-      def perform
-        txt = @value2
-        txt = ENV[txt.to_s] if ENV[txt.to_s]
-        elms = %i[textarea text_field iframe]
-
-        found_box = elms.map do |elm|
-          Browser.b.send(elm, "#{@locate}": @value).exists?
-        end.compact
-
-        raise 'Multiple matches' if found_box.select { |i| i }.empty?
-
-        index = found_box.index(true)
-        return unless index
-
-        Browser.b.send(elms[index], "#{@locate}": @value)
-               .wait_until(&:exists?).send_keys txt
-        MyLog.log.info("Textbox: #{@value} has correct value: #{txt}")
-        true
-      rescue StandardError
-        MyLog.log.warn("Textbox: #{@value} does not exist")
-        false
-      end
-    end
-  end
-end

data/lib/main.rb

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-# Created on 20 Sept 2017
-# @author: Andy Perrett
-#
-# Versions:
-# 1.0 - Baseline
-#
-# main.rb - Framework Driver Script
-module Main
-  require_relative './taf_config.rb'
-
-  # parses the cmd line imput into the taf
-  CMDLine.cmdline_input
-
-  # get the overall test suite end time
-  ts_start_time = Report.current_time
-
-  # process the test files to execute the tests
-  total_passes, total_failures, total_skipped = TestEngine.process_testfiles
-  total_metrics = [total_passes, total_failures, total_skipped]
-  # get the overall test suite end time
-  ts_end_time = Report.current_time
-
-  # output the overall test summary
-  ReportSummary.overall_test_summary(ts_start_time, ts_end_time, total_metrics)
-  JunitReport.test_summary_junit(ts_start_time, ts_end_time, total_metrics)
-
-  # Exit status code.
-  Process.exit(total_failures.zero? ? 0 : 1)
-end

data/lib/parser/json_parser.rb

@@ -1,50 +0,0 @@
-# frozen_string_literal: true
-
-# Created on 02 Aug 2018
-# @author: Andy Perrett
-#
-# Versions:
-# 1.0 - Baseline
-#
-# json_parser.rb - json parser functions
-module JsonParser
-  require_relative '../taf_config.rb'
-
-  def self.parse_test_header_data(parse_json)
-    # get the number of test steps in the file
-    number_test_steps = parse_json['steps'].count
-    # get the remaining test data
-    @test_id = parse_json['testId']
-    @project_id = parse_json['projectId']
-    test_des = parse_json['testDescription']
-    MyLog.log.info "Number of test steps: #{number_test_steps}"
-    MyLog.log.info "Test Description: #{test_des}"
-    MyLog.log.info "TestID: #{@test_id} \n"
-  end
-
-  def self.test_id
-    @test_id
-  end
-
-  def self.project_id
-    @project_id
-  end
-
-  # parseTestStepData
-  def self.parse_test_step_data(parse_json)
-    parsed_step = {
-      testdesc: parse_json['description'],
-      testFunction: parse_json['function'].downcase,
-      testvalue: parse_json['value0'],
-      locate: parse_json['value1'] || 'id',
-      testvalue2: parse_json['value2'],
-      locate2: parse_json['value3'] || 'id',
-      skipTestCase: parse_json['skipTestCase'] == 'yes'
-    }
-
-    parsed_step
-    # if an error reading the test step data then re-raise the exception
-  rescue StandardError => e
-    raise e
-  end
-end

data/lib/parser/parser.rb

@@ -1,49 +0,0 @@
-# frozen_string_literal: true
-
-# Created on 02 Aug 2018
-# @author: Andy Perrett
-#
-# Versions:
-# 1.0 - Baseline
-#
-# parser.rb - basic parser functions
-module Parser
-  require_relative '../taf_config.rb'
-
-  def self.test_files
-    @test_files ||= Dir.glob("#{CMDLine.tests_folder}/*.json").reject do |file|
-      File.basename(file).start_with?('~$')
-    end.sort
-  end
-
-  # readTestData
-  def self.read_test_data(test_file_name)
-    # get the file type
-    file_type = File.extname(test_file_name)
-    if file_type.casecmp('.json').zero?
-      MyLog.log.info "Processing test file: #{test_file_name}"
-      json = File.read(test_file_name)
-      parse_json = JSON.parse(json)
-
-      JsonParser.parse_test_header_data(parse_json)
-      return parse_json
-    else
-      # if unable to read the test file list then construct a custom error
-      # message and raise an exception.
-      MyLog.log.info 'Not a valid JSON File Type' if test_file_name != 'JSON'
-      error_to_display = "Test File Name: '#{test_file_name}' " \
-                         'type not recognised (must be .xslx or .json)'
-      raise IOError, error_to_display
-    end
-
-    # if an error occurred reading the test file list then
-    # re-raise the exception.
-  rescue StandardError => e
-    raise IOError, e
-  end
-
-  # parseTestStepData
-  def self.parse_test_step_data(parse_json)
-    JsonParser.parse_test_step_data(parse_json)
-  end
-end

data/lib/report/junit_report.rb

@@ -1,74 +0,0 @@
-# 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
-  @test_step_report_summary2 = []
-  # construct the test suite header for junit
-  def self.test_step_summary_xml(test_file_name, test_file_name_index,
-                                 tc_start, tc_end, metrics)
-    number_test_steps = [metrics.stepFailures, metrics.stepPasses,
-                         metrics.stepSkipped].sum
-    @test_step_report_summary2[test_file_name_index] = {
-      'classname' => test_file_name,
-      'name' => test_file_name,
-      'assertions' => number_test_steps,
-      'failures' => metrics.stepFailures,
-      'tests' => metrics.stepPasses,
-      'skipped' => metrics.stepSkipped,
-      'time' => TimeDifference.between(
-        tc_end, tc_start
-      ).in_seconds
-    }
-  end
-
-  def self.test_summary_junit(ts_start_time, ts_end_time, total_metrics)
-    # output to XML file format for Junit for CI.
-    builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
-      testsuite_attrs = {
-        'classname' => CMDLine.tests_folder.to_s,
-        'name' => CMDLine.tests_folder.to_s,
-        'tests' => total_metrics[0].to_s,
-        'failures' => total_metrics[1].to_s,
-        'timestamp' => ts_start_time.to_s,
-        'skipped' => total_metrics[2].to_s,
-        'time' => TimeDifference.between(ts_end_time, ts_start_time)
-                                .in_seconds
-      }
-      xml.testsuites(testsuite_attrs) do |testsuites|
-        @test_step_report_summary2.each do |test_step_report_summary2|
-          testsuites.testsuite(test_step_report_summary2) do |testsuite|
-            $testStep_xml[test_step_report_summary2['name']]
-              .each do |test_step_idx, test_step_xml|
-              testsuite.testcase(test_step_xml) do |testcase|
-                failure = $failtestStep_xml
-                  &.[](test_step_report_summary2['name'])&.[](test_step_idx)
-                skipped = $skiptestStep_xml
-                  &.[](test_step_report_summary2['name'])&.[](test_step_idx)
-                testcase.failure(failure) if failure
-                testcase.skipped(skipped) if skipped
-              end
-            end
-          end
-        end
-      end
-    end
-
-    # the test suite summary is a XML report generated will be called
-    # 'report_uuid.xml'
-    project_id = JsonParser.project_id.delete(' ')
-    xml_dir = File.join('Results', project_id)
-    ts_xml_file = "#{xml_dir}/report_#{SecureRandom.uuid}.xml"
-
-    ts_summary_file_xml = File.open(ts_xml_file, 'w')
-    ts_summary_file_xml.write builder.to_xml
-    ts_summary_file_xml.close
-  end
-end

data/lib/report/report.rb

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-# Created on 20 Sept 2017
-# @author: Andy Perrett
-#
-# Versions:
-# 1.0 - Baseline
-#
-# report.rb - methods for outputting console.
-module Report
-  require_relative '../taf_config.rb'
-
-  # get the current time in the format Day - Month - Date - Time (HH:MM:SS)
-  def self.current_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, test_step_idx, test_desc)
-    @test_start_time = current_time
-    MyLog.log.info "Test step: #{test_step_idx} : #{test_desc}"
-
-    step = {
-      'id' => test_step_idx,
-      'classname' => "SuiteID: #{JsonParser.test_id}" \
-      " Test Step: #{test_step_idx} #{test_desc}",
-      'name' => test_desc,
-      '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][test_step_idx] = step
-  end
-
-  # print the Pass / Fail status of a test to the test results file
-  def self.test_pass_fail(pass_fail, test_file_name, test_step_idx, metrics)
-    if pass_fail == true
-      @current_test_fail = false
-      metrics.stepPasses += 1
-      MyLog.log.info "Test #{test_step_idx} has Passed ".green
-    elsif pass_fail == false
-      @current_test_fail = true
-      metrics.stepFailures += 1
-      MyLog.log.info "Test #{test_step_idx} has FAILED ".red
-      sc_file_name = Screenshot.save_screenshot(test_step_idx)
-      failstep = {
-        'message' => "SuiteID: #{JsonParser.test_id}" \
-        " Test Step: #{test_step_idx} Test has" \
-         " FAILED - Check logs, see Screenshot: #{sc_file_name}",
-        '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][test_step_idx] = failstep
-    else
-      @current_test_fail = false
-      metrics.stepSkipped += 1
-      MyLog.log.info "Test #{test_step_idx} no checks performed ".blue
-      skipstep = {
-        'message' => "SuiteID: #{JsonParser.test_id}" \
-        " Test Step: #{test_step_idx} 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][test_step_idx] = skipstep
-    end
-    test_end_time = current_time
-
-    test_duration = TimeDifference.between(
-      test_end_time, @test_start_time
-    ).humanize || 0
-    MyLog.log.info "Test step duration: #{test_duration} \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)
-    consecutive_fail_threshold = 5
-    if @current_test_fail
-      @consecutive_test_fail += 1
-    else
-      @consecutive_test_fail = 0
-    end
-
-    return if @consecutive_test_fail < consecutive_fail_threshold
-
-    # write info to stdout
-    MyLog.log.warn "Terminating the current test file: #{test_file_name} as" \
-      " the test failure threshold (#{@consecutive_test_fail}) has been" \
-      ' reached.'
-    MyLog.log.warn '...continuing with the next test file (if there is one)'
-
-    raise FailureThresholdExceeded,
-          "test failure threshold (#{@consecutive_test_fail}) has been reached"
-  end
-end

data/lib/report/report_summary.rb

@@ -1,53 +0,0 @@
-# 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
-  @test_step_report_summary = []
-  # output the test results summary for the current test case
-  def self.test_step_summary(test_file_name, test_file_name_index, metrics)
-    @test_step_report_summary[test_file_name_index] = <<~TEXT
-      Test file executed: #{test_file_name}
-      Browser Type: #{CMDLine.browser_type}
-      Browser Version: #{Browser.browser_version}
-      There are: #{metrics.stepPasses} Passes
-      There are: #{metrics.stepFailures} Failures
-      There are: #{metrics.stepSkipped} Skipped Tests \n
-    TEXT
-  end
-
-  # output the overall test results summary
-  def self.overall_test_summary(ts_start_time, ts_end_time, total_metrics)
-    # output to the console
-
-    MyLog.log.info 'Finished processing all test files ' \
-      "from the following test folder: #{CMDLine.tests_folder}"
-    MyLog.log.info "Overall Test Summary: \n"
-    @test_step_report_summary.each do |test_step_report_summary|
-      test_step_report_summary.each_line do |line|
-        MyLog.log.info(line.strip)
-      end
-    end
-
-    duration = TimeDifference.between(
-      ts_end_time, ts_start_time
-    ).humanize || 0
-
-    MyLog.log.info "Total Tests started at: #{ts_start_time}"
-    MyLog.log.info "Total Tests finished at: #{ts_end_time}"
-    MyLog.log.info "Total Tests duration: #{duration}"
-    MyLog.log.info "Total Tests Passed: #{total_metrics[0]}".green
-    MyLog.log.info "Total Tests Failed: #{total_metrics[1]}".red
-    MyLog.log.info "Total Tests Skipped: #{total_metrics[2]}".blue
-    total_tests = [total_metrics[0], total_metrics[1],
-                   total_metrics[2]].sum
-    MyLog.log.info "Total Tests: #{total_tests}\n"
-  end
-end