testrail_rspec 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 892fde2a276a04d5eb848babfe6f5d55f890bc46
+  data.tar.gz: 1367fdb75da3e603bf8ca11ba3bdecf825917d63
+SHA512:
+  metadata.gz: f13bbde2db33c79f2f593f971c81190403e5b5d513a5b4d93fc4c143389dadcdd1b775a60a9b7052a4a34c5cf401a5a258e87dba570a27970d021c762ba3f19a
+  data.tar.gz: 8a780a95af0e588b3ad66ca7e932a384954d298b72c6be55a005e2e8ed6ccea14f831ebd6d24cad33fae59c2f6a504dcbe21787c6c944a932de1ff3bd206d975

data/.gitignore

@@ -0,0 +1,39 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalisation:
+/.bundle/
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+Gemfile.lock
+.ruby-version
+.ruby-gemset
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in testrail-rspec.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Michal Kubik
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# Testrail::Rspec
+
+This gem provides custom RSpec formatter allowing to export test results directly to [TestRail][1] instance via their [API][2].
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'testrail_rspec'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install testrail_rspec
+
+## Usage
+
+### Configuration
+
+via RSpec.configure in spec_helper.rb - describe it in more details when decided how it is done
+
+add to .rspec file this way:
+
+    $ --format TestrailRSpec
+
+or use it from commandline this way:
+
+    $ rspec spec --format TestrailRSpec
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/testrail-rspec/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[1]: http://www.gurock.com/testrail/            "TestRail"
+[2]: http://docs.gurock.com/testrail-api2/start "TestRail API"

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/testrail_rspec/client.rb

