allure-rspec 0.8.0 → 2.15.0

data/lib/allure_rspec/metadata_parser.rb

@@ -0,0 +1,186 @@
+# frozen_string_literal: true
+
+module AllureRspec
+  # RSpec metadata parser
+  #
+  class RspecMetadataParser
+    include Utils
+
+    RSPEC_IGNORED_METADATA = %i[
+      absolute_file_path
+      block
+      described_class
+      description
+      description_args
+      example_group
+      execution_result
+      file_path
+      full_description
+      last_run_status
+      line_number
+      location
+      rerun_file_path
+      retry
+      retry_attempts
+      retry_exceptions
+      scoped_id
+      shared_group_inclusion_backtrace
+      type
+    ].freeze
+
+    # Metadata parser instance
+    #
+    # @param [RSpec::Core::Example] example
+    # @param [AllureRspec::RspecConfig] config <description>
+    def initialize(example, config)
+      @example = example
+      @config = config
+    end
+
+    # Get allure labels
+    # @return [Array<Allure::Label>]
+    def labels
+      [
+        framework_label,
+        package_label,
+        test_class_label,
+        severity,
+        *tag_labels,
+        *behavior_labels,
+        *suite_labels
+      ].select(&:value)
+    end
+
+    # Get attachable links
+    # @return [Array<Allure::Link>]
+    def links
+      matching_links(:tms) + matching_links(:issue)
+    end
+
+    # Get status details
+    # @return [Allure::StatusDetails]
+    def status_details
+      Allure::StatusDetails.new(
+        flaky: !metadata[:flaky].nil?,
+        muted: !metadata[:muted].nil?,
+        known: !metadata[:known].nil?
+      )
+    end
+
+    private
+
+    # @return [RSpec::Core::Example]
+    attr_reader :example
+
+    # @return [AllureRspec::RspecConfig]
+    attr_reader :config
+
+    # Example metadata
+    #
+    # @return [Hash]
+    def metadata
+      @metadata ||= example.metadata
+    end
+
+    # Get package label
+    # @return [Allure::Label]
+    def package_label
+      Allure::ResultUtils.package_label(Pathname.new(strip_relative(example.file_path)).parent.to_s)
+    end
+
+    # Get test class label
+    #
+    # @return [Allure::Label]
+    def test_class_label
+      Allure::ResultUtils.test_class_label(File.basename(example.file_path, ".rb"))
+    end
+
+    # Get framework label
+    # @return [Allure::Label]
+    def framework_label
+      Allure::ResultUtils.framework_label("rspec")
+    end
+
+    # Get severity
+    # @return [String]
+    def severity
+      Allure::ResultUtils.severity_label(metadata[config.severity_tag] || "normal")
+    end
+
+    # Get test suite labels
+    # @return [Array<Allure::Label>]
+    def suite_labels
+      SuiteLabels.new(example.example_group).fetch
+    end
+
+    # Get custom labels
+    # @return [Array<Allure::Label>]
+    def tag_labels
+      metadata
+        .reject { |k| RSPEC_IGNORED_METADATA.include?(k) || special_metadata_tag?(k) }
+        .map { |k, v| allure?(k) ? Allure::ResultUtils.tag_label(v) : Allure::ResultUtils.tag_label(k.to_s) }
+    end
+
+    # Get behavior labels
+    # @return [Array<Allure::Label>]
+    def behavior_labels
+      metadata = example.metadata
+      epic = metadata[config.epic_tag] || Pathname.new(strip_relative(example.file_path)).parent.to_s
+      feature = metadata[config.feature_tag] || example.example_group.description
+      story = metadata[config.story_tag]
+
+      [
+        Allure::ResultUtils.epic_label(epic),
+        Allure::ResultUtils.feature_label(feature),
+        Allure::ResultUtils.story_label(story)
+      ]
+    end
+
+    # tms and issue links
+    # @param [Symbol] type
+    # @return [Array<Allure::Link>]
+    def matching_links(type)
+      link_pattern = config.public_send("link_#{type}_pattern")
+      return [] unless link_pattern
+
+      metadata
+        .select { |key| __send__("#{type}?", key) }
+        .map { |key, value| Allure::ResultUtils.public_send("#{type}_link", key.to_s, value, link_pattern) }
+    end
+
+    # Special allure metadata tags
+    #
+    # @param [Symbol] key
+    # @return [boolean]
+    def special_metadata_tag?(key)
+      tms?(key) || issue?(key) || [
+        config.severity_tag,
+        config.epic_tag,
+        config.feature_tag,
+        config.story_tag,
+        *config.ignored_tags
+      ].include?(key)
+    end
+
+    # Does key match custom allure label
+    # @param [Symbol] key
+    # @return [boolean]
+    def allure?(key)
+      key.to_s.match?(/allure(_\d+)?/i)
+    end
+
+    # Does key match tms pattern
+    # @param [Symbol] key
+    # @return [boolean]
+    def tms?(key)
+      key.to_s.match?(/#{config.tms_tag}(_\d+)?/i)
+    end
+
+    # Does key match issue pattern
+    # @param [Symbol] key
+    # @return [boolean]
+    def issue?(key)
+      key.to_s.match?(/#{config.issue_tag}(_\d+)?/i)
+    end
+  end
+end

data/lib/allure_rspec/suite_labels.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module AllureRspec
+  # Suite label generator
+  #
+  class SuiteLabels
+    include Utils
+
+    def initialize(example_group)
+      @example_group = example_group
+    end
+
+    # Get test suite labels
+    # @return [Array<Allure::Label>]
+    def fetch
+      parents = example_group.parent_groups.map do |group|
+        group.description.empty? ? "Anonymous" : group.description
+      end
+
+      labels = []
+      labels << Allure::ResultUtils.suite_label(suite(parents))
+      labels << Allure::ResultUtils.parent_suite_label(parent_suite(parents)) if parent_suite(parents)
+      labels << Allure::ResultUtils.sub_suite_label(sub_suites(parents)) if sub_suites(parents)
+
+      labels
+    end
+
+    private
+
+    attr_reader :example_group
+
+    # @param [Array<String>] parents
+    # @return [String]
+    def suite(parents)
+      parents.length == 1 ? parents.last : parents[-2]
+    end
+
+    # @param [Array<String>] parents
+    # @return [String]
+    def parent_suite(parents)
+      parents.length > 1 ? parents.last : nil
+    end
+
+    # @param [Array<String>] parents
+    # @return [String]
+    def sub_suites(parents)
+      parents.length > 2 ? parents[0..-3].join(" > ") : nil
+    end
+  end
+end

metadata

@@ -1,101 +1,71 @@
 --- !ruby/object:Gem::Specification
 name: allure-rspec
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 2.15.0
 platform: ruby
 authors:
-- Ilya Sadykov
+- Andrejs Cunskis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-12-28 00:00:00.000000000 Z
+date: 2021-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-- !ruby/object:Gem::Dependency
-  name: allure-ruby-adaptor-api
+  name: allure-ruby-commons
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 2.15.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 2.15.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rspec-core
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+        version: '3.8'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
+        version: '4'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
-description: Adaptor to use Allure framework along with the RSpec 2
-email:
-- smecsia@yandex-team.ru
+        version: '3.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '4'
+description: Cucumber adaptor to generate rich allure test reports
+email: andrejs.cunskis@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- Gemfile
-- Gemfile.lock
 - README.md
-- allure-rspec.gemspec
 - lib/allure-rspec.rb
-- lib/allure-rspec/adaptor.rb
-- lib/allure-rspec/dsl.rb
-- lib/allure-rspec/formatter.rb
-- lib/allure-rspec/hooks.rb
-- lib/allure-rspec/version.rb
-- logo.png
-- spec/another_spec.rb
-- spec/extend_steps_spec.rb
-- spec/hooks_spec.rb
-- spec/issue51_spec.rb
-- spec/nometavalue_spec.rb
-- spec/shared_example_spec.rb
-- spec/spec_helper.rb
-homepage: http://allure.qatools.ru
+- lib/allure_rspec/_utils.rb
+- lib/allure_rspec/config.rb
+- lib/allure_rspec/formatter.rb
+- lib/allure_rspec/metadata_parser.rb
+- lib/allure_rspec/suite_labels.rb
+homepage: https://github.com/allure-framework/allure-ruby/tree/master/allure-rspec
 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-rspec/README.md
+  source_code_uri: https://github.com/allure-framework/allure-ruby/tree/master/allure-rspec
+  wiki_uri: https://github.com/allure-framework/allure-ruby/wiki
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -104,16 +74,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.5.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 3.2.22
 signing_key: 
 specification_version: 4
-summary: allure-rspec-0.8.0
+summary: Allure rspec ruby adaptor
 test_files: []

data/.gitignore

@@ -1,15 +0,0 @@
-*.class
-
-# Package Files #
-*.jar
-*.war
-*.ear
-*.gem
-
-allure-report
-target
-allure
-.idea
-*.iml
-*.ipr
-*.iws

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec

data/Gemfile.lock

@@ -1,49 +0,0 @@
-PATH
-  remote: .
-  specs:
-    allure-rspec (0.8.0)
-      allure-ruby-adaptor-api (= 0.7.0)
-      rspec (~> 3.5)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    allure-ruby-adaptor-api (0.7.0)
-      mimemagic
-      nokogiri (~> 1.7)
-      uuid
-    diff-lcs (1.2.5)
-    macaddr (1.7.1)
-      systemu (~> 2.6.2)
-    mimemagic (0.3.2)
-    mini_portile2 (2.1.0)
-    nokogiri (1.7.0)
-      mini_portile2 (~> 2.1.0)
-    rake (10.4.2)
-    rspec (3.5.0)
-      rspec-core (~> 3.5.0)
-      rspec-expectations (~> 3.5.0)
-      rspec-mocks (~> 3.5.0)
-    rspec-core (3.5.4)
-      rspec-support (~> 3.5.0)
-    rspec-expectations (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-mocks (3.5.0)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.5.0)
-    rspec-support (3.5.0)
-    systemu (2.6.5)
-    uuid (2.3.8)
-      macaddr (~> 1.0)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  allure-rspec!
-  bundler
-  rake
-
-BUNDLED WITH
-   1.13.7

data/allure-rspec.gemspec

@@ -1,26 +0,0 @@
-# -*- encoding: utf-8 -*-
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
-require "allure-rspec/version"
-
-Gem::Specification.new do |s|
-  s.name          = 'allure-rspec'
-  s.version       = AllureRSpec::Version::STRING
-  s.platform         = Gem::Platform::RUBY
-  s.authors       = ['Ilya Sadykov']
-  s.email         = ['smecsia@yandex-team.ru']
-  s.description   = %q{Adaptor to use Allure framework along with the RSpec 2}
-  s.summary       = "allure-rspec-#{AllureRSpec::Version::STRING}"
-  s.homepage      = 'http://allure.qatools.ru'
-  s.license       = 'Apache-2.0'
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ['lib']
-
-  s.add_dependency 'rspec', '~> 3.5'
-  s.add_dependency 'allure-ruby-adaptor-api', '0.7.0'
-
-  s.add_development_dependency 'bundler'
-  s.add_development_dependency 'rake'
-end

data/lib/allure-rspec/adaptor.rb

@@ -1,15 +0,0 @@
-module AllureRSpec
-  module Adaptor
-    def self.included(base)
-      AllureRSpec.context.rspec = base
-      base.send :include, AllureRSpec::DSL
-      if RSpec::Core::Formatters::Loader.formatters.keys.find_all { |f| f == AllureRSpec::Formatter }.empty?
-        RSpec::Core::Formatters.register AllureRSpec::Formatter, *AllureRSpec::Formatter::NOTIFICATIONS
-        RSpec.configuration.add_formatter(AllureRSpec::Formatter)
-      end
-      RSpec::Core::ExampleGroup.send :include, AllureRSpec::Hooks
-      RSpec::Core::Example.send :include, AllureRSpec::DSL::Example
-    end
-  end
-end
-

data/lib/allure-rspec/dsl.rb

@@ -1,61 +0,0 @@
-require 'digest'
-require 'mimemagic'
-module AllureRSpec
-  module DSL
-    module Example
-
-      def current_step
-        if defined? @@__current_step
-          @@__current_step
-        else
-          nil
-        end
-      end
-
-      def step(step, &block)
-        suite = __description(metadata[:example_group])
-        test = __description(metadata)
-        begin
-          AllureRubyAdaptorApi::Builder.start_step(suite, test, step)
-          __with_step step, &block
-          AllureRubyAdaptorApi::Builder.stop_step(suite, test, step)
-        rescue Exception => e
-          AllureRubyAdaptorApi::Builder.stop_step(suite, test, step, :failed)
-          raise e
-        end
-      end
-
-
-      def attach_file(title, file, opts = {})
-        suite = __description(metadata[:example_group])
-        test = __description(metadata)
-        step = current_step
-        AllureRubyAdaptorApi::Builder.add_attachment suite, test, opts.merge(:title => title, :file => file, :step => step)
-      end
-
-      private
-
-      def __description(data)
-        data[:full_description] || data[:description]
-      end
-
-      def __mutex
-        @@__mutex ||= Mutex.new
-      end
-
-      def __with_step(step, &block)
-        __mutex.synchronize do
-          begin
-            @@__current_step = step
-            AllureRSpec.context.rspec.hooks.send :run, :before, :step, self
-            yield self
-          ensure
-            AllureRSpec.context.rspec.hooks.send :run, :after, :step, self
-            @@__current_step = nil
-          end
-        end
-      end
-    end
-  end
-end
-

data/lib/allure-rspec/formatter.rb

@@ -1,117 +0,0 @@
-require 'rspec/core' unless defined?(RSpec::Core)
-require 'rspec/core/formatters/base_formatter' unless defined?(RSpec::Core::Formatters::BaseFormatter)
-require 'fileutils'
-
-module AllureRSpec
-
-  class Formatter < RSpec::Core::Formatters::BaseFormatter
-
-    NOTIFICATIONS = [:example_group_started, :example_group_finished, :example_started,
-                     :example_failed, :example_passed, :example_pending, :start, :stop]
-    ALLOWED_LABELS = [:feature, :story, :severity, :language, :framework, :issue, :testId, :host, :thread]
-
-    def example_failed(notification)
-      res = notification.example.execution_result
-      status = res.exception.is_a?(RSpec::Expectations::ExpectationNotMetError) ? :failed : :broken
-      stop_test(notification.example, :exception => res.exception, :status => status)
-    end
-
-    def example_group_finished(notification)
-      AllureRubyAdaptorApi::Builder.stop_suite(description(notification.group).to_s)
-    end
-
-    def example_group_started(notification)
-      AllureRubyAdaptorApi::Builder.start_suite(description(notification.group).to_s, labels(notification))
-    end
-
-    def example_passed(notification)
-      stop_test(notification.example)
-    end
-
-    def example_pending(notification)
-      stop_test(notification.example)
-    end
-
-    def example_started(notification)
-      suite = description(notification.example.example_group).to_s
-      test = description(notification.example).to_s
-      AllureRubyAdaptorApi::Builder.start_test(suite, test, labels(notification))
-    end
-
-    def start(example_count)
-      dir = Pathname.new(AllureRSpec::Config.output_dir)
-      if AllureRSpec::Config.clean_dir?
-        puts "Cleaning output directory '#{dir}'..."
-        FileUtils.rm_rf(dir)
-      end
-      FileUtils.mkdir_p(dir)
-    end
-
-    def stop(notify)
-      AllureRubyAdaptorApi::Builder.build!
-    end
-
-    private
-
-    def description(data, attr = :full_description)
-      ((((data.respond_to?(attr)) ?
-          data.send(attr) : data.metadata[attr]) ||
-          description(data, :description)) || '').strip
-    end
-
-    def stop_test(example, opts = {})
-      res = example.execution_result
-      AllureRubyAdaptorApi::Builder.stop_test(
-          description(example.example_group).to_s,
-          (example.metadata[:description_args].size== 0) ? description(example.example_group) : description(example).to_s,
-          {
-              :status => res.status,
-              :finished_at => res.finished_at,
-              :started_at => res.started_at
-          }.merge(opts)
-      )
-    end
-
-    def metadata(example_or_group)
-      group?(example_or_group) ?
-          example_or_group.group.metadata :
-          example_or_group.example.metadata
-    end
-
-    def group?(example_or_group)
-      (example_or_group.respond_to? :group)
-    end
-
-    def labels(example_or_group)
-      labels = ALLOWED_LABELS.map { |label| [label, metadata(example_or_group)[label]] }.
-          find_all { |value| !value[1].nil? }.
-          inject({}) { |res, value| res.merge(value[0] => value[1]) }
-      detect_feature_story(labels, example_or_group)
-      labels
-    end
-
-    def method_or_key(metadata, key)
-      metadata.respond_to?(key) ? metadata.send(key) : metadata[key]
-    end
-
-    def detect_feature_story(labels, example_or_group)
-      metadata = metadata(example_or_group)
-      is_group = group?(example_or_group)
-      parent = (method_or_key(metadata, :parent_example_group))
-      if labels[:feature] === true
-        description = (!is_group && parent) ? method_or_key(parent, :description) : method_or_key(metadata, :description)
-        labels[:feature] = description
-        if labels[:story] === true
-          if parent
-            grandparent = parent && method_or_key(parent, :parent_example_group)
-            labels[:feature] = (!is_group && grandparent) ? method_or_key(grandparent, :description) :
-                method_or_key(parent, :description)
-          end
-          labels[:story] = description
-        end
-      end
-      labels
-    end
-
-  end
-end