cucumber_helper 0.0.5

data/lib/cucumber_helper/support/env_helper.rb

@@ -0,0 +1,114 @@
+module CucumberHelper
+  module Support
+    # create random report path and set the ENV['REPORT_PATH']
+    def create_report_path
+      report_root = File.absolute_path('./report')
+
+      if ENV['REPORT_PATH'].nil? || ENV['REPORT_PATH'] == ''
+        # clear report files
+        # this is same purpose with rake:clear_report on rakefile but run locally
+        puts '=====:: Delete report directory via env.rb'
+        FileUtils.rm_rf(report_root, secure: true)
+        FileUtils.mkdir_p report_root
+
+        # init report files
+        # this is same purpose with rake:init_report on rakefile but run locally
+        ENV['REPORT_PATH'] = Faker::Number.number(digits: 8).to_s
+        puts "=====:: about to create report #{ENV['REPORT_PATH']} via env.rb"
+      end
+
+      path = report_root.to_s
+      FileUtils.mkdir_p path
+      path
+    end
+
+    # create the browser and screenshot data to Path argument
+    # ENV['BROWSER'] = chrome_headless should make the chrome in headless mode
+    def create_browser(path)
+      browser_profile = Selenium::WebDriver::Chrome::Profile.new
+      browser_options = Selenium::WebDriver::Chrome::Options.new profile: browser_profile
+
+      setup_options(browser_options)
+      register_driver(browser_options)
+      setup_browser_screenshot(path)
+      setup_host
+    end
+
+    def headless(browser_options)
+      browser_options.add_argument('--headless=new')
+      browser_options.add_argument('--no-sandbox')
+      browser_options.add_argument('--disable-gpu')
+      browser_options.add_argument('--disable-dev-shm-usage')
+      browser_options.add_argument('--enable-features=NetworkService,NetworkServiceInProcess')
+    end
+
+    def setup_options(browser_options)
+      headless(browser_options) if ENV['BROWSER'].eql?('chrome_headless')
+      browser_options.add_preference('download.default_directory', File.absolute_path('./features/data/downloaded'))
+      browser_options.add_preference(:download, default_directory: File.absolute_path('./features/data/downloaded'))
+      browser_options.add_preference(:browser, set_download_behavior: { behavior: 'allow' })
+      browser_options.add_preference('plugins.always_open_pdf_externally', true)
+      browser_options.add_preference(:plugins, always_open_pdf_externally: true)
+      browser_options.add_preference('profile.geolocation.default_content_setting', 1)
+      browser_options.add_preference('profile.default_content_setting_values.geolocation', 1)
+    end
+
+    def register_driver(browser_options)
+      Capybara.register_driver :chrome do |app|
+        browser_options.add_argument('--window-size=1440,877')
+        browser_options.add_argument('--user-agent=selenium')
+
+        client = Selenium::WebDriver::Remote::Http::Default.new
+        client.open_timeout = 60
+        client.read_timeout = 300
+
+        Capybara::Selenium::Driver.new(
+          app,
+          browser: :chrome,
+          options: browser_options,
+          http_client: client
+        )
+      end
+
+      Capybara.default_driver = ENV['CI'] == 'true' ? :selenium : :chrome
+    end
+
+    # config rspec
+    def config_rspec
+      # try to add this to fix net::readtimeout but still no luck
+      RSpec.configure do |config|
+        # show retry status in spec process
+        config.verbose_retry = true
+        # Try twice (retry once)
+        config.default_retry_count = 2
+        # Only retry when Selenium raises Net::ReadTimeout
+        config.exceptions_to_retry = [Net::ReadTimeout]
+      end
+    end
+
+    # setup the how the browser take screenshot and its saved path
+    def setup_browser_screenshot(path)
+      Capybara::Screenshot.register_driver(:chrome) do |driver, dir|
+        driver.browser.save_screenshot dir
+      end
+      Capybara::Screenshot.autosave_on_failure = true
+      Capybara::Screenshot.prune_strategy = { keep: 50 }
+      Capybara::Screenshot.append_timestamp = true
+      Capybara::Screenshot.webkit_options = {
+        width: 1440,
+        height: 877
+      }
+      Capybara.save_path = "#{path}/screenshots"
+    end
+
+    # setup the browser base url and the timeout
+    def setup_host
+      # we use this when call .load function
+      Capybara.app_host = ENV['BASE_URL']
+      Capybara.default_max_wait_time = DEFAULT_TIMEOUT
+      Capybara.javascript_driver = :chrome
+      Selenium::WebDriver.logger.level = :debug
+      Selenium::WebDriver.logger.output = 'selenium.log'
+    end
+  end
+end

