taf 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68dc766c595d259d02242dfc34a39309531aa63ffabc912ffc85c9cad2ceb46b
-  data.tar.gz: cf0d163c682cebe8c794c19281dc18006ecceae413030e6e81a11ae9e09c5f76
+  metadata.gz: 8547dfd48a03b189469331103f5fe10b053b8761c1b25bdce6e069b9808c264c
+  data.tar.gz: 35b82be0e8d1f7ee7d7146a16aaecc5cb09914519ac31a4c36d4dad5cd473bf5
 SHA512:
-  metadata.gz: ad1dc2b44ccf4f29566adcfee38f679560cb1e5b8d040dd169a44e0d19073416bae4f9dab681189caa3cedc71f0c0b92d27ac6503278a1de58114bb949ca8767
-  data.tar.gz: 689cb611844b398d6f04148916c25c87136e6ec65612c1612ed18458323fb25aef0c1cd83b41838f80ad1a49079f24eb5568210e95ec8e758b3cc1e3561d9b9a
+  metadata.gz: 98dd2ffb3dbf3be2fc7beb897a9453ff2f6ad48645da9cb663538ac92f909a5e615452f6766be6c9f70541b08a67666de5a829b909600982019aa8a2db4fc533
+  data.tar.gz: 1d934465ba76c51574fcbda69d930a9809e9c46fbca9ded3b858e6819d42eaadc00d2d264f1d10b0f7f9c091333d417d8bf2e9aaf68e7f70152aa003955f5786

data/lib/main.rb

@@ -71,8 +71,6 @@ module Main
      $totalTestNotrun = 0
      $previousTestFail = false
      $currentTestFail = false
-     # initialised stores for the input xlsx test data
-     $XlsxDoc = ''
      # parses the cmd line imput into the taf
      Main.cmdline_input
    end

data/lib/parser/json_parser.rb

@@ -0,0 +1,42 @@
+# 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
+    $numberOfTestSteps = parse_json['steps'].count
+    # get the remaining test data
+    $testId = parse_json['testId']
+    $projectId    = parse_json['projectId']
+    $testDes      = parse_json['testDescription']
+    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(parse_json)
+    parsed_step = {
+      testStep: parse_json['currentStep'],
+      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',
+      screenShotData: parse_json['screenshot'] == 'yes',
+      skipTestCase: parse_json['skipTestCase'] == 'yes'
+    }
+
+    parsed_step
+    # if an error reading the test step data then re-raise the exception
+  rescue StandardError => error
+    raise error
+  end
+end

data/lib/parser/parser.rb

@@ -7,11 +7,9 @@
 # parser.rb - basic parser functions
 module Parser
   require_relative '../taf_config.rb'
-  # variables:
-  @xlsx_file_name_type = '.xlsx'
 
   def self.test_files
-    @test_files ||= Dir.glob("#{$testcasesFolder}/*.xlsx").reject do |file|
+    @test_files ||= Dir.glob("#{$testcasesFolder}/*.json").reject do |file|
       File.basename(file).start_with?('~$')
     end.sort
   end
@@ -20,17 +18,20 @@ module Parser
   def self.read_test_data(test_file_name)
     # get the file type
     file_type = File.extname(test_file_name)
-    if file_type.casecmp(@xlsx_file_name_type).zero?
+    if file_type.casecmp('.json').zero?
       MyLog.log.info "Processing test file: #{test_file_name}"
       MyLog.log.info "Browser Type: #{$browserType}"
-      $xlsxDoc = RubyXL::Parser.parse(test_file_name)
-      XlsxParser.parse_xlxs_test_header_data
-      return 'XLSX'
+      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)'
+                         'type not recognised (must be .xslx or .json)'
       raise IOError, error_to_display
     end
 
@@ -41,7 +42,7 @@ module Parser
   end
 
   # parseTestStepData
