tms-cli 0.0.pre.beta

data/lib/testrail/dataprep.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+require_relative './testrail'
+require_relative '../../util/script/generate-password'
+
+require 'date'
+require 'json'
+require 'fileutils'
+require 'mysql2'
+
+module Tms
+  module Dataprep
+    module_function
+
+    include GeneratePassword
+    # This method will create client of testrail
+    def client_tr
+      url = ENV['TR_BASEURL']
+      user = ENV['TR_USERNAME']
+      password = GeneratePassword.decrypt(ENV['TR_API_KEY'], ENV['TR_SECRET'])
+  
+      client = TestRail::APIClient.new(url)
+      client.user = user
+      client.password = password
+      client
+    end
+
+    # Creates a new file with the specified content at the given file path.
+    #
+    # @param [String] file_name The name of the file to create.
+    # @param [String, nil] folder_path (optional) The folder path where the file should be created.
+    #   If provided, the file will be created in this folder; otherwise, it will be created in the current directory.
+    # @param [String] content The content to write to the file.
+    def create_file(file_name, folder_path = nil, content)
+      file_path = folder_path ? File.join(folder_path, file_name) : file_name
+
+      File.open(file_path, "w") do |file|
+        file.write(content)
+      end
+    end
+
+    # Creates a `.env` file with the specified environment variable assignments.
+    #
+    # @param [String] file_path The path to the `.env` file to be created or overwritten.
+    # @param [String, nil] folder_path (optional) The folder path where the file should be created.
+    #   If provided, the file will be created in this folder; otherwise, it will be created in the current directory.
+    # @param [Hash] env_variables A hash containing environment variable assignments, where each
+    #   key-value pair represents an environment variable name and its corresponding value.
+    #
+    # @example Create a `foo.env` file with custom environment variables:
+    #   file_path = ".env"
+    #   env_variables = {
+    #     "DATABASE_URL" => "your_database_url",
+    #     "API_KEY" => "your_api_key",
+    #     "SECRET_KEY" => "your_secret_key"
+    #   }
+    #   create_env_file(file_path, env_variables)
+    def create_file_env(file_name, folder_path = nil, env_variables)
+      file_path = folder_path ? File.join(folder_path, file_name) : file_name
+
+      File.open("#{file_path}.env", "w") do |file|
+        env_variables.each do |key, value|
+          file.puts("#{key}=#{value}")
+        end
+      end
+    end
+
+    # This method will get project id based on file report
+    def project_id_by_report_file(client, report_file, tr_version)
+      project_name = nil
+      id = nil
+      response = Projects.get_projects(client)
+
+      project_name = if report_file.split('-').size.eql? 4
+                       report_file.split('-')[2].tr('_', ' ')
+                     else
+                       report_file.split('-')[1].tr('_', ' ')
+                     end
+      response.each do |project_detail|
+        if project_detail['name'].casecmp?(project_name.to_s)
+          id = project_detail['id']
+          break
+        end
+      end
+      id.nil? ? abort('Please input valid project name') : id
+    end
+
+    # This method will get project id based on project name
+    def project_id_by_name(client, project_name, tr_version)
+      id = nil
+      response = Projects.get_projects(client)
+
+      response.each do |project_detail|
+        if project_detail['name'].casecmp?(project_name.to_s)
+          id = project_detail['id']
+          break
+        end
+      end
+      id.nil? ? abort('Please input valid project name') : id
+    end
+
+    # This method will get section name based on file report
+    def section_name(report_file)
+      is_env_available = report_file.split('-').size.eql? 4
+      arrlocation = is_env_available ? 1 : 0
+      report_file.split('-')[arrlocation]
+    end
+
+    def platform_name(report_file)
+      is_env_available = report_file.split('-').size.eql? 4
+      arrlocation = is_env_available ? 3 : 2
+
+      report_type = report_file.split('-')[arrlocation]
+      report_type = report_type.split('_')[1]
+      platform_name = report_type.split('.')[0]
+    end
+
+    def test_env(report_file)
+      is_env_available = report_file.split('-').size.eql? 4
+      is_env_available ? report_file.split('-')[0] : ''
+    end
+
+    # This method will get testrail version on login page
+    # for handle response structure from api
+    def testrail_version(client, url)
+      source = URI.open(url).read
+      source.scan(%r{\b(?<=loginpage-version\"\>)[^"]+(?=</span>)})
+    end
+
+    # This method will get section id
+    def section_id(client, project_id, suite_id, section_name, tr_version)
+      tmp_sections = {}
+      sections = client.send_get("get_sections/#{project_id}&suite_id=#{suite_id}")
+      sections = sections['sections'] unless tr_version.to_s.include? '6.7.2'
+      sections.each do |section|
+        tmp_sections[section['name']] = section['id']
+      end
+      unless tmp_sections.key?(section_name)
+        create_section(client, project_id, suite_id, section_name)
+      else
+        tmp_sections[section_name]
+      end
+    end
+
+    # This method will create section on test suite
+    def create_section(client, project_id, suite_id, section_name)
+      payload = { description: section_name, suite_id: suite_id, name: section_name }
+      client.send_post("add_section/#{project_id}", payload)['id']
+    end
+
+    # This method will create new project
+    def create_project(client, project_name)
+      payload = { name: project_name, suite_mode: 3 }
+      client.send_post('add_project', payload)['id']
+    end
+
+    # Returns a Unix timestamp for a date that is a specified number of months before the current date.
+    #
+    # @param [Integer] month - The number of months before the current date.
+    # @return [Integer] - Unix timestamp for the calculated date.
+    #
+    # @example
+    #   timestamp = get_timestamp_prev_month(3) # 
+    #   Gets the timestamp for 3 months before the current date.
+    def get_timestamp_prev_month(month)
+      Date.today.prev_month(month).to_time.to_i
+    end
+  end
+end

