howitzer 1.0.2 → 1.1.0

data/generators/config/config_generator.rb

@@ -1,13 +1,13 @@
 require_relative '../base_generator'
 module Howitzer
   class ConfigGenerator < BaseGenerator
-      def manifest
-        { files:
-          [
-            { source: 'custom.yml', destination: 'config/custom.yml'},
-            { source: 'default.yml', destination: 'config/default.yml'}
-          ]
-        }
+    def manifest
+      { files:
+        [
+          { source: 'custom.yml', destination: 'config/custom.yml'},
+          { source: 'default.yml', destination: 'config/default.yml'}
+        ]
+      }
     end
 
     protected

data/generators/config/templates/custom.yml

@@ -1,4 +1,5 @@
 app_host: localhost:3000
+maximized_window: true
 driver: selenium
 sel_browser: chrome
 debug_mode: true

data/generators/config/templates/default.yml

@@ -19,13 +19,19 @@
 # TEST ENVIRONMENTS SETTINGS                              #
 ###########################################################
 
- # Specify one of the following drivers: selenium, selenium_dev, webkit, poltergeist, phantomjs, sauce, testingbot
- driver: poltergeist
+ # Specify maximized browser window size
+ maximized_window: false
+
+ # Specify one of the following drivers: selenium, selenium_dev, selenium_grid, webkit, poltergeist, phantomjs, sauce, testingbot, browserstack
+ driver: phantomjs
 
  # -Selenium-
- # specify one of next browsers: iexplore (ie), firefox (ff), chrome, opera
+ # specify one of next browsers: iexplore (ie), firefox (ff), chrome, opera, safari
  sel_browser: ff
 
+ # -Selenium Grid-
+ sel_hub_url: "http://example.com:4444/wd/hub"
+
  # -PhantomJS-
  # specify settings for poltergeist
  pjs_ignore_js_errors: false
@@ -53,6 +59,31 @@
  tb_idle_timeout: '180'
  tb_record_screenshot: false
 
+ # -BrowserStack
+ bs_user_name: bs_user
+ bs_password: bs_password
+ bs_url: "http://${bs_user_name}:${bs_password}@hub.browserstack.com/wd/hub"
+ bs_os_name: 'Windows'
+ bs_os_version: '8'
+ bs_browser_name: 'Firefox'
+ bs_browser_version: '16.0'
+ bs_resolution: '1024x768'
+ bs_max_duration: '1800'
+ bs_idle_timeout: '180'
+
+ # Run tests on mobile browsers
+ bs_mobile: false
+ bs_m_browser: 'iPhone'
+ bs_m_platform: 'MAC'
+ bs_m_device: 'iPhone 5'
+
+ bs_local: 'false'
+ bs_local_ID: 'Testing123'
+ bs_build: 'v1'
+ bs_project: 'Test Project'
+ bs_ssl: 'true'
+ bs_debug: 'false'
+
 ###########################################################
 # DATABASE SETTINGS                                       #
 ###########################################################
@@ -85,5 +116,4 @@
  timeout_tiny: 1
  timeout_short: 3
  timeout_small: 20
- timeout_medium: 60
-
+ timeout_medium: 60

data/generators/cucumber/templates/env.rb

@@ -14,7 +14,7 @@ if sauce_driver?
 end
 
 Before do |scenario|
-  log.print_feature_name(scenario.feature.title)
+  log.print_feature_name(scenario.feature.name)
   log.print_scenario_name(scenario.name)
   @session_start = duration(Time.now.utc - DataStorage.extract('sauce', :start_time))
 end
@@ -36,4 +36,4 @@ at_exit do
     log.info "SAUCE SERVER LOG URL: #{Capybara::Settings.sauce_resource_path('selenium-server.log')}"
     Capybara::Settings.update_sauce_job_status(passed: DataStorage.extract('sauce', :status))
   end
-end
+end

data/generators/cucumber/templates/transformers.rb

@@ -24,5 +24,7 @@ Transform /^table:.*$/ do |table|
       res
     end
   end
