test_rail_integration 0.0.5

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dbe2e2f64eac4da64edc9db1cb1297f08ab945b3
+  data.tar.gz: 84c6d54289552e5a24eb1c2949ae74708f29e9af
+SHA512:
+  metadata.gz: e71eb44a406958b6d1befba998283015771d66db35c2da60f22a04a7d38393455980820cb3325b0b9bc868e07f8ab113ad147aeb19b13437b056923d8b028d22
+  data.tar.gz: 60ddd527aa433f40126ad646efb721bf9e4ade577540bb12864fa2d9d57c4715804df08b6d11cc19466c058ff48fe950f98641202580359d74c7f6408d8d4605

data/.gitignore

@@ -0,0 +1 @@
+.idea/*

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+gem 'thor'
+gem 'fileutils'

data/Gemfile.lock

@@ -0,0 +1,14 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    fileutils (0.7)
+      rmagick (>= 2.13.1)
+    rmagick (2.13.4)
+    thor (0.19.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fileutils
+  thor

data/LICENSE.txt

@@ -0,0 +1,21 @@
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,34 @@
+# TestRailIntegration
+
+This game made for interaction between TestRail and Ruby automation framework Cucumber+Watir
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'test_rail_integration'
+gem 'thor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install test_rail_integration
+
+## Usage
+
+After installation type "test_rail_interaction perform". This command generate executable file run_test_run.rb. You should run this file with parameter - number on test run in TestRail
+Fill all data in test_rail_data.yml. Next time run_test_run.rb <run_number> will generate cucumber executable file.
+For perform this actions in Jenkins just create Execute shell "ruby run_test_run.rb $Testrun_id ; ./cucumber_run.sh;" where $Testrun_id its string parameter for parameterized builds.
+Add TestRail::Hook.update_test_rail(scenario) into after hook.
+## Contributing
+
+1. Fork it ( https://github.com/kirikami/test_rail_integration/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/bin/test_rail_integration

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'test_rail_integration/cli'
+TestRailIntegration::CLI.start

data/lib/test_rail_integration/cli.rb

@@ -0,0 +1,12 @@
+require 'thor'
+require_relative 'generator/project'
+
+module TestRailIntegration
+  class CLI < Thor
+    desc "perform", "Creates project for interaction with TestRail"
+
+    def perform
+      TestRailIntegration::TestTail::Generators::Project.copy_file('run_test_run.rb')
+    end
+  end
+end

data/lib/test_rail_integration/generator/API_client.rb

@@ -0,0 +1,107 @@
+#
+# 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
+#
+
+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(connection_data)
+      base_url = connection_data[:url]
+      unless base_url.match(/\/$/)
+        base_url += '/'
+      end
+      @url      = base_url + 'index.php?/api/v2/'
+      @user     = connection_data[:username]
+      @password = connection_data[:password]
+    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/test_rail_integration/generator/connection.rb

@@ -0,0 +1,103 @@
+require_relative 'API_client'
+require_relative 'test_case_result'
+require_relative 'test_rail_tools'
+
+module TestRail
+  class Connection
+
+    ASSIGNED_TO     ||= TestRailTools.test_rail_data[:assigned_to]
+    TEST_SUITE      ||= TestRailTools.test_rail_data[:test_suite]
+    CONNECTION_DATA ||= TestRailTools.test_rail_data[:connection_data]
+    PROJECT_ID      ||= TestRailTools.test_rail_data[:project]
+    TEST_RUN_ID     ||= TestRailTools.test_rail_data[:test_run_id]
+    IN_PROGRESS     ||= TestRailTools.test_rail_data[:in_progress]
+    NO_TEST_RAIL    ||= 0
+
+    #
+    # Creates connection to TestRail server
+    #
+    # client = TestRail::APIClient.new('<TestRail server>',"<User email>","<User password>")
+    #
+    def self.client
+      @client_test_rail ||= TestRail::APIClient.new(CONNECTION_DATA)
+    end
+
+    #
+    # Send test result to TestRail for current test run
+    # client.send_post("add_result_for_case/<number_of test run>/<test case id>", <result that pushes>)
+    #
+    # client.send_post("add_result_for_case/12/3131", status_id: '1', comment: "Test passed" )
+    #
+    def self.commit_test_result(test_case_result)
+      client.send_post("add_result_for_case/#{TEST_RUN_ID}/#{test_case_result.test_case_id}", test_case_result.to_test_rail_api)
+    end
+
+    #
+    # Obtaining of all previous test results for current test case
+    #
+    # client.send_get("get_results_for_case/12/3534")
+    #
+    def self.get_test_result(case_id)
+      client.send_get("get_results_for_case/#{test_run_id}/#{case_id}")
+    end
+
+    #
+    # Parse results and returns Failed if this test was marked as failed.
+    #
+    def self.get_previous_test_result(case_id)
+      test_results = get_test_result(case_id).map { |status_hash| status_hash["status_id"] }
+      status       = TestCaseResult::FAILED if test_results.include?(TestCaseResult::FAILED)
+      status       ||= TestCaseResult::PASS if test_results.first == TestCaseResult::PASS
+      status       ||= TestCaseResult::NEW
+      status
+    end
+
+    #
+    # Get ID of all test cases from current test run
+    #
+    # cases = client.send_get("get_tests/12")
+    #
+    def self.cases_id(test_run_id)
+      cases = client.send_get("get_tests/#{test_run_id}")
+      cases.map { |test_case| test_case["case_id"] }
+    end
+
+    #
+    # Setting up test run id
+    #
+    def self.test_run_id=(test_run_id)
+      @test_run_id = test_run_id
+    end
+
+    #
+    # Getting test run id value
+    #
+    def self.test_run_id
+      @test_run_id ||= TEST_RUN_ID
+    end
+
+    #
+    # Getting information about test run
+    #
+    def self.test_run_data
+      client.send_get("get_run/#{test_run_id}")
+    end
+
+    #
+    # Get test run name
+    #
+    def self.test_run_name
+      test_run_data["name"]
+    end
+
+    #
+    # Changing name of test run from <test run name> in progress to <test run name>
+    #
+    # VN LIVE_TEST in progress => VN LIVE_TEST
+    #
+    def self.change_test_run_name
+      new_name = test_run_name.gsub(IN_PROGRESS, "")
+      client.send_post("update_run/#{test_run_id}", { name: new_name })
+    end
+  end
+end

data/lib/test_rail_integration/generator/project/run_test_run.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+require 'test_rail_integration'
+require 'thor'
+require 'test_rail_integration/generator/API_client'
+require 'test_rail_integration/generator/connection'
+require 'test_rail_integration/generator/test_rail_tools'
+
+module TestRail
+  unless TestRailIntegration::TestTail::Generators::Project.test_rail_data_file_exist?
+    TestRailIntegration::TestTail::Generators::Project.copy_file("test_rail_data.yml")
+    raise "Please fill all required data in test rail data yml file"
+  end
+  id_of_run = ARGV.shift
+  TestRailTools.prepare_config(id_of_run)
+end
+

data/lib/test_rail_integration/generator/project/test_rail_data.yml

@@ -0,0 +1,25 @@
+:connection_data:
+  :url: #put here url of your TestRail server
+  :username: #TestRail username
+  :password: #Password for TestRail user
+
+:project: # Test project id can be found in Test Rail
+:test_suite: # Test suite id can be found in Test Rail
+:assigned_to: # Id of person could be found in Test Rail
+:description_of_run: "Automatically generated report by auto tests."
+
+:status_comment: 0
+:test_pass: 1
+:need_to_retest: 4
+:test_failed: 5
+:new_test: 0
+
+:test_passed_comment: "test **passed**"
+:test_failed_comment: "test **failed**"
+
+:ventures: #values for generating parametrized url for running test
+:environments: #values for generating parametrized url for running test
+
+:in_progress: " (in progress)" #value for changing test run name for monitoring complete of test run
+
+:test_run_id: 0 #parametrized test run from "ruby run_test_run.rb <testrun number>"

data/lib/test_rail_integration/generator/project.rb

@@ -0,0 +1,33 @@
+require 'fileutils'
+require 'thor/group'
+
+module TestRailIntegration
+  module TestTail
+    module Generators
+      class Project < Thor::Group
+        include Thor::Actions
+
+        desc "Generates files that contains information about TestRail"
+
+        def self.source_root
+          File.dirname(__FILE__)
+        end
+
+        def self.test_rail_data_file_exist?
+          File.exists?("config/data/test_rail_data.yml")
+        end
+
+        def self.copy_file(file_name, root = nil)
+          if file_name == "test_rail_data.yml"
+            FileUtils.mkdir("config/data")
+          end
+          if root
+            FileUtils.cp("#{source_root}/project/#{file_name}", "#{root}/#{file_name}")
+          else
+            FileUtils.cp("#{source_root}/project/#{file_name}", "#{file_name}")
+          end
+        end
+      end
+    end
+  end
+end

data/lib/test_rail_integration/generator/test_case_result.rb

@@ -0,0 +1,36 @@
+require_relative 'test_rail_tools'
+
+module TestRail
+  class TestCaseResult
+
+    attr_accessor :test_case_id, :title, :comment, :exception_message
+
+    COMMENT_STATUS ||= TestRail::TestRailTools.test_rail_data[:status_comment]
+    PASS           ||= TestRail::TestRailTools.test_rail_data[:test_pass]
+    FAILED         ||= TestRail::TestRailTools.test_rail_data[:test_failed]
+    NEW            ||= TestRail::TestRailTools.test_rail_data[:new_test]
+    PASS_COMMENT   ||= TestRail::TestRailTools.test_rail_data[:test_passed_comment]
+    FAILED_COMMENT ||= TestRail::TestRailTools.test_rail_data[:test_failed_comment]
+
+    COMMENT ||= { :pass           => { status: PASS, comment: PASS_COMMENT },
+                  :fail           => { status: FAILED, comment: FAILED_COMMENT },
+                  :unchanged_pass => { status: COMMENT_STATUS, comment: PASS_COMMENT }
+    }
+
+    def initialize(test_case_id, title)
+      self.test_case_id = test_case_id
+      self.title        = title
+    end
+
+    def to_test_rail_api
+      comment_message = "\"#{self.title}\" #{self.comment[:comment]}"
+      comment_message += "\n Exception : #{self.exception_message}" unless self.exception_message.nil?
+      if  self.comment[:status] == COMMENT_STATUS
+        { comment: comment_message }
+      else
+        { status_id: self.comment[:status], comment: comment_message }
+      end
+    end
+
+  end
+end

data/lib/test_rail_integration/generator/test_rail_hooks.rb

@@ -0,0 +1,45 @@
+require 'test_rail_integration/generator/connection'
+
+module TestRail
+  class Hook
+
+    TEST_RAIL_ID_REGEX ||= /^@C\d+/
+
+
+    def self.update_test_rail(scenario)
+      test_case_id = scenario.source_tag_names.find { |e| e.match(TEST_RAIL_ID_REGEX) }[2..-1]
+
+      prev_result              = TestRail::Connection.get_previous_test_result(test_case_id)
+      both_run_result          = scenario.passed? || RunInformation.second_run_result == 0
+      test_case_result         = TestRail::TestCaseResult.new(test_case_id, scenario.title)
+
+      test_case_result.comment = TestRail::TestCaseResult::COMMENT[:pass] if passed_result?(both_run_result, prev_result)
+      test_case_result.comment ||= TestRail::TestCaseResult::COMMENT[:unchanged_pass] if unchanged_pass_result?(both_run_result, prev_result)
+
+      if failed_result?(both_run_result)
+        test_case_result.comment ||= TestRail::TestCaseResult::COMMENT[:fail]
+        test_case_result.exception_message = scenario.steps.exception rescue nil
+      end
+
+      raise("Invalide test case result : scenario.passed? #{scenario.passed?}, both_run_result? #{both_run_result}  prev_result? #{prev_result}") if test_case_result.comment.nil?
+
+      TestRail::Connection.commit_test_result(test_case_result)
+    end
+
+    def self.failed_result?(result)
+      !result
+    end
+
+    def self.passed_result?(result, prev_result)
+      result && prev_result != TestRail::TestCaseResult::FAILED
+    end
+
+    def self.unchanged_pass_result?(result, prev_result)
+      result && prev_result == TestRail::TestCaseResult::FAILED
+    end
+
+    at_exit do
+      TestRail::Connection.change_test_run_name
+    end
+  end
+end

data/lib/test_rail_integration/generator/test_rail_tools.rb

@@ -0,0 +1,38 @@
+require 'yaml'
+require_relative 'connection'
+require_relative 'test_run_parameters'
+
+module TestRail
+  class TestRailTools
+
+    CONFIG_PATH ||= ('config/data/test_rail_data.yml')
+
+    def self.test_rail_data
+      YAML.load(File.open(CONFIG_PATH))
+    end
+
+    def self.generate_cucumber_execution_file(id_of_run)
+      parameters    = TestRunParameters.new
+      command       = "cucumber -p lazada.#{parameters.venture}.#{parameters.environment} TESTRAIL=1 --color -f json -o cucumber.json -t  " + Connection.cases_id(id_of_run).map { |id| "@C"+id.to_s }.join(",")
+      cucumber_file = File.new("cucumber_run.sh", "w")
+      cucumber_file.chmod(0700)
+      cucumber_file.write("#!/bin/sh\n")
+      cucumber_file.write(command)
+      cucumber_file.close
+    end
+
+    def self.write_test_run_id(test_run_id)
+      testrail_data_file = File.read(CONFIG_PATH).gsub(/^:test_run_id: \d+/, ":test_run_id: #{test_run_id}")
+      config_file        = File.open(CONFIG_PATH, "w")
+      config_file.write (testrail_data_file)
+      config_file.close
+    end
+
+    def self.prepare_config(run_id)
+      Connection.test_run_id = run_id
+      write_test_run_id(run_id)
+      generate_cucumber_execution_file(run_id)
+    end
+  end
+end
+

data/lib/test_rail_integration/generator/test_run_parameters.rb

@@ -0,0 +1,20 @@
+require_relative 'API_client'
+
+module TestRail
+  class TestRunParameters
+    VENTURE_REGEX     ||= /vn|id|ph|my|sg|th/
+    ENVIRONMENT_REGEX ||= /live_test|staging|showroom/
+
+    attr_accessor :environment, :venture
+
+    def initialize
+      parameters = Connection.test_run_name.downcase.match(/^(#{VENTURE_REGEX}) (#{ENVIRONMENT_REGEX})*/)
+      begin
+        @venture     = parameters[1]
+        @environment = parameters[2]
+      rescue Exception
+        raise ("The test run name is not valid. Format: 'venture env description'")
+      end
+    end
+  end
+end

