Attachment #69228 for bug #18205

View | Details | Raw Unified | Return to bug 18205
Collapse All | Expand All

Lines 792-797 our $PERL_DEPS = { Link Here

(-)a/C4/Installer/PerlDependencies.pm (+5 lines)
792	'required' => '1',	792	'required' => '1',
793	'min_ver' => '0.97',	793	'min_ver' => '0.97',
794	},	794	},
		795	'MojoX::Log::Log4perl' => {
		796	'usage' => 'Logs',
		797	'required' => '0',
		798	'min_ver' => '0.11',
		799	},
795	'UNIVERSAL::can' => {	800	'UNIVERSAL::can' => {
796	'usage' => 'SIP',	801	'usage' => 'SIP',
797	'required' => '1',	802	'required' => '1',




package Koha::Logger::Mojo;

# Copyright 2017 Koha-Suomi Oy
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it under the
# terms of the GNU General Public License as published by the Free Software
# Foundation; either version 3 of the License, or (at your option) any later
# version.
#
# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with Koha; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.

=head1 NAME

Koha::Logger::Mojo

=head1 SYNOPSIS

    use Koha::Logger::Mojo;

    $c->app->log(Koha::Logger::Mojo->get);
    $c->app->log->warn( 'WARNING: Serious error encountered' );

    EXAMPLE CONFIGS:
    log4perl.logger.rest = ERROR, REST
    log4perl.appender.REST=Log::Log4perl::Appender::File
    log4perl.appender.REST.filename=__LOG_DIR__/rest.log
    log4perl.appender.REST.create_at_logtime=true
    log4perl.appender.REST.syswrite=true
    log4perl.appender.REST.recreate=true
    log4perl.appender.REST.mode=append
    log4perl.appender.REST.layout=PatternLayout
    log4perl.appender.REST.layout.ConversionPattern=[%d] [%p] %m %l %n

    log4perl.logger.rest.Mojolicious.Plugin.OpenAPI = WARN, REST
    log4perl.appender.REST=Log::Log4perl::Appender::File
    log4perl.appender.REST.filename=__LOG_DIR__/rest.log
    log4perl.appender.REST.create_at_logtime=true
    log4perl.appender.REST.syswrite=true
    log4perl.appender.REST.recreate=true
    log4perl.appender.REST.mode=append
    log4perl.appender.REST.layout=PatternLayout
    log4perl.appender.REST.layout.ConversionPattern=[%d] [%p] %m %l %n

=head1 DESCRIPTION

    Use Log4perl on Mojolicious with the help of MojoX::Log::Log4perl.
=cut

use Modern::Perl;

use base 'MojoX::Log::Log4perl';

sub get {
    my ($class, $params) = @_;

    my $self;
    if ($ENV{'LOG4PERL_CONF'} and -s $ENV{"LOG4PERL_CONF"}) {
        $self = MojoX::Log::Log4perl->new($ENV{"LOG4PERL_CONF"});
    } elsif (C4::Context->config("log4perl_conf")) {
        $self = MojoX::Log::Log4perl->new(C4::Context->config("log4perl_conf"));
    } else {
        $self = MojoX::Log::Log4perl->new;
    }
    my $interface = $params ? $params->{interface}
                            ? $params->{interface} : C4::Context->interface
                            : C4::Context->interface;
    $self->{interface} = $interface;
    $self->{category} = $params->{category};

    bless $self, $class;
    return $self;
}

=head3 _get_logger

Overloads MojoX::Log::Log4perl::_get_logger by optionally including interface
and category.

For REST API, 'rest' should be the root category by default (defined in startup)

=cut

sub _get_logger {
    my ($self, $depth) = @_;

    my $category = $self->{category} ? $self->{category}
                                     : scalar caller( $depth || 1 );
    my $l4pcat  = $self->{interface} ? $self->{interface}.'.' : '';
       $l4pcat .= $category if $category;

    return Log::Log4perl->get_logger($l4pcat);
}

1;

Lines 40-45 sub startup { Link Here

(-)a/Koha/REST/V1.pm (+2 lines)
40		40
41	C4::Context->interface('rest');	41	C4::Context->interface('rest');
42		42
		43	$self->log(Koha::Logger::Mojo->get);
		44
43	# Force charset=utf8 in Content-Type header for JSON responses	45	# Force charset=utf8 in Content-Type header for JSON responses
44	$self->types->type(json => 'application/json; charset=utf8');	46	$self->types->type(json => 'application/json; charset=utf8');
45		47




#!/usr/bin/perl

# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <http://www.gnu.org/licenses>.

use Modern::Perl;
use Mojo::Base -strict;
use Mojolicious::Lite;
use Log::Log4perl;

use Test::Mojo;
use Test::More tests => 4;
use t::lib::Mocks;

use C4::Context;

BEGIN {
    $ENV{MOJO_MODE}    = 'development';
    $ENV{MOJO_NO_IPV6} = 1;
    $ENV{MOJO_REACTOR} = 'Mojo::Reactor::Poll';
    $ENV{'LOG4PERL_CONF'} = undef;
}

use_ok('Koha::Logger::Mojo');

# Create test context
my $config = {
    'log4perl.logger.rest' => 'ERROR, TEST',
    'log4perl.appender.TEST' => 'Log::Log4perl::Appender::TestBuffer',
    'log4perl.appender.TEST.layout' => 'SimpleLayout',
};
C4::Context->interface('rest');
t::lib::Mocks::mock_config('log4perl_conf', $config);

subtest 'check inteface' => sub {
    plan tests => 1;

    is(C4::Context->interface, 'rest', 'Using appropriate interface.');
};

subtest 'get() tests' => sub {
    plan tests => 1;

    app->log(Koha::Logger::Mojo->get);
    my $log = app->log;
    isa_ok($log, 'Koha::Logger::Mojo');
};

subtest 'Test configuration effectiveness' => sub {
    plan tests => 6;

    get '/test' => sub {
        package Koha::REST::V1::Test; # otherwise category would be rest.main
        $_[0]->app->log->error('Very problem');
        $_[0]->app->log->warn('Such issue');
        $_[0]->render(text => 'Hello World');
    };

    app->log(Koha::Logger::Mojo->get);

    my $appender = Log::Log4perl->appenders->{TEST};
    ok($appender, 'Got TEST appender');

    my $t = Test::Mojo->new;
    $t->app->log(Koha::Logger::Mojo->get);
    $t->get_ok('/test')
      ->status_is(200)
      ->content_is('Hello World');
    like($appender->buffer, qr/ERROR - Very problem/, 'found wanted message');
    unlike($appender->buffer, qr/WARN - Such issue/, 'did not find unwanted message');
};

1;

Return to bug 18205

Line 0 Link Here

(-)a/Koha/Logger/Mojo.pm (+102 lines)
		1	package Koha::Logger::Mojo;
		2
		3	# Copyright 2017 Koha-Suomi Oy
		4	#
		5	# This file is part of Koha.
		6	#
		7	# Koha is free software; you can redistribute it and/or modify it under the
		8	# terms of the GNU General Public License as published by the Free Software
		9	# Foundation; either version 3 of the License, or (at your option) any later
		10	# version.
		11	#
		12	# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
		13	# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
		14	# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
		15	#
		16	# You should have received a copy of the GNU General Public License along
		17	# with Koha; if not, write to the Free Software Foundation, Inc.,
		18	# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
		19
		20	=head1 NAME
		21
		22	Koha::Logger::Mojo
		23
		24	=head1 SYNOPSIS
		25
		26	use Koha::Logger::Mojo;
		27
		28	$c->app->log(Koha::Logger::Mojo->get);
		29	$c->app->log->warn( 'WARNING: Serious error encountered' );
		30
		31	EXAMPLE CONFIGS:
		32	log4perl.logger.rest = ERROR, REST
		33	log4perl.appender.REST=Log::Log4perl::Appender::File
		34	log4perl.appender.REST.filename=__LOG_DIR__/rest.log
		35	log4perl.appender.REST.create_at_logtime=true
		36	log4perl.appender.REST.syswrite=true
		37	log4perl.appender.REST.recreate=true
		38	log4perl.appender.REST.mode=append
		39	log4perl.appender.REST.layout=PatternLayout
		40	log4perl.appender.REST.layout.ConversionPattern=[%d] [%p] %m %l %n
		41
		42	log4perl.logger.rest.Mojolicious.Plugin.OpenAPI = WARN, REST
		43	log4perl.appender.REST=Log::Log4perl::Appender::File
		44	log4perl.appender.REST.filename=__LOG_DIR__/rest.log
		45	log4perl.appender.REST.create_at_logtime=true
		46	log4perl.appender.REST.syswrite=true
		47	log4perl.appender.REST.recreate=true
		48	log4perl.appender.REST.mode=append
		49	log4perl.appender.REST.layout=PatternLayout
		50	log4perl.appender.REST.layout.ConversionPattern=[%d] [%p] %m %l %n
		51
		52	=head1 DESCRIPTION
		53
		54	Use Log4perl on Mojolicious with the help of MojoX::Log::Log4perl.
		55	=cut
		56
		57	use Modern::Perl;
		58
		59	use base 'MojoX::Log::Log4perl';
		60
		61	sub get {
		62	my ($class, $params) = @_;
		63
		64	my $self;
65	if ($ENV{'LOG4PERL_CONF'} and -s $ENV{"LOG4PERL_CONF"}) {
66	$self = MojoX::Log::Log4perl->new($ENV{"LOG4PERL_CONF"});
67	} elsif (C4::Context->config("log4perl_conf")) {
68	$self = MojoX::Log::Log4perl->new(C4::Context->config("log4perl_conf"));
69	} else {
70	$self = MojoX::Log::Log4perl->new;
71	}
72	my $interface = $params ? $params->{interface}
73	? $params->{interface} : C4::Context->interface
74	: C4::Context->interface;
75	$self->{interface} = $interface;
76	$self->{category} = $params->{category};
77
78	bless $self, $class;
79	return $self;
80	}
81
82	=head3 _get_logger
83
84	Overloads MojoX::Log::Log4perl::_get_logger by optionally including interface
85	and category.
86
87	For REST API, 'rest' should be the root category by default (defined in startup)
88
89	=cut
90
91	sub _get_logger {
92	my ($self, $depth) = @_;
93
94	my $category = $self->{category} ? $self->{category}
95	: scalar caller( $depth \|\| 1 );
96	my $l4pcat = $self->{interface} ? $self->{interface}.'.' : '';
97	$l4pcat .= $category if $category;
98
99	return Log::Log4perl->get_logger($l4pcat);
100	}
101
102	1;

Line 0 Link Here

(-)a/t/Koha/Logger/Mojo.t (-1 / +85 lines)
0	-	1	#!/usr/bin/perl
		2
		3	# This file is part of Koha.
		4	#
		5	# Koha is free software; you can redistribute it and/or modify it
		6	# under the terms of the GNU General Public License as published by
		7	# the Free Software Foundation; either version 3 of the License, or
		8	# (at your option) any later version.
		9	#
		10	# Koha is distributed in the hope that it will be useful, but
		11	# WITHOUT ANY WARRANTY; without even the implied warranty of
		12	# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
		13	# GNU General Public License for more details.
		14	#
		15	# You should have received a copy of the GNU General Public License
		16	# along with Koha; if not, see <http://www.gnu.org/licenses>.
		17
		18	use Modern::Perl;
		19	use Mojo::Base -strict;
		20	use Mojolicious::Lite;
		21	use Log::Log4perl;
		22
		23	use Test::Mojo;
		24	use Test::More tests => 4;
		25	use t::lib::Mocks;
		26
		27	use C4::Context;
		28
		29	BEGIN {
		30	$ENV{MOJO_MODE} = 'development';
		31	$ENV{MOJO_NO_IPV6} = 1;
		32	$ENV{MOJO_REACTOR} = 'Mojo::Reactor::Poll';
		33	$ENV{'LOG4PERL_CONF'} = undef;
		34	}
		35
		36	use_ok('Koha::Logger::Mojo');
		37
		38	# Create test context
		39	my $config = {
		40	'log4perl.logger.rest' => 'ERROR, TEST',
		41	'log4perl.appender.TEST' => 'Log::Log4perl::Appender::TestBuffer',
		42	'log4perl.appender.TEST.layout' => 'SimpleLayout',
		43	};
		44	C4::Context->interface('rest');
		45	t::lib::Mocks::mock_config('log4perl_conf', $config);
		46
		47	subtest 'check inteface' => sub {
		48	plan tests => 1;
		49
		50	is(C4::Context->interface, 'rest', 'Using appropriate interface.');
		51	};
		52
		53	subtest 'get() tests' => sub {
		54	plan tests => 1;
		55
		56	app->log(Koha::Logger::Mojo->get);
		57	my $log = app->log;
		58	isa_ok($log, 'Koha::Logger::Mojo');
		59	};
		60
		61	subtest 'Test configuration effectiveness' => sub {
		62	plan tests => 6;
		63
		64	get '/test' => sub {
		65	package Koha::REST::V1::Test; # otherwise category would be rest.main
66	$_[0]->app->log->error('Very problem');
67	$_[0]->app->log->warn('Such issue');
68	$_[0]->render(text => 'Hello World');
69	};
70
71	app->log(Koha::Logger::Mojo->get);
72
73	my $appender = Log::Log4perl->appenders->{TEST};
74	ok($appender, 'Got TEST appender');
75
76	my $t = Test::Mojo->new;
77	$t->app->log(Koha::Logger::Mojo->get);
78	$t->get_ok('/test')
79	->status_is(200)
80	->content_is('Hello World');
81	like($appender->buffer, qr/ERROR - Very problem/, 'found wanted message');
82	unlike($appender->buffer, qr/WARN - Such issue/, 'did not find unwanted message');
83	};
84
85	1;