howitzer 1.1.1 → 2.0.0

data/generators/config/templates/custom.yml

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

data/generators/config/templates/default.yml

@@ -1,8 +1,3 @@
-###########################################################
-#  COMMON SETTINGS                                        #
-###########################################################
- debug_mode: false
-
 ###########################################################
 # APPLICATION SETTINGS                                    #
 ###########################################################
@@ -11,109 +6,82 @@
  app_protocol: http
  app_host: my.website.com
 
- def_test_user: test@test.com
- def_test_pass: mypass
- def_test_name: Auto Tester
+ app_test_user: test@test.com
+ app_test_pass: mypass
+ app_test_user_name: Auto Tester
+
+ app_api_token:
+ app_api_end_point: "api/v1"
 
 ###########################################################
 # TEST ENVIRONMENTS SETTINGS                              #
 ###########################################################
+ page_load_idle_timeout: 20
+ maximized_window: true # Specify maximized browser window size
 
- # 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
+ # Specify one of the following drivers: selenium, selenium_grid, webkit, poltergeist, phantomjs, sauce,
+ # testingbot, browserstack
  driver: phantomjs
 
  # -Selenium-
- # specify one of next browsers: iexplore (ie), firefox (ff), chrome, opera, safari
- sel_browser: ff
+ # specify one of next browsers: iexplore (ie), firefox (ff), chrome, safari
+ selenium_browser: ff
 
  # -Selenium Grid-
- sel_hub_url: "http://example.com:4444/wd/hub"
+ selenium_hub_url: "http://example.com:4444/wd/hub"
 
- # -PhantomJS-
+ # -PhantomJS/Poltergeist-
  # specify settings for poltergeist
- pjs_ignore_js_errors: false
- pjs_ignore_ssl_errors: true
-
- # -SauceLabs-
- sl_user: some_user
- sl_api_key: some_api_key
- sl_url: "http://${sl_user}:${sl_api_key}@ondemand.saucelabs.com:80/wd/hub"
- sl_platform: :VISTA
- sl_browser_name: firefox
- sl_selenium_version: "2.18.0"
- sl_max_duration: '1800'
- sl_idle_timeout: '180'
-
- # -TestingBot- browsers that are supported: firefox => '8', googlechrome, iexplore => '9'
- tb_api_key: client_key
- tb_api_secret: client_secret
- tb_url: "http://${tb_api_key}:${tb_api_secret}@hub.testingbot.com:80/wd/hub"
- tb_platform: :WIN8
- tb_browser_name: firefox
- tb_browser_version: 8
- tb_selenium_version: "2.18.0"
- tb_max_duration: '1800'
- 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'
+ phantom_ignore_js_errors: false
+ phantom_ignore_ssl_errors: true
 
 ###########################################################
-# DATABASE SETTINGS                                       #
+# Cloud-based Cross-browser Services                      #
 ###########################################################
+ cloud_auth_login: some_user_or_client_key
+ cloud_auth_pass: api_key_or_api_secret_or_access_key
+ cloud_platform: any
+ cloud_browser_name: Chrome
+ cloud_browser_version: '31'
+ cloud_max_duration: '1800'
+ cloud_http_idle_timeout: 40
+
+ # -SauceLabs- (https://wiki.saucelabs.com/display/DOCS/Test+Configuration+Options)
+ cloud_sauce_record_screenshots: false
+ cloud_sauce_idle_timeout: '180'
+ cloud_sauce_video_upload_on_pass: false
+
+ # -TestingBot- (https://testingbot.com/support/other/test-options)
+ cloud_testingbot_idle_timeout: '180'
+ cloud_testingbot_screenshots: false
+
+ # -BrowserStack (https://www.browserstack.com/automate/capabilities)
+ cloud_bstack_resolution: '1024x768'
+ cloud_bstack_project: 'Howitzer Example'
+ cloud_bstack_build: 'v1'
+ cloud_bstack_resolution: '1024x768'
+ cloud_bstack_mobile_device:
 
-
+###########################################################
+# CAPYBARA SETTINGS                                       #
+###########################################################
+ capybara_wait_time: 20
 
 ###########################################################
 # LOGGER SETTINGS                                         #
 ###########################################################
  log_dir: "log"
- txt_log: log.txt
+ debug_mode: false
  html_log: log.html
  selenium_server_log: selenium-server.log
  required_clean_logs: true
- rawler_log: rawler_log.txt
- add_rawler_xml_log: false
- rawler_xml_log: rawler_log.xml
- add_rawler_html_log: false # not implemented yet
- rawler_html_log: rawler_log.html # not implemented yet
+ hide_datetime_from_log: false
 
 ###########################################################