-  Cucumber::Ast::Table.new(raw)
+  location = Cucumber::Core::Ast::Location.of_caller
+  ast_table = Cucumber::Core::Ast::DataTable.new(raw, location)
+  Cucumber::MultilineArgument::DataTable.new(ast_table)
 end

data/generators/root/templates/Gemfile

@@ -1,5 +1,7 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
-gem 'howitzer' #, github: "strongqa/howitzer", branch: "develop"
-gem 'debugger'
+# Uncomment it if you are going to use 'webkit' driver. QT library should be installed. See https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit
+#
+# gem 'capybara-webkit'
 
+gem 'howitzer'

data/generators/root/templates/Rakefile

@@ -3,6 +3,8 @@ require 'rake/clean'
 require 'howitzer/settings'
 require 'howitzer/utils/log'
 
+load 'howitzer/tasks/framework.rake'
+
 Dir.chdir(File.join(File.dirname(__FILE__), '.'))
 
 if settings.required_clean_logs

data/generators/rspec/templates/example_spec.rb

@@ -1,7 +1,7 @@
 require 'spec_helper'
 
-feature "Some feature" do
-  scenario "test scenario" do
-    expect(true).to be_true
+RSpec.feature 'Some feature' do
+  scenario 'test scenario' do
+    expect(true).to be_truthy
   end
 end

data/generators/rspec/templates/spec_helper.rb

@@ -2,6 +2,8 @@ require 'rspec'
 require 'capybara/rspec'
 require_relative '../boot'
 
+Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].each{ |f| require f }
+
 RSpec.configure do |config|
   log.settings_as_formatted_text
 
@@ -12,21 +14,18 @@ RSpec.configure do |config|
   config.include Capybara::RSpecMatchers
   config.include DataGenerator
 
-  config.mock_with(:rspec){|c| c.syntax = :expect}
-  config.expect_with(:rspec) { |c| c.syntax = :expect }
-
-  config.color_enabled = true
-  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.disable_monkey_patching = true
+  config.color = true
 
   config.before(:all) do
     if sauce_driver?
-      suite_name = "#{(ENV['RAKE_TASK'] || 'CUSTOM').sub("rspec:", '').upcase} #{settings.sl_browser_name.upcase}"
+      suite_name = "#{(ENV['RAKE_TASK'] || 'CUSTOM').sub('rspec:', '').upcase} #{settings.sl_browser_name.upcase}"
       Capybara.drivers[:sauce][].options[:desired_capabilities][:name] = suite_name
     end
   end
 
   config.before(:each) do
-    log.print_scenario_name(example.description.empty? ? example.metadata[:full_description] : example.description)
+    log.print_scenario_name(RSpec.current_example.description.empty? ? RSpec.current_example.metadata[:full_description] : RSpec.current_example.description)
     @session_start = duration(Time.now.utc - DataStorage.extract('sauce', :start_time))
   end
 

data/howitzer.gemspec