data/lib/testrail/log.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Tms
+  module Log
+    module_function
+    def error(exception, is_local)
+        puts "An error of type '#{exception.class}' happened, message is '#{exception.message}'".colorize(:red)
+        puts "#{exception.backtrace.join("\n")}".colorize(:red)
+    end
+
+    def info(message)
+        puts "Info : #{message}".colorize(:yellow)
+    end
+  end
+end

data/lib/testrail/milestone.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require_relative './testrail'
+require_relative './dataprep'
+require_relative './projects'
+require 'json'
+require 'fileutils'
+
+module Tms
+  module Milestone
+    module_function
+
+    include Dataprep
+    include Projects
+
+    # This method will get milestone id
+    # Will create new if milestone is not exist
+    # Milestone name based on tag release on CI/CD pipeline
+    # @param client testrail
+    # @param project id
+    # @param milestone name
+    def milestone_id(client, project_id, milestone_name, tr_version)
+      milestone_id = nil
+      is_milestone_available = false
+
+      response = get_milestones(client, project_id)
+
+      if response.empty?
+        milestone_id = create_milestone(client, project_id, milestone_name)
+        is_milestone_available = true
+      else
+        response.map do |milestones|
+          next unless milestones['name'].eql? milestone_name
+
+          milestone_id = milestones['id']
+          is_milestone_available = true
+          break
+        end
+      end
+      is_milestone_available ? milestone_id : create_milestone(client, project_id, milestone_name)
+    end
+
+    # This method will create new milestone
+    # Will create new if milestone is not exist
+    # @param client testrail
+    # @param project id
+    # @param milestone name
+    def create_milestone(client, project_id, milestone_name)
+      puts "Creating new milestone ..."
+      # Calculate the due_on date as 14 days (2 weeks) from now
+      due_date = (Date.today + 14).to_time.to_i
+      client.send_post("add_milestone/#{project_id}", { name: milestone_name, due_on: due_date })['id']
+    end
+
+    # This method will update status old milestone to complete
+    # Only 10 recent milestones are active
+    # @param client testrail
+    # @param project id
+    def completed_old_milestone(client, project_id)
+      milestone_ids = []
+      client.send_get("get_milestones/#{project_id}")['milestones'].each { |detail| milestone_ids.push(detail['id'])}
+      10.times { milestone_ids.delete(milestone_ids.max) }
+      milestone_ids.each { |id| client.send_post("update_milestone/#{id}", { is_completed: true }) }
+    end
+
+    def get_milestones(client, project_id)
+      # handle tests more than 250 entries
+      offset = 0
+      milestones = []
+
+      puts "Retrieving milestones from project id #{project_id} ..."
+
+      loop do 
+        get_milestones = client.send_get("get_milestones/#{project_id}&offset=#{offset}&is_completed=0")
+        milestones.push get_milestones['milestones']
+        offset += 250
+        break if get_milestones['_links']['next'].nil?
+      end
+      milestones = milestones.flatten
+
+      return milestones
+    end
+
+    # This method will get milestone by name
+    # @param client testrail
+    # @param milestone name
+    def get_milestone_id(client, project_id, milestone_name)
+      response = get_milestones(client, project_id)
+      milestone_id = response.find { |milestone| milestone["name"] == milestone_name }&.dig("id")
+      
+      return milestone_id
+    end
+
+    # This method will delete milestone
+    # @param client testrail
+    # @param milestone name
+    def delete_milestone(client, milestone_id)
+      client.send_post("delete_milestone/#{milestone_id}", '')
+    end
+
+    # This method will complete milestone
+    # @param client testrail
+    # @param test milestone id
+    def completed_milestone(client, milestone_id)
+      client.send_post("update_milestone/#{milestone_id}", { is_completed: true })
+      puts "Complete the Milestone with ID: #{milestone_id}"
+    end
+
+    # This method will get the milestone status
+    # @param client testrail
+    # @param test milestone id
+    def get_milestone_state(client, milestone_id)
+      state = client.send_get("get_milestone/#{milestone_id}")['is_completed']
+      puts "Milestone with ID #{milestone_id} have completed status is #{state}"
+      return state
+    end
+
+    # This method completes milestones that started a specified number of months before the current date.
+    # It iterates through all projects, checks each milestone's start date, and completes those that meet the criteria.
+    #
+    # @param client [Client] The client instance for making API requests.
+    # @param month [Integer] The number of months before the current date.
+    def completed_milestone_months_before(client, month)
+      Projects.get_list_project_ids(client).each do |project_id|
+        get_milestones(client, project_id).each do |milestone_detail|
+          milestone_id = milestone_detail['id']
+          started_on = milestone_detail['started_on']
+          if started_on && started_on <= month
+            completed_milestone(client, milestone_id)
+            puts "Completed Milestone ID: #{milestone_id} with started on date: #{started_on}"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/testrail/projects.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+require_relative './testrail'
+require 'json'
+require 'fileutils'
+
+module Tms
+  module Projects
+    module_function
+
+    # Returns all list of available projects and handle more than 250 entries
+    # @param client testrail
+    def get_projects(client)
+      offset = 0
+      projects = []
+      loop do 
+        get_projects = client.send_get("get_projects&offset=#{offset}&is_completed=0")
+        projects.push get_projects['projects']
+        offset += 250
+        break if get_projects['_links']['next'].nil?
+      end
+      projects = projects.flatten
+      return projects
+    end
+
+    # Returns list of testrail project ids
+    # @param client testrail
+    def get_list_project_ids(client)
+      return get_projects(client).map { |project_detail| project_detail['id'] }
+    end
+
+    # Returns an existing testrail project
+    # @param client testrail
+    # @param project id
+    def get_projects_by_id(client, project_id)
+      response = client.send_get("get_project/#{project_id}")
+    end
+  end
+end

