From de8bcfa0d2444e463de05eeb565ac92bfc93f6dd Mon Sep 17 00:00:00 2001 From: Daniel-GrunbergerCA Date: Wed, 27 Oct 2021 14:44:25 +0300 Subject: [PATCH] enhance help msgs --- cautils/getter/loadpolicy.go | 2 +- clihandler/cmd/control.go | 25 +++++++++++++++---------- clihandler/cmd/framework.go | 6 ++++-- clihandler/cmd/scan.go | 4 ++-- 4 files changed, 22 insertions(+), 15 deletions(-) diff --git a/cautils/getter/loadpolicy.go b/cautils/getter/loadpolicy.go index cd667b5b..e71451d5 100644 --- a/cautils/getter/loadpolicy.go +++ b/cautils/getter/loadpolicy.go @@ -40,7 +40,7 @@ func (lp *LoadPolicy) GetControl(controlName string) (*reporthandling.Control, e return control, err } if controlName != "" && !strings.EqualFold(controlName, control.Name) && !strings.EqualFold(controlName, control.ControlID) { - framework, err := lp.GetFramework(control.PortalBase.Name) + framework, err := lp.GetFramework(controlName) if err != nil { return nil, fmt.Errorf("control from file not matching") } else { diff --git a/clihandler/cmd/control.go b/clihandler/cmd/control.go index f5911b1d..18a18853 100644 --- a/clihandler/cmd/control.go +++ b/clihandler/cmd/control.go @@ -13,7 +13,7 @@ import ( // controlCmd represents the control command var controlCmd = &cobra.Command{ - Use: "control /.\nExamples:\nscan control C-0058,C-0057 [flags]\nscan contol C-0058 [flags]\nscan control 'privileged container,allowed hostpath' [flags]", + Use: "control /.\nExamples:\n$ kubescape scan control C-0058,C-0057 [flags]\n$ kubescape scan contol C-0058 [flags]\n$ kubescape scan control 'privileged container,allowed hostpath' [flags]", Short: fmt.Sprintf("The control you wish to use for scan. It must be present in at least one of the folloiwng frameworks: %s", clihandler.ValidFrameworks), Args: func(cmd *cobra.Command, args []string) error { if len(args) > 0 { @@ -23,6 +23,8 @@ var controlCmd = &cobra.Command{ return fmt.Errorf("usage: ,") } } + } else { + return fmt.Errorf("requires at least one control name") } return nil }, @@ -30,23 +32,18 @@ var controlCmd = &cobra.Command{ flagValidationControl() scanInfo.PolicyIdentifier = []reporthandling.PolicyIdentifier{} - if len(args) < 1 && !(cmd.Flags().Lookup("use-from").Changed) { + if len(args) < 1 { scanInfo.PolicyIdentifier = SetScanForGivenFrameworks(clihandler.SupportedFrameworks) } else { var controls []string if len(args) > 0 { controls = strings.Split(args[0], ",") scanInfo.PolicyIdentifier = []reporthandling.PolicyIdentifier{} - newPolicy := reporthandling.PolicyIdentifier{} - newPolicy.Kind = reporthandling.KindControl - newPolicy.Name = controls[0] - scanInfo.PolicyIdentifier = append(scanInfo.PolicyIdentifier, newPolicy) + scanInfo.PolicyIdentifier = setScanForFirstControl(controls) } - if !(cmd.Flags().Lookup("use-from").Changed) { - if len(controls) > 1 { - scanInfo.PolicyIdentifier = SetScanForGivenControls(controls[1:]) - } + if len(controls) > 1 { + scanInfo.PolicyIdentifier = SetScanForGivenControls(controls[1:]) } } scanInfo.FrameworkScan = false @@ -73,6 +70,14 @@ func flagValidationControl() { } } +func setScanForFirstControl(controls []string) []reporthandling.PolicyIdentifier { + newPolicy := reporthandling.PolicyIdentifier{} + newPolicy.Kind = reporthandling.KindControl + newPolicy.Name = controls[0] + scanInfo.PolicyIdentifier = append(scanInfo.PolicyIdentifier, newPolicy) + return scanInfo.PolicyIdentifier +} + func SetScanForGivenControls(controls []string) []reporthandling.PolicyIdentifier { for _, control := range controls { control := strings.TrimLeft(control, " ") diff --git a/clihandler/cmd/framework.go b/clihandler/cmd/framework.go index bac9d768..9b75e224 100644 --- a/clihandler/cmd/framework.go +++ b/clihandler/cmd/framework.go @@ -13,7 +13,7 @@ import ( ) var frameworkCmd = &cobra.Command{ - Use: fmt.Sprintf("framework [``/`-`] [flags]\nExamples:\nscan framework nsa [flags]\nscanframework mitre,nsa [flags]\nSupported frameworks: %s", clihandler.ValidFrameworks), + Use: fmt.Sprintf("framework [``/`-`] [flags]\nExamples:\n$ kubescape scan framework nsa [flags]\n$ kubescape scan framework mitre,nsa [flags]\n$ kubescape scan framework 'nsa, mitre' [flags]\nSupported frameworks: %s", clihandler.ValidFrameworks), Short: fmt.Sprintf("The framework you wish to use. Supported frameworks: %s", strings.Join(clihandler.SupportedFrameworks, ", ")), Long: "Execute a scan on a running Kubernetes cluster or `yaml`/`json` files (use glob) or `-` for stdin", ValidArgs: clihandler.SupportedFrameworks, @@ -26,6 +26,8 @@ var frameworkCmd = &cobra.Command{ return fmt.Errorf(fmt.Sprintf("supported frameworks: %s", strings.Join(clihandler.SupportedFrameworks, ", "))) } } + } else { + return fmt.Errorf("requires at least one framework name") } return nil }, @@ -33,7 +35,7 @@ var frameworkCmd = &cobra.Command{ flagValidationFramework() scanInfo.PolicyIdentifier = []reporthandling.PolicyIdentifier{} // If no framework provided, use all - if len(args) < 1 && !(cmd.Flags().Lookup("use-from").Changed) { + if len(args) < 1 { scanInfo.PolicyIdentifier = SetScanForGivenFrameworks(clihandler.SupportedFrameworks) } else { // Read frameworks from input args diff --git a/clihandler/cmd/scan.go b/clihandler/cmd/scan.go index 3b16fd0d..f9c2e65b 100644 --- a/clihandler/cmd/scan.go +++ b/clihandler/cmd/scan.go @@ -40,7 +40,7 @@ func init() { scanCmd.PersistentFlags().StringVarP(&scanInfo.Output, "output", "o", "", "Output file. Print output to file and not stdout") scanCmd.PersistentFlags().BoolVarP(&scanInfo.Silent, "silent", "s", false, "Silent progress messages") scanCmd.PersistentFlags().Uint16VarP(&scanInfo.FailThreshold, "fail-threshold", "t", 0, "Failure threshold is the percent bellow which the command fails and returns exit code 1") - scanCmd.PersistentFlags().StringSliceVar(&scanInfo.UseFrom, "use-from", nil, "Load local framework object from specified path. If not used will download latest") - scanCmd.PersistentFlags().BoolVar(&scanInfo.UseDefault, "use-default", false, "Load local framework object from default path. If not used will download latest") + scanCmd.PersistentFlags().StringSliceVar(&scanInfo.UseFrom, "use-from", nil, "Load local policy object from specified path. If not used will download latest") + scanCmd.PersistentFlags().BoolVar(&scanInfo.UseDefault, "use-default", false, "Load local policy object from default path. If not used will download latest") scanCmd.PersistentFlags().StringVar(&scanInfo.UseExceptions, "exceptions", "", "Path to an exceptions obj. If not set will download exceptions from Armo management portal") }