mirror of
https://github.com/turbot/steampipe.git
synced 2025-12-19 18:12:43 -05:00
07782a2b13
- JSON output format has changed to move the rows to under a `rows` property, with timing information under the `metadata` property - Update timing display to show rows returned and rows fetched, as well as adding verbose mode which lists all scans - Use enums for output mode and timing mode - timing is now either `on`, `off` or `verbose` - Bugfix: ensure error is returned from ExecuteSystemClientCall. Closes #4246
94 lines
2.8 KiB
Go
94 lines
2.8 KiB
Go
package parse
|
|
|
|
import (
|
|
"fmt"
|
|
"github.com/hashicorp/hcl/v2"
|
|
"github.com/hashicorp/hcl/v2/gohcl"
|
|
"github.com/hashicorp/hcl/v2/hclsyntax"
|
|
"github.com/turbot/pipe-fittings/hclhelpers"
|
|
"github.com/turbot/steampipe/pkg/constants"
|
|
"github.com/turbot/steampipe/pkg/steampipeconfig/options"
|
|
"github.com/zclconf/go-cty/cty"
|
|
)
|
|
|
|
// DecodeOptions decodes an options block
|
|
func DecodeOptions(block *hcl.Block, overrides ...BlockMappingOverride) (options.Options, hcl.Diagnostics) {
|
|
var diags hcl.Diagnostics
|
|
mapping := defaultOptionsBlockMapping()
|
|
for _, applyOverride := range overrides {
|
|
applyOverride(mapping)
|
|
}
|
|
optionsType := block.Labels[0]
|
|
|
|
destination, ok := mapping[optionsType]
|
|
if !ok {
|
|
diags = append(diags, &hcl.Diagnostic{
|
|
Severity: hcl.DiagError,
|
|
Summary: fmt.Sprintf("Unexpected options type '%s'", block.Labels[0]),
|
|
Subject: hclhelpers.BlockRangePointer(block),
|
|
})
|
|
return nil, diags
|
|
}
|
|
|
|
if timingOptions, ok := destination.(options.CanSetTiming); ok {
|
|
morediags := decodeTimingFlag(block, timingOptions)
|
|
if morediags.HasErrors() {
|
|
diags = append(diags, morediags...)
|
|
return nil, diags
|
|
}
|
|
}
|
|
diags = gohcl.DecodeBody(block.Body, nil, destination)
|
|
if diags.HasErrors() {
|
|
return nil, diags
|
|
}
|
|
|
|
return destination, nil
|
|
}
|
|
|
|
// for Query options block, if timing attribute is set to "verbose", replace with true and set verbose to true
|
|
func decodeTimingFlag(block *hcl.Block, timingOptions options.CanSetTiming) hcl.Diagnostics {
|
|
body := block.Body.(*hclsyntax.Body)
|
|
timingAttribute := body.Attributes["timing"]
|
|
if timingAttribute == nil {
|
|
return nil
|
|
}
|
|
// remove the attribute so subsequent decoding does not see it
|
|
delete(body.Attributes, "timing")
|
|
|
|
val, diags := timingAttribute.Expr.Value(&hcl.EvalContext{
|
|
Variables: map[string]cty.Value{
|
|
constants.ArgOn: cty.StringVal(constants.ArgOn),
|
|
constants.ArgOff: cty.StringVal(constants.ArgOff),
|
|
constants.ArgVerbose: cty.StringVal(constants.ArgVerbose),
|
|
},
|
|
})
|
|
if diags.HasErrors() {
|
|
return diags
|
|
}
|
|
return timingOptions.SetTiming(val.AsString(), timingAttribute.Range())
|
|
|
|
}
|
|
|
|
type OptionsBlockMapping = map[string]options.Options
|
|
|
|
func defaultOptionsBlockMapping() OptionsBlockMapping {
|
|
mapping := OptionsBlockMapping{
|
|
options.DatabaseBlock: &options.Database{},
|
|
options.GeneralBlock: &options.General{},
|
|
options.QueryBlock: &options.Query{},
|
|
options.CheckBlock: &options.Check{},
|
|
options.DashboardBlock: &options.GlobalDashboard{},
|
|
options.PluginBlock: &options.Plugin{},
|
|
}
|
|
return mapping
|
|
}
|
|
|
|
type BlockMappingOverride func(OptionsBlockMapping)
|
|
|
|
// WithOverride overrides the default block mapping for a single block type
|
|
func WithOverride(blockName string, destination options.Options) BlockMappingOverride {
|
|
return func(mapping OptionsBlockMapping) {
|
|
mapping[blockName] = destination
|
|
}
|
|
}
|