howitzer 0.0.3 → 1.0.1

data/lib/howitzer.rb

@@ -1,4 +1,5 @@
 require "howitzer/version"
+require "howitzer/settings"
 require 'howitzer/utils'
 require 'howitzer/init'
 require 'howitzer/helpers'

data/lib/howitzer/helpers.rb

@@ -1,17 +1,38 @@
+DriverNotSpecified = Class.new(StandardError)
+SlBrowserNameNotSpecified = Class.new(StandardError)
+TbBrowserNameNotSpecified = Class.new(StandardError)
+SelBrowserNotSpecified = Class.new(StandardError)
+CHECK_YOUR_SETTINGS_MSG = "Please check your settings"
+DRIVER_NOT_SPECIFIED = DriverNotSpecified.new(CHECK_YOUR_SETTINGS_MSG)
+SL_BROWSER_NAME_NOT_SPECIFIED = SlBrowserNameNotSpecified.new(CHECK_YOUR_SETTINGS_MSG)
+TB_BROWSER_NAME_NOT_SPECIFIED = TbBrowserNameNotSpecified.new(CHECK_YOUR_SETTINGS_MSG)
+SEL_BROWSER_NOT_SPECIFIED = SelBrowserNotSpecified.new(CHECK_YOUR_SETTINGS_MSG)
 
 def sauce_driver?
+  raise DRIVER_NOT_SPECIFIED if settings.driver.nil?
   settings.driver.to_sym == :sauce
 end
 
+def testingbot_driver?
+  raise DRIVER_NOT_SPECIFIED if settings.driver.nil?
+  settings.driver.to_sym == :testingbot
+end
+
 def selenium_driver?
+  raise DRIVER_NOT_SPECIFIED if settings.driver.nil?
   settings.driver.to_sym == :selenium
 end
 
 def ie_browser?
   ie_browsers = [:ie, :iexplore]
   if sauce_driver?
+    raise SL_BROWSER_NAME_NOT_SPECIFIED if settings.sl_browser_name.nil?
     ie_browsers.include?(settings.sl_browser_name.to_sym)
+  elsif testingbot_driver?
+    raise TB_BROWSER_NAME_NOT_SPECIFIED if settings.tb_browser_name.nil?
+    ie_browsers.include?(settings.tb_browser_name.to_sym)
   elsif selenium_driver?
+    raise SEL_BROWSER_NOT_SPECIFIED if settings.sel_browser.nil?
     ie_browsers.include?(settings.sel_browser.to_sym)
   end
 end
@@ -19,22 +40,58 @@ end
 def ff_browser?
   ff_browsers = [:ff, :firefox]
   if sauce_driver?
+    raise SL_BROWSER_NAME_NOT_SPECIFIED if settings.sl_browser_name.nil?
     ff_browsers.include?(settings.sl_browser_name.to_sym)
+  elsif testingbot_driver?
+    raise TB_BROWSER_NAME_NOT_SPECIFIED if settings.tb_browser_name.nil?
+    ff_browsers.include?(settings.tb_browser_name.to_sym)
   elsif selenium_driver?
+    raise SEL_BROWSER_NOT_SPECIFIED if settings.sel_browser.nil?
     ff_browsers.include?(settings.sel_browser.to_sym)
   end
 end
 
+
 def chrome_browser?
   chrome_browser = :chrome
   if sauce_driver?
+    raise SL_BROWSER_NAME_NOT_SPECIFIED if settings.sl_browser_name.nil?
     settings.sl_browser_name.to_sym == chrome_browser
-  elsif
+  elsif testingbot_driver?
+    raise TB_BROWSER_NAME_NOT_SPECIFIED if settings.tb_browser_name.nil?
+    settings.tb_browser_name.to_sym == chrome_browser
+  elsif selenium_driver?
+    raise SEL_BROWSER_NOT_SPECIFIED if settings.sel_browser.nil?
     settings.sel_browser.to_sym == chrome_browser
   end
 end
 
 
