Upgrade to latest terraform-plugin-go, add logging sink. #805
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
paddycarver
added
the
subsystem/tests
paddycarver
force-pushed
the
paddy_plugin_log
branch
from
4874b1e
to
59c9fb6
Compare
paddycarver
force-pushed
the
paddy_plugin_log
branch
from
59c9fb6
to
2044c92
Compare
bflad
approved these changes
Dec 7, 2021
Upgrade to the latest version of terraform-plugin-go, bringing support for terraform-plugin-log. Use the terraform-plugin-log logging sink when setting up the helper/resource test framework. The idea here is that we'll use the logging sink to reroute all terraform-plugin-log logs, and leave the `log.Print` logs the way they are with the existing override. Over time, it may be nice to migrate those logs to use terraform-plugin-log, probably by extending `helper/logging.GetTestLogContext` to include a root SDK logger. In theory, this PR should result in no logs being written to the CLI during testing, which was happening in hashicorp/terraform-plugin-go#93. It should respect `TF_LOG`, `TF_LOG_PATH`, `TF_ACC_LOG_PATH`, and `TF_LOG_PATH_MASK`, as well as any terraform-plugin-log style environment variables in use. This also fixes `TF_ACC_LOG_PATH` to record the logs from the provider under test, not just the logs from Terraform and any providers the provider under test depends on. Co-authored-by: Brian Flad <bflad417@gmail.com>
paddycarver
force-pushed
the
paddy_plugin_log
branch
from
6da6133
to
199289e
Compare
|
I'm going to lock this pull request because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active contributions. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Upgrade to the latest version of terraform-plugin-go, bringing support
for terraform-plugin-log.
Use the terraform-plugin-log logging sink when setting up the
helper/resource test framework. The idea here is that we'll use the
logging sink to reroute all terraform-plugin-log logs, and leave the
log.Printlogs the way they are with the existing override. Over time,it may be nice to migrate those logs to use terraform-plugin-log, which
we've introduced
logging.GetTestLogContextas a helper for. But thatmay be a mistake, and maybe we should wait until we need it to introduce
that function.
In theory, this PR should result in no logs being written to the CLI
during testing, which was happening in hashicorp/terraform-plugin-go#93.
It should respect
TF_LOGandTF_LOG_PATH, as well as anyterraform-plugin-log style environment variables in use.
I think, by nature of this problem, we're going to need to test it manually for the moment, but I'll leave a comment with information on how to do that.
We should also wait to land this until hashicorp/terraform-plugin-log#15 lands and a release is cut, and hashicorp/terraform-plugin-go#93 lands and a release is cut, which will let us use tagged releases in our go.mod.