awetestlib 0.1.2 → 0.1.5

data/README.md

@@ -0,0 +1,55 @@
+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://http://rubyinstaller.org/downloads/)
+
+Additionally, you will need to install DevKit to compile a few dependent gems. You can download DevKit
+[here](http://http://rubyinstaller.org/downloads/)
+
+### Install
+
+1. In a terminal or command prompt, install the awetestlib gem
+  - `gem install awetestlib --no-ri --no-rdoc`
+
+
+2. To setup the regression module, run the following command and verify the step
+  - `awetestlib regression_setup`
+
+### Usage
+
+1. Run the following command to see the different usages
+  - `awetestlib`
+
+2. To setup the awetestlib gem with Netbeans or Rubymine, run either of the commands
+  - `awetestlib rubymine_setup`
+
+  or 
+  - `awetestlib netbeans_setup`
+
+  You can now start your scripts within the IDE. Use the Run Configuration button.
+
+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)
+        -l, --library LIBRARY            Specify a library to be loaded
+        -r, --root_path ROOT_PATH        Specify the root path
+        -x, --excel EXCEL_FILE           Specify an excel file containing variables to be loaded
+        -v, --version VERSION            Specify a browser version
+
+

data/awetestlib.windows.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
   s.add_dependency('i18n')
   s.add_dependency('andand')
   s.add_dependency('watirloo')
-  s.add_dependency('win32-process')
+  s.add_dependency('win32-process', '0.6.6')
   s.add_dependency('win32screenshot')
   s.add_dependency('spreadsheet', '0.6.8')
   s.add_dependency('google-spreadsheet-ruby', '0.1.6')

data/awetestlib_osx.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
   s.add_dependency('nokogiri')
   s.add_dependency('i18n')
   s.add_dependency('rb-appscript')
+  s.add_dependency('json', '1.4.6') #for safari support
 
   s.require_paths = ["lib"]   #,"ext"]
   s.files = `git ls-files`.split("\n")

data/bin/awetestlib

@@ -1,4 +1,23 @@
 $: << "./lib"
+require File.join(File.dirname(__FILE__),"awetestlib-helpers")
+require 'fileutils'
+
+cmd = ARGV[0]
+
+if cmd.nil?
+  print_usage
+  
+elsif cmd == "regression_setup"
+  require File.join(File.dirname(__FILE__),"awetestlib-regression-setup")
+  awetestlib_regression_setup
+elsif cmd == "rubymine_setup"
+  require File.join(File.dirname(__FILE__),"awetestlib-rubymine-setup")
+  awetestlib_rubymine_setup
+elsif cmd == "netbeans_setup"
+  require File.join(File.dirname(__FILE__),"awetestlib-netbeans-setup")
+  awetestlib_netbeans_setup
+else
+
 require 'optparse'
 require 'awetestlib'
 
@@ -59,9 +78,10 @@ options[:environment] ||= {}
 options[:environment]["name"] = options[:environment_name]
 options[:environment]["url"] = options[:environment_url]
 options[:environment]["nodename"] = options[:environment_nodename]
-options[:script_type] = 'AwetestLegacy'
-options[:script_file] = ARGV[0]
+check_script_type(options)
 
 IS_WIN_2008 = File.exists?("config/win2008.txt")
+Awetestlib::Runner.new(options)
+
 
-Awetestlib::Runner.new(options).start
+end

data/bin/awetestlib-helpers.rb

@@ -0,0 +1,39 @@
+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 registers autoitx3.dll
+
+    awetestlib rubymine_setup
+      setup a sample rubymine project
+
+    awetestlib netbeans_setup
+      setup a sample netbeans project
+
+    awetestlib cucumber_setup
+      setup cucumber regression and provides 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-netbeans-setup.rb

@@ -0,0 +1,39 @@
+def edit_config_file
+  @new_config_file = File.join(FileUtils.pwd,"sample_netbeans","nbproject","private","configs", "Demo.properties")
+  @demo_script = File.join(FileUtils.pwd,"sample_netbeans", "demo.rb")
+  workspace_text = File.read(@new_config_file)
+  new_workspace_text = workspace_text.gsub(/SAMPLE-SCRIPT/,@demo_script )
+  File.open(@new_config_file, "w") {|file| file.puts new_workspace_text}
+end
+
+def edit_private_file
+  @new_private_file = File.join(FileUtils.pwd,"sample_netbeans","nbproject","private", "private.properties")
+  @bin_dir = File.join(File.dirname(__FILE__))
+  workspace_text = File.read(@new_private_file)
+  new_workspace_text = workspace_text.gsub(/BIN-DIR/,@bin_dir )
+  File.open(@new_private_file, "w") {|file| file.puts new_workspace_text}
+end
+
+def awetestlib_netbeans_setup
+  @netbeans_dir = File.join(FileUtils.pwd, "sample_netbeans")
+  @source_dir = File.join(File.dirname(__FILE__), '..', 'setup_samples', 'sample_netbeans')
+
+  if File.exists?(@netbeans_dir)
+    puts "Sample Netbeans directory already exists."
+    exit 1
+  end
+
+  msg("Question") do
+    puts "I'm about to create a sample netbeans project in this directory"
+    puts "Please hit return to confirm that's what you want."
+    puts "NOTE: You may need to run this command as an administrator."
+  end
+  exit 2 unless STDIN.gets.chomp == ''
+  FileUtils.cp_r(@source_dir, @netbeans_dir)
+  edit_config_file
+  edit_private_file
+  msg("Info") do
+    puts "Configuring files and settings"
+  end
+
+end

