-
Notifications
You must be signed in to change notification settings - Fork 493
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #505 from patilpankaj212/remote-module-support
support for terraform registry remote modules
- Loading branch information
Showing
7 changed files
with
490 additions
and
1 deletion.
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| #file added for fix for #418 | ||
|
|
||
| # source https://registry.terraform.io/ | ||
|
|
||
| module "network" { | ||
| source = "Azure/network/azurerm" | ||
| version = "3.2.1" | ||
| } | ||
|
|
||
| module "eks" { | ||
| source = "terraform-aws-modules/eks/aws" | ||
| } | ||
|
|
||
| ## contains local modules | ||
| module "rds" { | ||
| source = "terraform-aws-modules/rds/aws" | ||
| version = "2.20.0" | ||
| } |
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
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
150 changes: 150 additions & 0 deletions
150
pkg/iac-providers/terraform/commons/remote-module-download.go
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,150 @@ | ||
| /* | ||
| Copyright (C) 2020 Accurics, Inc. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package commons | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "path/filepath" | ||
|
|
||
| version "github.com/hashicorp/go-version" | ||
| hclConfigs "github.com/hashicorp/terraform/configs" | ||
| "github.com/hashicorp/terraform/registry" | ||
| "github.com/hashicorp/terraform/registry/regsrc" | ||
| "github.com/hashicorp/terraform/registry/response" | ||
| "go.uber.org/zap" | ||
| ) | ||
|
|
||
| // DownloadRemoteModule will download remote modules from public and private terraform registries | ||
| // this function takes similar approach taken by terraform init for downloading terraform registry modules | ||
| func (r *RemoteModuleInstaller) DownloadRemoteModule(requiredVersion hclConfigs.VersionConstraint, destPath string, module *regsrc.Module) (string, error) { | ||
| // Terraform doesn't allow the hostname to contain Punycode | ||
| // module.SvcHost returns an error for such case | ||
| _, err := module.SvcHost() | ||
| if err != nil { | ||
| zap.S().Errorf("hostname for the module %s is invalid", module.String()) | ||
| return "", err | ||
| } | ||
|
|
||
| // get terraform registry client. | ||
| // terraform registry client provides methods for querying the terraform module registry | ||
| regClient := registry.NewClient(nil, nil) | ||
|
|
||
| // get all the available module versions from the terraform registry | ||
| moduleVersions, err := regClient.ModuleVersions(module) | ||
| if err != nil { | ||
| if registry.IsModuleNotFound(err) { | ||
| zap.S().Errorf("module: %s, not be found at registry: %s", module.String(), module.Host().Display()) | ||
| } else { | ||
| zap.S().Errorf("error while fetching available modules for module: %s, at registry: %s", module.String(), module.Host().Display()) | ||
| } | ||
| return "", err | ||
| } | ||
|
|
||
| // get the version to download | ||
| versionToDownload, err := getVersionToDownload(moduleVersions, requiredVersion, module) | ||
| if err != nil { | ||
| zap.S().Error("error while fetching the version to download,", zap.Error(err)) | ||
| return "", err | ||
| } | ||
|
|
||
| // get the source location for the matched version | ||
| sourceLocation, err := regClient.ModuleLocation(module, versionToDownload.String()) | ||
| if err != nil { | ||
| zap.S().Errorf("error while getting the source location for module: %s, at registry: %s", module.String(), module.Host().Display()) | ||
| return "", err | ||
| } | ||
|
|
||
| downloadLocation, err := r.DownloadModule(sourceLocation, destPath) | ||
| if err != nil { | ||
| zap.S().Errorf("error while downloading module: %s, with source location: %s", module.String(), sourceLocation) | ||
| return "", nil | ||
| } | ||
|
|
||
| if module.RawSubmodule != "" { | ||
| // Append the user's requested subdirectory | ||
| downloadLocation = filepath.Join(downloadLocation, module.RawSubmodule) | ||
| } | ||
|
|
||
| return downloadLocation, nil | ||
| } | ||
|
|
||
| // helper func to compare and update the version | ||
| func getGreaterVersion(latestVersion *version.Version, currentVersion *version.Version) *version.Version { | ||
| if latestVersion == nil || currentVersion.GreaterThan(latestVersion) { | ||
| latestVersion = currentVersion | ||
| } | ||
| return latestVersion | ||
| } | ||
|
|
||
| // helper func to get the module version to download | ||
| func getVersionToDownload(moduleVersions *response.ModuleVersions, requiredVersion hclConfigs.VersionConstraint, module *regsrc.Module) (*version.Version, error) { | ||
| // terraform init command pulls all the available versions of a module, | ||
| // and downloads the latest non pre-release (unless a pre-release version was | ||
| // specified in tf file) version, if a version constraint is not provided in the tf file. | ||
| // we are following what terraform does | ||
| allModules := moduleVersions.Modules[0] | ||
|
|
||
| var latestMatch *version.Version | ||
| var latestVersion *version.Version | ||
| var versionToDownload *version.Version | ||
| for _, moduleVersion := range allModules.Versions { | ||
| currentVersion, err := version.NewVersion(moduleVersion.Version) | ||
| if err != nil { | ||
| // if error is received for a version, then skip the current version | ||
| zap.S().Errorf("invalid version: %s, for module: %s, at registry: %s", moduleVersion.Version, module.String(), module.Host().Display()) | ||
| continue | ||
| } | ||
|
|
||
| if requiredVersion.Required == nil { | ||
| // skip the pre release version | ||
| if currentVersion.Prerelease() != "" { | ||
| continue | ||
| } | ||
|
|
||
| // update the latest version | ||
| latestVersion = getGreaterVersion(latestVersion, currentVersion) | ||
| } else { | ||
| // skip the pre-release version, unless specified in the tf file | ||
| if currentVersion.Prerelease() != "" && requiredVersion.Required.String() != currentVersion.String() { | ||
| continue | ||
| } | ||
|
|
||
| // update the latest version | ||
| latestVersion = getGreaterVersion(latestVersion, currentVersion) | ||
|
|
||
| // update latest match | ||
| if requiredVersion.Required.Check(currentVersion) { | ||
| latestMatch = getGreaterVersion(latestMatch, currentVersion) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| if latestVersion == nil { | ||
| return nil, fmt.Errorf("no versions for module: %s, found at registry: %s", module.String(), module.Host().Display()) | ||
| } | ||
|
|
||
| if requiredVersion.Required != nil && latestMatch == nil { | ||
| return nil, fmt.Errorf("no versions matching: %s, for module: %s, found at registry: %s, latest version found: %s", requiredVersion.Required.String(), module.String(), module.Host().Display(), latestVersion.String()) | ||
| } | ||
|
|
||
| versionToDownload = latestVersion | ||
| if latestMatch != nil { | ||
| versionToDownload = latestMatch | ||
| } | ||
|
|
||
| return versionToDownload, nil | ||
| } |
Oops, something went wrong.