1 package Test::Harness::Selenium;
5 use Socialtext::WikiFixture::Selenese;
6 use HTML::TableExtract;
14 package Test::Builder;
16 use Class::Method::Modifiers;
17 use ExtUtils::MakeMaker qw(prompt);
19 if (!$ENV{AUTOMATED_TESTING}) {
21 my ($orig, $self) = (shift, shift);
22 my $res = $self->$orig(@_);
24 if ('y' eq prompt "Well that didn't work, did it. Bail out?", 'y') {
36 if( $ENV{SELENIUM_RC_HOST} &&
37 $ENV{SELENIUM_RC_PORT} &&
38 $ENV{SELENIUM_RC_START} ) {
39 $args{selenium_rc}{host} = $ENV{SELENIUM_RC_HOST};
40 $args{selenium_rc}{port} = $ENV{SELENIUM_RC_PORT};
41 $args{selenium_rc}{start} = $ENV{SELENIUM_RC_START};
47 sub start_selenium_server {
49 if($self->{selenium_rc}{start}) {
50 $self->{selenium_rc}{xvnc_server_proc} = Child->new(sub {
51 system('ssh', $self->{selenium_rc}{host}, 'vncserver');
54 $self->{selenium_rc}{xvnc_server_proc}->start;
55 $self->{selenium_rc}{selenium_server_proc} = Child->new(sub {
56 system('ssh', $self->{selenium_rc}{host}, 'env',
57 "DISPLAY=:$self->{selenium_rc}{xvnc_display}", 'selenium-rc', '-port',
58 $self->{selenium_rc}{port} );
61 $self->{selenium_rc}{selenium_server_proc}->start;
66 $self->{src} = Socialtext::WikiFixture::Selenese->new(
67 host => $self->{selenium_rc}{host},
68 port => $self->{selenium_rc}{port},
69 browser => $self->{browser},
70 browser_url => $self->{app_base},
74 if(!defined $self->{src}) {
81 die "timed out waiting for selenium server to start" if $tries == 5;
84 sub stop_selenium_server {
86 # okay, we're done, kill the server.
88 "http://%s:%s/selenium-server/driver/?cmd=shutDownSeleniumServer",
89 $self->{selenium_rc}{host}, $self->{selenium_rc}{port};
92 $self->{selenium_rc}{selenium_server_proc}->wait;
93 $self->{selenium_rc}{xvnc_server_proc}->wait;
96 sub start_app_server {
98 $self->{app_server_proc} = Child->new(sub { exec($self->{app_server_cmd}) } );
99 $self->{app_server_proc}->start;
102 sub stop_app_server {
104 $self->{app_server_proc}->complete || $self->{app_server_proc}->kill("KILL");
108 my ($self, $dir) = @_;
109 if($self->{selenium_rc}{start} && !$self->{selenium_rc}{selenium_server_proc}) {
110 $self->start_selenium_server;
112 my @tests = File::Find::Rule->file()->name('*.html')->in($dir);
113 for my $test (@tests) {
114 $self->run_tests_for($test);
119 my ($self, $html_file) = @_;
120 my $rows = $self->get_rows_for($html_file);
121 $self->{src}->run_test_table($rows);
124 my $te = HTML::TableExtract->new;
126 my ($self, $html_file) = @_;
127 my $html = io($html_file)->all;
129 my $table = ($te->tables)[0];
131 [ map { (!defined $_ or $_ eq "\240") ? () : $_ } @$_ ]
132 } grep { defined $_->[1] } $table->rows;
138 if(exists $self->{selenium_rc}{xvnc_server_proc} and
139 exists $self->{selenium_rc}{selenium_server_proc}) {
140 $self->{selenium_rc}{xvnc_server_proc}->complete ||
141 $self->{selenium_rc}{xvnc_server_proc}->kill("KILL");
142 $self->{selenium_rc}{selenium_server_proc}->complete ||
143 $self->{selenium_rc}{selenium_server_proc}->kill("KILL");
145 $self->stop_app_server;
154 Test::Harness::Selenium - Test your app with Selenium
159 my $ths = Test::Harness::Selenium->new(
161 host => 'selenium_xvnc_server',
163 start => 1, # start xvnc and selenium RC via ssh(1)
165 browser => '*firefox',
166 # app_base is relative from the machine running selenium_rc
167 app_base => 'http://10.0.0.5:3000/',
168 app_start_cmd => 'script/myapp_server.pl -p 3000',
170 # HTML tables as emitted by the Selenium IDE
171 $ths->test_directory('t/selenium_corpus');
174 # or, if you've got a selenium server already running (say, on a designer's
176 my $ths = Test::Harness::Selenium->new(
178 host => 'designers_machine',
180 start => 0, # they've already got the RC running
182 browser => '*iexplore', # can't live with it, can't live without it
183 app_base => 'http://10.0.0.5:3000/',
184 app_start_cmd => 'script/myapp_server.pl -p 3000',
187 $ths->test_directory('t/selenium_corpus');
191 C<Test::Harness::Selenium> provides an abstracted way of doing Web app testing
192 using the Selenium framework. It will connect to a running Selenium RC server,
193 or start one using ssh(1) to connect to a machine and then launching the RC
194 server and an xvnc(1) instance in which to run the given browser. After the
195 connection is established, Test::Harness::Selenium will read the specified HTML
196 files from disk and massage them into a format that
197 L<Socialtext::WikiFixture::Selenese> can parse and send to the Selenium RC
198 server. The RC server will then script the browser to do the actions described
199 in the HTML files. These actions return results, which Test::Harness::Selenium
200 then interprets as passing or failing as appropriate.
208 =item arguments: %attrs
210 =item Return value: new Test::Harness::Selenium object
214 Constructor. Accepts a list of key/value pairs according to the following:
220 Hashref. Accepts the keys host, port, start. host and port describe the server
221 on which to start/find the Selenium RC server and possibly the xvnc server.
222 start is a Boolean indicating whether to start the Selenium RC server and xvnc
227 Scalar. The browser to use for testing the app. Must be in a form that Selenium
228 RC understands (e.g. '*firefox'); see the Selenium docs for more info.
232 Scalar. The URL, relative to the machine running Selenium RC, for the base of
233 the app. All requests made to the app are relative to this URL.
237 Scalar. This command will be run by start_app_server to run the app server to
242 =head2 test_directory
244 =item arguments: $dir
246 =item Return value: None
248 Object method. test_directory will use L<File::Find::Rule> to find all C<< .html >>
249 files in the given directory, and then formats massages them into data
250 structures that L<Socialtext::WikiFixture::Selenese> can send to the Selenium RC
251 server. test_directory will then output appropriate TAP according to whether the
252 tests and checks passed or failed, respectively.
256 =item arguments: $html_file
258 =item Return value: None
260 run_tests_for is called by test_directory for each C<< .html >> file it finds in
263 =head2 start_app_server, start_app_server
265 =item Arguments: None
267 =item Return value: None
269 Start and stop the app server using the command given to the constructor.
271 =head2 start_selenium_server, start_selenium_server
273 =item Arguments: None
275 =item Return value: None
277 Start and stop the selenium / xvnc servers using the params given to the
282 =head2 SELENIUM_RC_HOST, SELENIUM_RC_PORT, SELENIUM_RC_START
284 These values override the matching values in the selenium_rc hashref passed to
289 Chris Nehren <c.nehren/ths@shadowcat.co.uk>, Matt S. Trout <mst@shadowcat.co.uk>
293 No one, yet. Patches most welcome!
297 Copyright (c) 2011 the Test::Harness::Selenium "AUTHOR" and
298 "CONTRIBUTORS" as listed above.
302 This library is free software and may be distributed under the same terms as