-# MAILGUN SETTINGS                                        #
+# MAIL SETTINGS                                           #
 ###########################################################
+ mail_adapter: mailgun
  mailgun_key: mailgun_account_private_key
  mailgun_domain: mailgun_domain_with_stored_method
-
-############################################################
-# TIMEOUTS                                                 #
-############################################################
- timeout_tiny: 1
- timeout_short: 3
- timeout_small: 20
- timeout_medium: 60
+ mailgun_idle_timeout: 60
+ mailgun_sleep_time: 3

data/generators/cucumber/cucumber_generator.rb

@@ -1,25 +1,25 @@
 require_relative '../base_generator'
 
 module Howitzer
+  # This class responsible for Cucumber based files generation
   class CucumberGenerator < BaseGenerator
     def manifest
       { files:
         [
-          { source: 'common_steps.rb', destination: 'features/step_definitions/common_steps.rb'},
-          { source: 'env.rb', destination: 'features/support/env.rb'},
-          { source: 'transformers.rb', destination: 'features/support/transformers.rb'},
-          { source: 'example.feature', destination: 'features/example.feature'},
-          { source: 'cucumber.rake', destination: 'tasks/cucumber.rake'},
-          { source: 'cucumber.yml', destination: 'config/cucumber.yml'}
-        ]
-      }
+          { source: 'common_steps.rb', destination: 'features/step_definitions/common_steps.rb' },
+          { source: 'env.rb', destination: 'features/support/env.rb' },
+          { source: 'transformers.rb', destination: 'features/support/transformers.rb' },
+          { source: 'example.feature', destination: 'features/example.feature' },
+          { source: 'cucumber.rake', destination: 'tasks/cucumber.rake' }
+        ] }
     end
 
     protected
+
     def banner
       <<-EOS
   * Cucumber integration to the framework ...
       EOS
     end
   end
-end
+end

data/generators/cucumber/templates/common_steps.rb

@@ -2,7 +2,7 @@
 #                      PREREQUISITES                        #
 #############################################################
 
-Given /^I have entered (.*) into the calculator$/ do |input_|
+Given /^I have entered (.*) into the calculator$/ do |_input_|
   pending
 end
 
@@ -10,7 +10,7 @@ end
 #              ACTIONS             #
 ####################################
 
-When /^I press (.*)$/ do |button|
+When /^I press (.*)$/ do |_button|
   pending
 end
 
@@ -18,6 +18,6 @@ end
 #              CHECKS              #
 ####################################
 
-Then /^the result should be (.*) on the screen$/ do |output|
+Then /^the result should be (.*) on the screen$/ do |_output|
   pending
-end
+end

data/generators/cucumber/templates/cucumber.rake

@@ -1,57 +1,66 @@
+require 'cucumber'
+require 'cucumber/rake/task'
 