data/lib/cucumber_helper/support/hooks_helper.rb

@@ -0,0 +1,40 @@
+module CucumberHelper
+  module Support
+    # get the scenario tags into array of tags
+    def scn_tags(scenario)
+      scenario.source_tag_names
+    end
+
+    # capture screenshot if the scenario failed
+    def capture_screenshot(scenario)
+      return unless scenario.failed?
+
+      p 'test failed!'
+      p "Getting screen shoot in session #{Capybara.session_name}"
+      Capybara.using_session_with_screenshot(Capybara.session_name.to_s) do
+        # screenshots will work and use the correct session
+      end
+    end
+
+    # make scenario with @continue tag didn't delete its cookies/cache data
+    def handle_continue(scenario)
+      Capybara.session_name = :default
+
+      # if the scenario consist @continue tag, the session wont deleted
+      if scn_tags(scenario).include? '@continue'
+        Capybara.current_session.instance_variable_set(:@touched, false)
+      else
+        Capybara.current_session.driver.browser.manage.delete_all_cookies
+        Capybara.current_session.driver.browser.execute_script('localStorage.clear()')
+      end
+    end
+
+    # delete all downloaded file at ./features/data/downloaded
+    def delete_downloaded_file
+      return unless @downloaded_file.nil?
+
+      file = "#{File.absolute_path('./features/data/downloaded')}/#{@downloaded_file}"
+      File.delete(file) if File.file?(file)
+    end
+  end
+end

data/lib/cucumber_helper/support.rb

@@ -0,0 +1,4 @@
+require_relative './support/env_helper'
+require_relative './support/hooks_helper'
+
+include CucumberHelper::Support

data/lib/cucumber_helper/testrail/test_rail_integration.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# rubocop:disable Lint/UselessAssignment, /Lint/RescueException
+def update_result_in_test_rail(test_rail_url, user_name, access_key, run_id, case_ids, status)
+  b_flag = true
+  if test_rail_url.to_s.strip.empty? || user_name.to_s.strip.empty? || access_key.to_s.strip.empty? || run_id.to_s.strip.empty? || case_ids.to_s.strip.empty? || status.to_s.strip.empty?
+    puts 'Specified parameters is not correct, please re-check !'
+    puts "Specified Test Rail URL : #{test_rail_url}"
+    puts "Specified Test Rail User Name : #{user_name}"
+    puts "Specified Test Rail Access Key : #{access_key}"
+    puts "Specified Test Rail Run Id : #{run_id}"
+    puts "Specified Test Rail Case Id : #{case_ids}"
+    puts "Specified Test Rail Status : #{status}"
+  else
+    obj_test_rail = TestRail::APIClient.new(test_rail_url)
+    obj_test_rail.user = user_name
+    obj_test_rail.password = access_key
+    coll_case_ids = case_ids.split(',')
+    if status.casecmp('passed').zero?
+      result = { status_id: 1, comment: 'This scenarios marked as PASSED by DEADPOOL' }
+    elsif status.casecmp('failed').zero?
+      result = { status_id: 5, comment: 'This scenarios marked as FAILED by DEADPOOL' }
+    end
+    puts "Updating test run id #{run_id}"
+    coll_case_ids.each do |id|
+      add_results_uri = "add_result_for_case/#{run_id}/#{id}"
+      obj_test_rail.send_post(add_results_uri, result)
+    end
+  end
+rescue Exception => e
+  b_flag = false
+  puts "Error Occured In Uploading The results in Test Rail, Error is : #{e.message}"
+  b_flag
+end
+
+def test_rail_integration(arg_run_id, arg_case_ids, arg_status)
+  file_name = "#{Dir.pwd}/features/config/test_rail.yml"
+  test_rail_file = YAML.load_file(file_name)
+  url = test_rail_file['url']
+  user_name = test_rail_file['user_name']
+  access_key = test_rail_file['access_key']
+  if arg_status.empty? || arg_status.nil?
+    puts 'No result retrieved'
+  elsif update_result_in_test_rail(url, user_name, access_key, arg_run_id, arg_case_ids, arg_status)
+    puts "Result uploaded in Test Rail with case id #{arg_case_ids} Successfully!"
+  else
+    puts "Result uploaded in Test Rail with case id #{arg_case_ids} Failed!"
+  end
+rescue Exception => e
+  puts "Error Occured in Test Rail Integration, Error Desc is : #{e.message}"
+end
+# rubocop:enable Lint/UselessAssignment

data/lib/cucumber_helper/testrail/testrail.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'net/https'
+require 'uri'
+require 'json'
+
+module TestRail
+  class APIClient
+    @url = ''
+    @user = ''
+    @password = ''
+
+    attr_accessor :user, :password
+
+    def initialize(base_url)
+      base_url += '/' unless base_url =~ %r{/$}
+      @url = "#{base_url}index.php?/api/v2/"
+    end
+
+    def send_get(uri, data = nil)
+      _send_request('GET', uri, data)
+    end
+
+    def send_post(uri, data)
+      _send_request('POST', uri, data)
+    end
+
+    private
+
+    def _send_request(method, uri, data)
+      url = URI.parse(@url + uri)
+      if method == 'POST'
+        request = Net::HTTP::Post.new("#{url.path}?#{url.query}")
+        if uri.start_with?('add_attachment')
+          # SOURCE: https://yukimotopress.github.io/http
+          boundary = 'TestRailAPIAttachmentBoundary'
+          post_body = []
+          post_body << "--#{boundary}\r\n"
+          post_body << "Content-Disposition: form-data; name=\"attachment\"; filename=\"#{File.basename(data)}\"\r\n"
+          post_body << "\r\n"
+          post_body << File.read(data)
+          post_body << "\r\n--#{boundary}--\r\n"
+
+          request.body = post_body.join
+          request['Content-Type'] = "multipart/form-data; boundary=#{boundary}"
+        else
+          request['Content-Type'] = 'application/json'
+          request.body = JSON.dump(data)
+        end
+      else
+        request = Net::HTTP::Get.new("#{url.path}?#{url.query}")
+        request['Content-Type'] = 'application/json'
+      end
+      request.basic_auth(@user, @password)
+
+      conn = Net::HTTP.new(url.host, url.port)
+      if url.scheme == 'https'
+        conn.use_ssl = true
+        conn.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      end
+      response = conn.request(request)
+
+      if response.body && !response.body.empty? && (response.code == '200')
+        if uri.start_with?('get_attachment/')
+          File.write(data, response.body)
+          result = data
+        else
+          result = JSON.parse(response.body)
+        end
+      else
+        result = {}
+      end
+
+      if response.code != '200'
+        error = if result.key?('error')
+                  "\"#{result['error']}\""
+                else
+                  'No additional error message received'
+                end
+        raise APIError, format('TestRail API returned HTTP %<code>s (%<error>s)', { code: response.code, error: error })
+      end
+      result
+    end
+  end
+
+  class APIError < StandardError; end
+end

data/lib/cucumber_helper/version.rb

@@ -0,0 +1,5 @@
+module CucumberHelper
+  module VERSION
+    STRING = '0.0.5'.freeze
+  end
+end