@@ -0,0 +1,240 @@
+#
+# TestRail API binding for Ruby (API v2, available since TestRail 3.0)
+#
+# Learn more:
+#
+# http://docs.gurock.com/testrail-api2/start
+# http://docs.gurock.com/testrail-api2/accessing
+#
+# Copyright Gurock Software GmbH. See license.md for details.
+#
+
+# slightly modified by mkubik
+
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+module TestrailRspec
+
+  AUTOMATED_DESCRIPTION = 'created by automated test suite'
+
+  STATUS = {
+      passed: 1,
+      failed: 5,
+      skipped: 7,
+      pending: 6
+  }
+
+  class Client
+
+    def initialize(args)
+      @projects = nil
+      @sections = Hash.new
+      @suite   = Hash.new
+      @suites   = Hash.new
+
+      @client = APIClient.new args[:url]
+      %w(user password project).each do |key|
+        raise Exception.new("TestRail configuration key :#{key} not set. Cannot continue without it.") if args[key.intern].nil?
+        @client.send "#{key}=", args[key.intern] if %w(user password).include? key
+      end
+    end
+
+    # ---------------------------------------------------> projects ----------------------------------------------------
+    def get_projects
+      @projects ||= @client.send_get('get_projects')
+    end
+
+    def add_project(project_name)
+      @projects = nil # invalidate cached stuff
+      @client.send_post('add_project', {name: project_name,
+                                        announcement: AUTOMATED_DESCRIPTION,
+                                        show_anouncement: true})
+    end
+
+    def get_project(project_id)
+      self.get_projects.find { |project| project['id'] == project_id }
+    end
+
+    # ----------------------------------------------------> suites <----------------------------------------------------
+    def get_suite(suite_id)
+      @suite[suite_id] ||= @client.send_get("get_suite/#{suite_id}")
+    end
+
+    def get_suites(project_id)
+      @suites[project_id] ||= @client.send_get("get_suites/#{project_id}")
+    end
+
+    def find_suite_by_name(name, project_id)
+      suites = self.get_suites(project_id).select do |suite|
+        suite['name'] == name
+      end
+      puts "TestRail Exporter [WARN] #{suites.size} suites found with name: #{name}. Using first one." if suites.size > 1
+      suites.first
+    end
+
+    def create_suite(name, project_id)
+      @suites.delete(project_id) # invalidate cached stuff
+      puts "TestRail Exporter [INFO] Creating suite: #{name} under project: #{ self.get_project(project_id)['name'] }"
+      @client.send_post("add_suite/#{project_id}", { name: name, description: AUTOMATED_DESCRIPTION })
+    end
+
+    def find_or_create_suite(name, project_id)
+      self.find_suite_by_name(name, project_id) || self.create_suite(name, project_id)
+    end
+
+    # ---------------------------------------------------> sections <---------------------------------------------------
+    def get_sections(suite)
+      @sections[suite['id']] ||= @client.send_get("get_sections/#{suite['project_id']}&suite_id=#{suite['id']}")
+    end
+
+    def section_ids_at_depth(suite, depth)
+      self.get_sections(suite).select{ |s| s['depth'] == depth }.map{ |s| s['id'] }
+    end
+
+    def find_section(name, suite, parent_id)
+      get_sections(suite).select{ |s| s['parent_id'] == parent_id }.find{ |s| s['name'] == name.strip }
+    end
+
+    def find_or_create_section(name, suite, parent, depth)
+      parent_id = (depth == 0) ? nil : parent['id']
+      self.find_section(name, suite, parent_id) || self.create_section(name, suite, parent_id)
+    end
+
+    def create_section(name, suite, parent_id)
+      @sections.delete(suite['id']) # invalidate cached values
+      # TODO: check if JSON created have null for nil parent_id
+      @client.send_post("add_section/#{suite['project_id']}", { name: name,
+                                                                suite_id: suite['id'],
+                                                                description: AUTOMATED_DESCRIPTION,
+                                                                parent_id: parent_id })
+    end
+
+    # ----------------------------------------------------> cases <-----------------------------------------------------
+    def find_or_create_case(title, section, depth)
+      self.find_case(title, section, depth) || self.create_case(title, section['id'])
+    end
+
+    def find_case(title, section, depth)
+      suite = self.get_suite(section['suite_id'])
+      test_cases = @client.send_get("get_cases/#{suite['project_id']}&suite_id=#{suite['id']}")
+      test_cases.find do |test_case|
+        test_case['title'] == title && test_case['section_id'] == section['id']
+      end
+    end
+
+    def create_case(title, section_id)
+      @client.send_post("add_case/#{section_id}", { title: title })
+    end
+
+    # ----------------------------------------------------> runs <------------------------------------------------------
+    def create_run(suite)
+      @client.send_post("add_run/#{suite['project_id']}", { suite_id: suite['id'], name: "#{nice_time_now} - #{suite['name']}", description: 'describe it somehow'})
+    end
+
+    def add_results_for_cases(run_id, results)
+      @client.send_post("add_results_for_cases/#{run_id}", { results: results })
+    end
+
+    private
+
+    def nice_time_now
+      Time.now.strftime('%d %b %Y %R:%S %Z')
+    end
+
+  end
+
+  class APIClient
+    @url = ''
+    @user = ''
+    @password = ''
+
+    attr_accessor :user
+    attr_accessor :password
+
+    def initialize(base_url)
+      if !base_url.match(/\/$/)
+        base_url += '/'
+      end
+      @url = base_url + 'index.php?/api/v2/'
+    end
+
+    #
+    # Send Get
+    #
+    # Issues a GET request (read) against the API and returns the result
+    # (as Ruby hash).
+    #
+    # Arguments:
+    #
+    # uri                 The API method to call including parameters
+    #                     (e.g. get_case/1)
+    #
+    def send_get(uri)
+      _send_request('GET', uri, nil)
+    end
+
+    #
+    # Send POST
+    #
+    # Issues a POST request (write) against the API and returns the result
+    # (as Ruby hash).
+    #
+    # Arguments:
+    #
+    # uri                 The API method to call including parameters
+    #                     (e.g. add_case/1)
+    # data                The data to submit as part of the request (as
+    #                     Ruby hash, strings must be UTF-8 encoded)
+    #
+    def send_post(uri, data)
+      _send_request('POST', uri, data)
+    end
+
+    private
+    def _send_request(method, uri, data)
+      url = URI.parse(@url + uri)
+      if method == 'POST'
+        request = Net::HTTP::Post.new(url.path + '?' + url.query)
+        request.body = JSON.dump(data)
+      else
+        request = Net::HTTP::Get.new(url.path + '?' + url.query)
+      end
+      request.basic_auth(@user, @password)
+      request.add_field('Content-Type', 'application/json')
+
+      conn = Net::HTTP.new(url.host, url.port)
+      if url.scheme == 'https'
+        conn.use_ssl = true
+        conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      response = conn.request(request)
+
+      if response.body && !response.body.empty?
+        begin
+          result = JSON.parse(response.body)
+        rescue JSON::ParserError => e
+          raise APIError.new "TestRail API request (#{request.method} #{url}) failed\n#{e.class}: #{e.message}"
+        end
+      else
+        result = {}
+      end
+
+      if response.code != '200'
+        if result && result.key?('error')
+          error = '"' + result['error'] + '"'
+        else
+          error = 'No additional error message received'
+        end
+        raise APIError.new "TestRail API returned HTTP #{response.code} (#{error})"
+      end
+
+      result
+    end
+  end
+
+  class APIError < StandardError
+  end
+end

data/lib/testrail_rspec/version.rb

@@ -0,0 +1,3 @@
+module TestrailRspec
+  VERSION = "0.0.1"
+end

data/lib/testrail_rspec.rb

@@ -0,0 +1,182 @@
+require 'rspec'
+require 'rspec/core/formatters/base_text_formatter'
+
+require 'rubytree'
+
+require "testrail_rspec/version"
+require "testrail_rspec/client"
+
+module TestrailRspec
+
+  RSpec.configuration.add_setting :testrail_formatter_options, :default => {}
+
+  class Exporter < RSpec::Core::Formatters::BaseTextFormatter
+    RSpec::Core::Formatters.register self, :start, :close, :dump_summary
+    #                                  # :example_started, :example_passed,
+    #                                  # :example_pending,  :example_failed,
+    #                                  :dump_failures, :dump_pending
+    #                                  # :start_dump
+
+
+    # TODO: after exporter is done and working remove unnecessary overriden methods
+
+    def initialize(output)
+      @options = {}
+      @project_id = nil
+      super(output)
+    end
+
+    # To start
+    def start(notification)
+      @options = RSpec.configuration.testrail_formatter_options
+      @client = TestrailRspec::Client.new(@options)
+      @client.get_projects.each { |project| @project_id = project['id'] if project['name'] == @options[:project] }
+
+      puts "TestRail Exporter [INFO] Executing #{notification.count} tests. Loaded in #{notification.load_time}"
+
+      super
+    end
+
+    # Once per example group <-----------------------------------------------------------------------------
+    # def example_group_started(notification)
+    #   groups = []
+    #   current_group = notification.group
+    #   until current_group.top_level?
+    #     groups << current_group
+    #     current_group = current_group.parent if current_group.parent_groups.size > 1
+    #   end
+    #
+    #   groups << current_group
+    #
+    #   unless groups[0].examples.empty?
+    #     groups.reverse.each_with_index do |group, idx|
+    #       puts (idx == 0 ? "Spec: " : "") + (' ' *2 * idx) + "#{group.description}"
+    #     end
+    #     puts (' ' *2 * groups.size) + groups[0].examples.map(&:description).join("\n" + (' ' *2 * groups.size))
+    #   end
+    #
+    #   super
+    # end
+
+    # Once per example <-----------------------------------------------------------------------------------
+    # def example_started(notification)
+    #   puts " - case: #{notification.example.description}"
+    # end
+
+    # One of these per example <---------------------------------------------------------------------------
+    # def example_passed(passed)
+    #   puts "\tpass: #{passed.example.description}"
+    # end
+
+    # def example_failed(failure)
+    #   puts "\tfail: #{failure.example.description}"
+    # end
+    #
+    # def example_pending(pending)
+    #   puts "\tpend: #{pending.example.description}"
+    # end
+
+    # Optionally at any time <------------------------------------------------------------------------------
+    # def message(notification)
+    #   puts "msg notification: #{notification.inspect}"
+    #   super
+    # end
+
+    # At the end of the suite <-----------------------------------------------------------------------------
+    # def stop(notification)
+    #   puts "stop notification: #{notification.inspect}"
+    # end
+
+    # def start_dump(null_notification)
+    #   puts "start_dump notification: #{null_notification.inspect}"
+    # end
+    #
+    def dump_pending(notification)
+      # puts "dump pend notification: #{notification.inspect}"
+      # super
+    end
+
+    def dump_failures(notification)
+      # puts "dump fail notification: #{notification.inspect}"
+      # super
+    end
+
+    def dump_summary(notification)
+      # Create project if it is not present / could do it setting controlled
+      if @project_id.nil?
+        puts "TestRail Exporter [INFO] Creating project: #{@options[:project]}"
+        @project_id = @client.add_project(@options[:project])['id']
+      end
+
+      suites = Hash.new do |h,k|
+        h[k] = Tree::TreeNode.new(k, @client.find_or_create_suite(k, @project_id) )
+      end
+
+
+      notification.examples.each do |example|
+        build_hierarchy_tree!(suites, example)
+      end
+
+      suites.each { |_, suite| update_test_run(suite) }
+
+      super
+    end
+
+    def close(null_notification)
+      # TODO: could close any open connection
+      puts "TestRail Exporter [INFO] Closing..."
+      super
+    end
+
+    private
+
+    def get_path_for(node)
+      asc_arr = node.is_a?(RSpec::Core::Example) ? [node.description] : []
+      parent = (node.respond_to? :parent) ? node.parent : node.example_group
+      asc_arr << parent.description
+      asc_arr.push(*get_path_for(parent)) unless parent.top_level?
+      node.is_a?(RSpec::Core::Example) ? asc_arr.reverse : asc_arr
+    end
+
+    def build_hierarchy_tree!(suites, example)
+      path = get_path_for(example)
+
+      parent_node = suite_node = suites[path.shift]
+      path.unshift('Direct cases') unless path.size > 1
+
+      path.each_with_index do |item, idx|
+        child_node = (parent_node.children.map(&:name).include? item) ? parent_node[item] : nil
+        if child_node and (idx + 1 == path.size)
+          puts "TestRail Exporter [INFO] Second case with same path and name detected:\n\t#{suite_node.content['name']} -> #{path.join(' -> ')}"
+        end
+
+        unless child_node
+          child_node = if idx + 1 == path.size
+                         Tree::TreeNode.new(item, { case: @client.find_or_create_case(item, parent_node.content, idx), result: example })
+                       else
+                         Tree::TreeNode.new(item, @client.find_or_create_section(item, suite_node.content, parent_node.content, idx))
+                       end
+          parent_node << child_node
+        end
+        parent_node = child_node
+      end
+
+    end
+
+    def update_test_run(suite)
+      run_id = @client.create_run(suite.content)['id']
+      results = suite.each_leaf.map do |test|
+        test_result = test.content[:result].execution_result
+        run_time_seconds = test_result.run_time.round(0)
+        {
+            case_id:    test.content[:case]['id'],
+            status_id:  TestrailRspec::STATUS[test_result.status],
+            elapsed:    (run_time_seconds == 0) ? nil : "#{run_time_seconds}s"
+        }
+      end
+      @client.add_results_for_cases(run_id, results)
+    end
+
+
+  end
+end