data/lib/testrail/report.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require_relative './testrail'
+require 'webdrivers'
+require 'openssl'
+require 'base64'
+
+module Tms
+  module Report
+    module_function
+
+    # This method will post test result from json report to test run
+    def post(client, test_results, run_id)
+      payload = {}
+      tmp_array = []
+      test_results.each do |result|
+        next if result['status'].eql?(3)
+
+        comment = result['comment'].nil? || result['comment'].empty? ? 'automated' : result['comment'].to_s
+        result['comment'] = comment
+        tmp_array.push(result)
+      end
+      payload['results'] = tmp_array
+      client.send_post("add_results_for_cases/#{run_id}", payload)
+    end
+
+    def results(client, run_id)
+      offset = 0
+      results = []
+
+      puts 'Retrieving test results...'
+
+      loop do 
+        get_results = client.send_get("get_results_for_run/#{run_id}&offset=#{offset}")
+        results.push get_results['results']
+        offset += 250
+        break if get_results['_links']['next'].nil?
+      end
+      results = results.flatten
+
+      return results
+    end
+
+    def results_status(client, run_id, status_id)
+      offset = 0
+      results = []
+
+      puts 'Retrieving test results...'
+
+      loop do 
+        get_results = client.send_get("get_results_for_run/#{run_id}/&status_id=#{status_id}&offset=#{offset}")
+        results.push get_results['results']
+        offset += 250
+        break if get_results['_links']['next'].nil?
+      end
+      results = results.flatten
+
+      return results
+    end
+  end
+end

