-
Notifications
You must be signed in to change notification settings - Fork 0
fix(activity:list): handle null result on in-progress activities #59
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.
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
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| <?php | ||
|
|
||
| namespace Platformsh\Client\Model; | ||
|
|
||
| /** | ||
| * Local PHPStan stub for the Activity model. | ||
| * | ||
| * The upstream docblock types properties as non-nullable strings, but the API | ||
| * returns null for several properties until the activity reaches a particular | ||
| * state (e.g. result is null until the activity finishes). The list and | ||
| * nullability here follow the Upsun OpenAPI spec | ||
| * (https://developer.upsun.com/openapi.json). | ||
| * | ||
| * @property-read string $id | ||
| * @property-read int $completion_percent | ||
| * @property-read string $log | ||
| * @property-read string|null $created_at | ||
| * @property-read string|null $updated_at | ||
| * @property-read string[] $environments | ||
| * @property-read string|null $started_at | ||
| * @property-read string|null $completed_at | ||
| * @property-read string|null $cancelled_at | ||
| * @property-read string|null $expires_at | ||
| * @property-read array $parameters | ||
| * @property-read string $project | ||
| * @property-read string|null $integration | ||
| * @property-read string $state | ||
| * @property-read string|null $result | ||
| * @property-read string $type | ||
| * @property-read string|null $description | ||
| * @property-read string|null $text | ||
| * @property-read array $payload | ||
| * @property-read array $timings | ||
| * @property-read array $commands | ||
| */ | ||
| class Activity | ||
| { | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Platformsh\Cli\Tests\Service; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Platformsh\Cli\Service\ActivityMonitor; | ||
| use Platformsh\Client\Model\Activity; | ||
|
|
||
| class ActivityMonitorTest extends TestCase | ||
| { | ||
| public function testFormatResultSuccess(): void | ||
| { | ||
| $activity = new Activity(['id' => 'a', 'result' => Activity::RESULT_SUCCESS]); | ||
| $this->assertSame('success', ActivityMonitor::formatResult($activity, false)); | ||
| } | ||
|
|
||
| public function testFormatResultFailure(): void | ||
| { | ||
| $activity = new Activity(['id' => 'a', 'result' => Activity::RESULT_FAILURE]); | ||
| $this->assertSame('failure', ActivityMonitor::formatResult($activity, false)); | ||
| $this->assertSame('<error>failure</error>', ActivityMonitor::formatResult($activity, true)); | ||
| } | ||
|
|
||
| public function testFormatResultNull(): void | ||
| { | ||
| // An in-progress activity has no result yet. | ||
| $activity = new Activity(['id' => 'a', 'state' => Activity::STATE_IN_PROGRESS, 'result' => null]); | ||
| $this->assertSame('', ActivityMonitor::formatResult($activity, false)); | ||
| $this->assertSame('', ActivityMonitor::formatResult($activity, true)); | ||
|
pjcdawkins marked this conversation as resolved.
|
||
| } | ||
|
|
||
| public function testFormatResultFailedCommandOverridesSuccess(): void | ||
| { | ||
| $activity = new Activity([ | ||
| 'id' => 'a', | ||
| 'result' => Activity::RESULT_SUCCESS, | ||
| 'commands' => [ | ||
| ['exit_code' => 0], | ||
| ['exit_code' => 1], | ||
| ], | ||
| ]); | ||
| $this->assertSame('failure', ActivityMonitor::formatResult($activity, false)); | ||
| $this->assertSame('<error>failure</error>', ActivityMonitor::formatResult($activity, true)); | ||
| } | ||
|
|
||
| public function testFormatResultFailedCommandWithNullResult(): void | ||
| { | ||
| $activity = new Activity([ | ||
| 'id' => 'a', | ||
| 'state' => Activity::STATE_IN_PROGRESS, | ||
| 'result' => null, | ||
| 'commands' => [ | ||
| ['exit_code' => 1], | ||
| ], | ||
| ]); | ||
|
pjcdawkins marked this conversation as resolved.
|
||
| $this->assertSame('failure', ActivityMonitor::formatResult($activity, false)); | ||
| } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.