howitzer 1.1.1 → 2.0.0

data/generators/tasks/tasks_generator.rb

@@ -1,16 +1,18 @@
 require_relative '../base_generator'
 
 module Howitzer
+  # This class responsible for rake tasks generation
   class TasksGenerator < BaseGenerator
     def manifest
-      { files: [ source: 'common.rake', destination: 'tasks/common.rake' ] }
+      { files: [source: 'common.rake', destination: 'tasks/common.rake'] }
     end
 
     protected
+
     def banner
       <<-EOF
   * Base rake task generation ...
       EOF
     end
   end
-end
+end

data/generators/tasks/templates/common.rake

@@ -1,16 +1 @@
-desc "Check broken links"
-task :check_links do
-  require 'rawler'
-  require 'active_support'
-  require 'active_support/core_ext'
-  require 'howitzer/helpers'
-
-  log.settings_as_formatted_text
-  opts = {
-      wait: 0.1,
-      logfile: File.expand_path(settings.rawler_log, settings.log_dir)
-  }
-  opts[:username] = settings.app_base_auth_login unless settings.app_base_auth_login.blank?
-  opts[:password] = settings.app_base_auth_pass unless settings.app_base_auth_pass.blank?
-  Rawler::Base.new(app_base_url, $stdout, opts).validate
-end
+# Put here any common rake tasks

data/generators/turnip/templates/.rspec

@@ -0,0 +1 @@
+-r turnip/rspec

data/generators/turnip/templates/common_steps.rb

@@ -0,0 +1,25 @@
+module Turnip
+  # In this module should be combined common turnip steps
+  module Steps
+    # PUT GLOBAL STEPS HERE
+  end
+end
+
+# This module combines turnip steps for example.feature
+module MonsterSteps
+  attr_accessor :monster
+
+  step 'there is a monster' do
+    self.monster = 1
+  end
+
+  step 'I attack it' do
+    self.monster -= 1
+  end
+
+  step 'it should die' do
+    expect(self.monster).to eq(0)
+  end
+end
+
+RSpec.configure { |c| c.include MonsterSteps, monster_steps: true }

data/generators/turnip/templates/example.feature

@@ -0,0 +1,8 @@
+@monster_steps
+Feature: Attacking a monster
+  Background:
+    Given there is a monster
+
+  Scenario: attack the monster
+    When I attack it
+    Then it should die

data/generators/turnip/templates/spec_helper.rb

@@ -0,0 +1,56 @@
+require 'capybara-screenshot/rspec'
+require_relative '../config/boot'
+require_relative '../config/capybara'
+
+Dir['./spec/support/**/*.rb'].each { |f| require f }
+
+RSpec.configure do |config|
+  Howitzer::Log.settings_as_formatted_text
+
+  Howitzer::Cache.store(:cloud, :start_time, Time.now.utc)
+  Howitzer::Cache.store(:cloud, :status, true)
+
+  config.include FactoryGirl::Syntax::Methods
+
+  config.disable_monkey_patching = true
+  config.color = true
+
+  config.before(:each) do
+    scenario_name =
+      if RSpec.current_example.description.blank?
+        RSpec.current_example.metadata[:full_description]
+      else
+        RSpec.current_example.description
+      end
+    Howitzer::Log.print_scenario_name(scenario_name)
+    @session_start = CapybaraHelpers.duration(Time.now.utc - Howitzer::Cache.extract(:cloud, :start_time))
+  end
+
+  config.after(:each) do
+    Howitzer::Cache.clear_all_ns
+    if CapybaraHelpers.cloud_driver?
+      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
+    Capybara.reset_sessions!
+    Capybara.use_default_driver
+  end
+
+  config.after(:suite) do
+    if CapybaraHelpers.cloud_driver?
+      report_failures_count = config.reporter.failed_examples.count
+      Howitzer::Cache.store(:cloud, :status, report_failures_count.zero?)
+    end
+  end
+
+  at_exit do
+    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
+end

data/generators/turnip/templates/turnip.rake

