From Code to Community: Sponsoring The Perl and Raku Conference 2025 Learn more

EXODIST / Test2-Harness-UI-0.000130 / lib / Test2 / Harness / UI.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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292

              
package Test2::Harness::UI;
use strict;
use warnings;
our $VERSION = '0.000130';
use Router::Simple;
use Text::Xslate(qw/mark_raw/);
use Scalar::Util qw/blessed/;
use DateTime;
use Test2::Harness::UI::Request;
use Test2::Harness::UI::Controller::Upload;
use Test2::Harness::UI::Controller::User;
use Test2::Harness::UI::Controller::Run;
use Test2::Harness::UI::Controller::RunField;
use Test2::Harness::UI::Controller::Job;
use Test2::Harness::UI::Controller::JobField;
use Test2::Harness::UI::Controller::Download;
use Test2::Harness::UI::Controller::Sweeper;
use Test2::Harness::UI::Controller::Project;
use Test2::Harness::UI::Controller::Resources;
use Test2::Harness::UI::Controller::Stream;
use Test2::Harness::UI::Controller::View;
use Test2::Harness::UI::Controller::Lookup;
use Test2::Harness::UI::Controller::Query;
use Test2::Harness::UI::Controller::Events;
use Test2::Harness::UI::Controller::Durations;
use Test2::Harness::UI::Controller::Coverage;
use Test2::Harness::UI::Controller::Files;
use Test2::Harness::UI::Controller::Interactions;
use Test2::Harness::UI::Controller::Binary;
use Test2::Harness::UI::Util qw/share_dir/;
use Test2::Harness::UI::Response qw/resp error/;
use Test2::Harness::Util::JSON qw/encode_json decode_json/;
use Test2::Harness::UI::Util::HashBase qw/-config -router/;
sub init {
    my $self = shift;
    my $router = $self->{+ROUTER} ||= Router::Simple->new;
    my $config = $self->{+CONFIG};
    $router->connect('/' => {controller => 'Test2::Harness::UI::Controller::View'});
    $router->connect('/upload' => {controller => 'Test2::Harness::UI::Controller::Upload'})
        unless $config->single_run;
    $router->connect('/user' => {controller => 'Test2::Harness::UI::Controller::User'})
        unless $config->single_user;
    $router->connect('/resources/data/:id'      => {controller => 'Test2::Harness::UI::Controller::Resources', data => 1});
    $router->connect('/resources/data/:id/'     => {controller => 'Test2::Harness::UI::Controller::Resources', data => 1});
    $router->connect('/resources/data/:id/:rid' => {controller => 'Test2::Harness::UI::Controller::Resources', data => 1});
    $router->connect('/resources/:id'           => {controller => 'Test2::Harness::UI::Controller::Resources'});
    $router->connect('/resources/:id/'          => {controller => 'Test2::Harness::UI::Controller::Resources'});
    $router->connect('/resources/:id/:rid'      => {controller => 'Test2::Harness::UI::Controller::Resources'});
    $router->connect('/interactions/:id'               => {controller => 'Test2::Harness::UI::Controller::Interactions'});
    $router->connect('/interactions/:id/:context'      => {controller => 'Test2::Harness::UI::Controller::Interactions'});
    $router->connect('/interactions/data/:id'          => {controller => 'Test2::Harness::UI::Controller::Interactions', data => 1});
    $router->connect('/interactions/data/:id/:context' => {controller => 'Test2::Harness::UI::Controller::Interactions', data => 1});
    $router->connect('/project/:id'           => {controller => 'Test2::Harness::UI::Controller::Project'});
    $router->connect('/project/:id/stats'     => {controller => 'Test2::Harness::UI::Controller::Project', stats => 1});
    $router->connect('/project/:id/:n'        => {controller => 'Test2::Harness::UI::Controller::Project'});
    $router->connect('/project/:id/:n/:count' => {controller => 'Test2::Harness::UI::Controller::Project'});
    $router->connect('/query/:name'      => {controller => 'Test2::Harness::UI::Controller::Query'});
    $router->connect('/query/:name/:arg' => {controller => 'Test2::Harness::UI::Controller::Query'});
    $router->connect('/run/:id'            => {controller => 'Test2::Harness::UI::Controller::Run'});
    $router->connect('/run/:id/pin'        => {controller => 'Test2::Harness::UI::Controller::Run', action => 'pin_toggle'});
    $router->connect('/run/:id/delete'     => {controller => 'Test2::Harness::UI::Controller::Run', action => 'delete'});
    $router->connect('/run/:id/cancel'     => {controller => 'Test2::Harness::UI::Controller::Run', action => 'cancel'});
    $router->connect('/run/:id/parameters' => {controller => 'Test2::Harness::UI::Controller::Run', action => 'parameters'});
    $router->connect('/run/field/:id'        => {controller => 'Test2::Harness::UI::Controller::RunField'});
    $router->connect('/run/field/:id/delete' => {controller => 'Test2::Harness::UI::Controller::RunField', action => 'delete'});
    $router->connect('/job/field/:id'        => {controller => 'Test2::Harness::UI::Controller::JobField'});
    $router->connect('/job/field/:id/delete' => {controller => 'Test2::Harness::UI::Controller::JobField', action => 'delete'});
    $router->connect('/job/:job'         => {controller => 'Test2::Harness::UI::Controller::Job'});
    $router->connect('/job/:job/:try'    => {controller => 'Test2::Harness::UI::Controller::Job'});
    $router->connect('/event/:id'        => {controller => 'Test2::Harness::UI::Controller::Events', from => 'single_event'});
    $router->connect('/event/:id/events' => {controller => 'Test2::Harness::UI::Controller::Events', from => 'event'});
    $router->connect('/durations/:project'                => {controller => 'Test2::Harness::UI::Controller::Durations'});
    $router->connect('/durations/:project/median'         => {controller => 'Test2::Harness::UI::Controller::Durations', median => 1});
    $router->connect('/durations/:project/median/:user'   => {controller => 'Test2::Harness::UI::Controller::Durations', median => 1});
    $router->connect('/durations/:project/:short/:medium' => {controller => 'Test2::Harness::UI::Controller::Durations'});
    $router->connect('/coverage/:source'        => {controller => 'Test2::Harness::UI::Controller::Coverage'});
    $router->connect('/coverage/:source/:user'  => {controller => 'Test2::Harness::UI::Controller::Coverage'});
    $router->connect('/coverage/:source/delete' => {controller => 'Test2::Harness::UI::Controller::Coverage', delete => 1});
    $router->connect('/failed/:source'                 => {controller => 'Test2::Harness::UI::Controller::Files', failed => 1});
    $router->connect('/failed/:source/json'            => {controller => 'Test2::Harness::UI::Controller::Files', failed => 1, json => 1});
    $router->connect('/failed/:project/:idx'           => {controller => 'Test2::Harness::UI::Controller::Files', failed => 1, json => 1});
    $router->connect('/failed/:project/:username/:idx' => {controller => 'Test2::Harness::UI::Controller::Files', failed => 1, json => 1});
    $router->connect('/files/:source'                 => {controller => 'Test2::Harness::UI::Controller::Files', failed => 0});
    $router->connect('/files/:source/json'            => {controller => 'Test2::Harness::UI::Controller::Files', failed => 0, json => 1});
    $router->connect('/files/:project/:idx'           => {controller => 'Test2::Harness::UI::Controller::Files', failed => 0, json => 1});
    $router->connect('/files/:project/:username/:idx' => {controller => 'Test2::Harness::UI::Controller::Files', failed => 0, json => 1});
    $router->connect('/binary/:binary_id' => {controller => 'Test2::Harness::UI::Controller::Binary'});
    $router->connect('/download/:id' => {controller => 'Test2::Harness::UI::Controller::Download'});
    $router->connect('/lookup'              => {controller => 'Test2::Harness::UI::Controller::Lookup'});
    $router->connect('/lookup/:lookup'      => {controller => 'Test2::Harness::UI::Controller::Lookup'});
    $router->connect('/lookup/data/:lookup' => {controller => 'Test2::Harness::UI::Controller::Lookup', data => 1});
    $router->connect('/view'                   => {controller => 'Test2::Harness::UI::Controller::View'});
    $router->connect('/view/:id'               => {controller => 'Test2::Harness::UI::Controller::View'});
    $router->connect('/view/:run_id/:job'      => {controller => 'Test2::Harness::UI::Controller::View'});
    $router->connect('/view/:run_id/:job/:try' => {controller => 'Test2::Harness::UI::Controller::View'});
    $router->connect('/stream/run/:run_id'       => {controller => 'Test2::Harness::UI::Controller::Stream', run_only => 1});
    $router->connect('/stream'                   => {controller => 'Test2::Harness::UI::Controller::Stream'});
    $router->connect('/stream/:id'               => {controller => 'Test2::Harness::UI::Controller::Stream'});
    $router->connect('/stream/:run_id/:job'      => {controller => 'Test2::Harness::UI::Controller::Stream'});
    $router->connect('/stream/:run_id/:job/:try' => {controller => 'Test2::Harness::UI::Controller::Stream'});
    $router->connect('/sweeper/:count/days'    => {controller => 'Test2::Harness::UI::Controller::Sweeper', units => 'day'});
    $router->connect('/sweeper/:count/hours'   => {controller => 'Test2::Harness::UI::Controller::Sweeper', units => 'hour'});
    $router->connect('/sweeper/:count/minutes' => {controller => 'Test2::Harness::UI::Controller::Sweeper', units => 'minute'});
    $router->connect('/sweeper/:count/seconds' => {controller => 'Test2::Harness::UI::Controller::Sweeper', units => 'second'});
}
sub to_app {
    my $self = shift;
    my $router = $self->{+ROUTER};
    return sub {
        my $env = shift;
        my $req = Test2::Harness::UI::Request->new(env => $env, config => $self->{+CONFIG});
        my $r = $router->match($env) || {};
        $self->wrap($r->{controller}, $req, $r);
    };
}
sub wrap {
    my $self = shift;
    my ($class, $req, $r) = @_;
    my ($controller, $res, $session);
    my $ok = eval {
        die error(404) unless $class;
        if ($class->uses_session) {
            $session = $req->session;
            $req->session_host; # vivify this
        }
        $controller = $class->new(request => $req, config => $self->{+CONFIG});
        $res = $controller->handle($r);
        1;
    };
    my $err = $@ || 'Internal Error';
    unless ($ok && $res) {
        if (blessed($err) && $err->isa('Test2::Harness::UI::Response')) {
            $res = $err;
        }
        else {
            warn $err;
            my $msg = ($ENV{T2_HARNESS_UI_ENV} || '') eq 'dev' ? "$err\n" : undef;
            $res = error(500 => $msg);
        }
    }
    my $ct = $r->{json} ? 'application/json' : blessed($res) ? $res->content_type() : 'text/html';
    $ct ||= 'text/html';
    $ct = lc($ct);
    $res->content_type($ct) if blessed($res);
    if (my $stream = $res->stream) {
        return $stream;
    }
    if ($ct eq 'text/html') {
        my $dt = DateTime->now(time_zone => 'local');
        my $tx      = Text::Xslate->new(path => [share_dir('templates')]);
        my $wrapped = $tx->render(
            'main.tx',
            {
                config => $self->{+CONFIG},
                user     => $req->user     || undef,
                errors   => $res->errors   || [],
                messages => $res->messages || [],
                add_css  => $res->css      || [],
                add_js   => $res->js       || [],
                title    => $res->title    || ($controller ? $controller->title : 'Test2-Harness-UI'),
                time_zone => $dt->strftime("%Z"),
                base_uri => $req->base->as_string || '',
                content  => mark_raw($res->raw_body)  || '',
            }
        );
        $res->body($wrapped);
    }
    elsif($ct eq 'application/json') {
        if (my $data = $res->raw_body) {
            $res->body(ref($data) ? encode_json($data) : $data);
        }
        elsif (my $errors = $res->errors) {
            $res->body(encode_json({errors => $errors}));
        }
    }
    $res->cookies->{id} = {value => $session->session_id, httponly => 1, expires => '+1M'}
        if $session;
    return $res->finalize;
}
__END__
=pod
=encoding UTF-8
=head1 NAME
Test2::Harness::UI - Web interface for viewing and inspecting yath test logs
=head1 EARLY VERSION WARNING
This program is still in early development. There are many bugs, missing
features, and things that will change.
=head1 DESCRIPTION
This package provides a web UI for yath logs.
=head1 SYNOPSIS
The easiest thing to do is use the C<yath ui path/to/logfile> command, which
will create a temporary postgresql db, load your log into it, then launch the
app in starman on a local port that you can visit in your browser.
=head1 SOURCE
The source code repository for Test2-Harness-UI can be found at
F<https://github.com/Test-More/Test2-Harness-UI/>.
=head1 MAINTAINERS
=over 4
=item Chad Granum E<lt>exodist@cpan.orgE<gt>
=back
=head1 AUTHORS
=over 4
=item Chad Granum E<lt>exodist@cpan.orgE<gt>
=back
=head1 COPYRIGHT
Copyright 2019 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://dev.perl.org/licenses/>
=cut