taf 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 47c34f68219bf7188b916a891f7a86f4d14b08a437d08201382e7f3202e21143
-  data.tar.gz: 501befb0dc3bf630031a1094df678c1fa100e3be6c31d799dd914ac173e83938
+  metadata.gz: aec014d38b9b9f9dbe35fe3bc6a2c924a3434ab0eab2a9976bda8741763ee59d
+  data.tar.gz: bab944778a1ccf2eb1363de7751a8e2d95fb33a0ac69e2eeb80cbdfecca3c214
 SHA512:
-  metadata.gz: d1a1b0383b4d37a35b566a2739601f8818f887b9b8ac6e25702fde9ffa39416595c5f806fa8e6f550e008da6b7cbbb486fe105de60abb0b29dd53cfcb87f77b8
-  data.tar.gz: a3c32e949362a648f88e797185fa0883a8d010085b21d18a390ad5e6274f298eb31c6234bce00c15933dddb6ae01ed46a6cafb69c7b43fe00071db44918254ac
+  metadata.gz: 2278f72d06eb0fa27a49f3038b5f22ec9ace610cfc73c41b55282f93af1a6212a8c51e110bb27346559e5152b03a7cb4f91e56206d7384917535429fbfd2270b
+  data.tar.gz: a01563a120ea0c2f49228c62a2a90423ef41238780425d4430704ee44969fe6c43863edc50847095fb2c6fdae18a4b21813b4a0d2e3edb6ee649487bc216e181

data/lib/functions/handlers/ping_test.rb

@@ -23,4 +23,4 @@ module TestSteps
       end
     end
   end
-end
+end

data/lib/functions/handlers/switch_iframe.rb

@@ -0,0 +1,23 @@
+require_relative 'base_handler'
+
+module TestSteps
+  module Handlers
+    class SwitchIframe < Base
+      register :switch_iframe
+
+      def perform(step_attributes)
+        frame = step_attributes[:testvalue]
+        locate = step_attributes[:locate]
+
+        Browser.b.iframe(:"#{locate}" => frame).exists?
+        # Browser.b.wait_until { iframe(:"#{locate}" => frame).exists? }
+        # Browser.b.switch_to(:"#{locate}" => iframe)
+        MyLog.log.info("iframe found: #{frame} is correct")
+        true
+      rescue StandardError
+        MyLog.log.warn("iframe not found: #{frame}")
+        false
+      end
+    end
+  end
+end

data/lib/main.rb

@@ -20,16 +20,27 @@ module Main
       # 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
+      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|
+      parser.on(
+        '-b',
+        '--browser browser',
+        'Supported Browsers: chrome,' \
+        ' chrome-headless, firefox, firefox-headless.'
+      ) do |b|
         options[:browser] = b
         $browserType = options[:browser]
-        unless ['chrome', 'chrome-headless', 'firefox', 'firefox-headless'].include?($browserType)
-          MyLog.log.warn 'A valid Browser has not been supplied as a command-line parameter as expected'
+        unless ['chrome', 'chrome-headless', 'firefox', 'firefox-headless']
+               .include?($browserType)
+          MyLog.log.warn 'A valid Browser has not been supplied as a' \
+            ' command-line parameter as expected'
           Process.exit
         end
       end
@@ -38,10 +49,12 @@ module Main
         options[:testfolder] = t
         $testcasesFolder = options[:testfolder]
         if Parser.test_files.size.positive?
-          MyLog.log.info "There are: #{Parser.test_files.size} test files to process"
+          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'
+          MyLog.log.warn 'A valid Test case location has not been supplied' \
+            ' as a command-line parameter as expected'
           Process.exit
         end
       end

data/lib/parser/xlsx_parser.rb

@@ -10,23 +10,21 @@ module XlsxParser
 
   def self.parse_xlxs_test_header_data
     # get the number of test steps in the file
-    $numberOfTestSteps = ($xlsxDoc[0].sheet_data.size) - 4
+    $numberOfTestSteps = $xlsxDoc[0].sheet_data.size - 4
     worksheet = $xlsxDoc[0]
     # get the remaining test data
-    $testId    = worksheet.sheet_data[1][0].value
+    $testId = worksheet.sheet_data[1][0].value
     $projectId    = worksheet.sheet_data[1][1].value
     $testDes      = worksheet.sheet_data[1][2].value
     MyLog.log.info "Number of test steps: #{$numberOfTestSteps}"
     MyLog.log.info "Test Description: #{$testDes}"
     MyLog.log.info "TestID: #{$testId} \n"
-    
   end
 
   # parseTestStepData
-  def self.parse_test_step_data(testFileType)
-    begin
+  def self.parse_test_step_data(_test_file_type)
     worksheet = $xlsxDoc[0]
-    worksheet[4..$numberOfTestSteps+4].map do |row|
+    worksheet[4..$numberOfTestSteps + 4].map do |row|
       test = {
         testStep: row[0].value,
         testdesc: row[1].value,
@@ -36,7 +34,7 @@ module XlsxParser
         testvalue2: row[5].value,
         locate2: row[6].value,
         screenShotData: row[7].value,
-        skipTestCase: row[8].value,
+        skipTestCase: row[8].value
       }
 
       # convert test step, screenshot and skip test case functions to lowercase.
