Appwrite/appwrite
1
0
Fork 0
mirror of https://github.com/appwrite/appwrite.git synced 2026-05-26 13:51:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add E2E test for webhook migration

Browse Source 
Asserts events/auth round-trip, and that authPassword + signatureKey are
not copied from source (sensitive fields regenerated on destination).
This commit is contained in:
Prem Palanisamy
2026-05-15 07:25:30 +01:00
parent 8620cf1921
commit aa44221e56
1 changed files with 81 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files
tests/e2e/Services/Migrations/MigrationsBase.php
+81
View File
@@ -2616,6 +2616,87 @@ trait MigrationsBase
$this->client->call(Client::METHOD_DELETE, '/project/keys/' . $apiKey['$id'], $sourceHeaders);
}
public function testAppwriteMigrationWebhook(): void
{
$sourceHeaders = [
'content-type' => 'application/json',
'x-appwrite-project' => $this->getProject()['$id'],
'x-appwrite-key' => $this->getProject()['apiKey'],
];
$destinationHeaders = [
'content-type' => 'application/json',
'x-appwrite-project' => $this->getDestinationProject()['$id'],
'x-appwrite-key' => $this->getDestinationProject()['apiKey'],
];
// Unique name so re-runs and parallel suites can't match the wrong webhook
// on the destination list.
$webhookName = 'Test Webhook ' . ID::unique();
$createResp = $this->client->call(Client::METHOD_POST, '/webhooks', $sourceHeaders, [
'webhookId' => ID::unique(),
'url' => 'https://example.test/hook',
'name' => $webhookName,
'events' => ['users.*.create', 'users.*.delete'],
'enabled' => true,
'tls' => true,
'authUsername' => 'hook-user',
'authPassword' => 'hook-pass',
]);
$this->assertEquals(201, $createResp['headers']['status-code']);
$sourceWebhook = $createResp['body'];
$result = $this->performMigrationSync([
'resources' => [
Resource::TYPE_WEBHOOK,
],
'endpoint' => $this->webEndpoint,
'projectId' => $this->getProject()['$id'],
'apiKey' => $this->getProject()['apiKey'],
]);
$this->assertEquals('completed', $result['status']);
$this->assertEquals([Resource::TYPE_WEBHOOK], $result['resources']);
$this->assertArrayHasKey(Resource::TYPE_WEBHOOK, $result['statusCounters']);
$this->assertEquals(0, $result['statusCounters'][Resource::TYPE_WEBHOOK]['error']);
$this->assertEquals(0, $result['statusCounters'][Resource::TYPE_WEBHOOK]['pending']);
$this->assertGreaterThanOrEqual(1, $result['statusCounters'][Resource::TYPE_WEBHOOK]['success']);
$this->assertEquals(0, $result['statusCounters'][Resource::TYPE_WEBHOOK]['processing']);
$this->assertEquals(0, $result['statusCounters'][Resource::TYPE_WEBHOOK]['warning']);
$listResp = $this->client->call(Client::METHOD_GET, '/webhooks', $destinationHeaders);
$this->assertEquals(200, $listResp['headers']['status-code']);
$foundWebhook = null;
foreach ($listResp['body']['webhooks'] as $w) {
if ($w['name'] === $webhookName) {
$foundWebhook = $w;
break;
}
}
$this->assertNotNull($foundWebhook, 'Migrated webhook not found on destination');
$this->assertEquals($webhookName, $foundWebhook['name']);
$this->assertEquals('https://example.test/hook', $foundWebhook['url']);
$this->assertEqualsCanonicalizing(['users.*.create', 'users.*.delete'], $foundWebhook['events']);
$this->assertTrue($foundWebhook['enabled']);
$this->assertTrue($foundWebhook['security']);
$this->assertEquals('hook-user', $foundWebhook['httpUser']);
// authPassword is sensitive; destination must not blindly copy the source value.
$this->assertNotEquals('hook-pass', $foundWebhook['httpPass'] ?? '');
// signatureKey is regenerated on the destination — must not equal the source key.
if (!empty($sourceWebhook['signatureKey'])) {
$this->assertNotEquals($sourceWebhook['signatureKey'], $foundWebhook['signatureKey'] ?? '');
}
// Cleanup on destination
$this->client->call(Client::METHOD_DELETE, '/webhooks/' . $foundWebhook['$id'], $destinationHeaders);
// Cleanup on source
$this->client->call(Client::METHOD_DELETE, '/webhooks/' . $sourceWebhook['$id'], $sourceHeaders);
}
/**
* Import documents from a CSV file.
*/