Skip to content

Refactor: assertions #45

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
lohanidamodar wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Refactor: assertions #45

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
69adf79
Refactor: assertions
lohanidamodar Nov 26, 2025
c9bfff2
Fix codeQL
lohanidamodar Nov 26, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion tests/e2e/AdapterBase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ public function testAdapter(): void
}
$logger = new Logger($this->adapter);
$response = $logger->addLog($this->log);
$this->assertEquals($this->expected, $response);
$this->assertSame($this->expected, $response);
}

/**
Expand Down
16 changes: 8 additions & 8 deletions tests/unit/Log/BreadcrumbTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,19 @@ public function testLogBreadcrumb(): void
$timestamp = \microtime(true);
$breadcrumb = new Breadcrumb(Log::TYPE_DEBUG, 'http', 'POST /user', $timestamp);

self::assertEquals(Log::TYPE_DEBUG, $breadcrumb->getType());
self::assertEquals('http', $breadcrumb->getCategory());
self::assertEquals('POST /user', $breadcrumb->getMessage());
self::assertEquals($timestamp, $breadcrumb->getTimestamp());
self::assertSame(Log::TYPE_DEBUG, $breadcrumb->getType());
self::assertSame('http', $breadcrumb->getCategory());
self::assertSame('POST /user', $breadcrumb->getMessage());
self::assertSame($timestamp, $breadcrumb->getTimestamp());

$breadcrumb = new Breadcrumb(Log::TYPE_INFO, 'http', 'POST /user', $timestamp);
self::assertEquals(Log::TYPE_INFO, $breadcrumb->getType());
self::assertSame(Log::TYPE_INFO, $breadcrumb->getType());
$breadcrumb = new Breadcrumb(Log::TYPE_VERBOSE, 'http', 'POST /user', $timestamp);
self::assertEquals(Log::TYPE_VERBOSE, $breadcrumb->getType());
self::assertSame(Log::TYPE_VERBOSE, $breadcrumb->getType());
$breadcrumb = new Breadcrumb(Log::TYPE_ERROR, 'http', 'POST /user', $timestamp);
self::assertEquals(Log::TYPE_ERROR, $breadcrumb->getType());
self::assertSame(Log::TYPE_ERROR, $breadcrumb->getType());
$breadcrumb = new Breadcrumb(Log::TYPE_WARNING, 'http', 'POST /user', $timestamp);
self::assertEquals(Log::TYPE_WARNING, $breadcrumb->getType());
self::assertSame(Log::TYPE_WARNING, $breadcrumb->getType());

// Assert FAILS
self::expectException(\ArgumentCountError::class);
Expand Down
12 changes: 6 additions & 6 deletions tests/unit/Log/UserTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,17 +11,17 @@ public function testLogUser(): void
{
$user = new User();

self::assertEquals(null, $user->getEmail());
self::assertEquals(null, $user->getUsername());
self::assertEquals(null, $user->getId());
self::assertSame(null, $user->getEmail());
self::assertSame(null, $user->getUsername());
self::assertSame(null, $user->getId());

$user = new User('618e291cd8949');
self::assertEquals('618e291cd8949', $user->getId());
self::assertSame('618e291cd8949', $user->getId());

$user = new User(null, '[email protected]');
self::assertEquals('[email protected]', $user->getEmail());
self::assertSame('[email protected]', $user->getEmail());

$user = new User(null, null, 'Meldiron');
self::assertEquals('Meldiron', $user->getUsername());
self::assertSame('Meldiron', $user->getUsername());
}
}
58 changes: 29 additions & 29 deletions tests/unit/LogTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,59 +18,59 @@ public function testLog(): void

$timestamp = \microtime(true);
$log->setTimestamp($timestamp);
self::assertEquals($timestamp, $log->getTimestamp());
self::assertSame($timestamp, $log->getTimestamp());

$log->setType(Log::TYPE_ERROR);
self::assertEquals(Log::TYPE_ERROR, $log->getType());
self::assertSame(Log::TYPE_ERROR, $log->getType());
$log->setType(Log::TYPE_DEBUG);
self::assertEquals(Log::TYPE_DEBUG, $log->getType());
self::assertSame(Log::TYPE_DEBUG, $log->getType());
$log->setType(Log::TYPE_WARNING);
self::assertEquals(Log::TYPE_WARNING, $log->getType());
self::assertSame(Log::TYPE_WARNING, $log->getType());
$log->setType(Log::TYPE_VERBOSE);
self::assertEquals(Log::TYPE_VERBOSE, $log->getType());
self::assertSame(Log::TYPE_VERBOSE, $log->getType());
$log->setType(Log::TYPE_INFO);
self::assertEquals(Log::TYPE_INFO, $log->getType());
self::assertSame(Log::TYPE_INFO, $log->getType());

$log->setMessage("Cannot read 'user' of undefined");
self::assertEquals("Cannot read 'user' of undefined", $log->getMessage());
self::assertSame("Cannot read 'user' of undefined", $log->getMessage());

$log->setVersion('0.11.0');
self::assertEquals('0.11.0', $log->getVersion());
self::assertSame('0.11.0', $log->getVersion());

$log->setEnvironment(Log::ENVIRONMENT_PRODUCTION);
self::assertEquals(Log::ENVIRONMENT_PRODUCTION, $log->getEnvironment());
self::assertSame(Log::ENVIRONMENT_PRODUCTION, $log->getEnvironment());
$log->setEnvironment(Log::ENVIRONMENT_STAGING);
self::assertEquals(Log::ENVIRONMENT_STAGING, $log->getEnvironment());
self::assertSame(Log::ENVIRONMENT_STAGING, $log->getEnvironment());

$log->setNamespace('getAuthUser');
self::assertEquals('getAuthUser', $log->getNamespace());
self::assertSame('getAuthUser', $log->getNamespace());

$log->setAction('authGuard');
self::assertEquals('authGuard', $log->getAction());
self::assertSame('authGuard', $log->getAction());

$log->setServer('aws-001');
self::assertEquals('aws-001', $log->getServer());
self::assertSame('aws-001', $log->getServer());

$log->addExtra('isLoggedIn', false);
self::assertEquals(['isLoggedIn' => false], $log->getExtra());
self::assertSame(['isLoggedIn' => false], $log->getExtra());

$log->addTag('authMethod', 'session');
$log->addTag('authProvider', 'basic');
self::assertEquals(['authMethod' => 'session', 'authProvider' => 'basic'], $log->getTags());
self::assertSame(['authMethod' => 'session', 'authProvider' => 'basic'], $log->getTags());

$userId = 'myid123';
$user = new User($userId);
$log->setUser($user);
self::assertEquals($user, $log->getUser());
self::assertEquals($userId, $log->getUser()?->getId());
self::assertSame($user, $log->getUser());
self::assertSame($userId, $log->getUser()->getId());

$breadcrumb = new Breadcrumb(Log::TYPE_DEBUG, 'http', 'DELETE /api/v1/database/abcd1234/efgh5678', $timestamp);
$log->addBreadcrumb($breadcrumb);
self::assertEquals([$breadcrumb], $log->getBreadcrumbs());
self::assertEquals(Log::TYPE_DEBUG, $log->getBreadcrumbs()[0]->getType());
self::assertEquals('http', $log->getBreadcrumbs()[0]->getCategory());
self::assertEquals('DELETE /api/v1/database/abcd1234/efgh5678', $log->getBreadcrumbs()[0]->getMessage());
self::assertEquals($timestamp, $log->getBreadcrumbs()[0]->getTimestamp());
self::assertSame([$breadcrumb], $log->getBreadcrumbs());
self::assertSame(Log::TYPE_DEBUG, $log->getBreadcrumbs()[0]->getType());
self::assertSame('http', $log->getBreadcrumbs()[0]->getCategory());
self::assertSame('DELETE /api/v1/database/abcd1234/efgh5678', $log->getBreadcrumbs()[0]->getMessage());
self::assertSame($timestamp, $log->getBreadcrumbs()[0]->getTimestamp());
}

public function testLogMasked(): void
Expand All @@ -80,23 +80,23 @@ public function testLogMasked(): void
$log->addTag('password', '123456');
$log->addExtra('name', 'John Doe');

self::assertEquals(['password' => '123456'], $log->getTags());
self::assertEquals(['name' => 'John Doe'], $log->getExtra());
self::assertSame(['password' => '123456'], $log->getTags());
self::assertSame(['name' => 'John Doe'], $log->getExtra());

$log->setMasked(['password', 'name']);

self::assertEquals(['password' => '******'], $log->getTags());
self::assertEquals(['name' => '********'], $log->getExtra());
self::assertSame(['password' => '******'], $log->getTags());
self::assertSame(['name' => '********'], $log->getExtra());

// test nested array
$log->addExtra('user', ['password' => 'abc']);

self::assertEquals(['password' => '***'], $log->getExtra()['user']);
self::assertSame(['password' => '***'], $log->getExtra()['user']);

// test remove mask
$log->setMasked([]);

self::assertEquals(['password' => '123456'], $log->getTags());
self::assertEquals(['name' => 'John Doe', 'user' => ['password' => 'abc']], $log->getExtra());
self::assertSame(['password' => '123456'], $log->getTags());
self::assertSame(['name' => 'John Doe', 'user' => ['password' => 'abc']], $log->getExtra());
}
}
Loading