-
Notifications
You must be signed in to change notification settings - Fork 25
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
f473c6b
commit 573f32a
Showing
8 changed files
with
259 additions
and
238 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,197 @@ | ||
| package cmdconfig | ||
|
|
||
| import ( | ||
| "fmt" | ||
| "golang.org/x/exp/maps" | ||
| "strings" | ||
|
|
||
| "github.com/spf13/viper" | ||
| "github.com/turbot/go-kit/helpers" | ||
| "github.com/turbot/pipe-fittings/constants" | ||
| "github.com/turbot/pipe-fittings/modconfig" | ||
| "github.com/turbot/pipe-fittings/workspace" | ||
| "github.com/turbot/steampipe-plugin-sdk/v5/sperr" | ||
| ) | ||
|
|
||
| func ResolveTargets[T modconfig.ModTreeItem](cmdArgs []string, w *workspace.Workspace) ([]modconfig.ModTreeItem, error) { | ||
| if len(cmdArgs) == 0 { | ||
| return nil, nil | ||
| } | ||
|
|
||
| // special case handling for `benchmark run all` | ||
| targets, err := handleAllArg[T](cmdArgs, w) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if targets != nil { | ||
| return targets, nil | ||
| } | ||
| if len(cmdArgs) == 1 { | ||
| return resolveSingleTarget[T](cmdArgs[0], w) | ||
| } | ||
| // the only command which supports multiple targets is benchmark run | ||
| return resolveBenchmarkTargets[T](cmdArgs, w) | ||
| } | ||
|
|
||
| // resolveSingleTarget extracts a single target and (if present) query args from the command line parameters | ||
| // - if no resource type is specified in the name, it is added from the command type | ||
| // - validate the resource type specified in the name matches the command type | ||
| // - verify the resource exists in the workspace | ||
| // - if the command type is 'query', the target may be a query string rather than a resource name | ||
| // in this case, convert into a query and add to workspace (to allow for simple snapshot generation) | ||
| func resolveSingleTarget[T modconfig.ModTreeItem](cmdArg string, w *workspace.Workspace) ([]modconfig.ModTreeItem, error) { | ||
|
|
||
| var target modconfig.ModTreeItem | ||
| var queryArgs *modconfig.QueryArgs | ||
| var err error | ||
| // so there are multiple targets - this must be the benchmark command, so we do not expect any args | ||
| // now try to resolve targets | ||
| // NOTE: we only expect multiple targets for benchmarks which do not support query args | ||
| // however for resilience (and in case this changes), collect query args into a map | ||
|
|
||
| target, queryArgs, err = workspace.ResolveResourceAndArgsFromSQLString[T](cmdArg, w) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if helpers.IsNil(target) { | ||
| return nil, fmt.Errorf("'%s' not found in %s (%s)", cmdArg, w.Mod.Name(), w.Path) | ||
| } | ||
| if queryArgs != nil { | ||
| return nil, sperr.New("benchmarks do not support query args") | ||
| } | ||
|
|
||
| // ok we managed to resolve | ||
|
|
||
| // now check if any args were specified on the command line using the --arg flag | ||
| // if so verify no args were passed in the resource invocation, e.g. query.my_query("val1","val1" | ||
| commandLineQueryArgs, err := getCommandLineQueryArgs() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // so args were passed using --arg | ||
| if !commandLineQueryArgs.Empty() { | ||
| // verify no args were passed in the resource invocation, e.g. query.my_query("val1","val2") | ||
| if queryArgs != nil { | ||
| return nil, sperr.New("both command line args and query invocation args are set") | ||
| } | ||
| } | ||
| // set args for targer | ||
| if queryArgs != nil { | ||
| // if the target is a query provider set the args | ||
| // (if the target is a dashboard, which i snot a query provider, | ||
| // we read the args from viper separately and use to populate the inputs) | ||
| if qp, ok := any(target).(modconfig.QueryProvider); ok { | ||
| qp.SetArgs(queryArgs) | ||
| } | ||
| } | ||
| return []modconfig.ModTreeItem{target}, nil | ||
|
|
||
| } | ||
|
|
||
| func resolveBenchmarkTargets[T modconfig.ModTreeItem](cmdArgs []string, w *workspace.Workspace) ([]modconfig.ModTreeItem, error) { | ||
| var targets []modconfig.ModTreeItem | ||
| // so there are multiple targets - this must be the benchmark command, so we do not expect any args | ||
| // verify T is Benchmark (should be enforced by Cobra) | ||
| var empty T | ||
| if _, isBenchmark := (any(empty)).(*modconfig.Benchmark); !isBenchmark { | ||
| return nil, sperr.New("multiple targets are only supported for benchmarks") | ||
| } | ||
|
|
||
| // now try to resolve targets | ||
| for _, cmdArg := range cmdArgs { | ||
| target, queryArgs, err := workspace.ResolveResourceAndArgsFromSQLString[T](cmdArg, w) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| if helpers.IsNil(target) { | ||
| return nil, fmt.Errorf("'%s' not found in %s (%s)", cmdArgs[0], w.Mod.Name(), w.Path) | ||
| } | ||
| if queryArgs != nil { | ||
| return nil, sperr.New("benchmarks do not support query args") | ||
| } | ||
| targets = append(targets, target) | ||
| } | ||
|
|
||
| return targets, nil | ||
| } | ||
|
|
||
| func handleAllArg[T modconfig.ModTreeItem](args []string, w *workspace.Workspace) ([]modconfig.ModTreeItem, error) { | ||
| isAll := len(args) == 1 && args[0] == "all" | ||
| if !isAll { | ||
| return nil, nil | ||
| } | ||
| var empty T | ||
| if _, isBenchmark := (any(empty)).(*modconfig.Benchmark); !isBenchmark { | ||
| return nil, nil | ||
| } | ||
|
|
||
| // if the arg is "all", we want to execute all _direct_ children of the Mod | ||
| // but NOT children which come from dependency mods | ||
| filter := workspace.ResourceFilter{ | ||
| WherePredicate: func(item modconfig.HclResource) bool { | ||
| mti, ok := item.(modconfig.ModTreeItem) | ||
| if !ok { | ||
| return false | ||
| } | ||
| return mti.GetMod().ShortName == w.Mod.ShortName | ||
| }, | ||
| } | ||
| targetsMap, err := workspace.FilterWorkspaceResourcesOfType[T](w, filter) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| targets := ToModTreeItemSlice(maps.Values(targetsMap)) | ||
|
|
||
| // make a root item to hold the benchmarks | ||
| resolvedItem := modconfig.NewRootBenchmarkWithChildren(w.Mod, targets).(modconfig.ModTreeItem) | ||
|
|
||
| return []modconfig.ModTreeItem{resolvedItem}, nil | ||
|
|
||
| } | ||
|
|
||
| // build a QueryArgs from any args passed using the --args flag | ||
| func getCommandLineQueryArgs() (*modconfig.QueryArgs, error) { | ||
| argTuples := viper.GetStringSlice(constants.ArgArg) | ||
| var res = modconfig.NewQueryArgs() | ||
|
|
||
| if argTuples == nil { | ||
| return res, nil | ||
| } | ||
|
|
||
| for _, argTuple := range argTuples { | ||
| parts := strings.Split(argTuple, "=") | ||
| switch len(parts) { | ||
| case 1: | ||
| // if there is no '=' this must be a positional arg | ||
| if err := res.AddPositionalArgVal(parts[0]); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| case 2: | ||
| argName := parts[0] | ||
| argValue := parts[1] | ||
|
|
||
| if err := res.SetNamedArgVal(argName, argValue); err != nil { | ||
| return nil, err | ||
| } | ||
| default: | ||
| return nil, sperr.New("invalid arg format: %s", argTuple) | ||
| } | ||
| } | ||
| // we should not have both positional and named args | ||
| if len(res.ArgMap) > 0 && len(res.ArgList) > 0 { | ||
| return nil, sperr.New("cannot mix positional and named args") | ||
| } | ||
| return res, nil | ||
|
|
||
| } | ||
|
|
||
| func ToModTreeItemSlice[T modconfig.ModTreeItem](items []T) []modconfig.ModTreeItem { | ||
| var res []modconfig.ModTreeItem | ||
| for _, item := range items { | ||
| res = append(res, item) | ||
| } | ||
| return res | ||
| } |
Oops, something went wrong.