trail_marker 0.1.1

data/lib/trail_marker/api_testrail_rev2.bak

@@ -0,0 +1,350 @@
+require_relative "response"
+
+# TODO: CLEAN UP or DRY testruns and testplans methods since can be combined. 
+#      Implement other API calls
+#  
+class ApiTestRail
+  attr_accessor :project_id
+  attr_accessor :suite_id
+  attr_accessor :run_id
+  attr_accessor :test_case_id
+  attr_accessor :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(milestone_name)
+    ms_id = nil
+    if ! milestone_exists?(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(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(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?(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(testplan_name)
+    testplan_id = get_testplan_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?(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(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(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
+  # 
+  
+
+  
+end

data/lib/trail_marker/argument.rb

@@ -0,0 +1,229 @@
+
+# Parses command line argument.
+# Avoids requiring a dependent gem, easy to add any parameters and tags
+# To Add New Parameter:
+#   => Add new tag in @valid_parameters
+#   => Change HELP message to describe new parameter added
+# 
+class Argument
+  
+  USAGE = "Usage: \n  testrail_marker -r run_plan_name -p project_name -x /home/path_to/results_xml/dir \n"
+  HELP = "    -h, Show HELP
+    -p *, name of project (e.g. TestRail API Gem) (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@apitestrail.com)
+    -pw, password or token (recommended)
+    -url, URL of TestRail (e.g. https://yourcompany.testrail.io)
+    -cf, create a configuration file
+    -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
+   
+    
+    NOTES: Results must have TestRail test case numbers to match. See README file for
+           more details.
+           Create options are available by adding \'c\' to some arguments, ex. -cr would create a new test run."
+    
+  REQUIRED = "\nMissing required parameter/s (until config file implemented):
+    Ex: testrail_marker -p TestRail API Gem -r Regression Suite -x ./results/path
+    -p, name of project (e.g. -p TestRail API Gem)
+    -r or -t, name of test run or test plan (e.g. -r Regression Suite)
+    -x or -f, path (Directory) or a specific file of results to parse (e.g. -f /home/path/results/rspec_results.xml)\n"
+  
+  # Constructor. Requires passing the parameters from the command line argument.
+  #
+  def initialize(passed_arguments)
+    @arg_passed = passed_arguments
+    @valid_parameters = ['-p', '-m', '-r', '-h', '-u', '-pw', '-url', '-d', '-x', '-t', '-s', '-com', '-f']
+    @create_parameters = ['-cm', '-cr', '-ct']
+    @delete_parameters = ['-dm', '-dr', '-dt']
+    @runner_parameters = ['-cf']
+    @valid_parameters += @create_parameters
+    @valid_parameters += @delete_parameters
+    @valid_parameters += @runner_parameters
+    @required_parameters = ['-p']
+    @requires_atleast_one = ['-r', '-t', '-cr', '-ct']
+    @requires_only_one = ['-x', '-f']
+    
+    check_help(passed_arguments)
+    initialize_holder()
+    parse_args(passed_arguments)
+    check_required_parameters(passed_arguments)
+    print_arguments
+  end
+  
+  def print_arguments()
+    puts "\nPassed Arguments:"
+    @holder.each do |hold|
+      if hold[:value] != ""
+        puts "  #{hold[:tag]} #{hold[:value]}"
+      end
+    end
+  end
+  
+  def parse_args(arguments)
+    par_index = []
+    puts "ARG: #{arguments}"
+    @valid_parameters.each do |tag|
+      arg_index = arguments.index(tag).nil? ? -1 : arguments.index(tag)
+      par_index.push(arg_index)
+    end
+    @valid_parameters.each_with_index do |tag, x|
+      tag_index = par_index[x]
+      end_index = get_next_highest(tag_index, par_index)
+      save_arg_to_holder(arguments, tag_index, end_index)
+    end
+  end
+  
+  # Returns the argument parameter passed with the specified tag
+  #
+  def get_arg_value(tag)
+    tag_value = nil
+    if @valid_parameters.include?(tag)
+      tag_hash = @holder.detect{|tag_data| tag_data[:tag] == tag}
+      tag_value = tag_hash[:value]
+    else
+      puts "ERROR: Parameter #{tag} not recognized."
+    end
+    return tag_value
+  end
+  
+  def get_optional_arg(tag_arr)
+    tag_value = nil
+    tag_arr.each do |tag|
+      if @valid_parameters.include?(tag)
+        tag_hash = @holder.detect{|tag_data| tag_data[:tag] == tag}
+        tag_value = tag_hash[:value]
+      else
+        puts "ERROR: Parameter #{tag} not recognized."
+      end
+      if tag_value == ""
+        tag_value = nil
+      end
+      if ! tag_value.nil?
+        break
+      end
+    end
+    return tag_value
+  end
+  
+  def arg_exists?(tag)
+    it_exists = false
+    tagv = get_arg_value(tag)
+    if ! tagv.nil? && tagv != ""
+      it_exists = true
+    end
+    return it_exists
+  end
+
+  def has_argument?(tag)
+    if @arg_passed.include?(tag)
+      return true
+    end
+    return false
+  end
+  
+  private
+  
+  # Creates an array to hold values of possible parameter tags.
+  #
+  def initialize_holder()
+    @holder = []
+    @valid_parameters.each do |tag|
+      param_hash = {:tag => tag, :value => ""}
+      @holder.push(param_hash)
+    end
+  end
+  
+  # Returns the next highest value in the array
+  # If num is the highest, then returns 100
+  def get_next_highest(num, array_num)
+    retval = nil
+    if ! num.nil? && num != -1
+      arr_size = array_num.size
+      sorted_nums = array_num.sort
+      num_index = sorted_nums.index(num)
+      if num_index == arr_size - 1
+        retval = 100
+      else
+        retval = sorted_nums[num_index + 1]
+      end
+    end
+    return retval
+  end
+  
+  def save_arg_to_holder(arguments, startx, endx)
+    if startx >= 0
+      which_tag = arguments[startx]
+      tag_hash = @holder.detect{|tag_data| tag_data[:tag] == which_tag}
+      tag_hash[:value] = arguments[startx+1..endx-1].join(" ")
+    end
+  end
+  
+  def check_help(arguments)
+    if arguments.include?('-h')
+      puts "#{USAGE}"
+      puts "#{HELP} \n\n"
+      exit(0)
+    end
+  end
+  
+  private
+  
+  # Verifies that all required parameters are passed in the argument.
+  # Two types of required. First, parameters that are absolutely needed.
+  # Second, parameters that are not all required but at least one must
+  # be passed. 
+  # Exits the script if parameter requirements are not satisfied.
+  #
+  def check_required_parameters(arguments)
+    params_good = true
+
+    @runner_parameters.each do |run_par|
+      if arguments.include?(run_par)
+        return true
+      end
+    end
+    @required_parameters.each do |req_par|
+      passed_reqpar = get_arg_value(req_par)
+      if passed_reqpar.nil? || passed_reqpar == ''
+        params_good = false
+      end
+    end
+    
+    has_atleast_one = true
+    if @requires_atleast_one.size > 0
+      has_atleast_one = false
+      @requires_atleast_one.each do |least_one|
+        luno = get_arg_value(least_one)
+        if ! luno.nil? && luno != ""
+          has_atleast_one = true
+        end
+      end
+    end
+    
+    has_only_one = true
+    if @requires_only_one.size > 0
+      has_only_one = false
+      num_detected = 0
+      @requires_only_one.each do |only_one|
+        if arg_exists?(only_one)
+          num_detected += 1
+        end
+      end
+      if num_detected == 1
+        has_only_one = true
+      end
+    end
+    
+    if !params_good || ! has_atleast_one || ! has_only_one
+      puts "#{REQUIRED}"
+      exit(1)
+    end
+     
+  end
+  
+
+end

data/lib/trail_marker/config_file.rb

@@ -0,0 +1,107 @@
+require 'yaml'
+
+# History:
+#   2/19/2018 Created ibarra.alfonso@gmail.com
+#
+#
+class ConfigFile
+
+  attr_accessor :username, :token, :testrail_url, :filename, :default_comment
+
+  def initialize(cfile)
+    @filename = cfile
+    read_config_file
+  end
+
+  def prompt_user(user_msg, default_val)
+    retval = default_val
+    newval = ''
+    atmps = 0
+    while newval.strip == '' && atmps < 3
+      atmps += 1
+      print "#{user_msg}"
+      newval = STDIN.gets
+      retval = newval.strip == '' ? default_val : newval.strip
+      newval = retval
+    end
+    if atmps >= 3
+      puts "\nERROR: Value cannot be empty... exiting."
+      exit(1)
+    end
+    return retval
+  end
+
+  def user_continue?(user_msg, default_val=false)
+    retval = default_val
+    reply = prompt_user(user_msg, 'N')
+    if reply.upcase == "Y"
+      retval = true
+    end
+    return retval
+  end
+
+  def read_config_file
+    if File.exist?(@filename)
+      @trail_info = YAML.load_file(@filename)
+      @username = @trail_info["username"]
+      @token = @trail_info["token"]
+      @testrail_url = @trail_info["testrail_url"]
+      @default_comment = @trail_info['default_comment']
+    else
+      @trail_info = Hash.new
+      @username = ''
+      @token = ''
+      @testrail_url = ''
+      @default_comment = 'Marked by Automation'
+    end
+  end
+
+  def check_create_configfile
+    if ! File.exist?(@filename)
+      puts "\nWARNING: Configuration File does not exist."
+      if user_continue?("Create a new config file (Y/N)? : ", 'N')
+        create_configfile
+      end
+    end
+  end
+
+  def create_configfile
+    @username = prompt_user("Enter testrail email (#{@username}): ", @username)
+    @token = prompt_user("Enter testrail token (#{@token}): ", @token)
+    @testrail_url = prompt_user("TestRail URL (#{@testrail_url}): ", @testrail_url)
+    @default_comment = prompt_user("Test comment (Default - Marked by Automation): ", "Marked by Automation")
+    @trail_info = Hash.new
+    @trail_info["username"] = @username
+    @trail_info["token"] = @token
+    @trail_info["testrail_url"] = @testrail_url
+    @trail_info["default_comment"] = @default_comment
+    save
+    # Comment out until overwrite is finished.
+    #if user_continue?("Do you want to save the testrail project info (Y/N)?")
+    #  config_project
+    #  thash["project_name"] = @project_name
+    #  thash["testrun"] = @testrun
+    #  thash["testplan"] = @testplan
+    #end
+  end
+
+  def config_project
+    @project_name = prompt_user("Enter testrail project name: ")
+    @testrun = prompt_user("Enter name of test run: ", "NA")
+    @testplan = prompt_user("Enter name of test plan: ", "NA")
+  end
+
+  def update(varname, varvalue)
+    if defined? @trail_info
+      @trail_info[varname] = varvalue
+    end
+  end
+
+  def save
+    File.open(@filename, 'w') { |f|
+      f.write @trail_info.to_yaml
+      puts "Successfully saved config file: #{@filename}"
+    }
+  end
+  
+end