howitzer 1.1.1 → 2.0.0

data/generators/emails/emails_generator.rb

@@ -1,16 +1,18 @@
 require_relative '../base_generator'
 
 module Howitzer
+  # This class responsible for email examples generation
   class EmailsGenerator < BaseGenerator
     def manifest
-      { files: [ source: 'example_email.rb', destination: '/emails/example_email.rb' ] }
+      { files: [source: 'example_email.rb', destination: '/emails/example_email.rb'] }
     end
 
     protected
+
     def banner
       <<-EOS
   * Email example generation ...
       EOS
     end
   end
-end
+end

data/generators/emails/templates/example_email.rb

@@ -1,8 +1,8 @@
-class TestEmail < Email
-  SUBJECT = "Test email"
-
+# This class is example of test email
+class TestEmail < Howitzer::Email
+  subject 'Test email'
 
   def addressed_to?(new_user)
     /Hi #{new_user}/ === plain_text_body
   end
-end
+end

data/generators/prerequisites/prerequisites_generator.rb

@@ -0,0 +1,24 @@
+require_relative '../base_generator'
+
+module Howitzer
+  # This class responsible for prerequisites files generation
+  class PrerequisitesGenerator < BaseGenerator
+    def manifest
+      { files:
+          [
+            { source: 'factory_girl.rb', destination: 'prerequisites/factory_girl.rb' },
+            { source: 'users.rb', destination: 'prerequisites/factories/users.rb' },
+            { source: 'base.rb', destination: 'prerequisites/models/base.rb' },
+            { source: 'user.rb', destination: 'prerequisites/models/user.rb' }
+          ] }
+    end
+
+    protected
+
+    def banner
+      <<-EOS
+  * Pre-requisites integration to the framework ...
+      EOS
+    end
+  end
+end

data/generators/prerequisites/templates/base.rb

@@ -0,0 +1,22 @@
+# The base model. Models allow to communicate with
+# AUT (application under test) api endpoints. They are used by
+# FactoryGirl on create
+#
+# To implement a custom model, override the following methods:
+# * {Base.find}
+# * {Base.where}
+# * {Base.save!}
+#
+class Base
+  def self.find(_id)
+    raise NotImplementedError
+  end
+
+  def self.where(_params)
+    raise NotImplementedError
+  end
+
+  def save!
+    raise NotImplementedError
+  end
+end

data/generators/prerequisites/templates/factory_girl.rb

@@ -0,0 +1,30 @@
+# @see http://www.rubydoc.info/gems/factory_girl/file/GETTING_STARTED.md
+require 'factory_girl'
+
+FactoryGirl.definition_file_paths = [File.join(__dir__, 'factories')]
+FactoryGirl.find_definitions
+
+# This module holds custom FactoryGirl methods
+module FactoryGirl
+  # Fetches data from the cache, using factory name and number.
+  # If there is data in the cache with the given name and number,
+  # then that data is returned. Otherwise it stores firstly and then returns
+  # @param factory [String] underscored factory name
+  # @param num [Integer] a factory number
+  # @return [Object] the factory
+  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
+
+# This module holds data generators
+module Gen
+  # Generates unique string
+  # @return [String]
+  def self.serial
+    a = [('a'..'z').to_a, (0..9).to_a].flatten.shuffle
+    "#{Time.now.utc.strftime('%j%H%M%S')}#{a[0..4].join}"
+  end
+end

data/generators/prerequisites/templates/user.rb

@@ -0,0 +1,7 @@
+require_relative 'base'
+# Example User Model
+class User < Base
+  def self.default
+    where(email: Howitzer.app_test_user).first
+  end
+end

data/generators/prerequisites/templates/users.rb

@@ -0,0 +1,12 @@
+FactoryGirl.define do
+  factory :user do
+    email { "u#{serial}@#{Howitzer.mailgun_domain}" }
+    name { "FirstName LastName #{serial}" }
+    password { Howitzer.app_test_pass }
+    password_confirmation { Howitzer.app_test_pass }
+
+    trait :default do
+      initialize_with { User.default || User.new }
+    end
+  end
+end

data/generators/root/root_generator.rb

@@ -1,23 +1,27 @@
 require_relative '../base_generator'
 
 module Howitzer
+  # This class responsible for project root files generation
   class RootGenerator < BaseGenerator
     def manifest
       { files:
         [
-          { source: '.gitignore', destination: '.gitignore'},
-          { source: 'Gemfile', destination: 'Gemfile'},
-          { source: 'Rakefile', destination: 'Rakefile'},
-          { source: 'boot.rb', destination: 'boot.rb'}
-        ]
-      }
+          { source: '.gitignore', destination: '.gitignore' },
+          { source: '.rubocop.yml', destination: '.rubocop.yml' },
+          { source: 'Rakefile', destination: 'Rakefile' }
+        ],
+        templates:
+        [
+          { source: 'Gemfile.erb', destination: 'Gemfile' }
+        ] }
     end
 
     protected
+
     def banner
       <<-EOF
   * Root files generation ...
       EOF
     end
   end
-end
+end

data/generators/root/templates/.rubocop.yml

@@ -0,0 +1,32 @@
+# See full list of defaults here: https://github.com/bbatsov/rubocop/blob/master/config/default.yml
+# 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
+
+Style/CaseIndentation:
+  Enabled: false
+
+Style/EmptyElse:
+  Enabled: false
+
+Lint/AmbiguousRegexpLiteral:
+  Enabled: false
+
+Style/CaseEquality:
+  Enabled: false
+
+Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Metrics/ModuleLength:
+  Max: 150  

data/generators/root/templates/Gemfile.erb

@@ -0,0 +1,27 @@
+source 'https://rubygems.org'
+
+# 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
+#
+# gem 'capybara-webkit'
+
+gem 'howitzer'
+# Uncomment it if you are going to use 'poltergeist' driver. PhantomJS should be installed.
+# See https://github.com/jnicklas/capybara#poltergeist
+# gem 'poltergeist', github: 'teampoltergeist/poltergeist', branch: :master
+gem 'rest-client'
+gem 'repeater'
+gem 'factory_girl'
+gem 'capybara-screenshot'
+<% if cucumber %>
+gem 'syntax'
+gem 'cucumber', '~>2.0'
+<% elsif rspec %>
+gem 'rspec', '~>3.2'
+<% elsif turnip %>
+gem 'rspec', '~>3.2'
+gem 'turnip'
+<% end %>
+gem 'rubocop'
+gem 'pry'
+gem 'pry-byebug'

data/generators/root/templates/Rakefile

@@ -1,16 +1,14 @@
 require 'rake'
 require 'rake/clean'
-require 'howitzer/settings'
-require 'howitzer/utils/log'
+require 'howitzer'
+require 'rubocop/rake_task'
 
 load 'howitzer/tasks/framework.rake'
+RuboCop::RakeTask.new
 
-Dir.chdir(File.join(File.dirname(__FILE__), '.'))
-
-if settings.required_clean_logs
-  CLEAN.include("#{settings.log_dir}/*")
+if Howitzer.required_clean_logs
+  CLEAN.include("#{Howitzer.log_dir}/*")
   Rake::Task[:clean].invoke
 end
 
-Dir['tasks/**/*.rake'].each { |rake| load rake }
-ENV['RAKE_TASK'] = ARGV[0] if /^(?:r?spec|cucumber)/ === ARGV[0]
+Dir['./tasks/**/*.rake'].each { |rake| load rake }

data/generators/rspec/rspec_generator.rb

@@ -1,23 +1,23 @@
 require_relative '../base_generator'
 
 module Howitzer
+  # This class responsible for rspec based files generation
   class RspecGenerator < BaseGenerator
     def manifest
       { files:
         [
-          { source: 'spec_helper.rb', destination: 'spec/spec_helper.rb'},
-          { source: 'example_spec.rb', destination: 'spec/example_spec.rb'},
-          { source: 'rspec.rake', destination: 'tasks/rspec.rake'}
-        ]
-      }
+          { source: 'spec_helper.rb', destination: 'spec/spec_helper.rb' },
+          { source: 'example_spec.rb', destination: 'spec/example_spec.rb' },
+          { source: 'rspec.rake', destination: 'tasks/rspec.rake' }
+        ] }
     end
 
     protected
+
     def banner
       <<-EOS
   * RSpec integration to the framework ...
       EOS
     end
-
   end
-end
+end

data/generators/rspec/templates/example_spec.rb

@@ -4,4 +4,4 @@ RSpec.feature 'Some feature' do
   scenario 'test scenario' do
     expect(true).to be_truthy
   end
-end
+end

data/generators/rspec/templates/rspec.rake

@@ -1,34 +1,53 @@
-require 'rspec'
 require 'rspec/core/rake_task'
-include RSpec::Core
-
-# Specify here your group tests
-TEST_TYPES = [:all, :health, :bvt, :p1]
-
-# Specify here your business areas, ex. [:accounts, :blog, :news]
-TEST_AREAS = []
-
-namespace :rspec do
-  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"
-      s.pattern = "./spec/#{type == :all ? '**': s.name}/**/*_spec.rb"
-      s.rspec_opts = std_opts
-      s.verbose = true
-    end
-    TEST_AREAS.each do |group|
-      type_text = type == :all ? '**': type
-      pattern = "./spec/#{type_text}/#{group}/**/*_spec.rb"
-      RakeTask.new("#{"#{type}:" unless type == :all}#{group}") do |s|
-        s.send :desc, "Run all '#{s.name}' tests"
-        s.pattern = pattern
-        s.rspec_opts = std_opts
-        s.verbose = true
-      end
-    end
+
+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 rspec scenarios') do |t|
+  Howitzer.current_rake_task = t.name
+  t.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.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.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.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.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.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.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.opts = "#{opts.call(t.name)} --tag p2 --tag ~wip --tag ~bug"
+  end
 end
 
-task default: "rspec:all"
+task default: :features

data/generators/rspec/templates/spec_helper.rb

@@ -1,56 +1,57 @@
-require 'rspec'
-require 'capybara/rspec'
-require_relative '../boot'
+require 'capybara-screenshot/rspec'
+require 'capybara/rspec/features'
+require_relative '../config/boot'
+require_relative '../config/capybara'
 
-Dir[File.join(File.dirname(__FILE__), 'support', '**', '*.rb')].each{ |f| require f }
+Dir['./spec/support/**/*.rb'].each { |f| require f }
 
 RSpec.configure do |config|
-  log.settings_as_formatted_text
+  Howitzer::Log.settings_as_formatted_text
 
-  DataStorage.store('sauce', :start_time, Time.now.utc)
-  DataStorage.store('sauce', :status, true)
+  Howitzer::Cache.store(:cloud, :start_time, Time.now.utc)
+  Howitzer::Cache.store(:cloud, :status, true)
 
-  config.include Capybara::Settings
-  config.include Capybara::RSpecMatchers
-  config.include DataGenerator
+  config.include FactoryGirl::Syntax::Methods
 
   config.disable_monkey_patching = true
   config.color = true
 
-  config.before(:all) do
-    if sauce_driver?
-      suite_name = "#{(ENV['RAKE_TASK'] || 'CUSTOM').sub('rspec:', '').upcase} #{settings.sl_browser_name.upcase}"
-      Capybara.drivers[:sauce][].options[:desired_capabilities][:name] = suite_name
-    end
-  end
-
   config.before(:each) do
-    log.print_scenario_name(RSpec.current_example.description.empty? ? RSpec.current_example.metadata[:full_description] : RSpec.current_example.description)
-    @session_start = duration(Time.now.utc - DataStorage.extract('sauce', :start_time))
+    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
-    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'
+    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  
+    end
+    Capybara.reset_sessions!
+    Capybara.use_default_driver
   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?)
+    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 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))
+    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