howitzer 2.1.1 → 2.2.0

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

@@ -0,0 +1,25 @@
+CapybaraHelpers.load_driver_gem!(:appium, 'appium_capybara', 'appium_capybara')
+
+Capybara.register_driver(:appium) do |app|
+  caps = {}
+  caps['deviceName'] = Howitzer.appium_device_name
+  caps['deviceOrientation'] = Howitzer.appium_device_orientation
+  caps['platformVersion'] = Howitzer.appium_platform_version
+  caps['platformName'] = Howitzer.appium_platform_name
+  caps['browserName'] = Howitzer.appium_browser_name
+
+  url = Howitzer.appium_url
+
+  appium_lib_options = {
+    server_url: url
+  }
+  all_options = {
+    appium_lib: appium_lib_options,
+    caps: caps
+  }
+  Appium::Capybara::Driver.new app, all_options
+end
+
+Capybara::Screenshot.class_eval do
+  register_driver :appium, &registered_drivers[:selenium]
+end

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

@@ -0,0 +1,23 @@
+# :headless_firefox driver
+
+Capybara.register_driver :headless_firefox do |app|
+  startup_flags = ['--headless']
+  startup_flags.concat(Howitzer.headless_firefox_flags.split(/\s*,\s*/)) if Howitzer.headless_firefox_flags
+  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
+    profile['general.useragent.override'] = Howitzer.user_agent if Howitzer.user_agent.present?
+  end
+  options = Selenium::WebDriver::Firefox::Options.new(args: startup_flags, profile: ff_profile)
+  params = { browser: :firefox, options: options }
+  Capybara::Selenium::Driver.new app, params
+end
+
+Capybara.javascript_driver = :headless_firefox
+
+Capybara::Screenshot.class_eval do
+  register_driver :headless_firefox, &registered_drivers[:selenium]
+end

data/generators/cucumber/templates/cuke_sniffer.rake

@@ -1,11 +1,11 @@
 require 'cuke_sniffer'
 
 def path_to_features
-  @_path_to_features ||= File.expand_path(File.join(__dir__, '..', 'features'))
+  @path_to_features ||= File.expand_path(File.join(__dir__, '..', 'features'))
 end
 
 def cuke_sniffer
