Commit | Line | Data |
4f6d213e |
1 | package Test::WWW::Selenium::Catalyst; |
2 | |
3 | use warnings; |
4 | use strict; |
5 | use Carp; |
6 | use Alien::SeleniumRC; |
7 | use Test::WWW::Selenium; |
8 | use Test::More; |
9 | use Catalyst::Utils; |
10 | |
11 | BEGIN { $ENV{CATALYST_ENGINE} ||= 'HTTP'; } |
12 | |
13 | local $SIG{CHLD} = 'IGNORE'; |
14 | |
15 | my $DEBUG = $ENV{CATALYST_DEBUG}; |
16 | my $app; # app name (MyApp) |
17 | my $sel_pid; # pid of selenium server |
18 | my $app_pid; # pid of myapp server |
19 | |
20 | =head1 NAME |
21 | |
1cdeb21f |
22 | Test::WWW::Selenium::Catalyst - Test your Catalyst application with Selenium |
4f6d213e |
23 | |
24 | =cut |
25 | |
de35f86c |
26 | our $VERSION = '0.01'; |
4f6d213e |
27 | |
de35f86c |
28 | =head1 DEVELOPERISH RELEASE |
1cdeb21f |
29 | |
de35f86c |
30 | This is still a test release. It's working for me in production, but |
1cdeb21f |
31 | it depends on a Java application (SeleniumRC), which can be |
32 | unreliable. On my Debian system, I had to put C<firefox-bin> in my |
33 | path, and add C</usr/lib/firefox> to C<LD_LIBRARY_PATH>. Every distro |
34 | and OS is different, so I'd like some feedback on how this works on |
35 | your system. I would like to find a clean solution that lets this |
36 | module "Just Work" for everyone, but I have a feeling that it's going |
37 | to look more like C<if(gentoo){ ... } elsif (debian) { ... }> and so |
38 | on. I can live with that, but I need your help to get to that stage! |
39 | |
40 | Please report any problems to RT, the Catalyst mailing list, or the |
41 | #catalyst IRC channel on L<irc.perl.org>. Thanks! |
42 | |
4f6d213e |
43 | =head1 SYNOPSIS |
44 | |
45 | use Test::WWW::Selenium::Catalyst 'MyApp'; |
46 | use Test::More tests => 2; |
47 | |
48 | my $sel = Test::WWW::Selenium::Catalyst->start; |
49 | $sel->open_ok('/'); |
50 | $sel->is_text_present_ok('Welcome to MyApp'); |
51 | |
1cdeb21f |
52 | This module starts the SeleniumRC server and your Catalyst app so that |
53 | you can test it with SeleniumRC. Once you've called |
6fd21f2e |
54 | C<< Test::WWW::Selenium::Catalyst->start >>, everything is just like |
1cdeb21f |
55 | L<Test::WWW::Selenium|Test::WWW:Selenium>. |
56 | |
cba20015 |
57 | =head1 METHODS |
4f6d213e |
58 | |
59 | =head2 start |
60 | |
61 | Starts the Selenium and Catalyst servers, and returns a |
62 | pre-initialized, ready-to-use Test::WWW::Selenium object. |
63 | |
64 | [NOTE] The selenium server is actually started when you C<use> this |
65 | module, and it's killed when your test exits. |
66 | |
67 | =head2 sel_pid |
68 | |
69 | Returns the process ID of the Selenium Server. |
70 | |
71 | =head2 app_pid |
72 | |
73 | Returns the process ID of the Catalyst server. |
74 | |
75 | =cut |
76 | |
77 | |
78 | sub _start_server { |
79 | # fork off a selenium server |
80 | my $pid; |
81 | if(0 == ($pid = fork())){ |
82 | local $SIG{TERM} = sub { |
6fd21f2e |
83 | diag("Selenium server $$ going down (TERM)") if $DEBUG; |
4f6d213e |
84 | exit 0; |
85 | }; |
86 | |
87 | chdir '/'; |
88 | |
89 | if(!$DEBUG){ |
90 | close *STDERR; |
91 | close *STDOUT; |
e39d6317 |
92 | #close *STDIN; |
4f6d213e |
93 | } |
94 | |
95 | diag("Selenium running in $$") if $DEBUG; |
d5bcfeb7 |
96 | Alien::SeleniumRC::start() |
4f6d213e |
97 | or croak "Can't start Selenium server"; |
98 | diag("Selenium server $$ going down") if $DEBUG; |
99 | exit 1; |
100 | } |
101 | $sel_pid = $pid; |
102 | } |
103 | |
104 | sub sel_pid { |
105 | return $sel_pid; |
106 | } |
107 | |
108 | sub app_pid { |
109 | return $app_pid; |
110 | } |
111 | |
112 | sub import { |
113 | my ($class, $appname) = @_; |
114 | croak q{Specify your app's name} if !$appname; |
115 | $app = $appname; |
116 | |
117 | my $d = $ENV{Catalyst::Utils::class2env($appname). "_DEBUG"}; # MYAPP_DEBUG |
118 | if(defined $d && $d){ |
119 | $DEBUG = 1; |
120 | } |
121 | elsif(defined $d && $d == 0){ |
122 | $DEBUG = 0; |
123 | } |
124 | # if it's something else, leave the CATALYST_DEBUG setting in tact |
125 | |
126 | _start_server() or croak "Couldn't start selenium server"; |
127 | return 1; |
128 | } |
129 | |
130 | sub start { |
131 | my $class = shift; |
132 | my $args = shift || {}; |
133 | |
134 | # start a Catalyst MyApp server |
135 | eval("use $app"); |
136 | croak "Couldn't load $app: $@" if $@; |
137 | |
138 | my $pid; |
139 | if(0 == ($pid = fork())){ |
140 | local $SIG{TERM} = sub { |
141 | diag("Catalyst server $$ going down (TERM)") if $DEBUG; |
142 | exit 0; |
143 | }; |
144 | diag("Catalyst server running in $$") if $DEBUG; |
145 | $app->run('3000', 'localhost'); |
146 | exit 1; |
147 | } |
148 | $app_pid = $pid; |
149 | |
150 | my $tries = 5; |
151 | my $error; |
152 | my $sel; |
153 | while(!$sel && $tries--){ |
154 | sleep 1; |
155 | diag("Waiting for selenium server to start") |
156 | if $DEBUG; |
157 | |
158 | eval { |
159 | $sel = Test::WWW::Selenium-> |
160 | new(host => 'localhost', |
161 | port => 4444, |
162 | browser => $args->{browser} || '*firefox', |
163 | browser_url => 'http://localhost:3000/' |
164 | ); |
165 | }; |
166 | $error = $@; |
167 | } |
168 | |
169 | eval { $sel->start } |
170 | or croak "Can't start selenium: $@ (previous error: $error)"; |
171 | |
172 | return $sel; |
173 | } |
174 | |
175 | END { |
176 | if($sel_pid){ |
177 | diag("Killing Selenium Server $sel_pid") if $DEBUG; |
178 | kill 15, $sel_pid or diag "Killing Selenium: $!"; |
179 | undef $sel_pid; |
180 | } |
181 | if($app_pid){ |
182 | diag("Killing catalyst server $app_pid") if $DEBUG; |
183 | kill 15, $app_pid or diag "Killing MyApp: $!"; |
184 | undef $app_pid; |
185 | } |
186 | diag("Waiting for children to die") if $DEBUG; |
187 | waitpid $sel_pid, 0 if $sel_pid; |
188 | waitpid $app_pid, 0 if $app_pid; |
189 | } |
190 | |
191 | |
192 | =head1 ENVIRONMENT |
193 | |
194 | Debugging messages are shown if C<CATALYST_DEBUG> or C<MYAPP_DEBUG> |
195 | are set. C<MYAPP> is the name of your application, uppercased. (This |
196 | is the same syntax as Catalyst itself.) |
197 | |
198 | =head1 DIAGNOSTICS |
199 | |
200 | =head2 Specify your app's name |
201 | |
202 | You need to pass your Catalyst app's name as the argument to the use |
203 | statement: |
204 | |
205 | use Test::WWW::Selenium::Catalyst 'MyApp' |
206 | |
207 | C<MyApp> is the name of your Catalyst app. |
208 | |
1cdeb21f |
209 | =head1 SEE ALSO |
210 | |
211 | =over 4 |
212 | |
213 | =item * |
214 | |
215 | Selenium website: L<http://www.openqa.org/> |
216 | |
217 | =item * |
218 | |
219 | Description of what you can do with the C<$sel> object: L<Test::WWW::Selenium> |
220 | |
221 | =item * |
222 | |
223 | If you don't need a real web browser: L<Test::WWW::Mechanize::Catalyst> |
224 | |
225 | =back |
226 | |
4f6d213e |
227 | =head1 AUTHOR |
228 | |
229 | Jonathan Rockway, C<< <jrockway at cpan.org> >> |
230 | |
231 | =head1 BUGS |
232 | |
233 | Please report any bugs or feature requests to |
234 | C<bug-test-www-selenium-catalyst at rt.cpan.org>, or through the web interface at |
235 | L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-WWW-Selenium-Catalyst>. |
236 | I will be notified, and then you'll automatically be notified of progress on |
237 | your bug as I make changes. |
238 | |
cba20015 |
239 | =head1 PATCHES |
4f6d213e |
240 | |
cba20015 |
241 | Send me unified diffs against the git HEAD at: |
4f6d213e |
242 | |
cba20015 |
243 | git://git.jrock.us/Test-WWW-Selenium-Catalyst |
4f6d213e |
244 | |
cba20015 |
245 | You can view the repository online at |
4f6d213e |
246 | |
cba20015 |
247 | http://git.jrock.us/?p=Test-WWW-Selenium-Catalyst.git;a=summary |
4f6d213e |
248 | |
cba20015 |
249 | Thanks in advance for your contributions! |
4f6d213e |
250 | |
251 | =head1 ACKNOWLEDGEMENTS |
252 | |
1cdeb21f |
253 | Thanks for mst for getting on my case to actually write this thing :) |
254 | |
4f6d213e |
255 | =head1 COPYRIGHT & LICENSE |
256 | |
257 | Copyright 2006 Jonathan Rockway, all rights reserved. |
258 | |
259 | This program is free software; you can redistribute it and/or modify it |
260 | under the same terms as Perl itself. |
261 | |
262 | =cut |
263 | |
264 | 1; # End of Test::WWW::Selenium::Catalyst |