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
|
package Dancer2::Logger::Capture;
# ABSTRACT: Capture dancer logs
$Dancer2::Logger::Capture::VERSION = '1.0.0';
use Moo;
use Dancer2::Logger::Capture::Trap;
with 'Dancer2::Core::Role::Logger';
has trapper => (
is => 'ro',
lazy => 1,
builder => '_build_trapper',
);
sub _build_trapper { Dancer2::Logger::Capture::Trap->new }
sub log {
my ( $self, $level, $message ) = @_;
$self->trapper->store(
$level, $message, $self->format_message( $level => $message )
);
return;
}
1;
__END__
=pod
=encoding UTF-8
=head1 NAME
Dancer2::Logger::Capture - Capture dancer logs
=head1 VERSION
version 1.0.0
=head1 SYNOPSIS
The basics:
set logger => "capture";
my $trap = dancer_app->logger_engine->trapper;
my $logs = $trap->read;
A worked-out real-world example:
use Test::More tests => 2;
use Dancer2;
set logger => 'capture';
warning "Danger! Warning!";
debug "I like pie.";
my $trap = dancer_app->logger_engine->trapper;
is_deeply $trap->read, [
{ level => "warning", message => "Danger! Warning!" },
{ level => "debug", message => "I like pie.", }
];
# each call to read cleans the trap
is_deeply $trap->read, [];
=head1 DESCRIPTION
This is a logger class for L<Dancer2> which captures all logs to an object.
Its primary purpose is for testing. Here is an example of a test:
use strict;
use warnings;
use Test::More;
use Plack::Test;
use HTTP::Request::Common;
use Ref::Util qw<is_coderef>;
{
package App;
use Dancer2;
set log => 'debug';
set logger => 'capture';
get '/' => sub {
log(debug => 'this is my debug message');
log(core => 'this should not be logged');
log(info => 'this is my info message');
};
}
my $app = Dancer2->psgi_app;
ok( is_coderef($app), 'Got app' );
test_psgi $app, sub {
my $cb = shift;
my $res = $cb->( GET '/' );
my $trap = App->dancer_app->logger_engine->trapper;
is_deeply $trap->read, [
{ level => 'debug', message => 'this is my debug message' },
{ level => 'info', message => 'this is my info message' },
];
is_deeply $trap->read, [];
};
done_testing;
=head1 METHODS
=head2 trapper
Returns the L<Dancer2::Logger::Capture::Trap> object used to capture
and read logs.
=head1 SEE ALSO
L<Dancer2::Core::Role::Logger>, L<Dancer2::Logger::Capture::Trap>
=head1 AUTHOR
Dancer Core Developers
=head1 COPYRIGHT AND LICENSE
This software is copyright (c) 2023 by Alexis Sukrieh.
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.
=cut
|
