just_add_watir | Advanced recipes for Watir

Q. firefox-bin quit unexpectedly ?

admin — Wed, 21 Oct 2009 02:44:26 +0000

If you are trying to run Firewatir on Mac OSX and you see the following error message

"firefox-bin quit unexpectedly"

Have a look at the detailed error message available from an irb terminal e.g.

$  irb
>>require 'firewatir'
=> true
>> browser || Firefox.new
dyld: Library not loaded: /usr/lib/libsqlite3.dylib
  Referenced from: /System/Library/Frameworks/Security.framework/Versions/A/Security
  Reason: Incompatible library version: Security requires version 9.0.0 or later, but libsqlite3.dylib provides version 1.0.0

Chances are you have the wrong version of libsqlite3 in your Firefox installation. Run the following commands to copy the correct libraries into Firefox.

$ mv /Applications/Firefox.app/Contents/MacOS/libsqlite3.dylib Applications/Firefox.app/Contents/MacOS/libsqlite3.dylib.orig
$ cp /usr/lib/libsqlite3.dylib /Applications/Firefox.app/Contents/MacOS/libsqlite3.dylib

Q. How do I integrate watir with TestLink?

admin — Wed, 15 Oct 2008 11:11:19 +0000

A. This requires several hacks and use of the developer API ...

The first step to integrating these products is to download and install
TestLink 1.8.0 BETA2
Once finished, add the TestLink API BETA

Their blog has installation instructions for both.

Regarding the API there are a number of changes you will need to ensure:
1. create api_developer_keys table using the api_sql_changes.sql included with the API
2. create an api developer key in your new api_developer_keys table
3. update the api.const.inc.php database constants
4. $ chmod -R 755 api/
5. change the paths to relevant libraries in xmlrpc.php, mine looks like this:

change xmlrpc.php
/**
 * IXR is the class used for the XML-RPC server
 */
require_once(dirname(__FILE__) . "/../third_party/xml-rpc/class-IXR.php");
require_once("api.const.inc.php");
// require_once("APIErrors.php");
require_once(dirname(__FILE__) . "/../config.inc.php");
require_once(dirname(__FILE__) . "/../lib/functions/common.php");
require_once(dirname(__FILE__) . "/../lib/functions/testproject.class.php");
require_once(dirname(__FILE__) . "/../lib/functions/testcase.class.php");
require_once(dirname(__FILE__) . "/../lib/functions/testsuite.class.php");

You can be creative as you want with the API. The way I implemented this, was to change the test execution template to allow corresponding test cases to be executed within watir such that the following calls are made:

TestLink -> test_harness.php -> test_harness.rb -> test_suite.rb

I had to first modify the TestLink gui/templates/execute/execSetResults.tpl template as per the following (approx line 544):

   {if $tc_exec.can_be_executed}
      {include file="execute/inc_exec_controls.tpl"
               args_input_enable_mgmt=$input_enabled_disabled
               args_tcversion_id=$tcversion_id
               args_webeditor=$gui->exec_notes_editors[$tc_id]
               args_labels=$labels}
      
      {include file="execute/inc_exec_watir.tpl"}

I then added a new TestLink template in gui/templates/execute/inc_exec_watir.tpl as per the following:

{*
TestLink Open Source Project - http://testlink.sourceforge.net/
$Id: inc_exec_watir.tpl,v 0.1 2008/10/15 05:03:53 $
Purpose: draw execution controls for watir based test cases
Author : tim.koopmans@90kts.com
*}
      {assign var="ResultsStatusCode" value=$tlCfg->results.status_code}
  		<table class="invisible">
  		<tr>
  			<th rowspan="2" style="text-align: center;">
  				<div class="title">Watir Test Case {$tc_id}
<a href="http://localhost/~koops/testlink/watir/test_harness.php?name={$tc_exec.name}&id={$gui->tcasePrefix}{$tc_exec.tc_external_id}&tcid={$tc_id}">Execute &rarr;a>
  			th>
  			<td valign="top" style="width: 30%;">
    			td>
    		tr>
  		table>

