fix wording in logs command (#292)

Author: cx-pedro-lopes

internal/commands/root.go

@@ -175,6 +175,13 @@ func addResultFormatFlag(cmd *cobra.Command, defaultFormat string, otherAvailabl
 		fmt.Sprintf(params.FormatFlagUsageFormat, append(otherAvailableFormats, defaultFormat)))
 }
 
+func markFlagAsRequired(cmd *cobra.Command, flag string) {
+	err := cmd.MarkPersistentFlagRequired(flag)
+	if err != nil {
+		log.Fatal(err)
+	}
+}
+
 func addScanIDFlag(cmd *cobra.Command, helpMsg string) {
 	cmd.PersistentFlags().String(params.ScanIDFlag, "", helpMsg)
 }

internal/commands/scan.go

@@ -92,7 +92,7 @@ func NewScanCommand(
 
 	tagsCmd := scanTagsSubCommand(scansWrapper)
 
-	logsCmd := util.NewLogsCommand(logsWraper)
+	logsCmd := scanLogsSubCommand(logsWraper)
 
 	addFormatFlagToMultipleCommands(
 		[]*cobra.Command{listScansCmd, showScanCmd, workflowScanCmd},
@@ -106,6 +106,24 @@ func NewScanCommand(
 	return scanCmd
 }
 
+func scanLogsSubCommand(logsWrapper wrappers.LogsWrapper) *cobra.Command {
+	logsCmd := &cobra.Command{
+		Use:   "logs",
+		Short: "Download scan log for selected scan type",
+		Long:  "Accepts a scan-id and scan type (sast, kics or sca) and downloads the related scan log",
+		Example: heredoc.Doc(`
+			$ cx scan logs --scan-id <scan Id> --scan-type <sast | sca | kics>
+		`),
+		RunE: runDownloadLogs(logsWrapper),
+	}
+	logsCmd.PersistentFlags().String(commonParams.ScanIDFlag, "", "Scan ID to retrieve log for.")
+	logsCmd.PersistentFlags().String(commonParams.ScanTypeFlag, "", "Scan type to pull log for, ex: sast, kics or sca.")
+	markFlagAsRequired(logsCmd, commonParams.ScanIDFlag)
+	markFlagAsRequired(logsCmd, commonParams.ScanTypeFlag)
+
+	return logsCmd
+}
+
 func scanTagsSubCommand(scansWrapper wrappers.ScansWrapper) *cobra.Command {
 	tagsCmd := &cobra.Command{
 		Use:   "tags",
@@ -1089,6 +1107,19 @@ func runGetTagsCommand(scansWrapper wrappers.ScansWrapper) func(cmd *cobra.Comma
 	}
 }
 
+func runDownloadLogs(logsWrapper wrappers.LogsWrapper) func(*cobra.Command, []string) error {
+	return func(cmd *cobra.Command, _ []string) error {
+		scanID, _ := cmd.Flags().GetString(commonParams.ScanIDFlag)
+		scanType, _ := cmd.Flags().GetString(commonParams.ScanTypeFlag)
+		logText, err := logsWrapper.GetLog(scanID, scanType)
+		if err != nil {
+			return err
+		}
+		fmt.Print(logText)
+		return nil
+	}
+}
+
 type scanView struct {
 	ID        string `format:"name:Scan ID"`
 	ProjectID string `format:"name:Project ID"`