howitzer 1.1.1 → 2.0.0

data/features/step_definitions/common_steps.rb

@@ -1,9 +1,29 @@
-Given /^created old howitzer project$/ do
-  clean_current_dir
-  run_simple 'howitzer new test_automation --rspec --cucumber'
-  FileUtils.move(Dir.glob("#{Dir.pwd}/#{current_dir}/test_automation/*"), File.join(Dir.pwd, current_dir))
-  FileUtils.remove_dir File.join(current_dir, 'test_automation'), true
-  overwrite_file('boot.rb', "Dir.chdir(File.join(File.dirname(__FILE__), '.'))")
-  overwrite_file('Gemfile', "Hello")
-  remove_file 'config/default.yml'
-end
+Given /^created old howitzer project based on rspec$/ do
+  run_simple 'howitzer new test_automation --rspec'
+  all_commands.shift
+
+  FileUtils.move(Dir.glob("#{expand_path('.')}/test_automation/*"), expand_path('.'))
+  FileUtils.remove_dir File.join(expand_path('.'), 'test_automation'), true
+  overwrite_file('Rakefile', "Dir.chdir(File.join(__dir__, '.'))")
+  overwrite_file('Gemfile', 'Hello')
+  remove 'config/default.yml'
+end
+
+Given /^created old howitzer project based on cucumber$/ do
+  run_simple 'howitzer new test_automation --cucumber'
+  all_commands.shift
+
+  FileUtils.move(Dir.glob("#{expand_path('.')}/test_automation/*"), expand_path('.'))
+  FileUtils.remove_dir File.join(expand_path('.'), 'test_automation'), true
+  overwrite_file('Rakefile', "Dir.chdir(File.join(__dir__, '.'))")
+  overwrite_file('Gemfile', 'Hello')
+  remove 'config/default.yml'
+end
+
+Given /^created old howitzer project based on turnip$/ do
+  run_simple 'howitzer new test_automation --turnip'
+  all_commands.shift
+
+  FileUtils.move(Dir.glob("#{expand_path('.')}/test_automation/*"), expand_path('.'))
+  FileUtils.remove_dir File.join(expand_path('.'), 'test_automation'), true
+end

data/features/support/env.rb

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

data/features/support/transformers.rb

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

data/generators/base_generator.rb

@@ -1,27 +1,23 @@
 require 'fileutils'
+require 'erb'
+require 'ostruct'
+require 'active_support/core_ext/hash'
 
 module Howitzer
-  class BaseGenerator
-    class << self
-      attr_accessor :logger, :destination
+  # This module combines all methods related with information printing to stdout
+  module Outputable
+    def self.included(base)
+      class << base
+        attr_accessor :logger
+      end
     end
 
     def initialize
       print_banner
-      manifest.each do |type, list|
-        case type
-          when :files
-            copy_files(list)
-          when :templates
-            copy_templates(list)
-          else nil
-        end
-      end
     end
 
-    def manifest; end
-
     protected
+
     def banner; end
 
     def logger
@@ -32,22 +28,6 @@ module Howitzer
       BaseGenerator.destination || Dir.pwd
     end
 
-    def copy_files(list)
-      list.each do |data|
-        source_file = source_path(data[:source])
-
-        if File.exists?(source_file)
-          copy_with_path(data)
-        else
-          puts_error("File '#{source_file}' was not found.")
-        end
-      end
-    end
-
-    def copy_templates(list)
-      #TODO implement me if it is require
-    end
-
     def print_banner
       logger.puts banner unless banner.empty?
     end
@@ -63,11 +43,57 @@ module Howitzer
     def puts_error(data)
       logger.puts "      ERROR: #{data}"
     end
+  end
+
+  # This module combines methods for copying files and templates
+  module Copyable
+    def self.included(base)
+      class << base
+        attr_accessor :destination
+      end
+    end
+
+    def initialize(_options)
+      super()
+
+      manifest.each do |type, list|
+        case type
+          when :files
+            copy_files(list)
+          when :templates
+            copy_templates(list)
+          else nil
+        end
+      end
+    end
+
+    def manifest; end
+
+    protected
+
+    def copy_files(list)
+      list.each do |data|
+        source_file = source_path(data[:source])
+        File.exist?(source_file) ? copy_with_path(data) : puts_error("File '#{source_file}' was not found.")
+      end
+    end
+
+    def copy_templates(list)
+      list.each do |data|
+        destination_path = dest_path(data[:destination])
+        source_path = source_path(data[:source])
+        if File.exist?(destination_path)
+          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]}'"
+        end
+      end
+    end
 
     def source_path(file_name)
-      File.expand_path(
-          file_name, File.join(File.dirname(__FILE__), self.class.name.sub('Generator', '').sub('Howitzer::', '').downcase, 'templates')
-      )
+      base_name = self.class.name.sub('Generator', '').sub('Howitzer::', '').downcase
+      File.expand_path(file_name, File.join(__dir__, base_name, 'templates'))
     end
 
     def dest_path(path)
@@ -78,21 +104,8 @@ module Howitzer
       src = source_path(data[:source])
       dst = dest_path(data[:destination])
       FileUtils.mkdir_p(File.dirname(dst))
-      if File.exists?(dst)
-        if FileUtils.identical?(src, dst)
-          puts_info("Identical '#{data[:destination]}' file")
-        else
-          puts_info("Conflict with '#{data[:destination]}' file")
-          print_info("  Overwrite '#{data[:destination]}' file? [Yn]:")
-          case gets.strip.downcase
-            when 'y'
-              FileUtils.cp(src, dst)
-              puts_info("    Forced '#{data[:destination]}' file")
-            when 'n' then nil
-              puts_info("    Skipped '#{data[:destination]}' file")
-            else nil
-          end
-        end
+      if File.exist?(dst)
+        copy_with_path_file_exist(data, src, dst)
       else
         FileUtils.cp(src, dst)
         puts_info("Added '#{data[:destination]}' file")
@@ -100,5 +113,64 @@ module Howitzer
     rescue => e
       puts_error("Impossible to create '#{data[:destination]}' file. Reason: #{e.message}")
     end
+
+    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 }))
+      end
+    end
+
+    private
+
+    def copy_templates_file_exist(data, destination_path, source_path)
+      puts_info("Conflict with '#{data[:destination]}' template")
+      print_info("  Overwrite '#{data[:destination]}' template? [Yn]:")
+      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")
+      else
+        puts_info("Conflict with '#{data[:destination]}' file")
+        print_info("  Overwrite '#{data[:destination]}' file? [Yn]:")
+        copy_with_path_overwrite(gets.strip.downcase, data, source, destination)
+      end
+    end
+
+    def copy_templates_overwrite(answer, data, destination_path, source_path)
+      case answer
+        when 'y'
+          write_template(destination_path, source_path)
+          puts_info("    Forced '#{data[:destination]}' template")
+        when 'n'
+          puts_info("    Skipped '#{data[:destination]}' template")
+        else nil
+      end
+    end
+
+    def copy_with_path_overwrite(answer, data, source, destination)
+      case answer
+        when 'y'
+          FileUtils.cp(source, destination)
+          puts_info("    Forced '#{data[:destination]}' file")
+        when 'n' then
+          puts_info("    Skipped '#{data[:destination]}' file")
+        else nil
+      end
+    end
+  end
+
+  # Parent class for all generators
+  class BaseGenerator
+    attr_reader :options
+
+    include Outputable
+    include Copyable
+
+    def initialize(options = {})
+      @options = options.symbolize_keys
+      super
+    end
   end
-end
+end

data/generators/config/config_generator.rb

@@ -1,20 +1,23 @@
 require_relative '../base_generator'
 module Howitzer
+  # This class responsible for configuration files generation
   class ConfigGenerator < BaseGenerator
     def manifest
       { files:
         [
-          { source: 'custom.yml', destination: 'config/custom.yml'},
-          { source: 'default.yml', destination: 'config/default.yml'}
-        ]
-      }
+          { 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' }
+        ] }
     end
 
     protected
+
     def banner
       <<-EOF
   * Config files generation ...
       EOF
     end
   end
-end
+end

data/generators/config/templates/boot.rb

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'bundler/setup'
+
+Bundler.require(:default)
+
+Dir[
+  './emails/**/*.rb',
+  './web/sections/**/*.rb',
+  './web/pages/**/*.rb',
+  './prerequisites/models/**/*.rb',
+  './prerequisites/factory_girl.rb'
+].each { |f| require f }
+
+String.send(:include, Howitzer::Utils::StringExtensions)

data/generators/config/templates/capybara.rb

@@ -0,0 +1,156 @@
+HOWITZER_KNOWN_DRIVERS = [
+  :selenium,
+  :selenium_grid,
+  :webkit,
+  :poltergeist,
+  :phantomjs,
+  :sauce,
+  :testingbot,
+  :browserstack
+].freeze
+
+unless HOWITZER_KNOWN_DRIVERS.include?(Howitzer.driver.to_s.to_sym)
+  raise Howitzer::UnknownDriverError, "Unknown '#{Howitzer.driver}' driver." \
+                      " Check your settings, it should be one of #{HOWITZER_KNOWN_DRIVERS}"
+end
+
+Capybara.configure do |config|
+  config.run_server = false
+  config.app_host = nil
+  config.asset_host = Howitzer.app_uri.origin
+  config.default_selector = :css
+  config.default_max_wait_time = Howitzer.capybara_wait_time
+  config.ignore_hidden_elements = true
+  config.match = :one
+  config.exact = true
+  config.visible_text_only = true
+  config.default_driver = Howitzer.driver.to_s.to_sym
+  config.javascript_driver = Howitzer.driver.to_s.to_sym
+end
+
+require 'howitzer/capybara_helpers'
+
+# namespace for capybara helpers
+module CapybaraHelpers
+  extend Howitzer::CapybaraHelpers
+end
+
+# :selenium 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
+
+# :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
+         },
+         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.append_timestamp = false
+Capybara::Screenshot.register_filename_prefix_formatter(:default) do
+  "capybara-screenshot-#{Gen.serial}"
+end
+Capybara::Screenshot.prune_strategy = :keep_last_run