Logger.php
3.28 KB
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
<?php
namespace Codeception\Extension;
use Codeception\Event\FailEvent;
use Codeception\Event\StepEvent;
use Codeception\Event\SuiteEvent;
use Codeception\Event\TestEvent;
use Codeception\Events;
use Codeception\Exception\ConfigurationException;
use Codeception\Extension;
use Codeception\Test\Descriptor;
use Monolog\Handler\RotatingFileHandler;
/**
* Log suites/tests/steps using Monolog library.
* Monolog should be installed additionally by Composer.
*
* ```
* composer require monolog/monolog
* ```
*
* Steps are logged into `tests/_output/codeception.log`
*
* To enable this module add to your `codeception.yml`:
*
* ``` yaml
* extensions:
* enabled: [Codeception\Extension\Logger]
* ```
*
* #### Config
*
* * `max_files` (default: 3) - how many log files to keep
*
*/
class Logger extends Extension
{
public static $events = [
Events::SUITE_BEFORE => 'beforeSuite',
Events::TEST_BEFORE => 'beforeTest',
Events::TEST_AFTER => 'afterTest',
Events::TEST_END => 'endTest',
Events::STEP_BEFORE => 'beforeStep',
Events::TEST_FAIL => 'testFail',
Events::TEST_ERROR => 'testError',
Events::TEST_INCOMPLETE => 'testIncomplete',
Events::TEST_SKIPPED => 'testSkipped',
];
protected $logHandler;
/**
* @var \Monolog\Logger
*/
protected $logger;
protected $path;
protected $config = ['max_files' => 3];
public function _initialize()
{
if (!class_exists('\Monolog\Logger')) {
throw new ConfigurationException("Logger extension requires Monolog library to be installed");
}
$this->path = $this->getLogDir();
// internal log
$logHandler = new RotatingFileHandler($this->path . 'codeception.log', $this->config['max_files']);
$this->logger = new \Monolog\Logger('Codeception');
$this->logger->pushHandler($logHandler);
}
public function beforeSuite(SuiteEvent $e)
{
$suite = str_replace('\\', '_', $e->getSuite()->getName());
$this->logHandler = new RotatingFileHandler($this->path . $suite, $this->config['max_files']);
}
public function beforeTest(TestEvent $e)
{
$this->logger = new \Monolog\Logger(Descriptor::getTestFileName($e->getTest()));
$this->logger->pushHandler($this->logHandler);
$this->logger->info('------------------------------------');
$this->logger->info("STARTED: " . ucfirst(Descriptor::getTestAsString($e->getTest())));
}
public function afterTest(TestEvent $e)
{
}
public function endTest(TestEvent $e)
{
$this->logger->info("PASSED");
}
public function testFail(FailEvent $e)
{
$this->logger->alert($e->getFail()->getMessage());
$this->logger->info("# FAILED #");
}
public function testError(FailEvent $e)
{
$this->logger->alert($e->getFail()->getMessage());
$this->logger->info("# ERROR #");
}
public function testSkipped(FailEvent $e)
{
$this->logger->info("# Skipped #");
}
public function testIncomplete(FailEvent $e)
{
$this->logger->info("# Incomplete #");
}
public function beforeStep(StepEvent $e)
{
$this->logger->info((string) $e->getStep());
}
}