howitzer 1.0.1 → 1.0.2

data/features/cli_version.feature

@@ -0,0 +1,14 @@
+Feature: Howitzer CLI Version
+
+  Scenario Outline: Run with version global option
+    When I run `howitzer <option>`
+    Then the output should contain exactly:
+    """
+    howitzer version <HOWITZER_VERSION>
+
+    """
+    And the exit status should be 0
+  Examples:
+    | option    |
+    | --version |
+    | -v        |

data/features/step_definitions/common_steps.rb

@@ -0,0 +1 @@
+# For custom stem definitions

data/features/support/env.rb

@@ -0,0 +1 @@
+require 'aruba/cucumber'

data/features/support/transformers.rb

@@ -0,0 +1,3 @@
+Transform /<HOWITZER_VERSION>/ do |text|
+  text.gsub("<HOWITZER_VERSION>", Howitzer::VERSION)
+end

data/generators/base_generator.rb

@@ -16,9 +16,11 @@ module Howitzer
         case type
           when :files
             copy_files(list)
+          #:nocov:
           when :templates
             copy_templates(list)
           else nil
+          #:nocov:
         end
       end
     end

data/generators/config/config_generator.rb

@@ -13,7 +13,7 @@ module Howitzer
     protected
     def banner
       <<-EOF
-      Creates config files.
+  * Config files generation ...
       EOF
     end
   end

data/generators/config/templates/default.yml

@@ -19,7 +19,7 @@
 # TEST ENVIRONMENTS SETTINGS                              #
 ###########################################################
 
- # Specify one of the following drivers: selenium, selenium_dev, webkit, poltergeist, sauce, testingbot
+ # Specify one of the following drivers: selenium, selenium_dev, webkit, poltergeist, phantomjs, sauce, testingbot
  driver: poltergeist
 
  # -Selenium-
@@ -74,20 +74,10 @@
  rawler_html_log: rawler_log.html # not implemented yet
 
 ###########################################################
-# MAIL SETTINGS                                           #
+# MAILGUN SETTINGS                                        #
 ###########################################################
- mail_smtp_server: smtp.demo.com
- mail_smtp_port: 25
- mail_smtp_domain: demo.com
- mail_smtp_user_name: test_user
- mail_smtp_user_pass: mypass
-
- mail_pop3_server: pop.demo.com
- mail_pop3_port: 995
- mail_pop3_timeout: 120
- mail_pop3_domain: ${mail_smtp_domain}
- mail_pop3_user_name: test_user
- mail_pop3_user_pass: mypass
+ mailgun_key: mailgun_account_private_key
+ mailgun_domain: mailgun_domain_with_stored_method
 
 ############################################################
 # TIMEOUTS                                                 #

data/generators/cucumber/cucumber_generator.rb

@@ -18,7 +18,7 @@ module Howitzer
     protected
     def banner
       <<-EOS
-      Integrates Cucumber to the framework
+  * Cucumber integration to the framework ...
       EOS
     end
   end

data/generators/cucumber/templates/cucumber.yml

@@ -1,11 +1,10 @@
 <%
 rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
 rerun_opts = rerun.to_s.strip.empty? ? "--format progress features" : "--format pretty #{rerun}"
-std_opts = "--verbose --expand --format html --out=./log/log.html --format junit --out=./log features --tags ~@wip --tags ~@bug"
+std_opts = "--verbose --expand --format html --out=./log/log.html --format junit --out=./log --format pretty features --tags ~@wip --tags ~@bug"
 %>
 default: -r features <%= std_opts %>  --tags ~@demo features
 wip: -r features --tags @wip --wip features
 demo: -r features <%= std_opts %> --tags @demo features
 bug: -r features --tags @bug --wip features
-none: --format pretty
 rerun: <%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip

data/generators/cucumber/templates/env.rb

@@ -2,7 +2,7 @@ require 'cucumber'
 require 'capybara/cucumber'
 require_relative '../../boot'
 
-World(CapybaraSettings)
+World(Capybara::Settings)
 World(DataGenerator)
 
 log.settings_as_formatted_text
@@ -10,7 +10,7 @@ DataStorage.store('sauce', :start_time, Time.now.utc)
 DataStorage.store('sauce', :status, true)
 
 if sauce_driver?
-  Capybara.drivers[:sauce][].options[:desired_capabilities][:name] = CapybaraSettings.suite_name
+  Capybara.drivers[:sauce][].options[:desired_capabilities][:name] = Capybara::Settings.suite_name
 end
 
 Before do |scenario|
@@ -20,19 +20,20 @@ Before do |scenario|
 end
 
 After do |scenario|
-  Gen.delete_all_mailboxes
   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'
+    page.execute_script("void(document.execCommand('ClearAuthenticationCache', false));")
   end