data/bin/awetestlib-regression-setup.rb

@@ -0,0 +1,16 @@
+def awetestlib_regression_setup
+  msg("Question") do
+    puts "I'm about to setup awetest regression support and register the AutoIt.dll"
+    puts "Please hit return to confirm that's what you want."
+	puts "NOTE: You may need to run this command as an administrator."
+  end
+  exit 2 unless STDIN.gets.chomp == ''
+  
+  autoit_file = File.join(File.dirname(__FILE__),"AutoItX3.dll")
+  system("regsvr32 #{autoit_file}")
+
+  msg("Info") do
+    puts "Configuring files and settings"
+  end
+
+end

data/bin/awetestlib-rubymine-setup.rb

@@ -0,0 +1,33 @@
+
+def edit_config_file
+  @new_config_file = File.join(FileUtils.pwd,"sample_rubymine",".idea","workspace.xml")
+  @demo_script = File.join(FileUtils.pwd,"sample_rubymine", "demo.rb")
+  @awetestlib_file = File.join(File.dirname(__FILE__), "awetestlib")
+  workspace_text = File.read(@new_config_file)
+  new_workspace_text = workspace_text.gsub(/SAMPLE-SCRIPT/,@demo_script )
+  new_workspace_text = new_workspace_text.gsub(/RUBY-SCRIPT/, @awetestlib_file)
+  File.open(@new_config_file, "w") {|file| file.puts new_workspace_text}
+end
+
+def awetestlib_rubymine_setup
+  @rubymine_dir = File.join(FileUtils.pwd, "sample_rubymine")
+  @source_dir = File.join(File.dirname(__FILE__), '..', 'setup_samples', 'sample_rubymine')
+
+  if File.exists?(@rubymine_dir)
+    puts "Sample Rubymine directory already exists."
+    exit 1
+  end
+
+  msg("Question") do
+    puts "I'm about to create a sample rubymine project in this directory"
+    puts "Please hit return to confirm that's what you want."
+    puts "NOTE: You may need to run this command as an administrator."
+  end
+  exit 2 unless STDIN.gets.chomp == ''
+  FileUtils.cp_r(@source_dir, @rubymine_dir)
+  edit_config_file
+  msg("Info") do
+    puts "Configuring files and settings"
+  end
+
+end

data/lib/awetestlib.rb

@@ -1,4 +1,4 @@
-require 'yaml'
+#require 'yaml'    #Couldn't find use anywhere
 require 'active_support/core_ext/hash'
 
 module Awetestlib
@@ -25,15 +25,15 @@ module Awetestlib
   #require 'active_support/inflector'
   #require 'active_support/core_ext/object'
   #require 'active_support/core_ext/hash'
-
+  require 'awetestlib/runner'
   require 'andand'
-  require 'regression/runner'
+  require 'awetestlib/regression/runner'
 
 
   if USING_OSX
     require 'appscript'
   end
 
-  require 'roo'
+  #require 'roo' #moved to awetestlib runner
 
 end

data/lib/awetestlib/html_report.rb

