IntenseWebs/opentofu
3
0
Fork 0
mirror of https://github.com/opentofu/opentofu.git synced 2025-02-25 18:45:20 -06:00
Code Issues Packages Projects Releases Wiki Activity

allow config errors when using -from-module

Browse Source 
When initializing the working directory from a module, some use cases
may still want the module source even when the configuration cannot be
loaded due to validation errors.

Isolate the installation errors during the initialization sequence, so
we can report them if there is a problem fetching the actual module
source. Once we have the module, convert configuration errors to
warnings so the cli initialization can proceed.
This commit is contained in:
James Bardin 2023-08-03 16:05:47 -04:00
parent 3bea1171af
commit 29c3f650cd
2 changed files with 53 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
internal/initwd/from_module.go
View File

@ -49,6 +49,7 @@ const initFromModuleRootKeyPrefix = initFromModuleRootCallName + "."
// are produced in that case, to prompt the user to rewrite the source strings
// to be absolute references to the original remote module.
func DirFromModule(ctx context.Context, loader *configload.Loader, rootDir, modulesDir, sourceAddrStr string, reg *registry.Client, hooks ModuleInstallHooks) tfdiags.Diagnostics {
var diags tfdiags.Diagnostics
// The way this function works is pretty ugly, but we accept it because
@ -157,12 +158,42 @@ func DirFromModule(ctx context.Context, loader *configload.Loader, rootDir, modu
wrapHooks := installHooksInitDir{
Wrapped: hooks,
}
fetcher := getmodules.NewPackageFetcher()
_, instDiags := inst.installDescendentModules(ctx, fakeRootModule, rootDir, instManifest, true, wrapHooks, fetcher)
diags = append(diags, instDiags...)
if instDiags.HasErrors() {
return diags
// Create a manifest record for the root module. This will be used if
// there are any relative-pathed modules in the root.
instManifest[""] = modsdir.Record{
Key: "",
Dir: rootDir,
}
fetcher := getmodules.NewPackageFetcher()
// When attempting to initialize the current directory with a module
// source, some use cases may want to ignore configuration errors from the
// building of the entire configuration structure, but we still need to
// capture installation errors. Because the actual module installation
// happens in the ModuleWalkFunc callback while building the config, we
// need to create a closure to capture the installation diagnostics
// separately.
var instDiags hcl.Diagnostics
w := inst.moduleInstallWalker(ctx, instManifest, true, wrapHooks, fetcher)
walker := configs.ModuleWalkerFunc(func(req *configs.ModuleRequest) (*configs.Module, *version.Version, hcl.Diagnostics) {
mod, version, diags := w.LoadModule(req)
instDiags = instDiags.Extend(diags)
return mod, version, diags
})
_, cDiags := inst.installDescendentModules(fakeRootModule, instManifest, walker)
// We can't continue if there was an error during installation, but return
// all diagnostics in case there happens to be anything else useful when
// debugging the problem.
if instDiags.HasErrors() {
return diags.Append(cDiags)
}
// if there are errors here, they must be only from building the config
// structures. We don't want to block initialization at this point, so
// convert these into warnings. Any actual errors in the configuration will
// be raised as soon as the config is loaded again.
diags = append(diags, tfdiags.OverrideAll(cDiags, tfdiags.Warning, nil)...)
// If all of that succeeded then we'll now migrate what was installed
// into the final directory structure.

28
internal/initwd/module_install.go
View File

@ -115,14 +115,6 @@ func (i *ModuleInstaller) InstallModules(ctx context.Context, rootDir, testsDir
}
fetcher := getmodules.NewPackageFetcher()
cfg, instDiags := i.installDescendentModules(ctx, rootMod, rootDir, manifest, upgrade, hooks, fetcher)
diags = append(diags, instDiags...)
return cfg, diags
}
func (i *ModuleInstaller) installDescendentModules(ctx context.Context, rootMod *configs.Module, rootDir string, manifest modsdir.Manifest, upgrade bool, hooks ModuleInstallHooks, fetcher *getmodules.PackageFetcher) (*configs.Config, tfdiags.Diagnostics) {
var diags tfdiags.Diagnostics
if hooks == nil {
// Use our no-op implementation as a placeholder
@ -135,8 +127,16 @@ func (i *ModuleInstaller) installDescendentModules(ctx context.Context, rootMod
Key: "",
Dir: rootDir,
}
walker := i.moduleInstallWalker(ctx, manifest, upgrade, hooks, fetcher)
cfg, cDiags := configs.BuildConfig(rootMod, configs.ModuleWalkerFunc(
cfg, instDiags := i.installDescendentModules(rootMod, manifest, walker)
diags = append(diags, instDiags...)
return cfg, diags
}
func (i *ModuleInstaller) moduleInstallWalker(ctx context.Context, manifest modsdir.Manifest, upgrade bool, hooks ModuleInstallHooks, fetcher *getmodules.PackageFetcher) configs.ModuleWalker {
return configs.ModuleWalkerFunc(
func(req *configs.ModuleRequest) (*configs.Module, *version.Version, hcl.Diagnostics) {
var diags hcl.Diagnostics
@ -273,9 +273,15 @@ func (i *ModuleInstaller) installDescendentModules(ctx context.Context, rootMod
// of addrs.ModuleSource.
panic(fmt.Sprintf("unsupported module source address %#v", addr))
}
},
))
)
}
func (i *ModuleInstaller) installDescendentModules(rootMod *configs.Module, manifest modsdir.Manifest, installWalker configs.ModuleWalker) (*configs.Config, tfdiags.Diagnostics) {
var diags tfdiags.Diagnostics
cfg, cDiags := configs.BuildConfig(rootMod, installWalker)
diags = diags.Append(cDiags)
err := manifest.WriteSnapshotToDir(i.modsDir)