howitzer 1.0.1 → 1.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1ccf5128e9fd63e0b38181fb268f299e7fce85b5
+  data.tar.gz: 7673a8839534fa1b4e66857b3c5ece195564637f
+SHA512:
+  metadata.gz: 5a38c6ce3b3c19ddd8479290fc106fd248ea8746938fb8fd5efae051b5a3fe404007b41504f6d701b48d3ee44d1ca53a1326d7da4c220f62cd5d6753d95535c8
+  data.tar.gz: f53c4432a9ebe7407ea49b53b978370b6d7bfa790ce3ebee55c3591897800156beaf3c810ed3a51817fd22087ce8998cbf3fc9a9f91cf88adeb1dcc4df426c6d

data/.gitignore

@@ -5,4 +5,7 @@ coverage
 vendor/bundle/*
 spec/log/*
 Gemfile.lock
-doc
+doc
+tmp
+.bundle
+**/.DS_Store

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
-  - "1.9.3"
-  - "2.0.0"
+  - 1.9.3
+  - 2.0.0
+  - 2.1.1

data/CHANGELOG.md

@@ -1,23 +1,43 @@
-## In git
+## [In git](https://github.com/strongqa/howitzer/compare/master...develop)
 
 ### New Features
 
 ### Bugfixes
 