@@ -0,0 +1,171 @@
+module Awetestlib
+  class HtmlReport
+    # Initialize the report class
+    def initialize(report_name)
+      @reportname = report_name
+      @reportContent1 = ''
+      @reportContent2 = ''
+    end
+
+    # Create a report
+    def create_report(reportName)
+      # Get current time
+      t = Time.now
+      # Format the day
+      if(t.day.to_s.length == 1)
+        strDay = '0' + t.day.to_s
+      else
+        strDay = t.day.to_s
+      end
+
+      # Format the month
+      if(t.month.to_s.length == 1)
+        strMonth = '0' + t.month.to_s
+      else
+        strMonth = t.month.to_s
+      end
+
+      # Format the year
+      strYear = t.year.to_s
+
+      # Format the hour
+      if(t.hour.to_s.length == 1)
+        strHour = '0' + t.hour.to_s
+      else
+        strHour = t.hour.to_s
+      end
+
+      # Format the minutes
+      if(t.min.to_s.length == 1)
+        strMinutes = '0' + t.min.to_s
+      else
+        strMinutes = t.min.to_s
+      end
+
+      # Format the seconds
+      if(t.sec.to_s.length == 1)
+        strSeconds = '0' + t.sec.to_s
+      elsif (t.sec.to_s.length == 0)
+        strSeconds = '00'
+      else
+        strSeconds = t.sec.to_s
+      end
+
+      # Create the report name
+      strTime = '_' + strDay + strMonth + strYear + '_' + strHour + strMinutes + strSeconds + '.html'
+      strNiceTime = strDay + '-' + strMonth + '-' + strYear + ' @ ' + strHour + ':' + strMinutes + ':' + strSeconds
+      strTotalReport = reportName + strTime
+
+      # Create the HTML report
+      strFile = File.open(strTotalReport, 'w')
+
+      # Format the header of the HTML report
+      @reportContent1 = '<html>
+        <head>
+        <meta content=text/html; charset=ISO-8859-1 http-equiv=content-type>
+        <title>Awetestlib Test Run</title>
+        <style type=text/css>
+        .title { font-family: verdana; font-size: 30px;  font-weight: bold; align: left; color: #000000;}
+        .bold_text { font-family: verdana; font-size: 12px;  font-weight: bold;}
+        .bold_large_text { font-family: verdana; font-size: 13px;  font-weight: bold;}
+        .normal_text { font-family: verdana; font-size: 12px;  font-weight: normal;}
+        .small_text { font-family: verdana; font-size: 10px;  font-weight: normal; }
+        .border { border: 1px solid #000000;}
+        .mark_testlevel_left { border-top: 1px solid #858585; border-left: 1px solid #858585;background-color:#E2F4FE;}
+        .mark_testlevel_right { border-top: 1px solid #858585; border-right: 1px solid #858585;background-color:#E2F4FE;}
+        .border_left { border-top: 1px solid #858585; border-left: 1px solid #858585; border-right: 1px solid #858585;}
+        .border_right { border-top: 1px solid #858585; border-right: 1px solid #858585;}
+        .result_ok { font-family: verdana; font-size: 12px;  font-weight: bold; text-align: center; color: green;}
+        .result_nok { font-family: verdana; font-size: 12px;  font-weight: bold; text-align: center; color: red;}
+        .overall_ok { font-family: verdana; font-size: 12px;  font-weight: bold; text-align: left; color: green;}
+        .overall_nok { font-family: verdana; font-size: 12px;  font-weight: bold; text-align: left; color: red;}
+        .bborder_left { border-top: 1px solid #858585; border-left: 1px solid #858585; border-bottom: 1px solid #858585; background-color:#858585;font-family: verdana; font-size: 12px;  font-weight: bold; text-align: center; color: white;}
+        .bborder_right { border-right: 1px solid #858585; background-color:#858585;font-family: verdana; font-size: 12px;  font-weight: bold; text-align: center; color: white;}
+        </style>
+        </head>
+        <body>
+        <br>
+        <center>
+        <table width=800 border=0 cellpadding=2 cellspacing=2>
+        <tbody>
+        <tr>
+        <td>
+        <table width=100% border=0 cellpadding=2 cellspacing=2>
+        <tbody>
+        <tr>
+        <td style=width: 150px;>&nbsp;</td>
+        <td align=left><img src="../images/logo.png"></img></td>
+        <td align=right><p class=title>Test Report</p></td>
+        </tr>
+        </tbody>
+        </table>
+        <br>
+        <hr width=100% class=border size=1px>
+        <center>
+        <table border=0 width=95% cellpadding=2 cellspacing=2>
+        <tbody>
+        <tr>
+        <td width=20%><p class=bold_text>Script</p></td>
+        <td width=5%><p class=bold_text>:</p></td>
+        <td width=75%><p class=normal_text>' + @reportname.capitalize + '</p></td>
+        </tr>
+        <tr>
+        <td width=20%><p class=bold_text>Test Execution</p></td>
+        <td width=5%><p class=bold_text>:</p></td>
+        <td width=75%><p class=normal_text>' + strNiceTime + '</p></td>
+        </tr>
+        <tr>'
+
+      @reportContent2 = '</tr>
+        </tbody>
+        </table>
+        </center>
+        <br>
+        <center>
+        <table width=95% cellpadding=2 cellspacing=0>
+        <tbody>
+        <tr>
+        <td class=bborder_left width=80%><p>Test Step</p></td>
+        <td class=bborder_left width=20%><p>Result</p></td>
+        </tr>'
+
+      # Close the report
+      strFile.close
+
+      return strTotalReport
+    end
+
+    def add_to_report(step, result)
+      # Format the body of the HTML report
+      if (result == 'PASSED')
+        @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>'
+      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>'
+      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_nok>' + result + '</p></td>'
+      end
+
+    end
+
+    def finish_report(reportName)
+      # Open the HTML report
+      strFile = File.open(reportName, 'a')
+
+      @reportContent2 = @reportContent2 + '<tr>
+      <td class=bborder_left width=80%><p>&nbsp;</p></td>
+      <td class=bborder_left width=20%><p>&nbsp;</p></td>
+      </tr>
+      </table>'
+
+      strFile.puts(@reportContent1)
+
+      strFile.puts(@reportContent2)
+
+      # Close the report
+      strFile.close
+    end
+  end
+end