Handle module source subdirectories in Terraform #16160
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
Test that we can get a subdirectory from a tarball (or any other "packed" source that we support). The 'tar-subdir-to-parent' test highlights a regression where the subdirectory module references a module in its parent directory. This breaks the intended use ofr the subdirectory and the implementation in go-getter. We need to fix this in terraform, and possible plan warnings and deprecations for this type of source.
The registry uses the `//*` subdir format to unpack github archives. Add a test to cover this pattern.
In order to remain backward compatible with some modules, we need to handle subdirs during Load. This means duplicating part of the go-getter code path for subDir handling so we can resolve any subDirs and globs internally, while keeping the entire remote directory structure within the file storage.
jbardin
force-pushed
the
jbardin/get-subdir
branch
from
ccb19b8
to
b61943d
Compare
Module detection currently requires calling the registry to determine the subdirectory. Since we're not directly accessing the subdirectory through FolderStorage, and now handling it within terraform so modules can reference sibling paths, we need to call out to the registry every time we load a configuration to verify the subdirectory for the module, which is returned during the Detect. Record the subdirectories for each module in the top-level of the FolderStorage path for retrieval during Tree.Load. This lets us bypass Detection altogether, modules can be loaded without redetecting.
jbardin
force-pushed
the
jbardin/get-subdir
branch
from
b61943d
to
f6e89bb
Compare
apparentlymart
approved these changes
Sep 25, 2017
config/module/get_test.go
Outdated
| t.Fatal("should be loaded") | ||
| } | ||
|
|
||
| // This should no longer error |
There was a problem hiding this comment.
I'm not sure what this comment is referring to... it would be helpful to elaborate on what "this" is, and what "no longer" is in reference to (i.e. in what previous situation did it error?)
There was a problem hiding this comment.
sorry, that was a cut&paste artifact
jbardin
commented
Sep 25, 2017
config/module/get_test.go
Outdated
|
|
||
| var testMods = map[string]testMod{ | ||
| "registry/foo/bar": { | ||
| location: "file:///download/registry/foo/bar/0.2.3//*?archive=tar.gz", |
There was a problem hiding this comment.
I forgot the comment explaining the optional scheme prefix for these tests. (this fixture is likely to evolve in the near future anyway)
|
I'm going to lock this issue because it has been closed for 30 days ⏳. This helps our maintainers find and focus on the active issues. If you have found a problem that seems similar to this, please open a new issue and complete the issue template so we can capture all the details necessary to investigate further. |
ghost
locked and limited conversation to collaborators
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.
In order to remain backward compatible with some modules, we need to
handle subdirs during Load. This means duplicating part of the go-getter
code path for subDir handling so we can resolve any subDirs and globs
internally, while keeping the entire remote directory structure within
the file storage.
Module detection currently requires calling the registry to determine
the subdirectory. Since we're not directly accessing the subdirectory
through FolderStorage, and now handling it within terraform so modules can
reference sibling paths, we need to call out to the registry every
time we load a configuration to verify the subdirecory for the module,
which is returned during the Detect.
This adds a record for the detected subdirectory in the top-level of the FolderStorage path for
retrieval during Tree.Load. This lets us bypass Detection altogether,
modules can be loaded without redetecting.
Fixes #16138