-  def self.parse_test_step_data(test_file_type)
-    XlsxParser.parse_test_step_data(test_file_type)
+  def self.parse_test_step_data(parse_json)
+    JsonParser.parse_test_step_data(parse_json)
   end
 end

data/lib/report/report.rb

@@ -16,14 +16,14 @@ module Report
   end
 
   # print the test Step info to the test results file
-  def self.print_test_step_header(test_file_name, test_step_index)
+  def self.print_test_step_header(test_file_name, test_step_index, step_attributes)
     @test_start_time = current_time
-    MyLog.log.info "Test step: #{$test_step} : #{$test_step_des}"
+    MyLog.log.info "Test step: #{step_attributes[:testStep]} : #{step_attributes[:testdesc]}"
 
     step = {
-      'id' => $test_step,
-      'classname' => 'SuiteID: ' + $testId.to_s + ' Test Step: ' + $test_step.to_s + ' ' + $test_step_des.to_s,
-      'name' => $test_step_des,
+      'id' => step_attributes[:testStep],
+      'classname' => 'SuiteID: ' + $testId.to_s + ' Test Step: ' + step_attributes[:testStep].to_s + ' ' + step_attributes[:testdesc].to_s,
+      'name' => step_attributes[:testdesc],
       'file' => test_file_name
     }
     # output to console to show test step
@@ -37,19 +37,19 @@ module Report
   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_index)
+  def self.test_pass_fail(pass_fail, test_file_name, test_step_index, step_attributes)
     if pass_fail == true
       $previousTestFail = $currentTestFail
       $currentTestFail = false
       $testStepPasses += 1
-      MyLog.log.info "Test #{$test_step} has Passed ".green
+      MyLog.log.info "Test #{step_attributes[:testStep]} has Passed ".green
     elsif pass_fail == false
       $previousTestFail = $currentTestFail
       $currentTestFail = true
       $testStepFailures += 1
-      MyLog.log.info "Test #{$test_step} has FAILED ".red
+      MyLog.log.info "Test #{step_attributes[:testStep]} has FAILED ".red
       failstep = {
-        'message' => 'SuiteID: ' + $testId.to_s + ' Test Step: ' + $test_step.to_s + ' Test has FAILED - Check logs',
+        'message' => 'SuiteID: ' + $testId.to_s + ' Test Step: ' + step_attributes[:testStep].to_s + ' Test has FAILED - Check logs',
         'type' => 'FAILURE',
         'file' => test_file_name
       }
@@ -64,9 +64,9 @@ module Report
     else
       $currentTestFail = false
       $testStepNotrun += 1
-      MyLog.log.info "Test #{$test_step} no checks performed ".blue
+      MyLog.log.info "Test #{step_attributes[:testStep]} no checks performed ".blue
       skipstep = {
-        'message' => 'SuiteID: ' + $testId.to_s + ' Test Step: ' + $test_step.to_s + ' No checks performed - Check logs',
+        'message' => 'SuiteID: ' + $testId.to_s + ' Test Step: ' + step_attributes[:testStep].to_s + ' No checks performed - Check logs',
         'type' => 'SKIPPED',
         'file' => test_file_name
       }

data/lib/taf_config.rb

@@ -18,10 +18,10 @@ require 'net/ping'
 require 'nokogiri'
 require 'time_difference'
 require 'colored'
-require 'rubyXL'
 require 'optparse'
 require 'fileutils'
 require 'securerandom'
+require 'json'
 
 # list of all the required files
 require_relative './utils/test_steps'
@@ -34,7 +34,7 @@ require_relative './utils/exceptions'
 require_relative './report/junit_report'
 require_relative './report/report_summary'
 require_relative './parser/parser'
-require_relative './parser/xlsx_parser'
+require_relative './parser/json_parser'
 
 # Require all test step handlers, which register themselves with
 # TestStep.handlers when the files are required.

data/lib/utils/test_engine.rb

@@ -19,7 +19,7 @@ module TestEngine
     Parser.test_files.each_with_index do |test_file_name, test_file_index|
       begin
         # read in the test data
-        test_file_type = Parser.read_test_data(test_file_name)
+        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 => error
@@ -31,26 +31,18 @@ module TestEngine
       # 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 test_file_type != '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(test_file_type)
-
-        test_steps.each_with_index do |test_step, step_index|
-          $test_step     = test_step[:testStep]
-          $test_step_des = test_step[:testdesc]
-          screen_shot    = test_step[:screenShotData]
-
+        tests['steps'].each do |test_step|
+          parsed_steps = Parser.parse_test_step_data(test_step)
           # process the test step data
-          TestSteps.process_test_steps(test_file_name, step_index, test_step)
+          TestSteps.process_test_steps(test_file_name, parsed_steps[:testStep], parsed_steps)
           # see if screenshot required
-          Browser.check_save_screenshot(screen_shot)
+          Browser.check_save_screenshot(parsed_steps[:screenShotData])
         end
       rescue TafError => error
         warn error

data/lib/utils/test_steps.rb

@@ -18,15 +18,14 @@ module TestSteps
   # processing the associated data accordingly
   def self.process_test_steps(test_file_name, test_step_index, step_attributes)
     # print the test step information
-    Report.print_test_step_header(test_file_name, test_step_index)
-
+    Report.print_test_step_header(test_file_name, test_step_index, step_attributes)
     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_index)
+      Report.test_pass_fail(func, test_file_name, test_step_index, step_attributes)
       Report.check_failure_threshold(test_file_name, test_step_index)
       return true
     else

data/lib/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taf
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - Andy Perrett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-30 00:00:00.000000000 Z
+date: 2019-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: logger
   requirement: !ruby/object:Gem::Requirement
@@ -108,20 +122,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.7'
-- !ruby/object:Gem::Dependency
-  name: rubyXL
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.3'
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
@@ -199,8 +199,8 @@ files:
 - lib/functions/handlers/send_special_keys.rb
 - lib/functions/handlers/write_box_data.rb
 - lib/main.rb
+- lib/parser/json_parser.rb
 - lib/parser/parser.rb
-- lib/parser/xlsx_parser.rb
 - lib/report/junit_report.rb
 - lib/report/report.rb
 - lib/report/report_summary.rb

data/lib/parser/xlsx_parser.rb

@@ -1,72 +0,0 @@
-# Created on 02 Aug 2018
-# @author: Andy Perrett
-#
-# Versions:
-# 1.0 - Baseline
-#
-# xlsx_parser.rb - xlsx parser functions
-module XlsxParser
-  require_relative '../taf_config.rb'
-
-  def self.parse_xlxs_test_header_data
-    # get the number of test steps in the file
-    $numberOfTestSteps = $xlsxDoc[0].sheet_data.size - 4
-    worksheet = $xlsxDoc[0]
-    # get the remaining test data
-    $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(_test_file_type)
-    worksheet = $xlsxDoc[0]
-    worksheet[4..$numberOfTestSteps + 4].map do |row|
-      test = {
-        testStep: row[0].value,
-        testdesc: row[1].value,
-        testFunction: row[2].value,
-        testvalue: row[3].value,
-        locate: row[4].value,
-        testvalue2: row[5].value,
-        locate2: row[6].value,
-        screenShotData: row[7].value,
-        skipTestCase: row[8].value
-      }
-
-      # convert test step, screenshot and skip test case functions to lowercase.
-      test[:testFunction].downcase!
-
-      # get screenshot request, check for a null value and default to 'N'
-
-      test[:screenShotData] = if test[:screenShotData] == 'Y'
-                                true
-                              elsif test[:screenShotData] == 'N'
-                                false
-                              else
-                                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
-      test[:locate] = 'id' if test[:locate].to_s == ''
-
-      test[:locate2] = 'id' if test[:locate2].to_s == ''
-
-      test
-    # if an error reading the test step data then re-raise the exception
-    rescue StandardError => error
-      raise error
-    end
-  end
-end