awetestlib 0.1.29pre4 → 0.1.29

data/README.md

@@ -1,123 +1,123 @@
-Awetestlib
-==========
-
-Run automated regression and mobile tests
-
-After completing this guide you will be able to run tests locally from command line or from an IDE.
-
-------------
-
-## Prerequisites
-
-You need to have Ruby 1.8.7 installed. You can download Ruby 1.8.7 
-[here](http://rubyinstaller.org/downloads/)
-
-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
-[here](http://rubyinstaller.org/downloads/)
-and the installation directions can be found
-[here](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit)
-
-## Install
-
-In a terminal or command prompt, install the awetestlib gem:
-
-    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
-
-
-## Setup Regression Module
-
-Run the following command and verify the step
-  
-    awetestlib regression_setup
-
-## Usage
-
-Run the following command to see the different usages
-
-    awetestlib
-
-## Setup Browsers
-
-### Setup 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.
-When using raw Watir-webdriver for Safari, open the browser with
-
-    browser = Watir::Browser.new(:remote, :desired_capabilities=>:'safari')
-
-### Setup 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
-
-For Mac OSX:
-
-    echo $PATH
-
-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) 
-and move the executable into your PATH.
-
-
-### Setup IDEs (Rubymine, Netbeans)
-
-To setup the awetestlib gem with Rubymine use:
-
-    awetestlib rubymine_setup <ProjectName>
-    
-To setup awetestlib with Netbeans use:
- 
-    awetestlib netbeans_setup <ProjectName>
-
-You can now start your scripts within the IDE. Use the Run Configuration button.
-
-For additional information on IDE setup, refer to the links below:
-
-  - [Netbeans IDE setup](https://github.com/3qilabs/awetestlib/blob/develop/netbeans_setup.md)
-
-  - [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]`
-
-  For example: To run a script named demo.rb in Firefox, your command will look like.
-  - `awetestlib demo.rb -b FF`
-
-The full list of parameters for the command line currently are:
-
-    Usage: awetestlib <script_file> [parameters] [options]
-        -b, --browser BROWSER            Specify a browser (IE, FF, S, C)
-        -r, --root_path ROOT_PATH        Specify the root 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
-        -e, --environment_url URL        Specify the environment URL
-        -f, --environment_nodename NODE  Specify the environment node name
-        -n, --environment_name NAME      Specify the environment name
-        -u, --selenium_remote_url URL    Specify the device's remote url and port
-        -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
-            --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
-
-### 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.
-
-Visit our [wiki](https://github.com/3qilabs/awetestlib/wiki/Predefined-Cucumber-Web-Steps) to see the list of predefined steps provided by awetestlib
-
-
+Awetestlib
+==========
+
+Run automated regression and mobile tests
+
+After completing this guide you will be able to run tests locally from command line or from an IDE.
+
+------------
+
+## Prerequisites
+
+You need to have Ruby 1.8.7 installed. You can download Ruby 1.8.7 
+[here](http://rubyinstaller.org/downloads/)
+
+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
+[here](http://rubyinstaller.org/downloads/)
+and the installation directions can be found
+[here](https://github.com/oneclick/rubyinstaller/wiki/Development-Kit)
+
+## Install
+
+In a terminal or command prompt, install the awetestlib gem:
+
+    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
+
+
+## Setup Regression Module
+
+Run the following command and verify the step
+  
+    awetestlib regression_setup
+
+## Usage
+
+Run the following command to see the different usages
+
+    awetestlib
+
+## Setup Browsers
+
+### Setup 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.
+When using raw Watir-webdriver for Safari, open the browser with
+
+    browser = Watir::Browser.new(:remote, :desired_capabilities=>:'safari')
+
+### Setup 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
+
+For Mac OSX:
+
+    echo $PATH
+
+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) 
+and move the executable into your PATH.
+
+
+### Setup IDEs (Rubymine, Netbeans)
+
+To setup the awetestlib gem with Rubymine use:
+
+    awetestlib rubymine_setup <ProjectName>
+    
+To setup awetestlib with Netbeans use:
+ 
+    awetestlib netbeans_setup <ProjectName>
+
+You can now start your scripts within the IDE. Use the Run Configuration button.
+
+For additional information on IDE setup, refer to the links below:
+
+  - [Netbeans IDE setup](https://github.com/3qilabs/awetestlib/blob/develop/netbeans_setup.md)
+
+  - [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]`
+
+  For example: To run a script named demo.rb in Firefox, your command will look like.
+  - `awetestlib demo.rb -b FF`
+
+The full list of parameters for the command line currently are:
+
+    Usage: awetestlib <script_file> [parameters] [options]
+        -b, --browser BROWSER            Specify a browser (IE, FF, S, C)
+        -r, --root_path ROOT_PATH        Specify the root 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
+        -e, --environment_url URL        Specify the environment URL
+        -f, --environment_nodename NODE  Specify the environment node name
+        -n, --environment_name NAME      Specify the environment name
+        -u, --selenium_remote_url URL    Specify the device's remote url and port
+        -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
+            --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
+
+### 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.
+
+Visit our [wiki](https://github.com/3qilabs/awetestlib/wiki/Predefined-Cucumber-Web-Steps) to see the list of predefined steps provided by awetestlib
+
+

data/bin/awetestlib-android-setup.rb

@@ -1,28 +1,28 @@
-def awetestlib_android_setup
-  if ARGV[1].nil?
-    @proj_dir = "sample_android"
-  else
-    @proj_dir = ARGV[1]
-  end
-
-  @cucumber_dir = File.join(FileUtils.pwd, @proj_dir)
-  @source_dir = File.join(File.dirname(__FILE__), '..', 'setup_samples', 'sample_android')
-
-  if File.exists?(@cucumber_dir)
-    puts "Android project directory already exists."
-    exit 1
-  end
-
-  msg("Question") do
-    puts "I'm about to create an android project named #{@proj_dir} in this directory"
-    puts "Please hit return to confirm that's what you want."
-    puts "Enter anything else and hit return to abort."
-    puts "NOTE: You may need to run this command as an administrator."
-  end
-  exit 2 unless STDIN.gets.chomp == ''
-  FileUtils.cp_r(@source_dir, @cucumber_dir)
-  msg("Info") do
-    puts "Configuring files and settings"
-  end
-
-end
+def awetestlib_android_setup
+  if ARGV[1].nil?
+    @proj_dir = "sample_android"
+  else
+    @proj_dir = ARGV[1]
+  end
+
+  @cucumber_dir = File.join(FileUtils.pwd, @proj_dir)
+  @source_dir = File.join(File.dirname(__FILE__), '..', 'setup_samples', 'sample_android')
+
+  if File.exists?(@cucumber_dir)
+    puts "Android project directory already exists."
+    exit 1
+  end
+
+  msg("Question") do
+    puts "I'm about to create an android project named #{@proj_dir} in this directory"
+    puts "Please hit return to confirm that's what you want."
+    puts "Enter anything else and hit return to abort."
+    puts "NOTE: You may need to run this command as an administrator."
+  end
+  exit 2 unless STDIN.gets.chomp == ''
+  FileUtils.cp_r(@source_dir, @cucumber_dir)
+  msg("Info") do
+    puts "Configuring files and settings"
+  end
+
+end

data/bin/awetestlib-cucumber-setup.rb

@@ -1,30 +1,30 @@
-def awetestlib_cucumber_setup
-  if ARGV[1].nil?
-    @proj_dir = "sample_cucumber"
-  else
-    @proj_dir = ARGV[1]
-  end
-
-  @cucumber_dir = File.join(FileUtils.pwd, @proj_dir)
-  @source_dir = File.join(File.dirname(__FILE__), '..', 'setup_samples', 'sample_cucumber')
-
-  if File.exists?(@cucumber_dir)
-    puts "Cucumber project directory already exists."
-    exit 1
-  end
-
-  msg("Question") do
-    puts "I'm about to create a cucumber project named #{@proj_dir} in this directory"
-    puts "Please hit return to confirm that's what you want."
-    puts "Enter anything else and hit return to abort."
-    puts "NOTE: You may need to run this command as an administrator."
-  end
-  exit 2 unless STDIN.gets.chomp == ''
-  FileUtils.cp_r(@source_dir, @cucumber_dir)
-  msg("Info") do
-    puts "Configuring files and settings"
-    puts "From the sample_cucumber/features folder, you may now run command below:"
-    puts "cucumber yahoo_mail.feature"
-  end
-
-end
+def awetestlib_cucumber_setup
+  if ARGV[1].nil?
+    @proj_dir = "sample_cucumber"
+  else
+    @proj_dir = ARGV[1]
+  end
+
+  @cucumber_dir = File.join(FileUtils.pwd, @proj_dir)
+  @source_dir = File.join(File.dirname(__FILE__), '..', 'setup_samples', 'sample_cucumber')
+
+  if File.exists?(@cucumber_dir)
+    puts "Cucumber project directory already exists."
+    exit 1
+  end
+
+  msg("Question") do
+    puts "I'm about to create a cucumber project named #{@proj_dir} in this directory"
+    puts "Please hit return to confirm that's what you want."
+    puts "Enter anything else and hit return to abort."
+    puts "NOTE: You may need to run this command as an administrator."
+  end
+  exit 2 unless STDIN.gets.chomp == ''
+  FileUtils.cp_r(@source_dir, @cucumber_dir)
+  msg("Info") do
+    puts "Configuring files and settings"
+    puts "From the sample_cucumber/features folder, you may now run command below:"
+    puts "cucumber yahoo_mail.feature"
+  end
+
+end

data/bin/awetestlib-driver-setup.rb

@@ -1,22 +1,22 @@
-require 'pry'
-def awetestlib_driver_setup
-	current_dir = Dir.pwd
-	drivers_dir = File.expand_path(File.join(File.dirname(__FILE__), "..", "drivers"))
-	# binding.pry
-	ie_driver = File.join(drivers_dir,"IEDriverServer.exe")
-	chrome_driver = File.join(drivers_dir,"chromedriver.exe")
-	msg("Question") do
-    puts "I'm about to put the chromedriver and IEDriverServer in this directory"
-    puts "If it already exists, we will overwrite it"
-    puts "Please hit return to confirm that's what you want."
-    puts "Enter anything else and hit return to abort."
-    puts "NOTE: You may need to run this command as an administrator."
-  end
-  exit 2 unless STDIN.gets.chomp == ''
-	FileUtils.cp(ie_driver, current_dir)
-	FileUtils.cp(chrome_driver,current_dir)
-  msg("Info") do
-    puts "Successfully copied chromedriver and IEDriverServer to #{current_dir}"
-  end
-
-end
+require 'pry'
+def awetestlib_driver_setup
+	current_dir = Dir.pwd
+	drivers_dir = File.expand_path(File.join(File.dirname(__FILE__), "..", "drivers"))
+	# binding.pry
+	ie_driver = File.join(drivers_dir,"IEDriverServer.exe")
+	chrome_driver = File.join(drivers_dir,"chromedriver.exe")
+	msg("Question") do
+    puts "I'm about to put the chromedriver and IEDriverServer in this directory"
+    puts "If it already exists, we will overwrite it"
+    puts "Please hit return to confirm that's what you want."
+    puts "Enter anything else and hit return to abort."
+    puts "NOTE: You may need to run this command as an administrator."
+  end
+  exit 2 unless STDIN.gets.chomp == ''
+	FileUtils.cp(ie_driver, current_dir)
+	FileUtils.cp(chrome_driver,current_dir)
+  msg("Info") do
+    puts "Successfully copied chromedriver and IEDriverServer to #{current_dir}"
+  end
+
+end

data/bin/awetestlib-helpers.rb

@@ -1,42 +1,42 @@
-def msg(title, &block)
-  puts "\n" + "-"*10 + title + "-"*10
-  block.call
-  puts "-"*10 + "-------" + "-"*10 + "\n"
-end
-
-
-def print_usage
-  puts <<EOF
-  Usage Options:
-  
-    awetestlib regression_setup
-      setup awetest regression and register autoitx3.dll in Windows
-
-    awetestlib rubymine_setup <project_name>
-      setup a rubymine project 
-
-    awetestlib netbeans_setup <project_name>
-      setup a netbeans project
-
-    awetestlib mobile_app_setup <project_name>
-      setup a mobile app project
-
-    awetestlib cucumber_setup <project_name>
-      setup cucumber regression and provide skeleton folder structure
-
-    awetestlib <script_file> [parameters]
-      run an awetest regression script
-
-EOF
-end
-
-def check_script_type(options)
-  script_options = ['Regression', 'Cucumber']
-  if script_options.include? ARGV[0]
-    options[:script_type] = ARGV[0]
-    options[:script_file] = ARGV[1]
-  else
-    options[:script_type] = 'Regression'
-    options[:script_file] = ARGV[0]
-  end
-end
+def msg(title, &block)
+  puts "\n" + "-"*10 + title + "-"*10
+  block.call
+  puts "-"*10 + "-------" + "-"*10 + "\n"
+end
+
+
+def print_usage
+  puts <<EOF
+  Usage Options:
+  
+    awetestlib regression_setup
+      setup awetest regression and register autoitx3.dll in Windows
+
+    awetestlib rubymine_setup <project_name>
+      setup a rubymine project 
+
+    awetestlib netbeans_setup <project_name>
+      setup a netbeans project
+
+    awetestlib mobile_app_setup <project_name>
+      setup a mobile app project
+
+    awetestlib cucumber_setup <project_name>
+      setup cucumber regression and provide skeleton folder structure
+
+    awetestlib <script_file> [parameters]
+      run an awetest regression script
+
+EOF
+end
+
+def check_script_type(options)
+  script_options = ['Regression', 'Cucumber']
+  if script_options.include? ARGV[0]
+    options[:script_type] = ARGV[0]
+    options[:script_file] = ARGV[1]
+  else
+    options[:script_type] = 'Regression'
+    options[:script_file] = ARGV[0]
+  end
+end

data/bin/awetestlib-mobile-app-setup.rb

@@ -1,32 +1,32 @@
-def awetestlib_mobile_app_setup
-  if ARGV[1].nil?
-    @proj_dir = "sample_mobile_app"
-  else
-    @proj_dir = ARGV[1]
-  end
-
-  @cucumber_dir = File.join(FileUtils.pwd, @proj_dir)
-  @source_dir = File.join(File.dirname(__FILE__), '..', 'setup_samples', 'sample_mobile_app')
-
-  if File.exists?(@cucumber_dir)
-    puts "Mobile app project directory already exists."
-    exit 1
-  end
-
-  msg("Question") do
-    puts "I'm about to create a mobile app project named #{ARGV[1]} in this directory" if ARGV[1]
-    puts "I'm about to create a mobile app project named sample_mobile_app in this directory" if ARGV[1].nil?
-    puts "Please hit return to confirm that's what you want."
-    puts "Enter anything else and hit return to abort."
-    puts "NOTE: You may need to run this command as an administrator."
-  end
-  exit 2 unless STDIN.gets.chomp == ''
-
-  FileUtils.cp_r(@source_dir, @cucumber_dir)
-
-  msg("Info") do
-    puts "Configuring files and settings..."
-    puts "A skeleton project has been created with a features and step definitions folder"
-  end
-
-end
+def awetestlib_mobile_app_setup
+  if ARGV[1].nil?
+    @proj_dir = "sample_mobile_app"
+  else
+    @proj_dir = ARGV[1]
+  end
+
+  @cucumber_dir = File.join(FileUtils.pwd, @proj_dir)
+  @source_dir = File.join(File.dirname(__FILE__), '..', 'setup_samples', 'sample_mobile_app')
+
+  if File.exists?(@cucumber_dir)
+    puts "Mobile app project directory already exists."
+    exit 1
+  end
+
+  msg("Question") do
+    puts "I'm about to create a mobile app project named #{ARGV[1]} in this directory" if ARGV[1]
+    puts "I'm about to create a mobile app project named sample_mobile_app in this directory" if ARGV[1].nil?
+    puts "Please hit return to confirm that's what you want."
+    puts "Enter anything else and hit return to abort."
+    puts "NOTE: You may need to run this command as an administrator."
+  end
+  exit 2 unless STDIN.gets.chomp == ''
+
+  FileUtils.cp_r(@source_dir, @cucumber_dir)
+
+  msg("Info") do
+    puts "Configuring files and settings..."
+    puts "A skeleton project has been created with a features and step definitions folder"
+  end
+
+end