trail_marker 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 6fa914ab38fc9f73fade971a9e1e17dc73e33ef783d5e3f9af270ba3286f3c55
+  data.tar.gz: 08400303f17caa576dd2b1407270d0b6f35e7ac732adfdbf63a8b6cb5b3dce99
+SHA512:
+  metadata.gz: 1794d8f73ad47fd2b3e0bc018e543648e55fe2c0b8b7a15205d89430320cf4ca9903e3b6df1488c326885e05c2e593aa0062031e542b2d6eedb82edcca2aa110
+  data.tar.gz: 538c4eeaa7ea4a96bb14db0cb70a8abaf39634dd42d6dd58144e9ddbef0c47e7fbee426896eaf0dceb1bf0406041cc61179670ca2fdb7ab5d2a51dcecea51719

data/README.md

@@ -0,0 +1,71 @@
+# Rspec to TestRail Gem
+
+TestRail (http://www.gurock.com/testrail/) is one of the best test case management software available. It has available APIs which can be used to mark your automated test results. If you label your RSPEC tests with TestRail testcase numbers, then you can automatically mark the test results via API calls.
+
+![Instructions](/workflow.jpg)
+
+This gem installs a command line tool that parses through all your RSPEC XML results file or Squish results file and marks all the test cases (Passed, Failed, ...) via API calls. This is a very useful tool to mark your test cases after running your automation tests using RSpec or Squish tests. 
+
+## Installation
+
+Install it yourself as:
+
+    $ gem install trail_marker
+
+##Usage
+
+To Use:
+
+  $ testrail_marker.rb -p Test Project Name -r test_run_auto -x ../some/directory/results
+
+
+Arguments required:
+
+-p Name of Project
+
+-r or -t, Name of test run or test plan to mark
+
+-x Directory path where XML test results are located
+
+
+For RSPEC files: 
+   Tag all the tests with the correct test case
+   
+   Ex:
+   
+      it “should login to Server as a regular user (TestRail: C27)” do
+      => This would mark TestRail cases number 27
+      
+      it “should logout of server (TestRail: C11, C12 )” do
+      => This would mark two test cases, number 11 and 12, at the same time
+
+For SquishReport (Not sure how this is formatted - please edit):
+   Tag all verification name with the correct test case
+   
+   Ex (results XML should be):
+   
+      <verification line="114" type="" name=“Transfer (TestRail: C76, C92) " file="C:/ancd/aaa/suite_connections/tst_clone/test.rb">
+         <result type="PASS" time="2015-07-06T11:20:58-07:00">
+             <description>Comparison</description>
+         </result>
+      </verification>
+
+NOTE: You can associate multiple Test Cases to a single automated test if needed by separating each test case number by a comma (TestRail: C111, C222, …)
+
+<b>Other Options</b>
+
+    -h, Show HELP
+    -p *, name of project (e.g. Production Push) (required parameter) 
+    -r or -t *, name of test run (-r) or test plan (-t) (required parameter) 
+    -m, milestone name (can be used when creating a test run)
+    -s, test suite name (* required when creating a test run)
+    -u, user (e.g. ibarra@gmail.com)
+    -pw, password or token (recommended)
+    -url, URL of TestRail (e.g. https://test.mycompany.com/testrail)
+    -d, debug mode (set to false to suppresses most messages)
+    -x or -f *, path (-x, Directory) or specific file (-f) for results to parse 
+    -com, comment to put on each test
+    
+    '-cm', '-cr', '-ct'  => Creates milestones, runs, or test plan
+    '-dm', '-dr', '-dt' => Deletes milestones, runs, test plan
+    

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "testrail_marker"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/testrail_marker.rb

@@ -0,0 +1,44 @@
+##################################################################################
+#  TestRail is a test case/suite management tool. It has available API in order for 
+#  automated tests to mark cases as passed or failed.
+#  This tool can be used via command line or called inside your script.
+#  
+#  unix$ testrail_marker -h
+#
+#
+# HISTORY: 4/11/2016 Created - ibarra.alfonso@gmail.com
+#          2/19/2018 Packaged as executable ruby GEM
+#
+#
+# TODO: Add option to overwrite config file
+#
+require 'testrail_marker'
+#require_relative '../lib/trail_marker'
+
+#require_relative 'argument'
+#require_relative 'response'
+#require_relative 'request'
+#require_relative 'api_testrail'
+#require_relative 'results_parser'
+
+# Test Token = Epf.32h4wbdzBzZwoJZc-qOOoSfYHbWtVfaj2S5IN
+
+############################  MAIN  ############################### 
+
+full_config_path = File.expand_path(File.dirname(__FILE__)) + '/' + 'trail_config.yml'
+argument = Argument.new(ARGV)
+
+if argument.has_argument?('-cf')
+  cf = ConfigFile.new(full_config_path)
+  cf.create_configfile
+  exit(0)
+else
+  mark_tests = MarkTests.new(argument, full_config_path)
+  mark_tests.setup
+  mark_tests.check_create
+  mark_tests.markoff_all_results
+  mark_tests.show_exit_msg
+end
+
+
+

data/exe/testrail_marker

@@ -0,0 +1,45 @@
+##################################################################################
+#  TestRail is a test case/suite management tool. It has available API in order for 
+#  automated tests to mark cases as passed or failed.
+#  This tool can be used via command line or called inside your script.
+#  
+#  unix$ testrail_marker -h
+#
+#
+# HISTORY: 4/11/2016 Created - ibarra.alfonso@gmail.com
+#          2/19/2018 Packaged as executable ruby GEM
+#
+#
+# TODO: Add option to overwrite config file
+#
+require 'trail_marker'
+#require_relative '../lib/trail_marker'
+
+#require_relative 'argument'
+#require_relative 'response'
+#require_relative 'request'
+#require_relative 'api_testrail'
+#require_relative 'results_parser'
+
+# Test Token = Epf.32h4wbdzBzZwoJZc-qOOoSfYHbWtVfaj2S5IN
+
+############################  MAIN  ############################### 
+
+full_config_path = File.expand_path(File.dirname(__FILE__)) + '/' + 'trail_config.yml'
+argument = Argument.new(ARGV)
+
+puts "ConfigFile: #{full_config_path}"
+if argument.has_argument?('-cf')
+  cf = ConfigFile.new(full_config_path)
+  cf.create_configfile
+  exit(0)
+else
+  mark_tests = MarkTests.new(argument, full_config_path)
+  mark_tests.setup
+  mark_tests.check_create
+  mark_tests.markoff_all_results
+  mark_tests.show_exit_msg
+end
+
+
+

data/lib/trail_marker/api_testrail.rb

@@ -0,0 +1,364 @@
+# TODO: CLEAN UP or DRY testruns and testplans methods since can be combined.
+#       Refactor attr_accessor variables to be class variables
+#       Implement other API calls
+#  
+class ApiTestRail
+  attr_accessor :project_id, :suite_id, :run_id, :test_case_id, :section_id
+
+  def initialize(client)
+    @client = client
+    @projects = get_projects()
+    @project = nil
+    @suites = nil
+    @suite = nil
+    @plans = nil
+    @plan = nil
+    @runs = nil
+    @run = nil
+    @test_cases = nil
+    @test_case = nil
+    @milestones = nil
+    @milestone = nil
+    @statuses = get_statuses()
+  end
+  
+  # Returns the project ID of the project name passed.
+  # 
+  def get_project_id(project_name)
+    if @projects.nil?
+      get_projects()
+    end
+    project_id = search_array_kv(@projects, 'name', project_name, 'id')
+    if project_id.nil?
+      puts "\nProject '#{project_name}' WAS NOT FOUND, select from available projects."
+      resp_projects = Response.new(@projects)
+      project_name = resp_projects.picker("name")
+      project_id = search_array_kv(@projects, 'name', project_name, 'id')
+    end
+    return project_id
+  end
+  
+  def get_milestone_id(project_id, milestone_name)
+    ms_id = nil
+    if ! milestone_exists?(project_id, milestone_name)
+      puts "\nMilestone '#{milestone_name}' WAS NOT FOUND, select from available milestones."
+      resp_ms = Response.new(@milestones)
+      milestone_name = resp_ms.picker("name")
+      #ms_id = search_array_kv(@milestones, 'name', milestone_name, 'id')
+    end
+    ms_id = search_array_kv(@milestones, 'name', milestone_name, 'id')
+    return ms_id
+  end
+  
+  def get_test_runplan_id(project_id, runplan_name)
+    if @runs.nil?
+      get_runs(project_id)
+    end
+    run_id = search_array_kv(@runs, 'name', runplan_name, 'id')
+    if run_id.nil?
+      puts "\nTest Run WAS NOT FOUND, select from available."
+      resp_runs = Response.new(@runs)
+      runplan_name = resp_runs.picker("name")
+      run_id = search_array_kv(@runs, 'name', runplan_name, 'id')
+    end
+    return run_id
+  end
+  
+  def get_testplan_id(project_id, testplan_name)
+    if @plans.nil?
+      get_plans(project_id)
+    end
+    plan_id = search_array_kv(@plans, 'name', testplan_name, 'id')
+    if plan_id.nil?
+      puts "\nTestPlan #{testplan_name} WAS NOT FOUND, select from available."
+      resp_plans = Response.new(@plans)
+      plan_name = resp_plans.picker("name")
+      plan_id = search_array_kv(@plans, 'name', plan_name, 'id')
+    end
+    return plan_id
+  end
+  
+  def get_suite_id(proj_id, suite_name)
+    suite_id = nil
+    if suite_exists?(proj_id, suite_name)
+      suite_id = search_array_kv(@suites, 'name', suite_name, 'id')
+    end
+    return suite_id
+  end
+  
+  def get_projects()
+    @projects = request_get('get_projects')
+    return @projects
+  end
+  
+  def get_milestones(proj_id)
+    ms_req = "get_milestones/" + proj_id.to_s
+    @milestones = request_get(ms_req)
+  end
+  
+  def get_runs(proj_id)
+    runs_req = "get_runs/" + proj_id.to_s
+    @runs = request_get(runs_req)
+  end
+  
+  def get_plans(proj_id)
+    plans_req = "get_plans/" + proj_id.to_s
+    @plans = request_get(plans_req)
+  end
+  
+  def get_plan(plan_id)
+    plan_req = "get_plan/" + plan_id.to_s
+    @plan = request_get(plan_req)
+  end
+  
+  def get_suites(proj_id)
+    suite_req = "get_suites/" + proj_id.to_s
+    @suites = request_get(suite_req)
+  end
+  
+  ######################## VERIFY 
+  
+  def milestone_exists?(project_id, milestone_name)
+    it_exists = false
+    if @milestones.nil?
+      get_milestones(project_id)
+    end
+    puts "ALL MILES: #{@milestones}"
+    ms_id = search_array_kv(@milestones, 'name', milestone_name, 'id')
+    if ! ms_id.nil?
+      it_exists = true
+    end
+    return it_exists
+  end
+  
+  def run_exists?(proj_id, run_name)
+    it_exists = false
+    if @runs.nil? 
+      @runs = get_runs(proj_id)
+    end
+    run_id = search_array_kv(@runs, 'name', run_name, 'id')
+    if ! run_id.nil?
+      it_exists = true
+    end
+    return it_exists
+  end
+  
+  def suite_exists?(proj_id, suite_name)
+    it_exists = false
+    if @suites.nil? 
+      @suites = get_suites(proj_id)
+    end
+    suite_id = search_array_kv(@suites, 'name', suite_name, 'id')
+    if ! suite_id.nil?
+      it_exists = true
+    end
+    return it_exists
+  end
+  
+  #############
+  
+  # Makes an API call to get all possible results status. Currently has 5
+  # passed, blocked, untested, retest, failed. 
+  # Puts the name and status in @statuses array.
+  #
+  def get_statuses()
+    @statuses = []
+    status_req = request_get('get_statuses')
+    status_req.each do |status|
+      status_hash  ={}
+      status_hash['id'] = status['id']
+      status_hash['name'] = status['name']
+      @statuses.push(status_hash)
+    end
+    return @statuses
+  end
+  
+  
+  
+  ######################## TEST PLANS #########################
+  
+  # Returns an array of testrun IDs that is inside a testplan.
+  #
+  def get_testplan_testruns(testplan_id)
+    run_ids = []
+    plan_resp = get_plan(testplan_id)
+    tp_entries = plan_resp['entries']
+    tp_entries.each do |entry|
+      entry_runs = entry['runs']
+      entry_runs.each do |erun|
+        run_ids.push(erun['id'])
+      end
+    end
+    return run_ids
+  end
+  
+  # Returns array of id for testruns inside a testplan
+  def get_testplan_run_ids(project_id, testplan_name)
+    testplan_id = get_testplan_id(project_id, testplan_name)
+    get_testplan_testruns(testplan_id)
+  end
+  
+  # NOTE - NOT USED RIGHT NOW.
+  # Marks a test case inside a testplan. Testplans adds extra API calls
+  # because testruns are inside the testplans and are not named.
+  # See note below MARK_TESTPLAN
+  def markoff_testplan(case_id, testplan_id, pass_status)
+    status_id = search_array_kv(@statuses, 'name', 'failed', 'id')
+    defect_txt = ""
+    if pass_status
+      status_id = search_array_kv(@statuses, 'name', 'passed', 'id')
+      defect_txt = ""
+    end
+    equiv_json = {:status_id => status_id, :comment => 'Auto marker.', :defects => defect_txt}
+    add_result_req = "add_result_for_case/" + run_id.to_s + "/" + case_id.to_s
+    request_post(add_result_req, equiv_json)
+  end
+  
+  def get_testid(run_id, case_id)
+    puts "SEARCH FOR TESTID: #{run_id}  :: #{case_id}"
+    tests_req = 'get_tests/' + run_id.to_s
+    tests_resp = request_get(tests_req)
+    puts "GET_TESTS: #{tests_resp}"
+    id_equiv = search_array_kv(tests_resp, 'case_id', case_id.to_i, 'id')
+    return id_equiv
+  end
+
+  
+  
+  # TODO: Parse XML for failed reason and add to comment(?)
+  #
+  def markoff_test(case_id, run_id, pass_status, comment_txt)
+    status_id = search_array_kv(@statuses, 'name', 'failed', 'id')
+    defect_txt = ""
+    if pass_status
+      status_id = search_array_kv(@statuses, 'name', 'passed', 'id')
+      defect_txt = ""
+    end
+    equiv_json = {:status_id => status_id, :comment => comment_txt, :defects => defect_txt}
+    add_result_req = "add_result_for_case/" + run_id.to_s + "/" + case_id.to_s
+    request_post(add_result_req, equiv_json)
+  end
+  
+  # Makes a post call to create a new milestone
+  def create_milestone(proj_name, msname)
+    proj_id = get_project_id(proj_name)
+    if ! milestone_exists?(proj_id, msname)
+      puts "Create Milestones #{msname} in Project #{proj_name} "
+      unix_timestamp = Time.now.to_i 
+      req_field = {:name => msname, :due_on => unix_timestamp}
+      create_milestone_req = "add_milestone/" + proj_id.to_s
+      request_post(create_milestone_req, req_field)
+      sleep(2)
+      get_milestones(proj_id)
+    end
+  end
+  
+  def delete_milestone(proj_name, msname)
+    proj_id = get_project_id(proj_name)
+    ms_id = get_milestone_id(proj_id, msname)
+    del_ms_req = "delete_milestone/" + ms_id.to_s
+    request_post(del_ms_req, nil)
+    exit
+  end
+  
+  def create_testrun(proj_name, msname, trname, tsname)
+    proj_id = get_project_id(proj_name)
+    if ! run_exists?(proj_id, trname)
+      if suite_exists?(proj_id, tsname)
+        ms_id = nil
+        if ! msname.nil? && msname != ""
+          ms_id = get_milestone_id(proj_id, msname)
+        end
+        puts "MSID: #{msname} #{ms_id}"
+        ts_id = get_suite_id(proj_id, tsname)
+        req_field = {:name => trname, :suite_id => ts_id, :description => "AutoCreated"}
+        if ! ms_id.nil? && ms_id != ""
+          req_field[:milestone_id] = ms_id
+        end
+        add_run_req = "add_run/" + proj_id.to_s
+        request_post(add_run_req, req_field)
+        puts "CREATING RUN under #{proj_name} #{req_field}"
+        sleep(2)
+        get_runs(proj_id)
+      else
+        puts "CANNOT Create New TestRun, (-s) test suite name needed."
+      end
+    else
+      puts "CANNOT Create RUN #{trname}, already exists."
+    end
+  end
+  
+  private 
+  
+  def request_get(api_cmd)
+    req = Request.new(@client)
+    resp = req.exec_get(api_cmd)
+    return resp
+  end
+  
+  def request_post(api_cmd, data)
+    req = Request.new(@client)
+    resp = req.exec_post(api_cmd, data)
+    return resp
+  end
+  
+  # Searched an array of hashes for a key and value to match
+  # and returns a field of that hash.
+  # * *Args*  : 
+  #   - +rdata+ -> Array of hash data (e.g)
+  #   - +k+ -> key (e.g. "name")
+  #   - +v+ -> value to find (e.g. "Test Project")
+  #   - +key_return+ -> name of another field to return (e.g. "id")
+  # * *Returns* : 
+  #   - Value of a field in the hash
+  #   - nil if none found
+  #
+  # Example: rdata: [{'id' => 12, 'name' => 'Project-Files, 'owner' => 'Serban', 'run_name' => 'Sprint 2'}, 
+  #                  {'id' => 22, 'name' => 'Faspex, 'owner' => 'Ajanta', 'run_name' => 'Marathon 10'}]
+  #  
+  #          search_array_kv(rdata, "name", "Faspex", "owner")
+  #          => Calling this find the hash that has 'Faspex' for name, 
+  #             then return the value of 'owner' in that hash 'Ajanta'
+  #
+  def search_array_kv(rdata, k, v, key_return)
+    retval = nil
+    fnd = rdata.detect {|unhash| unhash[k] == v}
+    if ! fnd.nil?
+      retval = fnd[key_return]
+    end
+    return retval
+  end
+  
+   
+  # NOTE: MARK_TEST_PLAN
+  # User Input: Project Name, TestRun Name
+  # Project Name > Get project_id
+  # Call API get_plans/project_id to get all test plans for the project
+  # Get testplan_id of testplan with the given name
+  # Call API get_plan/testplan_id to get testruns inside this testplan
+  # 
+  
+  
+  
+  
+  
+  ############### DELETE THESE NOT USED
+  
+  # TODO: Parse XML for failed reason and add to comment(?)
+  #
+  # def markoff_test(case_id, run_id, pass_status)
+    # status_id = search_array_kv(@statuses, 'name', 'failed', 'id')
+    # defect_txt = ""
+    # if pass_status
+      # status_id = search_array_kv(@statuses, 'name', 'passed', 'id')
+      # defect_txt = ""
+    # end
+    # equiv_json = {:status_id => status_id, :comment => 'Auto marker.', :defects => defect_txt}
+    # add_result_req = "add_result_for_case/" + run_id.to_s + "/" + case_id.to_s
+    # request_post(add_result_req, equiv_json)
+  # end
+#   
+  
+ 
+  
+end