-unless ARGV.any? {|a| a =~ /^gems/} # Don't load anything when running the gems:* tasks
-  begin
-    require 'cucumber'
-    require 'cucumber/rake/task'
-
-    namespace :cucumber do
-      Cucumber::Rake::Task.new({ok: 'db:test:prepare'}, 'Run features that should pass') do |t|
-        t.fork = false # You may get faster startup if you set this to false
-        t.profile = 'default'
-      end
-
-      Cucumber::Rake::Task.new({wip: 'db:test:prepare'}, 'Run features that are being worked on') do |t|
-        t.fork = false # You may get faster startup if you set this to false
-        t.profile = 'wip'
-      end
-
-      Cucumber::Rake::Task.new({bug: 'db:test:prepare'}, 'Run features with known bugs') do |t|
-        t.fork = false # You may get faster startup if you set this to false
-        t.profile = 'bug'
-      end
-
-      Cucumber::Rake::Task.new({demo: 'db:test:prepare'}, 'Run demo feature') do |t|
-        t.fork = false # You may get faster startup if you set this to false
-        t.profile = 'demo'
-      end
-
-      Cucumber::Rake::Task.new({rerun: 'db:test:prepare'}, 'Record failing features and run only them if any exist') do |t|
-        t.fork = false # You may get faster startup if you set this to false
-        t.profile = 'rerun'
-      end
-
-      desc 'Run all features'
-      task all: [:ok, :wip]
-
-    end
-    desc 'Alias for cucumber:ok'
-    task cucumber: 'cucumber:ok'
-
-    task default: :cucumber
-
-    task features: :cucumber do
-      STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
-    end
-
-    # In case we don't have ActiveRecord, append a no-op task that we can depend upon.
-    task 'db:test:prepare' do
-    end
-
-  rescue LoadError
-    desc 'cucumber rake task not available (cucumber not installed)'
-    task :cucumber do
-      abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
-    end
+opts = lambda do |task_name|
+  [
+    '-r features',
+    '-v',
+    '-x',
+    "-f html -o ./#{Howitzer.log_dir}/#{Howitzer.driver}_#{task_name}_#{Howitzer.html_log}",
+    "-f junit -o ./#{Howitzer.log_dir}",
+    '-f pretty'
+  ].join(' ').freeze
+end
+
+Cucumber::Rake::Task.new(:cucumber, 'Run all cucumber scenarios') do |t|
+  Howitzer.current_rake_task = t.instance_variable_get :@task_name
+  t.fork = false
+  t.cucumber_opts = opts.call(t.instance_variable_get(:@task_name))
+end
+
+Cucumber::Rake::Task.new(:features, 'Run all workable scenarios (without @wip and @bug tags)') do |t|
+  Howitzer.current_rake_task = t.instance_variable_get :@task_name
+  t.fork = false
+  t.cucumber_opts = "#{opts.call(t.instance_variable_get(:@task_name))} --tags ~@wip --tags ~@bug"
+end
+
+namespace :features do
+  Cucumber::Rake::Task.new(:wip, 'Run scenarios in progress (with @wip tag)') do |t|
+    Howitzer.current_rake_task = t.instance_variable_get :@task_name
+    t.fork = false
+    t.cucumber_opts = "#{opts.call(t.instance_variable_get(:@task_name))} --tags @wip"
+  end
+
+  Cucumber::Rake::Task.new(:bug, 'Run scenarios with known bugs (with @bug tag)') do |t|
+    Howitzer.current_rake_task = t.instance_variable_get :@task_name
+    t.fork = false
+    t.cucumber_opts = "#{opts.call(t.instance_variable_get(:@task_name))} --tags @bug"
+  end
+
+  Cucumber::Rake::Task.new(:smoke, 'Run workable smoke scenarios (with @smoke tag)') do |t|
+    Howitzer.current_rake_task = t.instance_variable_get :@task_name
+    t.fork = false
+    t.cucumber_opts = "#{opts.call(t.instance_variable_get(:@task_name))} --tags @smoke --tags ~@wip --tags ~@bug"
+  end
+
+  Cucumber::Rake::Task.new(:bvt, 'Run workable build verification test scenarios') do |t|
+    Howitzer.current_rake_task = t.instance_variable_get :@task_name
+    t.fork = false
+    t.cucumber_opts = "#{opts.call(t.instance_variable_get(:@task_name))}
+    --tags ~@wip --tags ~@bug --tags ~@smoke --tags ~@p1 --tags ~@p2"
+  end
+
+  Cucumber::Rake::Task.new(:p1, 'Run workable scenarios with normal priority (with @p1 tag)') do |t|
+    Howitzer.current_rake_task = t.instance_variable_get :@task_name
+    t.fork = false
+    t.cucumber_opts = "#{opts.call(t.instance_variable_get(:@task_name))} --tags ~@wip --tags ~@bug --tags @p1"
+  end
+
+  Cucumber::Rake::Task.new(:p2, 'Run workable scenarios with low priority (with @p2 tag)') do |t|
+    Howitzer.current_rake_task = t.instance_variable_get :@task_name
+    t.fork = false
+    t.cucumber_opts = "#{opts.call(t.instance_variable_get(:@task_name))} --tags ~@wip --tags ~@bug --tags @p2"
   end
+end
 
-end
+task default: :features

data/generators/cucumber/templates/env.rb

@@ -1,39 +1,40 @@
 require 'cucumber'
-require 'capybara/cucumber'
-require_relative '../../boot'
+require 'capybara-screenshot/cucumber'
+require_relative '../../config/boot'
+require_relative '../../config/capybara'
 
-World(Capybara::Settings)
-World(DataGenerator)
+World(FactoryGirl::Syntax::Methods)
 
-log.settings_as_formatted_text
-DataStorage.store('sauce', :start_time, Time.now.utc)
-DataStorage.store('sauce', :status, true)
+FileUtils.mkdir_p(Howitzer.log_dir)
 
