improved LDAP logging (#5517)

This commit is contained in:
Kevin Papst
2025-06-07 11:48:09 +02:00
committed by GitHub
parent c8b4e4eabb
commit 46129c7ab9
3 changed files with 76 additions and 38 deletions

View File

@@ -12,10 +12,13 @@ namespace App\Tests\Ldap;
use App\Configuration\LdapConfiguration;
use App\Entity\User;
use App\Ldap\LdapDriver;
use App\Ldap\LdapDriverException;
use App\Tests\Mocks\SystemConfigurationFactory;
use App\Tests\Mocks\TestLogger;
use Laminas\Ldap\Exception\LdapException;
use Laminas\Ldap\Ldap;
use PHPUnit\Framework\TestCase;
use Psr\Log\LogLevel;
/**
* @covers \App\Ldap\LdapDriver
@@ -25,7 +28,7 @@ class LdapDriverTest extends TestCase
protected function setUp(): void
{
parent::setUp();
if (!class_exists('Laminas\Ldap\Ldap')) {
if (!class_exists(Ldap::class)) {
$this->markTestSkipped('LDAP is not installed');
}
}
@@ -63,6 +66,11 @@ class LdapDriverTest extends TestCase
$sut = $this->getTestLdapDriver($zendLdap);
$result = $sut->bind($user->getUserIdentifier(), 'test123');
self::assertFalse($result);
$logs = $sut->getLogger()->cleanLogs();
self::assertCount(2, $logs);
self::assertEquals(LogLevel::ERROR, $logs[1][0]);
self::assertStringStartsWith('Failed binding to LDAP at', $logs[1][1]);
}
public function testSearchSuccess(): void
@@ -75,15 +83,36 @@ class LdapDriverTest extends TestCase
$result = $sut->search('', '', []);
self::assertEquals(['count' => 3, 1, 2, 3], $result);
}
public function testSearchFailure(): void
{
$this->expectException(LdapDriverException::class);
$zendLdap = $this->getMockBuilder(Ldap::class)->disableOriginalConstructor()->onlyMethods(['bind', 'searchEntries'])->getMock();
$zendLdap->expects($this->once())->method('bind');
$zendLdap->expects($this->once())->method('searchEntries')->willThrowException(new LdapException());
$sut = $this->getTestLdapDriver($zendLdap);
$result = $sut->search('', '', []);
self::assertEquals(['count' => 3, 1, 2, 3], $result);
$logs = $sut->getLogger()->cleanLogs();
self::assertCount(2, $logs);
self::assertEquals(LogLevel::DEBUG, $logs[0][0]);
self::assertStringStartsWith('Failed to search LDAP', $logs[1][1]);
self::assertEquals(LogLevel::ERROR, $logs[1][0]);
self::assertStringStartsWith('An error occurred with the search operation', $logs[1][1]);
}
}
class TestLdapDriver extends LdapDriver
{
private Ldap $testDriver;
public TestLogger $logger;
public function __construct(LdapConfiguration $config, Ldap $ldap)
{
parent::__construct($config);
$this->logger = new TestLogger();
parent::__construct($config, $this->logger);
$this->testDriver = $ldap;
}
@@ -91,4 +120,9 @@ class TestLdapDriver extends LdapDriver
{
return $this->testDriver;
}
public function getLogger(): TestLogger
{
return $this->logger;
}
}