-
Notifications
You must be signed in to change notification settings - Fork 6
/
TinyMocker.pm
267 lines (172 loc) · 5.61 KB
/
TinyMocker.pm
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
package Test::TinyMocker;
use strict;
use warnings;
use Carp qw{ croak };
use vars qw(@EXPORT $VERSION);
use base 'Exporter';
$VERSION = '0.02';
my $mocks = {};
@EXPORT = qw(mock unmock should method methods);
sub method($) {@_}
sub methods($) {@_}
sub should(&) {@_}
sub mock {
croak 'useless use of mock with one or less parameter'
if scalar @_ < 2;
my @symbols;
if ( @_ > 2 ) {
@symbols = ref $_[1] eq 'ARRAY' ?
map { qq{$_[0]::$_} } @{ $_[1] } :
qq{$_[0]::$_[1]};
} else {
@symbols = ref $_[0] eq 'ARRAY' ?
@{ $_[0] } :
$_[0];
}
my $sub = $_[-1];
foreach my $symbol (@symbols) {
croak "unknown symbol: $symbol"
unless _symbol_exists($symbol);
_save_sub($symbol);
_bind_coderef_to_symbol($symbol, $sub);
}
}
sub unmock {
croak 'useless use of unmock without parameters'
unless scalar @_;
my $symbol = @_ == 2 ? qq{$_[0]::$_[1]} : $_[0];
croak "unkown method $symbol"
unless $mocks->{$symbol};
{
no strict 'refs';
no warnings 'redefine', 'prototype';
*{$symbol} = delete $mocks->{$symbol};
}
}
sub _symbol_exists {
my ($symbol) = @_;
{
no strict 'refs';
no warnings 'redefine', 'prototype';
return defined *{$symbol}{CODE};
}
}
sub _bind_coderef_to_symbol {
my ($symbol, $sub) = @_;
{
no strict 'refs';
no warnings 'redefine', 'prototype';
*{$symbol} = $sub;
}
}
sub _save_sub {
my ($name) = @_;
{
no strict 'refs';
$mocks->{$name} ||= *{$name}{CODE};
}
return $name;
}
1;
__END__
=head1 NAME
Test::TinyMocker - a very simple tool to mock external modules
=head1 VERSION
Version 0.02
=head1 SYNOPSIS
use Test::More;
use Test::TinyMocker;
mock 'Some::Module'
=> method 'some_method'
=> should {
return $mocked_value;
};
# or
mock 'Some::Module'
=> methods [ 'this_method', 'that_method' ]
=> should {
return $mocked_value;
};
# or
mock 'Some::Module::some_method'
=> should {
return $mocked_value;
};
# Some::Module::some_method() will now always return $mocked_value;
# To restore the original method
unmock 'Some::Module::some_method';
# or
unmock 'Some::Module' => method 'some_method';
# or
unmock 'Some::Module' => methods [ 'this_method', 'that_method' ];
=head1 EXPORT
=head2 mock($module, $method_or_methods, $sub)
This function allows you to overwrite the given method with an arbitrary code
block. This lets you simulate soem kind of behaviour for your tests.
Alternatively, this method can be passed only two arguments, the first one will
be the full path of the method (pcakge name + method name) and the second one
the coderef.
Syntactic sugar is provided (C<method>, C<methods> and C<should>) in order to
let you write sweet mock statements:
# This:
mock('Foo::Bar', 'a_method', sub { return 42;});
# is the same as:
mock 'Foo::Bar' => method 'a_method' => should { return 42 };
# or:
mock 'Foo::Bar::a_method' => should { return 42 };
# or also:
mock('Foo::Bar::a_method', sub { return 42;});
Using multiple methods at the same time can be done with arrayrefs:
# This:
mock('Foo::Bar', ['a_method', 'b_method'], sub { 42 } );
# is the same as:
mock 'Foo::Bar' => methods ['a_method', 'b_method'] => should { 42 };
=head2 unmock($module, $method_or_methods)
Syntactic sugar is provided (C<method> and C<methods>) in order to let you write
sweet unmock statements:
# This:
unmock('Foo::Bar', 'a_method');
# is the same as:
unmock 'Foo::Bar' => method 'a_method';
And using multiple methods at the same time:
unmock 'Foo::Bar' => methods ['a_method', 'b_method'];
=head2 method
Syntactic sugar for mock()
=head2 methods
Syntactic sugar for mock()
=head2 should
Syntactic sugar for mock()
=head1 AUTHOR
Alexis Sukrieh, C<< <sukria at sukria.net> >>
=head1 BUGS
Please report any bugs or feature requests to C<bug-test-tinymocker at rt.cpan.org>, or through
the web interface at L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-TinyMocker>. I will be notified, and then you'll
automatically be notified of progress on your bug as I make changes.
=head1 SUPPORT
You can find documentation for this module with the perldoc command.
perldoc Test::TinyMocker
You can also look for information at:
=over 4
=item * RT: CPAN's request tracker
L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test-TinyMocker>
=item * AnnoCPAN: Annotated CPAN documentation
L<http://annocpan.org/dist/Test-TinyMocker>
=item * CPAN Ratings
L<http://cpanratings.perl.org/d/Test-TinyMocker>
=item * Search CPAN
L<http://search.cpan.org/dist/Test-TinyMocker/>
=back
=head1 ACKNOWLEDGEMENTS
This module was inspired by Gugod's blog, after the article published about
mocking in Ruby and Perl: L<http://gugod.org/2009/05/mocking.html>
This module was first part of the test tools provided by Dancer in its own t
directory (previously named C<t::lib::EasyMocker>). A couple of developers asked
me if I could released this module as a real Test:: distribution on CPAN, so
here it is.
=head1 LICENSE AND COPYRIGHT
Copyright 2010 Alexis Sukrieh.
This program is free software; you can redistribute it and/or modify it
under the terms of either: the GNU General Public License as published
by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
=cut