-  DataStorage.clear_ns("user")
+  DataStorage.clear_all_ns
 end
 
 at_exit do
   if sauce_driver?
-    log.info "SAUCE SERVER LOG URL: #{CapybaraSettings.sauce_resource_path('selenium-server.log')}"
-    CapybaraSettings.update_sauce_job_status(passed: DataStorage.extract('sauce', :status))
+    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
-  Gen.delete_all_mailboxes
 end

data/generators/emails/emails_generator.rb

@@ -9,7 +9,7 @@ module Howitzer
     protected
     def banner
       <<-EOS
-  Creates a simple email class."
+  * Email example generation ...
       EOS
     end
   end

data/generators/pages/pages_generator.rb

@@ -14,7 +14,7 @@ module Howitzer
     protected
     def banner
       <<-EOS
-      Creates PageOriented pattern structure
+  * PageOriented pattern structure generation ...
       EOS
     end
   end

data/generators/pages/templates/example_page.rb

@@ -2,7 +2,7 @@ require_relative 'example_menu'
 
 class ExamplePage < WebPage
   URL = '/'
-  validates :url, pattern: /#{Regexp.escape(settings.app_host)}\/?/
+  validates :url, pattern: /\A(?:.*?:\/\/)?[^\/]*\/?\z/
 
   add_field_locator :search_input, 'lst-ib'
   add_button_locator :search_btn, 'btnK'
@@ -12,4 +12,4 @@ class ExamplePage < WebPage
   def fill_keyword(data)
     fill_in field_locator(:search_input), data
   end
-end
+end

data/generators/root/root_generator.rb

@@ -16,7 +16,7 @@ module Howitzer
     protected
     def banner
       <<-EOF
-      Creates root config files.
+  * Root files generation ...
       EOF
     end
   end

data/generators/root/templates/Gemfile

@@ -1,5 +1,5 @@
 source "https://rubygems.org"
 
-gem 'howitzer', git: "git://github.com/romikoops/howitzer.git", branch: "develop"
+gem 'howitzer' #, github: "strongqa/howitzer", branch: "develop"
 gem 'debugger'
 

data/generators/rspec/rspec_generator.rb

@@ -15,7 +15,7 @@ module Howitzer
     protected
     def banner
       <<-EOS
-      Integrates RSpec to the framework.
+  * RSpec integration to the framework ...
       EOS
     end
 

data/generators/rspec/templates/example_spec.rb

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

data/generators/rspec/templates/rspec.rake

@@ -9,7 +9,7 @@ TEST_TYPES = [:all, :health, :bvt, :p1]
 TEST_AREAS = []
 
 namespace :rspec do
-  std_opts = "--format html --out=./#{settings.log_dir}/#{settings.html_log}"
+  std_opts = "--format html --out=./#{settings.log_dir}/#{settings.html_log} --format documentation --color"
   TEST_TYPES.each do |type|
     RakeTask.new(type) do |s|
       s.send :desc, "Run all #{"'#{s.name}' " unless type == :all}tests"

data/generators/rspec/templates/spec_helper.rb

@@ -8,7 +8,7 @@ RSpec.configure do |config|
   DataStorage.store('sauce', :start_time, Time.now.utc)
   DataStorage.store('sauce', :status, true)
 
-  config.include CapybaraSettings
+  config.include Capybara::Settings
   config.include Capybara::RSpecMatchers
   config.include DataGenerator
 
@@ -31,18 +31,20 @@ RSpec.configure do |config|
   end
 
   config.after(:each) do
-    Gen.delete_all_mailboxes
-    DataStorage.clear_ns("user")
+    DataStorage.clear_all_ns
     if sauce_driver?
       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'
+      page.execute_script("void(document.execCommand('ClearAuthenticationCache', false));")
     end  
   end
 
   config.after(:suite) do
     if sauce_driver?
       report_failures_count = config.reporter.instance_variable_get(:@failure_count)
-      DataStorage.store('sauce', :status, report_failures_count.zero?) 
+      DataStorage.store('sauce', :status, report_failures_count.zero?)
     end
   end
 
@@ -51,6 +53,5 @@ RSpec.configure do |config|
       log.info "SAUCE SERVER LOG URL: #{CapybaraSettings.sauce_resource_path('selenium-server.log')}"
       CapybaraSettings.update_sauce_job_status(passed: DataStorage.extract('sauce', :status))
     end
-    Gen.delete_all_mailboxes
   end
 end

data/generators/tasks/tasks_generator.rb

@@ -9,7 +9,7 @@ module Howitzer
     protected
     def banner
       <<-EOF
-      Creates RAKE tasks folder and file.
+  * Base rake task generation ...
       EOF
     end
   end

data/generators/tasks/templates/common.rake

@@ -1,6 +1,7 @@
 desc "Check broken links"
 task :check_links do
   require 'rawler'
+  require 'active_support'
   require 'active_support/core_ext'
   require 'howitzer/helpers'
 

data/howitzer.gemspec

@@ -4,9 +4,9 @@ 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{The framework is based on Page Object pattern, Capybara and Rspec/Cucumber libraries}
-  gem.summary       = %q{Universal Ruby Test Framework for black box testing}
-  gem.homepage      = "https://github.com/romikoops/howitzer"
+  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.summary       = %q{Ruby based framework for acceptance testing}
+  gem.homepage      = "https://github.com/strongqa/howitzer"
 
   gem.bindir        = 'bin'
   gem.files         = `git ls-files`.split($\)
@@ -17,7 +17,9 @@ Gem::Specification.new do |gem|
   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 'rake'
+  gem.add_runtime_dependency 'gli'
   gem.add_runtime_dependency 'i18n'
   gem.add_runtime_dependency 'syntax'
   gem.add_runtime_dependency 'cucumber'
@@ -25,19 +27,17 @@ Gem::Specification.new do |gem|
   gem.add_runtime_dependency 'sexy_settings'
   gem.add_runtime_dependency 'repeater'
   gem.add_runtime_dependency 'launchy'
-  gem.add_runtime_dependency 'log4r'
-  gem.add_runtime_dependency 'mail'
+  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 'activeresource', '~>4.0'
+  gem.add_runtime_dependency 'activesupport', '~>4.0'
   gem.add_runtime_dependency 'testingbot'
 
-  gem.add_development_dependency("rspec", [">= 2.14.1"])
+  gem.add_development_dependency('aruba')
   gem.add_development_dependency("fuubar", [">= 0.0.1"])
-  gem.add_development_dependency("rake")
   gem.add_development_dependency("ffaker")
 
 end

data/lib/howitzer.rb

@@ -1,6 +1,9 @@
 require "howitzer/version"
 require "howitzer/settings"
+require 'howitzer/capybara/settings'
 require 'howitzer/utils'
 require 'howitzer/init'
 require 'howitzer/helpers'
-require 'howitzer/web_page'
+require 'howitzer/email'
+require 'howitzer/web_page'
+require 'howitzer/blank_page'

data/lib/howitzer/blank_page.rb

@@ -0,0 +1,6 @@
+require 'howitzer/web_page'
+
+class BlankPage < WebPage
+  URL = 'about:blank'
+  validates :url, pattern: /^about:blank$/
+end

data/lib/howitzer/capybara/dsl_ex.rb

@@ -0,0 +1,15 @@
+require 'capybara'
+module Howitzer
+  module Capybara
+    module DslEx
+      include ::Capybara::DSL
+
+      # It flattens arguments of all DSL methods to support locator store DSL
+      ::Capybara::Session::DSL_METHODS.each do |method|
+        define_method method do |*args, &block|
+          super(*args.map{|el| args.first == el && el.respond_to?(:flatten) ? el.flatten : el}.flatten, &block)
+        end
+      end
+    end
+  end
+end

data/lib/howitzer/capybara/settings.rb

@@ -0,0 +1,267 @@
+##
+#
+# Predefined Capybara settings and capybara drivers
+#
+require 'selenium-webdriver'
+require 'capybara'
+require 'howitzer/utils/log'
+module Capybara
+  module Settings
+    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_host
+      profile
+    end
+
+    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 :phantomjs
+            define_phantomjs_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, poltergeist, phantomjs, 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
+      end
+
+      def define_selenium_dev_driver
+        Capybara.register_driver :selenium_dev do |app|
+          profile = base_ff_profile_settings
+          vendor_dir = settings.custom_vendor_dir || File.join(File.dirname(__FILE__), '..', 'vendor')
+          log.error "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
+              log.error "Extension was not found by '#{full_path_pattern}' pattern!"
+            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
+
+          Capybara::Selenium::Driver.new app, browser: :firefox, profile: profile
+        end
+      end
+
+      def define_webkit_driver
+        require 'capybara-webkit'
+      end
+
+      def define_poltergeist_driver
+        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'}" ]
+          }
+          )
+        end
+      end
+
+      def define_phantomjs_driver
+        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'}" ]
+          )
+        end
+      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: "#{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?
+          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
+        }
+
+        Capybara.register_driver :sauce 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
+
+      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
+
+    ##
+    #
+    # 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"
+      path = "/rest/#{settings.sl_user}/jobs/#{session_id}/results/#{name}"
+      "#{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}"
+      url = "#{host}#{path}"
+      ::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
+        res.empty? ? 'ALL' : res
+      else
+        'CUSTOM'
+      end
+      "#{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
+end
+
+# @deprecated
+#
+CapybaraSettings = Capybara::Settings