taf 0.3.7 → 0.3.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 436860d3248c2b1548a9409a70f6edafe44c1f3239c8ec03fb1991b69e6a45e5
-  data.tar.gz: 97ded2847979e394f7a01680d1274fea84d69aa65b4f46b4612c22c541cf96eb
+  metadata.gz: fdf9086f0e77fd7b425360f96cd7ce31eb009af1108cbaf87f2db5074741a247
+  data.tar.gz: b1d008e6ad5536addcfb8968581f5c161d751a4e98688d6f435d2b39fd9cb66b
 SHA512:
-  metadata.gz: 9a814d67bcbc4f17493282b383b4874a2bd6b94e09db6e6478a897ee477f825a3baebdbb14e6ca6630044721a71bd3c105d0aaecd0aafb93538da4820332de04
-  data.tar.gz: '04829e2953ad7ab526f8603ecec94f6373244843f1b353848b9eba45e24d53e431113b7b9059705506097ca364a049c1379b4d7ee007f39285c18d69317586bc'
+  metadata.gz: d1983aa74c176c657c4aa4ebf13f49ef401f084f369f738a923102fe3d72cacc4fe054e63fba75fd7557c37739791d906c05a437ea9b0739b916a5ee2a2b3489
+  data.tar.gz: c4062ab7558b5591d8ac095f7f17d1d881d2a2abc56cc29090046732e4a33dfbb25cabe6312e59cf0d402ed7767dcf1f17802d690d7864beef4fe93052ea3746

data/bin/taf

@@ -1,5 +1,26 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'version.rb'
-require 'main.rb'
+require 'taf'
+
+# parses the cmd line imput into the taf
+Taf::CMDLine.cmdline_input
+
+# get the overall test suite end time
+ts_start_time = Taf::Report.current_time
+
+# process the test files to execute the tests
+total_passes, total_failures, total_skipped =
+  Taf::TestEngine.process_testfiles
+total_metrics = [total_passes, total_failures, total_skipped]
+# get the overall test suite end time
+ts_end_time = Taf::Report.current_time
+
+# output the overall test summary
+Taf::ReportSummary.overall_test_summary(ts_start_time, ts_end_time,
+                                        total_metrics)
+Taf::JUnitReport.test_summary_junit(ts_start_time, ts_end_time,
+                                    total_metrics)
+
+# Exit status code.
+Process.exit(total_failures.zero? ? 0 : 1)

data/lib/taf.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Taf is the main namespace for this project.
+module Taf
+  class TafError < StandardError; end
+  class UnknownTestStep < TafError; end
+  class FailureThresholdExceeded < TafError; end
+  class BrowserFailedOpen < TafError; end
+  class LoginTypeFailed < TafError; end
+
+  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'
+
+  require 'taf/browser'
+  require 'taf/cmd_line'
+  require 'taf/create_directories'
+  require 'taf/json_parser'
+  require 'taf/junit_report'
+  require 'taf/my_log'
+  require 'taf/parser'
+  require 'taf/report'
+  require 'taf/report_summary'
+  require 'taf/screenshot'
+  require 'taf/test_engine'
+  require 'taf/test_steps'
+  require 'taf/test_steps/handlers/base'
+  require 'taf/version'
+
+  # Load all handlers.
+  Dir[File.expand_path('taf/test_steps/handlers/base/*.rb', __dir__)]
+    .each do |f|
+    require f
+  end
+
+  # Watir config. set wait:
+  Watir.default_timeout = 60
+end

data/lib/taf/browser.rb

@@ -0,0 +1,103 @@
+# frozen_string_literal: true
+
+# Created on 02 Aug 2018
+# @author: Andy Perrett
+#
+# Versions:
+# 1.0 - Baseline
+#
+module Taf
+  # browser_setup.rb - a browser functions
+  module Browser
+    # open_browser function
+    def self.open_browser
+      browser = Taf::CMDLine.browser_type.downcase
+      case browser
+      when 'chrome' then chrome
+      when 'chrome-headless' then chrome_headless
+      when 'firefox' then firefox
+      when 'firefox-headless' then firefox_headless
+      else
+        raise Taf::BrowserFailedOpen,
+              "unable to open selected browser: #{browser}"
+      end
+    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 = Taf::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
+
+    # Check platform
+    def self.browser_platform
+      browser_name = Taf::CMDLine.browser_type.downcase
+      case browser_name
+      when 'chrome', 'chrome-headless'
+        @browser.execute_script('return navigator.userAgent;')
+                .split(';')[1].split(')')[0]
+      when 'firefox', 'firefox-headless'
+        @browser.execute_script('return navigator.userAgent;').split(';')[1]
+      end
+    rescue StandardError
+      'No Platform found'
+    end
+  end
+end

data/lib/taf/cmd_line.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+# Created on 13 May 2019
+# @author: Andy Perrett
+#
+# Versions:
+# 1.0 - Baseline
+#
+module Taf
+  # cmd_line.rb - command line script Script
+  module CMDLine
+    def self.help
+      puts '  Usage: taf [options]'
+      puts '-h --help 2 arguments are required: -b {Browser}'\
+              '-t {Testcase folder}'
+      puts '-v --verision Shows current version'
+      puts '-b --browser browser Supported Browsers: chrome, chrome-headless,'\
+              ' firefox, firefox-headless'
+      puts '-t --tests testfolder i.e. tests/*.json'
+      Process.exit
+    end
+
+    def self.browser(browser)
+      @browser_type = browser
+      unless ['chrome', 'chrome-headless', 'firefox', 'firefox-headless']
+             .include?(@browser_type)
+        Taf::MyLog.log.warn 'A valid Browser has not been supplied as a' \
+                  ' command-line parameter as expected'
+        Process.exit
+      end
+    end
+
+    def self.tests(testfolder)
+      @tests_folder = testfolder
+      if Taf::Parser.test_files.size.positive?
+        Taf::MyLog.log.info "There are: #{Taf::Parser.test_files.size}" \
+          " test files to process: #{Taf::Parser.test_files}\n"
+      else
+        Taf::MyLog.log.warn \
+          'A valid Test case location has not been supplied' \
+          ' as a command-line parameter as expected, Files should be .JSON'
+        Process.exit
+      end
+    end
+
+    def self.taf_version
+      puts "TAF Version: #{Taf::VERSION}"
+      Process.exit
+    end
+
+    def self.browser_type
+      @browser_type
+    end
+
+    def self.tests_folder
+      @tests_folder
+    end
+
+    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 |opt|
+        opt.banner = 'Usage: taf [options]'
+        opt.on('-h', '--help') { help }
+        opt.on('-v', '--version') { taf_version }
+        opt.on('-b', '--browser b') { |b| options[:browser] = b, browser(b) }
+        opt.on('-t', '--tests t') { |t| options[:testfolder] = t, tests(t) }
+      end.parse!
+    end
+  end
+end

data/lib/taf/create_directories.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+# Created on 20 Sept 2017
+# @author: Andy Perrett
+#
+# Versions:
+# 1.0 - Baseline
+#
+module Taf
+  # 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.
+    # 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 = Taf::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 = Taf::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
+end

data/lib/taf/json_parser.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+# Created on 02 Aug 2018
+# @author: Andy Perrett
+#
+# Versions:
+# 1.0 - Baseline
+#
+module Taf
+  # json_parser.rb - json parser functions
+  module JSONParser
+    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']
+      Taf::MyLog.log.info "Number of test steps: #{number_test_steps}"
+      Taf::MyLog.log.info "Test Description: #{test_des}"
+      Taf::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
+end

data/lib/taf/junit_report.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+# Created on 20 Sept 2017
+# @author: Andy Perrett
+#
+# Versions:
+# 1.0 - Baseline
+#
+module Taf
+  # junit_report.rb - methods for writing to the summary xml junit report.
+  module JUnitReport
+    # 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' => Taf::CMDLine.tests_folder.to_s,
+          'name' => Taf::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 = Taf::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
+end