fix the hanging problem in windows if the terraform plan command failed #5909
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
mildaniel
approved these changes
Sep 8, 2023
samcli/lib/utils/subprocess_utils.py
Outdated
| @@ -92,10 +96,18 @@ def _print_loading_pattern(): | |||
| # we read from subprocess stdout to avoid the deadlock process.wait function | |||
| # for more detail check this python bug https://bugs.python.org/issue1256 | |||
| for line in process.stdout: | |||
| decoded_line = _check_and_process_bytes(line) | |||
| is_error = ( | |||
| not IS_NOT_WINDOWS | |||
There was a problem hiding this comment.
nit: Can we maybe flip the constant to clean up this condition? I think it would make it easier to read since this double negative reads a little awkward.
IS_WINDOWS instead of IS_NOT_WINDOWS
mildaniel
approved these changes
Sep 8, 2023
mndeveci
reviewed
Sep 8, 2023
There was a problem hiding this comment.
Thanks for fixing this issue @moelasmar!
One other thing I was wondering is setting some timeout to the process calls that we are making. Can we add some timeouts for them so that we won't be waiting indefinitely?
samcli/lib/utils/subprocess_utils.py
Outdated
Comment on lines
99
to
103
| is_error = ( | ||
| IS_WINDOWS | ||
| and len(line) >= len(TERRAFORM_ERROR_PREFIX) | ||
| and line[0:4] == bytes(TERRAFORM_ERROR_PREFIX) | ||
| ) |
There was a problem hiding this comment.
This utility module and function seems very generic, can we put terraform specific stuff behind a flag so that this will be only applied to the places where it is been called for terraform stuff?
mndeveci
approved these changes
Sep 14, 2023
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.
In windows, if Terraform plan command failed, the std out stream will not be closed till we read all the logs in the std err stream. The solution is to redirect the Terraform plan subprocess stderr stream to write in stdout, so we can read all the plan command logs from stdout, and we do not need to switch to the stderr in case if the command failed. This change only applied for Windows. I also added a check to differentiate between the plan command normal output, and errors.
I added a new integration test case to make sure that SAM CLI will not hang in case if terraform plan command failed.
Mandatory Checklist
PRs will only be reviewed after checklist is complete
make prpassesmake update-reproducible-reqsif dependencies were changedBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.