@@ -44,36 +42,31 @@ module XlsxParser
 
       # 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
+      test[:screenShotData] = if test[:screenShotData] == 'Y'
+                                true
+                              elsif test[:screenShotData] == 'N'
+                                false
+                              else
+                                false
+                              end
 
-      if (test[:skipTestCase] == 'Y')
-        test[:skipTestCase] = true
-      elsif(test[:skipTestCase] == 'N')
-        test[:skipTestCase] = false
-      else
-        test[:skipTestCase] = false
-      end
+      test[:skipTestCase] = if test[:skipTestCase] == 'Y'
+                              true
+                            elsif test[:skipTestCase] == 'N'
+                              false
+                            else
+                              false
+                            end
 
       # if there is an element locator then use it, otherwise use an ID
-      if (test[:locate].to_s == '')
-        test[:locate] = 'id'
-      end
+      test[:locate] = 'id' if test[:locate].to_s == ''
 
-      if (test[:locate2].to_s == '')
-        test[:locate2] = 'id'
-      end
+      test[:locate2] = 'id' if test[:locate2].to_s == ''
 
       test
-     # if an error reading the test step data then re-raise the exception
+    # if an error reading the test step data then re-raise the exception
     rescue StandardError => error
-      raise
+      raise error
     end
   end
 end
-end

data/lib/report/junit_report.rb

@@ -10,17 +10,19 @@
 module JunitReport
   require_relative '../taf_config.rb'
   # holds printable test report summary for all the executed tests
-  @testStepReportSummary2 = []
+  @test_step_report_summary2 = []
   # 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] = {
+    @test_step_report_summary2[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
+      'time' => TimeDifference.between(
+        $test_case_end_time, $test_case_start_time
+      ).in_seconds
     }
   end
 
@@ -34,15 +36,19 @@ module JunitReport
         '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
+        '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 |test_step_index, testStep_xml|
-              testsuite.testcase(testStep_xml) do |testcase|
-                failure = $failtestStep_xml&.[](testStepReportSummary2['name'])&.[](test_step_index)
-                skipped = $skiptestStep_xml&.[](testStepReportSummary2['name'])&.[](test_step_index)
+        @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_index, test_step_xml|
+              testsuite.testcase(test_step_xml) do |testcase|
+                failure = $failtestStep_xml
+                  &.[](test_step_report_summary2['name'])&.[](test_step_index)
+                skipped = $skiptestStep_xml
+                  &.[](test_step_report_summary2['name'])&.[](test_step_index)
                 testcase.failure(failure) if failure
                 testcase.skipped(skipped) if skipped
               end
@@ -57,12 +63,14 @@ module JunitReport
 
     # 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 MyLog.log.warn "test suite summary file xml name: #{$TestSuiteSummaryXML} is already open"
+      testSuiteSummaryFile_xml = File.open($TestSuiteSummaryXML, 'w+')
+      testSuiteSummaryFile_xml.write builder.to_xml
+    else
+      MyLog.log.warn '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?
+    testSuiteSummaryFile_xml.close unless testSuiteSummaryFile_xml.closed?
   end
 end

data/lib/report/report_summary.rb

@@ -10,10 +10,10 @@
 module ReportSummary
   require_relative '../taf_config.rb'
   # holds printable test report summary for all the executed tests
-  @testStepReportSummary = []
+  @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)
-    @testStepReportSummary[test_file_name_index] = <<~TEXT
+    @test_step_report_summary[test_file_name_index] = <<~TEXT
       Test file executed: #{test_file_name}
       Browser type used: #{$browserType}
       Browser version: #{Browser.browser_version}
@@ -29,17 +29,19 @@ module ReportSummary
   def self.print_overall_test_summary
     # output to the console
 
-    MyLog.log.info "Finished processing all test files - executed via test suite: #{$testcasesFolder}"
+    MyLog.log.info 'Finished processing all test files -' \
+      "executed via test suite: #{$testcasesFolder}"
     MyLog.log.info "Overall Test Summary: \n"
-    @testStepReportSummary.each do |testStepReportSummary|
-      testStepReportSummary.each_line do |line|
+    @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
 
     MyLog.log.info "Total Tests started at: #{$test_start_time}"
     MyLog.log.info "Total Tests finished at: #{$test_end_time}"
-    MyLog.log.info ('Total Tests duration: ' + TimeDifference.between($test_end_time, $test_start_time).humanize)
+    MyLog.log.info 'Total Tests duration: ' \
+      + TimeDifference.between($test_end_time, $test_start_time).humanize
     MyLog.log.info "Total Tests Passed: #{$totalTestPasses}".green
     MyLog.log.info "Total Tests Failed: #{$totalTestFailures}".red
     MyLog.log.info "Total Tests Skipped: #{$totalTestNotrun}".blue

