Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
<?php

namespace App\Audit\ConcreteFormatters;

/**
* Copyright 2026 OpenStack Foundation
* Licensed 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.
**/

use App\Audit\AbstractAuditLogFormatter;
use App\Audit\Interfaces\IAuditStrategy;
use App\Models\Foundation\ExtraQuestions\ExtraQuestionTypeValue;
use Illuminate\Support\Facades\Log;

class ExtraQuestionTypeValueAuditLogFormatter extends AbstractAuditLogFormatter
{
public function format($subject, array $change_set): ?string
{
if (!$subject instanceof ExtraQuestionTypeValue) {
return null;
}

try {
$id = $subject->getId() ?? 'unknown';
$label = $subject->getLabel() ?? 'Unknown Value';
$question = $subject->getQuestion();
$question_label = $question ? ($question->getLabel() ?? 'Unknown Question') : 'Unknown Question';

switch ($this->event_type) {
case IAuditStrategy::EVENT_ENTITY_CREATION:
return sprintf("Extra Question Value '%s' (%s) for Question '%s' created by user %s", $label, $id, $question_label, $this->getUserInfo());
case IAuditStrategy::EVENT_ENTITY_UPDATE:
$details = $this->buildChangeDetails($change_set);
return sprintf("Extra Question Value '%s' (%s) for Question '%s' updated: %s by user %s", $label, $id, $question_label, $details, $this->getUserInfo());
case IAuditStrategy::EVENT_ENTITY_DELETION:
return sprintf("Extra Question Value '%s' (%s) for Question '%s' deleted by user %s", $label, $id, $question_label, $this->getUserInfo());
}
} catch (\Exception $ex) {
Log::warning("ExtraQuestionTypeValueAuditLogFormatter error: " . $ex->getMessage());
}

return null;
}
}
55 changes: 55 additions & 0 deletions app/Audit/ConcreteFormatters/SummitOrderAuditLogFormatter.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<?php

namespace App\Audit\ConcreteFormatters;

/**
* Copyright 2026 OpenStack Foundation
* Licensed 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.
**/

use App\Audit\AbstractAuditLogFormatter;
use App\Audit\Interfaces\IAuditStrategy;
use models\summit\SummitOrder;
use Illuminate\Support\Facades\Log;

class SummitOrderAuditLogFormatter extends AbstractAuditLogFormatter
{
public function format($subject, array $change_set): ?string
{
if (!$subject instanceof SummitOrder) {
return null;
}

try {
$id = $subject->getId() ?? 'unknown';
$order_number = $subject->getNumber() ?? 'Unknown Order';
$status = $subject->getStatus() ?? 'Unknown';
$summit = $subject->getSummit();
$summit_name = $summit ? ($summit->getName() ?? 'Unknown Summit') : 'Unknown Summit';
$owner = $subject->getOwner();
$owner_email = $owner ? ($owner->getEmail() ?? 'Unknown Owner') : 'No Owner';

switch ($this->event_type) {
case IAuditStrategy::EVENT_ENTITY_CREATION:
return sprintf("Order '%s' (%s) created for '%s' in Summit '%s' with status '%s' by user %s", $order_number, $id, $owner_email, $summit_name, $status, $this->getUserInfo());
case IAuditStrategy::EVENT_ENTITY_UPDATE:
$details = $this->buildChangeDetails($change_set);
return sprintf("Order '%s' (%s) in Summit '%s' updated: %s by user %s", $order_number, $id, $summit_name, $details, $this->getUserInfo());
case IAuditStrategy::EVENT_ENTITY_DELETION:
return sprintf("Order '%s' (%s) in Summit '%s' deleted by user %s", $order_number, $id, $summit_name, $this->getUserInfo());
}
} catch (\Exception $ex) {
Log::warning("SummitOrderAuditLogFormatter error: " . $ex->getMessage());
}

return null;
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
<?php

namespace App\Audit\ConcreteFormatters;

/**
* Copyright 2026 OpenStack Foundation
* Licensed 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.
**/

use App\Audit\AbstractAuditLogFormatter;
use App\Audit\Interfaces\IAuditStrategy;
use models\summit\SummitOrderExtraQuestionType;
use Illuminate\Support\Facades\Log;

class SummitOrderExtraQuestionTypeAuditLogFormatter extends AbstractAuditLogFormatter
{
public function format($subject, array $change_set): ?string
{
if (!$subject instanceof SummitOrderExtraQuestionType) {
return null;
}

try {
$id = $subject->getId() ?? 'unknown';
$label = $subject->getLabel() ?? 'Unknown Question';
$question_type = $subject->getType() ?? 'Unknown Type';
$summit = $subject->getSummit();
$summit_name = $summit ? ($summit->getName() ?? 'Unknown Summit') : 'Unknown Summit';

switch ($this->event_type) {
case IAuditStrategy::EVENT_ENTITY_CREATION:
return sprintf("Order Extra Question '%s' (%s) of type '%s' created in Summit '%s' by user %s", $label, $id, $question_type, $summit_name, $this->getUserInfo());
case IAuditStrategy::EVENT_ENTITY_UPDATE:
$details = $this->buildChangeDetails($change_set);
return sprintf("Order Extra Question '%s' (%s) in Summit '%s' updated: %s by user %s", $label, $id, $summit_name, $details, $this->getUserInfo());
case IAuditStrategy::EVENT_ENTITY_DELETION:
return sprintf("Order Extra Question '%s' (%s) in Summit '%s' deleted by user %s", $label, $id, $summit_name, $this->getUserInfo());
}
} catch (\Exception $ex) {
Log::warning("SummitOrderExtraQuestionTypeAuditLogFormatter error: " . $ex->getMessage());
}

return null;
}
}
12 changes: 12 additions & 0 deletions config/audit_log.php
Original file line number Diff line number Diff line change
Expand Up @@ -228,5 +228,17 @@
'enabled' => true,
'strategy' => \App\Audit\ConcreteFormatters\PresentationAttendeeVoteAuditLogFormatter::class,
],
\models\summit\SummitOrder::class => [
'enabled' => true,
'strategy' => \App\Audit\ConcreteFormatters\SummitOrderAuditLogFormatter::class,
],
\models\summit\SummitOrderExtraQuestionType::class => [
'enabled' => true,
'strategy' => \App\Audit\ConcreteFormatters\SummitOrderExtraQuestionTypeAuditLogFormatter::class,
],
\App\Models\Foundation\ExtraQuestions\ExtraQuestionTypeValue::class => [
'enabled' => true,
'strategy' => \App\Audit\ConcreteFormatters\ExtraQuestionTypeValueAuditLogFormatter::class,
],
]
];
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
<?php

