mirror of
https://github.com/opentofu/opentofu.git
synced 2024-12-28 01:41:48 -06:00
internal/getproviders: Make local directory search a public API
Previously this was available by instantiating a throwaway FilesystemMirrorSource, but that's pretty counter-intuitive for callers that just want to do a one-off scan without retaining any ongoing state. Now we expose SearchLocalDirectory as an exported function, and the FilesystemMirrorSource then uses it as part of its implementation too. Callers that just want to know what's available in a directory can call SearchLocalDirectory directly.
This commit is contained in:
Martin Atkins
parent
c49fd39c2a
commit
283b4d4cad
@ -1,13 +1,6 @@
|
||||
package getproviders
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
svchost "github.com/hashicorp/terraform-svchost"
|
||||
"github.com/hashicorp/terraform/addrs"
|
||||
)
|
||||
|
||||
@ -112,187 +105,17 @@ func (s *FilesystemMirrorSource) scanAllVersions() error {
|
||||
// if we found nothing during the scan.
|
||||
return nil
|
||||
}
|
||||
ret := make(map[addrs.Provider]PackageMetaList)
|
||||
err := filepath.Walk(s.baseDir, func(fullPath string, info os.FileInfo, err error) error {
|
||||
if err != nil {
|
||||
return fmt.Errorf("cannot search %s: %s", fullPath, err)
|
||||
}
|
||||
|
||||
// There are two valid directory structures that we support here...
|
||||
// Unpacked: registry.terraform.io/hashicorp/aws/2.0.0/linux_amd64 (a directory)
|
||||
// Packed: registry.terraform.io/hashicorp/aws/terraform-provider-aws_2.0.0_linux_amd64.zip (a file)
|
||||
//
|
||||
// Both of these give us enough information to identify the package
|
||||
// metadata.
|
||||
fsPath, err := filepath.Rel(s.baseDir, fullPath)
|
||||
if err != nil {
|
||||
// This should never happen because the filepath.Walk contract is
|
||||
// for the paths to include the base path.
|
||||
log.Printf("[TRACE] FilesystemMirrorSource: ignoring malformed path %q during walk: %s", fullPath, err)
|
||||
return nil
|
||||
}
|
||||
relPath := filepath.ToSlash(fsPath)
|
||||
parts := strings.Split(relPath, "/")
|
||||
|
||||
if len(parts) < 3 {
|
||||
// Likely a prefix of a valid path, so we'll ignore it and visit
|
||||
// the full valid path on a later call.
|
||||
return nil
|
||||
}
|
||||
|
||||
hostnameGiven := parts[0]
|
||||
namespace := parts[1]
|
||||
typeName := parts[2]
|
||||
|
||||
hostname, err := svchost.ForComparison(hostnameGiven)
|
||||
if err != nil {
|
||||
log.Printf("[WARN] local provider path %q contains invalid hostname %q; ignoring", fullPath, hostnameGiven)
|
||||
return nil
|
||||
}
|
||||
var providerAddr addrs.Provider
|
||||
if namespace == addrs.LegacyProviderNamespace {
|
||||
if hostname != addrs.DefaultRegistryHost {
|
||||
log.Printf("[WARN] local provider path %q indicates a legacy provider not on the default registry host; ignoring", fullPath)
|
||||
return nil
|
||||
}
|
||||
providerAddr = addrs.NewLegacyProvider(typeName)
|
||||
} else {
|
||||
providerAddr = addrs.NewProvider(hostname, namespace, typeName)
|
||||
}
|
||||
|
||||
switch len(parts) {
|
||||
case 5: // Might be unpacked layout
|
||||
if !info.IsDir() {
|
||||
return nil // packed layout requires a directory
|
||||
}
|
||||
|
||||
versionStr := parts[3]
|
||||
version, err := ParseVersion(versionStr)
|
||||
if err != nil {
|
||||
log.Printf("[WARN] ignoring local provider path %q with invalid version %q: %s", fullPath, versionStr, err)
|
||||
return nil
|
||||
}
|
||||
|
||||
platformStr := parts[4]
|
||||
platform, err := ParsePlatform(platformStr)
|
||||
if err != nil {
|
||||
log.Printf("[WARN] ignoring local provider path %q with invalid platform %q: %s", fullPath, platformStr, err)
|
||||
return nil
|
||||
}
|
||||
|
||||
log.Printf("[TRACE] FilesystemMirrorSource: found %s v%s for %s at %s", providerAddr, version, platform, fullPath)
|
||||
|
||||
meta := PackageMeta{
|
||||
Provider: providerAddr,
|
||||
Version: version,
|
||||
|
||||
// FIXME: How do we populate this?
|
||||
ProtocolVersions: nil,
|
||||
TargetPlatform: platform,
|
||||
|
||||
// Because this is already unpacked, the filename is synthetic
|
||||
// based on the standard naming scheme.
|
||||
Filename: fmt.Sprintf("terraform-provider-%s_%s_%s.zip", providerAddr.Type, version, platform),
|
||||
Location: PackageLocalDir(fullPath),
|
||||
|
||||
// FIXME: What about the SHA256Sum field? As currently specified
|
||||
// it's a hash of the zip file, but this thing is already
|
||||
// unpacked and so we don't have the zip file to hash.
|
||||
}
|
||||
ret[providerAddr] = append(ret[providerAddr], meta)
|
||||
|
||||
case 4: // Might be packed layout
|
||||
if info.IsDir() {
|
||||
return nil // packed layout requires a file
|
||||
}
|
||||
|
||||
filename := filepath.Base(fsPath)
|
||||
// the filename components are matched case-insensitively, and
|
||||
// the normalized form of them is in lowercase so we'll convert
|
||||
// to lowercase for comparison here. (This normalizes only for case,
|
||||
// because that is the primary constraint affecting compatibility
|
||||
// between filesystem implementations on different platforms;
|
||||
// filenames are expected to be pre-normalized and valid in other
|
||||
// regards.)
|
||||
normFilename := strings.ToLower(filename)
|
||||
|
||||
// In the packed layout, the version number and target platform
|
||||
// are derived from the package filename, but only if the
|
||||
// filename has the expected prefix identifying it as a package
|
||||
// for the provider in question, and the suffix identifying it
|
||||
// as a zip file.
|
||||
prefix := "terraform-provider-" + providerAddr.Type + "_"
|
||||
const suffix = ".zip"
|
||||
if !strings.HasPrefix(normFilename, prefix) {
|
||||
log.Printf("[WARN] ignoring file %q as possible package for %s: lacks expected prefix %q", filename, providerAddr, prefix)
|
||||
return nil
|
||||
}
|
||||
if !strings.HasSuffix(normFilename, suffix) {
|
||||
log.Printf("[WARN] ignoring file %q as possible package for %s: lacks expected suffix %q", filename, providerAddr, suffix)
|
||||
return nil
|
||||
}
|
||||
|
||||
// Extract the version and target part of the filename, which
|
||||
// will look like "2.1.0_linux_amd64"
|
||||
infoSlice := normFilename[len(prefix) : len(normFilename)-len(suffix)]
|
||||
infoParts := strings.Split(infoSlice, "_")
|
||||
if len(infoParts) < 3 {
|
||||
log.Printf("[WARN] ignoring file %q as possible package for %s: filename does not include version number, target OS, and target architecture", filename, providerAddr)
|
||||
return nil
|
||||
}
|
||||
|
||||
versionStr := infoParts[0]
|
||||
version, err := ParseVersion(versionStr)
|
||||
if err != nil {
|
||||
log.Printf("[WARN] ignoring local provider path %q with invalid version %q: %s", fullPath, versionStr, err)
|
||||
return nil
|
||||
}
|
||||
|
||||
// We'll reassemble this back into a single string just so we can
|
||||
// easily re-use our existing parser and its normalization rules.
|
||||
platformStr := infoParts[1] + "_" + infoParts[2]
|
||||
platform, err := ParsePlatform(platformStr)
|
||||
if err != nil {
|
||||
log.Printf("[WARN] ignoring local provider path %q with invalid platform %q: %s", fullPath, platformStr, err)
|
||||
return nil
|
||||
}
|
||||
|
||||
log.Printf("[TRACE] FilesystemMirrorSource: found %s v%s for %s at %s", providerAddr, version, platform, fullPath)
|
||||
|
||||
meta := PackageMeta{
|
||||
Provider: providerAddr,
|
||||
Version: version,
|
||||
|
||||
// FIXME: How do we populate this?
|
||||
ProtocolVersions: nil,
|
||||
TargetPlatform: platform,
|
||||
|
||||
// Because this is already unpacked, the filename is synthetic
|
||||
// based on the standard naming scheme.
|
||||
Filename: normFilename, // normalized filename, because this field says what it _should_ be called, not what it _is_ called
|
||||
Location: PackageLocalArchive(fullPath), // non-normalized here, because this is the actual physical location
|
||||
|
||||
// TODO: Also populate the SHA256Sum field. Skipping that
|
||||
// for now because our initial uses of this result --
|
||||
// scanning already-installed providers in local directories,
|
||||
// rather than explicit filesystem mirrors -- doesn't do
|
||||
// any hash verification anyway, and this is consistent with
|
||||
// the FIXME in the unpacked case above even though technically
|
||||
// we _could_ populate SHA256Sum here right now.
|
||||
}
|
||||
ret[providerAddr] = append(ret[providerAddr], meta)
|
||||
|
||||
}
|
||||
|
||||
return nil
|
||||
})
|
||||
ret, err := SearchLocalDirectory(s.baseDir)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// Sort the results to be deterministic (aside from semver build metadata)
|
||||
// and consistent with ordering from other functions.
|
||||
for _, l := range ret {
|
||||
l.Sort()
|
||||
|
||||
// As noted above, we use an explicit empty map so we can distinguish a
|
||||
// successful-but-empty result from a failure on future calls, so we'll
|
||||
// make sure that's what we have before we assign it here.
|
||||
if ret == nil {
|
||||
ret = make(map[addrs.Provider]PackageMetaList)
|
||||
}
|
||||
s.allPackages = ret
|
||||
return nil
|
||||
|
||||
206
internal/getproviders/filesystem_search.go
Normal file
206
internal/getproviders/filesystem_search.go
Normal file
@ -0,0 +1,206 @@
|
||||
package getproviders
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
"log"
|
||||
"os"
|
||||
"path/filepath"
|
||||
"strings"
|
||||
|
||||
svchost "github.com/hashicorp/terraform-svchost"
|
||||
|
||||
"github.com/hashicorp/terraform/addrs"
|
||||
)
|
||||
|
||||
// SearchLocalDirectory performs an immediate, one-off scan of the given base
|
||||
// directory for provider plugins using the directory structure defined for
|
||||
// FilesystemMirrorSource.
|
||||
//
|
||||
// This is separated to allow other callers, such as the provider plugin cache
|
||||
// management in the "internal/providercache" package, to use the same
|
||||
// directory structure conventions.
|
||||
func SearchLocalDirectory(baseDir string) (map[addrs.Provider]PackageMetaList, error) {
|
||||
ret := make(map[addrs.Provider]PackageMetaList)
|
||||
err := filepath.Walk(baseDir, func(fullPath string, info os.FileInfo, err error) error {
|
||||
if err != nil {
|
||||
return fmt.Errorf("cannot search %s: %s", fullPath, err)
|
||||
}
|
||||
|
||||
// There are two valid directory structures that we support here...
|
||||
// Unpacked: registry.terraform.io/hashicorp/aws/2.0.0/linux_amd64 (a directory)
|
||||
// Packed: registry.terraform.io/hashicorp/aws/terraform-provider-aws_2.0.0_linux_amd64.zip (a file)
|
||||
//
|
||||
// Both of these give us enough information to identify the package
|
||||
// metadata.
|
||||
fsPath, err := filepath.Rel(baseDir, fullPath)
|
||||
if err != nil {
|
||||
// This should never happen because the filepath.Walk contract is
|
||||
// for the paths to include the base path.
|
||||
log.Printf("[TRACE] FilesystemMirrorSource: ignoring malformed path %q during walk: %s", fullPath, err)
|
||||
return nil
|
||||
}
|
||||
relPath := filepath.ToSlash(fsPath)
|
||||
parts := strings.Split(relPath, "/")
|
||||
|
||||
if len(parts) < 3 {
|
||||
// Likely a prefix of a valid path, so we'll ignore it and visit
|
||||
// the full valid path on a later call.
|
||||
return nil
|
||||
}
|
||||
|
||||
hostnameGiven := parts[0]
|
||||
namespace := parts[1]
|
||||
typeName := parts[2]
|
||||
|
||||
hostname, err := svchost.ForComparison(hostnameGiven)
|
||||
if err != nil {
|
||||
log.Printf("[WARN] local provider path %q contains invalid hostname %q; ignoring", fullPath, hostnameGiven)
|
||||
return nil
|
||||
}
|
||||
var providerAddr addrs.Provider
|
||||
if namespace == addrs.LegacyProviderNamespace {
|
||||
if hostname != addrs.DefaultRegistryHost {
|
||||
log.Printf("[WARN] local provider path %q indicates a legacy provider not on the default registry host; ignoring", fullPath)
|
||||
return nil
|
||||
}
|
||||
providerAddr = addrs.NewLegacyProvider(typeName)
|
||||
} else {
|
||||
providerAddr = addrs.NewProvider(hostname, namespace, typeName)
|
||||
}
|
||||
|
||||
switch len(parts) {
|
||||
case 5: // Might be unpacked layout
|
||||
if !info.IsDir() {
|
||||
return nil // packed layout requires a directory
|
||||
}
|
||||
|
||||
versionStr := parts[3]
|
||||
version, err := ParseVersion(versionStr)
|
||||
if err != nil {
|
||||
log.Printf("[WARN] ignoring local provider path %q with invalid version %q: %s", fullPath, versionStr, err)
|
||||
return nil
|
||||
}
|
||||
|
||||
platformStr := parts[4]
|
||||
platform, err := ParsePlatform(platformStr)
|
||||
if err != nil {
|
||||
log.Printf("[WARN] ignoring local provider path %q with invalid platform %q: %s", fullPath, platformStr, err)
|
||||
return nil
|
||||
}
|
||||
|
||||
log.Printf("[TRACE] FilesystemMirrorSource: found %s v%s for %s at %s", providerAddr, version, platform, fullPath)
|
||||
|
||||
meta := PackageMeta{
|
||||
Provider: providerAddr,
|
||||
Version: version,
|
||||
|
||||
// FIXME: How do we populate this?
|
||||
ProtocolVersions: nil,
|
||||
TargetPlatform: platform,
|
||||
|
||||
// Because this is already unpacked, the filename is synthetic
|
||||
// based on the standard naming scheme.
|
||||
Filename: fmt.Sprintf("terraform-provider-%s_%s_%s.zip", providerAddr.Type, version, platform),
|
||||
Location: PackageLocalDir(fullPath),
|
||||
|
||||
// FIXME: What about the SHA256Sum field? As currently specified
|
||||
// it's a hash of the zip file, but this thing is already
|
||||
// unpacked and so we don't have the zip file to hash.
|
||||
}
|
||||
ret[providerAddr] = append(ret[providerAddr], meta)
|
||||
|
||||
case 4: // Might be packed layout
|
||||
if info.IsDir() {
|
||||
return nil // packed layout requires a file
|
||||
}
|
||||
|
||||
filename := filepath.Base(fsPath)
|
||||
// the filename components are matched case-insensitively, and
|
||||
// the normalized form of them is in lowercase so we'll convert
|
||||
// to lowercase for comparison here. (This normalizes only for case,
|
||||
// because that is the primary constraint affecting compatibility
|
||||
// between filesystem implementations on different platforms;
|
||||
// filenames are expected to be pre-normalized and valid in other
|
||||
// regards.)
|
||||
normFilename := strings.ToLower(filename)
|
||||
|
||||
// In the packed layout, the version number and target platform
|
||||
// are derived from the package filename, but only if the
|
||||
// filename has the expected prefix identifying it as a package
|
||||
// for the provider in question, and the suffix identifying it
|
||||
// as a zip file.
|
||||
prefix := "terraform-provider-" + providerAddr.Type + "_"
|
||||
const suffix = ".zip"
|
||||
if !strings.HasPrefix(normFilename, prefix) {
|
||||
log.Printf("[WARN] ignoring file %q as possible package for %s: lacks expected prefix %q", filename, providerAddr, prefix)
|
||||
return nil
|
||||
}
|
||||
if !strings.HasSuffix(normFilename, suffix) {
|
||||
log.Printf("[WARN] ignoring file %q as possible package for %s: lacks expected suffix %q", filename, providerAddr, suffix)
|
||||
return nil
|
||||
}
|
||||
|
||||
// Extract the version and target part of the filename, which
|
||||
// will look like "2.1.0_linux_amd64"
|
||||
infoSlice := normFilename[len(prefix) : len(normFilename)-len(suffix)]
|
||||
infoParts := strings.Split(infoSlice, "_")
|
||||
if len(infoParts) < 3 {
|
||||
log.Printf("[WARN] ignoring file %q as possible package for %s: filename does not include version number, target OS, and target architecture", filename, providerAddr)
|
||||
return nil
|
||||
}
|
||||
|
||||
versionStr := infoParts[0]
|
||||
version, err := ParseVersion(versionStr)
|
||||
if err != nil {
|
||||
log.Printf("[WARN] ignoring local provider path %q with invalid version %q: %s", fullPath, versionStr, err)
|
||||
return nil
|
||||
}
|
||||
|
||||
// We'll reassemble this back into a single string just so we can
|
||||
// easily re-use our existing parser and its normalization rules.
|
||||
platformStr := infoParts[1] + "_" + infoParts[2]
|
||||
platform, err := ParsePlatform(platformStr)
|
||||
if err != nil {
|
||||
log.Printf("[WARN] ignoring local provider path %q with invalid platform %q: %s", fullPath, platformStr, err)
|
||||
return nil
|
||||
}
|
||||
|
||||
log.Printf("[TRACE] FilesystemMirrorSource: found %s v%s for %s at %s", providerAddr, version, platform, fullPath)
|
||||
|
||||
meta := PackageMeta{
|
||||
Provider: providerAddr,
|
||||
Version: version,
|
||||
|
||||
// FIXME: How do we populate this?
|
||||
ProtocolVersions: nil,
|
||||
TargetPlatform: platform,
|
||||
|
||||
// Because this is already unpacked, the filename is synthetic
|
||||
// based on the standard naming scheme.
|
||||
Filename: normFilename, // normalized filename, because this field says what it _should_ be called, not what it _is_ called
|
||||
Location: PackageLocalArchive(fullPath), // non-normalized here, because this is the actual physical location
|
||||
|
||||
// TODO: Also populate the SHA256Sum field. Skipping that
|
||||
// for now because our initial uses of this result --
|
||||
// scanning already-installed providers in local directories,
|
||||
// rather than explicit filesystem mirrors -- doesn't do
|
||||
// any hash verification anyway, and this is consistent with
|
||||
// the FIXME in the unpacked case above even though technically
|
||||
// we _could_ populate SHA256Sum here right now.
|
||||
}
|
||||
ret[providerAddr] = append(ret[providerAddr], meta)
|
||||
|
||||
}
|
||||
|
||||
return nil
|
||||
})
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
// Sort the results to be deterministic (aside from semver build metadata)
|
||||
// and consistent with ordering from other functions.
|
||||
for _, l := range ret {
|
||||
l.Sort()
|
||||
}
|
||||
return ret, nil
|
||||
}
|
||||
Loading…
Reference in New Issue
Block a user