tms-cli 0.0.pre.beta

data/lib/tms.rb

@@ -0,0 +1,337 @@
+# frozen_string_literal: true
+
+require 'thor'
+require_relative 'preprocessing'
+require_relative 'regression'
+require_relative 'cucumber'
+require_relative 'acceptance_criteria'
+require_relative 'testrail/log'
+require_relative 'db/mysql'
+require_relative 'testrail/dataprep'
+require_relative '../util/script/mergerequest'
+require_relative '../util/script/generate-password'
+
+module Tms
+  class CLI < Thor
+
+    include Preprocessing
+    include Regression
+    include Cucumber
+    include Log
+    include Dataprep
+    include Gitlab
+    include AcceptanceCriteria
+
+    def initialize(*args)
+      super
+      @starting = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+      Dotenv.load(".env")
+    end
+
+    desc 'post_report', 'Process Test Result to TestRail'
+    method_option :report_file, :aliases => "-f", :desc => "Report file (.json) - example : ./STG-E2E-MITRA_BANGUNAN-report_tms.json or ./STG-E2E-MITRA_BANGUNAN-report_tms-*.json for multiple report", :default => [], :type => :array
+    method_option :milestone_name, :aliases => "-r", :desc => "Release Version of Test", :default => ""
+    method_option :attachment_dir, :aliases => "-d", :desc => "Attachment Directory - example : /Home/Attachment/*", :default => ""
+    method_option :generate_report, :aliases => "-g", :desc => "Create report on TMS", :type => :boolean, default: false
+    method_option :chromedriver_dir, :aliases => "-c", :desc => "Create report on TMS", default: "./chromedriver"
+    method_option :email_azure, :aliases => "-u", :desc => "user azure (inclue @azure.bukalapak.io)", :default => ""
+    method_option :suite_name, :aliases => "-t", :desc => "suite name", :default => ""
+    method_option :section_name, :aliases => "-e", :desc => "section name", :default => ""
+    method_option :local, :aliases => "-l", :desc => "running from local", :type => :boolean, default: false
+    
+    def post_report
+      begin
+        if !options[:suite_name].nil? && !options[:section_name].nil? && !options[:suite_name].empty? && !options[:section_name].empty?
+          Preprocessing.execute_preprocessing_bdd(options[:report_file], options[:suite_name], options[:section_name])
+        else
+          runner_type = ENV['TEST_RUNNER_TYPE'] || ""
+          Preprocessing.execute_preprocessing(options[:report_file], options[:milestone_name], options[:attachment_dir], runner_type)
+        end
+      rescue => e
+        Log.error(e, options[:local])
+        exit 1
+      end
+      count_elapsed_time
+    end
+
+    desc 'clean_refs', 'Clean Invalid References format'
+    method_option :project_id, :aliases => "-P", :desc => "Project id", :default => ""
+    method_option :local, :aliases => "-l", :desc => "running from local", :type => :boolean, default: false
+    method_option :email_azure, :aliases => "-u", :desc => "user azure (include @azure.bukalapak.io)", :default => ""
+
+    def clean_refs
+      begin
+        Preprocessing.execute_clean_testcase(options[:project_id])
+      rescue => e
+        Log.error(e, options[:local])
+        exit 1
+      end
+      count_elapsed_time
+    end
+
+    desc 'generate_report', 'Generate Traceability Metric and Coverage Report'
+    method_option :project_name, :aliases => "-p", :desc => "Project Name", :default => ""
+    method_option :milestone_name, :aliases => "-m", :desc => "Milestone Name", :default => ""
+    method_option :chromedriver_dir, :aliases => "-c", :desc => "Create report on TMS", default: "/testrail/chromedriver"
+    method_option :local, :aliases => "-l", :desc => "running from local", :type => :boolean, default: false
+    method_option :email_azure, :aliases => "-u", :desc => "user azure (inclue @azure.bukalapak.io)", :default => ""
+
+    def generate_report
+      ENV['CHROMEDRIVER'] = options[:chromedriver_dir]
+      puts options[:project_name]
+      puts options[:milestone_name]
+      begin
+        Preprocessing.execute_generate_report(options[:project_name], options[:milestone_name])
+      rescue => e
+        Log.error(e, options[:local])
+        exit 1
+      end
+      count_elapsed_time
+    end
+
+    desc 'capture_mr_result', 'Capture dashboard result for specific test'
+    method_option :project_name, :aliases => "-p", :desc => "Project Name", :default => ""
+    method_option :milestone_name, :aliases => "-m", :desc => "Milestone Name", :default => ""
+    method_option :chromedriver_dir, :aliases => "-c", :desc => "Chromedriver", default: "/testrail/chromedriver"
+    method_option :local, :aliases => "-l", :desc => "running from local", :type => :boolean, default: false
+    method_option :email_azure, :aliases => "-u", :desc => "user azure (inclue @azure.bukalapak.io)", :default => ""
+    method_option :gitlab_project_id, :aliases => "-g", :desc => "The ID of the current project", :default => ""
+    method_option :merge_request_iid, :aliases => "-i", :desc => "The project-level IID (internal ID) of the merge request. This ID is unique for the current project.", :default => ""
+
+    def capture_mr_result
+      ENV['CHROMEDRIVER'] = options[:chromedriver_dir]
+      begin
+        Preprocessing.execute_capture_result(options[:project_name], options[:milestone_name])
+        Mergerequest.post_image_to_mr(options[:gitlab_project_id], options[:merge_request_iid], options[:milestone_name])
+        Preprocessing.delete_milestones_runs(options[:project_name], options[:milestone_name])
+      rescue => e
+        Log.error(e, options[:local])
+        exit 1
+      end
+      count_elapsed_time
+    end
+
+    desc 'regression_prep', 'Regression preparation: milestone, test plans and test runs creation'
+    method_option :app_version, :aliases => "-v", :desc => "Release Version Name", :default => ""
+    method_option :app_name, :aliases => "-p", :desc => "App Release Name", :default => ""
+
+    def regression_prep
+      begin
+        Regression.execute_regression_prep(options[:app_name], options[:app_version])
+      rescue => e
+        Log.error(e, options[:local])
+        exit 1
+      end
+      count_elapsed_time
+    end
+
+    desc 'cucumber_feature_download', 'Downloads .feature files cucumber'
+    method_option :project_name, :aliases => "-p", :desc => "Project Name", :default => ""
+    method_option :suite_name, :aliases => "-t", :desc => "Test Type/Suite Name", :default => ""
+    method_option :section_name, :aliases => "-s", :desc => "Section Name", :default => ""
+    method_option :filter_label, :aliases => "-l", :desc => "Custom Label Filtering", :default => ""
+    method_option :milestone_name, :aliases => "-r", :desc => "Release Version of Test", :default => ""
+
+    def cucumber_feature_download
+      begin
+        puts "Project: " + options[:project_name]
+        puts "Suite: " + options[:suite_name]
+        puts "Section: " + options[:section_name]
+        puts "Label: " + options[:filter_label]
+        puts "------------------------------"
+        if !options[:milestone_name].nil? && !options[:milestone_name].empty?
+          run_id = Cucumber.create_test_run_microservice(
+            options[:project_name], 
+            options[:suite_name], 
+            options[:section_name], 
+            options[:filter_label], 
+            options[:milestone_name]
+          )
+          Cucumber.feature_download(run_id)
+        else
+          Cucumber.micr_download_feature_only(
+            options[:project_name], 
+            options[:suite_name], 
+            options[:section_name], 
+            options[:filter_label], 
+          )
+        end
+      rescue => e
+        Log.error(e, options[:local])
+        exit 1
+      end
+      count_elapsed_time
+    end
+
+    desc 'generate_password', 'Encrypt or Decrypt of a string with key'
+    method_option :method, :aliases => "-m", :desc => "Method", :default => "encrypt"
+    method_option :string_password, :aliases => "-p", :desc => "Password", :default => ""
+    method_option :string_key, :aliases => "-k", :desc => "Key", :default => ""
+
+    def generate_password
+      begin
+        pass = GeneratePassword.execute_generate_password(
+          options[:method], 
+          options[:string_password], 
+          options[:string_key]
+        )
+        puts 'password: ' + pass.to_s
+      rescue => e
+        Log.error(e, options[:local])
+        exit 1
+      end
+      count_elapsed_time
+    end
+
+    desc 'app_cucumber_feature_download', 'Downloads .feature files cucumber'
+    method_option :app_name, :aliases => "-p", :desc => "App Release Name", :default => ""
+    method_option :test_type, :aliases => "-t", :desc => "Test Type", :default => ""
+    method_option :squad, :aliases => "-s", :desc => "Squad Name", :default => ""
+    method_option :filter_label, :aliases => "-l", :desc => "Filter Label", :default => ""
+    method_option :environment_name, :aliases => "-e", :desc => "Environment Name", :default => ""
+    method_option :custom_section, :aliases => "-c", :desc => "Custom Section Run Name", :default => ""
+    method_option :pipeline_id, :aliases => "-i", :desc => "Pipeline ID", :default => ""
+
+    def app_cucumber_feature_download
+      begin
+        if options[:test_type] == 'regression'
+          run_id = Regression.get_latest_automation_run(
+            options[:app_name], 
+            options[:squad], 
+            options[:environment_name],
+            options[:custom_section]
+          )
+          Cucumber.feature_download(run_id)
+        else
+          Cucumber.app_download_feature_only(
+            options[:app_name], 
+            options[:squad], 
+            options[:environment_name],
+            options[:test_type],
+            options[:filter_label],
+            options[:custom_section], 
+          )
+        end
+      rescue => e
+        Log.error(e, options[:local])
+        exit 1
+      end
+      count_elapsed_time
+    end
+
+    desc 'delete_cases', 'Delete cases from specific section'
+    method_option :suite_id, :aliases => "-s", :desc => "suite id", :default => ""
+    method_option :group_name, :aliases => "-g", :desc => "group name", :default => ""
+    method_option :limit, :aliases => "-l", :desc => "limit for deleting in batch", :default => "10"
+
+    def delete_cases
+      begin
+        if options[:suite_id].eql?('') || options[:group_name].eql?('')
+          raise "No suite id or group name submitted. Please input mandatory parameter"
+        end
+        
+        Preprocessing.delete_cases_from_section(options[:suite_id], options[:group_name], options[:limit].to_i)
+      rescue => e
+        Log.error(e, options[:local])
+        exit 1
+      end
+      count_elapsed_time
+    end
+
+    desc 'post_feature', 'Create or update test cases to Testrail'
+    method_option :project_name, :aliases => "-p", :desc => "project name", :default => ""
+    method_option :scenario_dir, :aliases => "-d", :desc => "directory of scenarios", :default => ""
+
+    def post_feature
+      begin
+        Preprocessing.upload_feature(options[:scenario_dir])
+      rescue => e
+        Log.error(e, options[:local])
+        exit 1
+      end
+      count_elapsed_time
+    end
+
+    desc 'close_test_run', 'Close test run after test'
+    method_option :run_id, :aliases => "-r", :desc => "run id", :default => ""
+
+    def close_test_run
+      client = Dataprep.client_tr
+      Testrun.close_test_run(client, options[:run_id])
+    end
+
+    desc 'completed_milestone', 'Completed milestone after test'
+    method_option :milestone_id, :aliases => "-m", :desc => "milestone id", :default => ""
+
+    def completed_milestone
+      client = Dataprep.client_tr
+      Milestone.completed_milestone(client, options[:milestone_id])
+    end
+
+    desc 'clean_testrail', 'Completes milestones that started a specified number of months before the current date'
+    method_option :type, :aliases => "-t", :desc => "clean types", :required => true
+    method_option :prev_months, :aliases => "-m", :desc => "previous month", :required => true
+
+    def clean_testrail
+      client = Dataprep.client_tr
+      prev_month_to_i = options[:prev_months].to_i
+      prev_x_month = Dataprep.get_timestamp_prev_month(prev_month_to_i)
+      if options[:type].empty?
+        puts 'Fill the clean of types like milestone/plan/run'
+      else
+        case "#{options[:type]}"
+        when 'milestone'
+          Milestone.completed_milestone_months_before(client, prev_x_month)
+        when 'plan'
+          Testplan.close_test_plan_months_before(client, prev_x_month)
+        when 'run'
+          Testrun.close_test_run_months_before(client, prev_x_month)
+        else
+          puts "There is no type option: #{options[:type]}"
+        end
+      end
+    end
+
+    desc 'create_ac_to_tc', 'Migrate AC from Jira to Testrail'
+    method_option :jira_key, :aliases => "-k", :desc => "issue key", :required => true
+
+    def create_ac_to_tc
+      begin
+        client = Dataprep.client_tr
+        squad, hash_projects = AcceptanceCriteria.generate_features(options[:jira_key])
+        puts "squad: #{squad}"
+        puts "hash_projects: #{hash_projects}"
+        case_ids = AcceptanceCriteria.upload_tc_from_feature(options[:jira_key], squad, hash_projects)
+        puts "List Case IDs: #{case_ids}"
+        # AcceptanceCriteria.embed_tc_to_testrun(case_ids)
+      rescue => e
+        Log.error(e, options[:local])
+        exit 1
+      end
+      count_elapsed_time
+    end
+
+    desc 'update_ac_to_tc', 'Update AC from Jira to Testrail'
+    method_option :jira_key, :aliases => "-k", :desc => "issue key", :required => true
+
+    def update_ac_to_tc
+      begin
+        client = Dataprep.client_tr
+        AcceptanceCriteria.generate_features(options[:jira_key])
+      rescue => e
+        Log.error(e, options[:local])
+        exit 1
+      end
+      count_elapsed_time
+    end
+
+    no_commands do
+      def count_elapsed_time
+        ending = Process.clock_gettime(Process::CLOCK_MONOTONIC)
+        elapsed = ending - @starting
+        puts "Running time : #{elapsed}(s)"
+      end
+    end
+  end
+  Tms::CLI.start(ARGV)
+end

