kankankan 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1c932b1a6f900e710bddda3e662a1fabe9007b8
+  data.tar.gz: 8d2276de6bd71a180ebc556a81a89c8c23ccca7c
+SHA512:
+  metadata.gz: e8db96269c05349ab9593217db4e7837840a57563031db6b35c7205d1979af71e50ff8f427d218b9226a29fa1cfa745c8ab57e6587b626aa2a370d2b70cfffb1
+  data.tar.gz: 6fddc0dfe5f75f549c4557d5b9719e4d4494d56d6e253656e043349eb447460ed1ad3354d3f3664b55b6ef503756fd0d274d9d9ffb0be427cc9a03eae216d21d

data/lib/kankankan.rb

@@ -0,0 +1,299 @@
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+module Kankankan
+
+  # GET/POST client
+  class APIClient
+    @url = ''
+    @user = ''
+    @password = ''
+
+    attr_accessor :user
+    attr_accessor :password
+
+    def initialize(base_url)
+      base_url += '/' unless base_url.match(/\/$/)
+      @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
+        fail APIError.new('TestRail API returned HTTP %s (%s)' %
+          [response.code, error])
+      end
+
+      result
+    end
+  end
+
+  class APIError < StandardError
+  end
+
+  class Project
+    attr_accessor :test_plan_id
+    attr_accessor :test_suite_id
+
+    def initialize(project_id, user, password, base_url = nil)
+      @project_id = project_id
+      @client = APIClient.new(base_url.nil? ? 'https://testrail.com':base_url)
+      @client.user = user
+      @client.password = password
+      @project_info = @client.send_get("get_project/#{@project_id}")
+
+      @test_plan_id = ENV['TEST_PLAN_ID'] if ENV.key?('TEST_PLAN_ID')
+      @test_run_name = 'Debug Run'
+      use_test_run_name(ENV['RUN_NAME']) if ENV.key?('RUN_NAME')
+      use_test_run_id(ENV['RUN_ID']) if ENV.key?('RUN_ID')
+    end
+
+    def testsuites
+      @test_suites = @client.send_get("get_suites/#{@project_id}") unless @test_suites
+    end
+
+    def use_test_run_id(test_run_id)
+      @test_run_name = ''
+      @test_run_id = test_run_id
+    end
+
+    def use_test_run_name(test_run_name)
+      @test_run_name = test_run_name
+      @test_run_id = ''
+    end
+
+    def dump
+      puts @project_info
+    end
+
+    def _get_test_run_entry_id(test_plan_id)
+      runs = []
+      test_run_entry_id = nil
+
+      if @project_info['suite_mode'].to_i == 1
+        runs = @client.send_get("get_runs/#{@project_id}")
+      else
+        if @test_plan_id
+          @test_plan = @client.send_get("get_plan/#{test_plan_id}")
+
+          @test_plan['entries'].each do |entry|
+            runs += entry['runs']
+          end
+        end
+      end
+      runs.each do |run|
+        if @test_run_name && @test_run_name != ''
+          next unless run['name'].eql?(@test_run_name)
+          test_run_entry_id = run['entry_id']
+          break
+        else
+          next unless run['id'].to_s.eql?(@test_run_id)
+          test_run_entry_id = run['entry_id']
+          break
+        end
+      end
+
+      test_run_entry_id
+    end
+
+    def _get_test_run_id(test_plan_id)
+      runs = []
+      test_run_id = nil
+
+      if @project_info['suite_mode'].to_i == 1
+        runs = @client.send_get("get_runs/#{@project_id}")
+      else
+        if @test_plan_id
+          @test_plan = @client.send_get("get_plan/#{test_plan_id}")
+
+          @test_plan['entries'].each do |entry|
+            runs += entry['runs']
+          end
+        end
+      end
+
+      runs.each do |run|
+        if @test_run_name && @test_run_name != ''
+          next unless run['name'].eql?(@test_run_name)
+          test_run_id = run['id']
+          break
+        else
+          next unless run['id'].to_s.eql?(@test_run_id)
+          test_run_id = run['id']
+          break
+        end
+      end
+
+      test_run_id
+    end
+
+    def _get_test_run_id_from_name(_test_run_name)
+      runs = []
+      test_run_id = nil
+
+      if @project_info['suite_mode'].to_i == 1
+        runs = @client.send_get("get_runs/#{@project_id}")
+      else
+        if @test_plan_id
+          @test_plan = @client.send_get("get_plan/#{test_plan_id}")
+
+          @test_plan['entries'].each do |entry|
+            runs += entry['runs']
+          end
+        end
+      end
+
+      runs.each do |run|
+        next unless run['name'].eql?(@test_run_name)
+        test_run_id = run['id']
+        break
+      end
+
+      test_run_id
+    end
+
+    def _test_run_id_exists?(test_run_id, test_plan_id = nil)
+      if test_run_id.nil? || test_run_id.empty?
+        if test_plan_id.nil?
+          return true if _get_test_run_id_from_name(@test_run_name)
+        end
+
+        return false
+      end
+
+      if @project_info['suite_mode'].to_i == 1 || test_plan_id.nil?
+        run = @client.send_get("get_run/#{test_run_id}")
+        return !run.nil?
+      else
+        return !_get_test_run_entry_id(test_plan_id).nil?
+      end
+    end
+
+    def _prepare_test_run(test_run_id, case_id)
+      existing_test_run_id = _test_run_id_exists?(test_run_id)
+
+      if existing_test_run_id
+        test_run_id = _get_test_run_id(@test_plan_id)
+      end
+
+      if @project_info['suite_mode'].to_i == 1
+        new_run = @client.send_post("add_run/#{@project_id}", name: @test_run_name, include_all: false) unless existing_test_run_id
+      else
+        if @test_plan_id
+          run_entry_id = _get_test_run_entry_id(@test_plan_id)
+
+          unless run_entry_id
+            newPlanEntry = @client.send_post("add_plan_entry/#{@test_plan_id}",
+                                             suite_id: @test_suite_id,
+                                             include_all: false,
+                                             name: @test_run_name,
+                                             case_ids:case_id.to_s.split(',').map(&:to_i)
+            )
+            new_run = newPlanEntry['runs'][0]
+            run_entry_id = newPlanEntry['id']
+          end
+
+        else
+          new_run = @client.send_post("add_run/#{@project_id}", name: @test_run_name, include_all: false) unless existing_test_run_id
+        end
+      end
+      new_run = @client.send_get("get_run/#{test_run_id}") unless new_run
+
+      # extract all tests in the run
+      allTestsForRun = @client.send_get("get_tests/#{new_run['id']}")
+      included_tests = []
+      included_tests << case_id.to_i # append our new case
+      allTestsForRun.each do |testInRun|
+        included_tests << testInRun['case_id'].to_i
+      end
+
+      if @test_plan_id
+        @client.send_post("update_plan_entry/#{@test_plan_id}/#{run_entry_id}",
+                          include_all: false, case_ids: included_tests
+                          )
+      else
+        @client.send_post("update_run/#{new_run['id']}", case_ids: included_tests)
+      end
+
+      new_run
+    end
+
+    def add_result(case_id, ok, comment)
+      if case_id.to_i
+        test_run = _prepare_test_run(@test_run_id, case_id)
+        # puts test_run
+        # puts "case id #{case_id}"
+        # send the result to TestRail
+        @client.send_post("add_result_for_case/#{test_run['id']}/#{case_id}",
+                          status_id: ok ? 1 : 5,
+                          comment: comment
+                         )
+      else
+        puts 'Skipping testrail update due to empty case_id'
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,43 @@
+--- !ruby/object:Gem::Specification
+name: kankankan
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Akhmad Fathonih
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-06 00:00:00.000000000 Z
+dependencies: []
+description: A Wrapper for simple testrail result synchronization
+email: akhmad.fathonih@rakuten.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/kankankan.rb
+homepage: 
+licenses: []
+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.1
+signing_key: 
+specification_version: 4
+summary: Testrail result push!
+test_files: []