testrail-rspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 9e16041a770eed00286369886e6109acccab1ead3a44cfdb1078cd1605920368
+  data.tar.gz: 1f0d38bcce60ef9c7e092db496cd37873824073465baeba07759df968f01904a
+SHA512:
+  metadata.gz: 7deaa1684832970b626fc5622dcb69950ae6d219cf169897ccba4e2486edf3d6eb5761507e0eec54d3d227158cf7110b207a26bab1e60466688eeaf56995cd67
+  data.tar.gz: df634941c512d418c3c07a8fa20b38386a3fe048c0645552a2a3aa476435cfad93221b30cd33f67c6615e8baf6b9dfb6500be0f28b95a5ce057ec13f9166d07c

data/lib/testrail-rspec/api-client.rb

@@ -0,0 +1,106 @@
+#
+# 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.
+#
+
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+module TestRail
+  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?
+        result = JSON.parse(response.body)
+      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 %s (%s)' %
+                               [response.code, error])
+      end
+
+      result
+    end
+  end
+
+  class APIError < StandardError
+  end
+end

data/lib/testrail-rspec/update-testrails.rb

@@ -0,0 +1,72 @@
+require_relative 'api-client'
+
+module TestrailRSpec
+  class UpdateTestRails
+    attr_accessor :client
+
+    def initialize(scenario)
+      @scenario = scenario
+
+      if File.exist? './testrail_config.yml'
+        @config = YAML.load_file("./testrail_config.yml")['testrail']
+        raise 'TestRail configuration file not loaded successfully' if @config.nil?
+      else
+        raise 'TestRail configuration file is required'
+      end
+
+      setup_testrail_client
+    end
+
+    def upload_result
+
+      response = {}
+      case_id = @scenario.metadata[:description].split(' ').first.scan(/\d+/).first rescue nil
+
+      status_id = get_status_id 'passed'.to_sym if @scenario.exception == nil
+      status_id = get_status_id 'failed'.to_sym if @scenario.exception != nil
+      run_id = @config['run_id']
+
+      if case_id && run_id
+        response = client.send_post(
+            "add_result_for_case/#{run_id}/#{case_id}",
+            { status_id: status_id }
+        )
+      else
+        raise 'unable to get case id or run id'
+      end
+
+      response
+    end
+
+    def fetch_status_ids
+      client.send_get('get_statuses')
+    end
+
+    private
+
+    def setup_testrail_client
+      @client = TestRail::APIClient.new(@config['url'])
+      @client.user = @config['user']
+      @client.password = @config['password']
+    end
+
+    def get_status_id(status)
+      case status
+      when :passed
+        1
+      when :blocked
+        2
+      when :untested
+        3
+      when :retest
+        4
+      when :failed
+        5
+      when :undefined
+        raise 'missing step definition'
+      else
+        raise 'unexpected scenario status passed'
+      end
+    end
+  end
+end

data/lib/testrail-rspec/version.rb

@@ -0,0 +1,3 @@
+module TestrailRspec
+  VERSION = '0.1.0'.freeze
+end

data/lib/testrail-rspec.rb

@@ -0,0 +1,3 @@
+require 'testrail-rspec/api-client'
+require 'testrail-rspec/update-testrails'
+require 'testrail-rspec/version'

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: testrail-rspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Prashanth Sams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-23 00:00:00.000000000 Z
+dependencies: []
+description: 
+email:
+- sams.prashanth@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/testrail-rspec.rb
+- lib/testrail-rspec/api-client.rb
+- lib/testrail-rspec/update-testrails.rb
+- lib/testrail-rspec/version.rb
+homepage: 
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://www.rubydoc.info/github/prashanth-sams/testrail-rspec/master
+  source_code_uri: https://github.com/prashanth-sams/testrail-rspec
+  bug_tracker_uri: https://github.com/prashanth-sams/testrail-rspec/issues
+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: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Sync Rspec test results with your testrail suite
+test_files: []