itriagetestrail 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ca184602865faed2cddddc923bbf3cba340a7c03
+  data.tar.gz: 7424622d43d58c797c2caae9bfb32a1b11c2937a
+SHA512:
+  metadata.gz: 97d4a13b3e89e9325c6c80ecfe0822d463db4d4830f7b64ecc45e0f2a7b7f5c0206ab5169f21e7df2880d991ed9878a01f0cfa1aeb2358f648175c5318f0f0da
+  data.tar.gz: bce81ab788adc8bf1b78a5c3d2b10d355e17e40023242c7cb7e70f9951257957c1371161ab93b79a8cc824db106e44f8e97ac39807d484aea3b9b8719e3c2d69

data/lib/itriagetestrail.rb

@@ -0,0 +1,235 @@
+require "itriagetestrail/version"
+require_relative "itriagetestrail/testrail_binding"
+require_relative "itriagetestrail/pool"
+#require 'testrail-rails'
+
+
+module Itriagetestrail
+  class TestRailInterface
+    # code goes here...
+    attr_accessor :client
+    attr_accessor :sections
+    attr_accessor :test_cases
+    attr_accessor :test_case_ids
+    attr_accessor :run_id
+    attr_accessor :execute
+    attr_reader :results
+    attr_reader :external_results
+    attr_accessor :pool
+    attr_accessor :batch_size
+
+    def initialize(execute, testrail_config)
+      @run_id = 0
+      @setup = false
+      @testrail_config = testrail_config
+      @project_id = @testrail_config.project_id
+      @execute = execute
+    end
+
+    def setup?
+      @setup
+    end
+
+    def setup
+      return false if setup?
+
+      @results = { results: [] }
+      @submitted = { results: [] }
+
+      @external_results = { results: [] }
+      @batch_size = @testrail_config.batch_size
+
+      make_connection
+
+      # Get the test rail sections
+      testrail_sections
+
+      # Get the test rail ids
+      testrail_ids
+
+      add_testrail_run
+
+      @pool = Pool.new(1)
+
+      @setup = true
+    end
+
+    def make_connection
+      @client = TestRail::APIClient.new(@testrail_config.site)
+      @client.user = @testrail_config.user
+      @client.password = @testrail_config.password
+    end
+
+    # TestRail Sections
+    def testrail_sections
+      @sections = @client.send_get("get_sections/#{@project_id}")
+    end
+
+    def testrail_section_id(section_title)
+      res = -1
+      @sections.each { | section |
+
+        if section['name'] == section_title
+          res = section['id']
+        end
+      }
+      res
+    end
+
+    def add_testrail_section(section_title)
+      body = {
+          :name => section_title
+      }
+
+      res = @client.send_post("add_section/#{@project_id}", body)
+
+      testrail_section = res['id']
+
+      #re-establish sections
+      testrail_sections
+
+      testrail_section
+    end
+
+    # TestRail Cases
+    def testrail_ids
+
+      @test_cases = @client.send_get("get_cases/#{@project_id}&type_id=3")
+
+      @test_case_ids = []
+
+      @test_cases.each { |test_case| @test_case_ids <<  test_case['id']}
+    end
+
+    def testrail_test_case_id(external_id)
+
+      res = -1
+      @test_cases.each { | test_case |
+
+        if test_case['custom_external_case_id'] == external_id
+          res = test_case['id']
+        end
+      }
+      res
+    end
+
+    def associate_result(external_id)
+
+      test_case_id = testrail_test_case_id(external_id)
+      #store the test case id with the local result
+      @results[:results].each { |result|
+
+        if result['external_id'] == external_id
+          @external_results['results'] << {case_id: test_case_id, status_id: result['status_id'], comment: result['comment']}
+        end
+      }
+    end
+
+    # add the test case if it doesn't exist
+    def add_testrail_test_case(scenario_title, external_id, scenario_steps, section_id)
+      body = {
+          :title => scenario_title,
+          :custom_external_case_id => external_id,
+          :custom_steps => scenario_steps,
+          :type_id => 3
+      }
+
+      @client.send_post("add_case/#{section_id}", body)
+
+      #refresh test case ids
+      testrail_ids
+    end
+
+    # open a test run to submit test results
+    def add_testrail_run
+
+      if @testrail_config.include_all? then
+
+        body = {
+            :name => "POC Regression on #{Time.now}",
+            :include_all => true
+        }
+      else
+
+        body = {
+            :name => "POC Regression on #{Time.now}",
+            :include_all => false,
+            :case_ids => @test_case_ids
+        }
+      end
+
+      res = @client.send_post("add_run/#{@project_id}", body)
+
+      @run_id = res['id']
+    end
+
+    def send_results_to_testrail
+      if @results[:results].size != 0
+
+        # copy what is in the results
+        @submitted[:results] << @results[:results]
+
+        send = {:results => @results[:results]}
+        @pool.schedule do
+          #make sure tests are part of current run
+          @client.send_post("add_results_for_cases/#{@run_id}", send)
+        end
+
+        @results[:results] = @results[:results] - send[:results]
+      end
+    end
+
+    def update_test_suite(scenario_title, external_id, scenario_steps)
+
+      # establish variables
+      #@external_id = result['external_id']
+
+      feature = external_id.split(';')[0]
+
+      section_id = testrail_section_id(feature)
+
+      #if the testrail section does not exist, update sections
+      if section_id == -1
+
+        section_id = add_testrail_section(feature)
+      end
+
+      #if the testrail case does not exist, update cases
+      if testrail_test_case_id(external_id) == -1
+
+        #@scenario_title = result['scenario_title']
+
+        add_testrail_test_case(scenario_title, external_id, scenario_steps, section_id)
+        sleep 1
+      end
+
+      #store the case id associated with the external_id
+      associate_result(external_id)
+    end
+
+
+    def store_result(scenario_title, external_id, scenario_steps, status_id, comment)
+
+      update_test_suite scenario_title, external_id, scenario_steps
+
+      case_id = testrail_test_case_id(external_id)
+
+      @results[:results] << {case_id: case_id, scenario_title: scenario_title, external_id: external_id, scenario_steps: scenario_steps, status_id: status_id, comment: comment }
+
+      if @results[:results].size >= @batch_size
+
+        send_results_to_testrail
+
+      end
+    end
+
+    def shutdown
+      @pool.shutdown
+
+      if @testrail_config.close_run?
+        @client.send_post("close_run/#{@run_id}", {})
+      end
+    end
+
+  end
+end

