feat: Add cbatch --open-mode option (#258)

* Add cbatch ----open-mode function

* Sync proto from backend.

* Refactor.

---------

Co-authored-by: RileyWen <wrllrwwrllrw@gmail.com>

Author: 1daidai1

internal/cbatch/CmdArgParser.go

@@ -48,6 +48,7 @@ var (
 	FlagExport        string
 	FlagStdoutPath    string
 	FlagStderrPath    string
+	FlagOpenMode      string
 
 	FlagWrappedScript string
 
@@ -158,4 +159,5 @@ func init() {
 	RootCmd.Flags().StringVar(&FlagMailUser, "mail-user", "", "Mail address of the notification receiver")
 	RootCmd.Flags().StringVar(&FlagComment, "comment", "", "Comment of the job")
 	RootCmd.Flags().BoolVar(&FlagJson, "json", false, "Output in JSON format")
+	RootCmd.Flags().StringVar(&FlagOpenMode, "open-mode", "", "Set the mode for opening output and error files, supported values: append, truncate (default is truncate) ")
 }

internal/cbatch/cbatch.go

@@ -30,14 +30,15 @@ import (
 
 	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
+	"google.golang.org/protobuf/proto"
 )
 
 type CbatchArg struct {
 	name string
 	val  string
 }
 
-// Merge and validate arguments from the file and the command line,
+// ProcessCbatchArgs Merge and validate arguments from the file and the command line,
 // then return the constructed TaskToCtld.
 func ProcessCbatchArgs(cmd *cobra.Command, args []CbatchArg) (bool, *protos.TaskToCtld) {
 	task := new(protos.TaskToCtld)
@@ -143,6 +144,15 @@ func ProcessCbatchArgs(cmd *cobra.Command, args []CbatchArg) (bool, *protos.Task
 			structExtraFromScript.MailUser = arg.val
 		case "--comment":
 			structExtraFromScript.Comment = arg.val
+		case "--open-mode":
+			if arg.val == util.OpenModeAppend {
+				task.GetBatchMeta().OpenModeAppend = proto.Bool(true)
+			} else if arg.val == util.OpenModeTruncate {
+				task.GetBatchMeta().OpenModeAppend = proto.Bool(false)
+			} else {
+				log.Errorf("--open-mode must be either '%s' or '%s'", util.OpenModeAppend, util.OpenModeTruncate)
+				return false, nil
+			}
 		default:
 			log.Errorf("Invalid argument: unrecognized '%s' is given in the script", arg.name)
 			return false, nil
@@ -235,6 +245,16 @@ func ProcessCbatchArgs(cmd *cobra.Command, args []CbatchArg) (bool, *protos.Task
 	if FlagComment != "" {
 		structExtraFromCli.Comment = FlagComment
 	}
+	if FlagOpenMode != "" {
+		if FlagOpenMode == util.OpenModeAppend {
+			task.GetBatchMeta().OpenModeAppend = proto.Bool(true)
+		} else if FlagOpenMode == util.OpenModeTruncate {
+			task.GetBatchMeta().OpenModeAppend = proto.Bool(false)
+		} else {
+			log.Errorf("--open-mode must be either '%s' or '%s'", util.OpenModeAppend, util.OpenModeTruncate)
+			return false, nil
+		}
+	}
 
 	// Set and check the extra attributes
 	var extraFromCli string
@@ -327,7 +347,7 @@ func SendMultipleRequests(task *protos.TaskToCtld, count uint32) util.CraneCmdEr
 	return util.ErrorSuccess
 }
 
-// Split the job script into two parts: the arguments and the shell script.
+// ParseCbatchScript Split the job script into two parts: the arguments and the shell script.
 func ParseCbatchScript(path string, args *[]CbatchArg, sh *[]string) util.CraneCmdError {
 	file, err := os.Open(path)
 	if err != nil {

internal/util/paramConstraint.go

@@ -0,0 +1,6 @@
+package util
+
+const (
+	OpenModeAppend   = "append"
+	OpenModeTruncate = "truncate"
+)

protos/Crane.proto

@@ -872,4 +872,4 @@ service CraneForeD {
   rpc CrunStream(stream StreamCrunRequest) returns(stream StreamCrunReply);
   rpc TaskIOStream(stream StreamTaskIORequest) returns(stream StreamTaskIOReply);
   rpc QueryTaskIdFromPort(QueryTaskIdFromPortRequest) returns (QueryTaskIdFromPortReply);
-}
+}

protos/PublicDefs.proto

@@ -217,6 +217,7 @@ message TaskToD {
 
 message BatchTaskAdditionalMeta {
   string sh_script = 1;
+  optional bool open_mode_append = 2;
   string output_file_pattern = 3;
   string error_file_pattern = 4;
 }
@@ -337,7 +338,7 @@ message TrimmedPartitionInfo {
 
 message RichError {
   ErrCode code = 1;
-   string description = 2;
+  string description = 2;
 }
 
 enum ErrCode {
@@ -524,4 +525,4 @@ message CranedRemoteMeta {
   string craned_version = 3;
   google.protobuf.Timestamp craned_start_time = 4;
   google.protobuf.Timestamp system_boot_time = 5;
-}
+}