qat-reporter 6.2.2 → 7.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cee1fada9622bdf85a4eed4ae35b843ce9dae4569dbf2e8c552183117d39332f
-  data.tar.gz: ee2809f46036d1a8cb5d4064f2b92a7defdbb5c0259acf3843c36ffcfe0e8120
+  metadata.gz: 4772b5b5e87e182ac3c10af01ff0d4f6c1b9a35a36b39b0deb3977dfae3f279e
+  data.tar.gz: 0a200fcae3fb836ce04bcc903149949482e8103e4eb6251565803ad73190d6e9
 SHA512:
-  metadata.gz: 57feab6d04160266b2dde66f019774bab7ef20db3deb4c4b76fb82de16d30051f8237b119801d7948791803fa20921bf225ef9cc8be77aa98bdd331539fad040
-  data.tar.gz: b19eb7a94e3597f30502f64b9bef53af54b784cd6c2f5a00fcaa0c070955c368ddceb20013d90790c879334408091dae61448bad5c92adedc1df02d23fb9e0ef
+  metadata.gz: 39216fdb5f7c3ef70f6de4680701bdc59c844e854d8ebbf9d6767655ed41087cb8d2674011b152cf581c41159bfbaf607e3c865f6c7074461ee114f7ce615780
+  data.tar.gz: 7c86e34f0a4853bce9301ce2afd48cdad535bdf04d7bc852645e6e528400dc82632b30e5926e085e84ca86934dd5552e9e33b1957780a029e21aab02dc3bb470

data/lib/qat/reporter/formatter/json.rb

@@ -10,7 +10,7 @@ module QAT
       #@since 6.1.7
       class Json < ::Cucumber::Formatter::Json
         #@api private
-        def embed *_
+        def attach *_
         end
       end
     end

data/lib/qat/reporter/formatter/req_coverage.rb

@@ -5,7 +5,9 @@ require 'cucumber/formatter/duration_extractor'
 require 'json'
 require 'fileutils'
 require 'qat/logger'
+require 'qat/formatter/helper'
 require 'qat/formatter/loggable'
+require_relative '../../reporter/times'
 
 module QAT
   # Namespace for QAT Reporter
@@ -14,123 +16,126 @@ module QAT
     #@since 6.1.7
     module Formatter
       # Namespace for ReqCoverage formatter
-      #@since 6.1.7
+      #@since 7.0.0
       class ReqCoverage
         include ::Cucumber::Formatter::Io
         include ::Cucumber::Formatter::Duration
         include QAT::Formatter::Loggable
         include QAT::Logger
-
-        #@api private
-        def initialize(runtime, path_or_io, options)
-          @io = ensure_io(path_or_io)
-          @options = options
-          @test_results = []
-
-          ensure_outputter 'ReqCoverage' unless options[:dry_run]
-        end
-
-        #@api private
-        def before_feature(*_)
+        include QAT::Formatter::Helper
+
+
+        def initialize(config)
+          @config = config
+          @io     = ensure_io(config.out_stream, config.error_stream)
+          ensure_outputter 'ReqCoverage' unless @config.dry_run?
+          @ast_lookup     = ::Cucumber::Formatter::AstLookup.new(config)
+          @feature_hashes = []
+          config.on_event :test_case_started, &method(:on_test_case_started)
+          config.on_event :test_case_finished, &method(:on_test_case_finished)
+          config.on_event :test_run_finished, &method(:on_test_run_finished)
+          @test_results            = []
           @feature_requirement_ids = []
-          @test_requirement_ids = []
-          @in_test_cases = false
-          @row_counter = 0
-          @flag_tag = nil
+          @test_requirement_ids    = []
+          @row_counter             = 0
+          @flag_tag                = nil
         end
 
-        #@api private
-        def feature_name(*_)
-          @in_test_cases = true
-        end
 
         #@api private
         def tag_name(tag_name)
-          @test_id = tag_name.to_s.split('#')[1] if tag_name.match(/@test#(\d+)/)
+          @test_id       = tag_name.to_s.split('#')[1] if tag_name.match(/@test#(\d+)/)
           requirement_id = tag_name.to_s.split('#')[1] if tag_name.match(/@user_story#(\d+)/)
-          if @in_test_cases
-            @test_requirement_ids << requirement_id
-          else
-            @feature_requirement_ids << requirement_id
-          end
+          @test_requirement_ids << requirement_id
         end
 
         #@api private
-        def before_test_case(test_case)
-          @current_scenario = test_case.source[1]
-          unless @current_scenario.is_a?(::Cucumber::Core::Ast::ScenarioOutline)
-            @test_id = nil
-            @test_requirement_ids = []
+        def on_test_case_started(event)
+          return if @config.dry_run?
+          @row_number = nil
+          @examples   = nil
+          test_case   = event.test_case
+          build(test_case, @ast_lookup)
+          @test_id              = nil
+          @test_requirement_ids = []
+          @scenario[:tags].each do |tag|
+            tag_name tag
           end
+
+
         end
 
-        #@api private
-        def after_test_case(_, status)
-          test_status = if status.is_a? ::Cucumber::Core::Test::Result::Passed
+        def on_test_case_finished event
+          return if @config.dry_run?
+          _test_case, result = *event.attributes
+          @current_feature   = nil
+
+          test_status = if result.passed?
                           if QAT::Reporter.const_defined?('Times')
-                            Times.test_sla_status
+                            QAT::Reporter::Times.test_sla_status
                           else
                             "passed"
                           end
-                        elsif status.is_a? ::Cucumber::Core::Test::Result::Failed
+                        elsif result.failed?
                           "failed"
                         else
                           "not_runned"
                         end
 
-          if @current_scenario.is_a? ::Cucumber::Core::Ast::ScenarioOutline
+          if @examples_values
             if @flag_tag == @test_id
               @row_counter += 1
             else
               @row_counter = 1
             end
-
-            test_id = "#{@test_id}.#{@row_counter}".to_f
+            test_id = "#{@test_id}.#{@scenario[:id].split('').last}".to_f
           else
             @row_counter = 1
-            test_id = @test_id.to_i
+            test_id      = @test_id.to_i
           end
 
-          duration = ::Cucumber::Formatter::DurationExtractor.new(status).result_duration
+          duration       = ::Cucumber::Formatter::DurationExtractor.new(result).result_duration
           human_duration = format_duration(duration)
 
           test_result = {
-              test: test_id,
-              requirement: (@feature_requirement_ids + @test_requirement_ids).uniq.compact,
-              status: test_status,
-              duration: duration,
-              human_duration: human_duration
+            test:           test_id,
+            requirement:    @test_requirement_ids.uniq.compact,
+            status:         test_status,
+            duration:       duration,
+            human_duration: human_duration
           }
 
           if test_result[:test]
             @test_results << test_result
 
             log.info({
-                         'message' => 'test execution',
-                         '_test' => test_result[:test],
-                         '_requirement' => test_result[:requirement],
-                         '_status' => test_result[:status],
-                         '_duration' => duration,
-                         '_human_duration' => human_duration
+                       'message'         => 'test execution',
+                       '_test'           => test_result[:test],
+                       '_requirement'    => test_result[:requirement],
+                       '_status'         => test_result[:status],
+                       '_duration'       => duration,
+                       '_human_duration' => human_duration
                      })
           end
 
-          @test_requirement_ids = [] unless @current_scenario.is_a?(::Cucumber::Core::Ast::ScenarioOutline)
-          @flag_tag = @test_id if @flag_tag != @test_id
+          @test_requirement_ids = [] if @examples_values
+          @flag_tag             = @test_id if @flag_tag != @test_id
         end
 
-        #@api private
-        def after_features(*_)
+
+        def on_test_run_finished event
+          return if @config.dry_run?
           publish_result
+          @test_id              = nil
+          @test_requirement_ids = []
         end
 
-
         private
 
         # Writes results to a JSON file
         def publish_result
           content = {
-              results: @test_results
+            results: @test_results
           }
           @io.puts(JSON.pretty_generate(content))
         end

data/lib/qat/reporter/formatter/time_measurements.rb

@@ -4,164 +4,118 @@ require 'cucumber/formatter/duration'
 require 'cucumber/formatter/duration_extractor'
 require 'json'
 require 'qat/logger'
+require 'qat/formatter/helper'
 require 'qat/formatter/loggable'
-require_relative '../times'
+require_relative '../../reporter/times'
+
 
 module QAT
-  # Namespace for QAT Reporter
+  # Namespace for custom Cucumber formatters and helpers.
+  #@since 0.1.0
   module Reporter
-    # Namespace for custom Cucumber formatters and helpers.
-    #@since 6.1.7
     module Formatter
       # Namespace for Time Measurements formatter
-      #@since 6.1.7
+      #@since 7.0.0
       class TimeMeasurements
         include ::Cucumber::Formatter::Io
         include ::Cucumber::Formatter::Duration
-
-        def initialize(runtime, path_or_io, options)
-          @io = ensure_io(path_or_io)
-          @options = options
+        include QAT::Formatter::Loggable
+        include QAT::Logger
+        include QAT::Formatter::Helper
+
+
+        def initialize(config)
+          @config         = config
+          @io             = ensure_io(config.out_stream, config.error_stream)
+          @ast_lookup     = ::Cucumber::Formatter::AstLookup.new(config)
+          @feature_hashes = []
+          config.on_event :test_case_started, &method(:on_test_case_started)
+          config.on_event :test_case_finished, &method(:on_test_case_finished)
+          config.on_event :test_run_finished, &method(:on_test_run_finished)
           @json_content = []
         end
 
-        #@api private
-        def before_feature(feature)
-          @in_test_cases = false
-          @current_feature = feature
-          @current_feature_timestamp = Time.now.strftime("%FT%T%z")
-          @outline_tags = []
-          @current_feature_info = {
-              feature: @current_feature,
-              tags: [],
-              timestamp: @current_feature_timestamp,
-              scenarios: []
-          }
-
-          @outline_scenario_info = {
-              name: [],
-              tags: [],
-              timestamp: [],
-              test_runs: []
-          }
-        end
-
-        #@api private
-        def feature_name(*_)
-          @in_test_cases = true
-        end
 
-        #@api private
-        def tag_name(tag_name)
-          @test_id = tag_name.to_s
-          @current_feature_info[:tags] << tag_name unless @in_test_cases
+        def on_test_case_started event
+          return if @config.dry_run?
+          @row_number = nil
+          test_case   = event.test_case
+          build(test_case, @ast_lookup)
 
-          if @in_test_cases
-            if @current_scenario.is_a?(::Cucumber::Core::Ast::ScenarioOutline)
-              @outline_tags << tag_name
-            else
-              @current_scenario_info[:tags] << tag_name
-            end
+          if @current_feature_info.nil?
+            @current_feature_timestamp = Time.now.strftime("%FT%T%z")
+            feature_body
+          elsif @current_feature_info.values.include?(@feature_hash[:name])
+          else
+            @current_feature_timestamp = Time.now.strftime("%FT%T%z")
+            process_scenarios
+            feature_body
           end
-        end
 
-        #@api private
-        def before_test_case(test_case)
-          @current_scenario = test_case.source[1]
-          @current_scenario_timestamp = Time.now.strftime("%FT%T%z")
-
-          unless @current_scenario.is_a?(::Cucumber::Core::Ast::ScenarioOutline)
-            @current_scenario_info = {
-                name: @current_scenario,
-                tags: [],
-                timestamp: @current_scenario_timestamp,
-                test_runs: []
-            }
-          end
+          @current_scenario        = @scenario
+          @current_scenario[:tags] = @current_scenario[:tags] - @feature_hash[:tags] if @feature_hash[:tags]
+          scenario_body
         end
 
-        #@api private
-        def before_outline_table(*_)
-          @outline = true
-          @outline_scenario_info = {
-              name: @current_scenario,
-              tags: [],
-              timestamp: @current_scenario_timestamp,
-              test_runs: []
-          }
-        end
+        def on_test_case_finished event
+          return if @config.dry_run?
+          _test_case, result = *event.attributes
+          @current_feature   = nil
+          @current_feature_info[:scenarios] << @current_scenario_info
 
-        #@api private
-        def after_test_case(_, status)
           test_run_id = QAT[:current_test_run_id]
           measurements = QAT::Reporter::Times.get_measures rescue []
 
-          test_status = if status.is_a? ::Cucumber::Core::Test::Result::Passed
+          test_status = if result.passed?
                           if QAT::Reporter.const_defined?('Times')
-                            Times.test_sla_status
+                            QAT::Reporter::Times.test_sla_status
                           else
                             "passed"
                           end
-                        elsif status.is_a? ::Cucumber::Core::Test::Result::Failed
+                        elsif result.failed?
                           "failed"
                         else
                           "not_runned"
                         end
 
           test_run_info = {
-              id: test_run_id,
-              test_status: test_status,
-              timestamp: QAT[:test_start_timestamp]&.strftime("%FT%T%z"),
-              measurements: []
+            id:           test_run_id,
+            test_status:  test_status,
+            timestamp:    QAT[:test_start_timestamp]&.strftime("%FT%T%z"),
+            measurements: []
           }
 
           measurements.each do |id, measure|
             if id
               minutes, seconds = measure[:duration].divmod(60)
               test_run_info[:measurements] << {
-                  id: id,
-                  name: measure[:name],
-                  timestamp: measure[:start].strftime("%FT%T%z"),
-                  time: {
-                      secs: measure[:duration],
-                      human: "#{minutes}m #{'%02.0f' % seconds}s"
-                  },
-                  sla: measure[:sla]
+                id:        id,
+                name:      measure[:name],
+                timestamp: measure[:start].strftime("%FT%T%z"),
+                time:      {
+                  secs:  measure[:duration],
+                  human: "#{minutes}m #{'%02.0f' % seconds}s"
+                },
+                sla:       measure[:sla]
               }
             end
           end
 
-          if @current_scenario.is_a?(::Cucumber::Core::Ast::ScenarioOutline)
-            @outline_scenario_info[:test_runs] << test_run_info
-          else
-            @current_scenario_info[:test_runs] << test_run_info
-          end
+          @current_scenario_info[:test_runs] << test_run_info
         end
 
-        #@api private
-        def after_examples_array(*_)
-          @outline_scenario_info[:tags] = @outline_tags
-          @current_feature_info[:scenarios] << @outline_scenario_info
-          @outline = true
-          @outline_tags = []
+        def on_test_run_finished event
+          return if @config.dry_run?
+          process_scenarios
+          @io.puts(JSON.pretty_generate(@json_content))
+          log.error @json_content
         end
 
-        #@api private
-        def after_feature_element(*_)
-          #After outline run, here cucumber changes for non outline, flag needed for outlines scenarios
-          if @outline == true
-            @outline = false
-          else
-            @current_feature_info[:scenarios] << @current_scenario_info
-          end
-          @in_test_cases = true
-        end
 
-        #@api private
-        def after_feature(*_)
-          @indexes = []
+        def process_scenarios
+          @indexes           = []
           @indexes_test_runs = []
-          @scenarios = @current_feature_info[:scenarios]
+          @scenarios         = @current_feature_info[:scenarios]
 
           @scenarios.each_with_index do |key, value|
             test_run = key[:test_runs]
@@ -188,17 +142,25 @@ module QAT
           @json_content << @current_feature_info unless @scenarios.empty?
         end
 
-        #@api private
-        def after_features(*_)
-          publish_result
-        end
 
-        private
+        def feature_body
+          @current_feature_info = {
+            feature:   @feature_hash[:name],
+            tags:      @feature_hash[:tags],
+            timestamp: @current_feature_timestamp,
+            scenarios: []
+          }
+        end
 
-        # Writes results to a JSON file
-        def publish_result
-          @io.puts(JSON.pretty_generate(@json_content))
+        def scenario_body
+          @current_scenario_info = {
+            name:      @current_scenario[:name],
+            tags:      @current_scenario[:tags],
+            timestamp: Time.now.strftime("%FT%T%z"),
+            test_runs: []
+          }
         end
+
       end
     end
   end

data/lib/qat/reporter/times.rb

@@ -200,7 +200,6 @@ module QAT
         description = if QAT.configuration.dig(:qat, :reporter, :times, key).is_a?(Hash)
                         QAT.configuration.dig(:qat, :reporter, :times, key, :name)
                       else
-                        warn "[WARN] DEPRECATED: Measurements definition without limits will be removed in a 7.0 version, please use following configuration instead:\nmeasure_id:\n  name: Test measure\n  sla_warn: 10\n  sla_error: 15"
                         QAT.configuration.dig(:qat, :reporter, :times, key)
                       end
 

data/lib/qat/reporter/times/helpers.rb

@@ -1,4 +1,3 @@
-warn "[WARN] DEPRECATED: QAT::Reporter::Times::Helpers will be removed in a 7.0 version, please use QAT::Reporter::Helpers::TimeFormat"
 require_relative '../helpers/time_format'
 
 module QAT

data/lib/qat/reporter/version.rb

@@ -3,6 +3,6 @@ module QAT
   # Namespace for QAT Reporter
   module Reporter
     # Represents QAT Reporter's version
-    VERSION = '6.2.2'
+    VERSION = '7.0.0'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qat-reporter
 version: !ruby/object:Gem::Version
-  version: 6.2.2
+  version: 7.0.0
 platform: ruby
 authors:
 - QAT
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-10-23 00:00:00.000000000 Z
+date: 2021-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: qat-cucumber
@@ -16,73 +16,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 7.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 7.0.4
 - !ruby/object:Gem::Dependency
   name: qat-logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: qat-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 8.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: qat-devel
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 8.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: 8.0.0
 description: |2
     QAT Reporter is a collection of tool for generating test report information such as:
       - Requirement Coverage
+      - Time Measurements
 email: qatoolkit@readinessit.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
-- lib/qat/formatter/json.rb
-- lib/qat/formatter/req_coverage.rb
-- lib/qat/formatter/time_measurements.rb
 - lib/qat/reporter.rb
 - lib/qat/reporter/formatter/json.rb
 - lib/qat/reporter/formatter/req_coverage.rb
 - lib/qat/reporter/formatter/time_measurements.rb
-- lib/qat/reporter/formatters/ascii_table.rb
 - lib/qat/reporter/helpers.rb
 - lib/qat/reporter/helpers/ascii_table.rb
 - lib/qat/reporter/helpers/time_format.rb
@@ -104,15 +101,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - "~>"
     - !ruby/object:Gem::Version
-      version: '2.3'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.7
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Utility for Test Reports.

data/lib/qat/formatter/json.rb

@@ -1,12 +0,0 @@
-warn "[WARN] DEPRECATED: QAT::Formatter::Json will be removed in a 7.0 version, please use QAT::Reporter::Formatter::Json"
-require_relative '../reporter/formatter/json'
-
-module QAT
-  # Namespace for custom Cucumber formatters and helpers.
-  #@since 0.1.0
-  module Formatter
-    # Namespace for Json formatter
-    #@since 6.1.0
-    Json = QAT::Reporter::Formatter::Json
-  end
-end

data/lib/qat/formatter/req_coverage.rb

@@ -1,12 +0,0 @@
-warn "[WARN] DEPRECATED: QAT::Formatter::ReqCoverage will be removed in a 7.0 version, please use QAT::Reporter::Formatter::ReqCoverage"
-require_relative '../reporter/formatter/req_coverage'
-
-module QAT
-  # Namespace for custom Cucumber formatters and helpers.
-  #@since 0.1.0
-  module Formatter
-    # Namespace for ReqCoverage formatter
-    #@since 1.0.0
-    ReqCoverage = QAT::Reporter::Formatter::ReqCoverage
-  end
-end

data/lib/qat/formatter/time_measurements.rb

@@ -1,10 +0,0 @@
-warn "[WARN] DEPRECATED: QAT::Formatter::TimeMeasurements will be removed in a 7.0 version, please use QAT::Reporter::Formatter::TimeMeasurements"
-require_relative '../reporter/formatter/time_measurements'
-
-module QAT
-  # Namespace for custom Cucumber formatters and helpers.
-  #@since 0.1.0
-  module Formatter
-    TimeMeasurements = QAT::Reporter::Formatter::TimeMeasurements
-  end
-end

data/lib/qat/reporter/formatters/ascii_table.rb

@@ -1,14 +0,0 @@
-warn "[WARN] DEPRECATED: QAT::Reporter::Formatters::AsciiTable will be removed in a 7.0 version, please use QAT::Reporter::Helpers::AsciiTable"
-require_relative '../helpers/ascii_table'
-
-module QAT
-  module Reporter
-    # Namespace for custom Report output formatters
-    #@since 3.1.0
-    module Formatters
-      # Namespace for AsciiTable formatter
-      #@since 3.1.0
-      AsciiTable = QAT::Reporter::Helpers::AsciiTable
-    end
-  end
-end