The Perl Toolchain Summit 2025 Needs You: You can help 🙏 Learn more

EXODIST / Test-Simple-1.301001_001 / lib / Test / Builder / Formatter / LegacyResults.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

              
package Test::Builder::Formatter::LegacyResults;
use strict;
use warnings;
use parent 'Test::Builder::Formatter';
use Test::Builder::Threads;
sub init {
    my $self = shift;
    $self->reset;
}
sub reset {
    my $self = shift;
    $self->{Test_Results} = &share( [] );
    $self->{Curr_Test}    = 0;
    &share(\$self->{Curr_Test});
    return;
}
sub summary {
    my($self) = shift;
    return map { $_->{'ok'} } @{ $self->{Test_Results} };
}
sub details {
    my $self = shift;
    return @{ $self->{Test_Results} };
}
sub current_test {
    my ($self, $tb, $num) = @_;
    lock( $self->{Curr_Test} );
    if( defined $num ) {
        my $delta = $num - $self->{Curr_Test};
        $self->{Curr_Test} = $num;
        $tb->stream->tests_run($delta);
        $tb->tap->test_number($delta) if $tb->tap;
        # If the test counter is being pushed forward fill in the details.
        my $test_results = $self->{Test_Results};
        if( $num > @$test_results ) {
            my $start = @$test_results ? @$test_results : 0;
            for( $start .. $num - 1 ) {
                $test_results->[$_] = &share(
                    {
                        'ok'      => 1,
                        actual_ok => undef,
                        reason    => 'incrementing test number',
                        type      => 'unknown',
                        name      => undef
                    }
                );
            }
        }
        # If backward, wipe history.  Its their funeral.
        elsif( $num < @$test_results ) {
            $#{$test_results} = $num - 1;
        }
    }
    return $self->{Curr_Test};
}
sub sanity_check {
    my $self = shift;
    my ($tb) = @_;
    $tb->_whoa( $self->{Curr_Test} < 0, 'Says here you ran a negative number of tests!' );
    $tb->_whoa(
        $self->{Curr_Test} != @{ $self->{Test_Results} },
        'Somehow you got a different number of results than tests ran!'
    );
    return;
}
sub ok {
    my $self = shift;
    my ($item) = @_;
    my $result = &share( {} );
    lock $self->{Curr_Test};
    $self->{Curr_Test}++;
    $result->{ok} = $item->bool;
    $result->{actual_ok} = $item->real_bool;
    my $name = $item->name;
    if(defined $name) {
        $name =~ s|#|\\#|g;    # # in a name can confuse Test::Harness.
        $result->{name} = $name;
    }
    else {
        $result->{name} = '';
    }
    if($item->skip && ($item->in_todo || $item->todo)) {
        $result->{type} = 'todo_skip',
        $result->{reason} = $item->skip || $item->todo;
    }
    elsif($item->in_todo || $item->todo) {
        $result->{reason} = $item->todo;
        $result->{type}   = 'todo';
    }
    elsif($item->skip) {
        $result->{reason} = $item->skip;
        $result->{type}   = 'skip';
    }
    else {
        $result->{reason} = '';
        $result->{type}   = '';
    }
    $self->{Test_Results}[ $self->{Curr_Test} - 1 ] = $result;
}
1;
__END__
=head1 NAME
Test::Builder::Formatter::LegacyResults - Encapsulate some legacy stuff.
=head1 DESCRIPTION
Older versions kept track of test results using an array of hashes. This is now
deprecated, but needs to still work for legacy code.
=head1 TEST COMPONENT MAP
  [Test Script] > [Test Tool] > [Test::Builder] > [Test::Bulder::Stream] > [Result Formatter]
                                                                                   ^
                                                                             You are here
A test script uses a test tool such as L<Test::More>, which uses Test::Builder
to produce results. The results are sent to L<Test::Builder::Stream> which then
forwards them on to one or more formatters. The default formatter is
L<Test::Builder::Fromatter::TAP> which produces TAP output.
=head1 AUTHORS
=over 4
=item Chad Granum E<lt>exodist@cpan.orgE<gt>
=back
=head1 SOURCE
The source code repository for Test::More can be found at
F<http://github.com/Test-More/test-more/>.
=head1 COPYRIGHT
Copyright 2014 Chad Granum E<lt>exodist7@gmail.comE<gt>.
This program is free software; you can redistribute it and/or
modify it under the same terms as Perl itself.
See F<http://www.perl.com/perl/misc/Artistic.html>