@@ -2,42 +2,42 @@
 require File.expand_path('../lib/howitzer/version', __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Roman Parashchenko, Konstantin Lynda, Nikolay Zozulyak"]
-  gem.email         = ["strongqa@gmail.com"]
-  gem.description   = %q{Howitzer allows to generate a test project in 5 minutes. It uses the best practices and design patterns. It has out-of-the-box configurations for parallel cross-browser testing in the Cloud.}
+  gem.author        = 'Roman Parashchenko'
+  gem.email         = 'howitzer@strongqa.com'
+  gem.description   = %q{Howitzer uses the best practices and design patterns allowing to generate a test project in less than 5 minutes. It has out-of-the-box configurations for parallel cross-browser testing in the Cloud.}
   gem.summary       = %q{Ruby based framework for acceptance testing}
-  gem.homepage      = "https://github.com/strongqa/howitzer"
+  gem.homepage      = 'http://strongqa.github.io/howitzer/'
+  gem.license       = 'MIT'
 
   gem.bindir        = 'bin'
   gem.files         = `git ls-files`.split($\)
   gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
-  gem.name          = "howitzer"
-  gem.require_paths = ["lib"]
+  gem.name          = 'howitzer'
+  gem.require_paths = ['lib']
   gem.version       = Howitzer::VERSION
   gem.required_ruby_version = '>= 1.9.3'
 
-  gem.add_runtime_dependency 'nokogiri', '~> 1.6.2.rc2' if gem.platform.to_s =~ /mswin|mingw/
+  gem.add_runtime_dependency 'nokogiri', '~> 1.6' if gem.platform.to_s =~ /mswin|mingw/
   gem.add_runtime_dependency 'rake'
   gem.add_runtime_dependency 'gli'
-  gem.add_runtime_dependency 'i18n'
   gem.add_runtime_dependency 'syntax'
-  gem.add_runtime_dependency 'cucumber'
-  gem.add_runtime_dependency 'rspec', '~> 2.0'
+  gem.add_runtime_dependency 'cucumber', '~>2.0'
+  gem.add_runtime_dependency 'rspec', '~>3.2'
   gem.add_runtime_dependency 'sexy_settings'
   gem.add_runtime_dependency 'repeater'
   gem.add_runtime_dependency 'launchy'
-  gem.add_runtime_dependency 'log4r', '1.1.10'
+  gem.add_runtime_dependency 'log4r', '~>1.1.10'
   gem.add_runtime_dependency 'rest-client'
   gem.add_runtime_dependency 'poltergeist'
   gem.add_runtime_dependency 'rawler'
   gem.add_runtime_dependency 'capybara'
   gem.add_runtime_dependency 'selenium-webdriver'
-  gem.add_runtime_dependency 'activesupport', '~>4.0'
+  gem.add_runtime_dependency 'activesupport', '~>4.2'
   gem.add_runtime_dependency 'testingbot'
 
   gem.add_development_dependency('aruba')
-  gem.add_development_dependency("fuubar", [">= 0.0.1"])
-  gem.add_development_dependency("ffaker")
-
+  gem.add_development_dependency('fuubar')
+  gem.add_development_dependency('ffaker')
+  gem.add_development_dependency('yard')
 end

data/lib/howitzer/capybara/settings.rb

@@ -1,10 +1,7 @@
-##
-#
-# Predefined Capybara settings and capybara drivers
-#
 require 'selenium-webdriver'
 require 'capybara'
 require 'howitzer/utils/log'
+require 'howitzer/helpers'
 module Capybara
   module Settings
     extend self
@@ -20,11 +17,11 @@ module Capybara
 
     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_host
+      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_host
       profile
     end
 
@@ -36,7 +33,7 @@ module Capybara
       #
 
       def define_driver
-        case settings.driver.to_sym
+        case settings.driver.to_s.to_sym
           when :selenium
             define_selenium_driver
           when :selenium_dev
@@ -51,16 +48,39 @@ module Capybara
             define_sauce_driver
           when :testingbot
             define_testingbot_driver
+          when :browserstack
+            define_browserstack_driver
+          when :selenium_grid
+            define_selenium_grid_driver
           else
-            log.error "Unknown '#{settings.driver}' driver. Check your settings, it should be one of [selenium, selenium_dev, webkit, poltergeist, phantomjs, sauce, testingbot]"
+            log.error "Unknown '#{settings.driver}' driver. Check your settings, it should be one of [selenium, selenium_grid, selenium_dev, webkit, poltergeist, phantomjs, sauce, testingbot, browserstack]"
         end
       end
 
       private
+      def define_selenium_grid_driver
+        Capybara.register_driver :selenium_grid do |app|
+          caps = if ie_browser?
+            ::Selenium::WebDriver::Remote::Capabilities.internet_explorer
+          elsif ff_browser?
+            ::Selenium::WebDriver::Remote::Capabilities.firefox
+          elsif chrome_browser?
+            ::Selenium::WebDriver::Remote::Capabilities.chrome
+          elsif opera_browser?
+            ::Selenium::WebDriver::Remote::Capabilities.opera
+          elsif safari_browser?
+            ::Selenium::WebDriver::Remote::Capabilities.safari
+          else
+            log.error "Unknown '#{settings.sel_browser}' sel_browser. Check your settings, it should be one of [:ie, :iexplore, :ff, :firefox, :chrome, :opera, safari]"
+          end
+
+          Capybara::Selenium::Driver.new(app, :browser => :remote, :url => settings.sel_hub_url, :desired_capabilities => caps)
+        end
+      end
 
       def define_selenium_driver
         Capybara.register_driver :selenium do |app|
-          params = {browser: settings.sel_browser.to_sym}
+          params = {browser: settings.sel_browser.to_s.to_sym}
           params[:profile] = base_ff_profile_settings if ff_browser?
           Capybara::Selenium::Driver.new app, params
         end
@@ -80,12 +100,12 @@ module Capybara
             end
           end
           profile['extensions.firebug.currentVersion']    = 'Last' # avoid 'first run' tab
-          profile["extensions.firebug.previousPlacement"] = 1
-          profile["extensions.firebug.onByDefault"]       = true
-          profile["extensions.firebug.defaultPanelName"]  = "firepath"
-          profile["extensions.firebug.script.enableSites"] = true
-          profile["extensions.firebug.net.enableSites"] = true
-          profile["extensions.firebug.console.enableSites"] = true
+          profile['extensions.firebug.previousPlacement'] = 1
+          profile['extensions.firebug.onByDefault']       = true
+          profile['extensions.firebug.defaultPanelName']  = 'firepath'
+          profile['extensions.firebug.script.enableSites'] = true
+          profile['extensions.firebug.net.enableSites'] = true
+          profile['extensions.firebug.console.enableSites'] = true
 
           Capybara::Selenium::Driver.new app, browser: :firefox, profile: profile
         end
@@ -99,10 +119,10 @@ module Capybara
         require 'capybara/poltergeist'
         Capybara.register_driver :poltergeist do |app|
           Capybara::Poltergeist::Driver.new(
-              app, {
-              js_errors: !settings.pjs_ignore_js_errors,
-              phantomjs_options: ["--ignore-ssl-errors=#{settings.pjs_ignore_ssl_errors ? 'yes' : 'no'}" ]
-          }
+            app, {
+                 js_errors: !settings.pjs_ignore_js_errors,
+                 phantomjs_options: ["--ignore-ssl-errors=#{settings.pjs_ignore_ssl_errors ? 'yes' : 'no'}" ]
+               }
           )
         end
       end
@@ -111,36 +131,36 @@ module Capybara
         Capybara.register_driver :phantomjs do |app|
           Capybara::Selenium::Driver.new(
             app, browser: :phantomjs,
-                desired_capabilities: {
-                    javascript_enabled: !settings.pjs_ignore_js_errors
-                },
-                args: ["--ignore-ssl-errors=#{settings.pjs_ignore_ssl_errors ? 'yes' : 'no'}" ]
+            desired_capabilities: {
+              javascript_enabled: !settings.pjs_ignore_js_errors
+            },
+            args: ["--ignore-ssl-errors=#{settings.pjs_ignore_ssl_errors ? 'yes' : 'no'}" ]
           )
         end
       end
 
       def define_sauce_driver
-        task_name = ENV['RAKE_TASK'].to_s.sub(/(?:r?spec|cucumber):?(.*)/, '\1').upcase
+        task_name = rake_task_name
         caps_opts = {
-            platform: settings.sl_platform,
-            browser_name: settings.sl_browser_name,
-            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,
-            'record-screenshots' => settings.sl_record_screenshot,
-            'video-upload-on-pass' => settings.sl_video_upload_on_pass
+          platform: settings.sl_platform,
+          browser_name: settings.sl_browser_name,
+          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,
+          'record-screenshots' => settings.sl_record_screenshot,
+          'video-upload-on-pass' => settings.sl_video_upload_on_pass
         }
 
-        unless (settings.sl_browser_version.to_s || "").empty?
+        unless (settings.sl_browser_version.to_s || '').empty?
           caps_opts['version'] = settings.sl_browser_version.to_s
         end
 
         options = {
-            url: settings.sl_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
+          url: settings.sl_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 :sauce do |app|
@@ -155,7 +175,7 @@ module Capybara
 
       def define_testingbot_driver
         require 'testingbot'
-        task_name = ENV['RAKE_TASK'].to_s.sub(/(?:r?spec|cucumber):?(.*)/, '\1').upcase
+        task_name = rake_task_name
         caps_opts = {
           platform: settings.tb_platform,
           browser_name: settings.tb_browser_name,
@@ -168,7 +188,7 @@ module Capybara
         }
 
         unless (settings.tb_browser_version.to_s || "").empty?
-                  caps_opts['version'] = settings.tb_browser_version.to_s
+          caps_opts['version'] = settings.tb_browser_version.to_s
         end
         options = {
           url: settings.tb_url,
@@ -187,6 +207,49 @@ module Capybara
       end
     end
 
+    def define_browserstack_driver
+      task_name = rake_task_name
+      caps_opts = {
+          name: "#{ENV['RAKE_TASK'] ? (task_name.empty? ? 'ALL' : task_name) : 'CUSTOM'} #{settings.bs_mobile ? settings.bs_m_browser : settings.bs_browser_name.upcase}",
+          maxduration: settings.bs_max_duration.to_i,
+          idletimeout: settings.bs_idle_timeout.to_i,
+          project: settings.bs_project,
+          build: settings.bs_build,
+          resolution: settings.bs_resolution
+      }
+
+      if settings.bs_local
+        caps_opts['browserstack.local'] = settings.bs_local
+        caps_opts['browserstack.localIdentifier'] = settings.bs_local_ID
+      end
+
+      if settings.bs_mobile
+        caps_opts[:browserName] = settings.bs_m_browser
+        caps_opts[:platform] = settings.bs_m_platform
+        caps_opts[:device] = settings.bs_m_device
+      else
+        caps_opts[:os] = settings.bs_os_name
+        caps_opts[:os_version] = settings.bs_os_version
+        caps_opts[:browser] = settings.bs_browser_name
+        caps_opts[:browser_version] = settings.bs_browser_version
+      end
+
+      options = {
+          url: settings.bs_url,
+          desired_capabilities: ::Selenium::WebDriver::Remote::Capabilities.new(caps_opts),
+          browser: :remote
+      }
+      Capybara.register_driver :browserstack 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
+
     ##
     #
     # Returns url of current Sauce Labs job
@@ -230,11 +293,11 @@ module Capybara
 
     def suite_name
       res = if ENV['RAKE_TASK']
-        res = ENV['RAKE_TASK'].sub(/(?:r?spec|cucumber):?(.*)/, '\1').upcase
-        res.empty? ? 'ALL' : res
-      else
-        'CUSTOM'
-      end
+              res = ENV['RAKE_TASK'].sub(/(?:r?spec|cucumber):?(.*)/, '\1').upcase
+              res.empty? ? 'ALL' : res
+            else
+              'CUSTOM'
+            end
       "#{res} #{settings.sl_browser_name.upcase}"
     end
 
@@ -247,15 +310,28 @@ module Capybara
       Capybara.current_session.driver.browser.instance_variable_get(:@bridge).session_id
     end
 
+    ##
+    #
+    # Returns custom name for rake task
+    #
+    # *Returns:*
+    # * +string+ - Returns rake task name
+    #
+
+    def rake_task_name
+      ENV['RAKE_TASK'].to_s.sub(/(?:r?spec|cucumber):?(.*)/, '\1').upcase
+    end
+
     Capybara.run_server = false
     Capybara.app_host = ''
+    Capybara.asset_host = app_base_url
     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
+    Capybara.default_driver = settings.driver.to_s.to_sym
+    Capybara.javascript_driver = settings.driver.to_s.to_sym
 
     define_driver