This essentially adds a new link to the test execution screen which will call a test_harness from PHP using a system call. The screen mod looks like this:
The PHP harness which it calls is located in watir/test_harness.php and looks like the following:


  if (isset($_GET["name"])) $name = $_GET["name"];
  if (isset($_GET["id"])) $id = $_GET["id"];
  if (isset($_GET["tcid"])) $tcid = $_GET["tcid"];
  print "Executing watir test case id: $tcid
";
  system("ruby /Users/koops/Sites/testlink/watir/test_harness.rb $id $tcid");
?>

The purpose of this is to launch a test_harness client in Ruby passing it the client ID and test case ID required for execution. This client is based on the API examples and it could have been written in PHP, but I felt more comfortable with Ruby. So there is a little double handling here which could be improved... The Ruby harness it calls is located in watir/test_harness.rb and looks like the following:

require 'xmlrpc/client'
 
class TestlinkAPIClient
  # substitute your server URL Here
  SERVER_URL = "http://localhost/~koops/testlink/api/xmlrpc.php"
 
  def initialize(dev_key)
    @server = XMLRPC::Client.new2(SERVER_URL)
    @devKey = dev_key
  end
 
  def reportTCResult(tcid, tpid, status)
    args = {"devKey"=>@devKey, "tcid"=>tcid, "tpid"=>tpid, "status"=>status}
    @server.call("tl.reportTCResult", args)
  end
 
  def getProjectIDByClientID(clientid)
    args = {"devKey"=>@devKey}
    result = @server.call("tl.getProjects", args)
    result.each do |project|
      return projectid = project["id"] if project["name"] =~ /#{clientid}/
    end
    return 'ERROR: Unable to find project by client id: ' + clientid
  end
 
  def getProjectTestPlanIDByName(testprojectid, testplanname)
    args = {"devKey"=>@devKey, "testprojectid"=>testprojectid}
    result = @server.call("tl.getProjectTestPlans", args)
    result.each do |testplanid, values|
      p values
      return testplanid if values["name"] =~ /#{testplanname}/
    end
    return 'ERROR: Unable to find test plan name by test project id ' + testprojectid
  end
 
  def getProjectTestPlanID(testprojectid)
    args = {"devKey"=>@devKey, "testprojectid"=>testprojectid}
    result = @server.call("tl.getProjectTestPlans", args)
    result.each do |testplanid, values|
      return testplanid
    end
    return 'ERROR: Unable to find test plan id ' + testprojectid
  end
 
  def getTestCaseIDByName(testcasename)
    args = {"devKey"=>@devKey, "testcasename"=>testcasename}
    @server.call("tl.getTestCaseIDByName", args)
  end
end
 
# param args
watirid  = ARGV[0] || "ID74278-1"
tcid     = ARGV[1] || 62
clientid = watirid[/[\w\d]+/]
 