-  @_cuke_sniffer ||= CukeSniffer::CLI.new(
+  @cuke_sniffer ||= CukeSniffer::CLI.new(
     features_location: path_to_features,
     step_definitions_location: File.join(path_to_features, 'step_definitions'),
     hooks_location: File.join(path_to_features, 'support'),

data/generators/cucumber/templates/env.rb

@@ -10,6 +10,14 @@ RSpec.configure do |config|
   config.disable_monkey_patching!
 end
 
+AfterConfiguration do |config|
+  if Howitzer.test_order.present?
+    order, seed = Howitzer.test_order.split(':')
+    config.instance_variable_get(:@options)[:order] = order
+    config.instance_variable_get(:@options)[:seed] = seed
+  end
+end
+
 FileUtils.mkdir_p(Howitzer.log_dir)
 
 Howitzer::Log.settings_as_formatted_text

data/generators/prerequisites/templates/factory_bot.rb

@@ -15,6 +15,7 @@ module FactoryBot
   def self.given_by_number(factory, num)
     data = Howitzer::Cache.extract(factory, num.to_i)
     return data if data.present?
+
     Howitzer::Cache.store(factory, num.to_i, build(factory))
   end
 end

data/generators/root/root_generator.rb

@@ -7,11 +7,11 @@ module Howitzer
       { files:
         [
           { source: '.gitignore', destination: '.gitignore' },
-          { source: '.rubocop.yml', destination: '.rubocop.yml' },
           { source: 'Rakefile', destination: 'Rakefile' }
         ],
         templates:
         [
+          { source: '.rubocop.yml.erb', destination: '.rubocop.yml' },
           { source: 'Gemfile.erb', destination: 'Gemfile' }
         ] }
     end

data/generators/root/templates/{.rubocop.yml → .rubocop.yml.erb}

@@ -2,34 +2,55 @@
 # To see all cops used see here: https://github.com/bbatsov/rubocop/blob/master/config/enabled.yml
 
 AllCops:
-  TargetRubyVersion: 2.3
-  Include:
-      - Rakefile
-      - Gemfile
-
-LineLength:
-  Max: 120
+  DisplayCopNames: true
+  TargetRubyVersion: 2.4
 
 Layout/CaseIndentation:
   Enabled: false
+<% if cucumber -%>
 
-Style/EmptyElse:
+Lint/AmbiguousBlockAssociation:
   Enabled: false
+<% end -%>
 
 Lint/AmbiguousRegexpLiteral:
   Enabled: false
 
-Lint/AmbiguousBlockAssociation:
+Metrics/BlockLength:
   Enabled: false
 
+Metrics/LineLength:
+  Max: 120
+
+Metrics/ModuleLength:
+  Max: 150
+
 Style/CaseEquality:
   Enabled: false
 
-Documentation:
+Style/Documentation:
   Enabled: false
 
-Style/FrozenStringLiteralComment:
+Style/EmptyElse:
   Enabled: false
 
-Metrics/ModuleLength:
-  Max: 150
+Style/FrozenStringLiteralComment:
+  Enabled: false
+<% if turnip -%>
+
+Style/MixinGrouping:
+  EnforcedStyle: separated
+  Exclude:
+    - '**/*_steps.rb'
+<% end -%>
+<% if cucumber || turnip -%>
+
+Style/SymbolProc:
+  Exclude:
+<% if cucumber -%>
+    - 'features/step_definitions/**/*.rb'
+<%- end -%>
+<% if turnip -%>
+    - 'spec/steps/**/*.rb'
+<%- end -%>
+<% end -%>

data/generators/root/templates/Gemfile.erb

@@ -14,6 +14,10 @@ gem 'rubocop'
 <%= "gem 'turnip'\n" if turnip -%>
 <%= "gem 'syntax'\n" if cucumber -%>
 
+# Uncomment it if you are going to use 'appium' driver. Appium and Android SDK should be installed.
+# See https://appium.io/docs/en/about-appium/getting-started/
+# gem 'appium_capybara'
+
 # 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
 #

data/generators/rspec/templates/spec_helper.rb

@@ -15,6 +15,7 @@ RSpec.configure do |config|
   config.disable_monkey_patching!
   config.color = true
   config.wait_timeout = Howitzer.rspec_wait_timeout
+  config.order = Howitzer.test_order.presence || :defined
 
   config.before(:each) do
     scenario_name =

data/generators/turnip/templates/spec_helper.rb

@@ -14,6 +14,7 @@ RSpec.configure do |config|
   config.disable_monkey_patching!
   config.color = true
   config.wait_timeout = Howitzer.rspec_wait_timeout
+  config.order = Howitzer.test_order.presence || :defined
 
   config.before(:each) do
     scenario_name =

data/howitzer.gemspec

@@ -1,4 +1,4 @@
-require File.expand_path('../lib/howitzer/version', __FILE__)
+require File.expand_path('lib/howitzer/version', __dir__)
 
 Gem::Specification.new do |gem|
   gem.author        = 'Roman Parashchenko'
@@ -16,10 +16,10 @@ Gem::Specification.new do |gem|
   gem.name          = 'howitzer'
   gem.require_paths = ['lib']
   gem.version       = Howitzer::VERSION
-  gem.required_ruby_version = '>= 2.2.2'
+  gem.required_ruby_version = '>= 2.3'
 
   gem.add_runtime_dependency 'activesupport', '~>5.0'
-  gem.add_runtime_dependency 'capybara', ['>= 2.1', '< 3.0']
+  gem.add_runtime_dependency 'capybara', '< 4.0'
   gem.add_runtime_dependency 'colorize'
   gem.add_runtime_dependency 'gli'
   gem.add_runtime_dependency 'gmail'

data/lib/howitzer.rb

@@ -29,6 +29,45 @@ module Howitzer
       ::SexySettings::Base.instance.all['mailgun_idle_timeout']
     end
 
+    # @return active session name
+
+    def session_name
+      @session_name ||= 'default'
+    end
+
+    # Sets new session name
+    #
+    # @param name [String] string identifier for the session
+    #
+    # @example Executing code in another browser
+    # Howitzer.session_name = 'browser2'
+    # LoginPage.on do
+    #   expect(title).to eq('Login Page')
+    # end
+    #
+    # # Switching back to main browser
+    # Howitzer.session_name = 'default'
+
+    def session_name=(name)
+      @session_name = name
+      Capybara.session_name = @session_name
+    end
+
+    # Yield a block using a specific session name
+    #
+    # @param name [String] string identifier for the session
+    #
+    # @example Opening page in another browser
+    # Howitzer.using_session('browser2') do
+    #   LoginPage.on do
+    #     expect(title).to eq('Login Page')
+    #   end
+    # end
+
+    def using_session(name)
+      Capybara.using_session(name) { yield }
+    end
+
     attr_accessor :current_rake_task
   end
 
@@ -60,6 +99,7 @@ module Howitzer
 
   def self.sexy_setting!(name)
     return Howitzer.public_send(name) if Howitzer.respond_to?(name)
+
     raise UndefinedSexySettingError,
           "Undefined '#{name}' setting. Please add the setting to config/default.yml:\n #{name}: some_value\n"
   end

data/lib/howitzer/cache.rb

@@ -12,35 +12,35 @@ module Howitzer
 
       # Saves data into memory. Marking by a namespace and a key
       #
-      # @param ns [String] a namespace
+      # @param namespace [String] a namespace
       # @param key [String] a key that should be uniq within the namespace
       # @param value [Object] everything you want to store in Memory
       # @raise [NoDataError] if the namespace missing
 
-      def store(ns, key, value)
-        check_ns(ns)
-        @data[ns][key] = value
+      def store(namespace, key, value)
+        check_ns(namespace)
+        @data[namespace][key] = value
       end
 
       # Gets data from memory. Can get all namespace or single data value in namespace using key
       #
-      # @param ns [String] a namespace
+      # @param namespace [String] a namespace
       # @param key [String] key that isn't necessary required
       # @return [Object, Hash] all data from the namespace if the key is ommited, otherwise returs
       #   all data for the namespace
       # @raise [NoDataError] if the namespace missing
 
-      def extract(ns, key = nil)
-        check_ns(ns)
-        key ? @data[ns][key] : @data[ns]
+      def extract(namespace, key = nil)
+        check_ns(namespace)
+        key ? @data[namespace][key] : @data[namespace]
       end
 
       # Deletes all data from a namespace
       #
-      # @param ns [String] a namespace
+      # @param namespace [String] a namespace
 
-      def clear_ns(ns)
-        init_ns(ns)
+      def clear_ns(namespace)
+        init_ns(namespace)
       end
 
       # Deletes all namespaces with data
@@ -53,17 +53,18 @@ module Howitzer
 
       private
 
-      def check_ns(ns)
-        raise Howitzer::NoDataError, 'Data storage namespace can not be empty' unless ns
-        init_ns(ns) if ns_absent?(ns)
+      def check_ns(namespace)
+        raise Howitzer::NoDataError, 'Data storage namespace can not be empty' unless namespace
+
+        init_ns(namespace) if ns_absent?(namespace)
       end
 
-      def ns_absent?(ns)
-        !@data.key?(ns)
+      def ns_absent?(namespace)
+        !@data.key?(namespace)
       end
 
-      def init_ns(ns)
-        @data[ns] = {}
+      def init_ns(namespace)
+        @data[namespace] = {}
       end
     end
   end

data/lib/howitzer/capybara_helpers.rb

@@ -14,7 +14,7 @@ module Howitzer
       ].freeze,
       LOCAL_BROWSERS = [
         HEADLESS_CHROME = :headless_chrome,
-        PHANTOMJS = :phantomjs,
+        HEADLESS_FIREFOX = :headless_firefox,
         POLTERGEIST = :poltergeist,
         SELENIUM = :selenium,
         SELENIUM_GRID = :selenium_grid,
@@ -51,7 +51,7 @@ module Howitzer
     # @raise [SelBrowserNotSpecifiedError] if selenium driver and missing browser name
 
     def chrome_browser?
-      browser?(:chrome) || Howitzer.driver == HEADLESS_CHROME.to_s
+      browser? :chrome
     end
 
     # @return [Boolean] whether or not current browser is Safari.
@@ -155,13 +155,13 @@ module Howitzer
       unless Howitzer.cloud_browser_name.nil?
         return browser_aliases.include?(Howitzer.cloud_browser_name.to_s.downcase.to_sym)
       end
+
       raise Howitzer::CloudBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG
     end
 
     def selenium_browser?(*browser_aliases)
-      unless Howitzer.selenium_browser.nil?
-        return browser_aliases.include?(Howitzer.selenium_browser.to_s.to_sym)
-      end
+      return browser_aliases.include?(Howitzer.selenium_browser.to_s.to_sym) unless Howitzer.selenium_browser.nil?
+
       raise Howitzer::SelBrowserNotSpecifiedError, CHECK_YOUR_SETTINGS_MSG
     end
 
@@ -169,6 +169,14 @@ module Howitzer
       Howitzer.driver.to_sym == SELENIUM
     end
 
+    def headless_chrome_driver?
+      Howitzer.driver.to_sym == HEADLESS_CHROME
+    end
+
+    def headless_firefox_driver?
+      Howitzer.driver.to_sym == HEADLESS_FIREFOX
+    end
+
     def selenium_grid_driver?
       Howitzer.driver.to_sym == SELENIUM_GRID
     end

data/lib/howitzer/email.rb

@@ -12,6 +12,7 @@ module Howitzer
 
     def self.adapter
       return @adapter if @adapter
+
       self.adapter = Howitzer.mail_adapter.to_sym
       @adapter
     end

data/lib/howitzer/mail_adapters/gmail.rb

@@ -16,6 +16,7 @@ module Howitzer
         message = {}
         retryable(find_retry_params(wait)) { message = get_message(recipient, subject) }
         return new(message) if message.present?
+
         raise Howitzer::EmailNotFoundError,
               "Message with subject '#{subject}' for recipient '#{recipient}' was not found."
       end
@@ -68,12 +69,14 @@ module Howitzer
       def mime_part!
         files = mime_part
         return files if files.present?
+
         raise Howitzer::NoAttachmentsError, 'No attachments were found.'
       end
 
       def self.get_message(recipient, subject)
         message = Howitzer::GmailApi::Client.new.find_message(recipient, subject)
         raise Howitzer::EmailNotFoundError if message.blank?
+
         message
       end
       private_class_method :get_message

data/lib/howitzer/mail_adapters/mailgun.rb

@@ -17,6 +17,7 @@ module Howitzer
         message = {}
         retryable(find_retry_params(wait)) { message = retrieve_message(recipient, subject) }
         return new(message) if message.present?
+
         raise Howitzer::EmailNotFoundError,
               "Message with subject '#{subject}' for recipient '#{recipient}' was not found."
       end
@@ -75,6 +76,7 @@ module Howitzer
       def mime_part!
         files = mime_part
         return files if files.present?
+
         raise Howitzer::NoAttachmentsError, 'No attachments were found.'
       end
 

data/lib/howitzer/mail_adapters/mailtrap.rb

@@ -16,6 +16,7 @@ module Howitzer
         message = {}
         retryable(find_retry_params(wait)) { message = retrieve_message(recipient, subject) }
         return new(message) if message.present?
+
         raise Howitzer::EmailNotFoundError,
               "Message with subject '#{subject}' for recipient '#{recipient}' was not found."
       end
@@ -74,6 +75,7 @@ module Howitzer
       def mime_part!
         files = mime_part
         return files if files.present?
+
         raise Howitzer::NoAttachmentsError, 'No attachments were found.'
       end
 
@@ -91,6 +93,7 @@ module Howitzer
       def self.retrieve_message(recipient, subject)
         message = Howitzer::MailtrapApi::Client.new.find_message(recipient, subject)
         raise Howitzer::EmailNotFoundError, 'Message not received yet, retry...' unless message
+
         message
       end
       private_class_method :retrieve_message