data/lib/taf_config.rb

@@ -20,6 +20,9 @@ require 'time_difference'
 require 'colored'
 require 'rubyXL'
 require 'optparse'
+require 'fileutils'
+require 'securerandom'
+
 
 # list of all the required files
 require_relative './utils/test_steps'

data/lib/utils/create_directories.rb

@@ -1,5 +1,4 @@
 # frozen_string_literal: true
-
 # Created on 20 Sept 2017
 # @author: Andy Perrett
 #
@@ -16,54 +15,51 @@ module CreateDirectories
   #
   # ----> Project directory (working directory)
   #
-  # ------->directory named after the test run number
+  # ------->directory named after the test run ID UUID
   #
-  # ---------->directory named after test_id (with browser type identified)
+  # ---------->directory named after test_id
   #
   # ------------->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
+  def self.time_now
+    Time.new.strftime('%d-%b-%Y_%H_%M')
+  end
 
-    # create the 'Project' directory if it doesn't already exist
+  def self.construct_projectdirs
+    # create top-level directory if it doesn't already exist:
+    # Results/Project_id
     project_id = $projectId.delete(' ')
-    $project_iddir = result_home + '/' + project_id
-    Dir.mkdir($project_iddir) unless File.directory? $project_iddir
+    $project_iddir = File.join('Results', project_id
+    )
 
-    # 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')
+    FileUtils.mkdir_p($project_iddir)
 
-    $TestSuiteSummaryXML = 'Results/' + $projectId + '/' + f_date + '_' + f_time + '_test_result.xml'
+    # Generate UUID
+    $run_uuid = SecureRandom.uuid
+
+    # the test suite summary is a XML report generated will be called
+    # 'suite_summary.xml'
+    $TestSuiteSummaryXML = "Results/#{project_id}/#{time_now}" \
+                           '_test_result.xml'
   end
 
   def self.construct_testspecdirs
-    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)
-
-    # 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 directories for each test spec for screenshots:
+    # Results/Project_id/Run_ID_UUID/Test_ID/Screenshots
+    screenshot_dir = File.join(
+      $project_iddir, "Run_ID_#{$run_uuid}",  "#{$testId.delete(' ')}",  
+      'Screenshots'
+    )
 
-    # create a screenshot directory under the 'testId' directory - it will always need creating
-    screenshot_dir = testid_dir + '/' + 'Screenshots' + '/'
-    Dir.mkdir(screenshot_dir)
-
-    # create absolute paths to the screenshots and test suite summary directories
     abs_path_screenshot_dir = File.absolute_path(screenshot_dir)
-
-  # if any issues then set error message and re-raise the exception
+    # abs_path_run_no_dir = File.absolute_path(runNoDir)
+    FileUtils.mkdir_p(abs_path_screenshot_dir)
+    # if any issues then set error message and re-raise the exception
   rescue StandardError => 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
+    # 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

data/lib/version.rb

@@ -3,10 +3,10 @@
 module Taf
   # This module holds the TAF version information.
   module Version
-    STRING = '0.2.1'.freeze
+    STRING = '0.2.2'
 
     MSG = '%<version>s (using Parser %<parser_version>s, running on ' \
-          '%<ruby_engine>s %<ruby_version>s %<ruby_platform>s)'.freeze
+          '%<ruby_engine>s %<ruby_version>s %<ruby_platform>s)'
 
     def self.version(debug = false)
       if debug

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taf
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Andy Perrett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-21 00:00:00.000000000 Z
+date: 2019-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -192,13 +192,13 @@ files:
 - lib/functions/handlers/insert_value_config.rb
 - lib/functions/handlers/ipause.rb
 - lib/functions/handlers/list_all_dropdowns_values.rb
-- lib/functions/handlers/open_portal_url.rb
 - lib/functions/handlers/open_url.rb
 - lib/functions/handlers/ping_test.rb
 - lib/functions/handlers/portal_login.rb
 - lib/functions/handlers/radio_button.rb
 - lib/functions/handlers/select_dropdown.rb
 - lib/functions/handlers/send_special_keys.rb
+- lib/functions/handlers/switch_iframe.rb
 - lib/functions/handlers/write_box_data.rb
 - lib/functions/handlers/write_to_editor.rb
 - lib/main.rb

data/lib/functions/handlers/open_portal_url.rb

@@ -1,24 +0,0 @@
-require_relative 'base_handler'
-
-module TestSteps
-  module Handlers
-    class OpenPortalUrl < Base
-      register :open_portal_url
-
-      def perform(step_attributes)
-        value = step_attributes[:testvalue]
-        url = ENV[value.to_s]
-        Browser.open_browser
-        Browser.b.goto(url)
-        url_nme = Browser.b.url
-        if url_nme == url
-          MyLog.log.info("opened URL: #{url}")
-          return true
-        else
-          MyLog.log.warn("URL not open: #{url} - opened #{url_nme} instead")
-          return false
-        end
-      end
-    end
-  end
-end