data/lib/itriagetestrail/pool.rb

@@ -0,0 +1,35 @@
+require 'thread'
+
+class Pool
+
+  def initialize(size)
+
+    @size = size
+    @jobs = Queue.new
+
+    @pool = Array.new(@size) do |i|
+      Thread.new do
+        Thread.current[:id] = i
+
+        catch(:exit) do
+          loop do
+            job, args = @jobs.pop
+            job.call(*args)
+          end
+        end
+      end
+    end
+  end
+
+  def schedule(*args, &block)
+    @jobs << [block, args]
+  end
+
+  def shutdown
+    @size.times do
+      schedule { throw :exit }
+    end
+
+    @pool.map(&:join)
+  end
+end

data/lib/itriagetestrail/testrail_binding.rb

@@ -0,0 +1,116 @@
+#
+# 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 make_connection(url)
+      conn = Net::HTTP.new(url.host, url.port)
+      if url.scheme == 'https'
+        conn.use_ssl = true
+        conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      conn
+    end
+
+    def parse_json(response)
+      if response.body && !response.body.empty?
+        result = JSON.parse(response.body)
+      else
+        result = {}
+      end
+      result
+    end
+
+    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 = make_connection(url)
+
+      response = conn.request(request)
+
+      result = parse_json(response)
+
+      if response.code != '200'
+        if result && result.key?('error')
+          error = '"' + result['error'] + '"'
+        else
+          error = 'No additional error message received'
+        end
+
+        raise APIError, "TestRail API returned HTTP #{response.code} #{error}"
+      end
+      result
+    end
+  end
+
+  class APIError < StandardError
+  end
+end

data/lib/itriagetestrail/version.rb

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

metadata

@@ -0,0 +1,88 @@
+--- !ruby/object:Gem::Specification
+name: itriagetestrail
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- a801069
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-09-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Plugin to export your cucumber tests in the Testrail
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/itriagetestrail.rb
+- lib/itriagetestrail/testrail_binding.rb
+- lib/itriagetestrail/pool.rb
+- lib/itriagetestrail/version.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
+signing_key: 
+specification_version: 4
+summary: Plugin to export your cucumber tests in the Testrail
+test_files: []