@@ -0,0 +1,61 @@
+require 'rspec/core/rake_task'
+
+opts = lambda do |task_name|
+  [
+    "--format html --out ./#{Howitzer.log_dir}/#{Howitzer.driver}_#{task_name}_#{Howitzer.html_log}",
+    '--format documentation',
+    '--color'
+  ].join(' ').freeze
+end
+
+RSpec::Core::RakeTask.new(:rspec, 'Run all turnip scenarios') do |t|
+  Howitzer.current_rake_task = t.name
+  t.pattern = './spec{,/*/**}/*.feature'
+  t.rspec_opts = opts.call(t.name)
+end
+
+RSpec::Core::RakeTask.new(:features, 'Run all workable scenarios (without @wip and @bug tags)') do |t|
+  Howitzer.current_rake_task = t.name
+  t.pattern = './spec{,/*/**}/*.feature'
+  t.rspec_opts = "#{opts.call(t.name)} --tag ~wip --tag ~bug"
+end
+
+namespace :features do
+  RSpec::Core::RakeTask.new(:wip, 'Run scenarios in progress (with @wip tag)') do |t|
+    Howitzer.current_rake_task = t.name
+    t.pattern = './spec{,/*/**}/*.feature'
+    t.rspec_opts = "#{opts.call(t.name)} --tag wip"
+  end
+
+  RSpec::Core::RakeTask.new(:bug, 'Run scenarios with known bugs (with @bug tag)') do |t|
+    Howitzer.current_rake_task = t.name
+    t.pattern = './spec{,/*/**}/*.feature'
+    t.rspec_opts = "#{opts.call(t.name)} --tag bug"
+  end
+
+  RSpec::Core::RakeTask.new(:smoke, 'Run workable smoke scenarios (with @smoke tag)') do |t|
+    Howitzer.current_rake_task = t.name
+    t.pattern = './spec{,/*/**}/*.feature'
+    t.rspec_opts = "#{opts.call(t.name)} --tag smoke --tag ~wip --tag ~bug"
+  end
+
+  RSpec::Core::RakeTask.new(:bvt, 'Run workable build verification test scenarios') do |t|
+    Howitzer.current_rake_task = t.name
+    t.pattern = './spec{,/*/**}/*.feature'
+    t.rspec_opts = "#{opts.call(t.name)} --tag ~wip --tag ~bug --tag ~p1 --tag ~p2 --tag ~smoke"
+  end
+
+  RSpec::Core::RakeTask.new(:p1, 'Run workable scenarios with normal priority (with @p1 tag)') do |t|
+    Howitzer.current_rake_task = t.name
+    t.pattern = './spec{,/*/**}/*.feature'
+    t.rspec_opts = "#{opts.call(t.name)} --tag p1 --tag ~wip --tag ~bug"
+  end
+
+  RSpec::Core::RakeTask.new(:p2, 'Run workable scenarios with low priority (with @p2 tag)') do |t|
+    Howitzer.current_rake_task = t.name
+    t.pattern = './spec{,/*/**}/*.feature'
+    t.rspec_opts = "#{opts.call(t.name)} --tag p2 --tag ~wip --tag ~bug"
+  end
+end
+
+task default: :features

data/generators/turnip/templates/turnip_helper.rb

@@ -0,0 +1,6 @@
+require 'turnip'
+Dir.glob('spec/steps/**/*steps.rb') { |f| load f, true }
+
+RSpec.configure do |config|
+  config.raise_error_for_unimplemented_steps = true
+end

data/generators/turnip/turnip_generator.rb

@@ -0,0 +1,26 @@
+require_relative '../base_generator'
+
+module Howitzer
+  # This class responsible for turnip based files generation
+  class TurnipGenerator < BaseGenerator
+    def manifest
+      { files:
+            [
+              { source: '.rspec', destination: '.rspec' },
+              { source: 'spec_helper.rb', destination: 'spec/spec_helper.rb' },
+              { source: 'turnip_helper.rb', destination: 'spec/turnip_helper.rb' },
+              { source: 'example.feature', destination: 'spec/acceptance/example.feature' },
+              { source: 'common_steps.rb', destination: 'spec/steps/common_steps.rb' },
+              { source: 'turnip.rake', destination: 'tasks/turnip.rake' }
+            ] }
+    end
+
+    protected
+
+    def banner
+      <<-EOS
+  * Turnip integration to the framework ...
+      EOS
+    end
+  end
+end

data/generators/web/templates/example_page.rb

@@ -0,0 +1,15 @@
+require_relative 'example_menu'
+# This class is example of web page
+class ExamplePage < Howitzer::Web::Page
+  path '/'
+  validate :url, %r{\A(?:.*?:\/\/)?[^\/]*\/?\z}
+
+  section :menu
+
+  element :search_input, :fillable_field, 'lst-ib'
+  element :search_btn, :button, 'btnK'
+
+  def fill_keyword(data)
+    search_input_element.set(data)
+  end
+end

data/generators/web/templates/menu_section.rb

@@ -0,0 +1,13 @@
+# This class is example of section
+class MenuSection < Howitzer::Web::Section
+  me :id, 'metaMenu'
+
+  element :menu_button, '.menuButton'
+  element :account, :xpath, ".//*[@id='metaMenu']//a[contains(., 'Account')]"
+  element :log_out, :xpath, ".//*[@id='metaMenu']//a[contains(., 'Log Out')]"
+
+  def logout
+    Howitzer::Log.info 'Log out'
+    log_out_element.click
+  end
+end

data/generators/web/web_generator.rb

@@ -0,0 +1,22 @@
+require_relative '../base_generator'
+
+module Howitzer
+  # This class responsible for page object pattern generation
+  class WebGenerator < BaseGenerator
+    def manifest
+      { files:
+        [
+          { source: 'example_page.rb', destination: 'web/pages/example_page.rb' },
+          { source: 'menu_section.rb', destination: 'web/sections/menu_section.rb' }
+        ] }
+    end
+
+    protected
+
+    def banner
+      <<-EOS
+  * PageOriented pattern structure generation ...
+      EOS
+    end
+  end
+end

data/howitzer.gemspec

@@ -1,45 +1,38 @@
 # -*- encoding: utf-8 -*-
+
 require File.expand_path('../lib/howitzer/version', __FILE__)
 
 Gem::Specification.new do |gem|
   gem.author        = 'Roman Parashchenko'
   gem.email         = 'howitzer@strongqa.com'
-  gem.description   = %q{Howitzer uses the best practices and design patterns allowing to generate a test project in less than 5 minutes. 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.description   = 'Howitzer uses the best practices and design patterns allowing to generate a test project in' \
+      ' less than 5 minutes. It has out-of-the-box configurations for parallel cross-browser testing in the cloud.'
+  gem.summary       = 'Ruby based framework for acceptance testing'
   gem.homepage      = 'http://strongqa.github.io/howitzer/'
   gem.license       = 'MIT'
 
   gem.bindir        = 'bin'
-  gem.files         = `git ls-files`.split($\)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = 'howitzer'
   gem.require_paths = ['lib']
   gem.version       = Howitzer::VERSION
-  gem.required_ruby_version = '>= 1.9.3'
+  gem.required_ruby_version = '>= 2.2.2'
 
-  gem.add_runtime_dependency 'nokogiri', '~> 1.6' if gem.platform.to_s =~ /mswin|mingw/
-  gem.add_runtime_dependency 'rack', '~> 1.0'
-  gem.add_runtime_dependency 'tins', '1.6.0'
-  gem.add_runtime_dependency 'rake'
+  gem.add_runtime_dependency 'activesupport', '~>5.0'
+  gem.add_runtime_dependency 'capybara', ['>= 2.1', '< 3.0']
   gem.add_runtime_dependency 'gli'
-  gem.add_runtime_dependency 'syntax'
-  gem.add_runtime_dependency 'cucumber', '~>2.0'
-  gem.add_runtime_dependency 'rspec', '~>3.2'
-  gem.add_runtime_dependency 'sexy_settings'
-  gem.add_runtime_dependency 'repeater'
   gem.add_runtime_dependency 'launchy'
   gem.add_runtime_dependency 'log4r', '~>1.1.10'
-  gem.add_runtime_dependency 'rest-client', '~>1.8'
-  gem.add_runtime_dependency 'poltergeist'
-  gem.add_runtime_dependency 'rawler'
-  gem.add_runtime_dependency 'capybara'
+  gem.add_runtime_dependency 'nokogiri', '~> 1.6' if gem.platform.to_s =~ /mswin|mingw/
+  gem.add_runtime_dependency 'rake'
+  gem.add_runtime_dependency 'rspec', '~>3.2'
   gem.add_runtime_dependency 'selenium-webdriver'
-  gem.add_runtime_dependency 'activesupport', '~>4.2'
-  gem.add_runtime_dependency 'testingbot'
+  gem.add_runtime_dependency 'sexy_settings'
 
   gem.add_development_dependency('aruba')
-  gem.add_development_dependency('fuubar')
   gem.add_development_dependency('ffaker')
+  gem.add_development_dependency('fuubar')
   gem.add_development_dependency('yard')
 end

data/lib/howitzer.rb

@@ -1,9 +1,49 @@
-require "howitzer/version"
-require "howitzer/settings"
-require 'howitzer/capybara/settings'
+require 'selenium-webdriver'
+require 'capybara'
+require 'sexy_settings'
+
+SexySettings.configure do |config|
+  config.path_to_default_settings = File.expand_path('config/default.yml', Dir.pwd)
+  config.path_to_custom_settings = File.expand_path('config/custom.yml', Dir.pwd)
+end
+
+# This is main namespace for the library
+module Howitzer
+  class << self
+    # Defines methods for all known settings
+    # @example
+    #  Howtzer.app_host
+    #  Howitzer.driver
+
+    ::SexySettings::Base.instance.all.each do |key, value|
+      define_method(key) { value }
+    end
+
+    attr_accessor :current_rake_task
+  end
+
+  # @return an application uri
+  #
+  # @example returns url with auth
+  #  app_uri.site
+  # @example returns url without auth
+  #  app_uri.origin
+
+  def self.app_uri
+    ::Addressable::URI.new(
+      user: Howitzer.app_base_auth_login,
+      password: Howitzer.app_base_auth_pass,
+      host: Howitzer.app_host,
+      scheme: Howitzer.app_protocol || 'http'
+    )
+  end
+end
+
+require 'howitzer/version'
+require 'howitzer/exceptions'
+require 'howitzer/log'
 require 'howitzer/utils'
-require 'howitzer/init'
-require 'howitzer/helpers'
+require 'howitzer/cache'
 require 'howitzer/email'
-require 'howitzer/web_page'
-require 'howitzer/blank_page'
+require 'howitzer/web'
+require 'howitzer/capybara_helpers'

data/lib/howitzer/cache.rb

@@ -0,0 +1,70 @@
+module Howitzer
+  ##
+  #
+  # Data can be stored in memory using this class
+  #
+  module Cache
+    SPECIAL_NS_LIST = [:cloud].freeze
+    @data ||= {}
+
+    class << self
+      attr_reader :data
+
+      # Saves data into memory. Marking by a namespace and a key
+      #
+      # @param ns [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
+      end
+
+      # Gets data from memory. Can get all namespace or single data value in namespace using key
+      #
+      # @param ns [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]
+      end
+
+      # Deletes all data from a namespace
+      #
+      # @param ns [String] a namespace
+
+      def clear_ns(ns)
+        init_ns(ns)
+      end
+
+      # Deletes all namespaces with data
+      #
+      # @param exception_list [Array] a namespace list for excluding
+
+      def clear_all_ns(exception_list = SPECIAL_NS_LIST)
+        (@data.keys - exception_list).each { |ns| clear_ns(ns) }
+      end
+
+      private
+
+      def check_ns(ns)
+        raise Howitzer::NoDataError, 'Data storage namespace can not be empty' unless ns
+        init_ns(ns) if ns_absent?(ns)
+      end
+
+      def ns_absent?(ns)
+        !@data.key?(ns)
+      end
+
+      def init_ns(ns)
+        @data[ns] = {}
+      end
+    end
+  end
+end