data/util/script/generate-password.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'optparse'
+require 'openssl'
+require 'base64'
+
+module Tms
+  module GeneratePassword
+    module_function
+
+		def execute_generate_password(method, password, key)
+			if method == nil
+				abort('put your method : encrypt or decrypt')
+			end
+			
+			if password == nil
+				abort('put your password or encrypt string')
+			end
+			
+			if key == nil
+				abort('put yout secret key')
+			end
+
+			if method.eql?'encrypt'
+				encrypt(password, key)
+			elsif method.eql?'decrypt'
+				decrypt(password, key)
+			else
+				abort('invalid method name : encrypt or decrypt')
+			end
+		end
+
+		def encrypt(str, key)
+			cipher = OpenSSL::Cipher.new('RC4')
+			cipher.decrypt
+			cipher.key = OpenSSL::Digest.digest('md5', key)
+			Base64.encode64(cipher.update(str) + cipher.final)
+		end
+
+		def decrypt(encrypted_string, key)
+			decipher = OpenSSL::Cipher.new('RC4')
+			decipher.decrypt
+			decipher.key = OpenSSL::Digest.digest('md5', key)
+			decipher.update(Base64.decode64(encrypted_string)) + decipher.final
+		end
+	end
+end

data/util/script/generatereport.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+require 'webdrivers'
+require 'openssl'
+require 'base64'
+require 'fileutils'
+require_relative './generate-password'
+
+module Tms
+  module GenerateReport
+    module_function
+
+    include GeneratePassword
+
+    def generate(project_id, milestone_name)
+      puts 'generate report...'
+      service = Selenium::WebDriver::Service.chrome(path: ENV['CHROMEDRIVER'])
+      options = Selenium::WebDriver::Chrome::Options.new
+      options.add_argument('--headless')
+      options.add_argument('--no-sandbox')
+      options.add_argument("--disable-extensions") 
+      options.add_argument("--disable-gpu") 
+      driver = Selenium::WebDriver.for :chrome, options: options, service: service
+      wait = Selenium::WebDriver::Wait.new(:timeout => 10)
+      driver.get("#{ENV['TR_BASEURL']}index.php?/auth/login")
+      driver.manage.window.maximize
+      login(driver, wait)
+      traceablity_report(driver, wait, project_id, milestone_name)
+      coverage_report(driver, wait, project_id, milestone_name)
+    end
+
+    def capture_dashboard(project_id, milestone_name)
+      service = Selenium::WebDriver::Service.chrome(path: ENV['CHROMEDRIVER'])
+      options = Selenium::WebDriver::Chrome::Options.new
+      options.add_argument('--headless')
+      options.add_argument('--no-sandbox')
+      options.add_argument("--disable-extensions") 
+      options.add_argument("--disable-gpu") 
+      options.add_argument("--window-size=1500,960")
+      driver = Selenium::WebDriver.for :chrome, options: options, service: service
+      wait = Selenium::WebDriver::Wait.new(:timeout => 10)
+      driver.get("#{ENV['TR_BASEURL']}index.php?/auth/login")
+      driver.manage.window.maximize
+      login(driver, wait)
+      screenshot_dashboard(driver, wait, project_id, milestone_name)
+    end
+    
+    def login(driver, wait)
+      driver.find_element(id: 'name').send_keys(ENV['TR_USERNAME'])
+      password = GeneratePassword.decrypt(ENV['TR_PASSWORD'], ENV['TR_SECRET'])
+      driver.find_element(id: 'password').send_keys(password)
+      driver.find_element(id: 'button_primary').click
+      wait.until { driver.find_element(id: 'navigation-dashboard')}
+    end
+    
+    def traceablity_report(driver, wait, project_id, milestone_name)
+      driver.get("#{ENV['TR_BASEURL']}index.php?/reports/overview/#{project_id}")
+      driver.find_element(xpath: "//*[@href='index.php?/reports/add_job/#{project_id}&plugin=references_case_coverage']").click
+      wait.until { driver.find_element(class: 'report-box-title')}
+      driver.find_element(id: 'name').clear
+      driver.find_element(id: 'name').send_keys("Traceability Report - #{milestone_name}")
+      driver.find_element(id: 'access_shared').click
+      driver.find_element(id: 'submit').click
+    end
+    
+    def coverage_report(driver, wait, project_id, milestone_name)
+      driver.get("#{ENV['TR_BASEURL']}index.php?/reports/overview/#{project_id}")
+      driver.find_element(xpath: "//*[@href='index.php?/reports/add_job/#{project_id}&plugin=milestones_summary']").click
+      wait.until { driver.find_element(class: 'report-box-title')}
+      driver.find_element(id: 'name').clear
+      driver.find_element(id: 'name').send_keys("Coverage Report - #{milestone_name}")
+      driver.execute_script("window.scrollTo(0, document.body.scrollHeight)")
+      driver.find_element(id: 'custom_milestones_id').click
+      driver.find_element(xpath: "//*[.='#{milestone_name}']").click
+      driver.find_element(id: 'access_shared').click
+      driver.find_element(id: 'submit').click
+    end
+
+    def screenshot_dashboard(driver, wait, project_id, milestone_name)
+      driver.get("#{ENV['TR_BASEURL']}index.php?/milestones/overview/#{project_id}")
+      
+      driver.find_element(xpath: "//*[text()[contains(.,'#{milestone_name}')]]").click
+      image = driver.find_element(id: 'content-inner')
+      ss_path = File.expand_path("../" + milestone_name + '.png')
+      sleep 3
+      image.save_screenshot ss_path
+      puts "Dashboard test result captured!"
+    end
+  end
+end

