testrailtagging 0.3.6.8

data/lib/files/testrail_operations.rb

@@ -0,0 +1,369 @@
+require_relative "testrail_apiclient_retry"
+require_relative "TestCase"
+
+# =================================================================================
+#
+# API's for Test Rail
+#
+# =================================================================================
+
+module TestRailOperations
+  def self.set_testrail_ids(pid, sid)
+    @@testrail_project_id = pid
+    @@testrail_suite_id = sid
+  end
+
+  def self.project_id
+    @@testrail_project_id
+  end
+
+  def self.suite_id
+    @@testrail_suite_id
+  end
+
+  # Splits a string by a command and returns an array.
+  def self.split_by_comma(device_string)
+    splits = device_string.split(",")
+    key = splits[0].chomp
+    val = splits[1].lstrip
+    [key, val]
+  end
+
+  # Gets the Test Rail client
+  # http://docs.gurock.com/testrail-api2/bindings-ruby
+  def self.get_test_rail_client
+    url = "https://canvas.testrail.com"
+    trclient = TestRail::APIClient.new(url)
+    trclient.user = ENV["TESTRAIL_USER"]
+    trclient.password = ENV["TESTRAIL_PASSWORD"]
+    trclient
+  end
+
+  # Gets the definition of device types that are assigned to our test rail cases.
+  # It looks like this:
+  # {1=>"Desktop", 2=>"Tablet", 3=>"Phone"}
+  def self.get_test_rail_screen_size_codes
+    trclient = get_test_rail_client
+    case_fields = trclient.send_get("get_case_fields")
+
+    results = {}
+    case_fields.each do |case_field|
+      if (case_field["name"] == "screen_size")
+        config_array = case_field["configs"] # The array usually has a size of 1, but sometimes 0
+        if config_array.size > 0
+          config = config_array[0]
+          # Some configs have items, like screen size
+          items = config["options"]["items"]
+          if items
+            devices = items.split("\n")
+            devices.each do |device|
+              key, value = split_by_comma(device)
+              results[key.to_i] = value
+            end
+          end
+        end
+      end
+    end
+    results
+  end
+
+  # Gets the definition of the priority codes that are assigned to our test rail cases.
+  # The priority codes on testrail do not match our nice 1,2,3 numbers. Their codes are
+  # different from ours. i.e.
+  #
+  # {1=>"3 - Low Priority", 3=>"2 - Test If Time", 4=>"1 - Must Test", 6=>"Smoke Test"}
+  #
+  # Therefore this function creates a more bridge friendly translation.
+  def self.get_test_rail_priority_codes
+    trclient = get_test_rail_client
+    # retreive priority information
+    # http://docs.gurock.com/testrail-api2/reference-priorities
+    priority_response = trclient.send_get("get_priorities")
+
+    results = {}
+    priority_response.each do |priority|
+      # find the numeric priority
+      name = priority["name"]
+      splits = name.split("-")
+      key = priority["id"].to_i
+      if splits.size == 2 && splits[0].to_i
+        val = { name: name, user_friendly_priority: splits[0].to_i }
+        results[key] = val
+      elsif name == "Smoke Test"
+        val = { name: "Smoke", user_friendly_priority: 0 }
+        results[key] = val
+      elsif name == "STUB"
+        val = { name: "Stub", user_friendly_priority: 7 }
+        results[key] = val
+      end
+    end
+    results
+  end
+
+  # Gets all the test cases for a particular test suite.
+  # The keys are the numeric(integer) test rail case ID's.
+  # The Values are the instance of TestCase.
+  # Each TestCase instance corresponds to a test case in test rail.
+  # return - A hash of TestCase instances
+  def self.get_test_rail_cases
+    trclient        = get_test_rail_client
+    screen_sizes    = get_test_rail_screen_size_codes
+    priorities      = get_test_rail_priority_codes
+    test_cases      = {}
+
+    # retrieve test cases
+    testcases_url = "get_cases/#{self.project_id}&suite_id=#{self.suite_id}"
+    response = trclient.send_get(testcases_url)
+    response.each do |test_case|
+      id = test_case["id"]
+      size = test_case["custom_screen_size"]
+      screen_size_description = screen_sizes[size]
+      priority = test_case["priority_id"]
+      priority_description = priorities[priority]
+      if priority_description
+        priority_code = priority_description[:user_friendly_priority]
+        automated = test_case["custom_automated"]
+        run_once = test_case["custom_run_once"]
+        automatable = test_case["custom_to_be_automated"]
+        references = test_case["refs"]
+        tc = TestCase.new(
+          id.to_s, test_case["title"], priority_code, automated,
+          screen_size_description, automatable, references, run_once
+        )
+        tc.file = test_case["custom_spec_location"]
+        test_cases[id] = tc
+      end
+    end
+
+    test_cases
+  end
+
+  # Updates a testcase that corresponds to the provided
+  # testrail_id. The testcase's reference field will be
+  # linked to the provided Jira ticket, given in the format
+  # of PROJECT-ID (ex. "BR-1000")
+  # param - testrail_id. The integer ID of the testcase
+  # param - reference. The string of the JIRA ticket(s)
+  def self.update_references(testrail_id, reference)
+    puts "id: #{testrail_id} => refs: #{reference}"
+    url = "update_case/#{testrail_id}"
+    data = { "refs" => reference }
+    TestRailOperations.get_test_rail_client.send_post_retry(url, data)
+  end
+
+  # Gets JSON data about the test runs on testrail for the given project and suite
+  def self.get_test_rail_runs
+    trclient = get_test_rail_client
+    request  = "get_runs/#{self.project_id}"
+    trclient.send_get(request)
+  end
+
+  # Returns a list of test plans for a project.
+  # http://docs.gurock.com/testrail-api2/reference-plans#get_plans
+  def self.get_test_rail_plans
+    trclient = get_test_rail_client
+    request  = "get_plans/#{self.project_id}"
+    trclient.send_get(request)
+  end
+
+  # Gets JSON data about an existing test plan
+  # http://docs.gurock.com/testrail-api2/reference-plans#get_plan
+  def self.get_test_rail_plan(plan_id)
+    trclient = get_test_rail_client
+    request  = "get_plan/#{plan_id}"
+    trclient.send_get(request)
+  end
+
+  def self.create_test_plan(name, description = 'created by api', entries = [])
+    request  = "add_plan/#{self.project_id}"
+    data = {
+        "name" => name,
+        "description" => description,
+        "entries"=> entries}
+    get_test_rail_client.send_post(request, data)
+  end
+
+  # new method to create plan entry with runs
+  def self.create_test_plan_entry_with_runs(plan_id, data)
+    request  = "add_plan_entry/#{plan_id}"
+    get_test_rail_client.send_post(request, data)
+  end
+
+  # Adds one test run to a test plan
+  # Returns hash containing:
+  # 1. The test run ID of the test run.
+  # 2. The entry ID of the test run which is a large Guid like this:
+  # "id"=>"638fd46c-7c3e-4818-9c90-f411a2dec52a"
+  def self.create_test_plan_entry(plan_id, name, include_all_cases: true, case_ids: [])
+    if !include_all_cases && case_ids.count == 0
+      return "Error! Must create a test plan with at least one test case"
+    end
+
+    request = "add_plan_entry/#{plan_id}"
+    data = {
+        "suite_id" => self.suite_id,
+        "name" => name,
+        "include_all" => include_all_cases,
+        "case_ids" => case_ids
+    }
+
+    trclient = get_test_rail_client
+    response = trclient.send_post_retry(request, data)
+    { entry_id: response["id"], run_id: response["runs"][0]["id"] }
+  end
+
+  # Updates a test plan with the given entry_id and array of test case IDSs
+  def self.add_test_case_to_test_plan(plan_id, entry_id, case_ids)
+    request = "update_plan_entry/#{plan_id}/#{entry_id}"
+    data = {
+        "suite_id" => self.suite_id,
+        "case_ids" => case_ids
+    }
+
+    trclient = get_test_rail_client
+    trclient.send_post_retry(request, data)
+  end
+
+  def self.keep_only(plan_id, entry_id, case_ids)
+    request = "update_plan_entry/#{plan_id}/#{entry_id}"
+    data = {
+        "suite_id" => self.suite_id,
+        "include_all" => false,
+        "case_ids" => case_ids
+    }
+
+    trclient = get_test_rail_client
+    trclient.send_post_retry(request, data)
+  end
+
+  # Creates a test run on testrail
+  # param project_ID - The integer identifier of the project on test rail.
+  # param suite_id   - The integer identifier of the test suite on test rail.
+  # param name       - The string name to call the new test run
+  # param test_case_ids - The array of numerical integers of test cases to add to the test run
+  # returns - The number ID of the test run.
+  def self.create_test_run(project_id, suite_id, name, test_case_ids)
+    request = "add_run/#{project_id}"
+    data = {
+      "suite_id" => suite_id,
+      "name" => name,
+      "include_all" => false,
+      "case_ids" =>  test_case_ids
+    }
+
+    trclient = get_test_rail_client
+    response = trclient.send_post_retry(request, data)
+    response["id"]
+  end
+
+  def self.add_testcase_to_test_run(test_run_id, case_ids)
+    request = "update_run/#{test_run_id}"
+    data = { "case_ids" => case_ids }
+    trclient = get_test_rail_client
+    trclient.send_post_retry(request, data)
+  end
+
+  PASSED = 1
+  BLOCKED = 2
+  UNTESTED = 3
+  RETEST = 4
+  FAILED = 5
+  PENDING = 6
+  @rspec_to_testrail_status_map = {
+    passed: PASSED, blocked: BLOCKED, untested: UNTESTED, retest: RETEST, failed: FAILED, pending: PENDING
+  }
+  # Converts an rspec test result (a symbol) to an integer that TestRail understands.
+  def self.status_rspec_to_testrail(result_symbol)
+    @rspec_to_testrail_status_map[result_symbol]
+  end
+
+  # Converts the a TestRail integer result status into a symbol (that rspec uses) that is human readable
+  def self.status_testrail_to_rspec(int_id)
+    @rspec_to_testrail_status_map.key(int_id)
+  end
+
+  # Sends test result data back to testrail to update cases in a test run
+  # param run_id - integer value designating the test run to update
+  # param data   - A hash containing an array of hashes with test results
+  def self.post_run_results(run_id, data)
+    trclient = get_test_rail_client
+    uri = "add_results/#{run_id}"
+    trclient.send_post_retry(uri, "results" => data)
+  end
+
+  # When a test run is created, the test cases have new, sort of temporary ID's.
+  # These are completely different from the permanent static ID's of the test cases.
+  # Given a test run ID, this gets the test cases that are assigned to that test run.
+  # It returns a hash where the key is the integer permanent ID, and the value is a TestCase instance.
+  def self.get_test_run_cases(run_id)
+    result = {}
+    trclient = get_test_rail_client
+    response = trclient.send_get("get_tests/#{run_id}")
+    response.each do |r|
+      # Each response hash for a test case in a run looks like this:
+      #
+      # {"id"=>481664, "case_id"=>152222, "status_id"=>5, "assignedto_id"=>49, "run_id"=>2641,
+      # "title"=>"The my Learning page has all my courses listed. Overdue, Next Up, Optional,
+      # Completed", "type_id"=>2, "priority_id"=>3, "estimate"=>nil, "estimate_forecast"=>nil,
+      # "refs"=>nil, "milestone_id"=>nil, "custom_sprint_date"=>nil, "custom_commit_url"=>nil,
+      # "custom_reviewed"=>false, "custom_automated"=>true,
+      # "custom_spec_location"=>"regression_spec/learner_management/mylearning_spec.rb",
+      # "custom_test_order"=>nil, "custom_screen_size"=>3, "custom_preconds"=>nil,
+      # "custom_steps_separated"=>nil, "custom_browser_skip"=>[]}
+      #
+
+      permanent_id = r["case_id"].to_i
+      tc = TestCase.new(
+        permanent_id, r["title"], r["priority_id"].to_i,
+        r["custom_automated"], r["custom_screen_size"].to_i,
+        r["custom_to_be_automated"], r["refs"], r["custom_run_once"]
+      )
+      tc.temp_id = r["id"].to_i
+      tc.assigned_to = r["assignedto_id"].to_i
+      tc.set_status(status_testrail_to_rspec(r["status_id"].to_i), nil)
+
+      value = tc
+      key = permanent_id
+      result[key] = value
+    end
+    result
+  end
+
+  # Gets the string name of the test run, given the test run id as an integer
+  # if the test id is not found, it returns an empty string
+  def self.get_test_run_name(run_id)
+    runs = get_test_rail_runs(self.project_id)
+    runs.each do |run|
+      if run_id == run["id"].to_i
+        return run["name"]
+      end
+    end
+    ""
+  end
+
+  def self.get_test_rail_users
+    # Returns an array of user hashes. Like this:
+    # [
+    # {
+    #    "email": "alexis@example.com",
+    #    "id": 1,
+    #    "is_active": true,
+    #    "name": "Alexis Gonzalez"
+    # },
+    # ....
+    # ]
+    get_test_rail_client.send_get("get_users")
+  end
+
+  # Given an email address, gets the user json data
+  def self.get_test_rail_user_by_email(email)
+    # The response looks like this:
+    # {
+    #    "email": "alexis@example.com",
+    #    "id": 1,
+    #    "is_active": true,
+    #    "name": "Alexis Gonzalez"
+    # }
+    get_test_rail_client.send_get("get_user_by_email&email=#{email}")
+  end
+end