+##
+#
+# Returns application url including base authentication (if specified in settings)
+#
+
+def app_url                         
+  prefix = settings.app_base_auth_login.blank? ? '' : "#{settings.app_base_auth_login}:#{settings.app_base_auth_pass}@"
+  app_base_url prefix
+end
+
+##
+# Returns application url without base authentication by default
+#
+# *Parameters:*
+# * +prefix+ - Sets base authentication prefix (defaults to: nil)
+#
+
+def app_base_url(prefix=nil)
+  "#{settings.app_protocol || 'http'}://#{prefix}#{settings.app_host}"
+end
+
+# *Parameters:*
+# * +time_in_numeric+ - Number of seconds
+#
+
 def duration(time_in_numeric)
   secs = time_in_numeric.to_i
   mins = secs / 60
@@ -48,20 +105,48 @@ def duration(time_in_numeric)
   end
 end
 
+##
+#
+# Evaluates given value
+#
+# *Parameters:*
+# * +value+ - Value to be evaluated
+#
+
 def ri(value)
   raise value.inspect
 end
 
 class String
+
+  ##
+  #
+  # Delegates WebPage.open method. Useful in cucumber step definitions
+  #
+  # *Parameters:*
+  # * +*args+ - Url to be opened
+  #
+
   def open(*args)
     as_page_class.open(*args)
   end
 
+  ##
+  #
+  # Returns page instance
+  #
+
+
   def given
     as_page_class.new
   end
 
+  ##
+  #
+  # Returns page class
+  #
+
   def as_page_class
     Object.const_get("#{self.capitalize}Page")
   end
-end
+end

data/lib/howitzer/init.rb

@@ -1,5 +1,4 @@
 include DataGenerator
-include Capybara::DSL #TODO should be included to webpage instead of global content
 
 # Configure mail client
 Mailgun::init(settings.mailgun_api_key)

data/lib/howitzer/patches/rawler_patched.rb

@@ -0,0 +1,86 @@
+module Rawler
+  class Base
+    def record_response(code, link, from_url, redirection=nil)
+      message = "#{code} - #{link}"
+
+      if code.to_i >= 300
+        message += " - Called from: #{from_url}"
+      end
+
+      message += " - Following redirection to: #{redirection}" if redirection
+      log_fields = {code: code, link: link, message: message}
+
+      code = code.to_i
+      case code / 100
+        when 1,2
+          Rawler.output.info(message)
+          add_xml_log_item(log_fields) if settings.add_rawler_xml_log
+          add_html_log_item(log_fields) if settings.add_rawler_html_log
+        when 3 then
+          Rawler.output.warn(message)
+          add_xml_log_item(log_fields) if settings.add_rawler_xml_log
+          add_html_log_item(log_fields) if settings.add_rawler_html_log
+        when 4,5 then
+          Rawler.output.error(message)
+          log_fields[:failed] = true
+          add_xml_log_item(log_fields) if settings.add_rawler_xml_log
+          add_html_log_item(log_fields) if settings.add_rawler_html_log
+        else
+          Rawler.output.error("Unknown code #{message}")
+          log_fields[:failed] = true
+          log_fields[:message] = "Unknown code #{message}"
+          add_xml_log_item(log_fields) if settings.add_rawler_xml_log
+          add_html_log_item(log_fields) if settings.add_rawler_html_log
+      end
+      @logfile.puts(message) if Rawler.log
+    end
+
+    def add_xml_log_item(fields)
+      log_file_path = File.expand_path(settings.rawler_xml_log, "#{settings.log_dir}")
+
+      doc = File.exists?(log_file_path) ? Nokogiri::XML::Document.parse(File.read log_file_path) : Nokogiri::XML::Document.new
+
+      doc.encoding = 'UTF-8'
+
+      if doc.root
+        tests = doc.root > ("testcase")
+        failures = doc.root > ("testcase failure")
+        doc.root[:failures] = failures.to_a.size.to_s
+        doc.root[:tests] = tests.to_a.size.to_s
+        doc.root[:time] = "#{tests.to_a.size} sec."
+      else
+        root = doc.create_element('testsuite')
+        root[:errors] = "0"
+        root[:failures] = "0"
+        root[:name] = "Check links"
+        root[:skipped] = "0"
+        root[:tests] = "0"
+        root[:time] = "0 sec."
+        doc.root = root
+      end
+
+      testcase = doc.create_element('testcase')
+      testcase[:classname] = "Check links"
+      testcase[:name] = "Check: link '#{fields[:link]}'"
+      testcase[:time] = "1"
+
+      if fields[:failed]
+        failure = doc.create_element('failure', message: "Failed responce code: '#{fields[:code]}'", type:'failed')
+        failure << doc.create_cdata("#{fields[:message]}")
+        testcase << failure
+      end
+
+      testcase << doc.create_element('system-out')
+      testcase << doc.create_element('system-err')
+      doc.root << testcase
+
+      File.open(log_file_path, 'w+') do |f|
+        f.write(doc.serialize(:encoding => 'UTF-8', :save_with => Nokogiri::XML::Node::SaveOptions::FORMAT))
+      end
+    end
+
+    def add_html_log_item(fields)
+      #Todo: should be implemented
+    end
+  end
+end

data/lib/howitzer/settings.rb

@@ -0,0 +1,27 @@
+require 'sexy_settings'
+
+SexySettings.configure do |config|
+  config.path_to_default_settings = File.expand_path("config/default.yml", Dir.pwd)
+  config.path_to_custom_settings = File.expand_path("config/custom.yml", Dir.pwd)
+end
+
+##
+#
+# Returns settings as singleton object
+#
+# *Example:*
+#
+# +settings.app_host+
+
+def settings
+  SexySettings::Base.instance
+end
+
+##
+#
+# Returns logger as singleton object
+#
+
+def log
+  Howitzer::Log.instance
+end

data/lib/howitzer/utils.rb

@@ -1,14 +1,5 @@
-require 'sexy_settings'
 require 'repeater'
+require 'capybara'
+require 'selenium-webdriver'
 
-SexySettings.configure do |config|
-  config.path_to_default_settings = File.expand_path("config/default.yml", Dir.pwd)
-  config.path_to_custom_settings = File.expand_path("config/custom.yml", Dir.pwd)
-end
-
-def settings
-  SexySettings::Base.instance()
-end
-
-
-Dir[File.join(File.dirname(__FILE__), "./utils/**/*.rb")].each {|f| require f}
+Dir[File.join(File.dirname(__FILE__), "./utils/**/*.rb")].each {|f| require f}

data/lib/howitzer/utils/capybara_patched.rb

@@ -12,11 +12,12 @@ module CapybaraPatched
         class_eval <<-RUBY
         def #{method}(*args, &block)
           retryable(tries:3, logger: log, trace: true, on: RETRY_ON) do
-            current_node.send(:#{method}, *args.flatten, &block)
+            @touched = true
+            current_scope.send(:#{method}, *args.flatten, &block)
           end
         end
         RUBY
       end
     end
   end
-end
+end

data/lib/howitzer/utils/capybara_settings.rb

@@ -1,37 +1,81 @@
-require 'howitzer/utils/logger'
+##
+#
+# Predefined Capybara settings and capybara drivers
+#
+
+require 'howitzer/utils/log'
 module CapybaraSettings
   extend self
 
+  ##
+  #
+  # Predefined settings of Firefox browser
+  #
+  # *Returns:*
+  # * +Hash+ - Settings that can be changed
+  #
+
+
   def self.base_ff_profile_settings
     profile = Selenium::WebDriver::Firefox::Profile.new
     profile["network.http.phishy-userpass-length"] = 255
     profile["browser.safebrowsing.malware.enabled"] = false
     profile["network.automatic-ntlm-auth.allow-non-fqdn"] = true
     profile["network.ntlm.send-lm-response"] = true
-    profile["network.automatic-ntlm-auth.trusted-uris"] = settings.app_main_host
+    profile["network.automatic-ntlm-auth.trusted-uris"] = settings.app_host
     profile
   end
 
-  Capybara.run_server = false
-  Capybara.app_host = ''
-  Capybara.default_wait_time = settings.timeout_small
-  Capybara.ignore_hidden_elements = true
-  case settings.driver.to_sym
-    when :selenium
+  class << self
+
+    ##
+    #
+    #Defines driver based on specified test environment settings
+    #
+
+    def define_driver
+      case settings.driver.to_sym
+        when :selenium
+          define_selenium_driver
+        when :selenium_dev
+          define_selenium_dev_driver
+        when :webkit
+          define_webkit_driver
+        when :poltergeist
+          define_poltergeist_driver
+        when :sauce
+          define_sauce_driver
+        when :testingbot
+          define_testingbot_driver
+        else
+          log.error "Unknown '#{settings.driver}' driver. Check your settings, it should be one of [selenium, selenium_dev, webkit, sauce, testingbot]"
+      end
+    end
+
+    private
+
+    def define_selenium_driver
       Capybara.register_driver :selenium do |app|
         params = {browser: settings.sel_browser.to_sym}
         params[:profile] = base_ff_profile_settings if ff_browser?
         Capybara::Selenium::Driver.new app, params
       end
-    when :selenium_dev
+    end
+
+    def define_selenium_dev_driver
       Capybara.register_driver :selenium_dev do |app|
         profile = base_ff_profile_settings
-        fb_name = "firebug-#{settings.sel_firebug_version}-fx.xpi"
-        fp_name = "firepath-#{settings.sel_firepath_version}.xpi"
-        [fb_name, fp_name].each do |name|
-          profile.add_extension(File.expand_path(name, File.join('shared', 'vendor', 'firebug')))
+        vendor_dir = settings.custom_vendor_dir || File.join(File.dirname(__FILE__), '..', 'vendor')
+        raise "Vendor directory was not found('#{vendor_dir}')." unless Dir.exist?(vendor_dir)
+        %w(firebug*.xpi firepath*.xpi).each do |file_name|
+          full_path_pattern = File.join(File.expand_path(vendor_dir), file_name)
+          if (full_path = Dir[full_path_pattern].first)
+            profile.add_extension full_path
+          else
+            raise "Extension was not found by '#{full_path_pattern}' pattern!"
+          end
         end
-        profile['extensions.firebug.currentVersion']    = settings.sel_firebug_version # avoid 'first run' tab
+        profile['extensions.firebug.currentVersion']    = 'Last' # avoid 'first run' tab
         profile["extensions.firebug.previousPlacement"] = 1
         profile["extensions.firebug.onByDefault"]       = true
         profile["extensions.firebug.defaultPanelName"]  = "firepath"
@@ -41,18 +85,30 @@ module CapybaraSettings
 
         Capybara::Selenium::Driver.new app, browser: :firefox, profile: profile
       end
-    when :webkit
+    end
+
+    def define_webkit_driver
       require 'capybara-webkit'
-    when :poltergeist
+    end
+
+    def define_poltergeist_driver
       require 'capybara/poltergeist'
       Capybara.register_driver :poltergeist do |app|
-        Capybara::Poltergeist::Driver.new(app, settings.poltergeist_settings)
+        Capybara::Poltergeist::Driver.new(
+            app, {
+            js_errors: !settings.pjs_ignore_js_errors,
+            phantomjs_options: ["--ignore-ssl-errors=#{settings.pjs_ignore_ssl_errors ? 'yes' : 'no'}" ]
+        }
+        )
       end
-    when :sauce
+    end
+
+    def define_sauce_driver
+      task_name = ENV['RAKE_TASK'].to_s.sub(/(?:r?spec|cucumber):?(.*)/, '\1').upcase
       caps_opts = {
           platform: settings.sl_platform,
           browser_name: settings.sl_browser_name,
-          name: 'Capybara test name should be overwritten',
+          name: "#{ENV['RAKE_TASK'] ? (task_name.empty? ? 'ALL' : task_name) : 'CUSTOM'} #{settings.sl_browser_name.upcase}",
           "max-duration" => settings.sl_max_duration,
           'idle-timeout' => settings.sl_idle_timeout,
           'selenium-version' => settings.sl_selenium_version,
@@ -72,15 +128,59 @@ module CapybaraSettings
       }
 
       Capybara.register_driver :sauce do |app|
-        Capybara::Selenium::Driver.new(app, options)
+        driver = Capybara::Selenium::Driver.new(app, options)
+        driver.browser.file_detector = lambda do |args|
+          str = args.first.to_s
+          str if File.exist?(str)
+        end
+        driver
       end
+    end
 
-    else
-      log.error "Unknown '#{settings.driver}' driver. Check your settings, it should be one of [selenium, selenium_dev, webkit, sauce]"
+    def define_testingbot_driver
+      require 'testingbot'
+      task_name = ENV['RAKE_TASK'].to_s.sub(/(?:r?spec|cucumber):?(.*)/, '\1').upcase
+      caps_opts = {
+        platform: settings.tb_platform,
+        browser_name: settings.tb_browser_name,
+        name: "#{ENV['RAKE_TASK'] ? (task_name.empty? ? 'ALL' : task_name) : 'CUSTOM'} #{settings.tb_browser_name.upcase}",
+        maxduration: settings.tb_max_duration.to_i,
+        idletimeout: settings.tb_idle_timeout.to_i,
+        'selenium-version' => settings.tb_selenium_version,
+        screenshot: settings.tb_record_screenshot,
+        'avoid-proxy' => settings.tb_avoid_proxy
+      }
+
+      unless (settings.tb_browser_version.to_s || "").empty?
+                caps_opts['version'] = settings.tb_browser_version.to_s
+      end
+      options = {
+        url: settings.tb_url,
+        desired_capabilities: Selenium::WebDriver::Remote::Capabilities.new(caps_opts),
+        http_client: Selenium::WebDriver::Remote::Http::Default.new.tap{|c| c.timeout = settings.timeout_medium},
+        browser: :remote
+      }
+      Capybara.register_driver :testingbot do |app|
+        driver = Capybara::Selenium::Driver.new(app, options)
+        driver.browser.file_detector = lambda do |args|
+          str = args.first.to_s
+          str if File.exist?(str)
+        end
+        driver
+      end
+    end
   end
 
-  Capybara.default_driver = settings.driver.to_sym
-  Capybara.javascript_driver = settings.driver.to_sym
+  ##
+  #
+  # Returns url of current Sauce Labs job
+  #
+  # *Parameters:*
+  # * +name+ - Your account name
+  #
+  # *Returns:*
+  # * +string+ - URL address of last running Sauce Labs job
+  #
 
   def sauce_resource_path(name)
     host = "https://#{settings.sl_user}:#{settings.sl_api_key}@saucelabs.com"
@@ -88,6 +188,15 @@ module CapybaraSettings
     "#{host}#{path}"
   end
 
+  ##
+  #
+  # Sends http request to change current Sauce Labs job status - pass/fail
+  #
+  # *Parameters:*
+  # * +json_data+ - test status as hash (for details see Saucelab documentation)
+  #
+
+
   def update_sauce_job_status(json_data = {})
     host = "http://#{settings.sl_user}:#{settings.sl_api_key}@saucelabs.com"
     path = "/rest/v1/#{settings.sl_user}/jobs/#{session_id}"
@@ -95,6 +204,14 @@ module CapybaraSettings
     RestClient.put url, json_data.to_json, content_type: :json, accept: :json
   end
 
+  ##
+  #
+  # Returns custom name for Sauce Labs job
+  #
+  # *Returns:*
+  # * +string+ - Return name of current Sauce Labs job
+  #
+
   def suite_name
     res = if ENV['RAKE_TASK']
       res = ENV['RAKE_TASK'].sub(/(?:r?spec|cucumber):?(.*)/, '\1').upcase
@@ -105,9 +222,26 @@ module CapybaraSettings
     "#{res} #{settings.sl_browser_name.upcase}"
   end
 
+  ##
+  #
+  # Returns current session id
+  #
+
   def session_id
     Capybara.current_session.driver.browser.instance_variable_get(:@bridge).session_id
   end
 
+  Capybara.run_server = false
+  Capybara.app_host = ''
+  Capybara.default_wait_time = settings.timeout_small
+  Capybara.ignore_hidden_elements = true
+  Capybara.visible_text_only = true
+  Capybara.match = :one
+  Capybara.exact_options = true
+  Capybara.default_driver = settings.driver.to_sym
+  Capybara.javascript_driver = settings.driver.to_sym
+
+  define_driver
+
 end