howitzer 1.0.2 → 1.1.0

data/Gemfile

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

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 StrongQA, Inc.
+Copyright (c) 2012-2015 Roman Parashchenko and StrongQA, Ltd.
 
 MIT License
 

data/README.md

@@ -1,47 +1,53 @@
 # Howitzer
+
+[![Join the chat at https://gitter.im/strongqa/howitzer](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/strongqa/howitzer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![Gem Version](http://img.shields.io/gem/v/howitzer.svg)][gem]
 [![Build Status](https://travis-ci.org/strongqa/howitzer.svg?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/romikoops/howitzer.png)][gemnasium]
+[![Dependency Status](https://gemnasium.com/strongqa/howitzer.svg)][gemnasium]
 [![Code Climate](https://codeclimate.com/github/romikoops/howitzer.png)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/strongqa/howitzer/badge.png?branch=master)][coveralls]
 [![License](http://img.shields.io/badge/license-MIT-blue.svg)][license]
 
 [gem]: https://rubygems.org/gems/howitzer
 [travis]: https://travis-ci.org/strongqa/howitzer
-[gemnasium]: https://gemnasium.com/romikoops/howitzer
+[gemnasium]: https://gemnasium.com/strongqa/howitzer
 [codeclimate]: https://codeclimate.com/github/romikoops/howitzer
+[coveralls]: https://coveralls.io/r/strongqa/howitzer?branch=master
 [license]: https://github.com/strongqa/howitzer/blob/master/LICENSE
 
-Howitzer is Ruby based framework for acceptance testing.
+Howitzer is a Ruby-based framework for acceptance testing.
+
+It was originally developed for testing web applications, but you can also use it for API testing and web service 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/strongqa/howitzer/wiki/Test-Framework-Design).
+The framework was built with modern patterns, techniques, and tools in automated testing. For details, please see [Test Framework Design](https://github.com/strongqa/howitzer/wiki/Test-Framework-Design).
 
-## Key benefits
+## Key Benefits
 - 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 or RSpec)
-- Itegration with SauceLabs, Testingbot and Mailgun web services.
-- Easy to support tests in actual state.
+- Fast installation of the complete testing infrastructure (takes less than 5 minutes).
+- Flexible configuration of the test framework.
+- Possibility to choose between Cucumber or RSpec BDD tool.
+- Integration with SauceLabs, Testingbot, BrowserStack and MailGun web services.
+- Easy tests support.
 - 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
+- Searches for broken links.
 
 
 ## Documentation
-See [GETTING_STARTED](https://github.com/strongqa/howitzer/blob/develop/GETTING_STARTED.md) how to work with *howitzer*.
+Refer to the [GETTING STARTED](http://rubydoc.info/gems/howitzer/file/GETTING_STARTED.md) document to start working with *Howitzer*.
 
-Also you can find Rdoc documentation on [Rubygems](https://rubygems.org/gems/howitzer).
+You can also find the Rdoc documentation on [Rubygems](https://rubygems.org/gems/howitzer).
 
-## Related products
-* [Howitzer Example](https://github.com/strongqa/howitzer_example) - Demo Rails application and Acceptance tests
-* [Howitzer Stat](https://github.com/strongqa/howitzer_stat) - Howitzer extension for test coverage visualization of web web pages
+## Related Products
+* [Howitzer Example](https://github.com/strongqa/howitzer_example) – an example of Howitzer based project for demo web application.
+* [Howitzer Stat](https://github.com/strongqa/howitzer_stat) – is the extension to Howitzer product. It is used for automated tests coverage visualization of web pages.
 
 ## Requirements
 * Supported OS: Mac OS X, Linux, Windows
-* Ruby 1.9.3+
-* [DevKit](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit#installation-instructions)(For **Windows** only)
+* [Ruby](https://www.ruby-lang.org/en/downloads/) 1.9.3+
+* [DevKit](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit#installation-instructions) (For **Windows** only)
 * [PhantomJS](http://phantomjs.org/download.html)
 * [ChromeDriver](https://code.google.com/p/selenium/wiki/ChromeDriver)
+* [QT](https://github.com/thoughtbot/capybara-webkit/wiki/Installing-Qt-and-compiling-capybara-webkit) (For **webkit** driver only)
 
 ## Setup
 To install, type
@@ -51,7 +57,7 @@ gem install howitzer
 ```
 
 ## Usage
-navigate to desired directory where new project will be created
+Browse to a desired directory where a new project will be created.
 
 To deploy the framework with Cucumber, type:
 
@@ -59,7 +65,7 @@ To deploy the framework with Cucumber, type:
 howitzer new <PROJECT NAME> --cucumber
 ```
 
-This command will generate next folders and files:
+The following folders and files will be generated:
 ```
 config/
   cucumber.yml
@@ -90,45 +96,93 @@ With Rspec:
 howitzer new <PROJECT NAME> --rspec
 ```
 
-With both the ones:
+With both Cucumber and Rspec:
 
 ```bash
 howitzer new <PROJECT NAME> --cucumber --rspec
 ```
 
-### Configuration
-Learn and specify correct default settings in `config/default.yml` file. For details, please see original [sexy_settings](https://github.com/romikoops/sexy_settings) gem.
+**Configuration**
+
+Learn and specify correct default settings in the `config/default.yml` file. For more details, please refer to the original [sexy_settings](https://github.com/romikoops/sexy_settings) gem.
 
-## Test implementation workflow
+## Test Implementation Workflow
 
-- Prepare Features and Scenarios
-- Implement appropriate pages in `pages` folder. For details, see [Page Object Pattern](https://github.com/strongqa/howitzer/wiki/PageObject-pattern).
+- Prepare features and scenarios
+- Implement appropriate pages in the `pages` folder. For details, refer to  [Page Object Pattern](https://github.com/strongqa/howitzer/wiki/PageObject-pattern).
 - Implement emails in `emails` folder.
 - Implement scenarios:
-  * Cucumber:
+  * For Cucumber:
     1. Read and learn [Cucumber Best Practices](https://github.com/strongqa/howitzer/wiki/Cucumber-Best-Practices)
-    2. Implement step definitions in `features/step_definitions/common_steps.rb` file.
-  * Rspec: Use [DSL](https://github.com/jnicklas/capybara/blob/master/lib/capybara/rspec/features.rb) provided by Capybara for creating descriptive acceptance tests
+    2. Implement step definitions in the `features/step_definitions/common_steps.rb` file.
+  * For Rspec: Use [DSL](https://github.com/jnicklas/capybara/blob/master/lib/capybara/rspec/features.rb) provided by Capybara to create descriptive acceptance tests.
 - Debug feature against to desired driver.
 - Enjoy it!
 
-## Rake tasks
+## Rake Tasks
 
-You can list all available tasks with next command
+You can get a list of all available tasks by typing the following command:
 
 ```bash
 rake -T
+
+```
+
+## Upgrading Howitzer
+Before attempting to upgrade an existing project, you should be sure you have a good reason to upgrade. You need to balance several factors: the need for new features, the increasing difficulty of finding support for old code, and your available time and skills, to name a few.
+
+From version _v1.1.0_ howitzer provides **howitzer update** command. After updating the Howitzer version in the Gemfile, run this rake task. This will help you with the creation of new files and changes of old files in an interactive session.
+
+```
+$ howitzer update
+        *  Config files generation ...
+            Identical 'config/custom.yml' file
+            Added 'config/default.yml' file
+        * Root files generation ...
+            Added '.gitignore' file
+            Conflict with 'Gemfile' file
+              Overwrite 'Gemfile' file? [Yn]:Y
+                Forced 'Gemfile' file
+            Identical 'Rakefile' file
+            Conflict with 'boot.rb' file
+              Overwrite 'boot.rb' file? [Yn]:n
+                Skipped 'boot.rb' file
+
+...
 ```
+Don't forget to review the difference, to see if there were any unexpected changes and merge them. It is easy if your project is under revision control systems like _Git_.
 
-## More information
+## Additional Information
 * [Rubygems](https://rubygems.org/gems/howitzer)
 * [Mailing list](https://groups.google.com/forum/#!forum/howitzer_ruby)
 * [Issues](https://github.com/strongqa/howitzer/issues)
+* [Developer chat](https://gitter.im/strongqa/howitzer)
+
+Contributing
+------------
+
+Please see [CONTRIBUTING.md](https://github.com/strongqa/howitzer/blob/master/CONTRIBUTING.md).
+
+howitzer was originally designed by Roman Parashchenko and is now maintained by StrongQA team. You can find list of contributors here [open source
+community](https://github.com/strongqa/howitzer/graphs/contributors).
+
+License
+-------
+
+howitzer is Copyright © 2012-2015 Roman Parashchenko and StrongQA. It is free
+software, and may be redistributed under the terms specified in the
+[LICENSE](/LICENSE) file.
+
+About StrongQA
+----------------
+
+![StrongQA](http://strongqa.com/head_logo_big.png)
+
+howitzer is maintained and funded by StrongQA, Ltd.
+The names and logos for StrongQA are trademarks of StrongQA, Ltd.
 
-## Contributing
+We love open source software!
+See [our other projects][testing_solutions] or [hire us][hire] to consult and develop testing solutions.
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+[testing_solutions]: http://strongqa.com/testing_solutions/?utm_source=github
+[hire]: https://strongqa.com?utm_source=github

data/Rakefile

@@ -3,6 +3,7 @@ require "bundler"
 Bundler.setup
 
 require 'rake'
+require 'yard'
 require 'rspec/core/rake_task'
 require 'cucumber/rake/task'
 Bundler::GemHelper.install_tasks
@@ -15,4 +16,7 @@ end
 desc "All tests"
 task(all_tests: [:spec, :cucumber]) {}
 
+YARD::Rake::YardocTask.new do |t|
+end
+
 task :default => :all_tests

data/bin/howitzer

@@ -21,7 +21,7 @@ module HowitzerCli
     c.action do |global_options, options, args|
       if args.size > 0
         validate_options(options)
-        Dir[File.join(File.dirname(__FILE__), '..', 'generators', '**', '*_generator.rb')].each{ |f| require File.expand_path(f) }
+        load_generators
         path_to_dir = File.join(Dir.pwd, args.first)
         puts "  * New project directory creation ..."
         Dir.mkdir(path_to_dir)
@@ -41,10 +41,19 @@ module HowitzerCli
     end
   end
 
-  def self.call
-    exit run(ARGV)
+  desc 'Upgrade existing project'
+  command :update do |c|
+    c.action do
+        check_project_presence
+        load_generators
+        Howitzer::ConfigGenerator.new
+        Howitzer::RootGenerator.new
+        Howitzer::CucumberGenerator.new if cucumber_integrated?
+        Howitzer::RspecGenerator.new if rspec_integrated?
+    end
   end
 
+  #helpers
   class << self
     private
     def validate_options(options)
@@ -52,9 +61,29 @@ module HowitzerCli
         exit_now!("Provide --cucumber and/or --rspec option", 64)
       end
     end
+
+    def check_project_presence
+      exit_now!('Current directory is not Howitzer project', 126) unless howitzer_project?
+    end
+
+    def howitzer_project?
+      Dir.exists?('pages') && Dir.exists?('config') && File.exists?('boot.rb')
+    end
+
+    def load_generators
+      Dir[File.join(File.dirname(__FILE__), '..', 'generators', '**', '*_generator.rb')].each{ |f| require File.expand_path(f) }
+    end
+
+    def cucumber_integrated?
+      Dir.exists?('features')
+    end
+
+    def rspec_integrated?
+      Dir.exists?('spec')
+    end
   end
 end
 
 unless ENV['TEST_MODE']
-  HowitzerCli.call
-end
+  exit(HowitzerCli.run(ARGV))
+end

data/features/cli_help.feature

@@ -18,8 +18,9 @@ Feature: Howitzer CLI Help
         --version - Display the program version
 
     COMMANDS
-        help - Shows a list of commands or help for one command
-        new  - Generate new project
+        help   - Shows a list of commands or help for one command
+        new    - Generate new project
+        update - Upgrade existing project
 
     """
     And the exit status should be 0

data/features/cli_new.feature

@@ -1,4 +1,4 @@
-Feature: Howitzer CLI Version
+Feature: Howitzer CLI New Project Creation
 
   Scenario: Run with new command without argument and options
     When I run `howitzer new`

data/features/cli_unknown.feature

@@ -1,4 +1,4 @@
-Feature: Howitzer CLI Version
+Feature: Howitzer CLI Unknown command
 
   Scenario: Run with --unknown global option
     When I run `howitzer --unknown`

data/features/cli_update.feature

@@ -0,0 +1,84 @@
+Feature: Howitzer CLI Update Existing Project
+
+  Scenario: Run with update command when project present
+    Given created old howitzer project
+    When I run `howitzer update` interactively
+    And I type "y"
+    And I type "n"
+    And I type "i"
+    Then the output should contain:
+    """
+      * Config files generation ...
+          Identical 'config/custom.yml' file
+          Added 'config/default.yml' file
+      * Root files generation ...
+          Added '.gitignore' file
+          Conflict with 'Gemfile' file
+            Overwrite 'Gemfile' file? [Yn]:          Forced 'Gemfile' file
+          Identical 'Rakefile' file
+          Conflict with 'boot.rb' file
+            Overwrite 'boot.rb' file? [Yn]:          Skipped 'boot.rb' file
+      * Cucumber integration to the framework ...
+          Identical 'features/step_definitions/common_steps.rb' file
+          Identical 'features/support/env.rb' file
+          Identical 'features/support/transformers.rb' file
+          Identical 'features/example.feature' file
+          Identical 'tasks/cucumber.rake' file
+          Identical 'config/cucumber.yml' file
+      * RSpec integration to the framework ...
+          Identical 'spec/spec_helper.rb' file
+          Identical 'spec/example_spec.rb' file
+          Identical 'tasks/rspec.rake' file
+    """
+    And the exit status should be 0
+    When I run `howitzer update` interactively
+    And I type "y"
+    Then the output should contain:
+    """
+      * Config files generation ...
+          Identical 'config/custom.yml' file
+          Identical 'config/default.yml' file
+      * Root files generation ...
+          Identical '.gitignore' file
+          Identical 'Gemfile' file
+          Identical 'Rakefile' file
+          Conflict with 'boot.rb' file
+            Overwrite 'boot.rb' file? [Yn]:          Forced 'boot.rb' file
+      * Cucumber integration to the framework ...
+          Identical 'features/step_definitions/common_steps.rb' file
+          Identical 'features/support/env.rb' file
+          Identical 'features/support/transformers.rb' file
+          Identical 'features/example.feature' file
+          Identical 'tasks/cucumber.rake' file
+          Identical 'config/cucumber.yml' file
+      * RSpec integration to the framework ...
+          Identical 'spec/spec_helper.rb' file
+          Identical 'spec/example_spec.rb' file
+          Identical 'tasks/rspec.rake' file
+    """
+    And the exit status should be 0
+
+  Scenario: Run with update command when project missing
+    When I run `howitzer update`
+    Then the output should contain:
+    """
+    error: Current directory is not Howitzer project
+    """
+    And the exit status should be 126
+
+  Scenario Outline: Run with update command with help option
+    When I run `howitzer update <option>`
+    Then the output should contain exactly:
+    """
+    NAME
+        update - Upgrade existing project
+
+    SYNOPSIS
+        howitzer [global options] update 
+
+    """
+    And the exit status should be 0
+  Examples:
+    | option |
+    | --help |
+    | -h     |

data/features/step_definitions/common_steps.rb

@@ -1 +1,9 @@
-# For custom stem definitions
+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

data/generators/base_generator.rb

@@ -2,12 +2,8 @@ require 'fileutils'
 
 module Howitzer
   class BaseGenerator
-    def self.logger=(logger)
-      @logger = logger
-    end
-
-    def self.destination=(destination)
-      @destination = destination
+    class << self
+      attr_accessor :logger, :destination
     end
 
     def initialize
@@ -16,11 +12,9 @@ module Howitzer
         case type
           when :files
             copy_files(list)
-          #:nocov:
           when :templates
             copy_templates(list)
           else nil
-          #:nocov:
         end
       end
     end
@@ -31,11 +25,11 @@ module Howitzer
     def banner; end
 
     def logger
-      BaseGenerator.instance_variable_get(:@logger) || $stdout
+      BaseGenerator.logger || $stdout
     end
 
     def destination
-      BaseGenerator.instance_variable_get(:@destination) || Dir.pwd
+      BaseGenerator.destination || Dir.pwd
     end
 
     def copy_files(list)
@@ -45,7 +39,7 @@ module Howitzer
         if File.exists?(source_file)
           copy_with_path(data)
         else
-          print_error("File '#{source_file}' was not found.")
+          puts_error("File '#{source_file}' was not found.")
         end
       end
     end
@@ -59,10 +53,14 @@ module Howitzer
     end
 
     def print_info(data)
+      logger.print "      #{data}"
+    end
+
+    def puts_info(data)
       logger.puts "      #{data}"
     end
 
-    def print_error(data)
+    def puts_error(data)
       logger.puts "      ERROR: #{data}"
     end
 
@@ -80,10 +78,27 @@ module Howitzer
       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")
+      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
+      else
+        FileUtils.cp(src, dst)
+        puts_info("Added '#{data[:destination]}' file")
+      end
     rescue => e
-      print_error("Impossible to create '#{data[:destination]}' file. Reason: #{e.message}")
+      puts_error("Impossible to create '#{data[:destination]}' file. Reason: #{e.message}")
     end
   end
 end