tests/phpunit/mocks/TestLogger.php

   1 <?php
   2 /**
   3  * Testing logger
   4  *
   5  * Copyright (C) 2015 Wikimedia Foundation and contributors
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 2 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * This program is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License along
  18  * with this program; if not, write to the Free Software Foundation, Inc.,
  19  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  20  * http://www.gnu.org/copyleft/gpl.html
  21  *
  22  * @file
  23  */
  24
  25 use Psr\Log\LogLevel;
  26
  27 /**
  28  * A logger that may be configured to either buffer logs or to print them to
  29  * the output where PHPUnit will complain about them.
  30  *
  31  * @since 1.27
  32  */
  33 class TestLogger extends \Psr\Log\AbstractLogger {
  34         /** @var bool */
  35         private $collect;
  36         /** @var bool */
  37         private $collectContext;
  38         /** @var array */
  39         private $buffer = [];
  40         /** @var callable|null */
  41         private $filter;
  42
  43         /**
  44          * @param bool $collect Whether to collect logs. @see setCollect()
  45          * @param callable|null $filter Filter logs before collecting/printing. Signature is
  46          *  string|null function ( string $message, string $level, array $context );
  47          * @param bool $collectContext Whether to keep the context passed to log
  48          *             (since 1.29, @see setCollectContext()).
  49          */
  50         public function __construct( $collect = false, $filter = null, $collectContext = false ) {
  51                 $this->collect = $collect;
  52                 $this->collectContext = $collectContext;
  53                 $this->filter = $filter;
  54         }
  55
  56         /**
  57          * Set the "collect" flag
  58          * @param bool $collect
  59          * @return TestLogger $this
  60          */
  61         public function setCollect( $collect ) {
  62                 $this->collect = $collect;
  63                 return $this;
  64         }
  65
  66         /**
  67          * Set the collectContext flag
  68          *
  69          * @param bool $collectContext
  70          * @since 1.29
  71          * @return TestLogger $this
  72          */
  73         public function setCollectContext( $collectContext ) {
  74                 $this->collectContext = $collectContext;
  75                 return $this;
  76         }
  77
  78         /**
  79          * Return the collected logs
  80          * @return array Array of [ string $level, string $message ], or
  81          *   [ string $level, string $message, array $context ] if $collectContext was true.
  82          */
  83         public function getBuffer() {
  84                 return $this->buffer;
  85         }
  86
  87         /**
  88          * Clear the collected log buffer
  89          */
  90         public function clearBuffer() {
  91                 $this->buffer = [];
  92         }
  93
  94         public function log( $level, $message, array $context = [] ) {
  95                 $message = trim( $message );
  96
  97                 if ( $this->filter ) {
  98                         $message = ( $this->filter )( $message, $level, $context );
  99                         if ( $message === null ) {
 100                                 return;
 101                         }
 102                 }
 103
 104                 if ( $this->collect ) {
 105                         if ( $this->collectContext ) {
 106                                 $this->buffer[] = [ $level, $message, $context ];
 107                         } else {
 108                                 $this->buffer[] = [ $level, $message ];
 109                         }
 110                 } else {
 111                         switch ( $level ) {
 112                                 case LogLevel::DEBUG:
 113                                 case LogLevel::INFO:
 114                                 case LogLevel::NOTICE:
 115                                         trigger_error( "LOG[$level]: $message", E_USER_NOTICE );
 116                                         break;
 117
 118                                 case LogLevel::WARNING:
 119                                         trigger_error( "LOG[$level]: $message", E_USER_WARNING );
 120                                         break;
 121
 122                                 case LogLevel::ERROR:
 123                                 case LogLevel::CRITICAL:
 124                                 case LogLevel::ALERT:
 125                                 case LogLevel::EMERGENCY:
 126                                         trigger_error( "LOG[$level]: $message", E_USER_ERROR );
 127                                         break;
 128                         }
 129                 }
 130         }
 131 }