namespace Tests\OpenTelemetry\Formatters;

use App\Audit\ConcreteFormatters\ExtraQuestionTypeValueAuditLogFormatter;
use App\Audit\Interfaces\IAuditStrategy;
use Tests\OpenTelemetry\Formatters\Support\AuditContextBuilder;
use Mockery;
use Tests\TestCase;

class ExtraQuestionTypeValueAuditLogFormatterTest extends TestCase
{
private const VALUE_ID = 333;
private const VALUE_LABEL = 'Option A';
private const VALUE_VALUE = 'OPTION_A';
private const QUESTION_LABEL = 'Choose an Option';
private const CHANGED_LABEL = 'Option B';

private mixed $mockSubject;

protected function setUp(): void
{
parent::setUp();
$this->mockSubject = $this->createMockSubject();
}

protected function tearDown(): void
{
Mockery::close();
parent::tearDown();
}

private function createMockSubject(): mixed
{
$mockQuestion = Mockery::mock('App\Models\Foundation\ExtraQuestions\ExtraQuestionType');
$mockQuestion->shouldReceive('getLabel')->andReturn(self::QUESTION_LABEL);

$mock = Mockery::mock('App\Models\Foundation\ExtraQuestions\ExtraQuestionTypeValue');
$mock->shouldReceive('getId')->andReturn(self::VALUE_ID);
$mock->shouldReceive('getLabel')->andReturn(self::VALUE_LABEL);
$mock->shouldReceive('getValue')->andReturn(self::VALUE_VALUE);
$mock->shouldReceive('getQuestion')->andReturn($mockQuestion);

return $mock;
}

public function testSubjectCreationAuditMessage(): void
{
$formatter = new ExtraQuestionTypeValueAuditLogFormatter(IAuditStrategy::EVENT_ENTITY_CREATION);
$formatter->setContext(AuditContextBuilder::default()->build());
$result = $formatter->format($this->mockSubject, []);

$this->assertNotNull($result);
$this->assertStringContainsString('created', $result);
$this->assertStringContainsString(self::VALUE_LABEL, $result);
$this->assertStringContainsString((string)self::VALUE_ID, $result);
}

public function testSubjectUpdateAuditMessage(): void
{
$formatter = new ExtraQuestionTypeValueAuditLogFormatter(IAuditStrategy::EVENT_ENTITY_UPDATE);
$formatter->setContext(AuditContextBuilder::default()->build());
$changeSet = ['label' => [self::VALUE_LABEL, self::CHANGED_LABEL]];

$result = $formatter->format($this->mockSubject, $changeSet);

$this->assertNotNull($result);
$this->assertStringContainsString('updated', $result);
}

public function testSubjectDeletionAuditMessage(): void
{
$formatter = new ExtraQuestionTypeValueAuditLogFormatter(IAuditStrategy::EVENT_ENTITY_DELETION);
$formatter->setContext(AuditContextBuilder::default()->build());
$result = $formatter->format($this->mockSubject, []);

$this->assertNotNull($result);
$this->assertStringContainsString('deleted', $result);
}

public function testFormatterReturnsNullForInvalidSubject(): void
{
$formatter = new ExtraQuestionTypeValueAuditLogFormatter(IAuditStrategy::EVENT_ENTITY_CREATION);
$formatter->setContext(AuditContextBuilder::default()->build());
$result = $formatter->format(new \stdClass(), []);

$this->assertNull($result);
}

public function testFormatterHandlesEmptyChangeSet(): void
{
$formatter = new ExtraQuestionTypeValueAuditLogFormatter(IAuditStrategy::EVENT_ENTITY_UPDATE);
$formatter->setContext(AuditContextBuilder::default()->build());
$result = $formatter->format($this->mockSubject, []);

$this->assertNotNull($result);
$this->assertStringContainsString('updated', $result);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
<?php

namespace Tests\OpenTelemetry\Formatters;

use App\Audit\ConcreteFormatters\SummitAttendeeBadgeAuditLogFormatter;
use App\Audit\Interfaces\IAuditStrategy;
use Tests\OpenTelemetry\Formatters\Support\AuditContextBuilder;
use Mockery;
use Tests\TestCase;

class SummitAttendeeBadgeAuditLogFormatterTest extends TestCase
{
private const BADGE_ID = 111;
private const TICKET_ID = 789;
private const TICKET_NUMBER = 'TICKET-2024-001';
private const SUMMIT_NAME = 'OpenStack Summit 2024';

private mixed $mockSubject;

protected function setUp(): void
{
parent::setUp();
$this->mockSubject = $this->createMockSubject();
}

protected function tearDown(): void
{
Mockery::close();
parent::tearDown();
}

private function createMockSubject(): mixed
{
$mockSummit = Mockery::mock('models\summit\Summit');
$mockSummit->shouldReceive('getName')->andReturn(self::SUMMIT_NAME);

$mockOrder = Mockery::mock('models\summit\SummitOrder');
$mockOrder->shouldReceive('getSummit')->andReturn($mockSummit);

$mockTicket = Mockery::mock('models\summit\SummitAttendeeTicket');
$mockTicket->shouldReceive('getId')->andReturn(self::TICKET_ID);
$mockTicket->shouldReceive('getNumber')->andReturn(self::TICKET_NUMBER);
$mockTicket->shouldReceive('getOrder')->andReturn($mockOrder);

$mock = Mockery::mock('models\summit\SummitAttendeeBadge');
$mock->shouldReceive('getId')->andReturn(self::BADGE_ID);
$mock->shouldReceive('isVoid')->andReturn(false);
$mock->shouldReceive('getTicket')->andReturn($mockTicket);

return $mock;
}

public function testSubjectCreationAuditMessage(): void
{
$formatter = new SummitAttendeeBadgeAuditLogFormatter(IAuditStrategy::EVENT_ENTITY_CREATION);
$formatter->setContext(AuditContextBuilder::default()->build());
$result = $formatter->format($this->mockSubject, []);

$this->assertNotNull($result);
$this->assertStringContainsString('created', $result);
$this->assertStringContainsString(self::TICKET_NUMBER, $result);
$this->assertStringContainsString((string)self::TICKET_ID, $result);
}

public function testSubjectUpdateAuditMessage(): void
{
$formatter = new SummitAttendeeBadgeAuditLogFormatter(IAuditStrategy::EVENT_ENTITY_UPDATE);
$formatter->setContext(AuditContextBuilder::default()->build());
$changeSet = ['is_void' => [false, true]];

$result = $formatter->format($this->mockSubject, $changeSet);

$this->assertNotNull($result);
$this->assertStringContainsString('updated', $result);
}

public function testSubjectDeletionAuditMessage(): void
{
$formatter = new SummitAttendeeBadgeAuditLogFormatter(IAuditStrategy::EVENT_ENTITY_DELETION);
$formatter->setContext(AuditContextBuilder::default()->build());
$result = $formatter->format($this->mockSubject, []);

$this->assertNotNull($result);
$this->assertStringContainsString('deleted', $result);
}

public function testFormatterReturnsNullForInvalidSubject(): void
{
$formatter = new SummitAttendeeBadgeAuditLogFormatter(IAuditStrategy::EVENT_ENTITY_CREATION);
$formatter->setContext(AuditContextBuilder::default()->build());
$result = $formatter->format(new \stdClass(), []);

$this->assertNull($result);
}

public function testFormatterHandlesEmptyChangeSet(): void
{
$formatter = new SummitAttendeeBadgeAuditLogFormatter(IAuditStrategy::EVENT_ENTITY_UPDATE);
$formatter->setContext(AuditContextBuilder::default()->build());
$result = $formatter->format($this->mockSubject, []);

$this->assertNotNull($result);
$this->assertStringContainsString('updated', $result);
}
}
Loading