allure-cucumber 2.13.0 → 2.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a40fd70805beafb477df5371f9e8f7c0f66cee6c8243b484141eb7b32c9a1026
-  data.tar.gz: f555048bb7569ecee757c15082e384d30f89eb5d15799317084a8655a1f478bb
+  metadata.gz: ec242b1ce862dc86cbf68c7856daa57f683796581e4433af79b4ad7a55b9a783
+  data.tar.gz: fd36406dead4a7ba6fe504bf48b6a97b6a99ef2063820fe56426619f44df8460
 SHA512:
-  metadata.gz: ac13c7c3b417e00809b05c584f695539f585aaf8712c58c15998049c1dc8382a5a8aea4bad87d783a5c3a85f224a53f29939dad7b11ba8a3b428b9ee20a1bd97
-  data.tar.gz: bb7c69513879f80dd682ff78a896be2dc2d9a6994be249035ed4f9a60eecd4c5b33687ef89486add98e023faa0d0b676317055823b078d22d3b5f6c7d8745121
+  metadata.gz: e924c3a2e4a7ea1ce3b8b598f0f1ebed4b7a9299653b412b80588e4926b87e010b79557d0e2c83ef32a3c186b6638c5867d13e99f8af94791ded9e8e0d8bbb98
+  data.tar.gz: 6a22c0c59c031df736423e71826d2da0a9a64e3ac3672ff41edc6f85e50dccab817976fe73ae46da4a744ed94b7165133e6405dbe5611e1f414a4484f289c96f

data/lib/allure_cucumber/cucumber_model.rb

@@ -10,128 +10,126 @@ require_relative "tag_parser"
 
 module AllureCucumber
   # Support class for transforming cucumber test entities in to allure model entities
-  class AllureCucumberModel
-    extend AstTransformer
-    extend TagParser
-
-    class << self
-      # Convert to allure test result
-      # @param [Cucumber::Core::Test::Case] test_case
-      # @return [TestResult]
-      def test_result(test_case)
-        Allure::TestResult.new(
-          name: test_case.name,
-          description: description(test_case),
-          description_html: description(test_case),
-          history_id: Digest::MD5.hexdigest(test_case.inspect),
-          full_name: "#{test_case.feature.name}: #{test_case.name}",
-          labels: labels(test_case),
-          links: links(test_case),
-          parameters: parameters(test_case) || [],
-          status_details: Allure::StatusDetails.new(**status_detail_tags(test_case.tags.map(&:name))),
-        )
-      end
+  module AllureCucumberModel
+    include AstTransformer
+    include TagParser
+
+    # Convert to allure test result
+    # @param [Cucumber::Core::Test::Case] test_case
+    # @return [TestResult]
+    def test_result(test_case)
+      Allure::TestResult.new(
+        name: test_case.name,
+        description: description(test_case),
+        description_html: description(test_case),
+        history_id: Digest::MD5.hexdigest(test_case.inspect),
+        full_name: "#{test_case.feature.name}: #{test_case.name}",
+        labels: labels(test_case),
+        links: links(test_case),
+        parameters: parameters(test_case) || [],
+        status_details: Allure::StatusDetails.new(**status_detail_tags(test_case.tags.map(&:name))),
+      )
+    end
 
-      # Convert to allure step result
-      # @param [Cucumber::Core::Test::Step] test_step
-      # @return [StepResult]
-      def step_result(test_step)
-        Allure::StepResult.new(
-          name: "#{step(test_step).keyword}#{test_step.text}",
-          attachments: [multiline_arg_attachment(test_step)].compact,
-        )
-      end
+    # Convert to allure step result
+    # @param [Cucumber::Core::Test::Step] test_step
+    # @return [StepResult]
+    def step_result(test_step)
+      Allure::StepResult.new(
+        name: "#{step(test_step).keyword}#{test_step.text}",
+        attachments: [multiline_arg_attachment(test_step)].compact,
+      )
+    end
 
-      # Convert to allure step result
-      # @param [Cucumber::Core::Test::Step] test_step
-      # @return [StepResult]
-      def fixture_result(test_step)
-        location = test_step.location.to_s.split("/").last
-        Allure::FixtureResult.new(name: location)
-      end
+    # Convert to allure step result
+    # @param [Cucumber::Core::Test::Step] test_step
+    # @return [StepResult]
+    def fixture_result(test_step)
+      location = test_step.location.to_s.split("/").last
+      Allure::FixtureResult.new(name: location)
+    end
 
-      # Get failure details
-      # @param [Cucumber::Core::Test::Result] result <description>
-      # @return [Hash<Symbol, String>]
-      def failure_details(result)
-        return { message: result.exception.message, trace: result.exception.backtrace.join("\n") } if result.failed?
-        return { message: result.message, trace: result.backtrace.join("\n") } if result.undefined?
+    # Get failure details
+    # @param [Cucumber::Core::Test::Result] result <description>
+    # @return [Hash<Symbol, String>]
+    def failure_details(result)
+      return { message: result.exception.message, trace: result.exception.backtrace.join("\n") } if result.failed?
+      return { message: result.message, trace: result.backtrace.join("\n") } if result.undefined?
 
-        {}
-      end
+      {}
+    end
 
-      private
+    # Get thread specific lifecycle
+    # @return [Allure::AllureLifecycle]
+    def lifecycle
+      Allure.lifecycle
+    end
 
-      # Get thread specific lifecycle
-      # @return [Allure::AllureLifecycle]
-      def lifecycle
-        Allure.lifecycle
+    private
+
+    # @param [Cucumber::Core::Test::Case] test_case
+    # @return [Array<Allure::Label>]
+    def labels(test_case)
+      labels = []
+      labels << Allure::ResultUtils.framework_label("cucumber")
+      labels << Allure::ResultUtils.feature_label(test_case.feature.name)
+      labels << Allure::ResultUtils.package_label(test_case.feature.name)
+      labels << Allure::ResultUtils.suite_label(test_case.feature.name)
+      labels << Allure::ResultUtils.story_label(test_case.name)
+      labels << Allure::ResultUtils.test_class_label(test_case.name)
+      unless test_case.tags.empty?
+        labels.push(*tag_labels(test_case.tags))
+        labels << severity(test_case.tags)
       end
 
-      # @param [Cucumber::Core::Test::Case] test_case
-      # @return [Array<Allure::Label>]
-      def labels(test_case)
-        labels = []
-        labels << Allure::ResultUtils.framework_label("cucumber")
-        labels << Allure::ResultUtils.feature_label(test_case.feature.name)
-        labels << Allure::ResultUtils.package_label(test_case.feature.name)
-        labels << Allure::ResultUtils.suite_label(test_case.feature.name)
-        labels << Allure::ResultUtils.story_label(test_case.name)
-        labels << Allure::ResultUtils.test_class_label(test_case.name)
-        unless test_case.tags.empty?
-          labels.push(*tag_labels(test_case.tags))
-          labels << severity(test_case.tags)
-        end
-
-        labels
-      end
+      labels
+    end
 
-      # @param [Cucumber::Core::Test::Case] test_case
-      # @return [Array<Allure::Link>]
-      def links(test_case)
-        return [] unless test_case.tags
+    # @param [Cucumber::Core::Test::Case] test_case
+    # @return [Array<Allure::Link>]
+    def links(test_case)
+      return [] unless test_case.tags
 
-        tms_links(test_case.tags) + issue_links(test_case.tags)
-      end
+      tms_links(test_case.tags) + issue_links(test_case.tags)
+    end
 
-      # @param [Cucumber::Core::Test::Case] test_case
-      # @return [Array<Allure::Parameter>]
-      def parameters(test_case)
-        example_row(test_case)&.values&.map { |value| Allure::Parameter.new("argument", value) }
-      end
+    # @param [Cucumber::Core::Test::Case] test_case
+    # @return [Array<Allure::Parameter>]
+    def parameters(test_case)
+      example_row(test_case)&.values&.map { |value| Allure::Parameter.new("argument", value) }
+    end
 
-      # @param [Cucumber::Core::Test::Case] test_case
-      # @return [String]
-      def description(test_case)
-        scenario = scenario(test_case)
-        scenario.description.empty? ? "Location - #{scenario.file_colon_line}" : scenario.description.strip
-      end
+    # @param [Cucumber::Core::Test::Case] test_case
+    # @return [String]
+    def description(test_case)
+      scenario = scenario(test_case)
+      scenario.description.empty? ? "Location - #{scenario.file_colon_line}" : scenario.description.strip
+    end
 
-      # @param [Cucumber::Core::Test::Step] test_step
-      # @return [Allure::Attachment]
-      def multiline_arg_attachment(test_step)
-        arg = multiline_arg(test_step)
-        return unless arg
+    # @param [Cucumber::Core::Test::Step] test_step
+    # @return [Allure::Attachment]
+    def multiline_arg_attachment(test_step)
+      arg = multiline_arg(test_step)
+      return unless arg
 
-        arg.data_table? ? data_table_attachment(arg) : docstring_attachment(arg)
-      end
+      arg.data_table? ? data_table_attachment(arg) : docstring_attachment(arg)
+    end
 
-      # @param [Cucumber::Core::Ast::DataTable] multiline_arg
-      # @return [Allure::Attachment]
-      def data_table_attachment(multiline_arg)
-        attachment = lifecycle.prepare_attachment("data-table", Allure::ContentType::CSV)
-        csv = multiline_arg.raw.each_with_object([]) { |row, arr| arr.push(row.to_csv) }.join("")
-        lifecycle.write_attachment(csv, attachment)
-        attachment
-      end
+    # @param [Cucumber::Core::Ast::DataTable] multiline_arg
+    # @return [Allure::Attachment]
+    def data_table_attachment(multiline_arg)
+      attachment = lifecycle.prepare_attachment("data-table", Allure::ContentType::CSV)
+      csv = multiline_arg.raw.each_with_object([]) { |row, arr| arr.push(row.to_csv) }.join("")
+      lifecycle.write_attachment(csv, attachment)
+      attachment
+    end
 
-      # @param [String] multiline_arg
-      # @return [String]
-      def docstring_attachment(multiline_arg)
-        attachment = lifecycle.prepare_attachment("docstring", Allure::ContentType::TXT)
-        lifecycle.write_attachment(multiline_arg.content, attachment)
-        attachment
-      end
+    # @param [String] multiline_arg
+    # @return [String]
+    def docstring_attachment(multiline_arg)
+      attachment = lifecycle.prepare_attachment("docstring", Allure::ContentType::TXT)
+      lifecycle.write_attachment(multiline_arg.content, attachment)
+      attachment
     end
   end
 end

data/lib/allure_cucumber/formatter.rb

@@ -1,11 +1,12 @@
 # frozen_string_literal: true
 
-require "fileutils"
 require_relative "cucumber_model"
 
 module AllureCucumber
   # Main formatter class. Translates cucumber event to allure lifecycle
   class CucumberFormatter
+    include AllureCucumberModel
+
     # @return [Hash] hook handler methods
     HOOK_HANDLERS = {
       "Before hook" => :start_prepare_fixture,
@@ -22,20 +23,28 @@ module AllureCucumber
     def initialize(config)
       Allure.configure do |c|
         c.results_directory = config.out_stream if config.out_stream.is_a?(String)
-        FileUtils.rm_f(Dir.glob("#{c.results_directory}/*")) if c.clean_results_directory
       end
+
+      config.on_event(:test_run_started, &method(:on_test_run_started))
       config.on_event(:test_case_started, &method(:on_test_case_started))
       config.on_event(:test_step_started, &method(:on_test_step_started))
       config.on_event(:test_step_finished, &method(:on_test_step_finished))
       config.on_event(:test_case_finished, &method(:on_test_case_finished))
     end
 
+    # Clean test result directory before starting run
+    # @param [Cucumber::Events::TestRunStarted<Type>] _event
+    # @return [void]
+    def on_test_run_started(_event)
+      lifecycle.clean_results_dir
+    end
+
     # Handle test case started event
     # @param [Cucumber::Core::Events::TestCaseStarted] event
     # @return [void]
     def on_test_case_started(event)
       lifecycle.start_test_container(Allure::TestResultContainer.new(name: event.test_case.name))
-      lifecycle.start_test_case(AllureCucumberModel.test_result(event.test_case))
+      lifecycle.start_test_case(test_result(event.test_case))
     end
 
     # Handle test step started event
@@ -65,7 +74,7 @@ module AllureCucumber
     # @param [Cucumber::Core::Events::TestCaseFinished] event
     # @return [void]
     def on_test_case_finished(event)
-      failure_details = AllureCucumberModel.failure_details(event.result)
+      failure_details = failure_details(event.result)
       status = ALLURE_STATUS.fetch(event.result.to_sym, Allure::Status::BROKEN)
       lifecycle.update_test_case do |test_case|
         test_case.stage = Allure::Stage::FINISHED
@@ -80,12 +89,6 @@ module AllureCucumber
 
     private
 
-    # Get thread specific lifecycle
-    # @return [Allure::AllureLifecycle]
-    def lifecycle
-      Allure.lifecycle
-    end
-
     # @param [Cucumber::Core::Test::Step] test_step <description>
     # @return [Boolean]
     def hook?(test_step)
@@ -101,7 +104,7 @@ module AllureCucumber
     # @param [Cucumber::Core::Test::Step] test_step
     # @return [void]
     def handle_step_started(test_step)
-      lifecycle.start_test_step(AllureCucumberModel.step_result(test_step))
+      lifecycle.start_test_step(step_result(test_step))
     end
 
     # @param [Cucumber::Core::Test::Step] test_step
@@ -109,7 +112,7 @@ module AllureCucumber
     def handle_hook_started(test_step)
       return if prepare_world_hook?(test_step)
 
-      lifecycle.public_send(HOOK_HANDLERS[test_step.text], AllureCucumberModel.fixture_result(test_step))
+      lifecycle.public_send(HOOK_HANDLERS[test_step.text], fixture_result(test_step))
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-cucumber
 version: !ruby/object:Gem::Version
-  version: 2.13.0
+  version: 2.13.1
 platform: ruby
 authors:
 - Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-09-08 00:00:00.000000000 Z
+date: 2019-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: allure-ruby-commons
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 2.13.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 2.13.0
+        version: 2.13.1
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -54,7 +54,12 @@ files:
 homepage: https://github.com/allure-framework/allure-ruby
 licenses:
 - Apache-2.0
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/allure-framework/allure-ruby/issues
+  changelog_uri: https://github.com/allure-framework/allure-ruby/releases
+  documentation_uri: https://github.com/allure-framework/allure-ruby/blob/master/allure-cucumber/README.md
+  source_code_uri: https://github.com/allure-framework/allure-ruby/tree/master/allure-cucumber
+  wiki_uri: https://github.com/allure-framework/allure-ruby/wiki
 post_install_message: 
 rdoc_options: []
 require_paths: