howitzer 0.0.3 → 1.0.1

data/Gemfile

@@ -1,4 +1,6 @@
 source 'https://rubygems.org'
-
 # Specify your gem's dependencies in howitzer.gemspec
-gemspec
+group :development, :test do
+  gem "simplecov", :require => false
+end
+gemspec

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 StrongQA, Inc.
+Copyright (c) 2013 StrongQA, Inc.
 
 MIT License
 
@@ -19,4 +19,4 @@ MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
 LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
 OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,8 +1,9 @@
 # Howitzer
 
+[![Build Status](https://api.travis-ci.org/romikoops/howitzer.png)](http://travis-ci.org/romikoops/howitzer)
 [![Dependency Status](https://gemnasium.com/romikoops/howitzer.png)](https://gemnasium.com/romikoops/howitzer)
 
-Howitzer is Ruby based framework for acceptance testing. 
+Howitzer is Ruby based framework for acceptance testing.
 
 Initially it was developed for testing of web applications, but it is applicable to testing of web services or some API as well.
 The framework uses modern patterns, techniques and tools in automated testing area. For details, please see [Test Framework Design](https://github.com/romikoops/howitzer/wiki/Test-Framework-Design).
@@ -11,10 +12,20 @@ The framework uses modern patterns, techniques and tools in automated testing ar
 - Independent of test web application, its technologies and lanquage.
 - Deploy all test infrastructure for 5 minutes.
 - Flexible test framework configuration.
-- Ability to choose desired BDD tool (Cucumber for now only, but RSpec is coming soon)
-- Itegration with SauceLabs, Mailgun web services.
+- Ability to choose desired BDD tool (Cucumber or RSpec)
+- Itegration with SauceLabs, Testingbot and Mailgun web services.
 - Easy to support tests in actual state.
 - Ability to execute tests against to both browserless driver and actual browsers with no changes in your tests.
+- Ability to check all links are valid
+
+
+## Documentation
+See [GETTING_STARTED](https://github.com/romikoops/howitzer/blob/develop/GETTING_STARTED.md) how to work with *howitzer*.
+
+Also you can find Rdoc documentation on [Rubygems](https://rubygems.org/gems/howitzer).
+
+## Requirements
+Ruby 1.9.3+
 
 ## Setup
 To install, type
@@ -29,26 +40,46 @@ To deploy the framework, type:
 ```bash
 mkdir test_automation
 cd test_automation
+```
+
+Then for Cucumber:
+
+```bash
 howitzer install --cucumber
 ```
 
+For Rspec:
+
+```bash
+howitzer install --rspec
+```
+
+Or for both the ones:
+
+```bash
+howitzer install --cucumber --rspec
+```
+
 This command will generate next folders and files:
 ```
 config/
-        cucumber.yml
-        default.yml
-        custom.yml
+  cucumber.yml
+  default.yml
+  custom.yml
 tasks/
-        cucumber.rake
+  common.rake
+  cucumber.rake
+  rspec.rake
 emails/
-        example_email.rb
+  example_email.rb
 features/
-        support/env.rb
-        step_definitions/common_steps.rb
-        example.feature
+  support/env.rb
+  step_definitions/common_steps.rb
+  example.feature
 pages/
-        example_page.rb
-        example_menu.rb
+  example_page.rb
+  example_menu.rb
+boot.rb
 Gemfile
 Rakefile
 .gitignore
@@ -64,6 +95,19 @@ Learn and specify correct default settings in `config/default.yml` file. For det
 - Debug feature.
 - Enjoy it!
 
+## Rake tasks
+
+You can list all available tasks with next command
+
+```bash
+rake -T
+```
+
+## More information
+* [Rubygems](https://rubygems.org/gems/howitzer)
+* [Mailing list](https://groups.google.com/forum/#!forum/howitzer_ruby)
+* [Issues](https://github.com/romikoops/howitzer/issues)
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,2 +1,9 @@
-#!/usr/bin/env rake
-require "bundler/gem_tasks"
+require 'rubygems'
+require "bundler"
+Bundler.setup
+
+require 'rake'
+require 'rspec/core/rake_task'
+Bundler::GemHelper.install_tasks
+RSpec::Core::RakeTask.new(:spec) { |spec| }
+task :default => :spec

data/bin/howitzer

@@ -1,41 +1,89 @@
 #!/usr/bin/env ruby
 
 require 'rubygems' unless ENV['NO_RUBYGEMS']
-require 'rubigen'
 
-if %w(-v --version).include? ARGV.first
-  require File.dirname(__FILE__) + "/../lib/howitzer"
-  puts "#{File.basename($0)} #{Howitzer::VERSION}"
-  exit(0)
+Dir[File.join(File.dirname(__FILE__), '..', 'generators', '**', '*_generator.rb')].each{ |f| require File.expand_path(f) }
+
+def check_arguments
+  expected_option_list = [
+    'install --cucumber',
+    'install --rspec',
+    'install --cucumber --rspec',
+    'install --rspec --cucumber',
+    '--version',
+    '--help'
+  ]
+
+  actual_options = ARGV.map(&:downcase).join(' ')
+  unless expected_option_list.include?(actual_options)
+    puts "ERROR: incorrect options. Please, see help for details"
+    show_help
+    exit 1
+  end
 end
 
-require 'rubigen/scripts/generate'
-
-require 'pp'
-RubiGen::Base.use_application_sources!
-RubiGen::Base.prepend_sources(*[
-  RubiGen::PathSource.new(:app, File.join(File.dirname(__FILE__), "..", "generators"))
-])
-
-CORRECT_ARGS = %w[--cucumber --rspec]
-
-if ARGV[0] == "install"
-  ARGV.delete 'install'
-  ARGV.each do |option|
-    if option == '--cucumber'
-      RubiGen::Scripts::Generate.new.run(%w[cucumber])
-      RubiGen::Scripts::Generate.new.run(%w[root])
-      RubiGen::Scripts::Generate.new.run(%w[config])
-      RubiGen::Scripts::Generate.new.run(%w[pages])
-      RubiGen::Scripts::Generate.new.run(%w[tasks])
-      RubiGen::Scripts::Generate.new.run(%w[emails])
-    elsif option == '--rspec'
-      #TODO add rspec generator
-      puts "Rspec generator is not available"
+def parse_options
+  first_option = ARGV.shift.to_s.downcase
+  case first_option
+    when 'install' then execute_generator(ARGV.map(&:downcase))
+    when '--version' then show_version
+    when '--help' then show_help
     else
-      puts "ERROR: no such generator with name: '#{option}' is available"
+     puts "ERROR: incorrect first argument ('#{first_option}')"
+     show_help
+     exit 1
+  end
+end
+
+private
+
+def show_help
+  puts %{
+howitzer [command {--cucumber, --rspec}] | {options}
+
+Commands are ...
+    install                  Generate test framework units:
+          --rspec                add RSpec integration with framework
+          --cucumber             add Cucumber integration with framework
+Options are ...
+    --help                   Display this help message.
+    --version                Display the program version.
+  }
+end
+
+def show_version
+  require_relative "../lib/howitzer/version"
+  puts "Version: #{Howitzer::VERSION}"
+  exit 0
+end
+
+def execute_generator(options)
+  if %w[--cucumber --rspec].include?(options.first)
+    Howitzer::ConfigGenerator.new
+    Howitzer::PagesGenerator.new
+    Howitzer::TasksGenerator.new
+    Howitzer::EmailsGenerator.new
+    Howitzer::RootGenerator.new
+
+    options.each do |option|
+      case option
+        when '--cucumber' then Howitzer::CucumberGenerator.new
+        when '--rspec' then Howitzer::RspecGenerator.new
+        else nil
+      end
     end
+  else
+    if options.empty?
+      puts "ERROR: No option specified for install command."
+    else
+      puts "ERROR: Unknown '#{options.first}' option specified."
+    end
+    show_help
+    exit 1
   end
-else
-  puts "ERROR: no such command with name: '#{ARGV[0]} found'"
+end
+
+unless ENV['TEST_MODE']
+  check_arguments
+  parse_options
 end

data/generators/base_generator.rb

@@ -0,0 +1,87 @@
+require 'fileutils'
+
+module Howitzer
+  class BaseGenerator
+    def self.logger=(logger)
+      @logger = logger
+    end
+
+    def self.destination=(destination)
+      @destination = destination
+    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
+      BaseGenerator.instance_variable_get(:@logger) || $stdout
+    end
+
+    def destination
+      BaseGenerator.instance_variable_get(:@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
+          print_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
+
+    def print_info(data)
+      logger.puts "      #{data}"
+    end
+
+    def print_error(data)
+      logger.puts "      ERROR: #{data}"
+    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')
+      )
+    end
+
+    def dest_path(path)
+      File.expand_path(File.join(destination, path))
+    end
+
+    def copy_with_path(data)
+      src = source_path(data[:source])
+      dst = dest_path(data[:destination])
+      FileUtils.mkdir_p(File.dirname(dst))
+      FileUtils.cp(src, dst)
+      print_info("Added '#{data[:destination]}' file")
+    rescue => e
+      print_error("Impossible to create '#{data[:destination]}' file. Reason: #{e.message}")
+    end
+  end
+end

data/generators/config/config_generator.rb

@@ -1,24 +1,20 @@
-require 'rbconfig'
-
-class ConfigGenerator < RubiGen::Base
-  def initialize(runtime_args, runtime_options = {})
-    super
-    @destination_root = File.expand_path('config')
-  end
-
-  def manifest
-    record do |m|
-      m.directory ''
-      m.template 'custom.yml', 'custom.yml'
-      m.template 'default.yml', 'default.yml'
-      m.file 'cucumber.yml', 'cucumber.yml'
+require_relative '../base_generator'
+module Howitzer
+  class ConfigGenerator < BaseGenerator
+      def manifest
+        { files:
+          [
+            { source: 'custom.yml', destination: 'config/custom.yml'},
+            { source: 'default.yml', destination: 'config/default.yml'}
+          ]
+        }
     end
-  end
 
-  protected
-  def banner
-    <<-EOF
-    Creates config files.
-    EOF
+    protected
+    def banner
+      <<-EOF
+      Creates config files.
+      EOF
+    end
   end
 end

data/generators/config/templates/default.yml

@@ -6,8 +6,11 @@
 ###########################################################
 # APPLICATION SETTINGS                                    #
 ###########################################################
+ app_base_auth_login: login
+ app_base_auth_pass: pass
+ app_protocol: http
  app_host: my.website.com
- app_url: "http://${app_host}"
+
  def_test_user: test@test.com
  def_test_pass: mypass
  def_test_name: Auto Tester
@@ -16,19 +19,17 @@
 # TEST ENVIRONMENTS SETTINGS                              #
 ###########################################################
 
- # Specify one of the following drivers: selenium, selenium_dev, webkit, poltergeist, sauce
- driver: webkit
+ # Specify one of the following drivers: selenium, selenium_dev, webkit, poltergeist, sauce, testingbot
+ driver: poltergeist
 
  # -Selenium-
  # specify one of next browsers: iexplore (ie), firefox (ff), chrome, opera
  sel_browser: ff
- sel_firefox_version: 10
- sel_firebug_version: 1.9.1
- sel_firepath_version: 0.9.7
 
  # -PhantomJS-
  # specify settings for poltergeist
- poltergeist_settings: {js_errors: false}
+ pjs_ignore_js_errors: false
+ pjs_ignore_ssl_errors: true
 
  # -SauceLabs-
  sl_user: some_user
@@ -40,6 +41,18 @@
  sl_max_duration: '1800'
  sl_idle_timeout: '180'
 
+ # -TestingBot- browsers that are supported: firefox => '8', googlechrome, iexplore => '9'
+ tb_api_key: client_key
+ tb_api_secret: client_secret
+ tb_url: "http://${tb_api_key}:${tb_api_secret}@hub.testingbot.com:80/wd/hub"
+ tb_platform: :WIN8
+ tb_browser_name: firefox
+ tb_browser_version: 8
+ tb_selenium_version: "2.18.0"
+ tb_max_duration: '1800'
+ tb_idle_timeout: '180'
+ tb_record_screenshot: false
+
 ###########################################################
 # DATABASE SETTINGS                                       #
 ###########################################################
@@ -51,8 +64,14 @@
 ###########################################################
  log_dir: "log"
  txt_log: log.txt
+ html_log: log.html
  selenium_server_log: selenium-server.log
  required_clean_logs: true
+ rawler_log: rawler_log.txt
+ add_rawler_xml_log: false
+ rawler_xml_log: rawler_log.xml
+ add_rawler_html_log: false # not implemented yet
+ rawler_html_log: rawler_log.html # not implemented yet
 
 ###########################################################
 # MAIL SETTINGS                                           #