mirror/php-monolog
1
0
Fork 0
mirror of https://github.com/Seldaek/monolog.git synced 2025-08-05 12:47:39 +02:00
Code Issues Releases Wiki Activity

Slack improvements (#894)

Browse Source 
- [x] Exclude `extra`/`context`, `datetime`, `level` from message when attachment is used
- [x] Use `ts` attachment key to display `datetime` considering user timezone
- [x] [Support](https://github.com/Seldaek/monolog/pull/846#issuecomment-249528719) custom user images
- [x] [Allow](https://github.com/Seldaek/monolog/pull/894#issuecomment-263532399) to setup username from slack
- [x] [Improve](https://github.com/Seldaek/monolog/pull/846#issuecomment-261529198) array formatting within `context`/`extra`
- [x] [Support](https://github.com/Seldaek/monolog/issues/745) `include_stacktraces` option when attachment is not used and always include stacktraces when attachment is used
- [x] Support `extra`/`context` field exclusion
- [x] Update tests
This commit is contained in:
Anton Nizhegorodov
2016-12-13 16:25:55 +02:00
committed by Jordi Boggiano
parent fdd6780ffd
commit b732364e70
5 changed files with 201 additions and 104 deletions
Download Patch File Download Diff File Expand all files Collapse all files

156
tests/Monolog/Handler/Slack/SlackRecordTest.php
View File

@@ -19,11 +19,11 @@ use Monolog\TestCase;
*/
class SlackRecordTest extends TestCase
{
private $channel;
private $jsonPrettyPrintFlag;
protected function setUp()
{
$this->channel = 'monolog_alerts';
$this->jsonPrettyPrintFlag = defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT : 128;
}
public function dataGetAttachmentColor()
@@ -39,6 +39,7 @@ class SlackRecordTest extends TestCase
array(Logger::EMERGENCY, SlackRecord::COLOR_DANGER),
);
}
/**
* @dataProvider dataGetAttachmentColor
* @param int $logLevel
@@ -47,7 +48,7 @@ class SlackRecordTest extends TestCase
*/
public function testGetAttachmentColor($logLevel, $expectedColour)
{
$slackRecord = new SlackRecord('#test');
$slackRecord = new SlackRecord();
$this->assertSame(
$expectedColour,
$slackRecord->getAttachmentColor($logLevel)
@@ -56,26 +57,20 @@ class SlackRecordTest extends TestCase
public function testAddsChannel()
{
$record = new SlackRecord($this->channel);
$channel = '#test';
$record = new SlackRecord($channel);
$data = $record->getSlackData($this->getRecord());
$this->assertArrayHasKey('channel', $data);
$this->assertSame($this->channel, $data['channel']);
$this->assertSame($channel, $data['channel']);
}
public function testStringifyReturnsNullWithNoLineFormatter()
public function testNoUsernameByDefault()
{
$slackRecord = new SlackRecord('#test');
$this->assertNull($slackRecord->stringify(array('foo' => 'bar')));
}
public function testAddsDefaultUsername()
{
$record = new SlackRecord($this->channel);
$record = new SlackRecord();
$data = $record->getSlackData($this->getRecord());
$this->assertArrayHasKey('username', $data);
$this->assertSame('Monolog', $data['username']);
$this->assertArrayNotHasKey('username', $data);
}
/**
@@ -83,17 +78,24 @@ class SlackRecordTest extends TestCase
*/
public function dataStringify()
{
$jsonPrettyPrintFlag = defined('JSON_PRETTY_PRINT') ? JSON_PRETTY_PRINT : 128;
$multipleDimensions = array(array(1, 2));
$numericKeys = array('library' => 'monolog');
$singleDimension = array(1, 'Hello', 'Jordi');
return array(
array(array(), ''),
array(array('foo' => 'bar'), 'foo: bar'),
array(array('Foo' => 'bAr'), 'Foo: bAr'),
array(array(), '[]'),
array($multipleDimensions, json_encode($multipleDimensions, $jsonPrettyPrintFlag)),
array($numericKeys, json_encode($numericKeys, $jsonPrettyPrintFlag)),
array($singleDimension, json_encode($singleDimension))
);
}
/**
* @dataProvider dataStringify
*/
public function testStringifyWithLineFormatter($fields, $expectedResult)
public function testStringify($fields, $expectedResult)
{
$slackRecord = new SlackRecord(
'#test',
@@ -110,7 +112,7 @@ class SlackRecordTest extends TestCase
public function testAddsCustomUsername()
{
$username = 'Monolog bot';
$record = new SlackRecord($this->channel, $username);
$record = new SlackRecord(null, $username);
$data = $record->getSlackData($this->getRecord());
$this->assertArrayHasKey('username', $data);
@@ -119,7 +121,7 @@ class SlackRecordTest extends TestCase
public function testNoIcon()
{
$record = new SlackRecord($this->channel);
$record = new SlackRecord();
$data = $record->getSlackData($this->getRecord());
$this->assertArrayNotHasKey('icon_emoji', $data);
@@ -127,25 +129,22 @@ class SlackRecordTest extends TestCase
public function testAddsIcon()
{
$record = new SlackRecord($this->channel, 'Monolog', true, 'ghost');
$data = $record->getSlackData($this->getRecord());
$record = $this->getRecord();
$slackRecord = new SlackRecord(null, null, false, 'ghost');
$data = $slackRecord->getSlackData($record);
$slackRecord2 = new SlackRecord(null, null, false, 'http://github.com/Seldaek/monolog');
$data2 = $slackRecord2->getSlackData($record);
$this->assertArrayHasKey('icon_emoji', $data);
$this->assertSame(':ghost:', $data['icon_emoji']);
}
public function testAddsEmptyTextIfUseAttachment()
{
$record = new SlackRecord($this->channel);
$data = $record->getSlackData($this->getRecord());
$this->assertArrayHasKey('text', $data);
$this->assertSame('', $data['text']);
$this->assertArrayHasKey('icon_url', $data2);
$this->assertSame('http://github.com/Seldaek/monolog', $data2['icon_url']);
}
public function testAttachmentsNotPresentIfNoAttachment()
{
$record = new SlackRecord($this->channel, 'Monolog', false);
$record = new SlackRecord(null, null, false);
$data = $record->getSlackData($this->getRecord());
$this->assertArrayNotHasKey('attachments', $data);
@@ -153,7 +152,7 @@ class SlackRecordTest extends TestCase
public function testAddsOneAttachment()
{
$record = new SlackRecord($this->channel);
$record = new SlackRecord();
$data = $record->getSlackData($this->getRecord());
$this->assertArrayHasKey('attachments', $data);
@@ -161,10 +160,10 @@ class SlackRecordTest extends TestCase
$this->assertInternalType('array', $data['attachments'][0]);
}
public function testTextEqualsMessageIfNoFormatter()
public function testTextEqualsMessageIfNoAttachment()
{
$message = 'Test message';
$record = new SlackRecord($this->channel, 'Monolog', false);
$record = new SlackRecord(null, null, false);
$data = $record->getSlackData($this->getRecord(Logger::WARNING, $message));
$this->assertArrayHasKey('text', $data);
@@ -186,7 +185,7 @@ class SlackRecordTest extends TestCase
->will($this->returnCallback(function ($record) { return $record['message'] . 'test1'; }));
$message = 'Test message';
$record = new SlackRecord($this->channel, 'Monolog', false, null, false, false, $formatter);
$record = new SlackRecord(null, null, false, null, false, false, array(), $formatter);
$data = $record->getSlackData($this->getRecord(Logger::WARNING, $message));
$this->assertArrayHasKey('text', $data);
@@ -202,7 +201,7 @@ class SlackRecordTest extends TestCase
public function testAddsFallbackAndTextToAttachment()
{
$message = 'Test message';
$record = new SlackRecord($this->channel);
$record = new SlackRecord(null);
$data = $record->getSlackData($this->getRecord(Logger::WARNING, $message));
$this->assertSame($message, $data['attachments'][0]['text']);
@@ -211,7 +210,7 @@ class SlackRecordTest extends TestCase
public function testMapsLevelToColorAttachmentColor()
{
$record = new SlackRecord($this->channel);
$record = new SlackRecord(null);
$errorLoggerRecord = $this->getRecord(Logger::ERROR);
$emergencyLoggerRecord = $this->getRecord(Logger::EMERGENCY);
$warningLoggerRecord = $this->getRecord(Logger::WARNING);
@@ -238,7 +237,7 @@ class SlackRecordTest extends TestCase
{
$level = Logger::ERROR;
$levelName = Logger::getLevelName($level);
$record = new SlackRecord($this->channel, 'Monolog', true, null, true);
$record = new SlackRecord(null, null, true, null, true);
$data = $record->getSlackData($this->getRecord($level, 'test', array('test' => 1)));
$attachment = $data['attachments'][0];
@@ -252,9 +251,11 @@ class SlackRecordTest extends TestCase
{
$level = Logger::ERROR;
$levelName = Logger::getLevelName($level);
$record = new SlackRecord($this->channel, 'Monolog', true, null, true, true);
$loggerRecord = $this->getRecord($level, 'test', array('test' => 1));
$loggerRecord['extra'] = array('tags' => array('web'));
$context = array('test' => 1);
$extra = array('tags' => array('web'));
$record = new SlackRecord(null, null, true, null, true, true);
$loggerRecord = $this->getRecord($level, 'test', $context);
$loggerRecord['extra'] = $extra;
$data = $record->getSlackData($loggerRecord);
$attachment = $data['attachments'][0];
@@ -266,13 +267,13 @@ class SlackRecordTest extends TestCase
array(
array(
'title' => 'Extra',
'value' => 'tags: ["web"]',
'short' => true
'value' => sprintf('```%s```', json_encode($extra, $this->jsonPrettyPrintFlag)),
'short' => false
),
array(
'title' => 'Context',
'value' => 'test: 1',
'short' => true
'value' => sprintf('```%s```', json_encode($context, $this->jsonPrettyPrintFlag)),
'short' => false
)
),
$attachment['fields']
@@ -283,7 +284,7 @@ class SlackRecordTest extends TestCase
{
$level = Logger::ERROR;
$levelName = Logger::getLevelName($level);
$record = new SlackRecord($this->channel, 'Monolog', true, null);
$record = new SlackRecord(null, null, true, null);
$data = $record->getSlackData($this->getRecord($level, 'test', array('test' => 1)));
$attachment = $data['attachments'][0];
@@ -295,7 +296,7 @@ class SlackRecordTest extends TestCase
array(array(
'title' => 'Level',
'value' => $levelName,
'short' => true
'short' => false
)),
$attachment['fields']
);
@@ -305,25 +306,27 @@ class SlackRecordTest extends TestCase
{
$level = Logger::ERROR;
$levelName = Logger::getLevelName($level);
$record = new SlackRecord($this->channel, 'Monolog', true, null, false, true);
$loggerRecord = $this->getRecord($level, 'test', array('test' => 1));
$loggerRecord['extra'] = array('tags' => array('web'));
$context = array('test' => 1);
$extra = array('tags' => array('web'));
$record = new SlackRecord(null, null, true, null, false, true);
$loggerRecord = $this->getRecord($level, 'test', $context);
$loggerRecord['extra'] = $extra;
$data = $record->getSlackData($loggerRecord);
$expectedFields = array(
array(
'title' => 'Level',
'value' => $levelName,
'short' => true,
'short' => false,
),
array(
'title' => 'tags',
'value' => '["web"]',
'value' => sprintf('```%s```', json_encode($extra['tags'])),
'short' => false
),
array(
'title' => 'test',
'value' => 1,
'value' => $context['test'],
'short' => false
)
);
@@ -338,4 +341,47 @@ class SlackRecordTest extends TestCase
$attachment['fields']
);
}
public function testAddsTimestampToAttachment()
{
$record = $this->getRecord();
$slackRecord = new SlackRecord();
$data = $slackRecord->getSlackData($this->getRecord());
$attachment = $data['attachments'][0];
$this->assertArrayHasKey('ts', $attachment);
$this->assertSame($record['datetime']->getTimestamp(), $attachment['ts']);
}
public function testExcludeExtraAndContextFields()
{
$record = $this->getRecord(
Logger::WARNING,
'test',
array('info' => array('library' => 'monolog', 'author' => 'Jordi'))
);
$record['extra'] = array('tags' => array('web', 'cli'));
$slackRecord = new SlackRecord(null, null, true, null, false, true, array('context.info.library', 'extra.tags.1'));
$data = $slackRecord->getSlackData($record);
$attachment = $data['attachments'][0];
$expected = array(
array(
'title' => 'info',
'value' => sprintf('```%s```', json_encode(array('author' => 'Jordi'), $this->jsonPrettyPrintFlag)),
'short' => false
),
array(
'title' => 'tags',
'value' => sprintf('```%s```', json_encode(array('web'))),
'short' => false
),
);
foreach ($expected as $field) {
$this->assertNotFalse(array_search($field, $attachment['fields']));
break;
}
}
}