RubyGems - rubySelenium - Versions diffs - 0.0.8 - Mend

rubySelenium 0.0.8

Files changed (286) hide show

@@ -0,0 +1,25 @@
+require 'RubySeleniumGenerator'
+begin
+working_directory = `pwd`
+rescue
+directory = `dir`
+directory.match(/Directory of(.+)$/)
+working_directory = $1.to_s.gsub(/\\/,"/").gsub(/^\s/,"")
+end
+selenium = RubySeleniumGenerator.new(working_directory.to_s.chomp)
+selenium.make_tests_directory
+selenium.make_testResults_directory
+selenium.make_methods_directory
+selenium.make_resultServer_directory
+selenium.make_resultServer_css_directory
+selenium.make_rubySeleniumConfig
+selenium.make_seleniumMethods
+selenium.make_datahandler
+selenium.make_execute_all_tests
+selenium.make_generate_all_tests
+selenium.make_sample_user_data
+selenium.make_results_css
+selenium.make_webserver

data/documentation/output/css/style.css ADDED

@@ -0,0 +1,36 @@
+body {
+	font-family:arial,helvetica,clean;
+}
+td {
+	text-align: left;
+	vertical-align: top;
+	font-family:arial,helvetica,clean;
+	font-size:12px;
+	color:#000000;
+}
+form
+{
+	margin:0px;
+}
+a {
+	font-family:arial,helvetica,clean;
+	font-size:13px;
+	text-decoration: none;
+	font-weight: bold;
+	color:blue;
+}
+A:Hover  {
+	color:blue;
+	text-decoration : underline;
+}
+.addstyles {
+	color: #FFFFFF;
+	font-weight: bold;
+}

data/documentation/output/documentation.html ADDED

