Zonemaster/Backend/Log.pm untested

filter: Statementstmt 0.0% 0 / 95 Branchbran 0.0% 0 / 26 Conditioncond 0.0% 0 / 17 MC/DCmcdc 0.0% 0 / 10 Subroutinesub 0.0% 0 / 15 Podpod 0.0% 0 / 4 totaltotal 0.0% 0 / 167 CC 14 SCAR 31.4
CC
14
Cov
0%
init
56.0
structured
30.0
format_text
20.0
CRAP 23.1
1 use strict;
2 use warnings;
3  
4 package Zonemaster::Backend::Log;
5  
6 use English qw( $PID );
7 use POSIX;
8 use JSON::PP;
9 use IO::Handle;
10 use Log::Any::Adapter::Util ();
11 use Carp;
12 use Data::Dumper;
13  
14 use base qw(Log::Any::Adapter::Base);
15  
16 my $default_level = Log::Any::Adapter::Util::numeric_level( 'info' );
17  
18 sub init {
19 my ( $self ) = @_;
20  
21 if ( defined $self->{log_level} && $self->{log_level} =~ /\D/ ) {
22 $self->{log_level} = lc $self->{log_level};
23 my $numeric_level = Log::Any::Adapter::Util::numeric_level( $self->{log_level} );
24 if ( !defined( $numeric_level ) ) {
25 croak "Error: Unrecognized log level " . $self->{log_level} . "\n";
26 }
27 $self->{log_level} = $numeric_level;
28 }
29  
30 $self->{log_level} //= $default_level;
31  
32 my $fd;
33 if ( !exists $self->{file} || $self->{file} eq '-' ) {
34 if ( $self->{stderr} ) {
35 $fd = fileno( STDERR );
36 }
37 else {
38 $fd = fileno( STDOUT );
39 }
40 }
41 else {
42 open( $fd, '>>', $self->{file} ) or croak "Can't open log file: $!";
43 }
44  
45 $self->{handle} = IO::Handle->new_from_fd( $fd, "w" ) or croak "Can't fdopen file: $!";
46 $self->{handle}->autoflush( 1 );
47  
48 $self->{with_timestamp} //= 1;
49 $self->{with_pid} //= 1;
50  
51 if ( !exists $self->{formatter} ) {
52 if ( $self->{json} ) {
53 $self->{formatter} = \&format_json;
54 }
55 else {
56 $self->{formatter} = \&format_text;
57 }
58 }
59 }
60  
61 sub format_text {
62 my ( $self, $log_params ) = @_;
63 my $msg = '';
64  
65 my $timestamp = delete $log_params->{timestamp};
66 if ( defined $timestamp ) {
67 $msg .= sprintf "%s ", $timestamp;
68 }
69  
70 my $pid = delete $log_params->{pid};
71 if ( defined $pid ) {
72 $msg .= sprintf "[%d] ", $pid;
73 }
74  
75 $msg .= sprintf( "[%s] [%s] %s", uc delete $log_params->{level}, delete $log_params->{category}, delete $log_params->{message} );
76  
77 if ( %$log_params ) {
78 local $Data::Dumper::Indent = 0;
79 local $Data::Dumper::Terse = 1;
80 my $data = Dumper( $log_params );
81  
82 $msg .= " Extra parameters: $data";
83 }
84  
85 return $msg;
86 }
87  
88 sub format_json {
89 my ( $self, $log_params ) = @_;
90  
91 my $js = JSON::PP->new;
92 $js->canonical( 1 );
93  
94 return $js->encode( $log_params );
95 }
96  
97 sub structured {
98 my ( $self, $level, $category, $string, @items ) = @_;
99  
100 my $log_level = Log::Any::Adapter::Util::numeric_level( $level );
101  
102 return if $log_level > $self->{log_level};
103  
104 my %log_params = (
105 level => $level,
106 category => $category,
107 message => $string,
108 );
109  
110 if ( $self->{with_timestamp} ) {
111 $log_params{timestamp} = strftime( "%FT%TZ", gmtime );
112 }
113  
114 if ( $self->{with_pid} ) {
115 $log_params{pid} = $PID;
116 }
117  
118 for my $item ( @items ) {
119 if ( ref( $item ) eq 'HASH' ) {
120 for my $key ( keys %$item ) {
121 $log_params{$key} = $item->{$key};
122 }
123 }
124 }
125  
126 my $msg = $self->{formatter}->( $self, \%log_params );
127 $self->{handle}->print( $msg . "\n" );
128 }
129  
130 # From Log::Any::Adapter::File
131 foreach my $method ( Log::Any::Adapter::Util::detection_methods() ) {
132 no strict 'refs';
133 my $base = substr( $method, 3 );
134 my $method_level = Log::Any::Adapter::Util::numeric_level( $base );
135 *{$method} = sub {
136 return !!( $method_level <= $_[0]->{log_level} );
137 };
138 }
139  
140 1;
141  
142 =head1 NAME
143  
144 Zonemaster::Backend::Log
145  
146 =head1 SYNOPSIS
147  
148 Log::Any::Adapter->set(
149 '+Zonemaster::Backend::Log',
150 log_level => 'info',
151 json => 0,
152 file => '/path/to/logfile.log',
153 with_pid => 1,
154 with_timestamp => 1,
155 );
156  
157 =head1 DESCRIPTION
158  
159 This is an adapter for Log::Any, tailored towards the needs of Zonemaster
160 Backend.
161  
162 The following attributes are supported.
163  
164 =over 4
165  
166 =item file
167  
168 A string. The location of the log file to use. Default: C<->.
169  
170 The special value C<-> sends output to stdout or stderr depending on the
171 C<stderr> attribute.
172  
173 =item stderr
174  
175 A boolean. True means log to stderr. False means log to stdout. Default: false.
176  
177 Ignored if C<file> is anything other than C<->.
178  
179 =item log_level
180  
181 The threshold for emitting log entries. Default: info.
182  
183 The allowed values are specified at L<Log::Any/LOG-LEVELS>.
184  
185 =item json
186  
187 A boolean. When true, logs are written in JSON format. Default: false.
188  
189 =item with_timestamp
190  
191 A boolean. Controls the inclusion of timestamp log entries. Default: true.
192  
193 =item with_pid
194  
195 A boolean. Controls the inclusion of PID in log entries. Default: true.
196  
197 =back
198  
199 =cut