class LoggerChannelTest in Drupal 9

@coversDefaultClass \Drupal\Core\Logger\LoggerChannel @group Logger

Hierarchy

• class \Drupal\Tests\UnitTestCase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, PhpUnitCompatibilityTrait, PhpUnitWarnings
  • class \Drupal\Tests\Core\Logger\LoggerChannelTest

File

core/tests/Drupal/Tests/Core/Logger/LoggerChannelTest.php, line 22

Contains \Drupal\Tests\Core\Logger\LoggerChannelTest.

Namespace

Drupal\Tests\Core\Logger

class LoggerChannelTest extends UnitTestCase {

  /**
   * Tests LoggerChannel::log().
   *
   * @param callable $expected
   *   An anonymous function to use with $this->callback() of the logger mock.
   *   The function should check the $context array for expected values.
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   Will be passed to the channel under test if present.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   Will be passed to the channel under test if present.
   *
   * @dataProvider providerTestLog
   * @covers ::log
   * @covers ::setCurrentUser
   * @covers ::setRequestStack
   */
  public function testLog(callable $expected, Request $request = NULL, AccountInterface $current_user = NULL) {
    $channel = new LoggerChannel('test');
    $message = $this
      ->randomMachineName();
    $logger = $this
      ->createMock('Psr\\Log\\LoggerInterface');
    $logger
      ->expects($this
      ->once())
      ->method('log')
      ->with($this
      ->anything(), $message, $this
      ->callback($expected));
    $channel
      ->addLogger($logger);
    if ($request) {
      $requestStack = new RequestStack();
      $requestStack
        ->push($request);
      $channel
        ->setRequestStack($requestStack);
    }
    if ($current_user) {
      $channel
        ->setCurrentUser($current_user);
    }
    $channel
      ->log(rand(0, 7), $message);
  }

  /**
   * Tests LoggerChannel::log() recursion protection.
   *
   * @covers ::log
   */
  public function testLogRecursionProtection() {
    $channel = new LoggerChannel('test');
    $logger = $this
      ->createMock('Psr\\Log\\LoggerInterface');
    $logger
      ->expects($this
      ->exactly(LoggerChannel::MAX_CALL_DEPTH))
      ->method('log');
    $channel
      ->addLogger($logger);
    $channel
      ->addLogger(new NaughtyRecursiveLogger($channel));
    $channel
      ->log(rand(0, 7), $this
      ->randomMachineName());
  }

  /**
   * Tests LoggerChannel::addLoggers().
   *
   * @covers ::addLogger
   * @covers ::sortLoggers
   */
  public function testSortLoggers() {
    $channel = new LoggerChannel($this
      ->randomMachineName());
    $index_order = '';
    for ($i = 0; $i < 4; $i++) {
      $logger = $this
        ->createMock('Psr\\Log\\LoggerInterface');
      $logger
        ->expects($this
        ->once())
        ->method('log')
        ->willReturnCallback(function () use ($i, &$index_order) {

        // Append the $i to the index order, so that we know the order that
        // loggers got called with.
        $index_order .= $i;
      });
      $channel
        ->addLogger($logger, $i);
    }
    $channel
      ->log(rand(0, 7), $this
      ->randomMachineName());

    // Ensure that the logger added in the end fired first.
    $this
      ->assertEquals('3210', $index_order);
  }

  /**
   * Data provider for self::testLog().
   */
  public function providerTestLog() {
    $account_mock = $this
      ->createMock('Drupal\\Core\\Session\\AccountInterface');
    $account_mock
      ->expects($this
      ->any())
      ->method('id')
      ->will($this
      ->returnValue(1));
    $request_mock = $this
      ->getMockBuilder('Symfony\\Component\\HttpFoundation\\Request')
      ->setMethods([
      'getClientIp',
    ])
      ->getMock();
    $request_mock
      ->expects($this
      ->any())
      ->method('getClientIp')
      ->will($this
      ->returnValue('127.0.0.1'));
    $request_mock->headers = $this
      ->createMock('Symfony\\Component\\HttpFoundation\\ParameterBag');

    // No request or account.
    $cases[] = [
      function ($context) {
        return $context['channel'] == 'test' && empty($context['uid']) && empty($context['ip']);
      },
    ];

    // With account but not request. Since the request is not available the
    // current user should not be used.
    $cases[] = [
      function ($context) {
        return $context['uid'] === 0 && empty($context['ip']);
      },
      NULL,
      $account_mock,
    ];

    // With request but not account.
    $cases[] = [
      function ($context) {
        return $context['ip'] === '127.0.0.1' && empty($context['uid']);
      },
      $request_mock,
    ];

    // Both request and account.
    $cases[] = [
      function ($context) {
        return $context['ip'] === '127.0.0.1' && $context['uid'] === 1;
      },
      $request_mock,
      $account_mock,
    ];
    return $cases;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
LoggerChannelTest::providerTestLog	public	function	Data provider for self::testLog().
LoggerChannelTest::testLog	public	function	Tests LoggerChannel::log().
LoggerChannelTest::testLogRecursionProtection	public	function	Tests LoggerChannel::log() recursion protection.
LoggerChannelTest::testSortLoggers	public	function	Tests LoggerChannel::addLoggers().
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
UnitTestCase::$randomGenerator	protected	property	The random generator.
UnitTestCase::$root	protected	property	The app root.	1
UnitTestCase::assertArrayEquals Deprecated	protected	function	Asserts if two arrays are equal by sorting them first.
UnitTestCase::getClassResolverStub	protected	function	Returns a stub class resolver.
UnitTestCase::getConfigFactoryStub	public	function	Returns a stub config factory that behaves according to the passed array.
UnitTestCase::getConfigStorageStub	public	function	Returns a stub config storage that returns the supplied configuration.
UnitTestCase::getContainerWithCacheTagsInvalidator	protected	function	Sets up a container with a cache tags invalidator.
UnitTestCase::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
UnitTestCase::getStringTranslationStub	public	function	Returns a stub translation manager that just returns the passed string.
UnitTestCase::randomMachineName	public	function	Generates a unique random string containing letters and numbers.
UnitTestCase::setUp	protected	function		308
UnitTestCase::setUpBeforeClass	public static	function