data/lib/testrail/results.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative './testrail'
+require 'json'
+require 'fileutils'
+
+module Tms
+  module Results
+    module_function
+
+    # This method will adds a new test result, comment or assigns a test.
+    # It’s recommended to use add_results instead if you plan to add results for multiple tests.
+    # @param client testrail
+    # @param test_id
+    def add_result(client, test_id, status_id, comment)
+      payload = { status_id: status_id, comment: comment }
+      client.send_post("add_result/#{test_id}", payload)
+    end
+  end
+end

data/lib/testrail/sections.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative './testrail'
+require 'json'
+require 'fileutils'
+
+module Tms
+  module Sections
+    module_function
+
+    # Returns a list of sections for a project.
+    # @param client testrail
+    # @param project id
+    def get_sections(client, project_id)
+      client.send_get("get_sections/#{project_id}")
+    end
+
+    # Returns a list of sections for a project and test suite.
+    # @param client testrail
+    # @param project id
+    def get_sections(client, project_id, suite_id)
+      client.send_get("get_sections/#{project_id}&suite_id=#{suite_id}")
+    end
+
+    # Returns a list of sections for a project and test suite.
+    # @param client testrail
+    # @param project id
+    def get_section_id(client, section_id)
+      client.send_get("get_section/#{section_id}")
+    end
+  end
+end

data/lib/testrail/testbdd.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative './testrail'
+require 'json'
+require 'fileutils'
+
+module Tms
+  module Testbdd
+    module_function
+
+    # Exports a BDD scenario from a test case as a .feature file.
+    # @param client testrail
+    # @param case id
+    def get_bdd(client, case_id)
+      client.send_get("get_bdd/#{case_id}")
+    end
+
+    def get_case(client, case_id)
+      response = client.send_get("get_case/#{case_id}")
+      response = JSON.parse(response) if response.is_a?(String)
+      
+      custom_testrail_bdd_scenario = JSON.parse(response['custom_testrail_bdd_scenario'])
+
+      # handle test case that contains fews BDD scenario
+      content_array = []
+
+      if custom_testrail_bdd_scenario.is_a?(Array)
+        custom_testrail_bdd_scenario.each do |scenario|
+          content = scenario['content']
+          content_array << content if content
+        end
+      end
+
+      case_bdd = content_array.join("\n\n")
+
+      # Handle multiple refs and add "@" before each refs 
+      refs = response['refs'].split(", ").map { |component| "@" + component }.join(" ") unless response['refs'].nil?
+
+      case_bdd = "#{refs}\nFeature: #{response['title']}\n" + case_bdd
+      return case_bdd
+    end
+
+    # Create new BDD cases by upload .feature file.
+    # @param client testrail
+    # @param case id
+    def add_bdd(client, section_id, file)
+      puts "Create test case: #{File.read(file).match(/Feature:(.+)/)[1]}"
+      client.send_post("add_bdd/#{section_id}", file)
+    end
+
+    def get_scenario(client, case_id)
+      response = client.send_get("get_case/#{case_id}")
+      response = JSON.parse(response) if response.is_a?(String)
+      
+      custom_testrail_bdd_scenario_string = response['custom_testrail_bdd_scenario']
+      custom_testrail_bdd_scenario = JSON.parse(custom_testrail_bdd_scenario_string)
+
+      # handle test case that contains fews BDD scenario
+      content_array = []
+
+      if custom_testrail_bdd_scenario.is_a?(Array)
+        custom_testrail_bdd_scenario.each do |scenario|
+          content = scenario['content']
+          content_array << content if content
+        end
+      end
+
+      scenario_bdd = content_array.join("\n\n")
+      return scenario_bdd
+    end
+  end
+end