-## [v1.0.1](https://github.com/romikoops/howitzer/compare/v1.0...v1.0.1)
+## [v1.0.2](https://github.com/strongqa/howitzer/compare/v1.0.1...v1.0.2)
+
+### New Features
+- Added Ruby 2.1 supporting
+- Added Windows Supporting
+- Improved project documentation
+- Simplified new project creation
+- Rewritten Mailgun integration to support Fabruary changes
+- Created [Howitzer_example](https://github.com/strongqa/howitzer_example)
+- Moved from personal github account to organization
+- Added supporting of native selenium phantomjs driver
+- Implemented smart page identification
+- Rewritten command line interface and covered by acceptance tests fully
+- Simplified DataStorage clearing after each tests
+
+### Bugfixes
+- Fixed reset session after each scenario against to IE
+- Corrected default Cucumber and Rspec formatters
+- Minor bug fixing and code refactoring
+
+## [v1.0.1](https://github.com/strongqa/howitzer/compare/v1.0...v1.0.1)
 
 ### Bugfixes
 - Fixed unit tests
 - Fixed correct Ruby version supporting
 
-## [v1.0](https://github.com/romikoops/howitzer/compare/v0.0.3...v1.0)
+## [v1.0](https://github.com/strongqa/howitzer/compare/v0.0.3...v1.0)
 
 It is major release, so there are many new features, refactoring, unit tests, code documentation.
 
 **Caution**: It is not going to support old versions anymore.
 
 
-## [v0.0.3](https://github.com/romikoops/howitzer/compare/v0.0.1...v0.0.3)
+## [v0.0.3](https://github.com/strongqa/howitzer/compare/v0.0.1...v0.0.3)
 
 ### New Features
 
@@ -27,6 +47,6 @@ It is major release, so there are many new features, refactoring, unit tests, co
 
 * Fixed problem with dependencies 
 
-## [v0.0.1](https://github.com/romikoops/howitzer/tree/v0.0.1)
+## [v0.0.1](https://github.com/strongqa/howitzer/tree/v0.0.1)
 
 Initial version

data/GETTING_STARTED.md

@@ -2,6 +2,7 @@ Getting Started
 ===============
 
 ## Jump to Section
+* [Available Drivers](#available-drivers)
 * [Pages](#pages)
    * [Validations](#validations)
    * [Locators](#locators)
@@ -18,6 +19,126 @@ Getting Started
    * [Cucumber Tranformers](#cucumber-transformers)
 * [RSpec Folder Structure](#rspec-folder-structure)
 
+Available Drivers
+------
+[[Back To Top]](#jump-to-section)
+
+**Driver** - universal interface for test runners against to different web browsers. All implementations of drivers can be divided to 2 categories:
+
+* **Headless testing** - browser emulation without GUI(very useful on CI servers, like Bamboo, TeamCity, Jenkins, etc.)
+* **Real browser testing** - integration with real browsers via extensions, plugins, ActiveX, etc.(for local and cloud based testing, like SauceLabs, Testingbot)
+
+Howitzer uses [Capybara](http://jnicklas.github.io/capybara/) for driver management and configuration. All that you really need:
+ - specify the **driver** settings in _config/default.yml_
+ - specify some additional settings for chosen driver.
+Bellow you can find aggregated table with some useful informations about driver settings in Howitzer:
+
+<table>
+<thead>
+  <tr>
+    <th>Driver</th>
+    <th align="center">Category</th>
+    <th align="center">Setting name</th>
+    <th align="center">Setting type</th>
+    <th align="center">Description</th>
+  </tr>
+</thead>
+<tbody>
+  <tr>
+    <td><a href="http://phantomjs.org/">phantomjs</a>(<strong>default</strong>)</td>
+    <td align="center">Headless</td>
+    <td align="left" rowspan="2">
+      <strong>pjs_ignore_js_errors</strong><br/><br/>
+      <strong>pjs_ignore_ssl_errors</strong>
+    </td>
+    <td align="left" rowspan="2">
+      Boolean <br/><br/>
+      Boolean
+    </td>
+    <td align="left" rowspan="2">
+      if false, then raises exception on js error in app<br/>
+      if false, then ignores ssl warnings
+    </td>
+  </tr>
+  <tr>
+    <td><a href="https://github.com/teampoltergeist/poltergeist">poltergeist</a></td>
+    <td align="center">Headless</td>
+  </tr>
+  <tr>
+    <td><a href="https://github.com/thoughtbot/capybara-webkit">webkit</a></td>
+    <td align="center">Headless</td>
+    <td align="center">-</td>
+    <td align="center">-</td>
+    <td align="center">-</td>
+  </tr>
+  <tr>
+    <td><a href="https://code.google.com/p/selenium/wiki/RubyBindings">selenium</a></td>
+    <td align="center">Real</td>
+    <td align="center"><strong>sel_browser</strong></td>
+    <td align="center">String</td>
+    <td align="center">specify one of next browsers: iexplore (ie), firefox (ff), chrome, opera, safari</td>
+  </tr>
+  <tr>
+    <td>selenium_dev</td>
+    <td align="center">Real</td>
+    <td align="center"><strong>-</strong></td>
+    <td align="center">-</td>
+    <td align="center">Execute tests against to FireFox with firebug and firepath extensions</td>
+  </tr>
+  <tr>
+    <td><a href="https://saucelabs.com">sauce</a></td>
+    <td align="center">Real</td>
+    <td align="center">
+    <strong>sl_user<strong><br/>
+    <strong>sl_api_key</strong><br/>
+    <strong>sl_url</strong><br/>
+    <strong>sl_platform</strong><br/>
+    <strong>sl_browser_name</strong><br/>
+    <strong>sl_selenium_version</strong><br/>
+    <strong>sl_max_duration</strong><br/>
+    <strong>sl_idle_timeout</strong></td>
+    <td align="center">
+    String<br/>
+    String<br/>
+    String<br/>
+    Symbol<br/>
+    String<br/>
+    String<br/>
+    String<br/>
+    String</td>
+    <td align="center">See details <a href="https://saucelabs.com/docs/additional-config">here</a></td>
+  </tr>
+  <tr>
+    <td><a href="http://testingbot.com">testingbot</a></td>
+    <td align="center">Real</td>
+    <td align="center">
+      <strong>tb_api_key<strong><br/>
+      <strong>tb_api_secret<strong><br/>
+      <strong>tb_url<strong><br/>
+      <strong>tb_platform<strong><br/>
+      <strong>tb_browser_name<strong><br/>
+      <strong>tb_browser_version<strong><br/>
+      <strong>tb_selenium_version<strong><br/>
+      <strong>tb_max_duration<strong><br/>
+      <strong>tb_idle_timeout<strong><br/>
+      <strong>tb_record_screenshot<strong>
+    </td>
+    <td align="center">
+    String<br/>
+    String<br/>
+    String<br/>
+    Symbol<br/>
+    String<br/>
+    Numberic<br/>
+    String<br/>
+    String<br/>
+    String<br/>
+    Boolean</td>
+    <td align="center">See details <a href="http://testingbot.com/support/other/test-options">here</a></td>
+  </tr>
+</tbody>
+</table>
+
 Pages
 ------
 [[Back To Top]](#jump-to-section)
@@ -36,6 +157,8 @@ Each page contains required constant URL(the relative URL of the page):
 **Example :**
 
 ```ruby
+# put the class to ./pages/home_page.rb file
+
 class HomePage < WebPage
   URL = '/'
 end
@@ -65,7 +188,7 @@ Validation Type    | Options | Value Type    | Description
 ```ruby
 class HomePage < WebPage
   URL = '/'
-  validates :url, pattern: /#{Regexp.escape(settings.app_host)}\/?\z/
+  validates :url, pattern: /\A(?:.*?:\/\/)?[^\/]*\/?\z/
 end
 ```
 
@@ -119,7 +242,7 @@ Each page contains a description of all elements by adding the appropriate locat
 ```ruby
 class HomePage < WebPage
   URL = '/'
-  validates :url, pattern: /#{Regexp.escape(settings.app_host)}\/?\z/
+  validates :url, pattern: /\A(?:.*?:\/\/)?[^\/]*\/?\z/
 
   add_locator :test_locator_name1,  '.foo'                         #css locator, default
   add_locator :test_locator_name2,  css: '.foo'                    #css locator
@@ -247,16 +370,34 @@ Emails
 ------
 [[Back To Top]](#jump-to-section)
 
-_**Email**_ class uses `Mailgun` gem and allows you to work with the mailbox.
-Class corresponds to one letter. Used to test the notifications.
+Howitzer uses amazing service [Mailgun](http://mailgun.com) which allows to catch all emails of sandbox domain, and to store them to its data storage during 3 days. It is extrimaly useful for new user creation with email confirmation during testing of web applications
+
+You can use **free** account. Follow steps below:
 
-**.find_by_recipient (recipient)** - search for the letter recipient. The parameter receives email recipient.
+1. Sign up [here](https://mailgun.com/signup)
+2. Login and copy your API Key
+3. Open config/default.yml file of your project, find **mailgun_key** setting and past copied api key there.
+4. Open Mailgun web page again and copy mailgun domain, ie. 'sandboxbaf443d4c81b43d0b64a413805dc6f68.mailgun.org'
+5. Open config/default.yml file of your project again, find **mailgun_domain** setting and past copied mailgun domain there.
+6. Open Mailgun web page again and navigate to **Routes** menu
+7. Create new route with following parameters
 
-**.find (recipient, subject)** - same as the **self.find_by_recipient (recipient)**, but only in case, when we do not know in advance what kind of _subject_ has email.
+Priority  | Filter Expression     | Action  | Description         
+:--------:|:---------------------:|:-------:|:------------------
+ 0        | match_recipient(".*") | store() | Store all messages
 
-**\#plain_text_body** - receiving text of messages
+_**Email**_ Class corresponds to one letter. Used to test the notifications.
 
-**\#get_mime_part** - allows you to receive the attachment of email
+* **.find_by_recipient (recipient)** - search for the letter recipient. The parameter receives email recipient.
+* **.find (recipient, subject)** - same as the **self.find_by_recipient (recipient)**, but only in case, when we do not know in advance what kind of _subject_ has email.
+* **\#plain_text_body** - receiving body of message as plain text
+* **\#html_body** - receiving body of messages as html
+* **\#text_body** - receiving body of messages as stripped text
+* **\#mail_from** - returns who has send email data in format: User Name <user@email>
+* **\#recipients** - returns array of recipients who has received current email
+* **\#received_time** - returns email received time
+* **\#sender_email** - returns sender user email
+* **\#get_mime_part** - allows you to receive the attachment of email
 
 **Example:**
 ```ruby
@@ -267,6 +408,8 @@ end
 
 Example, how custom class might look like:
 ```ruby
+# put the class to ./emails/my_email.rb file
+
 class MyEmail <Email
   SUBJECT = "Test email" # specify the subject of an email
 
@@ -403,11 +546,12 @@ Data Storage is simple key value storage, which uses namespaces (for example, :u
 This module has next methods:
 
 
-Method                                |  Description
-:------------------------------------:|:--------------------------------------------------:
-|  DataStorage.store(ns,key,value)    | Adds data to storage, where ns - uniq namespace name
-|  DataStorage::extract(ns, key=nil)  | Gets data from storage by namespace and key. If key is not specified, then it will returns all data from namespace
-|  DataStorage::clear_ns(ns)          | Removes namespace with data
+Method                                      |  Description
+:------------------------------------------:|:--------------------------------------------------:
+|  DataStorage.store(ns,key,value)          | Adds data to storage, where ns - uniq namespace name
+|  DataStorage::extract(ns, key=nil)        | Gets data from storage by namespace and key. If key is not specified, then it will returns all data from namespace
+|  DataStorage::clear_ns(ns)                | Removes namespace with data
+|  DataStorage::clear_all_ns(exception_list=SPECIAL_NS_LIST)| Removes all namespaces except special namespaces provided as array
 
 **Example:**
 ```ruby
@@ -527,3 +671,4 @@ You can run all tests from this folder by command:
 ```bash
 rake rspec:bvt:accounts
 ```
+

data/README.md

@@ -1,12 +1,20 @@
 # 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)
+[![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]
+[![Code Climate](https://codeclimate.com/github/romikoops/howitzer.png)][codeclimate]
+[![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
+[codeclimate]: https://codeclimate.com/github/romikoops/howitzer
+[license]: https://github.com/strongqa/howitzer/blob/master/LICENSE
 
 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).
+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).
 
 ## Key benefits
 - Independent of test web application, its technologies and lanquage.
@@ -20,44 +28,35 @@ The framework uses modern patterns, techniques and tools in automated testing ar
 
 
 ## Documentation
-See [GETTING_STARTED](https://github.com/romikoops/howitzer/blob/develop/GETTING_STARTED.md) how to work with *howitzer*.
+See [GETTING_STARTED](https://github.com/strongqa/howitzer/blob/develop/GETTING_STARTED.md) how to work with *howitzer*.
 
 Also you can find 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
+
 ## Requirements
-Ruby 1.9.3+
+* 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)
+* [PhantomJS](http://phantomjs.org/download.html)
+* [ChromeDriver](https://code.google.com/p/selenium/wiki/ChromeDriver)
 
 ## Setup
 To install, type
 
 ```bash
-sudo gem install howitzer
+gem install howitzer
 ```
 
 ## Usage
-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
-```
+navigate to desired directory where new project will be created
 
-Or for both the ones:
+To deploy the framework with Cucumber, type:
 
 ```bash
-howitzer install --cucumber --rspec
+howitzer new <PROJECT NAME> --cucumber
 ```
 
 This command will generate next folders and files:
@@ -84,15 +83,33 @@ Gemfile
 Rakefile
 .gitignore
 ```
+
+With Rspec:
+
+```bash
+howitzer new <PROJECT NAME> --rspec
+```
+
+With both the ones:
+
+```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.
 
 ## Test implementation workflow
 
-- Prepare some feature with scenarios in `features/some.feature` file.
-- Implement step definitions in `features/step_definitions/common_steps.rb` file.
-- Implement appropriate pages in `pages` folder. For details, see [Page Object Pattern](https://github.com/romikoops/howitzer/wiki/PageObject-pattern).
-- Debug feature.
+- Prepare Features and Scenarios
+- Implement appropriate pages in `pages` folder. For details, see [Page Object Pattern](https://github.com/strongqa/howitzer/wiki/PageObject-pattern).
+- Implement emails in `emails` folder.
+- Implement scenarios:
+  * 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
+- Debug feature against to desired driver.
 - Enjoy it!
 
 ## Rake tasks
@@ -106,7 +123,7 @@ 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)
+* [Issues](https://github.com/strongqa/howitzer/issues)
 
 ## Contributing
 

data/Rakefile

@@ -4,6 +4,15 @@ Bundler.setup
 
 require 'rake'
 require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
 Bundler::GemHelper.install_tasks
 RSpec::Core::RakeTask.new(:spec) { |spec| }
-task :default => :spec
+
+Cucumber::Rake::Task.new(:cucumber, 'Run all cucumber features') do |t|
+  t.fork = false
+end
+
+desc "All tests"
+task(all_tests: [:spec, :cucumber]) {}
+
+task :default => :all_tests