taf 0.1.9 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8fce262beb8801e713c9bf2bba991657eed3e3660d5098b3905d27c16abbb2c9
-  data.tar.gz: 9a98b39402e830e014216b8701082c89955556c90af42793ef7f797981c917c4
+  metadata.gz: c5a4ea4d70ac8bd18bd9e90fa0b0b1615e036669df29d789105cec6aa5d74e09
+  data.tar.gz: 4d62ee8db6590f1ed95be8dbabdb2db2e220d9e5f5bad68d73b1266eb8cf084b
 SHA512:
-  metadata.gz: b93e27555e02b0478cbc0615a66812fe9c1621ccbebb0fbd452493fd5831b3d0ecf41af72275dffd39955eac8c06daae3b97a07d6eb9966e4c07faf7737df460
-  data.tar.gz: cdbe883d6dbb0ab8bf43c273eb36ae2814eff4955ad351a04e5ab2224a3157f7ad54f1ac622fd9e01fac91140239f205866f2e7c2687f0f459e2016808b88e7c
+  metadata.gz: e7f1b953e22f15a8152110c5621c824535efb13e0921c6961a07e90cb1f3165a0ead74a87ccf8502c0c086a4c7899c74c55a4934cf2952d271f2045df28647d0
+  data.tar.gz: dddad76d0929978d394fa1e8639288b84ecf445fa4d79a03e81d34b7a1168445c08dbbdb82f2ab71168ca3324ff4702b5db2b0c3a9104e5aa88c37b9e8ce3d56

data/lib/main.rb

@@ -28,25 +28,20 @@ module Main
 
     begin
       # check if the test suite file name exists on the command line
-      # allow a user to input 1 or 2 arguments in to CMD line the 2 values are:
-      # Testsuite File and Browser.
-      if ARGV.length < 2
-        $testSuiteFile = ARGV[0]
-        MyLog.log.info 'Only one argument needed: {TestSuite File}'
-      elsif ARGV.length < 3
-        $testSuiteFile = ARGV[0]
+      # allow a user to input 2 arguments in to CMD line the 2 values are:
+      # Testcase Folder and Browser.
+      if ARGV.length < 3
+        $testcasesFolder = ARGV[0]
         $browserType = ARGV[1]
-        MyLog.log.info 'Only 2 arguments needed: {TestSuite File} {Browser}'
+        MyLog.log.info '2 arguments are required: {Testcase folder} {Browser}'
       else
         # unable to open file as not supplied as command-line parameter
-        $testSuiteFile = 'unknown'
-        error_to_display = 'Test File has not been supplied as a command-line parameter as expected'
+        $testcasesFolder = 'unknown'
+        error_to_display = 'Test case location has not been supplied as a command-line parameter as expected'
+        $browserType = 'unknown'
+        error_to_display = 'Browser has not been supplied as a command-line parameter as expected'
         raise IOError, error_to_display  
       end
-
-    # Get the test suite data
-    Parser.read_test_suite_data
-
   # unable to read the test file then handle the error and terminate
   rescue StandardError => error
     warn error
@@ -54,7 +49,7 @@ module Main
     abort
   end
 
-    MyLog.log.info "There are: #{$numberOfTestSpecs} test files to process \n"
+    MyLog.log.info "There are: #{Parser.test_files.size} test files to process \n"
 
     # process the test files to execute the tests
     TestEngine.process_testfiles

data/lib/parser/parser.rb

@@ -10,49 +10,10 @@ module Parser
   # variables:
   @XlsxFileNameType = '.xlsx'
 
