Persist container exit code in agent state file #1125
Merged
Conversation
This file contains 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
|
I missed this in my comments. Can you please add a changelog entry as well? Example: 6527d7d#diff-4ac32a78649ca5bdd8e0ba38b7006a1eR4 |
Container exit code needs to be persisted in the agent state file so that api.Container structs can be rebuilt after agent restarts. Go's default JSON encoder marshals only public fields. Rename and export KnownExitCodeUnsafe with proper JSON marking. Add test to ensure exit code is persisted and catch any regressions. Fix existing test panics caused by continuing after fatal nil checks.
richardpen
reviewed
Dec 4, 2017
| // the JSON body while saving the state. | ||
| // NOTE: Do not access KnownExitCodeUnsafe directly. Instead, use `GetKnownExitCode` | ||
| // and `SetKnownExitCode`. | ||
| KnownExitCodeUnsafe *int `json:"KnownExitCode"` |
There was a problem hiding this comment.
You may also bump the state file version here
There was a problem hiding this comment.
I think the KnownExitCode was part of the state file since the beginning. It was recently accidentally removed, this change is just putting it back in. So I thought I shouldn't bump the version?
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
Container exit code needs to be persisted in the agent state file so
that api.Container structs can be rebuilt after agent restarts. Go's
default JSON encoder marshals only public fields. This PR renames
and exports that field, updates access functions and adds a test case
for exercising the new logic.
Future work: We should write a custom marshaler for container class
so that we don't have to expose internal state. Since this improvement
is not specific to exit code, I chose to fix it first, and implement the
custom marshaler in a later commit.
Implementation details
Testing
make release)go build -out amazon-ecs-agent.exe ./agent)make test) passgo test -timeout=25s ./agent/...) passmake run-integ-tests) pass.\scripts\run-integ-tests.ps1) passmake run-functional-tests) pass.\scripts\run-functional-tests.ps1) passNew tests cover the changes: yes
Description for the changelog
Bug - Persist container exit code in agent state file
Licensing
This contribution is under the terms of the Apache 2.0 License: yes
Fixes #986