data/lib/test_rail_integration/version.rb

@@ -0,0 +1,3 @@
+module TestRailIntegration
+  VERSION = "0.0.5"
+end

data/lib/test_rail_integration.rb

@@ -0,0 +1,2 @@
+require 'test_rail_integration/cli'
+require 'test_rail_integration/version'

data/test_rail_integration.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'test_rail_integration/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "test_rail_integration"
+  spec.version       = TestRailIntegration::VERSION
+  spec.authors       = ["Kirikami"]
+  spec.email         = ["naumenko.ruslan@outlook.com"]
+  spec.summary       = %q{Gem for integration between framework and TestRail API}
+  spec.description   = %q{Setups status of tests into TestRail after each scenario}
+  spec.homepage      = "https://github.com/Kirikami/test_rail_integration"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "thor", "~> 0.17"
+  spec.add_development_dependency "fileutils", "~> 0.7"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: test_rail_integration
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Kirikami
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-12-26 00:00:00.000000000 Z
+dependencies:
+- !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'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.17'
+- !ruby/object:Gem::Dependency
+  name: fileutils
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+description: Setups status of tests into TestRail after each scenario
+email:
+- naumenko.ruslan@outlook.com
+executables:
+- test_rail_integration
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/test_rail_integration
+- lib/test_rail_integration.rb
+- lib/test_rail_integration/cli.rb
+- lib/test_rail_integration/generator/API_client.rb
+- lib/test_rail_integration/generator/connection.rb
+- lib/test_rail_integration/generator/project.rb
+- lib/test_rail_integration/generator/project/run_test_run.rb
+- lib/test_rail_integration/generator/project/test_rail_data.yml
+- lib/test_rail_integration/generator/test_case_result.rb
+- lib/test_rail_integration/generator/test_rail_hooks.rb
+- lib/test_rail_integration/generator/test_rail_tools.rb
+- lib/test_rail_integration/generator/test_run_parameters.rb
+- lib/test_rail_integration/version.rb
+- test_rail_integration.gemspec
+homepage: https://github.com/Kirikami/test_rail_integration
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Gem for integration between framework and TestRail API
+test_files: []