howitzer 2.0.3 → 2.1.0

data/features/cli_version.feature

@@ -2,7 +2,7 @@ Feature: Howitzer CLI Version
 
   Scenario Outline: Run with version global option
     When I run `howitzer <option>`
-    Then the output should contain exactly:
+    Then the output should be exactly:
     """
     howitzer version <HOWITZER_VERSION>
 

data/features/step_definitions/common_steps.rb

@@ -27,3 +27,8 @@ Given /^created old howitzer project based on turnip$/ do
   FileUtils.move(Dir.glob("#{expand_path('.')}/test_automation/*"), expand_path('.'))
   FileUtils.remove_dir File.join(expand_path('.'), 'test_automation'), true
 end
+
+Then 'the output should be exactly:' do |text|
+  text.gsub!('<HOWITZER_VERSION>', Howitzer::VERSION)
+  step 'the output should contain exactly:', text
+end

data/generators/base_generator.rb

@@ -1,3 +1,4 @@
+require 'colorized_string'
 require 'fileutils'
 require 'erb'
 require 'ostruct'
@@ -29,7 +30,7 @@ module Howitzer
     end
 
     def print_banner
-      logger.puts banner unless banner.empty?
+      logger.puts ColorizedString.new(banner.chomp).light_cyan unless banner.empty?
     end
 
     def print_info(data)
@@ -41,7 +42,7 @@ module Howitzer
     end
 
     def puts_error(data)
-      logger.puts "      ERROR: #{data}"
+      logger.puts ColorizedString.new("      ERROR: #{data}").red
     end
   end
 
@@ -88,7 +89,8 @@ module Howitzer
           copy_templates_file_exist(data, destination_path, source_path)
         else
           write_template(destination_path, source_path)
-          puts_info "Added template '#{data[:source]}' with params '#{@options}' to destination '#{data[:destination]}'"
+          puts_info "#{ColorizedString.new('Added').light_green} template '#{data[:source]}' with"\
+                    " params '#{@options}' to destination '#{data[:destination]}'"
         end
       end
     end
@@ -103,14 +105,13 @@ module Howitzer
     end
 
     def copy_with_path(data)
-      src = source_path(data[:source])
-      dst = dest_path(data[:destination])
+      src, dst = get_source_and_destination(data)
       FileUtils.mkdir_p(File.dirname(dst))
       if File.exist?(dst)
         copy_with_path_file_exist(data, src, dst)
       else
         FileUtils.cp(src, dst)
-        puts_info("Added '#{data[:destination]}' file")
+        puts_info("#{ColorizedString.new('Added').light_green} '#{data[:destination]}' file")
       end
     rescue => e
       puts_error("Impossible to create '#{data[:destination]}' file. Reason: #{e.message}")
@@ -118,24 +119,37 @@ module Howitzer
 
     def write_template(dest_path, source_path)
       File.open(dest_path, 'w+') do |f|
-        f.write(ERB.new(File.open(source_path, 'r').read).result(OpenStruct.new(@options).instance_eval { binding }))
+        f.write(ERB.new(File.open(source_path, 'r').read, nil, '-')
+         .result(OpenStruct.new(@options).instance_eval { binding }))
       end
     end
 
     private
 
+    def get_source_and_destination(data)
+      [source_path(data[:source]), dest_path(data[:destination])]
+    end
+
+    def conflict_file_msg(data)
+      ColorizedString.new("Conflict with '#{data[:destination]}' file").yellow
+    end
+
+    def overwrite_file_msg(data)
+      ColorizedString.new("  Overwrite '#{data[:destination]}' file? [Yn]:").yellow
+    end
+
     def copy_templates_file_exist(data, destination_path, source_path)
-      puts_info("Conflict with '#{data[:destination]}' template")
-      print_info("  Overwrite '#{data[:destination]}' template? [Yn]:")
+      puts_info(ColorizedString.new("Conflict with '#{data[:destination]}' template").yellow)
+      print_info(ColorizedString.new("  Overwrite '#{data[:destination]}' template? [Yn]:").yellow)
       copy_templates_overwrite(gets.strip.downcase, data, destination_path, source_path)
     end
 
     def copy_with_path_file_exist(data, source, destination)
       if FileUtils.identical?(source, destination)
-        puts_info("Identical '#{data[:destination]}' file")
+        puts_info("#{ColorizedString.new('Identical').light_green} '#{data[:destination]}' file")
       else
-        puts_info("Conflict with '#{data[:destination]}' file")
-        print_info("  Overwrite '#{data[:destination]}' file? [Yn]:")
+        puts_info(conflict_file_msg(data))
+        print_info(overwrite_file_msg(data))
         copy_with_path_overwrite(gets.strip.downcase, data, source, destination)
       end
     end
@@ -144,9 +158,9 @@ module Howitzer
       case answer
         when 'y'
           write_template(destination_path, source_path)
-          puts_info("    Forced '#{data[:destination]}' template")
+          puts_info("    #{ColorizedString.new('Forced').light_green} '#{data[:destination]}' template")
         when 'n'
-          puts_info("    Skipped '#{data[:destination]}' template")
+          puts_info("    #{ColorizedString.new('Skipped').light_black} '#{data[:destination]}' template")
         else nil
       end
     end
@@ -155,9 +169,9 @@ module Howitzer
       case answer
         when 'y'
           FileUtils.cp(source, destination)
-          puts_info("    Forced '#{data[:destination]}' file")
+          puts_info("    #{ColorizedString.new('Forced').light_green} '#{data[:destination]}' file")
         when 'n' then
-          puts_info("    Skipped '#{data[:destination]}' file")
+          puts_info("    #{ColorizedString.new('Skipped').light_black} '#{data[:destination]}' file")
         else nil
       end
     end

data/generators/config/config_generator.rb

@@ -8,16 +8,26 @@ module Howitzer
           { source: 'boot.rb', destination: 'config/boot.rb' },
           { source: 'custom.yml', destination: 'config/custom.yml' },
           { source: 'capybara.rb', destination: 'config/capybara.rb' },
-          { source: 'default.yml', destination: 'config/default.yml' }
+          { source: 'default.yml', destination: 'config/default.yml' },
+          { source: 'drivers/browserstack.rb', destination: 'config/drivers/browserstack.rb' },
+          { source: 'drivers/crossbrowsertesting.rb', destination: 'config/drivers/crossbrowsertesting.rb' },
+          { source: 'drivers/headless_chrome.rb', destination: 'config/drivers/headless_chrome.rb' },
+          { source: 'drivers/phantomjs.rb', destination: 'config/drivers/phantomjs.rb' },
+          { source: 'drivers/poltergeist.rb', destination: 'config/drivers/poltergeist.rb' },
+          { source: 'drivers/sauce.rb', destination: 'config/drivers/sauce.rb' },
+          { source: 'drivers/selenium.rb', destination: 'config/drivers/selenium.rb' },
+          { source: 'drivers/selenium_grid.rb', destination: 'config/drivers/selenium_grid.rb' },
+          { source: 'drivers/testingbot.rb', destination: 'config/drivers/testingbot.rb' },
+          { source: 'drivers/webkit.rb', destination: 'config/drivers/webkit.rb' }
         ] }
     end
 
     protected
 
     def banner
-      <<-EOF
+      <<-MSG
   * Config files generation ...
-      EOF
+      MSG
     end
   end
 end

data/generators/config/templates/boot.rb

@@ -8,7 +8,7 @@ Dir[
   './web/sections/**/*.rb',
   './web/pages/**/*.rb',
   './prerequisites/models/**/*.rb',
-  './prerequisites/factory_girl.rb'
+  './prerequisites/factory_bot.rb'
 ].each { |f| require f }
 
 String.send(:include, Howitzer::Utils::StringExtensions)

data/generators/config/templates/capybara.rb

@@ -7,6 +7,7 @@ HOWITZER_KNOWN_DRIVERS = %i[
   sauce
   testingbot
   browserstack
+  crossbrowsertesting
   headless_chrome
 ].freeze
 
@@ -36,135 +37,8 @@ module CapybaraHelpers
   extend Howitzer::CapybaraHelpers
 end
 
-# :selenium driver
+require_relative "drivers/#{Howitzer.driver}"
 
-Capybara.register_driver :selenium do |app|
-  params = { browser: Howitzer.selenium_browser.to_s.to_sym }
-  if CapybaraHelpers.ff_browser?
-    ff_profile = Selenium::WebDriver::Firefox::Profile.new.tap do |profile|
-      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'] = Howitzer.app_host
-    end
-    params[:profile] = ff_profile
-  end
-  Capybara::Selenium::Driver.new app, params
-end
-
-# :headless_chrome driver
-
-Capybara.register_driver :headless_chrome do |app|
-  startup_flags = ['--headless']
-  startup_flags << '-start-maximized' if Howitzer.maximized_window
-  startup_flags.concat(Howitzer.headless_chrome_flags.split(/\s*,\s*/)) if Howitzer.headless_chrome_flags
-  params = { browser: :chrome, switches: startup_flags }
-  Capybara::Selenium::Driver.new app, params
-end
-
-# :webkit driver
-
-if Howitzer.driver.to_sym == :webkit
-  CapybaraHelpers.load_driver_gem!(:webkit, 'capybara-webkit', 'capybara-webkit')
-  Capybara::Webkit.configure do |config|
-    config.allow_url(Howitzer.app_host)
-  end
-end
-
-# :poltergeist driver
-
-if Howitzer.driver.to_sym == :poltergeist
-  CapybaraHelpers.load_driver_gem!(:poltergeist, 'capybara/poltergeist', 'poltergeist')
-
-  Capybara.register_driver :poltergeist do |app|
-    Capybara::Poltergeist::Driver.new(
-      app,
-      js_errors: !Howitzer.phantom_ignore_js_errors,
-      phantomjs_options: ["--ignore-ssl-errors=#{Howitzer.phantom_ignore_ssl_errors ? 'yes' : 'no'}"]
-    )
-  end
-end
-
-# :phantomjs driver
-
-Capybara.register_driver :phantomjs do |app|
-  Capybara::Selenium::Driver.new(
-    app, browser: :phantomjs,
-         desired_capabilities: {
-           javascript_enabled: !Howitzer.phantom_ignore_js_errors
-         },
-         driver_opts: {
-           args: ["--ignore-ssl-errors=#{Howitzer.phantom_ignore_ssl_errors ? 'yes' : 'no'}"]
-         }
-  )
-end
-
-# :sauce driver
-
-Capybara.register_driver :sauce do |app|
-  caps = CapybaraHelpers.required_cloud_caps.merge(
-    maxDuration: Howitzer.cloud_max_duration,
-    idleTimeout: Howitzer.cloud_sauce_idle_timeout,
-    recordScreenshots: Howitzer.cloud_sauce_record_screenshots,
-    videoUploadOnPass: Howitzer.cloud_sauce_video_upload_on_pass
-  )
-  url = "http://#{Howitzer.cloud_auth_login}:#{Howitzer.cloud_auth_pass}@ondemand.saucelabs.com:80/wd/hub"
-  CapybaraHelpers.cloud_driver(app, caps, url)
-end
-
-# :testingbot driver
-
-Capybara.register_driver :testingbot do |app|
-  caps = CapybaraHelpers.required_cloud_caps.merge(
-    maxduration: Howitzer.cloud_max_duration,
-    idletimeout: Howitzer.cloud_testingbot_idle_timeout,
-    screenshot: Howitzer.cloud_testingbot_screenshots
-  )
-  url = "http://#{Howitzer.cloud_auth_login}:#{Howitzer.cloud_auth_pass}@hub.testingbot.com/wd/hub"
-  CapybaraHelpers.cloud_driver(app, caps, url)
-end
-
-# :browserstack driver
-
-Capybara.register_driver :browserstack do |app|
-  caps = CapybaraHelpers.required_cloud_caps.merge(
-    project: Howitzer.cloud_bstack_project,
-    build: Howitzer.cloud_bstack_build
-  )
-  caps[:resolution] = Howitzer.cloud_bstack_resolution if Howitzer.cloud_bstack_resolution.present?
-  caps[:device] = Howitzer.cloud_bstack_mobile_device if Howitzer.cloud_bstack_mobile_device.present?
-  url = "http://#{Howitzer.cloud_auth_login}:#{Howitzer.cloud_auth_pass}@hub.browserstack.com/wd/hub"
-  CapybaraHelpers.cloud_driver(app, caps, url)
-end
-
-# :selenium_grid driver
-
-Capybara.register_driver :selenium_grid do |app|
-  caps = if CapybaraHelpers.ie_browser?
-           Selenium::WebDriver::Remote::Capabilities.internet_explorer
-         elsif CapybaraHelpers.ff_browser?
-           Selenium::WebDriver::Remote::Capabilities.firefox
-         elsif CapybaraHelpers.chrome_browser?
-           Selenium::WebDriver::Remote::Capabilities.chrome
-         elsif CapybaraHelpers.safari_browser?
-           Selenium::WebDriver::Remote::Capabilities.safari
-         else
-           raise Howitzer::UnknownBrowserError, "Unknown '#{Howitzer.selenium_browser}' selenium_browser." \
-                     ' Check your settings, it should be one of' \
-                     ' [:ie, :iexplore, :ff, :firefox, :chrome, safari]'
-         end
-
-  Capybara::Selenium::Driver.new(app, browser: :remote, url: Howitzer.selenium_hub_url, desired_capabilities: caps)
-end
-
-Capybara.save_path = Howitzer.log_dir
-Capybara::Screenshot.register_driver(:phantomjs) do |driver, path|
-  driver.browser.save_screenshot path
-end
-Capybara::Screenshot.register_driver(:headless_chrome) do |driver, path|
-  driver.browser.save_screenshot path
-end
 Capybara::Screenshot.append_timestamp = false
 Capybara::Screenshot.register_filename_prefix_formatter(:default) do
   "capybara-screenshot-#{Gen.serial}"

data/generators/config/templates/default.yml

@@ -17,11 +17,12 @@
 ###########################################################
 # TEST ENVIRONMENTS SETTINGS                              #
 ###########################################################
+ user_agent: # if blank, then default agent
  page_load_idle_timeout: 20
  maximized_window: true # Specify maximized browser window size
 
  # Specify one of the following drivers: selenium, selenium_grid, webkit, poltergeist, phantomjs, sauce,
- # testingbot, browserstack, headless_chrome
+ # testingbot, browserstack, crossbrowsertesting, headless_chrome
  driver: phantomjs
 
  # -Selenium-
@@ -30,7 +31,7 @@
 
  # -Headless Chrome-
  # List of available flags (http://peter.sh/experiments/chromium-command-line-switches/)
- headless_chrome_flags: "--window-size=1920x1080, --disable-gpu"
+ headless_chrome_flags: "window-size=1920x1080, disable-gpu"
 
  # -Selenium Grid-
  selenium_hub_url: "http://example.com:4444/wd/hub"
@@ -68,6 +69,14 @@
  cloud_bstack_build: 'v1'
  cloud_bstack_mobile_device:
 
+ # -CrossBrowserTesting (https://app.crossbrowsertesting.com/selenium/run)
+ cloud_cbt_name: 'Howitzer Example'
+ cloud_cbt_build: '1.0'
+ cloud_cbt_os_api_name: 'Win7x64-C1'
+ cloud_cbt_screen_resolution: '1024x768'
+ cloud_cbt_record_video: 'true'
+ cloud_cbt_record_network: 'true'
+
 ###########################################################
 # CAPYBARA SETTINGS                                       #
 ###########################################################
@@ -88,8 +97,16 @@
 ###########################################################
  mail_adapter: mailgun
  mail_wait_time: 60
+ mail_sleep_time: 3
 
 # -Mailgun- (http://www.mailgun.com/)
  mailgun_key: mailgun_account_private_key
  mailgun_domain: mailgun_domain_with_stored_method
- mailgun_sleep_time: 3
+
+ # -Mailtrap- (https://mailtrap.io/)
+ mailtrap_api_token: private_api_key
+ mailtrap_inbox_id: inbox_id
+
+# -Gmail-
+ gmail_login: gmail_address
+ gmail_password: gmail_password

data/generators/config/templates/drivers/browserstack.rb

@@ -0,0 +1,19 @@
+Capybara.register_driver :browserstack do |app|
+  caps = CapybaraHelpers.required_cloud_caps.merge(
+    project: Howitzer.cloud_bstack_project,
+    build: Howitzer.cloud_bstack_build
+  )
+  caps[:resolution] = Howitzer.cloud_bstack_resolution if Howitzer.cloud_bstack_resolution.present?
+  caps[:device] = Howitzer.cloud_bstack_mobile_device if Howitzer.cloud_bstack_mobile_device.present?
+  if Howitzer.user_agent.present?
+    if CapybaraHelpers.chrome_browser?
+      caps['chromeOptions'] = { 'args' => ["--user-agent=#{Howitzer.user_agent}"] }
+    elsif CapybaraHelpers.ff_browser?
+      profile = Selenium::WebDriver::Firefox::Profile.new
+      profile['general.useragent.override'] = Howitzer.user_agent
+      caps[:firefox_profile] = profile
+    end
+  end
+  url = "http://#{Howitzer.cloud_auth_login}:#{Howitzer.cloud_auth_pass}@hub.browserstack.com/wd/hub"
+  CapybaraHelpers.cloud_driver(app, caps, url)
+end

data/generators/config/templates/drivers/crossbrowsertesting.rb

@@ -0,0 +1,25 @@
+# :crossbrowsertesting driver
+
+Capybara.register_driver :crossbrowsertesting do |app|
+  caps = {}
+  caps['name'] = Howitzer.cloud_cbt_name
+  caps['build'] = Howitzer.cloud_cbt_build
+  caps['browser_api_name'] = Howitzer.cloud_browser_name + Howitzer.cloud_browser_version.to_s
+  caps['os_api_name'] = Howitzer.cloud_cbt_os_api_name
+  caps['screen_resolution'] = Howitzer.cloud_cbt_screen_resolution
+  caps['record_video'] = Howitzer.cloud_cbt_record_video
+  caps['record_network'] = Howitzer.cloud_cbt_record_network
+  caps['max_duration'] = Howitzer.cloud_max_duration
+  if Howitzer.user_agent.present?
+    if CapybaraHelpers.chrome_browser?
+      caps['chromeOptions'] = { 'args' => ["--user-agent=#{Howitzer.user_agent}"] }
+    elsif CapybaraHelpers.ff_browser?
+      profile = Selenium::WebDriver::Firefox::Profile.new
+      profile['general.useragent.override'] = Howitzer.user_agent
+      caps[:firefox_profile] = profile
+    end
+  end
+  url = "http://#{CGI.escape(Howitzer.cloud_auth_login)}:#{Howitzer.cloud_auth_pass}"\
+        '@hub.crossbrowsertesting.com/wd/hub'
+  CapybaraHelpers.cloud_driver(app, caps, url)
+end

data/generators/config/templates/drivers/headless_chrome.rb

@@ -0,0 +1,16 @@
+# :headless_chrome driver
+
+Capybara.register_driver :headless_chrome do |app|
+  startup_flags = ['headless']
+  startup_flags << 'start-fullscreen' if Howitzer.maximized_window
+  startup_flags << "user-agent=#{Howitzer.user_agent}" if Howitzer.user_agent.present?
+  startup_flags.concat(Howitzer.headless_chrome_flags.split(/\s*,\s*/)) if Howitzer.headless_chrome_flags
+  options = Selenium::WebDriver::Chrome::Options.new(args: startup_flags)
+  params = { browser: :chrome, options: options }
+  Capybara::Selenium::Driver.new app, params
+end
+
+Capybara.save_path = Howitzer.log_dir
+Capybara::Screenshot.register_driver(:headless_chrome) do |driver, path|
+  driver.browser.save_screenshot path
+end

data/generators/config/templates/drivers/phantomjs.rb

@@ -0,0 +1,20 @@
+# :phantomjs driver
+
+Capybara.register_driver :phantomjs do |app|
+  caps = {
+    javascript_enabled: !Howitzer.phantom_ignore_js_errors
+  }
+  caps['phantomjs.page.settings.userAgent'] = "WebKit #{Howitzer.user_agent}" if Howitzer.user_agent.present?
+  Capybara::Selenium::Driver.new(
+    app, browser: :phantomjs,
+         desired_capabilities: caps,
+         driver_opts: {
+           args: ["--ignore-ssl-errors=#{Howitzer.phantom_ignore_ssl_errors ? 'yes' : 'no'}"]
+         }
+  )
+end
+
+Capybara.save_path = Howitzer.log_dir
+Capybara::Screenshot.register_driver(:phantomjs) do |driver, path|
+  driver.browser.save_screenshot path
+end