Summary This PR implements Spec 049 – Backup/Restore Job Orchestration: all critical Backup/Restore execution paths are job-only, idempotent, tenant-scoped, and observable via run records + DB notifications (Phase 1). The UI no longer performs heavy Graph work inside request/Filament actions for these flows. Why We want predictable UX and operations at MSP scale: • no timeouts / long-running requests • reproducible run state + per-item results • safe error persistence (no secrets / no token leakage) • strict tenant isolation + auditability for write paths What changed Foundational (Runs + Idempotency + Observability) • Added a shared RunIdempotency helper (dedupe while queued/running). • Added a read-only BulkOperationRuns surface (list + view) for status/progress. • Added DB notifications for run status changes (with “View run” link). US1 – Policy “Capture snapshot” is job-only • Policy detail “Capture snapshot” now: • creates/reuses a run (dedupe key: tenant + policy.capture_snapshot + policy DB id) • dispatches a queued job • returns immediately with notification + link to run detail • Graph capture work moved fully into the job; request path stays Graph-free. US3 – Restore runs orchestration is job-only + safe • Live restore execution is queued and updates RestoreRun status/progress. • Per-item outcomes are persisted deterministically (per internal DB record). • Audit logging is written for live restore. • Preview/dry-run is enforced as read-only (no writes). Tenant isolation / authorization (non-negotiable) • Run list/view/start are tenant-scoped and policy-guarded (cross-tenant access => 403, not 404). • Explicit Pest tests cover cross-tenant denial and start authorization. Tests / Verification • ./vendor/bin/pint --dirty • Targeted suite (examples): • policy capture snapshot queued + idempotency tests • restore orchestration + audit logging + preview read-only tests • run authorization / tenant isolation tests Notes / Scope boundaries • Phase 1 UX = DB notifications + run detail page. A global “progress widget” is tracked as Phase 2 and not required for merge. • Resilience/backoff is tracked in tasks but can be iterated further after merge. Review focus • Dedupe behavior for queued/running runs (reuse vs create-new) • Tenant scoping & policy gates for all run surfaces • Restore safety: audit event + preview no-writes Co-authored-by: Ahmed Darrazi <ahmeddarrazi@adsmac.local> Reviewed-on: #56
364 lines
12 KiB
PHP
364 lines
12 KiB
PHP
<?php
|
|
|
|
use App\Models\BackupItem;
|
|
use App\Models\BackupSet;
|
|
use App\Models\Policy;
|
|
use App\Models\Tenant;
|
|
use App\Models\User;
|
|
use App\Services\Graph\GraphClientInterface;
|
|
use App\Services\Graph\GraphResponse;
|
|
use App\Services\Intune\FoundationMappingService;
|
|
use App\Services\Intune\RestoreService;
|
|
use Illuminate\Foundation\Testing\RefreshDatabase;
|
|
use Mockery\MockInterface;
|
|
|
|
uses(RefreshDatabase::class);
|
|
|
|
class RestoreAssignmentGraphClient implements GraphClientInterface
|
|
{
|
|
/**
|
|
* @var array<int, array{method:string,path:string,payload:array|null}>
|
|
*/
|
|
public array $requestCalls = [];
|
|
|
|
/**
|
|
* @param array<int, GraphResponse> $requestResponses
|
|
*/
|
|
public function __construct(
|
|
private readonly GraphResponse $applyPolicyResponse,
|
|
private array $requestResponses = [],
|
|
) {}
|
|
|
|
public function listPolicies(string $policyType, array $options = []): GraphResponse
|
|
{
|
|
return new GraphResponse(true, []);
|
|
}
|
|
|
|
public function getPolicy(string $policyType, string $policyId, array $options = []): GraphResponse
|
|
{
|
|
return new GraphResponse(true, ['payload' => []]);
|
|
}
|
|
|
|
public function getOrganization(array $options = []): GraphResponse
|
|
{
|
|
return new GraphResponse(true, []);
|
|
}
|
|
|
|
public function applyPolicy(string $policyType, string $policyId, array $payload, array $options = []): GraphResponse
|
|
{
|
|
return $this->applyPolicyResponse;
|
|
}
|
|
|
|
public function getServicePrincipalPermissions(array $options = []): GraphResponse
|
|
{
|
|
return new GraphResponse(true, []);
|
|
}
|
|
|
|
public function request(string $method, string $path, array $options = []): GraphResponse
|
|
{
|
|
$this->requestCalls[] = [
|
|
'method' => strtoupper($method),
|
|
'path' => $path,
|
|
'payload' => $options['json'] ?? null,
|
|
];
|
|
|
|
return array_shift($this->requestResponses) ?? new GraphResponse(true, []);
|
|
}
|
|
}
|
|
|
|
test('restore applies assignments with mapped groups', function () {
|
|
$applyResponse = new GraphResponse(true, []);
|
|
$requestResponses = [
|
|
new GraphResponse(true, []), // assign action
|
|
];
|
|
|
|
$client = new RestoreAssignmentGraphClient($applyResponse, $requestResponses);
|
|
app()->instance(GraphClientInterface::class, $client);
|
|
|
|
$tenant = Tenant::create([
|
|
'tenant_id' => 'tenant-1',
|
|
'name' => 'Tenant One',
|
|
'metadata' => [],
|
|
]);
|
|
|
|
$policy = Policy::create([
|
|
'tenant_id' => $tenant->id,
|
|
'external_id' => 'scp-1',
|
|
'policy_type' => 'settingsCatalogPolicy',
|
|
'display_name' => 'Settings Catalog Alpha',
|
|
'platform' => 'windows',
|
|
]);
|
|
|
|
$backupSet = BackupSet::create([
|
|
'tenant_id' => $tenant->id,
|
|
'name' => 'Backup',
|
|
'status' => 'completed',
|
|
'item_count' => 1,
|
|
]);
|
|
|
|
$backupItem = BackupItem::create([
|
|
'tenant_id' => $tenant->id,
|
|
'backup_set_id' => $backupSet->id,
|
|
'policy_id' => $policy->id,
|
|
'policy_identifier' => $policy->external_id,
|
|
'policy_type' => $policy->policy_type,
|
|
'platform' => $policy->platform,
|
|
'payload' => ['id' => $policy->external_id, '@odata.type' => '#microsoft.graph.deviceManagementConfigurationPolicy'],
|
|
'assignments' => [
|
|
[
|
|
'id' => 'assignment-1',
|
|
'intent' => 'apply',
|
|
'target' => [
|
|
'@odata.type' => '#microsoft.graph.groupAssignmentTarget',
|
|
'groupId' => 'source-group-1',
|
|
'group_display_name' => 'Source One',
|
|
],
|
|
],
|
|
[
|
|
'id' => 'assignment-2',
|
|
'intent' => 'apply',
|
|
'target' => [
|
|
'@odata.type' => '#microsoft.graph.groupAssignmentTarget',
|
|
'groupId' => 'source-group-2',
|
|
],
|
|
],
|
|
],
|
|
]);
|
|
|
|
$user = User::factory()->create(['email' => 'tester@example.com']);
|
|
$this->actingAs($user);
|
|
|
|
$service = app(RestoreService::class);
|
|
$run = $service->execute(
|
|
tenant: $tenant,
|
|
backupSet: $backupSet,
|
|
selectedItemIds: [$backupItem->id],
|
|
dryRun: false,
|
|
actorEmail: $user->email,
|
|
actorName: $user->name,
|
|
groupMapping: [
|
|
'source-group-1' => 'target-group-1',
|
|
'source-group-2' => 'target-group-2',
|
|
],
|
|
);
|
|
|
|
$result = $run->results['items'][$backupItem->id] ?? null;
|
|
expect($result)->not->toBeNull();
|
|
|
|
$summary = $result['assignment_summary'] ?? null;
|
|
|
|
expect($summary)->not->toBeNull();
|
|
expect($summary['success'])->toBe(2);
|
|
expect($summary['failed'])->toBe(0);
|
|
|
|
$postCalls = collect($client->requestCalls)
|
|
->filter(fn (array $call) => $call['method'] === 'POST')
|
|
->values();
|
|
|
|
expect($postCalls)->toHaveCount(1);
|
|
expect($postCalls[0]['path'])->toBe('/deviceManagement/configurationPolicies/scp-1/assign');
|
|
|
|
$payloadAssignments = $postCalls[0]['payload']['assignments'] ?? [];
|
|
$groupIds = collect($payloadAssignments)->pluck('target.groupId')->all();
|
|
|
|
expect($groupIds)->toBe(['target-group-1', 'target-group-2']);
|
|
expect($payloadAssignments[0])->not->toHaveKey('id');
|
|
});
|
|
|
|
test('restore handles assignment failures gracefully', function () {
|
|
$applyResponse = new GraphResponse(true, []);
|
|
$requestResponses = [
|
|
new GraphResponse(false, ['error' => ['message' => 'Bad request']], 400, [
|
|
['code' => 'BadRequest', 'message' => 'Bad request'],
|
|
], [], [
|
|
'error_code' => 'BadRequest',
|
|
'error_message' => 'Bad request',
|
|
]), // assign action fails
|
|
];
|
|
|
|
$client = new RestoreAssignmentGraphClient($applyResponse, $requestResponses);
|
|
app()->instance(GraphClientInterface::class, $client);
|
|
|
|
$tenant = Tenant::create([
|
|
'tenant_id' => 'tenant-1',
|
|
'name' => 'Tenant One',
|
|
'metadata' => [],
|
|
]);
|
|
|
|
$policy = Policy::create([
|
|
'tenant_id' => $tenant->id,
|
|
'external_id' => 'scp-1',
|
|
'policy_type' => 'settingsCatalogPolicy',
|
|
'display_name' => 'Settings Catalog Alpha',
|
|
'platform' => 'windows',
|
|
]);
|
|
|
|
$backupSet = BackupSet::create([
|
|
'tenant_id' => $tenant->id,
|
|
'name' => 'Backup',
|
|
'status' => 'completed',
|
|
'item_count' => 1,
|
|
]);
|
|
|
|
$backupItem = BackupItem::create([
|
|
'tenant_id' => $tenant->id,
|
|
'backup_set_id' => $backupSet->id,
|
|
'policy_id' => $policy->id,
|
|
'policy_identifier' => $policy->external_id,
|
|
'policy_type' => $policy->policy_type,
|
|
'platform' => $policy->platform,
|
|
'payload' => ['id' => $policy->external_id, '@odata.type' => '#microsoft.graph.deviceManagementConfigurationPolicy'],
|
|
'assignments' => [
|
|
[
|
|
'id' => 'assignment-1',
|
|
'intent' => 'apply',
|
|
'target' => [
|
|
'@odata.type' => '#microsoft.graph.groupAssignmentTarget',
|
|
'groupId' => 'source-group-1',
|
|
],
|
|
],
|
|
[
|
|
'id' => 'assignment-2',
|
|
'intent' => 'apply',
|
|
'target' => [
|
|
'@odata.type' => '#microsoft.graph.groupAssignmentTarget',
|
|
'groupId' => 'source-group-2',
|
|
],
|
|
],
|
|
],
|
|
]);
|
|
|
|
$user = User::factory()->create(['email' => 'tester@example.com']);
|
|
$this->actingAs($user);
|
|
|
|
$service = app(RestoreService::class);
|
|
$run = $service->execute(
|
|
tenant: $tenant,
|
|
backupSet: $backupSet,
|
|
selectedItemIds: [$backupItem->id],
|
|
dryRun: false,
|
|
actorEmail: $user->email,
|
|
actorName: $user->name,
|
|
groupMapping: [
|
|
'source-group-1' => 'target-group-1',
|
|
'source-group-2' => 'target-group-2',
|
|
],
|
|
);
|
|
|
|
$result = $run->results['items'][$backupItem->id] ?? null;
|
|
expect($result)->not->toBeNull();
|
|
|
|
$summary = $result['assignment_summary'] ?? null;
|
|
|
|
expect($summary)->not->toBeNull();
|
|
expect($summary['success'])->toBe(0);
|
|
expect($summary['failed'])->toBe(2);
|
|
expect($result['status'] ?? null)->toBe('partial');
|
|
});
|
|
|
|
test('restore maps assignment filter identifiers', function () {
|
|
$applyResponse = new GraphResponse(true, []);
|
|
$requestResponses = [
|
|
new GraphResponse(true, []), // assign action
|
|
];
|
|
|
|
$client = new RestoreAssignmentGraphClient($applyResponse, $requestResponses);
|
|
app()->instance(GraphClientInterface::class, $client);
|
|
|
|
$tenant = Tenant::create([
|
|
'tenant_id' => 'tenant-1',
|
|
'name' => 'Tenant One',
|
|
'metadata' => [],
|
|
]);
|
|
|
|
$policy = Policy::create([
|
|
'tenant_id' => $tenant->id,
|
|
'external_id' => 'scp-1',
|
|
'policy_type' => 'settingsCatalogPolicy',
|
|
'display_name' => 'Settings Catalog Alpha',
|
|
'platform' => 'windows',
|
|
]);
|
|
|
|
$backupSet = BackupSet::create([
|
|
'tenant_id' => $tenant->id,
|
|
'name' => 'Backup',
|
|
'status' => 'completed',
|
|
'item_count' => 2,
|
|
]);
|
|
|
|
$foundationItem = BackupItem::create([
|
|
'tenant_id' => $tenant->id,
|
|
'backup_set_id' => $backupSet->id,
|
|
'policy_id' => null,
|
|
'policy_identifier' => 'filter-old',
|
|
'policy_type' => 'assignmentFilter',
|
|
'platform' => 'all',
|
|
'payload' => ['id' => 'filter-old', 'displayName' => 'Filter Old'],
|
|
'metadata' => ['displayName' => 'Filter Old'],
|
|
]);
|
|
|
|
$backupItem = BackupItem::create([
|
|
'tenant_id' => $tenant->id,
|
|
'backup_set_id' => $backupSet->id,
|
|
'policy_id' => $policy->id,
|
|
'policy_identifier' => $policy->external_id,
|
|
'policy_type' => $policy->policy_type,
|
|
'platform' => $policy->platform,
|
|
'payload' => ['id' => $policy->external_id, '@odata.type' => '#microsoft.graph.deviceManagementConfigurationPolicy'],
|
|
'assignments' => [
|
|
[
|
|
'id' => 'assignment-1',
|
|
'intent' => 'apply',
|
|
'target' => [
|
|
'@odata.type' => '#microsoft.graph.groupAssignmentTarget',
|
|
'groupId' => 'source-group-1',
|
|
'deviceAndAppManagementAssignmentFilterId' => 'filter-old',
|
|
'deviceAndAppManagementAssignmentFilterType' => 'include',
|
|
],
|
|
],
|
|
],
|
|
]);
|
|
|
|
$entries = [
|
|
[
|
|
'type' => 'assignmentFilter',
|
|
'sourceId' => 'filter-old',
|
|
'sourceName' => 'Filter Old',
|
|
'decision' => 'created',
|
|
'targetId' => 'filter-new',
|
|
'targetName' => 'Filter Old',
|
|
],
|
|
];
|
|
|
|
$this->mock(FoundationMappingService::class, function (MockInterface $mock) use ($entries) {
|
|
$mock->shouldReceive('map')
|
|
->twice()
|
|
->andReturn([
|
|
'entries' => $entries,
|
|
'mapping' => ['filter-old' => 'filter-new'],
|
|
'failed' => 0,
|
|
'skipped' => 0,
|
|
]);
|
|
});
|
|
|
|
$user = User::factory()->create(['email' => 'tester@example.com']);
|
|
$this->actingAs($user);
|
|
|
|
$service = app(RestoreService::class);
|
|
$service->execute(
|
|
tenant: $tenant,
|
|
backupSet: $backupSet,
|
|
selectedItemIds: [$foundationItem->id, $backupItem->id],
|
|
dryRun: false,
|
|
actorEmail: $user->email,
|
|
actorName: $user->name,
|
|
groupMapping: [
|
|
'source-group-1' => 'target-group-1',
|
|
],
|
|
);
|
|
|
|
$payloadAssignments = $client->requestCalls[0]['payload']['assignments'] ?? [];
|
|
|
|
expect($payloadAssignments[0]['target']['deviceAndAppManagementAssignmentFilterId'])->toBe('filter-new');
|
|
});
|