testrail-cucumber 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f29e6ee50c2a1ad6a978c52c71420fba172318a5bd6fbfd82dab674cf382366e
+  data.tar.gz: 8789d7cb2f4fbc3e495010ffc129b4e99c9e8f083cfcc46ad9818978da8d4576
+SHA512:
+  metadata.gz: fd98efad13e1c5ccc3d66e5ba7373b2b3a3f94a2638310980c1e6a3821bf440004af3efb54ca3a065a3668153d9ae8308de4a3128d85bbe2c3121f0594ed0a37
+  data.tar.gz: 8adef21d64cca34f66c61f7ffb6353636ea70519711bc96b29740584454c12692f5b128284d2a4f2eda083939cb9e48a353afb73bd0cd0f8ba4f629c474faf05

data/lib/testrail-cucumber.rb

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

data/lib/testrail-cucumber/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-cucumber/update-testrails.rb

@@ -0,0 +1,70 @@
+require_relative 'api-client'
+
+module TestrailCucumber
+    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.name.split(' ').first.scan(/\d+/).first rescue nil
+            status_id = get_status_id @scenario.status
+            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-cucumber/version.rb

@@ -0,0 +1,3 @@
+module TestrailCucumber
+    VERSION = '0.1.3'.freeze
+end

metadata

@@ -0,0 +1,47 @@
+--- !ruby/object:Gem::Specification
+name: testrail-cucumber
+version: !ruby/object:Gem::Version
+  version: 0.1.3
+platform: ruby
+authors:
+- Prashanth Sams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-04-23 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/testrail-cucumber.rb
+- lib/testrail-cucumber/api-client.rb
+- lib/testrail-cucumber/update-testrails.rb
+- lib/testrail-cucumber/version.rb
+homepage: 
+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.7.8
+signing_key: 
+specification_version: 4
+summary: Sync Automation results with your testrail suite
+test_files: []