Add ability for a resource to "use" another resources output automatically #72
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
Ensure that resource IDs passed into the use field exist and are in the same resource group as the current resource.
Changes CheckResourcesAndGroupNames to be a standalone function that returns error and ResourceToGroup map. Also removed the -c flag from run_examples to remove the deprecation warning.
Added a step in exand that applies any matching output in "use" resources that matches the input of the current resource. In addition, tests have been reorganized to decrease the size of the test_config.go file.
Add tests for: * getResourceByID * useResource * appendAsSlice * getResourceByVarName Various fixes to support tests also made
Adding a few function comments and cleaning up a test config
This commit adds the ability to use multiple resource output lists as a single setting by merging the lists. This is done using the flatten function in terraform and with a new feild in BlueprintConfig with functions to be applied to settings in the main.tf file.
cboneti
reviewed
Jan 12, 2022
For simplicity, move applyFunctions into the YamlConfig so it can be directly accessed during and after expand in the same way. This allows a call to expand to produce a YAML that can be used again in create with no differences in the final result. The name was also changed to WrapSettingsWith to be more explanatory and fit better under the Resource struct.
Moves expand() and validate() to the expand.go and validate.go file respectively for clarity and to keep config.go as top-level as possible.
Makes a number of changes in the useResource and applyUseResource function to decrease complexity and increase readabiltiy.
heyealex
force-pushed
the
use-resources
branch
from
ffab3a7
to
2c9067b
Compare
cboneti
reviewed
Jan 12, 2022
pkg/reswriter/tfwriter.go
Outdated
| if wrap, ok := res.WrapSettingsWith[setting]; ok { | ||
| if len(wrap) != 2 { | ||
| return fmt.Errorf( | ||
| "invalid length of WrapSettingsWith, expected 2 got %d", len(wrap)) |
There was a problem hiding this comment.
I would also say for which resource and which setting, if these are readily available.
* Pass in resource Inputs and Used resource outputs directly to UseResource rather than the ResourceInfo structs * Improve Comment Clarity * Improve error output details
|
All feedback has been addressed, just waiting on the checks now. |
cboneti
approved these changes
Jan 13, 2022
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.
Implements the "use" field as described in the design document. This field allows a resource to depend on the outputs of another in the same resource group, which means that similar to global variables, any matching outputs names for the used variable will be paired up with a setting in the using resource, assuming none have been explicitly set yet.
There are a lot of opportunities with this in place to shorten our current examples. All available ones have been added already, but I plan to follow-up with another PR that makes output name/setting name changes to make the most of this new feature.
Submission Checklist:
pre-commit installmake testschange?
guides?