Add BackendStatusString method to ContainerStatus #4167
Merged
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.
Summary
Currently
ContainerStatus
enum and backend recognized container status strings are coupled asBackendStatus
method that is used to map former to latter returns aContainerStatus
and not astring
. This is not ideal as the coupling restricts the evolution of internal container statuses in Agent. This PR decouples the two by introducing a newBackendStatusString
method forContainerStatus
type that maps the internal container status to a suitable backend recognized status string. ExistingBackendStatus
method is marked as deprecated in this PR.BackendStatusString
method is slightly different fromBackendStatus
in that its steady state parameter is optional and defaults toContainerRunning
. That will be useful in cases where there is no special steady state for a container.This decoupling already exists for
TaskStatus
type, this PR extends the same logic toContainerStatus
.amazon-ecs-agent/ecs-agent/api/task/status/taskstatus.go
Lines 69 to 78 in b702281
The new method is not currently used but we plan to use it in the near future.
Testing
New tests cover the changes: yes
Description for the changelog
Enhancement: Decouple internal container status and backend recognized container status by introducing BackendStatusString() method to map internal container status to a backend recognized container status.
Does this PR include breaking model changes? If so, Have you added transformation functions?
Licensing
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.