- # read in the data from the test suite file
-  def self.read_test_suite_data
-    # check if the file list exists and is readable
-    if (File.file?($testSuiteFile) & File.readable?($testSuiteFile))
-      MyLog.log.info "Processing test suite file: #{$testSuiteFile}"
-      # get the file type
-      fileType = File.extname($testSuiteFile)
-      # extract the test data from the test suite
-      if (fileType.casecmp(@XlsxFileNameType) == 0)
-        # process as xlsx...
-        $XlsxSuiteDoc = RubyXL::Parser.parse($testSuiteFile)
-        # ...and parse...
-        XlsxParser.parse_xlxs_test_suite_header_data
-      else
-        # the file type is not that expected so create
-        # a error message and raise an exception
-        error_to_display = "Test Suite file: '#{$testSuiteFile}' "\
-                           "type not recognised (must be .xlsx)"
-        raise IOError, error_to_display
-      end
-        # if unable to read the test file list then construct
-        # a custom error message and raise an exception
-    elsif error_to_display = "Test Suite file: '#{$testSuiteFile}' "\
-                             "does not exist or is unreadable"
-        raise IOError, error_to_display
-    end
-  end
-
-  def self.parse_test_suite_data(testSpecIndex)
-    begin
-      # get the file type
-      fileType = File.extname($testSuiteFile)
-
-      if (fileType.casecmp(@XlsxFileNameType) == 0)
-        XlsxParser.parse_xlxs_test_suite_data(testSpecIndex)
-      else
-        # the file type is not that expected so create a
-        # error message and raise an exception
-        error_to_display = "Test Suite file: '#{$testSuiteFile}' "\
-                           "type not recognised (must be .xlsx)"
-        raise IOError, error_to_display
-      end
-    end
+  def self.test_files
+    @test_files ||= Dir.glob("#{$testcasesFolder}/*.xlsx").reject do |file|
+      File.basename(file).start_with?('~$')
+    end.sort
   end
 
   # readTestData

data/lib/parser/xlsx_parser.rb

@@ -7,53 +7,18 @@
 # xlsx_parser.rb - xlsx parser functions
 module XlsxParser
   require_relative '../taf_config.rb'
-  def self.parse_xlxs_test_suite_header_data
-    begin
-      # get the number of test specifications in the file (number of
-      # occurences of "Test_Specification"
-      $numberOfTestSpecs = $XlsxSuiteDoc[0].sheet_data.size - 7
-
-      worksheet = $XlsxSuiteDoc[0]
-      $projectName = worksheet.sheet_data[1][0].value
-      $projectId = worksheet.sheet_data[1][1].value
-      $sprint = worksheet.sheet_data[1][2].value
-
-      $testSuiteId = worksheet.sheet_data[4][0].value
-      $testSuiteDes = worksheet.sheet_data[4][1].value
-      $tester  = worksheet.sheet_data[4][2].value
-    end
- end
-
-  def self.parse_xlxs_test_suite_data(testSpecIndex)
-    worksheet = $XlsxSuiteDoc[0]
-
-    worksheet[7..$numberOfTestSpecs+7].map do |row|
-      suite = {
-        id: row[0].value,
-        specdesc: row[1].value,
-        env: row[3].value,
-      }
-
-      if ARGV.length < 2
-        suite[:browser] = row[2].value
-      elsif ARGV.length < 3
-        suite[:browser] = ARGV[1]
-      else
-        raise IOError, 'Unable to open browser'  
-      end
-
-      suite
-    end
-  end
 
   def self.parse_xlxs_test_header_data
     # get the number of test steps in the file
-    $numberOfTestSteps = ($xlsxDoc[0].sheet_data.size) - 7
+    $numberOfTestSteps = ($xlsxDoc[0].sheet_data.size) - 4
     worksheet = $xlsxDoc[0]
     # get the remaining test data
-    $testDes      = worksheet.sheet_data[4][1].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
 
@@ -61,7 +26,7 @@ module XlsxParser
   def self.parse_test_step_data(testFileType)
     begin
     worksheet = $xlsxDoc[0]
