COG / Test-RandomResults-0.03 / README 

            

              
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

              
Test::RandomResults version 0.03
================================
=head1 NAME
Test::RandomResults - Test non-deterministic functions
=head1 DESCRIPTION
This module aims to provide ways of testing functions that are meant
to return results that are random; that is, non-deterministic
functions.
Some of the tests provided here might be easily achieved with other
testing modules. The reason why they're here is that this way users
become aware of how to test their non-deterministic functions.
=head1 NOTICE
This is a work in progress. Comments are welcome.
=head1 SYNOPSIS
  use Test::More plan => $Num_Tests;
  use Test::RandomResults;
  is_in( my_function, [ $list, $of, $items ], "result is inside list" );
  in_between( my_function, sub { $_[0] cmp $_[1] }, 1, 10, "result between 1 and 10");
  length_lt( my_function, $limit, "length less than $limit");
  length_le( my_function, $limit, "length less or equal to $limit");
  length_eq( my_function, $limit, "length equal to $limit");
  length_ge( my_function, $limit, "length greater of equal to $limit");
  length_gt( my_function, $limit, "length greater than $limit");
=head1 SPECIAL FEATURES
Whenever C<Test::RandomResults> is invoked, a new seed is generated
and outputed as diagnostics. This is done so that you can use it to
debug your code, if needed.
=head1 FUNCTIONS
=head2 is_in
Tests if an element belongs to an array.
  is_in( my_function, [1, 2, 3], 'either 1, 2 or 3');
=head2 in_between
Tests if an element is within two boundaries.
The second parameter to this function is what it uses to do the
comparisons.
To compare strings:
  in_between( my_function, { $_[0] cmp $_[1] }, "aaa", "zzz",
              'result is between "aaa" and "zzz"' );
To compare numbers:
  in_between( my_function, { $_[0] <=> $_[1] }, 1, 10, 'result is between 1 and 10' );
To compare something else:
  in_between( my_function, &your_function_here, $lower_boundary, $upper_boundary,
              'result is between boundaries' );
As you can see, the function should use $_[0] and $_[1] to do the comparison.
As with <=> and cmp, the function should return 1, 0 or -1 depending on whether
the first argument ($_[0]) is greater, equal to, or less than the second one
($_[1]).
C<in_between> swaps the lower and upper limits, if need be (this means
that checking whether a value is between 1 and 10 is the same as
checking between 10 and 1).
=head2 length_lt
Tests if length is less than a limit.
  length_lt( my_function, $limit, "length less than $limit");
=head2 length_le
Tests if length is less or equal to a limit.
  length_le( my_function, $limit, "length less or equal to $limit");
=head2 length_eq
Tests if length is equal to a limit.
  length_eq( my_function, $limit, "length equal to $limit");
=head2 length_ge
Tests if length is greater of equal to a limit.
  length_ge( my_function, $limit, "length greater of equal to $limit");
=head2 length_gt
Tests if length is greater than a limit.
  length_gt( my_function, $limit, "length greater than $limit");
=head1 TO DO
* Check if N results of a function are evenly_distributed
=head1 AUTHOR
Jose Castro, C<< <cog@cpan.org> >>
=head1 BUGS
Please report any bugs or feature requests to
C<bug-test-randomresults@rt.cpan.org>, or through the web interface at
L<http://rt.cpan.org>.  I will be notified, and then you'll automatically
be notified of progress on your bug as I make changes.
=head1 COPYRIGHT & LICENSE
Copyright 2005 Jose Castro, All Rights Reserved.
This program is free software; you can redistribute it and/or modify it
under the same terms as Perl itself.