src/test/php/appenders/LoggerAppenderMongoDBTest.php - logging-log4php - Git at Google

 <?php
 /**
  * Licensed to the Apache Software Foundation (ASF) under one or more
  * contributor license agreements.  See the NOTICE file distributed with
  * this work for additional information regarding copyright ownership.
  * The ASF licenses this file to You under the Apache License, Version 2.0
  * (the "License"); you may not use this file except in compliance with
  * the License.  You may obtain a copy of the License at
  *
  *     http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
  *
  * @category   tests
  * @package    log4php
  * @subpackage appenders
  * @license    http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
  * @link       http://logging.apache.org/log4php
  */

 /**
  * Testclass for the MongoDB appender.
  *
  * This class has been originally contributed from Vladimir Gorej
  * (http://github.com/log4mongo/log4mongo-php).
  *
  * @group appenders
  */
 class LoggerAppenderMongoDBTest extends PHPUnit_Framework_TestCase {

 	protected $appender;
 	protected $event;

 	protected function setUp() {
 		if (!extension_loaded('Mongo')) {
 			$this->markTestSkipped(
 				'The Mongo extension is not available.'
 			);
 		} else {
 			$this->appender = new LoggerAppenderMongoDB('mongo_appender');
 			$this->appender->setCollectionName('log4php_mongodb_test');
 			$this->event = LoggerTestHelper::getErrorEvent('mongo logging event', 'test_mongo');
 		}
 	}

 	protected function tearDown() {
 		if (extension_loaded('Mongo')) {
 			$collection = $this->appender->getCollection();
 			if ($collection !== null) {
 				$collection->drop();
 			}
 		}
 		unset($this->appender);
 		LoggerMDC::clear();
 	}

 	public function testConnectionString() {
 		$expected = 'mongodb://localhost,localhost';
 		$this->appender->setConnectionString($expected);
 		$result = $this->appender->getConnectionString();
 		$this->assertEquals($expected, $result);
 	}

 	public function testHost() {
 		$expected = 'mongodb://localhost';
 		$this->appender->setHost($expected);
 		$result = $this->appender->getHost();
 		$this->assertEquals($expected, $result);
 	}

 	public function testPort() {
 		$expected = 27017;
 		$this->appender->setPort($expected);
 		$result = $this->appender->getPort();
 		$this->assertEquals($expected, $result);
 	}

 	public function testDatabaseName() {
 		$expected = 'log4php_mongodb_test';
 		$this->appender->setDatabaseName($expected);
 		$result	= $this->appender->getDatabaseName();
 		$this->assertEquals($expected, $result);
 	}

 	public function testCollectionName() {
 		$expected = 'logs';
 		$this->appender->setCollectionName($expected);
 		$result = $this->appender->getCollectionName();
 		$this->assertEquals($expected, $result);
 	}

 	public function testUserName() {
 		$expected = 'char0n';
 		$this->appender->setUserName($expected);
 		$result = $this->appender->getUserName();
 		$this->assertEquals($expected, $result);
 	}

 	public function testPassword() {
 		$expected = 'secret pass';
 		$this->appender->setPassword($expected);
 		$result	= $this->appender->getPassword();
 		$this->assertEquals($expected, $result);
 	}

 	public function testTimeout() {
 		$expected = 4000;
 		$this->appender->setTimeout($expected);
 		$result	= $this->appender->getTimeout();
 		$this->assertEquals($expected, $result);
 	}

 	public function testCapped() {
 		$expected = true;
 		$this->appender->setCapped($expected);
 		$result	= $this->appender->getCapped();
 		$this->assertEquals($expected, $result);
 	}

 	public function testCappedMax() {
 		$expected = 20;
 		$this->appender->setCappedMax($expected);
 		$result	= $this->appender->getCappedMax();
 		$this->assertEquals($expected, $result);
 	}

 	public function testCappedSize() {
 		$expected = 10000;
 		$this->appender->setCappedSize($expected);
 		$result	= $this->appender->getCappedSize();
 		$this->assertEquals($expected, $result);
 	}

 	public function testWriteConcern() {
 		$expected = 7;
 		$this->appender->setWriteConcern($expected);
 		$result = $this->appender->getWriteConcern();
 		$this->assertEquals($expected, $result);
 	}

 	public function testWriteConcernJournaled() {
 		$expected = true;
 		$this->appender->setWriteConcernJournaled($expected);
 		$result = $this->appender->getWriteConcernJournaled();
 		$this->assertEquals($expected, $result);
 	}


 	public function testWriteConcernTimeout() {
 		$expected = 100;
 		$this->appender->setWriteConcernTimeout($expected);
 		$result = $this->appender->getWriteConcernTimeout();
 		$this->assertEquals($expected, $result);
 	}

 	public function testConnectionTimeout() {
 		$expected = 200;
 		$this->appender->setConnectionTimeout($expected);
 		$result = $this->appender->getConnectionTimeout();
 		$this->assertEquals($expected, $result);
 	}

 	public function testSocketTimeout() {
 		$expected = 300;
 		$this->appender->setSocketTimeout($expected);
 		$result = $this->appender->getSocketTimeout();
 		$this->assertEquals($expected, $result);
 	}

 	public function testReplicaSet() {
 		$expected = 'replica_set';
 		$this->appender->setReplicaSet($expected);
 		$result = $this->appender->getReplicaSet();
 		$this->assertEquals($expected, $result);
 	}

 	public function testActivateOptions() {
 		$this->appender->activateOptions();
 		$this->assertInstanceOf('MongoClient', $this->appender->getConnection());
 		$this->assertInstanceOf('MongoCollection', $this->appender->getCollection());
 	}

 	public function testActivateOptionsNoCredentials() {
 		$this->appender->setUserName(null);
 		$this->appender->setPassword(null);
 		$this->appender->activateOptions();
 		$this->assertInstanceOf('MongoClient', $this->appender->getConnection());
 		$this->assertInstanceOf('MongoCollection', $this->appender->getCollection());
 	}

 	public function testActivateOptionsCappedCollection() {
 		$this->appender->setCollectionName('logs_capped');
 		$this->appender->setCapped(true);
 		$this->appender->activateOptions();
 		$this->assertInstanceOf('MongoClient', $this->appender->getConnection());
 		$this->assertInstanceOf('MongoCollection', $this->appender->getCollection());
 	}

 	public function testFormat() {
 		$this->appender->activateOptions();
 		$record = $this->logOne($this->event);

 		$this->assertEquals('ERROR', $record['level']);
 		$this->assertEquals('mongo logging event', $record['message']);
 		$this->assertEquals('test_mongo', $record['loggerName']);

 		$this->assertEquals('NA', $record['fileName']);
 		$this->assertEquals('getLocationInformation', $record['method']);
 		$this->assertEquals('NA', $record['lineNumber']);
 		$this->assertEquals('LoggerLoggingEvent', $record['className']);

 		$this->assertTrue(is_int($record['thread']));
 		$this->assertSame(getmypid(), $record['thread']);
 		$this->assertTrue(is_int($record['lineNumber']) || $record['lineNumber'] == 'NA');
 		$this->assertEquals(10, count($record));
 	}

 	public function testFormatMDC() {
 		$this->appender->activateOptions();
 		LoggerMDC::put('extra_data', 'extra data');
 		$record = $this->logOne($this->event);
 		$this->assertEquals(1, count(LoggerMDC::getMap()));
 		$this->assertEquals(11, count($record));
 		$this->assertArrayHasKey('extra_data', $record);
 		$this->assertEquals('extra data', $record['extra_data']);
 	}

 	public function testFormatMDCOverride() {
 		$this->appender->activateOptions();
 		LoggerMDC::put('fileName', 'extra data');
 		$record = $this->logOne($this->event);
 		$this->assertEquals(1, count(LoggerMDC::getMap()));
 		$this->assertEquals(10, count($record));
 		$this->assertArrayHasKey('fileName', $record);
 		$this->assertEquals('NA', $record['fileName']);
 	}

 	public function testFormatThrowableInfo() {
 		$this->appender->activateOptions();
 		$event = new LoggerLoggingEvent(
 			'testFqcn',
 			new Logger('test.Logger'),
 			LoggerLevel::getLevelWarn(),
 			'test message',
 			microtime(true),
 			new Exception('test exception', 1)
 		);

 		$record = $this->logOne($event);

 		$this->assertArrayHasKey('exception', $record);
 		$this->assertEquals(1, $record['exception']['code']);
 		$this->assertEquals('test exception', $record['exception']['message']);
 		$this->assertContains('[internal function]: LoggerAppenderMongoDBTest', $record['exception']['stackTrace']);
 	}

 	public function testFormatThrowableInfoWithInnerException() {
 		// Skip test if PHP version is lower than 5.3.0 (no inner exception support)
 		if (version_compare(PHP_VERSION, '5.3.0') < 0) {
 			$this->markTestSkipped();
 		}

 		$this->appender->activateOptions();
 		$event = new LoggerLoggingEvent(
 			'testFqcn',
 			new Logger('test.Logger'),
 			LoggerLevel::getLevelWarn(),
 			'test message',
 			microtime(true),
 			new Exception('test exception', 1, new Exception('test exception inner', 2))
 		);

 		$record = $this->logOne($event);

 		$this->assertArrayHasKey('exception', $record);
 		$this->assertEquals(1, $record['exception']['code']);
 		$this->assertEquals('test exception', $record['exception']['message']);
 		$this->assertContains('[internal function]: LoggerAppenderMongoDBTest', $record['exception']['stackTrace']);

 		$this->assertArrayHasKey('innerException', $record['exception']);
 		$this->assertEquals(2, $record['exception']['innerException']['code']);
 		$this->assertEquals('test exception inner', $record['exception']['innerException']['message']);
 	}

 	public function testCappedCollection() {
 		$expected = 2;
 		$this->appender->setCollectionName('logs_capped');
 		$this->appender->setCapped(true);
 		$this->appender->setCappedMax($expected);
 		$this->appender->activateOptions();

 		// Log 10 events into capped collection.
 		for ($i = 0; $i < 10; $i += 1) {
 			$this->appender->append($this->event);
 		}

 		$this->assertEquals($expected, $this->appender->getCollection()->count());
 	}

 	/**
 	 * @expectedException PHPUnit_Framework_Error
 	 */
 	public function testReplicaSetOption() {
 		$this->appender->setReplicaSet('mongo_appender_replica_set1');
 		$this->appender->activateOptions();
 	}

 	public function testMultipleHostsConnection() {
 		$this->appender->setConnectionString('mongodb://locahost:27017,localhost:27017');
 		$this->appender->activateOptions();
 	}

 	public function testClose() {
 		$this->appender->activateOptions();
 		$this->assertInstanceOf('MongoClient', $this->appender->getConnection());
 		$this->assertInstanceOf('MongoCollection', $this->appender->getCollection());
 		$this->appender->close();
 		$this->assertNull($this->appender->getConnection());
 		$this->assertNull($this->appender->getCollection());
 	}

 	/**
 	 * Logs the event and returns the record from the database.
 	 * @param LoggerLoggingEvent $event
 	 * @return array
 	 */
 	private function logOne($event)
 	{
 		$collection = $this->appender->getCollection();
 		$collection->drop();
 		$this->appender->append($event);
 		$record = $collection->findOne();
 		$this->assertNotNull($record, 'Could not read the record from the database.');
 		return $record;
 	}
 }
	<?php
	/**
	* Licensed to the Apache Software Foundation (ASF) under one or more
	* contributor license agreements. See the NOTICE file distributed with
	* this work for additional information regarding copyright ownership.
	* The ASF licenses this file to You under the Apache License, Version 2.0
	* (the "License"); you may not use this file except in compliance with
	* the License. You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing, software
	* distributed under the License is distributed on an "AS IS" BASIS,
	* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
	* See the License for the specific language governing permissions and
	* limitations under the License.
	*
	* @category tests
	* @package log4php
	* @subpackage appenders
	* @license http://www.apache.org/licenses/LICENSE-2.0 Apache License, Version 2.0
	* @link http://logging.apache.org/log4php
	*/

	/**
	* Testclass for the MongoDB appender.
	*
	* This class has been originally contributed from Vladimir Gorej
	* (http://github.com/log4mongo/log4mongo-php).
	*
	* @group appenders
	*/
	class LoggerAppenderMongoDBTest extends PHPUnit_Framework_TestCase {

	protected $appender;
	protected $event;

	protected function setUp() {
	if (!extension_loaded('Mongo')) {
	$this->markTestSkipped(
	'The Mongo extension is not available.'
	);
	} else {
	$this->appender = new LoggerAppenderMongoDB('mongo_appender');
	$this->appender->setCollectionName('log4php_mongodb_test');
	$this->event = LoggerTestHelper::getErrorEvent('mongo logging event', 'test_mongo');
	}
	}

	protected function tearDown() {
	if (extension_loaded('Mongo')) {
	$collection = $this->appender->getCollection();
	if ($collection !== null) {
	$collection->drop();
	}
	}
	unset($this->appender);
	LoggerMDC::clear();
	}

	public function testConnectionString() {
	$expected = 'mongodb://localhost,localhost';
	$this->appender->setConnectionString($expected);
	$result = $this->appender->getConnectionString();
	$this->assertEquals($expected, $result);
	}

	public function testHost() {
	$expected = 'mongodb://localhost';
	$this->appender->setHost($expected);
	$result = $this->appender->getHost();
	$this->assertEquals($expected, $result);
	}

	public function testPort() {
	$expected = 27017;
	$this->appender->setPort($expected);
	$result = $this->appender->getPort();
	$this->assertEquals($expected, $result);
	}

	public function testDatabaseName() {
	$expected = 'log4php_mongodb_test';
	$this->appender->setDatabaseName($expected);
	$result = $this->appender->getDatabaseName();
	$this->assertEquals($expected, $result);
	}

	public function testCollectionName() {
	$expected = 'logs';
	$this->appender->setCollectionName($expected);
	$result = $this->appender->getCollectionName();
	$this->assertEquals($expected, $result);
	}

	public function testUserName() {
	$expected = 'char0n';
	$this->appender->setUserName($expected);
	$result = $this->appender->getUserName();
	$this->assertEquals($expected, $result);
	}

	public function testPassword() {
	$expected = 'secret pass';
	$this->appender->setPassword($expected);
	$result = $this->appender->getPassword();
	$this->assertEquals($expected, $result);
	}

	public function testTimeout() {
	$expected = 4000;
	$this->appender->setTimeout($expected);
	$result = $this->appender->getTimeout();
	$this->assertEquals($expected, $result);
	}

	public function testCapped() {
	$expected = true;
	$this->appender->setCapped($expected);
	$result = $this->appender->getCapped();
	$this->assertEquals($expected, $result);
	}

	public function testCappedMax() {
	$expected = 20;
	$this->appender->setCappedMax($expected);
	$result = $this->appender->getCappedMax();
	$this->assertEquals($expected, $result);
	}

	public function testCappedSize() {
	$expected = 10000;
	$this->appender->setCappedSize($expected);
	$result = $this->appender->getCappedSize();
	$this->assertEquals($expected, $result);
	}

	public function testWriteConcern() {
	$expected = 7;
	$this->appender->setWriteConcern($expected);
	$result = $this->appender->getWriteConcern();
	$this->assertEquals($expected, $result);
	}

	public function testWriteConcernJournaled() {
	$expected = true;
	$this->appender->setWriteConcernJournaled($expected);
	$result = $this->appender->getWriteConcernJournaled();
	$this->assertEquals($expected, $result);
	}


	public function testWriteConcernTimeout() {
	$expected = 100;
	$this->appender->setWriteConcernTimeout($expected);
	$result = $this->appender->getWriteConcernTimeout();
	$this->assertEquals($expected, $result);
	}

	public function testConnectionTimeout() {
	$expected = 200;
	$this->appender->setConnectionTimeout($expected);
	$result = $this->appender->getConnectionTimeout();
	$this->assertEquals($expected, $result);
	}

	public function testSocketTimeout() {
	$expected = 300;
	$this->appender->setSocketTimeout($expected);
	$result = $this->appender->getSocketTimeout();
	$this->assertEquals($expected, $result);
	}

	public function testReplicaSet() {
	$expected = 'replica_set';
	$this->appender->setReplicaSet($expected);
	$result = $this->appender->getReplicaSet();
	$this->assertEquals($expected, $result);
	}

	public function testActivateOptions() {
	$this->appender->activateOptions();
	$this->assertInstanceOf('MongoClient', $this->appender->getConnection());
	$this->assertInstanceOf('MongoCollection', $this->appender->getCollection());
	}

	public function testActivateOptionsNoCredentials() {
	$this->appender->setUserName(null);
	$this->appender->setPassword(null);
	$this->appender->activateOptions();
	$this->assertInstanceOf('MongoClient', $this->appender->getConnection());
	$this->assertInstanceOf('MongoCollection', $this->appender->getCollection());
	}

	public function testActivateOptionsCappedCollection() {
	$this->appender->setCollectionName('logs_capped');
	$this->appender->setCapped(true);
	$this->appender->activateOptions();
	$this->assertInstanceOf('MongoClient', $this->appender->getConnection());
	$this->assertInstanceOf('MongoCollection', $this->appender->getCollection());
	}

	public function testFormat() {
	$this->appender->activateOptions();
	$record = $this->logOne($this->event);

	$this->assertEquals('ERROR', $record['level']);
	$this->assertEquals('mongo logging event', $record['message']);
	$this->assertEquals('test_mongo', $record['loggerName']);

	$this->assertEquals('NA', $record['fileName']);
	$this->assertEquals('getLocationInformation', $record['method']);
	$this->assertEquals('NA', $record['lineNumber']);
	$this->assertEquals('LoggerLoggingEvent', $record['className']);

	$this->assertTrue(is_int($record['thread']));
	$this->assertSame(getmypid(), $record['thread']);
	$this->assertTrue(is_int($record['lineNumber']) \|\| $record['lineNumber'] == 'NA');
	$this->assertEquals(10, count($record));
	}

	public function testFormatMDC() {
	$this->appender->activateOptions();
	LoggerMDC::put('extra_data', 'extra data');
	$record = $this->logOne($this->event);
	$this->assertEquals(1, count(LoggerMDC::getMap()));
	$this->assertEquals(11, count($record));
	$this->assertArrayHasKey('extra_data', $record);
	$this->assertEquals('extra data', $record['extra_data']);
	}

	public function testFormatMDCOverride() {
	$this->appender->activateOptions();
	LoggerMDC::put('fileName', 'extra data');
	$record = $this->logOne($this->event);
	$this->assertEquals(1, count(LoggerMDC::getMap()));
	$this->assertEquals(10, count($record));
	$this->assertArrayHasKey('fileName', $record);
	$this->assertEquals('NA', $record['fileName']);
	}

	public function testFormatThrowableInfo() {
	$this->appender->activateOptions();
	$event = new LoggerLoggingEvent(
	'testFqcn',
	new Logger('test.Logger'),
	LoggerLevel::getLevelWarn(),
	'test message',
	microtime(true),
	new Exception('test exception', 1)
	);

	$record = $this->logOne($event);

	$this->assertArrayHasKey('exception', $record);
	$this->assertEquals(1, $record['exception']['code']);
	$this->assertEquals('test exception', $record['exception']['message']);
	$this->assertContains('[internal function]: LoggerAppenderMongoDBTest', $record['exception']['stackTrace']);
	}

	public function testFormatThrowableInfoWithInnerException() {
	// Skip test if PHP version is lower than 5.3.0 (no inner exception support)
	if (version_compare(PHP_VERSION, '5.3.0') < 0) {
	$this->markTestSkipped();
	}

	$this->appender->activateOptions();
	$event = new LoggerLoggingEvent(
	'testFqcn',
	new Logger('test.Logger'),
	LoggerLevel::getLevelWarn(),
	'test message',
	microtime(true),
	new Exception('test exception', 1, new Exception('test exception inner', 2))
	);

	$record = $this->logOne($event);

	$this->assertArrayHasKey('exception', $record);
	$this->assertEquals(1, $record['exception']['code']);
	$this->assertEquals('test exception', $record['exception']['message']);
	$this->assertContains('[internal function]: LoggerAppenderMongoDBTest', $record['exception']['stackTrace']);

	$this->assertArrayHasKey('innerException', $record['exception']);
	$this->assertEquals(2, $record['exception']['innerException']['code']);
	$this->assertEquals('test exception inner', $record['exception']['innerException']['message']);
	}

	public function testCappedCollection() {
	$expected = 2;
	$this->appender->setCollectionName('logs_capped');
	$this->appender->setCapped(true);
	$this->appender->setCappedMax($expected);
	$this->appender->activateOptions();

	// Log 10 events into capped collection.
	for ($i = 0; $i < 10; $i += 1) {
	$this->appender->append($this->event);
	}

	$this->assertEquals($expected, $this->appender->getCollection()->count());
	}

	/**
	* @expectedException PHPUnit_Framework_Error
	*/
	public function testReplicaSetOption() {
	$this->appender->setReplicaSet('mongo_appender_replica_set1');
	$this->appender->activateOptions();
	}

	public function testMultipleHostsConnection() {
	$this->appender->setConnectionString('mongodb://locahost:27017,localhost:27017');
	$this->appender->activateOptions();
	}

	public function testClose() {
	$this->appender->activateOptions();
	$this->assertInstanceOf('MongoClient', $this->appender->getConnection());
	$this->assertInstanceOf('MongoCollection', $this->appender->getCollection());
	$this->appender->close();
	$this->assertNull($this->appender->getConnection());
	$this->assertNull($this->appender->getCollection());
	}

	/**
	* Logs the event and returns the record from the database.
	* @param LoggerLoggingEvent $event
	* @return array
	*/
	private function logOne($event)
	{
	$collection = $this->appender->getCollection();
	$collection->drop();
	$this->appender->append($event);
	$record = $collection->findOne();
	$this->assertNotNull($record, 'Could not read the record from the database.');
	return $record;
	}
	}