data/lib/files/testrail_queries.rb

@@ -0,0 +1,108 @@
+require_relative "testrail_operations"
+
+# =================================================================================
+#
+# Test case printing and inspections
+#
+# =================================================================================
+
+module TestRailQueries
+  # Prints to the console, the test cases sorted by priority (ascending).
+  def self.print_priority_sorted_test_cases
+    test_cases = TestRailOperations.get_test_rail_cases
+    sorted_cases = test_cases.values.sort_by do |tc|
+      tc.priority
+    end
+
+    automated_count = 0
+    sorted_cases.each do |tc|
+      tc.print
+      automated_count += 1 if tc.automated
+    end
+
+    puts "Number Test Cases: #{test_cases.size}"
+    puts "Number Test Cases Automated: #{automated_count}"
+    percentage = (automated_count / test_cases.size.to_f) * 100.0
+    puts "Percentage Automated #{percentage.round(1)}%"
+  end
+
+  # Prints to the console, the test cases that work on phone devices. (Sorted by test ID)
+  def self.print_phone_test_cases
+    test_cases = TestRailOperations.get_test_rail_cases
+
+    phones = []
+    test_cases.values.each do |tc|
+      phones << tc if tc.screen_size == "Phone"
+    end
+
+    sorted_ids = phones.each do |tc|
+      tc.id
+    end
+
+    sorted_ids.each do |tc|
+      tc.print
+    end
+
+    puts "Number Test Cases: #{test_cases.size}"
+    puts "Number Test Cases Phone: #{phones.size}"
+    percentage = (phones.size / test_cases.size.to_f) * 100.0
+    puts "Percentage Phone #{percentage.round(1)}%"
+  end
+
+  # Prints to the console, all the test case ID's and the minimum screen size they work on
+  def self.print_test_case_devices
+    test_cases = TestRailOperations.get_test_rail_cases
+
+    test_cases.each do |key, value|
+      puts "ID: #{key}, #{value.screen_size}"
+    end
+  end
+
+  # Prints to the console, all the test runs
+  def self.print_all_test_runs
+    test_runs = TestRailOperations.get_test_rail_runs
+    count_runs  = 0
+    count_open  = 0
+    count_close = 0
+    test_runs.each do |test_run|
+      puts "Run: #{test_run["name"]}, id: #{test_run["id"]} complete: #{test_run["is_completed"]} "
+      if test_run["is_completed"]
+        count_close += 1
+      else
+        count_open += 1
+      end
+
+      count_runs += 1
+    end
+    puts "========================================"
+    puts "Total Test Runs: #{count_runs}"
+    puts "Total Open: #{count_open}"
+    puts "Total Closed: #{count_close}"
+  end
+
+  # Prints to the console all the test plans in bridge
+  def self.print_all_test_plans
+    test_plans = TestRailOperations.get_test_rail_plans
+    count_plans = 0
+    test_plans.each do |plan|
+      id = plan["id"]
+      puts "Plan: ID: #{id}, #{plan["name"]}"
+      count_plans += 1
+      pjson = TestRailOperations.get_test_rail_plan(id)
+      puts "    passed: #{pjson["passed_count"]}, failed: #{pjson["failed_count"]}, retest: #{pjson["retest_count"]}, blocked: #{pjson["blocked_count"]}"
+      puts "    entries count: #{pjson["entries"].count}"
+      pjson["entries"].each do |entry|
+        puts "    entry: #{entry["id"]} - #{entry["name"]}"
+      end
+    end
+    puts "========================================"
+    puts "Total Test Plans: #{count_plans}"
+  end
+
+  def self.print_all_users
+    users = TestRailOperations.get_test_rail_users
+    users.each do |user|
+      puts user
+    end
+  end
+end