-
Notifications
You must be signed in to change notification settings - Fork 19
/
README.html
321 lines (210 loc) · 11 KB
/
README.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
<?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>File: README</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="fileHeader">
<h1>README</h1>
<table class="header-table">
<tr class="top-aligned-row">
<td><strong>Path:</strong></td>
<td>README
</td>
</tr>
<tr class="top-aligned-row">
<td><strong>Last Update:</strong></td>
<td>Sat Feb 03 22:54:11 +0100 2007</td>
</tr>
</table>
</div>
<!-- banner header -->
<div id="bodyContent">
<div id="contextContent">
<div id="description">
<p>Welcome to the Selenium on Rails README. Exciting isn’t it?</p>
<h1 id="selenium_on_rails">Selenium on Rails</h1>
<h2 id="overview">Overview</h2>
<p>Selenium on Rails provides an easy way to test Rails application with
SeleniumCore[http://www.openqa.org/selenium-core/].</p>
<p>This plugin does four things:</p>
<ol>
<li>The Selenium Core files don’t have to pollute <tt>/public</tt>.</li>
<li>No need to create suite files, they are generated on the fly — one suite per directory in <tt>/test/selenium</tt> (suites can be nested).</li>
<li>Instead of writing the test cases in HTML you can use a number of better formats (see <tt>Formats</tt>).</li>
<li>Loading of fixtures and wiping of session (<tt>/selenium/setup</tt>).</li>
</ol>
<h2 id="installation">Installation</h2>
<p>Rails periodically changes the way that it renders pages, which unfortunately breaks backwards versions of Selenium on Rails. Therefore there are different
installation locations depending on your version of Rails:</p>
<p><em>Rails 2.2 and up:</em></p>
<pre><code>http://svn.openqa.org/svn/selenium-on-rails/stable/selenium-on-rails
</code></pre>
<p><em>Rails 2.1:</em></p>
<pre><code>http://svn.openqa.org/svn/selenium-on-rails/tags/rails_2_1/selenium-on-rails
</code></pre>
<p><em>Before Rails 2.1:</em></p>
<pre><code>http://svn.openqa.org/svn/selenium-on-rails/tags/pre-rails-2-1/selenium-on-rails
</code></pre>
<p>The latest release is always kept on GitHub at </p>
<pre><code>git clone git://github.com/paytonrules/selenium-on-rails.git
</code></pre>
<p>To install:</p>
<ol>
<li>Install Selenium on Rails: script/plugin install <URL></li>
<li>If you‘re on Windows, gem install win32-open3</li>
<li>If the RedCloth gem is available the Selenese test cases can use it for better markup.</li>
<li>Run the Rakefile in the plugin‘s directory to run the tests in order to see that everything works. (If RedCloth isn‘t installed a few tests will fail since they assume RedCloth is installed.)</li>
<li>Create a test case: script/generate selenium <TestName></li>
<li>Start the server: script/server -e test</li>
<li>Point your browser to localhost:3000/selenium</li>
<li>If everything works as expected you should see the Selenium test runner. The north east frame contains all your test cases (just one for now), and the north frame contains your test case.</li>
</ol>
<h2 id="formats">Formats</h2>
<p>The test cases can be written in a number of formats. Which one you choose is a matter of taste. You can generate your test files by running script/generate selenium or by creating them manually in your /test/selenium directory.</p>
<h2 id="rselenese_rsel">RSelenese, .rsel</h2>
<p>RSelenese lets you write your tests in Ruby. This is my favorite format.</p>
<pre><code>setup :fixtures => :all
open '/'
assert_title 'Home'
('a'..'z').each {|c| open :controller => 'user', :action => 'create', :name => c }
</code></pre>
<p>See SeleniumOnRails::TestBuilder for available commands. <em>IMPORTANT NOTE:</em> RSelenese generates the HTML tables for Selenium behind the scenes when the page is loaded - ONCE. That means code like this:</p>
<pre><code>(1..10).each do |index|
do something
end
</code></pre>
<p>Will only be executed when the test is loaded, not when the test is run. This is a common error and leads to tests that work the first time and fail the second time.</p>
<h2 id="selenese_sel">Selenese, .sel</h2>
<p>Selenese is the dumbest format (in a good way). You just write your commands delimited by | characters.</p>
<pre><code>|open|/selenium/setup|
|open|/|
|goBack|
</code></pre>
<p>If you don‘t want to write Selenese tests by hand you can use SeleniumIDE which has support for Selenese.</p>
<h2 id="html_rhtml">HTML/RHTML</h2>
<p>You can write your tests in HTML/RHTML but that‘s mostly useful if you have existing tests you want to reuse.</p>
<h2 id="partial_test_cases">Partial test cases</h2>
<p>If you have some common actions you want to do in several test cases you can put them in a separate partial test case and include them in your other test cases. This is highly recommended, just as small functions would be recommended in structured programming.</p>
<p>A partial test case is just like a normal test case besides that its filename has to start with _:</p>
<pre><code>#_login.rsel
open '/login'
type 'name', name
type 'password', password
click 'submit', :wait=>true
</code></pre>
<p>To include a partial test case in a RSelenese test case:</p>
<pre><code>include_partial 'login', :name => 'Jane Doe', :password => 'Jane Doe'.reverse
</code></pre>
<p>in a Selenese test case:</p>
<pre><code>|includePartial|login|name=John Doe|password=eoD nhoJ|
</code></pre>
<p>and in a RHTML test case:</p>
<pre><code><%= render :partial => 'login', :locals => {:name = 'Joe Schmo', :password => 'Joe Schmo'.reverse} %>
</code></pre>
<h2 id="configuration">Configuration</h2>
<p>There are a number of settings available. You make them by renaming selenium.yml.example to selenium.yml and placing it in your rails app’s config
file. Make your changes in that file.</p>
<h2 id="environments">Environments</h2>
<p>Per default this plugin is only available in test environment. You can change this by setting environments, such as:</p>
<pre><code>#selenium.yml
environments:
- test
- development
</code></pre>
<h2 id="selenium_core_path">Selenium Core path</h2>
<p>If you don‘t want to use the bundled Selenium Core version you can set selenium_path to the directory where Selenium Core is stored.</p>
<pre><code>#config.yml
selenium_path: 'c:\selenium'
</code></pre>
<h2 id="rake_task">Rake Task</h2>
<p>You can run all your Selenium tests as a Rake task. If you’re using a continuous builder this is a great way to integrate selenium into your build process. First, if you‘re on Windows, you have to make sure win32-open3 is installed. Then you have to configure which browsers you want to run, like this:</p>
<pre><code>#config.yml
browsers:
firefox: 'c:\Program Files\Mozilla Firefox\firefox.exe'
ie: 'c:\Program Files\Internet Explorer\iexplore.exe'
</code></pre>
<p>Now you‘re all set. First start a server:</p>
<pre><code>script/server -e test
</code></pre>
<p>Then run the tests:</p>
<pre><code>rake test:acceptance
</code></pre>
<p>Now it should work, otherwise let me know!</p>
<h2 id="store_results">Store results</h2>
<p>If you want to store the results from a test:acceptance you just need to set in which directory they should be stored:</p>
<pre><code>#config.yml
result_dir: 'c:\result'
</code></pre>
<p>So when you run rake test:acceptance the tables with the results will be stored as .html files in that directory.</p>
<h2 id="user_extensionjs">user_extension.js</h2>
<p>Selenium has support for user_extension.js which is a way to extend the functionality of Selenium Core. Selenium on Rails now provides the means for you to extend it’s functionality to match.</p>
<p>To get you started, we’ve included the example files lib/test_builder_user_accessors.rb.example and lib/test_builder_user_actions.rb.example that replicate the sample extensions in Selenium Core’s user-extensions.js.sample.</p>
<p>To get these examples running, simply remove the .example and .sample extensions
from the files and restart your server.</p>
<h2 id="todo">Todo</h2>
<ul>
<li><p>Standalone mode
More work is needed on test:acceptance< on Windows to be able to start the server when needed.</p></li>
<li><p>Documentation update</p></li>
</ul>
<h2 id="not_todo">Not todo</h2>
<ul>
<li>Editor
Creating an editor for the test cases is currently considered out of scope for this plugin. SeleniumIDE[http://www.openqa.org/selenium-ide/] does such a good job and has support[http://wiki.openqa.org/display/SIDE/SeleniumOnRails] for both the Selenese and RSelenese formats.</li>
</ul>
<h2 id="credits">Credits</h2>
<ul>
<li>Jonas Bengston — original creator</li>
<li>Eric Smith, http://blog.8thlight.com/eric — Current Maintainer</li>
<li>Jon Tirsen, http://jutopia.tirsen.com — initial inspiration[http://wiki.rubyonrails.com/rails/pages/SeleniumIntegration]</li>
<li>Eric Kidd, http://www.randomhacks.net — contribution of RSelenese</li>
<li>Marcos Tapajós http://www.improveit.com.br/en/company/tapajos — Several useful features, current committer</li>
<li>Ryan Bates, http://railscasts.com — Fixes for Rails 2.1</li>
<li>Nando Vieira, http://simplesideias.com.br</li>
<li>Gordon McCreight, a neat script that lists any unsupported methods</li>
</ul>
<h2 id="contributing_">Contributing ##</h2>
<p>Contributing is simple. Fork the github repo listed above, make your changes, then issue a pull request. <em>IMPORTANT</em> I will not take forks that do not have associated unit tests. There must be tests, and they must pass, so I can bring the changes in.</p>
<h2 id="information">Information</h2>
<p>For more information, check out the <a href="http://seleniumhq.org/projects/on-rails/">website</a>.</p>
</div>
<!-- if includes -->
<div id="section">
<!-- if method_list -->
</div>
<div id="validator-badges">
<p><small><a href="http://validator.w3.org/check/referer">[Validate]</a></small></p>
</div>
</body>
</html>