Skip to content

fix: Validate provider semantic version #445

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

Merged
roneli merged 3 commits into from
Jan 27, 2022
Merged

fix: Validate provider semantic version #445

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
21c693b
fix: Fail on bad semantic version in config
roneli Jan 27, 2022
d4d0738
linting
roneli Jan 27, 2022
d695664
Update pkg/config/config_parser.go
roneli Jan 27, 2022
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
97 changes: 58 additions & 39 deletions pkg/config/config_parser.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@ import (
"os"
"strings"

"github.com/cloudquery/cloudquery/pkg/policy"

"github.com/creasty/defaults"
"github.com/hashicorp/hcl/v2"
"github.com/hashicorp/hcl/v2/gohcl"
"github.com/spf13/viper"

"github.com/cloudquery/cloudquery/pkg/policy"

"github.com/hashicorp/hcl/v2"
)

func (p *Parser) LoadConfigFromSource(name string, data []byte) (*Config, hcl.Diagnostics) {
Expand Down Expand Up @@ -47,42 +48,9 @@ func (p *Parser) decodeConfig(body hcl.Body, diags hcl.Diagnostics) (*Config, hc
for _, block := range content.Blocks {
switch block.Type {
case "cloudquery":
contentDiags = gohcl.DecodeBody(block.Body, &p.HCLContext, &config.CloudQuery)
diags = append(diags, contentDiags...)
// TODO: decode in a more generic way

if config.CloudQuery.Connection == nil {
config.CloudQuery.Connection = &Connection{
DSN: "",
}
}
if config.CloudQuery.History != nil {
if err := defaults.Set(config.CloudQuery.History); err != nil {
diags = append(diags, &hcl.Diagnostic{Severity: hcl.DiagError, Summary: "failed to set defaults in history"})
}
}

if dsn := viper.GetString("dsn"); dsn != "" {
config.CloudQuery.Connection.DSN = dsn
}
if dir := viper.GetString("plugin-dir"); dir != "." {
if dir == "." {
if dir, err := os.Getwd(); err == nil {
config.CloudQuery.PluginDirectory = dir
}
} else {
config.CloudQuery.PluginDirectory = dir
}
}
if dir := viper.GetString("policy-dir"); dir != "" {
if dir == "." {
if dir, err := os.Getwd(); err != nil {
config.CloudQuery.PolicyDirectory = dir
}
} else {
config.CloudQuery.PolicyDirectory = dir
}
}
cqBlock, cqDiags := decodeCloudQueryBlock(block, &p.HCLContext)
diags = diags.Extend(cqDiags)
config.CloudQuery = cqBlock
case "provider":
cfg, cfgDiags := decodeProviderBlock(block, &p.HCLContext, existingProviders)
diags = append(diags, cfgDiags...)
Expand Down Expand Up @@ -142,3 +110,54 @@ func ReadModuleConfigProfiles(module string, block hcl.Body) (map[string]hcl.Bod
}
return ret, nil
}

func decodeCloudQueryBlock(block *hcl.Block, ctx *hcl.EvalContext) (CloudQuery, hcl.Diagnostics) {
var cq CloudQuery
var diags hcl.Diagnostics
diags = diags.Extend(gohcl.DecodeBody(block.Body, ctx, &cq))

// TODO: decode in a more generic way
if cq.Connection == nil {
cq.Connection = &Connection{
DSN: "",
}
}
if cq.History != nil {
if err := defaults.Set(cq.History); err != nil {
diags = append(diags, &hcl.Diagnostic{Severity: hcl.DiagError, Summary: "failed to set defaults in history"})
}
}
if dsn := viper.GetString("dsn"); dsn != "" {
cq.Connection.DSN = dsn
}
if dir := viper.GetString("plugin-dir"); dir != "." {
if dir == "." {
if dir, err := os.Getwd(); err == nil {
cq.PluginDirectory = dir
}
} else {
cq.PluginDirectory = dir
}
}
if dir := viper.GetString("policy-dir"); dir != "" {
if dir == "." {
if dir, err := os.Getwd(); err == nil {
cq.PolicyDirectory = dir
}
} else {
cq.PolicyDirectory = dir
}
}
// validate provider versions
for _, cp := range cq.Providers {
if cp.Version != "latest" && !strings.HasPrefix(cp.Version, "v") {
diags = append(diags, &hcl.Diagnostic{
Severity: hcl.DiagError,
Summary: fmt.Sprintf("Provider %s version %s is invalid", cp.Name, cp.Version),
Detail: "Please set to 'latest' version or valid semantic versioning starting with vX.Y.Z",
Subject: &block.DefRange,
})
}
}
return cq, diags
}
17 changes: 17 additions & 0 deletions pkg/config/parser_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -144,6 +144,16 @@ provider "aws" {
`
const expectedDuplicateAliasProviderError = "test.hcl:23,3-21: Duplicate Alias; Provider with alias same-aws for provider aws already exists, give it a different alias."

const testBadVersion = `cloudquery {
connection {
dsn = "postgres://postgres:pass@localhost:5432/postgres"
}
provider "test" {
source = "cloudquery"
version = "0.0.0"
}
}`

type Account struct {
ID string `hcl:",label"`
RoleARN string `hcl:"role_arn,optional"`
Expand Down Expand Up @@ -185,6 +195,13 @@ func TestParser_LoadConfigFromSource(t *testing.T) {
}, cfg)
}

func TestParser_BadVersion(t *testing.T) {
p := NewParser()
_, diags := p.LoadConfigFromSource("test.hcl", []byte(testBadVersion))
assert.NotNil(t, diags)
assert.Equal(t, "test.hcl:1,1-11: Provider test version 0.0.0 is invalid; Please set to 'latest' version or valid semantic versioning starting with vX.Y.Z", diags[0].Error())
}

func TestParser_DuplicateProviderNaming(t *testing.T) {
p := NewParser()
_, diags := p.LoadConfigFromSource("test.hcl", []byte(testMultipleProviderConfig))
Expand Down