@@ -0,0 +1,197 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+<html>
+<head>
+	<title>rubySelenium
+</title>
+	<link rel=stylesheet type="text/css" href="css/style.css">
+</head>
+<body background="images/background.jpg" bottommargin="0" leftmargin="0" marginheight="0" marginwidth="0" rightmargin="0" topmargin="0">
+<center><table width="765" height="100%" cellpadding="0" cellspacing="0" border="0" background="images/mainbackground.jpg"><tr valign="top"><td>
+<table width="764" height="97" cellpadding="0" cellspacing="0" border="0">
+	<tr valign="top">
+<td width="248"><!-- logo image --><img src="images/blanklogo_withswirl.jpg" width="248" height="97" border="0" alt=""><!-- end logo image --></td>
+<td width="100%" background="images/toplogobg.jpg"><img src="images/toplogobg.jpg" width="22" height="97" border="0" alt=""></td>
+	</tr>
+</table>
+<table width="764" height="42" cellpadding="0" cellspacing="0" border="0">
+	<tr valign="top">
+<td width="169"><img src="images/left1.jpg" width="169" height="42" border="0" alt=""></td>
+<td width="100%" background="images/left1bg.jpg"><img src="images/left1bg.jpg" width="20" height="42" border="0" alt=""></td>
+	</tr>
+</table>
+<table width="764" cellpadding="0" cellspacing="0" border="0">
+	<tr valign="top">
+<td width="150">
+<!-- menu below, copy and paste the menudivider.jpg code as necessary -->
+<!-- the &nbsp; is code for a one letter space -->
+<img src="images/menudivider.jpg" width="150" height="6" border="0" alt=""><BR>
+&nbsp; <a href="index.html">Home</a><BR>
+<img src="images/menudivider.jpg" width="150" height="6" border="0" alt=""><BR>
+&nbsp; <a href="documentation.html">Documentation</a><BR>
+<img src="images/menudivider.jpg" width="150" height="6" border="0" alt=""><BR>
+&nbsp; <a href="files/rdoc/index.html">rubySelenium API</a><BR>
+<img src="images/menudivider.jpg" width="150" height="6" border="0" alt=""><BR>
+<!--
+&nbsp; <a href="http://www.webaddresshere.com">Services</a><BR>
+<img src="images/menudivider.jpg" width="150" height="6" border="0" alt=""><BR>
+&nbsp; <a href="http://www.webaddresshere.com">Contact us</a><BR>
+<img src="images/menudivider.jpg" width="150" height="6" border="0" alt=""><BR>
+&nbsp; <a href="http://www.webaddresshere.com">Bookmark</a><BR>
+<img src="images/menudivider.jpg" width="150" height="6" border="0" alt=""><BR>
+-->
+<!-- end menu -->
+</td>
+<td width="10">&nbsp;</td>
+<td width="744">
+<!-- add your content below -->
+<h1>rubySelenium User Guide</h1>
+<h2>Contents</h2>
+<ol>
+<li><a href="#intro">Introduction to rubySelenium</a></li>
+<li><a href="#install">Downloading &amp; Local Installation</a></li>
+<li><a href="#config">Configuring rubySelenium</a></li>
+<li><a href="#create">Writing your First rubySelenium Test</a></li>
+</ol>
+<h2 id="intro">Introduction to rubySelenium</h2>
+<p>rubySelenium is esentially an HTML generation tool for the FitRunner version of Selenium. In my opinion the FitRunner version of Selenium is stable and reliable, executes quickly and feels nice to use. </p>
+<p>However it is very time consuming to type out HTML constantly when you have a large number of scripts to create and maintain. Which is where rubySelenium fits in. </p>
+<p>The Benefits of rubySelenium:</p>
+<ul>
+<li><p>Write tests programmatically gaining the benefit of using a fully featured OO programming language. </p></li>
+<li><p>Easier to write tests by functionally decomposing sections of functionality into logical chunks, e.g. Login may be executed on every script - by having one login function it saves typing out the html or code in every script. </p></li>
+<li><p>Maintaining test scripts can be a huge problem if a change needs to be made 100 different scripts rather than in just 1 place. Also it's far easier to maintain Ruby code than verbose HTML. </p></li>
+<li><p>Backwards compatibility with the scripts written in HTML by hand as the tests can sit along side exisiting tests. </p></li>
+</ul>
+<h2 id="install">Downloading and Local Installation</h2>
+<h3>Install rubySelenium Gem</h3>
+<p>Download the latest rubySelenium gem, open a cmd window in the same directory as the gem file and then install as below:</p>
+<p>gem install rubySelenium</p>
+<p>Next create a folder (e.g. rubySeleniumScripts) that will contain yor ruby tests from where you will generate the HTML tests. Using a cmd window change directory into your new folder.</p>
+<p>Now type: rubyselenium-seed </p>
+<p>You will see a stack of files and folder have been generated that are the core rubySelenium files required. You are now fully installed.</p>
+<h2 id="config">Configuring rubySelenium</h2>
+<p>There is a file called rubySeleniumConfig.txt in your newly created rubySelenium folder. there are a number of settings in here of which the most important is the TEST_LOCATION setting. </p>
+<p>This sets the path that is followed when you execute one of the scripts locally. The path should point to the location of the tests folder inside the rubySeleniumScripts folder that resides on your local server. </p>
+<p>e.g. if you navigate to http://localhost:9081/Selenium/tests/rubySeleniumScripts/tests/seleniumTestRunner.html to find your tests then you should set this property to http://localhost:9081/Selenium/tests/rubySeleniumScripts </p>
+<p>After editing the file save the changes </p>
+<h2 id="create">Writing your First rubySelenium Test</h2>
+<p>Now you are ready to write your first test. </p>
+<p>Make sure that your project web server on your local machine is up and running.
+Now create a new file inside the rubySeleniumScripts folder called 001_myTest.rb
+(I find it most best to use the scite editor that comes with Ruby - right click the file and select edit and it open in Scite by default) You must create the test with following notation: 3 digits underscore testname fullstop rb => 001_mytestname.rb </p>
+<p>Copy and paste the following code into that file: (without the numbers down the side!) </p>
+<pre><code>1 require 'RubySelenium'
+2 require 'methods/seleniumMethods'
+3
+4 # Create new SeleniumMethods and RubySelenium instances
+5 t = SeleniumMethods.new(s = RubySelenium.new)
+6
+7 # Start the test and supply a name for the test
+8 s.start("001_myTest")
+9
+10 loginType = "DirectInvestor"
+11
+12 # begin test
+13 t.login(loginType)
+14
+15 # complete test
+16 s.complete
+17 s.go
+</code></pre>
+<p>Lets go through the main points of this script to understand what each part does. </p>
+<p>Line 1 you require the rubySelenium API</p>
+<p>Line 2 you require the additional methods that live in the methods directory (you can put your own methods in here)</p>
+<p>Line 5 you create the RubySelenium object and the SeleniumMethods object so you can use them. Here the SelemiumMethods
+object wants the RubySelenium object to be passed into to it so we can access the API inside the additional methods.</p>
+<p>Line 8 tells rubySelenium that the test is starting and you must give it the name of the test without the .rb</p>
+<p>Line 10 is a variable that hols a string with the type of user we want to login to the system with</p>
+<p>Line 13 refers to the additional user defined helper method that is in the methods folder. It takes a string that specifies the type of user to login with.</p>
+<p>Line 16 tells rubySelenium that the test ends here</p>
+<p>Line 17 instructs rubySelenium to execute this test locally when you execute this script</p>
+<p>To run the test locally you can either double click on the 001_myTest.rb file or from the cmd you can type:
+ruby 001_myTest.rb and also you from within Scite you can hit F5 to run the test. </p>
+<p>Now if you are unable to run this example you can try writing and running your own simlpe script to get an idea of how it works. So make a new file in the rubySeleniumScripts directory called 002_myFirstTest.rb and write something such as: </p>
+<pre><code>1 require 'RubySelenium'
+2
+3 # Create new RubySelenium instance
+4 s = RubySelenium.new
+5
+6 # Start the test and supply a name for the test
+7 s.start("002_myFirstTest")
+8
+9 # begin test
+10 s.open("path/to/your/project")
+11 s.type("username", "myusername")
+12 s.type("password", "mypassword")
+13 s.clickAndWait("loginbutton")
+14 s.verifyTextPresent("mytext")
+15
+16 # complete test
+17 s.complete
+18 s.go
+</code></pre>
+<p>You access the rubySelenium API through the object you created called s
+So now all the selenium commands are available by using s.command
+e.g. s.clickAndWait("login") </p>
+<p>When you created the SeleniumMethods object you assigned it to t so to access user defined methods from that object you access them via t.login("DirectInvestor2) etc. </p>
+<BR><BR><BR><BR><BR>
+<BR><BR><BR><BR><BR>
+<center>Copyright � 2004 Kingsley Hendrickse. All rights reserved -last published Wed Nov 09 16:07:49 GMT 2005</center>
+<!-- end content area -->
+</td>
+<td width="10">&nbsp;</td>
+	</tr>
+</table>
+</td></tr></table></center>
+</body>
+</html>

data/documentation/output/files/rdoc/classes/Batch_Generator.html ADDED

@@ -0,0 +1,274 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!DOCTYPE html
+     PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+     "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+<head>
+  <title>Class: Batch_Generator</title>
+  <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
+  <meta http-equiv="Content-Script-Type" content="text/javascript" />
+  <link rel="stylesheet" href=".././rdoc-style.css" type="text/css" media="screen" />
+  <script type="text/javascript">
+  // <![CDATA[
+  function popupCode( url ) {
+    window.open(url, "Code", "resizable=yes,scrollbars=yes,toolbar=no,status=no,height=150,width=400")
+  }
+  function toggleCode( id ) {
+    if ( document.getElementById )
+      elem = document.getElementById( id );
+    else if ( document.all )
+      elem = eval( "document.all." + id );
+    else
+      return false;
+    elemStyle = elem.style;
+    if ( elemStyle.display != "block" ) {
+      elemStyle.display = "block"
+    } else {
+      elemStyle.display = "none"
+    }
+    return true;
+  }
+  // Make codeblocks hidden by default
+  document.writeln( "<style type=\"text/css\">div.method-source-code { display: none }</style>" )
+  // ]]>
+  </script>
+</head>
+<body>
+    <div id="classHeader">
+        <table class="header-table">
+        <tr class="top-aligned-row">
+          <td><strong>Class</strong></td>
+          <td class="class-name-in-header">Batch_Generator</td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>In:</strong></td>
+            <td>
+                <a href="../files/lib/RubySelenium_rb.html">
+                lib/RubySelenium.rb
+                </a>
+        <br />
+            </td>
+        </tr>
+        <tr class="top-aligned-row">
+            <td><strong>Parent:</strong></td>
+            <td>
+                Object
+            </td>
+        </tr>
+        </table>
+    </div>
+  <!-- banner header -->
+  <div id="bodyContent">
+  <div id="contextContent">
+   </div>
+    <div id="method-list">
+      <h3 class="section-bar">Methods</h3>
+      <div class="name-list">
+      <a href="#M000064">build_tests_array</a>&nbsp;&nbsp;
+      <a href="#M000063">build_tests_list</a>&nbsp;&nbsp;
+      <a href="#M000070">create_all_test_files</a>&nbsp;&nbsp;
+      <a href="#M000067">create_test_suite_file_for_all_files</a>&nbsp;&nbsp;
+      <a href="#M000069">delete_html_files</a>&nbsp;&nbsp;
+      <a href="#M000068">find_html_contents_of_generation_directory</a>&nbsp;&nbsp;
+      <a href="#M000066">generate_test_suite_for_all_files</a>&nbsp;&nbsp;
+      <a href="#M000071">go</a>&nbsp;&nbsp;
+      <a href="#M000062">new</a>&nbsp;&nbsp;
+      <a href="#M000065">remove_go_commands_from_tests_array</a>&nbsp;&nbsp;
+      </div>
+    </div>
+  </div>
+    <!-- if includes -->
+    <div id="section">
+    <!-- if method_list -->
+    <div id="methods">
+      <h3 class="section-bar">Public Class methods</h3>
+      <div id="method-M000062" class="method-detail">
+        <a name="M000062"></a>
+        <div class="method-heading">
+          <a href="Batch_Generator.src/M000062.html" target="Code" class="method-signature"
+            onclick="popupCode('Batch_Generator.src/M000062.html');return false;">
+          <span class="method-name">new</span><span class="method-args">(ruby_tests_location = DEFAULT_RUBY_TEST_LOCATION)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <h3 class="section-bar">Public Instance methods</h3>
+      <div id="method-M000064" class="method-detail">
+        <a name="M000064"></a>
+        <div class="method-heading">
+          <a href="Batch_Generator.src/M000064.html" target="Code" class="method-signature"
+            onclick="popupCode('Batch_Generator.src/M000064.html');return false;">
+          <span class="method-name">build_tests_array</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000063" class="method-detail">
+        <a name="M000063"></a>
+        <div class="method-heading">
+          <a href="Batch_Generator.src/M000063.html" target="Code" class="method-signature"
+            onclick="popupCode('Batch_Generator.src/M000063.html');return false;">
+          <span class="method-name">build_tests_list</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000070" class="method-detail">
+        <a name="M000070"></a>
+        <div class="method-heading">
+          <a href="Batch_Generator.src/M000070.html" target="Code" class="method-signature"
+            onclick="popupCode('Batch_Generator.src/M000070.html');return false;">
+          <span class="method-name">create_all_test_files</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000067" class="method-detail">
+        <a name="M000067"></a>
+        <div class="method-heading">
+          <a href="Batch_Generator.src/M000067.html" target="Code" class="method-signature"
+            onclick="popupCode('Batch_Generator.src/M000067.html');return false;">
+          <span class="method-name">create_test_suite_file_for_all_files</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000069" class="method-detail">
+        <a name="M000069"></a>
+        <div class="method-heading">
+          <a href="Batch_Generator.src/M000069.html" target="Code" class="method-signature"
+            onclick="popupCode('Batch_Generator.src/M000069.html');return false;">
+          <span class="method-name">delete_html_files</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000068" class="method-detail">
+        <a name="M000068"></a>
+        <div class="method-heading">
+          <a href="Batch_Generator.src/M000068.html" target="Code" class="method-signature"
+            onclick="popupCode('Batch_Generator.src/M000068.html');return false;">
+          <span class="method-name">find_html_contents_of_generation_directory</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000066" class="method-detail">
+        <a name="M000066"></a>
+        <div class="method-heading">
+          <a href="Batch_Generator.src/M000066.html" target="Code" class="method-signature"
+            onclick="popupCode('Batch_Generator.src/M000066.html');return false;">
+          <span class="method-name">generate_test_suite_for_all_files</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000071" class="method-detail">
+        <a name="M000071"></a>
+        <div class="method-heading">
+          <a href="Batch_Generator.src/M000071.html" target="Code" class="method-signature"
+            onclick="popupCode('Batch_Generator.src/M000071.html');return false;">
+          <span class="method-name">go</span><span class="method-args">(browser = &quot;IE&quot;)</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+      <div id="method-M000065" class="method-detail">
+        <a name="M000065"></a>
+        <div class="method-heading">
+          <a href="Batch_Generator.src/M000065.html" target="Code" class="method-signature"
+            onclick="popupCode('Batch_Generator.src/M000065.html');return false;">
+          <span class="method-name">remove_go_commands_from_tests_array</span><span class="method-args">()</span>
+          </a>
+        </div>
+        <div class="method-description">
+        </div>
+      </div>
+    </div>
+  </div>
+<div id="validator-badges">
+  <p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
+</div>
+</body>
+</html>