taf 0.3.8 → 0.3.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fdf9086f0e77fd7b425360f96cd7ce31eb009af1108cbaf87f2db5074741a247
-  data.tar.gz: b1d008e6ad5536addcfb8968581f5c161d751a4e98688d6f435d2b39fd9cb66b
+  metadata.gz: bb63f2071b93028017fb466d80db1c21bef8f468788f6b3df344b3f9ba00b8ef
+  data.tar.gz: 8760a5584efe3a280b80f87886ce3e13511747f1226cf6501070529242b945d8
 SHA512:
-  metadata.gz: d1983aa74c176c657c4aa4ebf13f49ef401f084f369f738a923102fe3d72cacc4fe054e63fba75fd7557c37739791d906c05a437ea9b0739b916a5ee2a2b3489
-  data.tar.gz: c4062ab7558b5591d8ac095f7f17d1d881d2a2abc56cc29090046732e4a33dfbb25cabe6312e59cf0d402ed7767dcf1f17802d690d7864beef4fe93052ea3746
+  metadata.gz: 96ca2091cfe212d6364c9b2da8ed5a3cdcd1f054a2ae4d600815fa49925c2a024a63fe8f4d596bb9c5dfc2d9da336b26d5b6c605c37903351c273019e939f3be
+  data.tar.gz: 061a360b6a1a4fb0ebfbcc197b1eba9b1ce019891643709f115907a11a447e96797e2e47a65524830d66197f44a1669136977c97f9f6125a55321a994a75951a

data/bin/taf

@@ -16,11 +16,10 @@ total_metrics = [total_passes, total_failures, total_skipped]
 # get the overall test suite end time
 ts_end_time = Taf::Report.current_time
 
+total_time = TimeDifference.between(ts_end_time, ts_start_time).humanize || 0
 # 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)
+Taf::ReportSummary.overall_test_summary(total_time, total_metrics)
+Taf::TapReport.output
 
 # Exit status code.
 Process.exit(total_failures.zero? ? 0 : 1)

data/lib/taf/report.rb

@@ -11,78 +11,50 @@ module Taf
   module Report
     # 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')
+      require 'time'
+      # Time.new.strftime('%a %b %d %H:%M:%S %Z')
+      Time.new.xmlschema
     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)
+    def self.print_test_step_header(test_step_idx, test_desc)
       @test_start_time = current_time
       Taf::MyLog.log.info "Test step: #{test_step_idx} : #{test_desc}"