-    worksheet[7..$numberOfTestSteps+7].map do |row|
+    worksheet[4..$numberOfTestSteps+4].map do |row|
       test = {
         testStep: row[0].value,
         testdesc: row[1].value,

data/lib/report/junit_report.rb

@@ -28,8 +28,8 @@ module JunitReport
     # output to XML file format for Junit for CI.
     builder = Nokogiri::XML::Builder.new(encoding: 'UTF-8') do |xml|
       testsuite_attrs = {
-        'classname' => $testSuiteFile.to_s,
-        'name' => $testSuiteFile.to_s,
+        'classname' => $testcasesFolder.to_s,
+        'name' => $testcasesFolder.to_s,
         'tests' => $totalTests.to_s,
         'failures' => $totalTestFailures.to_s,
         'timestamp' => $test_start_time.to_s,

data/lib/report/report_summary.rb

@@ -14,10 +14,9 @@ module ReportSummary
   # 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 file: #{test_file_name}
-      Browser type: #{$browserType}
+      Test file executed: #{test_file_name}
+      Browser type used: #{$browserType}
       Browser version: #{Browser.browser_version}
-      Environment: #{$env_type}
       Started at: #{$test_case_start_time}
       Finished at: #{$test_case_end_time}
       There are: #{$testStepPasses} Passes
@@ -30,7 +29,7 @@ module ReportSummary
   def self.print_overall_test_summary
     # output to the console
 
-    MyLog.log.info "Finished processing all test files - executed via test suite: #{$testSuiteFile} by tester: #{$tester}"
+    MyLog.log.info "Finished processing all test files - executed via test suite: #{$testcasesFolder}"
     MyLog.log.info "Overall Test Summary:"
     @testStepReportSummary.each do |testStepReportSummary|
       testStepReportSummary.each_line do |line|

data/lib/utils/browser.rb

@@ -113,14 +113,16 @@ module Browser
 
   # 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)
+  def self.check_save_screenshot(screen_shot)
     if ($currentTestFail || screen_shot)
       time = Time.now.strftime('%H%M')
       if ($currentTestFail)
+        full_sc_dirname = CreateDirectories.construct_testspecdirs
         scFileName = full_sc_dirname + "/Test_step-#{$testStep}_Failed_"\
                                         "#{time}.png"
       else
         # file name will be teststep.png
+        full_sc_dirname = CreateDirectories.construct_testspecdirs
         scFileName = full_sc_dirname + "/Test_step-#{$testStep}_#{time}.png"
       end
 

data/lib/utils/create_directories.rb

@@ -29,18 +29,25 @@ module CreateDirectories
 
     # 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
+    $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.
+    # 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')
-    $runNoDir = project_iddir + '/' + 'Ran_on_' + f_date + '_' + f_time
-    Dir.mkdir($runNoDir)
+
+    $TestSuiteSummaryXML = 'Results/' + $projectId + '/' + f_date + '_' + f_time + '_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
@@ -55,18 +62,6 @@ module CreateDirectories
     abs_path_screenshot_dir = File.absolute_path(screenshot_dir)
     abs_path_run_no_dir      = File.absolute_path($runNoDir)
 
-    # 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
-
-    MyLog.log.info "TestId: #{$testId}"
-    MyLog.log.info "Screenshot directory: #{abs_path_screenshot_dir} \n"
-
   # 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)

data/lib/utils/test_engine.rb

@@ -12,114 +12,70 @@ module TestEngine
 
   # 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]
-
-        if ARGV.length < 2
-          $browserType = test_suite[:browser]
-          MyLog.log.info "Will use the following browser from Test Suite: #{$browserType}"
-        elsif ARGV.length < 3
-          $browserType = ARGV[1]
-          MyLog.log.info "Will use the following browser from CMD line: " + ARGV[1]
-        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
-          MyLog.log.warn "Terminating the current test case: " \
-                       "#{test_file_name} #{error}"
-          MyLog.log.info '...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
-          # if an error then show the error and terminate
-        rescue StandardError => error
-          warn error
-          MyLog.log.warn error
-          abort
-        end
-
-        # loop through the test file
-        if testFileType != 'XLSX'
-          MyLog.log.info 'Not a valid XLSX File Type'
+    Parser.test_files.each_with_index do |test_file_name, test_file_index|
+      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
+        MyLog.log.warn 'Terminating the current test case: ' \
+                     "#{test_file_name} #{error}"
+        MyLog.log.info '...continuing with the next test case (if there is one)'
+      end # of rescue block for readTestData
+
+      # create project folders - these only need creating once per test suite
+      CreateDirectories.construct_projectdirs
+
+      # loop through the test file
+      MyLog.log.info 'Not a valid XLSX File Type' if testFileType != 'XLSX'
+
+      # 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, 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, step_index, test_step)
+          # see if screenshot required
+          Browser.check_save_screenshot(screen_shot)
         end
-
-        # 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
-          MyLog.log.warn 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 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
+      rescue TafError => error
+        warn error
+        MyLog.log.warn error
       end
-    end # while loop for test files
-  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_index)
+      JunitReport.test_step_summary_xml(test_file_name, test_file_index)
+
+      # close the browser if created
+      Browser.b.quit
+
+      # 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

data/lib/version.rb

@@ -3,7 +3,7 @@
 module Taf
   # This module holds the TAF version information.
   module Version
-    STRING = '0.1.9'.freeze
+    STRING = '0.2.0'.freeze
 
     MSG = '%<version>s (using Parser %<parser_version>s, running on ' \
           '%<ruby_engine>s %<ruby_version>s %<ruby_platform>s)'.freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taf
 version: !ruby/object:Gem::Version
-  version: 0.1.9
+  version: 0.2.0
 platform: ruby
 authors:
 - Andy Perrett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-08 00:00:00.000000000 Z
+date: 2019-03-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler