allure-ruby-commons 2.13.0 → 2.13.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f87a04ab08ca894c406ea456552a64243acc4b91beb359e4c4673efc27c5b2e4
-  data.tar.gz: ce8af253d321e87a8115afb86df0e5d882555469de95969abac529c2b7b4c8c3
+  metadata.gz: 5a9115fbeeca5e229495d548047fa91edac5cb364a3a18c629f7d860fff43b3c
+  data.tar.gz: 302ce724cd87c8c8a392687355c693774e40e0dfeb6d00cc4e67c5202a2dd733
 SHA512:
-  metadata.gz: dd99f1bb1d1d4fd31d0a3bdd91a4752f2105f17149e73a3c2b031a03741eab5483557b50bb45e7af52e016620390fe820866937605724587baa15f0d1a4a61b4
-  data.tar.gz: 063dc9cd0a43cfa264396d7c21b26d2080233fb8d89eba446602c51243af305774c99b9e0553d3f6f51c483d35f8bfb1ad3ae7ff7ad3463f0820e20d11c53150
+  metadata.gz: 7392a3abf6e355d4e1a7e1dfddca5c39c68ffe89549eaf72db2a0e7e4793c4019e7f2dfb5877c82be92775476ac70349218e1c85087ed17aa7374a0d6c461beb
+  data.tar.gz: 9a263ffc1763bbb4647c5341259bf12f6e8e766feb026fc4f7fae41c51b109609b64b410baaadb0080f9bd07edfccb113ffb47553e5ddbf7632770188ed8190a

data/lib/allure-ruby-commons.rb

@@ -76,7 +76,7 @@ module Allure
     # Add description to current test case
     # @param [String] description
     # @return [void]
-    def description(description)
+    def add_description(description)
       lifecycle.update_test_case do |test_case|
         test_case.description = description
       end

data/lib/allure_ruby_commons/allure_lifecycle.rb

@@ -1,9 +1,12 @@
 # frozen_string_literal: true
 
+require "fileutils"
+
 module Allure
   # Main class for creating and writing allure results
   class AllureLifecycle
     def initialize
+      @test_context = []
       @step_context = []
     end
 
@@ -11,8 +14,10 @@ module Allure
     # @param [Allure::TestResultContainer] test_result_container
     # @return [Allure::TestResultContainer]
     def start_test_container(test_result_container)
-      test_result_container.start = ResultUtils.timestamp
-      @current_test_result_container = test_result_container
+      test_result_container.tap do |container|
+        container.start = ResultUtils.timestamp
+        @test_context.push(container)
+      end
     end
 
     # @example Update current test container
@@ -23,23 +28,25 @@ module Allure
     # @yieldreturn [void]
     # @return [void]
     def update_test_container
-      unless @current_test_result_container
+      unless current_test_result_container
         return logger.error("Could not update test container, no container is running.")
       end
 
-      yield(@current_test_result_container)
+      yield(current_test_result_container)
     end
 
     # Stop current test container and write result
     # @return [void]
     def stop_test_container
-      unless @current_test_result_container
+      unless current_test_result_container
         return logger.error("Could not stop test container, no container is running.")
       end
 
-      @current_test_result_container.stop = ResultUtils.timestamp
-      file_writer.write_test_result_container(@current_test_result_container)
-      clear_current_test_container
+      current_test_result_container.tap do |container|
+        container.stop = ResultUtils.timestamp
+        file_writer.write_test_result_container(container)
+        clear_last_test_container
+      end
     end
 
     # Start test case and add to current test container
@@ -47,14 +54,14 @@ module Allure
     # @return [Allure::TestResult]
     def start_test_case(test_result)
       clear_step_context
-      unless @current_test_result_container
+      unless current_test_result_container
         return logger.error("Could not start test case, test container is not started")
       end
 
       test_result.start = ResultUtils.timestamp
       test_result.stage = Stage::RUNNING
       test_result.labels.push(ResultUtils.thread_label, ResultUtils.host_label, ResultUtils.language_label)
-      @current_test_result_container.children.push(test_result.uuid)
+      current_test_result_container.children.push(test_result.uuid)
       @current_test_case = test_result
     end
 
@@ -123,7 +130,7 @@ module Allure
     # @return [Allure::FixtureResult]
     def start_prepare_fixture(fixture_result)
       start_fixture(fixture_result) || return
-      @current_test_result_container.befores.push(fixture_result)
+      current_test_result_container.befores.push(fixture_result)
       @current_fixture = fixture_result
     end
 
@@ -132,7 +139,7 @@ module Allure
     # @return [Allure::FixtureResult]
     def start_tear_down_fixture(fixture_result)
       start_fixture(fixture_result) || return
-      @current_test_result_container.afters.push(fixture_result)
+      current_test_result_container.afters.push(fixture_result)
       @current_fixture = fixture_result
     end
 
@@ -141,7 +148,7 @@ module Allure
     # @return [Allure::FixtureResult]
     def start_fixture(fixture_result)
       clear_step_context
-      unless @current_test_result_container
+      unless current_test_result_container
         logger.error("Could not start fixture, test container is not started")
         return false
       end
@@ -218,6 +225,14 @@ module Allure
       step_result
     end
 
+    # Clean results directory
+    # @return [void]
+    def clean_results_dir
+      Allure.configuration.tap do |c|
+        FileUtils.rm_f(Dir.glob("#{c.results_directory}/*")) if c.clean_results_directory
+      end
+    end
+
     private
 
     def logger
@@ -232,12 +247,12 @@ module Allure
       current_test_step || @current_fixture || @current_test_case
     end
 
-    def clear_current_test_container
-      @current_test_result_container = nil
+    def current_test_result_container
+      @test_context.last
     end
 
-    def clear_current_test_case
-      @current_test_case = nil
+    def clear_last_test_container
+      @test_context.pop
     end
 
     def current_test_step
@@ -252,6 +267,10 @@ module Allure
       @step_context.clear
     end
 
+    def clear_current_test_case
+      @current_test_case = nil
+    end
+
     def clear_current_fixture
       @current_fixture = nil
     end

data/lib/allure_ruby_commons/result_utils.rb

@@ -75,6 +75,20 @@ module Allure
         Label.new(SUITE_LABEL_NAME, value)
       end
 
+      # Parent suite label
+      # @param [String] value
+      # @return [Allure::Label]
+      def parent_suite_label(value)
+        Label.new(PARENT_SUITE_LABEL_NAME, value)
+      end
+
+      # Parent suite label
+      # @param [String] value
+      # @return [Allure::Label]
+      def sub_suite_label(value)
+        Label.new(SUB_SUITE_LABEL_NAME, value)
+      end
+
       # Story label
       # @param [String] value
       # @return [Allure::Label]
@@ -119,16 +133,16 @@ module Allure
 
       # Get status based on exception type
       # @param [Exception] exception
-      # @return [String]
+      # @return [Symbol]
       def status(exception)
         expectation_error?(exception) ? Status::FAILED : Status::BROKEN
       end
 
       # Get exception status detail
       # @param [Exception] exception
-      # @return [Hash<Symbol, String>]
+      # @return [Allure::StatusDetails]
       def status_details(exception)
-        StatusDetails.new(message: exception.message, trace: exception.backtrace&.join("\n"))
+        StatusDetails.new(message: exception&.message, trace: exception&.backtrace&.join("\n"))
       end
 
       private
@@ -144,8 +158,6 @@ module Allure
       def expectation_error?(exception)
         exception.instance_of?(RSpec::Expectations::ExpectationNotMetError) ||
           exception.instance_of?(RSpec::Expectations::MultipleExpectationsNotMetError)
-      rescue NameError
-        false
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allure-ruby-commons
 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: uuid
@@ -58,20 +58,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3'
-- !ruby/object:Gem::Dependency
-  name: rubyzip
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.2'
 - !ruby/object:Gem::Dependency
   name: mime-types
   requirement: !ruby/object:Gem::Requirement
@@ -113,11 +99,15 @@ files:
 - lib/allure_ruby_commons/model/test_result.rb
 - lib/allure_ruby_commons/model/test_result_container.rb
 - lib/allure_ruby_commons/result_utils.rb
-- lib/allure_ruby_commons/util.rb
 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-ruby-commons/README.md
+  source_code_uri: https://github.com/allure-framework/allure-ruby/tree/master/allure-ruby-commons
+  wiki_uri: https://github.com/allure-framework/allure-ruby/wiki
 post_install_message: 
 rdoc_options: []
 require_paths:

data/lib/allure_ruby_commons/util.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-require "open-uri"
-require "zip"
-require "pathname"
-
-module Allure
-  # Utility for downloading allure commandline binary
-  class Util
-    # @return [String] CLI version
-    ALLURE_CLI_VERSION = "2.12.1"
-    # @return [String] CLI bin download url
-    ALLURE_BIN_URL = "http://repo.maven.apache.org/maven2/io/qameta/allure/allure-commandline/"\
-                      "#{ALLURE_CLI_VERSION}/allure-commandline-#{ALLURE_CLI_VERSION}.zip"
-
-    class << self
-      # Download allure bin if appropriate version is not in path
-      # @return [String] allure executable
-      def allure_cli
-        return "allure" if ALLURE_CLI_VERSION == `allure --version`.chomp
-
-        cli_dir = File.join(".allure", "allure-#{ALLURE_CLI_VERSION}")
-        zip = File.join(".allure", "allure.zip")
-        bin = File.join(cli_dir, "bin", "allure")
-
-        FileUtils.mkpath(".allure")
-        download_allure(zip) unless File.exist?(zip) || File.exist?(bin)
-        extract_allure(zip, ".allure") unless File.exist?(bin)
-
-        bin
-      end
-
-      private
-
-      def download_allure(destination)
-        File.open(destination, "w") { |file| file.write(open(ALLURE_BIN_URL).read) } # rubocop:disable Security/Open
-      end
-
-      def extract_allure(zip, destination)
-        Zip::File.foreach(zip) do |entry|
-          entry.restore_permissions = true
-          entry.extract(File.join(destination, entry.name))
-        end
-        FileUtils.rm(zip)
-      end
-    end
-  end
-end