# execute watir test suite
stdout = %x[ruby /Users/koops/Sites/testlink/watir/test_suite.rb --name test_#{tcid}]
puts stdout
status = "f"
status = "p" if stdout =~ /0 errors/
 
# substitute your Dev Key Here
client = TestlinkAPIClient.new("f2a979d533cdd9761434bba60a88e4d8")
 
# find a project id by client id [custom]
projectid = client.getProjectIDByClientID("Client #{clientid}")
 
# find the first test plan id for a given project id [native]
tpid = client.getProjectTestPlanID(projectid)
 
result = client.reportTCResult(tcid.to_i, tpid, status)
puts "Run ID: " + result[0]["id"] + "
"

This harness essentially calls a corresponding Test::Unit test suite (by test case ID) and returns the results using the XML-RPC client back into TestLink.
To give you an idea, my example test suite looked like this:

require 'rubygems'
require 'test/unit'
require 'firewatir'
 
include FireWatir
class TestSuite < Test::Unit::TestCase
 
  def setup
    @b=Firefox.new
  end
 
  def test_62
    @b.goto('http://www.google.com')
  end
end

So, stitching it all together, TestLink can call watir test cases using the test case ID which is unique to TestLink and passing it to the relevant test runner or harness in Ruby. Ruby then does the execution and feeds the results (pass/fail) using the XML-RPC client API back into TestLink. You end up with test results being tracked in TestLink and presented (in progress) like this:

It's all a bit hacky and would be happy for others to progress with this. Just some ideas to get you started =)

Q. How do I install watir standalone?

admin — Wed, 08 Oct 2008 02:47:08 +0000

A previous post highlights some ways in which you can install watir from behind a proxy server via the command line.

This approach can be problematic when using authenticated proxy servers. The following file is a simple MSI which will install Watir 1.5.6 with its required dependencies. The pre-requisites for this MSI are:
1. Ruby 1.8.6 installed to c:\ruby
2. Windows XP SP2 (I have not tried this on Windows Vista)

Download MSI

Note: this is not the preferred way of installing Watir and as such I cannot offer any guarantees on its success.

Q. How do I use ci_reporter in my Test::Unit scripts?

admin — Tue, 30 Sep 2008 10:28:22 +0000

A. Use a ci_reporter gem ...
To install the ci_reporter gem on windows:

gem install ci_reporter

If you're using Test::Unit, ensure the ci/reporter/rake/test_unit_loader.rb file is loaded before the test is run. If you're using RSpec, you‘ll need to pass the following arguments to the spec command:

 --require GEM_PATH/lib/ci/reporter/rake/rspec_loader
 --format CI::Reporter::RSpec

You may also want to set the output directory as demonstrated by setting the CI_REPORTS environment variable.

require 'test/unit'
require 'ci/reporter/rake/test_unit_loader.rb'
require 'watir'
ENV["CI_REPORTS"] = 'C:/temp/'

Q. How do I pass command line arguments to Test::Unit?

admin — Tue, 30 Sep 2008 09:45:56 +0000

A. Use the -- argument to stop processing Test::Unit specific arguments ...
Module Test::Unit has its own command line arguments as specified by the following:

~/just_add_watir $>ruby test_suite.rb --help
Test::Unit automatic runner.
Usage: test/unit/graph_test.rb [options] [-- untouched arguments]
 
    -r, --runner=RUNNER              Use the given RUNNER.
                                     (c[onsole], f[ox], g[tk], g[tk]2, t[k])
    -n, --name=NAME                  Runs tests matching NAME.
                                     (patterns may be used).
    -t, --testcase=TESTCASE          Runs tests in TestCases matching TESTCASE.
                                     (patterns may be used).
    -v, --verbose=[LEVEL]            Set the output level (default is verbose).
                                     (s[ilent], p[rogress], n[ormal], v[erbose])
     --                           Stop processing options so that the
                                     remaining options will be passed to the
                                     test.
    -h, --help                       Display this help.
 
Deprecated options:
        --console                    Console runner (use --runner).
        --gtk                        GTK runner (use --runner).
        --fox                        Fox runner (use --runner).

Example watir:

def test_0021
  # need to call test unit with -- argument
  puts "argument 1 is: ",ARGV[0]
end

Q. How do I execute arbitrary javascript?

admin — Tue, 30 Sep 2008 09:31:44 +0000

A. Use the .goto method to call the javascript ...
Example html:

<html lang="en-US" xmlns="http://www.w3.org/1999/xhtml" xml:lang="en-US">
  <body scroll="no">
    <script type="text/javascript" charset="utf-8">
      function openWin(i){
         alert(i);
      }
    </script>
    <div id="menuLayer1">
      <div id="menuLite1">
        <div id="menuFg1">
          <div id="menuItem1" mmaction="location='javascript:openWin(2);'" zIndex="1">
            <div id="menuItemText1">
              <div id="menuItemShim1">
                <div align="left">
                  just_add_watir
                </div>
              </div>
            </div>
          </div>
        </div>
      </div>
    </div>
  </body>
</html>

Example watir:

@b.goto('http://justaddwatir.com/watir/test_html/tc_0001_0100/test_0020.html')
@b.div(:id, "menuItem1").flash
@b.goto("javascript:openWin(2)")

Q. How do I learn all the objects on a page? [firewatir]

admin — Fri, 26 Sep 2008 21:45:02 +0000

Sometimes you might wish to implement a QTP-like 'object repository'. I've had most success implementing this via Ruby modules.

To 'learn' all the objects on a page using firewatir you can use a simple script like this:

require 'rubygems'
require 'firewatir'
 
class NilClass
  def length
    0
  end
end
 
class DiscoverObjects
  include FireWatir
 
  def initialize(url)
    if url
      # attach to specific url
      @b = Firefox.start(url)
    else
      # attach to existing window
      @b = Firefox.new
    end
  end
 
  def all
    @objects = {}
    [:links, :text_fields, :buttons, :select_lists].each do |type|
      @b.send(type).each do |element|
        @objects[element] = {}
        @objects[element][:type] = type.to_s[0..-2]
        # omitted :href, :url, :class
        [:id, :name, :value, :text, :index, :xpath, :title, :action, :src, :for].each do |attrib|
          value = element.send(attrib)
          @objects[element][attrib] = value unless value.empty?
        end
      end
    end
  end
 
  def print_objects
    puts "module #{@b.title.to_s.gsub(/[^\d\w]/,'').capitalize}"
    puts "# Objects learned from: #{@b.url}\n# #{Time.now}"
 
    @objects.each do |key,val|
      val.each do |k,v|
          unless k.to_s =~ /type/
            method_name = "#{val[:type]}_#{k}_#{v.to_s.gsub(/[^\d\w]/,'_').downcase}"
            puts "\tdef #{method_name.gsub('__','_').gsub(/_$/,'')}"
            puts "\t\treturn @b.#{val[:type]}(:#{k}, \"#{v}\")\n\tend\n\n"
          end
      end
    end
    puts "end"
  end
 
end
 
url = ARGV[0]
discover = DiscoverObjects.new(url)
discover.all
discover.print_objects

Which will produce results like this:

module Firefoxwebbrowserfastermoresecurecustomizable
# Objects learned from: http://www.mozilla.com/en-US/firefox/
# Sat Sep 27 07:40:08 +1000 2008
	def link_text_qmo
		return @b.link(:text, "QMO")
	end
 
	def link_text_press_center
		return @b.link(:text, "Press Center")
	end
 
	def link_text_other_systems_and_languages
		return @b.link(:text, "Other Systems and Languages")
	end
end

Feel free to modify to suit (for watir or the like). I develop on a Mac, so firewatir is easiest for me. The manual way is to just use the IE Developer Toolbar or Firebug depending on your platform.

Q. How do I enter the current date or time into a textfield?

admin — Sat, 23 Aug 2008 17:19:00 +0000

A. Use the Time.now method ...
Example html:

<html>
   <body>
      <form method="post" action="">
         <textarea name="comments" cols="40" rows="1">
            Enter your comments here...
         </textarea><br />
         <input type="submit" value="Submit" />
      </form>
   </body>
</html>

Example watir:

t=Time.now
@b.text_field(:name,"comments").set(t.strftime("%m/%d/%Y_%H%:M%"))

Q. How do I get the text displayed in a javascript popup?

admin — Thu, 21 Aug 2008 13:04:31 +0000

A. Use the WIN32OLE extension library with the autoit function library ...
You will need to install autoit. You can download it here, once installed you can call the function library using the win32OLE extension library.
Example html:

<html>
   <head>
   <script language="javascript">
      function msgbox (textstring) {
      alert (textstring) }
   </script>
   </head>
   <body id="test_00test_0107" onload="">
      <form>
         <input name="text1" type=text>
         <input name="submit" type=button value="show me" onclick="msgbox(form.text1.value)">
     </form>
  </body>
</html>

Example watir:

require 'watir'
require 'rubygems'
require 'win32ole'
autoit = WIN32OLE.new('AutoItX3.Control')
@b.goto('http://justaddwatir.com/watir/test_html/tc_0101_0200/test_0107.html')
@b.text_field(:name,"text1").set("This is the text in the popup")
@b.button(:name,"submit").click_no_wait
autoit.WinWaitActive("[Class:#32770]")
text = autoit.ControlGetText("[Class:#32770]", "", "Static2")
autoit.ControlClick("[Class:#32770]","","Button1")
puts text

In order for the autoit function to execute, you need to use the .click_no_wait method in watir before the autoit function. This is because once the pop up is presented, the focus comes off the IE window and the script will pause. The .click_no_wait tells the script to continue running regardless of what happens next.
You may use the autoit window identifier to get the properties of the pop up the static text.

Q. How do I attach to a current IE session?

admin — Thu, 21 Aug 2008 12:53:53 +0000

A. Use the .attach method...
Example watir:

@b=Watir::IE.attach(:title,//)

I have used regex here for the window title, you can be more specific if you like.