data/testrail_rspec.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'testrail_rspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "testrail_rspec"
+  spec.version       = TestrailRspec::VERSION
+  spec.authors       = ["Michal Kubik"]
+  spec.email         = ["michal.kubik@boost.no"]
+  spec.summary       = %q{RSpec exporter formatter - pushes test run results to TestRail instance.}
+  spec.description   = %q{Allow exporting RSpect test run results into TestRail server.}
+  spec.homepage      = "https://github.com/mkubik8080/testrail-rspec"
+  spec.license       = "MIT"
+
+  spec.add_runtime_dependency "rubytree", "~> 0.9.4"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,96 @@
+--- !ruby/object:Gem::Specification
+name: testrail_rspec
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Michal Kubik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rubytree
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.9.4
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Allow exporting RSpect test run results into TestRail server.
+email:
+- michal.kubik@boost.no
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/testrail_rspec.rb
+- lib/testrail_rspec/client.rb
+- lib/testrail_rspec/version.rb
+- testrail_rspec.gemspec
+homepage: https://github.com/mkubik8080/testrail-rspec
+licenses:
+- MIT
+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.4.2
+signing_key: 
+specification_version: 4
+summary: RSpec exporter formatter - pushes test run results to TestRail instance.
+test_files: []
+has_rdoc: