allure-rspec 0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d5172f300f2a968898c79b3db59c0fc632c2d74c
+  data.tar.gz: 6a63f38b078f320a38b8b4c133e032c64f7c94dd
+SHA512:
+  metadata.gz: 030995aae4cb005e6a498222a3050d484ab1aa825f63a0e3ff97768fc4f069161831a503d5e70be70a44c1d898f77b7495518700342816e77402a022ad1f100f
+  data.tar.gz: a49109b6de8af85d44ebcb3b49bfc101fd53bb584c59498cdebb756ac5fc29875f075e37f0f7d2f812241bbe9dbd547afa91f152dc429782eb8b7206f306b8f9

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec
+gem 'rspec-steps', '~> 0.1.1'
+gem 'nokogiri', '~> 1.6.0'

data/Gemfile.lock

@@ -0,0 +1,41 @@
+PATH
+  remote: .
+  specs:
+    Allure RSpec Adaptor (0.1)
+      nokogiri
+      rspec-steps (~> 0.1.1)
+      uuid
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.2.5)
+    macaddr (1.6.1)
+      systemu (~> 2.5.0)
+    mini_portile (0.5.2)
+    nokogiri (1.6.0)
+      mini_portile (~> 0.5.0)
+    rake (10.1.0)
+    rspec (2.13.0)
+      rspec-core (~> 2.13.0)
+      rspec-expectations (~> 2.13.0)
+      rspec-mocks (~> 2.13.0)
+    rspec-core (2.13.1)
+    rspec-expectations (2.13.0)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.13.1)
+    rspec-steps (0.1.1)
+      rspec (>= 2.6, < 2.14.0)
+    systemu (2.5.2)
+    uuid (2.3.7)
+      macaddr (~> 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  Allure RSpec Adaptor!
+  bundler
+  nokogiri (~> 1.6.0)
+  rake
+  rspec-steps (~> 0.1.1)

data/README.md

@@ -0,0 +1,53 @@
+# Allure RSpec Adaptor
+
+Adaptor to use the Allure framework along with the RSpec
+
+## Setup
+
+Add the dependency to your Gemfile
+
+```ruby
+ gem 'allure-rspec'
+```
+
+And then include it in your spec_helper.rb:
+
+```ruby
+    RSpec.configure do |c|
+      c.include AllureRSpec::Adaptor
+    end
+```
+
+## Advanced options
+
+You can specify the directory where the Allure test results will appear. By default it would be 'allure/data' within
+your current directory.
+
+```ruby
+    AllureRSpec.configure do |c|
+      c.output_dir = "/whatever/you/like"
+    end
+```
+
+## Usage examples
+
+```ruby
+describe AllureRSpec do
+
+  it "should build" do
+    step "step1" do
+      attach_file "screenshot1", take_screenshot_as_file
+    end
+
+    step "step2" do
+      5.should be < 1
+    end
+
+    step "step3" do
+      0.should == 0
+    end
+
+    attach_file "screenshot2", take_screenshot_as_file
+  end
+end
+```

data/allure-rspec.gemspec

@@ -0,0 +1,27 @@
+# -*- 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       = 'Apache2'
+
+  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-steps', '~> 0.1.1'
+  s.add_dependency 'nokogiri'
+  s.add_dependency 'uuid'
+
+  s.add_development_dependency 'bundler'
+  s.add_development_dependency 'rake'
+end

data/lib/allure-rspec.rb

@@ -0,0 +1,28 @@
+require 'allure-rspec/version'
+require 'allure-rspec/formatter'
+require 'allure-rspec/adaptor'
+require 'allure-rspec/dsl'
+require 'allure-rspec/builder'
+
+module AllureRSpec
+  include AllureRSpec::DSL
+
+  module Config
+    class << self
+      attr_accessor :output_dir
+
+      DEFAULT_OUTPUT_DIR = 'allure/data'
+
+      def output_dir
+        @output_dir || DEFAULT_OUTPUT_DIR
+      end
+    end
+  end
+
+  class << self
+    def configure(&block)
+      yield Config
+    end
+  end
+
+end

data/lib/allure-rspec/adaptor.rb

@@ -0,0 +1,9 @@
+module AllureRSpec
+  module Adaptor
+    def self.included(base)
+      base.send :include, AllureRSpec::DSL
+      RSpec.configuration.add_formatter(AllureRSpec::Formatter)
+    end
+  end
+end
+

data/lib/allure-rspec/builder.rb

@@ -0,0 +1,150 @@
+require 'rexml/text'
+
+module AllureRSpec
+
+  class Builder
+    class << self
+      attr_accessor :suites
+      MUTEX = Mutex.new
+
+      def init_suites
+        MUTEX.synchronize {
+          self.suites ||= {}
+        }
+      end
+
+      def start_suite(title)
+        init_suites
+        MUTEX.synchronize do
+          puts "Starting suite #{title}"
+          self.suites[title] = {
+              :title => title,
+              :start => timestamp,
+              :tests => {},
+          }
+        end
+      end
+
+      def start_test(suite, test, severity = :normal)
+        MUTEX.synchronize do
+          puts "Starting test #{suite}.#{test}"
+          self.suites[suite][:tests][test] = {
+              :title => test,
+              :start => timestamp,
+              :severity => severity,
+              :failure => nil,
+              :steps => {},
+              :attachments => []
+          }
+        end
+      end
+
+      def stop_test(suite, test, result = {})
+        self.suites[suite][:tests][test][:steps].each do |step_title, step|
+          if step[:stop].nil? || step[:stop] == 0
+            stop_step(suite, test, step_title, result[:status])
+          end
+        end
+        MUTEX.synchronize do
+          puts "Stopping test #{suite}.#{test}"
+          self.suites[suite][:tests][test][:stop] = timestamp(result[:started_at])
+          self.suites[suite][:tests][test][:start] = timestamp(result[:finished_at])
+          self.suites[suite][:tests][test][:status] = result[:status]
+          if (result[:status].to_sym != :passed)
+            self.suites[suite][:tests][test][:failure] = {
+                :stacktrace => escape((result[:caller] || []).map { |s| s.to_s }.join("\r\n")),
+                :message => escape(result[:exception].to_s),
+            }
+          end
+
+        end
+      end
+
+      def escape(text)
+        REXML::Text.new(text, false, nil, false)
+      end
+
+      def start_step(suite, test, step, severity = :normal)
+        MUTEX.synchronize do
+          puts "Starting step #{suite}.#{test}.#{step}"
+          self.suites[suite][:tests][test][:steps][step] = {
+              :title => step,
+              :start => timestamp,
+              :severity => severity || :normal,
+              :attachments => []
+          }
+        end
+      end
+
+      def add_attachment(suite, test, attachment, step = nil)
+        attach = {
+            :title => attachment[:title],
+            :source => attachment[:source],
+            :type => attachment[:type],
+        }
+        if step.nil?
+          self.suites[suite][:tests][test][:attachments] << attach
+        else
+          self.suites[suite][:tests][test][:steps][step][:attachments] << attach
+        end
+      end
+
+      def stop_step(suite, test, step, status = :passed)
+        MUTEX.synchronize do
+          puts "Stopping step #{suite}.#{test}.#{step}"
+          self.suites[suite][:tests][test][:steps][step][:stop] = timestamp
+          self.suites[suite][:tests][test][:steps][step][:status] = status
+        end
+      end
+
+      def stop_suite(title)
+        init_suites
+        MUTEX.synchronize do
+          puts "Stopping suite #{title}"
+          self.suites[title][:stop] = timestamp
+        end
+      end
+
+      def timestamp(time = nil)
+        ((time || Time.now).to_f * 1000).to_i
+      end
+
+      def each_suite_build(&block)
+        suites_xml = []
+        self.suites.each do |suite_title, suite|
+          builder = Nokogiri::XML::Builder.new do
+            send "test-suite", :start => suite[:start] || 0, :stop => suite[:stop] || 0 do
+              title suite_title
+              suite[:tests].each do |test_title, test|
+                send "test-cases", :start => test[:start] || 0, :stop => test[:stop] || 0, :status => test[:status], :severity => test[:severity] do
+                  title test_title
+                  unless test[:failure].nil?
+                    failure do
+                      message test[:failure][:message]
+                      send "stack-trace", test[:failure][:stacktrace]
+                    end
+                  end
+                  test[:steps].each do |step_title, step_obj|
+                    steps(:start => step_obj[:start] || 0, :stop => step_obj[:stop] || 0, :status => step_obj[:status]) do
+                      title step_title
+                      step_obj[:attachments].each do |attach|
+                        attachment :source => attach[:source], :title => attach[:title], :type => attach[:type]
+                      end
+                    end
+                  end
+                  test[:attachments].each do |attach|
+                    attachment :source => attach[:source], :title => attach[:title], :type => attach[:type]
+                  end
+                end
+              end
+            end
+          end
+          xml = builder.to_xml
+          yield suite, xml
+          suites_xml << xml
+        end
+        suites_xml
+      end
+    end
+  end
+end

data/lib/allure-rspec/dsl.rb

@@ -0,0 +1,45 @@
+module AllureRSpec
+  module DSL
+
+    ALLOWED_ATTACH_EXTS = %w[txt html xml png jpg json]
+
+    def __mutex
+      @@__mutex ||= Mutex.new
+    end
+
+    def __current_step
+      if defined? @@__current_step
+        @@__current_step
+      else
+        nil
+      end
+    end
+
+    def __with_step(step, &block)
+      __mutex.synchronize do
+        @@__current_step = step
+        yield
+        @@__current_step = nil
+      end
+    end
+
+    def step(step, &block)
+      suite = self.example.metadata[:example_group][:description_args].first
+      test = self.example.metadata[:description]
+      AllureRSpec::Builder.start_step(suite, test, step)
+      __with_step step, &block
+      AllureRSpec::Builder.stop_step(suite, test, step)
+    end
+
+    def attach_file(title, file)
+      step = __current_step
+      suite = self.example.metadata[:example_group][:description_args].first
+      test = self.example.metadata[:description]
+      type = :other
+      file_extname = File.extname(file.path.downcase)
+      type = file_extname if ALLOWED_ATTACH_EXTS.include?(file_extname)
+      AllureRSpec::Builder.add_attachment(suite, test, {:type => type, :title => title, :source => file.path}, step)
+    end
+  end
+end
+

data/lib/allure-rspec/formatter.rb

@@ -0,0 +1,60 @@
+require 'pathname'
+require 'uuid'
+
+module AllureRSpec
+
+  class Formatter < RSpec::Core::Formatters::BaseFormatter
+
+    def example_failed(example)
+      AllureRSpec::Builder.stop_test(
+          example.metadata[:example_group][:description_args].first,
+          example.metadata[:description],
+          example.metadata[:execution_result].merge(:caller => example.metadata[:caller])
+      )
+      super
+    end
+
+    def example_group_finished(group)
+      AllureRSpec::Builder.stop_suite(group.metadata[:example_group][:description_args].first)
+      super
+    end
+
+    def example_group_started(group)
+      AllureRSpec::Builder.start_suite(group.metadata[:example_group][:description_args].first)
+      super
+    end
+
+    def example_passed(example)
+      AllureRSpec::Builder.stop_test(
+          example.metadata[:example_group][:description_args].first,
+          example.metadata[:description],
+          example.metadata[:execution_result].merge(:caller => example.metadata[:caller])
+      )
+      super
+    end
+
+    def example_pending(example)
+      super
+    end
+
+    def example_started(example)
+      suite = example.metadata[:example_group][:description_args].first
+      test = example.metadata[:description]
+      AllureRSpec::Builder.start_test(suite, test)
+      super
+    end
+
+    def stop
+      AllureRSpec::Builder.each_suite_build do |suite, xml|
+        dir = Pathname.new(AllureRSpec::Config.output_dir)
+        FileUtils.rm_rf(dir)
+        FileUtils.mkdir_p(dir)
+        File.open(dir.join("#{UUID.new.generate}.xml"), 'w+') do |file|
+          file.write(xml)
+        end
+      end
+      super
+    end
+
+  end
+end

data/lib/allure-rspec/version.rb

@@ -0,0 +1,5 @@
+module AllureRSpec # :nodoc:
+  module Version # :nodoc:
+    STRING = '0.1'
+  end
+end

data/spec/extend_steps_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'tempfile'
+
+describe AllureRSpec do
+  it "should build" do
+    attach_file "test-file1", Tempfile.new("test")
+    step "step1" do
+      attach_file "test-file2", Tempfile.new("test")
+    end
+
+    step "step2" do
+
+      5.should be < 1
+    end
+
+    step "step3" do
+
+      0.should == 0
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,11 @@
+require 'rspec'
+require 'allure-rspec'
+require 'nokogiri'
+
+RSpec.configure do |c|
+  c.include AllureRSpec::Adaptor
+end
+
+AllureRSpec.configure do |c|
+  c.output_dir = "allure"
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: allure-rspec
+version: !ruby/object:Gem::Version
+  version: '0.1'
+platform: ruby
+authors:
+- Ilya Sadykov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec-steps
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.1.1
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: uuid
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  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
+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/builder.rb
+- lib/allure-rspec/dsl.rb
+- lib/allure-rspec/formatter.rb
+- lib/allure-rspec/version.rb
+- spec/extend_steps_spec.rb
+- spec/spec_helper.rb
+homepage: http://allure.qatools.ru
+licenses:
+- Apache2
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: allure-rspec-0.1
+test_files: []