-if sauce_driver?
-  Capybara.drivers[:sauce][].options[:desired_capabilities][:name] = Capybara::Settings.suite_name
-end
+Howitzer::Log.settings_as_formatted_text
+Howitzer::Cache.store(:cloud, :start_time, Time.now.utc)
+Howitzer::Cache.store(:cloud, :status, true)
 
 Before do |scenario|
-  log.print_feature_name(scenario.feature.name)
-  log.print_scenario_name(scenario.name)
-  @session_start = duration(Time.now.utc - DataStorage.extract('sauce', :start_time))
+  Capybara.use_default_driver
+  Howitzer::Log.print_feature_name(scenario.feature.name)
+  Howitzer::Log.print_scenario_name(scenario.name)
+  @session_start = CapybaraHelpers.duration(Time.now.utc - Howitzer::Cache.extract(:cloud, :start_time))
 end
 
 After do |scenario|
-  if sauce_driver?
-    DataStorage.store('sauce', :status, false) if scenario.failed?
-    session_end = duration(Time.now.utc - DataStorage.extract('sauce', :start_time))
-    log.info "SAUCE VIDEO #@session_start - #{session_end} URL: #{sauce_resource_path('video.flv')}"
-  elsif ie_browser?
-    log.info 'IE reset session'
+  if CapybaraHelpers.cloud_driver?
+    Howitzer::Cache.store(:cloud, :status, false) if scenario.failed?
+    session_end = CapybaraHelpers.duration(Time.now.utc - Howitzer::Cache.extract(:cloud, :start_time))
+    Howitzer::Log.info "CLOUD VIDEO #{@session_start} - #{session_end}" \
+             " URL: #{CapybaraHelpers.cloud_resource_path(:video)}"
+  elsif CapybaraHelpers.ie_browser?
+    Howitzer::Log.info 'IE reset session'
     page.execute_script("void(document.execCommand('ClearAuthenticationCache', false));")
   end
-  DataStorage.clear_all_ns
+  Howitzer::Cache.clear_all_ns
+  Capybara.reset_sessions!
 end
 
 at_exit do
-  if sauce_driver?
-    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))
+  if CapybaraHelpers.cloud_driver?
+    Howitzer::Log.info "CLOUD SERVER LOG URL: #{CapybaraHelpers.cloud_resource_path(:server_log)}"
+    CapybaraHelpers.update_cloud_job_status(passed: Howitzer::Cache.extract(:cloud, :status))
   end
 end

data/generators/cucumber/templates/transformers.rb

@@ -1,30 +1,38 @@
 #############################################################
 #                      TRANSFORMERS                         #
 #############################################################
-Transform /UNIQ_USER(\d*)(?:\[\:(.+)\])?/ do |num, property|
-  res = Gen::given_user_by_number(num)
+
+# Revives factory or factory property from step to real value
+# @note any factory is building once per scenario for the same number.
+#  if number is ommited, then it is assigned to 0 number.
+#  Built factories are stored in Howitzer::Cache and cleared after each
+#  scenario automatically
+# @example
+#  'When I fill first name field with FACTORY_USER1[:first_name] value'
+#  #=> build(:user).first_name
+Transform /FACTORY_([a-z_]+)(\d*)(?:\[\:(.+)\])?/i do |factory, num, property|
+  res = FactoryGirl.given_by_number(factory.downcase, num)
   res = res.send(property) if property
   res
 end
 
+# Revives factories or factory properties from table to real values
+# @example
+#  When I sign up with following data:
+#   | name                 | email                 |
+#   | FACTORY_USER1[:name] | FACTORY_USER1[:email] |
+#  #=> build(:user).name and build(:user).email
 Transform /^table:.*$/ do |table|
   raw = table.raw.map do |array|
     array.map do |el|
-      res = el
-
-      # UNIQ_USER
-      data = /UNIQ_USER(?<num>\d*)(?:\[\:(?<property>.+)\])?/.match(el)
-      if data
-        res = Gen::given_user_by_number(data[:num])
-        if data[:property]
-          res = res.send(data[:property])
-        end
-      end
-
-      res
+      data = /FACTORY_(?<factory>[a-z_]+)(?<num>\d*)(?:\[\:(?<property>.+)\])?/i.match(el)
+      next(el) unless data
+      res = FactoryGirl.given_by_number(data[:factory].downcase, data[:num])
+      next(res) if data[:property].blank?
+      res.send(data[:property])
     end
   end
   location = Cucumber::Core::Ast::Location.of_caller
   ast_table = Cucumber::Core::Ast::DataTable.new(raw, location)
   Cucumber::MultilineArgument::DataTable.new(ast_table)
-end
+end