tagrail 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 39edd848f1d75d598d9adba6d167740ce89f25e4
+  data.tar.gz: fcefa7a55c19a9c34d55643dd896183a951f39ee
+SHA512:
+  metadata.gz: 02ed3697fc939a4a511877eaea72b079b5fbd6d2a9016738d51102ee35dae1bc1501005a09727aa6e3e327c9b5403fcff2798c1a32bbe01bc6448789326edc2d
+  data.tar.gz: 2534b83ed4a3ed2ed7ac6e0d35e7caf7229048b03a140ff13383e786c09c6f1d53aac703f187f359acadf63eb3d7bf677524c49a5cd04e466fbdc667142c6604

data/lib/tagrail.rb

@@ -0,0 +1,56 @@
+require 'rspec'
+require 'rspec/core/formatters/base_text_formatter'
+require_relative './tagrail/client'
+
+RSpec.configuration.add_setting :testrail_formatter_options, :default => {}
+
+class Tagrail < RSpec::Core::Formatters::BaseTextFormatter
+
+  RSpec::Core::Formatters.register self, :start, :close, :dump_summary
+
+  def initialize(output)
+    @options = {}
+    super(output)
+  end
+
+  def start(notification)
+    @run_name = start_timestamp
+
+    puts "TestRail Exporter [INFO] Executing #{notification.count} tests. Loaded in #{notification.load_time}"
+
+    super
+  end
+
+  def dump_summary(notification)
+    @options = RSpec.configuration.testrail_formatter_options
+    @client = Testrail::Client.new(@options)
+    @run = @client.add_run(@options[:project_id], @options[:suite_id], @run_name)
+
+    notification.examples.each do |example|
+      case_id = example.metadata[:test_id]
+
+      result = { status_id: Testrail::STATUS[example.execution_result.status] }
+      exception =  example.execution_result.exception
+
+      #if a test returns an exception, the exception will be included
+      #as a result comment in testrail
+      if !exception.nil?
+        result.merge!({ comment: "Error: #{exception} #{exception.backtrace.join('\n')}"})
+      end
+
+      @client.add_result_for_case(@run['id'], case_id, result)
+    end
+    super
+  end
+
+  def close(null_notification)
+    puts "TestRail Exporter [INFO] Closing..."
+    super
+  end
+
+  private
+
+  def start_timestamp
+    Time.at((Time.now.to_i.to_s[0..7] + "00").to_i).strftime('%d %b %Y %R %Z')
+  end
+end

data/lib/tagrail/client.rb

@@ -0,0 +1,119 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+module Testrail
+
+  STATUS = {
+      passed: 1,
+      failed: 5,
+      skipped: 7,
+      pending: 6
+  }
+
+  class Client
+
+    def initialize(args)
+      @projects = nil
+      @sections = Hash.new
+      @suite   = Hash.new
+      @suites   = []
+
+      @client = APIClient.new args[:url]
+      %w(user password project_id).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
+
+    def add_run(project_id, suite_id, run_name)
+      @client.send_post("add_run/#{project_id}", { suite_id: suite_id,
+                                                   name: run_name })
+    end
+
+    #cases
+    def get_case(case_id)
+      @client.send_get("get_case/#{case_id}")
+    end
+
+    #results
+    def add_result_for_case(run_id, case_id, result)
+      @client.send_post("add_result_for_case/#{run_id}/#{case_id}", result)
+    end
+
+    #projects
+    def get_project(project_id)
+      @client.send_get("get_project/#{project_id}")
+    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
+
+    def send_get(uri)
+      _send_request('GET', uri, nil)
+    end
+
+    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

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: tagrail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Caleb Guanzon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-03-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !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: Another RSpec formatter for Testrail
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/tagrail.rb
+- lib/tagrail/client.rb
+homepage: https://github.com/cguanzon/tagrail
+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.0.14
+signing_key: 
+specification_version: 4
+summary: Put Test Id's in tags an go
+test_files: []
+has_rdoc: