Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add source details to error message #138

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
+18 −6
Draft

Add source details to error message #138

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9767c44
add source details to error message
austinvalle Jun 12, 2023
ecc44a3
update msg
austinvalle Jun 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 18 additions & 6 deletions internal/plugintest/config.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,34 +44,46 @@ func DiscoverConfig(ctx context.Context, sourceDir string) (*Config, error) {
}

var sources []src.Source
// Upstream hc-install does not provide a String() method to identify the source, store details of each source to contextualize error during `installer.Ensure`
var sourceDetails []string

switch {
case tfPath != "":
logging.HelperResourceTrace(ctx, fmt.Sprintf("Adding potential Terraform CLI source of exact path: %s", tfPath))
sourceDetail := fmt.Sprintf("Terraform CLI source of exact path: %s", tfPath)
sourceDetails = append(sourceDetails, sourceDetail)
logging.HelperResourceTrace(ctx, fmt.Sprintf("Adding potential %s", sourceDetail))

sources = append(sources, &fs.AnyVersion{
ExactBinPath: tfPath,
})
case tfVersion != "":
tfVersion, err := version.NewVersion(tfVersion)

if err != nil {
return nil, fmt.Errorf("invalid Terraform version: %w", err)
}

logging.HelperResourceTrace(ctx, fmt.Sprintf("Adding potential Terraform CLI source of releases.hashicorp.com exact version %q for installation in: %s", tfVersion, tfDir))
sourceDetail := fmt.Sprintf("Terraform CLI source of releases.hashicorp.com exact version %q for installation in: %s", tfVersion, tfDir)
sourceDetails = append(sourceDetails, sourceDetail)
logging.HelperResourceTrace(ctx, fmt.Sprintf("Adding potential %s", sourceDetail))

sources = append(sources, &releases.ExactVersion{
InstallDir: tfDir,
Product: product.Terraform,
Version: tfVersion,
})
default:
logging.HelperResourceTrace(ctx, "Adding potential Terraform CLI source of local filesystem PATH lookup")
logging.HelperResourceTrace(ctx, fmt.Sprintf("Adding potential Terraform CLI source of checkpoint.hashicorp.com latest version for installation in: %s", tfDir))
sourceDetail := "Terraform CLI source of local filesystem PATH lookup"
sourceDetails = append(sourceDetails, sourceDetail)
logging.HelperResourceTrace(ctx, fmt.Sprintf("Adding potential %s", sourceDetail))

sources = append(sources, &fs.AnyVersion{
Product: &product.Terraform,
})

sourceDetail = fmt.Sprintf("Terraform CLI source of checkpoint.hashicorp.com latest version for installation in: %s", tfDir)
sourceDetails = append(sourceDetails, sourceDetail)
logging.HelperResourceTrace(ctx, fmt.Sprintf("Adding potential %s", sourceDetail))

sources = append(sources, &checkpoint.LatestVersion{
InstallDir: tfDir,
Product: product.Terraform,
Expand All @@ -81,7 +93,7 @@ func DiscoverConfig(ctx context.Context, sourceDir string) (*Config, error) {
installer := install.NewInstaller()
tfExec, err := installer.Ensure(context.Background(), sources)
if err != nil {
return nil, fmt.Errorf("failed to find or install Terraform CLI from %+v: %w", sources, err)
return nil, fmt.Errorf("error ensuring Terraform CLI binary: %w - attempted source(s): %v", err, sourceDetails)
}

ctx = logging.TestTerraformPathContext(ctx, tfExec)
Expand Down