awetestlib 0.1.30pre3 → 0.1.30

data/.gitignore

@@ -67,4 +67,4 @@ dump.rdb
 config/settings.yml
 PROJECT_NAME
 *.log
-awetest_reports/
+awetest_reports/

data/README.md

@@ -1,62 +1,90 @@
 Awetestlib
 ==========
 
-Run automated regression and mobile tests
+Automate testing of browser-based applications in Windows or Mac.
 
 After completing this guide you will be able to run tests locally from command line or from an IDE.
 
 ------------
+## Prerequisites: Ruby 1.8.7 and RubyInstaller Devkit
 
-## Prerequisites
+You need to have Ruby 1.8.7 installed using RubyInstaller. 
 
-You need to have Ruby 1.8.7 installed. You can download Ruby 1.8.7 
-[here](http://rubyinstaller.org/downloads/)
+You can download the RubyInstaller for 1.8.7 
+[here](http://rubyinstaller.org/downloads/).  Choose the most recent 1.8.7.  
+
+Make sure you tell the installer to put Ruby in the PATH environment variable.
 
 You can check your Ruby version using:
 
     ruby -v
 
-Additionally, for Windows, you will need to install the RubyInstaller DevKit to compile a few dependent gems. You can download DevKit
+Additionally, for Windows, you will need to install the RubyInstaller DevKit to compile a few dependent gems. 
+
+Download DevKit
 [here](http://rubyinstaller.org/downloads/)
 and the installation directions can be found
-[here](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit)
+[here](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit). 
 
-## Install
+Choose the one for Ruby 1.8.7.
 
-In a terminal or command prompt, install the awetestlib gem:
+If you have difficulties with the above in Windows 7 and/or behind a firewall, you may have to set the http_proxy and/or run the installers as administrator. (see below)
 
-    gem install awetestlib --no-ri --no-rdoc
+## Install Awetestlib
 
-Note: This could take up to 5 minutes for first time installs.  You may need to use 'sudo' on OSX
+**Start** by opening a command window or terminal
+
+----------
+
+####NOTE: If you are behind a firewall:
+
+1. You will need to set the http_proxy environment variable
+2. You may have to change the HOMEDRIVE environment variable to C: in Windows
+3. You may need to run the Windows 7 command window as administrator.
+
+In Windows
+	
+	set http_proxy=http://myproxy.mycompany.com:80
+	set HOMEDRIVE=C:
+
+In OSX
+
+	export HTTP_PROXY=http://myproxy.mycompany.com:80
+
+
+----------
+	
 
+**Then**, in a terminal or command prompt, install the awetestlib gem:
 
-## Setup Regression Module
+    gem install awetestlib --no-ri --no-rdoc
+
+Note: This could take up to 5 minutes for first time installs.  You may need to use 'sudo' on OSX
 
-Run the following command and verify the step
+**Then** run the following command and verify the step
   
     awetestlib regression_setup
 
-## Usage
+### Usage
 
 Run the following command to see the different usages
 
     awetestlib
 
 ## Setup Browsers
-
-### Setup Safari (Mac OS X only)
-
+### Safari (Mac OS X only)
 To setup support for Safari browser, please follow the instructions at [SafariDriver](http://code.google.com/p/selenium/wiki/SafariDriver)
 
-It is important to start a selenium-server-standalone process in a terminal session before running Safari scripts.
+It is likely you will need to start a selenium-server-standalone process in a terminal session before running Safari scripts, else you will get a 'waiting for connection' error. Get the jar [here](https://code.google.com/p/selenium/downloads/list).
+
 When using raw Watir-webdriver for Safari, open the browser with
 
     browser = Watir::Browser.new(:remote, :desired_capabilities=>:'safari')
 
-### Setup Chrome
+### Chrome
 To setup support for Google Chrome browser, please download the latest Chromedriver version from [here](http://code.google.com/p/chromedriver/downloads/list) 
 
-Then move the executables in your PATH. To find your PATHs, type the command below in your terminal/command prompt
+Then move the executables in your PATH. To find your PATH, type the command below in your terminal/command prompt:
 
 For Mac OSX:
 
@@ -65,13 +93,15 @@ For Mac OSX:
 For Windows:
 
     PATH
-    
-### Setup Internet Explorer
-To setup support for Internet Explorer, please download the latest IEDriver version from [here](http://code.google.com/p/selenium/downloads/list) 
+ 
+We suggest putting both drivers in \Ruby187\bin as it should already be in your path.
+   
+### Internet Explorer
+To setup support for Internet Explorer, please download the latest IEDriverServer version from [here](http://code.google.com/p/selenium/downloads/list) 
 and move the executable into your PATH.
 
 
-### Setup IDEs (Rubymine, Netbeans)
+## Setup IDEs (Rubymine, Netbeans)
 
 To setup the awetestlib gem with Rubymine use:
 
@@ -81,7 +111,7 @@ To setup awetestlib with Netbeans use:
  
     awetestlib netbeans_setup <ProjectName>
 
-You can now start your scripts within the IDE. Use the Run Configuration button.
+You can now start your scripts within the IDE. Follow the instructions in each IDE for creating and executing run/debug configurations.
 
 For additional information on IDE setup, refer to the links below:
 
@@ -89,17 +119,20 @@ For additional information on IDE setup, refer to the links below:
 
   - [Rubymine IDE setup](https://github.com/3qilabs/awetestlib/blob/develop/rubymine_setup.md)
 
-3. If you prefer to run your tests from command line, you can use the following command
-  - `awetestlib <script_file> [parameters]`
+## Command Line Execution
+If you prefer to run your tests from command line, you can use the following command
+
+  `awetestlib <script_file> [parameters]`
+
+  For example: To run a script named demo.rb in Firefox, your command will look like:
 
-  For example: To run a script named demo.rb in Firefox, your command will look like.
-  - `awetestlib demo.rb -b FF`
+  `awetestlib demo.rb -b FF`
 
-The full list of parameters for the command line currently are:
+Here is the full list of the currently available command line parameters:
 
-    Usage: awetestlib <script_file> [parameters] [options]
+    Usage: awetestlib <script_file> [parameters]
         -b, --browser BROWSER            Specify a browser (IE, FF, S, C)
-        -r, --root_path ROOT_PATH        Specify the root path
+        -r, --root_path ROOT_PATH        Specify the root path (default is current path)
         -l, --library LIBRARY            Specify a library to be loaded
         -x, --excel EXCEL_FILE           Specify an excel file containing variables to be loaded
         -v, --version VERSION            Specify a browser version
@@ -110,13 +143,21 @@ The full list of parameters for the command line currently are:
         -s, --screencap_path PATH        Specify the path where screenshots will be saved
         -o, --output_to_log              Write to log file
             --log_path_subdir SUBDIR     Specify log path relative to root_path
+		-p, --pry						 Require Pry for debugging
+		-c, --classic_watir				 Use Classic Watir for IE instead of Watir-webdriver
             --report_all_test_refs       Include list of all error/test case reference ids actually validated
 
-To start writing your own script, refer to the [Scripting Guide/Wiki](https://github.com/3qilabs/awetestlib/wiki/Getting-Started---Scripting) wiki
+To start writing your own script, refer to the [Scripting Guide/Wiki](https://github.com/3qilabs/awetestlib/wiki/Getting-Started---Scripting) wiki.
+
+For the latest documentation of the Awetest DSL go to [Rubydoc](http://rubydoc.info/gems/awetestlib) and look in Awetestlib::Regression.
 
 ### Cucumber Support 
 
-One of the technologies that the Awetest framework supports is [Cucumber](http://cukes.info/). To get setup with cucumber, you can run the following command: `awetestlib cucumber_setup` which will create your typical cucumber folder structure.
+One of the technologies that the Awetest framework supports is [Cucumber](http://cukes.info/). To get setup with cucumber, you can run the following command:
+
+`awetestlib cucumber_setup <ProjectName>`
+
+That will create the standard cucumber folder structure in the ProjectName directory.
 
 Visit our [wiki](https://github.com/3qilabs/awetestlib/wiki/Predefined-Cucumber-Web-Steps) to see the list of predefined steps provided by awetestlib
 

data/lib/awetestlib/html_report.rb

@@ -147,6 +147,21 @@ module Awetestlib
 
       @reportContent2 += row + "\n"
 
+
+      #if (result == 'PASSED')
+      #  @reportContent2 = @reportContent2 + '<tr>C'
+      #  @reportContent2 = @reportContent2 + '<td class=border_right width=20%><p class=result_ok>' + result + '</p></td>'
+      #elsif (result == 'FAILED')
+      #  @reportContent2 = @reportContent2 + '<tr><td class=border_left width=80%><p class=normal_text>' + step + '</p></td>'
+      #  @reportContent2 = @reportContent2 + '<td class=border_right width=20%><p class=result_nok>' + result + '</p></td>'
+      #elsif level < 1
+      #  @reportContent2 = @reportContent2 + '<tr><td class=border_left width=80%><p class=normal_text>' + step + '</p></td>'
+      #  @reportContent2 = @reportContent2 + '<td class=border_right width=20%><p class=result_ok>' + result + '</p></td>'
+      #else
+      #  @reportContent2 = @reportContent2 + '<tr><td class=mark_testlevel_left width=80%><p class=bold_large_text>' + step + '</p></td>'
+      #  @reportContent2 = @reportContent2 + '<td class=mark_testlevel_right width=20%><p class=result_ok>' + result + '</p></td>'
+      #end
+
     end
 
     # Close the report HTML

data/lib/version.rb

@@ -1,4 +1,4 @@
 module Awetestlib
-  VERSION = "0.1.30pre3"
-  VERSION_DATE = "2013-05-06"
+  VERSION = "0.1.30"
+  VERSION_DATE = "2013-05-21"
 end

data/setup_samples/sample_cucumber/features/step_definitions/predefined_steps.rb

@@ -5,20 +5,20 @@ rescue
 end
 
 def setup_classic_watir
-    require 'watir'
-    require 'win32ole'
-    $ai          = ::WIN32OLE.new('AutoItX3.Control')
-    $first_index = 1
-    $timestamp     = Time.now.strftime("%Y%m%d%H%M%S")
-    $watir_script = true
-    Watir::IE.close_all
-    Watir::IE.visible = true
-  end
+  require 'watir'
+  require 'win32ole'
+  $ai           = ::WIN32OLE.new('AutoItX3.Control')
+  $first_index  = 1
+  $timestamp    = Time.now.strftime("%Y%m%d%H%M%S")
+  $watir_script = true
+  Watir::IE.close_all
+  Watir::IE.visible = true
+end
 
 def setup_watir_webdriver
   require 'watir-webdriver'
-  $first_index = 0
-  $timestamp     = Time.now.strftime("%Y%m%d%H%M%S")
+  $first_index  = 0
+  $timestamp    = Time.now.strftime("%Y%m%d%H%M%S")
   $watir_script = false
 end
 
@@ -27,6 +27,11 @@ def open_firefox
   @browser = Watir::Browser.new :firefox
 end
 
+def open_safari
+  setup_watir_webdriver
+  @browser = Watir::Browser.new(:remote, :desired_capabilities => :'safari')
+end
+
 def open_chrome
   setup_watir_webdriver
   @browser = Watir::Browser.new :chrome
@@ -47,7 +52,7 @@ end
 
 def navigate_to_environment_url
   if @params and @params['environment'] and @params['environment']['url']
-  url = @params['environment']['url']
+    url = @params['environment']['url']
   elsif @login and @login['url']
     url = @login['url']
   elsif @role and @login[@role] and @login[@role]['url']
@@ -58,22 +63,24 @@ end
 
 def open_a_browser
   if @params
-     puts "@params: #{@params}"
- 	  case @params["browser"]
-       when "FF"
-         open_firefox
-       when "IE"
-         open_internet_explorer
-       when "C", "GC"
-         open_chrome
- 	  end
- 	else
-     if $watir_script
-       open_internet_explorer
-     else
-       open_firefox
-     end
-   end
+    puts "@params: #{@params}"
+    case @params["browser"]
+      when "FF"
+        open_firefox
+      when "IE"
+        open_internet_explorer
+      when "C", "GC"
+        open_chrome
+      when "S"
+        open_safari
+    end
+  else
+    if $watir_script
+      open_internet_explorer
+    else
+      open_firefox
+    end
+  end
 end
 
 Given /^I run with Watir$/ do
@@ -253,9 +260,9 @@ When /^I wait until "?(.*?)"? with "?(.*?)"? "(.*?)" is ready$/ do |element, how
   #what = Regexp.new(Regexp.escape(what)) unless how =~ /index|text/i or what.is_a?(Regexp)
   ok = false
   if $watir_script
-    if Watir::Wait.until {@browser.element(how, what).exists?}
-      if Watir::Wait.until {@browser.element(how, what).visible?}
-        if Watir::Wait.until {@browser.element(how, what).enabled?}
+    if Watir::Wait.until { @browser.element(how, what).exists? }
+      if Watir::Wait.until { @browser.element(how, what).visible? }
+        if Watir::Wait.until { @browser.element(how, what).enabled? }
           ok = true
         end
       end
@@ -269,8 +276,8 @@ When /^I wait until "?(.*?)"? with "?(.*?)"? "(.*?)" is ready$/ do |element, how
       when 'text field'
         sleep 2
         #if @browser.text_field(how.to_sym, what).wait_until_present
-          ok = true
-        #end
+        ok = true
+      #end
       else
         if @browser.element(how.to_sym, what).wait_until_present
           ok = true
@@ -306,14 +313,14 @@ end
 
 Given /^I load data spreadsheet "(.*?)" for "(.*?)"$/ do |file, feature|
   require 'roo'
-  @workbook               = Excel.new(file)
-  @feature_name           = feature     #File.basename(feature, ".feature")
+  @workbook     = Excel.new(file)
+  @feature_name = feature #File.basename(feature, ".feature")
   step "I load @login from spreadsheet"
   step "I load @var from spreadsheet"
 end
 
 Then /^I load @login from spreadsheet$/ do
-  @login                 = Hash.new
+  @login                  = Hash.new
   @workbook.default_sheet = @workbook.sheets[0]
 
   script_col   = 0
@@ -362,10 +369,10 @@ Then /^I load @login from spreadsheet$/ do
 end
 
 Then /^I load @var from spreadsheet$/ do
-  @var                   = Hash.new
+  @var                    = Hash.new
   @workbook.default_sheet = @workbook.sheets[1]
-  script_col             = 0
-  name_col               = 0
+  script_col              = 0
+  name_col                = 0
 
   1.upto(@workbook.last_column) do |col|
     header = @workbook.cell(1, col)

metadata

@@ -1,15 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: awetestlib
 version: !ruby/object:Gem::Version 
-  hash: -223651761
-  prerelease: 6
+  hash: 39
+  prerelease: 
   segments: 
   - 0
   - 1
   - 30
-  - pre
-  - 3
-  version: 0.1.30pre3
+  version: 0.1.30
 platform: ruby
 authors: 
 - Anthony Woo
@@ -18,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2013-05-06 00:00:00 Z
+date: 2013-05-21 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: watir-webdriver
@@ -398,4 +396,3 @@ specification_version: 3
 summary: Awetest DSL for automated testing of browser-based applications.
 test_files: []
 
-has_rdoc: