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.

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

fix(misconf): load only submodule if it is specified in source #7112

Merged
merged 1 commit into from
Aug 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions pkg/iac/scanners/terraform/parser/resolvers/cache.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ func (r *cacheResolver) Resolve(_ context.Context, _ fs.FS, opt Options) (filesy
return nil, "", "", false, nil
}

src := removeSubdirFromSource(opt.Source)
src, subdir := splitPackageSubdirRaw(opt.Source)
key := cacheKey(src, opt.Version)

opt.Debug("Trying to resolve: %s", key)
Expand All @@ -62,7 +62,7 @@ func (r *cacheResolver) Resolve(_ context.Context, _ fs.FS, opt Options) (filesy
return nil, "", "", true, err
}

return os.DirFS(filepath.Join(cacheDir, key)), opt.OriginalSource, ".", true, nil
return os.DirFS(filepath.Join(cacheDir, key)), opt.OriginalSource, subdir, true, nil
}
return nil, "", "", false, nil
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,10 @@ func TestResolveModuleFromCache(t *testing.T) {
}

tests := []struct {
name string
opts resolvers.Options
firstResolver moduleResolver
name string
opts resolvers.Options
firstResolver moduleResolver
expectedSubdir string
}{
{
name: "registry",
Expand All @@ -32,7 +33,8 @@ func TestResolveModuleFromCache(t *testing.T) {
Source: "terraform-aws-modules/s3-bucket/aws",
Version: "4.1.2",
},
firstResolver: resolvers.Registry,
firstResolver: resolvers.Registry,
expectedSubdir: ".",
},
{
name: "registry with subdir",
Expand All @@ -41,23 +43,26 @@ func TestResolveModuleFromCache(t *testing.T) {
Source: "terraform-aws-modules/s3-bucket/aws//modules/object",
Version: "4.1.2",
},
firstResolver: resolvers.Registry,
firstResolver: resolvers.Registry,
expectedSubdir: "modules/object",
},
{
name: "remote",
opts: resolvers.Options{
Name: "bucket",
Source: "git::https://github.com/terraform-aws-modules/terraform-aws-s3-bucket.git?ref=v4.1.2",
},
firstResolver: resolvers.Remote,
firstResolver: resolvers.Remote,
expectedSubdir: ".",
},
{
name: "remote with subdir",
opts: resolvers.Options{
Name: "object",
Source: "git::https://github.com/terraform-aws-modules/terraform-aws-s3-bucket.git//modules/object?ref=v4.1.2",
},
firstResolver: resolvers.Remote,
firstResolver: resolvers.Remote,
expectedSubdir: "modules/object",
},
}

Expand Down
2 changes: 1 addition & 1 deletion pkg/iac/scanners/terraform/parser/resolvers/registry.go
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ func (r *registryResolver) Resolve(ctx context.Context, target fs.FS, opt Option
}

inputVersion := opt.Version
source := removeSubdirFromSource(opt.Source)
source, _ := splitPackageSubdirRaw(opt.Source)
parts := strings.Split(source, "/")
if len(parts) < 3 || len(parts) > 4 {
return
Expand Down
4 changes: 2 additions & 2 deletions pkg/iac/scanners/terraform/parser/resolvers/remote.go
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ func (r *remoteResolver) Resolve(ctx context.Context, _ fs.FS, opt Options) (fil
return nil, "", "", false, nil
}

src := removeSubdirFromSource(opt.OriginalSource)
src, subdir := splitPackageSubdirRaw(opt.OriginalSource)
key := cacheKey(src, opt.OriginalVersion)
opt.Debug("Storing with cache key %s", key)

Expand All @@ -54,7 +54,7 @@ func (r *remoteResolver) Resolve(ctx context.Context, _ fs.FS, opt Options) (fil
r.incrementCount(opt)
opt.Debug("Successfully downloaded %s from %s", opt.Name, opt.Source)
opt.Debug("Module '%s' resolved via remote download.", opt.Name)
return os.DirFS(cacheDir), opt.Source, filepath.Join(".", opt.RelativePath), true, nil
return os.DirFS(cacheDir), opt.Source, subdir, true, nil
}

func (r *remoteResolver) download(ctx context.Context, opt Options, dst string) error {
Expand Down
7 changes: 4 additions & 3 deletions pkg/iac/scanners/terraform/parser/resolvers/source.go
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ package resolvers

import "strings"

func removeSubdirFromSource(src string) string {
func splitPackageSubdirRaw(src string) (string, string) {
stop := len(src)
if idx := strings.Index(src, "?"); idx > -1 {
stop = idx
Expand All @@ -18,7 +18,7 @@ func removeSubdirFromSource(src string) string {
// First see if we even have an explicit subdir
idx := strings.Index(src[offset:stop], "//")
if idx == -1 {
return src
return src, "."
}

idx += offset
Expand All @@ -29,8 +29,9 @@ func removeSubdirFromSource(src string) string {
// URL.
if idx = strings.Index(subdir, "?"); idx > -1 {
query := subdir[idx:]
subdir = subdir[:idx]
src += query
}

return src
return src, subdir
}
42 changes: 24 additions & 18 deletions pkg/iac/scanners/terraform/parser/resolvers/source_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -6,39 +6,45 @@ import (
"github.com/stretchr/testify/assert"
)

func TestRemoveSubdirFromSource(t *testing.T) {
func TestSplitPackageSubdirRaw(t *testing.T) {

tests := []struct {
name string
source string
expected string
name string
source string
expectedPkg string
expectedSubdir string
}{
{
name: "address with scheme and query string",
source: "git::https://github.com/aquasecurity/terraform-modules.git//modules/ecs-service?ref=v0.1.0",
expected: "git::https://github.com/aquasecurity/terraform-modules.git?ref=v0.1.0",
name: "address with scheme and query string",
source: "git::https://github.com/aquasecurity/terraform-modules.git//modules/ecs-service?ref=v0.1.0",
expectedPkg: "git::https://github.com/aquasecurity/terraform-modules.git?ref=v0.1.0",
expectedSubdir: "modules/ecs-service",
},
{
name: "address with scheme",
source: "git::https://github.com/aquasecurity/terraform-modules.git//modules/ecs-service",
expected: "git::https://github.com/aquasecurity/terraform-modules.git",
name: "address with scheme",
source: "git::https://github.com/aquasecurity/terraform-modules.git//modules/ecs-service",
expectedPkg: "git::https://github.com/aquasecurity/terraform-modules.git",
expectedSubdir: "modules/ecs-service",
},
{
name: "registry address",
source: "hashicorp/consul/aws//modules/consul-cluster",
expected: "hashicorp/consul/aws",
name: "registry address",
source: "hashicorp/consul/aws//modules/consul-cluster",
expectedPkg: "hashicorp/consul/aws",
expectedSubdir: "modules/consul-cluster",
},
{
name: "without subdir",
source: `hashicorp/consul/aws`,
expected: `hashicorp/consul/aws`,
name: "without subdir",
source: `hashicorp/consul/aws`,
expectedPkg: `hashicorp/consul/aws`,
expectedSubdir: ".",
},
}

for _, test := range tests {
t.Run(test.name, func(t *testing.T) {
got := removeSubdirFromSource(test.source)
assert.Equal(t, test.expected, got)
pkgAddr, subdir := splitPackageSubdirRaw(test.source)
assert.Equal(t, test.expectedPkg, pkgAddr)
assert.Equal(t, test.expectedSubdir, subdir)
})
}
}