Skip to content

CLI-1860: Updated response to include download links. #2028

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

Draft
vishalkhode1 wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

CLI-1860: Updated response to include download links. #2028

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
f5a6943
CLI-1860: Updated resoponse to include download links.
vishalkhode1 Jul 22, 2026
1227526
Merge branch 'main' into CLI-1860
deepakmishra2 Jul 24, 2026
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
20 changes: 17 additions & 3 deletions src/Command/Api/ApiBaseCommand.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,17 +156,31 @@ protected function execute(InputInterface $input, OutputInterface $output): int
private function mungeResponse(mixed &$response): void
{
if (is_object($response) && property_exists($response, '_links')) {
unset($response->_links);
$response->_links = $this->filterLinks($response->_links);
}
foreach ($response as &$value) {
if (is_object($value) && property_exists($value, '_links')) {
unset($value->_links);
$value->_links = $this->filterLinks($value->_links);
} elseif (is_array($value) && array_key_exists('_links', $value)) {
unset($value['_links']);
$value['_links'] = $this->filterLinks($value['_links']);
}
}
}

private function filterLinks(mixed $links): mixed
{
if (is_object($links)) {
foreach (array_keys((array) $links) as $key) {
if ($key !== 'download') {
unset($links->$key);
}
}
} elseif (is_array($links)) {
$links = array_filter($links, static fn($key) => $key === 'download', ARRAY_FILTER_USE_KEY);
}
return $links;
}

public function setMethod(string $method): void
{
$this->method = $method;
Expand Down
155 changes: 124 additions & 31 deletions tests/phpunit/src/Commands/Api/ApiCommandTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -921,11 +921,13 @@ public function testTranslationPathMungesResponse(): void
$output = $this->getDisplay();
$decoded = json_decode($output, true);

// Verify _links was removed (munged) from all items.
// Verify _links was filtered (munged) — still present but empty (no download key in fixture).
$this->assertIsArray($decoded);
$this->assertCount(2, $decoded);
$this->assertArrayNotHasKey('_links', $decoded[0]);
$this->assertArrayNotHasKey('_links', $decoded[1]);
$this->assertArrayHasKey('_links', $decoded[0]);
$this->assertEmpty($decoded[0]['_links']);
$this->assertArrayHasKey('_links', $decoded[1]);
$this->assertEmpty($decoded[1]['_links']);
$this->assertEquals(1, $decoded[0]['id']);
$this->assertEquals(2, $decoded[1]['id']);
}
Expand Down Expand Up @@ -974,12 +976,14 @@ public function testTranslationsPathDoesNotMungeResponse(): void
$output = $this->getDisplay();
$decoded = json_decode($output, true);

// Verify _links was removed (munged by original 12-char check).
// If mutant (13-char check) exists, _links would remain and this assertion would fail.
// Verify _links was filtered (munged by original 12-char check) — still present but empty.
// If mutant (13-char check) exists, munging is skipped and _links retains its original keys.
$this->assertIsArray($decoded);
$this->assertCount(2, $decoded);
$this->assertArrayNotHasKey('_links', $decoded[0]);
$this->assertArrayNotHasKey('_links', $decoded[1]);
$this->assertArrayHasKey('_links', $decoded[0]);
$this->assertEmpty($decoded[0]['_links']);

@deepakmishra2 deepakmishra2 Jul 24, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

and once we have the test we can change this assertion to assertArrayNotHasKey('_links', ...) for fixtures without a download key

$this->assertArrayHasKey('_links', $decoded[1]);
$this->assertEmpty($decoded[1]['_links']);
}

/**
Expand Down Expand Up @@ -1026,14 +1030,14 @@ public function testPathEndingWithTranslationDoesNotMungeResponse(): void
}

/**
* Tests that mungeResponse removes _links from the top-level response object.
* Tests that mungeResponse filters _links on the top-level response object (keeps only 'download').
* This kills the LogicalAndNegation mutant that negates the condition.
*
* Original: if (is_object($response) && property_exists($response, '_links')) → unsets _links
* Mutant: if (!(is_object($response) && property_exists($response, '_links'))) → doesn't unset _links
* Original: if (is_object($response) && property_exists($response, '_links')) → filters _links
* Mutant: if (!(is_object($response) && property_exists($response, '_links'))) → skips filtering
*
* By verifying _links are removed from the top-level object, we ensure the original condition is used.
* If the mutant exists, _links would remain and this test would fail.
* By verifying non-download keys are stripped from _links, we ensure the original condition is used.
* If the mutant exists, _links would retain all original keys and these assertions would fail.
*/
public function testTranslationPathMungesTopLevelLinks(): void
{
Expand Down Expand Up @@ -1072,27 +1076,30 @@ public function testTranslationPathMungesTopLevelLinks(): void
$output = $this->getDisplay();
$decoded = json_decode($output, true);

// Verify _links was removed (munged) from the top-level object.
// Original code: is_object($response) && property_exists($response, '_links') → true → unsets
// Mutant code: !(is_object($response) && property_exists($response, '_links')) → false → doesn't unset
// So if mutant exists, _links would remain and this assertion would fail.
// Verify _links was filtered (munged) on the top-level object — present but empty (no download key).
// Original code: is_object($response) && property_exists($response, '_links') → true → filters
// Mutant code: !(is_object($response) && property_exists($response, '_links')) → false → skips
// So if mutant exists, _links would retain 'next'/'self' keys and assertEmpty would fail.
$this->assertIsArray($decoded);
$this->assertArrayNotHasKey('_links', $decoded);
// Verify nested objects' _links are also removed by the foreach loop.
$this->assertArrayHasKey('_links', $decoded);
$this->assertEmpty($decoded['_links']);
// Verify nested objects' _links are also filtered by the foreach loop.
$this->assertIsArray($decoded['data']);
$this->assertArrayNotHasKey('_links', $decoded['data']);
$this->assertArrayHasKey('_links', $decoded['data']);
$this->assertEmpty($decoded['data']['_links']);
$this->assertEquals('test', $decoded['data']['message']);
$this->assertIsArray($decoded['meta']);
$this->assertArrayNotHasKey('_links', $decoded['meta']);
$this->assertArrayHasKey('_links', $decoded['meta']);
$this->assertEmpty($decoded['meta']['_links']);
$this->assertEquals(10, $decoded['meta']['count']);
}

/**
* Mutation test: MEO commands must remove _links from the response.
* Mutation test: MEO commands must filter _links keeping only the 'download' key.
* Kills mutants that make isMeoCommand() return false or skip mungeResponse().
*
* When isMeoCommand() returns true, mungeResponse() is called and _links are removed.
* If a mutant makes isMeoCommand() return false, _links would remain and this assertion fails.
* When isMeoCommand() returns true, mungeResponse() is called and _links are filtered.
* If a mutant makes isMeoCommand() return false, _links would retain all original keys.
*/
public function testMeoCommandRemovesLinksFromResponse(): void
{
Expand Down Expand Up @@ -1120,7 +1127,8 @@ public function testMeoCommandRemovesLinksFromResponse(): void
$decoded = json_decode($output, true);

$this->assertIsArray($decoded);
$this->assertArrayNotHasKey('_links', $decoded[0], 'MEO command must remove _links from response');
$this->assertArrayHasKey('_links', $decoded[0]);
$this->assertEmpty($decoded[0]['_links'], 'MEO command must filter _links (no download key in fixture leaves it empty)');
$this->assertEquals(1, $decoded[0]['id']);
$this->assertEquals('site1', $decoded[0]['name']);
}
Expand Down Expand Up @@ -1157,8 +1165,8 @@ public function testNonMeoCommandPreservesLinksInResponse(): void
}

/**
* Mutation test: mungeResponse must remove top-level _links on an object.
* Kills mutants that skip the top-level unset in mungeResponse().
* Mutation test: mungeResponse must filter _links on the top-level response object (keeps only 'download').
* Kills mutants that skip the top-level filterLinks call in mungeResponse().
*
* Uses api:codebases:sites-list (MEO command with no environmentId) to avoid
* environment alias validation that would require extra API mocks.
Expand Down Expand Up @@ -1188,17 +1196,18 @@ public function testMeoCommandRemovesTopLevelLinksFromObjectResponse(): void
$decoded = json_decode($output, true);

$this->assertIsArray($decoded);
$this->assertArrayNotHasKey('_links', $decoded, 'MEO command must remove top-level _links');
$this->assertArrayHasKey('_links', $decoded);
$this->assertEmpty($decoded['_links'], 'MEO command must filter top-level _links (no download key in fixture leaves it empty)');
$this->assertEquals('site-123', $decoded['id']);
$this->assertEquals('My Site', $decoded['name']);
}

/**
* Mutation test: mungeResponse must remove _links from array items (not just objects).
* Mutation test: mungeResponse must filter _links from array items (not just objects).
* Kills LogicalAnd mutant (line 152): is_object($value) && property_exists → || would call
* property_exists() on arrays and throw TypeError.
* Kills LogicalAndSingleSubExprNegation mutant (line 154): array_key_exists → !array_key_exists
* would skip removal when _links exists, leaving it in the output.
* would skip filtering when _links exists, leaving all original keys in the output.
*
* Some MEO endpoints return top-level array responses (array of arrays). When foreach iterates,
* $value is an array - we must use array_key_exists for arrays, not property_exists.
Expand Down Expand Up @@ -1238,9 +1247,93 @@ public function testMeoCommandRemovesLinksFromArrayItemsInResponse(): void

$this->assertIsArray($decoded);
$this->assertCount(2, $decoded);
$this->assertArrayNotHasKey('_links', $decoded[0], 'MEO command must remove _links from array items');
$this->assertArrayNotHasKey('_links', $decoded[1], 'MEO command must remove _links from array items');
$this->assertArrayHasKey('_links', $decoded[0]);
$this->assertEmpty($decoded[0]['_links'], 'MEO command must filter _links from array items (no download key leaves it empty)');
$this->assertArrayHasKey('_links', $decoded[1]);
$this->assertEmpty($decoded[1]['_links'], 'MEO command must filter _links from array items (no download key leaves it empty)');
$this->assertEquals(1, $decoded[0]['id']);
$this->assertEquals('site2', $decoded[1]['name']);
}

/**
* Data provider for testMeoCommandPreservesDownloadKeyInLinks.
*
* @return array<string, array{expectedDownloadHref: string, getLinks: callable, mockResponse: mixed}>
* Return an associative array where each key is a descriptive test case name, and each value is an array containing:
* - 'expectedDownloadHref': The expected href value for the 'download' link
* - 'getLinks': A callable that takes the decoded response and returns the _links array to check
* - 'mockResponse': The mock response to return from the API request, which can be an array or object depending on the test case
*/
public static function providerTestFilterLinksPreservesDownloadKey(): array
{
return [
'array items with array-typed _links' => [
'expectedDownloadHref' => 'https://s3.amazonaws.com/test/db/backups/site-1/environment/database.sql.gz',
'getLinks' => static fn(array $decoded) => $decoded[0]['_links'],
'mockResponse' => [
[
'id' => 1,
'name' => 'site1',
'_links' => [
'download' => ['href' => 'https://s3.amazonaws.com/test/db/backups/site-1/environment/database.sql.gz'],
'self' => ['href' => '/api/site/1'],
],
],
],
],
'object items in array' => [
'expectedDownloadHref' => 'https://s3.amazonaws.com/test/db/backups/site-1/environment/database.sql.gz',
'getLinks' => static fn(array $decoded) => $decoded[0]['_links'],
'mockResponse' => [(object)[
'id' => 1,
'name' => 'site1',
'_links' => (object)[
'download' => (object)['href' => 'https://s3.amazonaws.com/test/db/backups/site-1/environment/database.sql.gz'],
'self' => (object)['href' => '/api/site/1'],
],
],
],
],
'top-level response object' => [
'expectedDownloadHref' => 'https://s3.amazonaws.com/test/db/backups/site-123/environment/database.sql.gz',
'getLinks' => static fn(array $decoded) => $decoded['_links'],
'mockResponse' => (object)[
'id' => 'site-123',
'name' => 'My Site',
'_links' => (object)[
'download' => (object)['href' => 'https://s3.amazonaws.com/test/db/backups/site-123/environment/database.sql.gz'],
'self' => (object)['href' => '/api/sites/123'],
],
],
],
];
}

/**
* Tests that filterLinks preserves the 'download' key and removes all other keys from _links,
* regardless of whether _links is on a top-level object, an object item, or an array item.
*/
#[DataProvider('providerTestFilterLinksPreservesDownloadKey')]
public function testMeoCommandPreservesDownloadKeyInLinks(mixed $mockResponse, callable $getLinks, string $expectedDownloadHref): void
{
$this->clientProphecy->addOption('headers', ['Accept' => 'application/hal+json, version=2'])
->shouldBeCalled();

$this->command = $this->getApiCommandByName('api:codebases:sites-list');
$this->clientProphecy->request(
$this->command->getMethod(),
'/codebases/test-codebase-uuid/sites'
)
->willReturn($mockResponse)
->shouldBeCalled();

$this->executeCommand(['codebaseId' => 'test-codebase-uuid']);

$decoded = json_decode($this->getDisplay(), true);
$links = $getLinks($decoded);

$this->assertArrayHasKey('download', $links, 'filterLinks must preserve the download key');
$this->assertArrayNotHasKey('self', $links, 'filterLinks must remove non-download keys');
$this->assertEquals($expectedDownloadHref, $links['download']['href']);
}
}
Loading