-
-      step = { 'id' => test_step_idx,
-               'classname' => "SuiteID: #{Taf::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
+    def self.test_pass_fail(
+      pass_fail,
+      test_file_name,
+      test_step_idx,
+      test_step_description,
+      metrics
+    )
+      if pass_fail
+        Taf::MyLog.log.info "Test #{test_step_idx} has Passed ".green
         @current_test_fail = false
         metrics.stepPasses += 1
-        Taf::MyLog.log.info "Test #{test_step_idx} has Passed ".green
+        Taf::TapReport.success(
+          test_file_name, test_step_idx, test_step_description
+        )
       elsif pass_fail == false
+        Taf::MyLog.log.warn "Test #{test_step_idx} has FAILED ".red
+        Taf::Screenshot.save_screenshot(test_step_idx)
         @current_test_fail = true
         metrics.stepFailures += 1
-        Taf::MyLog.log.warn "Test #{test_step_idx} has FAILED ".red
-        sc_file_name = Taf::Screenshot.save_screenshot(test_step_idx)
-        failstep = {
-          'message' => "SuiteID: #{Taf::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
+        Taf::TapReport.failure(
+          test_file_name, test_step_idx, test_step_description
+        )
       else
+        Taf::MyLog.log.info "Test #{test_step_idx} no checks performed ".blue
         @current_test_fail = false
         metrics.stepSkipped += 1
-        Taf::MyLog.log.info "Test #{test_step_idx} no checks performed ".blue
-        skipstep = {
-          'message' => "SuiteID: #{Taf::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
+        Taf::TapReport.skip(
+          test_file_name, test_step_idx, test_step_description
+        )
       end
-      test_end_time = current_time
 
+      test_end_time = current_time
       test_duration = TimeDifference.between(
         test_end_time, @test_start_time
       ).humanize || 0
@@ -92,6 +64,7 @@ module Taf
     # 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 = 3
       if @current_test_fail

data/lib/taf/report_summary.rb

@@ -39,13 +39,10 @@ module Taf
     end
 
     # output the overall test results summary
-    def self.overall_test_summary(ts_start_time, ts_end_time, total_metrics)
+    def self.overall_test_summary(total_time, total_metrics)
       print_test_summary
-      t_time = TimeDifference.between(ts_end_time, ts_start_time).humanize || 0
 
-      Taf::MyLog.log.info "Total Tests started at: #{ts_start_time}"
-      Taf::MyLog.log.info "Total Tests finished at: #{ts_end_time}"
-      Taf::MyLog.log.info "Total Tests duration: #{t_time}"
+      Taf::MyLog.log.info "Toatal Duration: #{total_time}"
       Taf::MyLog.log.info "Total Tests Passed: #{total_metrics[0]}".green
       Taf::MyLog.log.info "Total Tests Failed: #{total_metrics[1]}".red
       Taf::MyLog.log.info "Total Tests Skipped: #{total_metrics[2]}".blue

data/lib/taf/tap_report.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+# Created on 13 June 2019
+# @author: Andy Perrett
+#
+# Versions:
+# 1.0 - Baseline
+#
+
+module Taf
+  # tap_report.rb - methods for outputting to a tap report file.
+  class TapReport
+    include Singleton
+
+    def self.success(filename, index, description)
+      step = Taf::TestSteps::SuccessStep.new(index: index,
+                                             description: description)
+      add_step filename, step
+    end
+
+    def self.failure(filename, index, description)
+      step = Taf::TestSteps::FailureStep.new(index: index,
+                                             description: description)
+      add_step filename, step
+    end
+
+    def self.skip(filename, index, description)
+      step = Taf::TestSteps::SkipStep.new(index: index,
+                                          description: description)
+      add_step filename, step
+    end
+
+    def self.add_step(filename, step)
+      instance.tests[filename] ||= []
+      instance.tests[filename] << step
+    end
+
+    def self.output
+      project_id = Taf::JSONParser.project_id.delete(' ')
+      ts_dir = File.join('Results', project_id)
+      file = File.open("#{ts_dir}/report_#{SecureRandom.uuid}.tap", 'w')
+      total_steps = 0
+      successes = 0
+      failures = 0
+      instance.tests.each do |filename, steps|
+        file.write("# #{filename}\n")
+        steps.each do |step|
+          total_steps += 1
+          if step.is_a?(Taf::TestSteps::SkipStep)
+            outstr = "ok #{total_steps} #{step.description} # SKIP"
+          else
+            if step.is_a?(Taf::TestSteps::SuccessStep)
+              outstr = 'ok'
+              successes += 1
+            elsif step.is_a?(Taf::TestSteps::FailureStep)
+              outstr = 'not ok'
+              failures += 1
+            else
+              outstr = '# test error'
+            end
+            outstr += " #{total_steps} #{step.description} - Step #{step.index}"
+          end
+
+          file.write(outstr + "\n")
+        end
+      end
+      file.write("1..#{total_steps}\n")
+      file.write("# tests #{total_steps}\n")
+      file.write("# pass #{successes}\n")
+      file.write("# fail #{failures}\n")
+      file.close
+    end
+
+    def initialize
+      @tests = {}
+    end
+
+    attr_accessor :tests
+  end
+end

data/lib/taf/test_engine.rb

@@ -35,9 +35,6 @@ module Taf
         # create project folders - these only need creating once per test suite
         Taf::CreateDirectories.construct_projectdirs
 
-        # get the test case start time
-        tc_start = Taf::Report.current_time
-
         Taf::Browser.open_browser
 
         begin
@@ -55,16 +52,9 @@ module Taf
           Taf::MyLog.log.warn e
         end
 
-        # get the test case end time
-        tc_end = Taf::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
+        # output the test results summary to console
         Taf::ReportSummary.test_step_summary(test_file_name, test_file_idx,
                                              metrics)
-        Taf::JUnitReport.test_step_summary_xml(test_file_name, test_file_idx,
-                                               tc_start, tc_end, metrics)
 
         # close the browser if created
         Taf::Browser.b.quit

data/lib/taf/test_steps/failure_step.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Taf
+  module TestSteps
+    class FailureStep < Step
+    end
+  end
+end

data/lib/taf/test_steps/handlers/base/check_boxdata.rb

@@ -7,10 +7,10 @@ module Taf
       class CheckBoxdata < Base
         register :check_box_data
 
-        def perform
-          elms = %i[textarea text_field iframe]
+        def check
+          @elms = %i[textarea text_field iframe]
 
-          found_box = elms.map do |elm|
+          found_box = @elms.map do |elm|
             Taf::Browser.b.send(elm, "#{@locate}": @value).exists?
           end.compact
 
@@ -19,7 +19,12 @@ module Taf
           index = found_box.index(true)
           return unless index
 
-          ele = Taf::Browser.b.send(elms[index], "#{@locate}": @value)
+          index
+        end
+
+        def perform
+          index = check
+          ele = Taf::Browser.b.send(@elms[index], "#{@locate}": @value)
 
           ele.wait_until(&:exists?)
           (ele.value == @value2)

data/lib/taf/test_steps/handlers/base/click_button.rb

@@ -7,10 +7,10 @@ module Taf
       class ClickButton < Base
         register :click_button
 
-        def perform
-          elms = %i[button span a div link image h1 h2 h3 h4]
+        def check
+          @elms = %i[button span a div link image h1 h2 h3 h4]
 
-          found_button = elms.map do |elm|
+          found_button = @elms.map do |elm|
             Taf::Browser.b.send(elm, "#{@locate}": @value).exists?
           end.compact
 
@@ -19,7 +19,12 @@ module Taf
           index = found_button.index(true)
           return unless index
 
-          Taf::Browser.b.send(elms[index], "#{@locate}": @value)
+          index
+        end
+
+        def perform
+          index = check
+          Taf::Browser.b.send(@elms[index], "#{@locate}": @value)
                       .wait_until(&:exists?).click
           Taf::MyLog.log.info("Button: #{@value} has been selected")
           true

data/lib/taf/test_steps/handlers/base/write_box_data.rb

@@ -7,12 +7,10 @@ module Taf
       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]
+        def check
+          @elms = %i[textarea text_field iframe]
 
-          found_box = elms.map do |elm|
+          found_box = @elms.map do |elm|
             Taf::Browser.b.send(elm, "#{@locate}": @value).exists?
           end.compact
 
@@ -21,7 +19,14 @@ module Taf
           index = found_box.index(true)
           return unless index
 
-          Taf::Browser.b.send(elms[index], "#{@locate}": @value)
+          index
+        end
+
+        def perform
+          txt = @value2
+          txt = ENV[txt.to_s] if ENV[txt.to_s]
+          index = check
+          Taf::Browser.b.send(@elms[index], "#{@locate}": @value)
                       .wait_until(&:exists?).send_keys txt
           Taf::MyLog.log.info("Textbox: #{@value} has correct value: #{txt}")
           true

data/lib/taf/test_steps/handlers/base.rb

@@ -25,8 +25,7 @@ module Taf
           if Taf::Browser.b.title.eql?(b_title)
             Taf::Browser.b.text_field(id: user_elm).wait_until(&:exists?)
                         .set user
-            Taf::Browser.b.text_field(id: pass_elm).wait_until(&:exists?)
-                        .set pass
+            Taf::Browser.b.text_field(id: pass_elm).set pass
             button = 'Sign in' || 'Log in'
             Taf::Browser.b.button(value: button).wait_until(&:exists?).click
             sleep 1

data/lib/taf/test_steps/skip_step.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Taf
+  module TestSteps
+    class SkipStep < Step
+    end
+  end
+end

data/lib/taf/test_steps/step.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Taf
+  module TestSteps
+    # steps.rb - methods for collecting steps info for tap report file.
+    class Step
+      attr_reader :index, :description
+
+      def initialize(
+        index:,
+        description:
+      )
+        @index = index
+        @description = description
+      end
+    end
+  end
+end

data/lib/taf/test_steps/success_step.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+module Taf
+  module TestSteps
+    class SuccessStep < Step
+    end
+  end
+end

data/lib/taf/test_steps.rb

@@ -18,7 +18,7 @@ module Taf
     def self.process_test_steps(test_file_name, test_step_idx, step_attributes,
                                 metrics)
       # print the test step information
-      Taf::Report.print_test_step_header(test_file_name, test_step_idx,
+      Taf::Report.print_test_step_header(test_step_idx,
                                          step_attributes[:testdesc])
       runtest = step_attributes[:skipTestCase]
       step_function = step_attributes[:testFunction]
@@ -26,7 +26,13 @@ module Taf
 
       if handler.respond_to?(:perform)
         func = handler.perform(step_attributes) if runtest == false
-        Taf::Report.test_pass_fail(func, test_file_name, test_step_idx, metrics)
+        Taf::Report.test_pass_fail(
+          func,
+          test_file_name,
+          test_step_idx,
+          step_attributes[:testdesc],
+          metrics
+        )
         Taf::Report.check_failure_threshold(test_file_name)
         return true
       else

data/lib/taf/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Taf
-  VERSION = '0.3.8'
+  VERSION = '0.3.9'
 end

data/lib/taf.rb

@@ -14,7 +14,6 @@ module Taf
   require 'fileutils'
   require 'logger'
   require 'net/ping'
-  require 'nokogiri'
   require 'time_difference'
   require 'colored'
   require 'optparse'
@@ -26,7 +25,7 @@ module Taf
   require 'taf/cmd_line'
   require 'taf/create_directories'
   require 'taf/json_parser'
-  require 'taf/junit_report'
+  require 'taf/tap_report'
   require 'taf/my_log'
   require 'taf/parser'
   require 'taf/report'
@@ -34,6 +33,10 @@ module Taf
   require 'taf/screenshot'
   require 'taf/test_engine'
   require 'taf/test_steps'
+  require 'taf/test_steps/step'
+  require 'taf/test_steps/success_step'
+  require 'taf/test_steps/failure_step'
+  require 'taf/test_steps/skip_step'
   require 'taf/test_steps/handlers/base'
   require 'taf/version'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: taf
 version: !ruby/object:Gem::Version
-  version: 0.3.8
+  version: 0.3.9
 platform: ruby
 authors:
 - Andy Perrett
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-06-10 00:00:00.000000000 Z
+date: 2019-06-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,20 +94,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-- !ruby/object:Gem::Dependency
-  name: nokogiri
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: rubygems-update
   requirement: !ruby/object:Gem::Requirement
@@ -178,14 +164,15 @@ files:
 - lib/taf/cmd_line.rb
 - lib/taf/create_directories.rb
 - lib/taf/json_parser.rb
-- lib/taf/junit_report.rb
 - lib/taf/my_log.rb
 - lib/taf/parser.rb
 - lib/taf/report.rb
 - lib/taf/report_summary.rb
 - lib/taf/screenshot.rb
+- lib/taf/tap_report.rb
 - lib/taf/test_engine.rb
 - lib/taf/test_steps.rb
+- lib/taf/test_steps/failure_step.rb
 - lib/taf/test_steps/handlers/base.rb
 - lib/taf/test_steps/handlers/base/browser_back.rb
 - lib/taf/test_steps/handlers/base/browser_forward.rb
@@ -211,6 +198,9 @@ files:
 - lib/taf/test_steps/handlers/base/select_dropdown.rb
 - lib/taf/test_steps/handlers/base/send_special_keys.rb
 - lib/taf/test_steps/handlers/base/write_box_data.rb
+- lib/taf/test_steps/skip_step.rb
+- lib/taf/test_steps/step.rb
+- lib/taf/test_steps/success_step.rb
 - lib/taf/version.rb
 homepage: https://github.com/Aperrett/TAF
 licenses:

data/lib/taf/junit_report.rb

@@ -1,73 +0,0 @@
-# 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