Merge pull request #106 from glours/wording_refactoring

Some minor wording changes in the command and usage message

Author: silvin-lubecki

README.md

@@ -247,17 +247,17 @@ Just try to use the plugin, open a terminal and write the following command:
 $ docker scan
 Usage:    docker scan [OPTIONS] IMAGE
 
-A tool to scan your docker image
+A tool to scan your images
 
 Options:
-      --accept-license    Accept to using a third party scanning provider
+      --accept-license    Accept using a third party scanning provider
       --dependency-tree   Show dependency tree with scan results
       --exclude-base      Exclude base image from vulnerability scanning (requires --file)
-  -f, --file string       Dockerfile associated with image
+  -f, --file string       Dockerfile associated with image, provides more detailed results
       --json              Output results in JSON format
       --login             Authenticate to the scan provider using an optional token (with --token), or web base token if empty
-      --reject-license    Reject to using a third party scanning provider
-      --token string      Authentication token for login to the scan provider
+      --reject-license    Reject using a third party scanning provider
+      --token string      Authentication token to login to the third party scanning provider
       --version           Display version of the scan plugin
 ```
 

cmd/docker-scan/main.go

@@ -75,7 +75,7 @@ func newScanCmd(ctx context.Context, dockerCli command.Cli) *cobra.Command {
 	var flags options
 	cmd := &cobra.Command{
 		Short:       "Docker Scan",
-		Long:        `A tool to scan your docker image`,
+		Long:        `A tool to scan your images`,
 		Use:         "scan [OPTIONS] IMAGE",
 		Annotations: map[string]string{},
 		RunE: func(cmd *cobra.Command, args []string) error {
@@ -89,14 +89,14 @@ func newScanCmd(ctx context.Context, dockerCli command.Cli) *cobra.Command {
 		},
 	}
 	cmd.Flags().BoolVar(&flags.login, "login", false, "Authenticate to the scan provider using an optional token (with --token), or web base token if empty")
-	cmd.Flags().StringVar(&flags.token, "token", "", "Authentication token for login to the scan provider")
+	cmd.Flags().StringVar(&flags.token, "token", "", "Authentication token to login to the third party scanning provider")
 	cmd.Flags().BoolVar(&flags.dependencyTree, "dependency-tree", false, "Show dependency tree with scan results")
 	cmd.Flags().BoolVar(&flags.excludeBase, "exclude-base", false, "Exclude base image from vulnerability scanning (requires --file)")
-	cmd.Flags().StringVarP(&flags.dockerFilePath, "file", "f", "", "Dockerfile associated with image")
+	cmd.Flags().StringVarP(&flags.dockerFilePath, "file", "f", "", "Dockerfile associated with image, provides more detailed results")
 	cmd.Flags().BoolVar(&flags.jsonFormat, "json", false, "Output results in JSON format")
 	cmd.Flags().BoolVar(&flags.showVersion, "version", false, "Display version of the scan plugin")
-	cmd.Flags().BoolVar(&flags.forceOptIn, "accept-license", false, "Accept to using a third party scanning provider")
-	cmd.Flags().BoolVar(&flags.forceOptOut, "reject-license", false, "Reject to using a third party scanning provider")
+	cmd.Flags().BoolVar(&flags.forceOptIn, "accept-license", false, "Accept using a third party scanning provider")
+	cmd.Flags().BoolVar(&flags.forceOptOut, "reject-license", false, "Reject using a third party scanning provider")
 
 	return cmd
 }

e2e/testdata/plugin-usage.golden

@@ -1,18 +1,20 @@
 
 Usage:	docker scan [OPTIONS] IMAGE
 
-A tool to scan your docker image
+A tool to scan your images
 
 Options:
-      --accept-license    Accept to using a third party scanning provider
+      --accept-license    Accept using a third party scanning provider
       --dependency-tree   Show dependency tree with scan results
       --exclude-base      Exclude base image from vulnerability scanning
                           (requires --file)
-  -f, --file string       Dockerfile associated with image
+  -f, --file string       Dockerfile associated with image, provides more
+                          detailed results
       --json              Output results in JSON format
       --login             Authenticate to the scan provider using an
                           optional token (with --token), or web base
                           token if empty
-      --reject-license    Reject to using a third party scanning provider
-      --token string      Authentication token for login to the scan provider
+      --reject-license    Reject using a third party scanning provider
+      --token string      Authentication token to login to the third
+                          party scanning provider
       --version           Display version of the scan plugin

internal/provider/snyk.go

@@ -167,7 +167,11 @@ func (s *snykProvider) Version() (string, error) {
 	cmd.Stdout = buff
 	cmd.Stderr = buffErr
 	if err := cmd.Run(); err != nil {
-		return "", fmt.Errorf("failed to get snyk version: %s, %s", checkCommandErr(err), buffErr.String())
+		errMsg := fmt.Sprintf("failed to get snyk version: %s", checkCommandErr(err))
+		if buffErr.String() != "" {
+			errMsg = fmt.Sprintf(errMsg+",%s", buffErr.String())
+		}
+		return "", fmt.Errorf(errMsg)
 	}
 	return fmt.Sprintf("Snyk (%s)", strings.TrimSpace(buff.String())), nil
 }