data/util/script/mergerequest.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+require 'gitlab'
+require_relative '../../lib/preprocessing'
+
+module Tms
+  module Mergerequest
+    module_function 
+
+    def client
+        Gitlab::Client.new(endpoint: ENV['GITLAB_API_ENDPOINT'], private_token: ENV['GITLAB_RAGABOT_API_TOKEN'])
+    end
+    
+    def post_image_to_mr(gitlab_project_id, merge_request_iid, milestone_name)
+      ss_path = File.expand_path("../" + milestone_name + '.png')
+      response = client.upload_file(gitlab_project_id, ss_path)
+
+      content_body = response['markdown']
+      comment_id = ragabot_comment_exists?(gitlab_project_id, merge_request_iid)
+      
+      if comment_id
+        puts "Updating report to merge request notes..."
+        client.delete_merge_request_note(gitlab_project_id,merge_request_iid, comment_id)
+        client.create_merge_request_note(gitlab_project_id, merge_request_iid, content_body)
+      else
+        puts "Post report to merge request notes..."
+        client.create_merge_request_note(gitlab_project_id, merge_request_iid, content_body)
+      end
+    end
+
+    def ragabot_comment_exists?(project_id, merge_request_id)
+      comments = client.merge_request_comments(project_id, merge_request_id)
+      comment = comments.select { |comment| comment['author']['username'] == "Ragabot" }.first
+      return comment['id'] if comment
+      return nil
+    end
+
+  end
+end