| 1 | package Test::Chimps::Report; | ||
| 2 | |||
| 3 | use warnings; | ||
| 4 | use strict; | ||
| 5 | |||
| 6 | =head1 NAME | ||
| 7 | |||
| 8 | Test::Chimps::Report - Encapsulate a smoke test report | ||
| 9 | |||
| 10 | =head1 SYNOPSIS | ||
| 11 | |||
| 12 | Represents a smoke report. See L<Jifty::DBI::Record>. | ||
| 13 | |||
| 14 | Note that parts of this class are dynamically generated in | ||
| 15 | Test::Chimps::Server base on the configuation file. | ||
| 16 | |||
| 17 | =head1 METHODS | ||
| 18 | |||
| 19 | =head2 new ARGS | ||
| 20 | |||
| 21 | Creates a new Report. ARGS is a hash whose only valid key is | ||
| 22 | handle. Its value must be a Jifty::DBI::Handle. | ||
| 23 | |||
| 24 | =head1 COLUMNS | ||
| 25 | |||
| 26 | C<Test::Chimps::Report>s have the following columns (and consequently accessors): | ||
| 27 | |||
| 28 | =over 4 | ||
| 29 | |||
| 30 | =item * report_html | ||
| 31 | |||
| 32 | =item * model_structure | ||
| 33 | |||
| 34 | =item * timestamp | ||
| 35 | |||
| 36 | =item * total_ok | ||
| 37 | |||
| 38 | =item * total_passed | ||
| 39 | |||
| 40 | =item * total_nok | ||
| 41 | |||
| 42 | =item * total_failed | ||
| 43 | |||
| 44 | =item * total_percentage | ||
| 45 | |||
| 46 | =item * total_ratio | ||
| 47 | |||
| 48 | =item * total_seen | ||
| 49 | |||
| 50 | =item * total_skipped | ||
| 51 | |||
| 52 | =item * total_todo | ||
| 53 | |||
| 54 | =item * total_unexpectedly_succeeded | ||
| 55 | |||
| 56 | =back | ||
| 57 | |||
| 58 | Additionally, columns are added dynamically based on the report | ||
| 59 | variables specified in the server. Unfortunately, this means that | ||
| 60 | external modules have a hard time getting at the C<Report> class as | ||
| 61 | seen by the server. | ||
| 62 | |||
| 63 | =cut | ||
| 64 | |||
| 65 | use base qw/Jifty::DBI::Record/; | ||
| 66 | |||
| 67 | package Test::Chimps::Report::Schema; | ||
| 68 | |||
| 69 | use Jifty::DBI::Schema; | ||
| 70 | |||
| 71 | column report_html => type is 'text'; | ||
| 72 | column model_structure => type is 'text', | ||
| 73 | filters are 'Jifty::DBI::Filter::Storable', 'Jifty::DBI::Filter::base64'; | ||
| 74 | column timestamp => type is 'timestamp', | ||
| 75 | filters are 'Jifty::DBI::Filter::DateTime'; | ||
| 76 | column total_ok => type is 'integer'; | ||
| 77 | column total_passed => type is 'integer'; | ||
| 78 | column total_nok => type is 'integer'; | ||
| 79 | column total_failed => type is 'integer'; | ||
| 80 | column total_percentage => type is 'integer'; | ||
| 81 | column total_ratio => type is 'integer'; | ||
| 82 | column total_seen => type is 'integer'; | ||
| 83 | column total_skipped => type is 'integer'; | ||
| 84 | column total_todo => type is 'integer'; | ||
| 85 | column total_unexpectedly_succeeded => type is 'integer'; | ||
| 86 | |||
| 87 | =head1 AUTHOR | ||
| 88 | |||
| 89 | Zev Benjamin, C<< <zev at cpan.org> >> | ||
| 90 | |||
| 91 | =head1 BUGS | ||
| 92 | |||
| 93 | Please report any bugs or feature requests to | ||
| 94 | C<bug-test-chimps at rt.cpan.org>, or through the web interface at | ||
| 95 | L<http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Test-Chimps>. | ||
| 96 | I will be notified, and then you'll automatically be notified of progress on | ||
| 97 | your bug as I make changes. | ||
| 98 | |||
| 99 | =head1 SUPPORT | ||
| 100 | |||
| 101 | You can find documentation for this module with the perldoc command. | ||
| 102 | |||
| 103 | perldoc Test::Chimps | ||
| 104 | |||
| 105 | You can also look for information at: | ||
| 106 | |||
| 107 | =over 4 | ||
| 108 | |||
| 109 | =item * Mailing list | ||
| 110 | |||
| 111 | Chimps has a mailman mailing list at | ||
| 112 | L<chimps@bestpractical.com>. You can subscribe via the web | ||
| 113 | interface at | ||
| 114 | L<http://lists.bestpractical.com/cgi-bin/mailman/listinfo/chimps>. | ||
| 115 | |||
| 116 | =item * AnnoCPAN: Annotated CPAN documentation | ||
| 117 | |||
| 118 | L<http://annocpan.org/dist/Test-Chimps> | ||
| 119 | |||
| 120 | =item * CPAN Ratings | ||
| 121 | |||
| 122 | L<http://cpanratings.perl.org/d/Test-Chimps> | ||
| 123 | |||
| 124 | =item * RT: CPAN's request tracker | ||
| 125 | |||
| 126 | L<http://rt.cpan.org/NoAuth/Bugs.html?Dist=Test-Chimps> | ||
| 127 | |||
| 128 | =item * Search CPAN | ||
| 129 | |||
| 130 | L<http://search.cpan.org/dist/Test-Chimps> | ||
| 131 | |||
| 132 | =back | ||
| 133 | |||
| 134 | =head1 COPYRIGHT & LICENSE | ||
| 135 | |||
| 136 | Copyright 2006 Best Practical Solutions. | ||
| 137 | |||
| 138 | This program is free software; you can redistribute it and/or modify it | ||
| 139 | under the same terms as Perl itself. | ||
| 140 | |||
| 141 | =cut | ||
| 142 | |||
| 143 | 1; |