Add support for sending REPLACE commands in test scripts

This is implemented as a modified APPEND command.
Full tests for IMAP REPLACE capability are not part of this commit.
This is needed for Dovecot internal CI testing.

Author: stephanbosch

src/client-state.c

@@ -386,10 +386,11 @@ int imap_client_append_continue(struct imap_client *client)
 	return 0;
 }
 
-int imap_client_append(struct imap_client *client, const char *args, bool add_datetime,
-		       command_callback_t *callback, struct command **cmd_r)
+static int
+imap_client_append_common(struct imap_client *client, string_t *cmd,
+			  const char *args, bool add_datetime,
+			  command_callback_t *callback, struct command **cmd_r)
 {
-	string_t *cmd;
 	time_t t;
 	uoff_t vsize;
 	int tz;
@@ -401,12 +402,6 @@ int imap_client_append(struct imap_client *client, const char *args, bool add_da
 		mailbox_source_get_next(client->storage->source,
 					&vsize, &t, &tz);
 
-	cmd = t_str_new(128);
-	if (client->append_unfinished) {
-		/* MULTIAPPEND contination */
-	} else {
-		str_append(cmd, "APPEND ");
-	}
 	str_append(cmd, args);
 	if (add_datetime)
 		str_printfa(cmd, " \"%s\"", imap_to_datetime_tz(t, tz));
@@ -435,6 +430,36 @@ int imap_client_append(struct imap_client *client, const char *args, bool add_da
 	return imap_client_append_continue(client);
 }
 
+int imap_client_append(struct imap_client *client, const char *args,
+		       bool add_datetime, command_callback_t *callback,
+		       struct command **cmd_r)
+{
+	string_t *cmd = t_str_new(128);
+
+	if (client->append_unfinished) {
+		/* MULTIAPPEND contination */
+	} else {
+		str_append(cmd, "APPEND ");
+	}
+
+	return imap_client_append_common(client, cmd, args, add_datetime,
+					 callback, cmd_r);
+}
+
+int imap_client_replace(struct imap_client *client, bool uid, const char *args,
+			command_callback_t *callback, struct command **cmd_r)
+{
+	string_t *cmd = t_str_new(128);
+
+	i_assert(!client->append_unfinished);
+	if (uid)
+		str_append(cmd, "UID ");
+	str_append(cmd, "REPLACE ");
+
+	return imap_client_append_common(client, cmd, args, FALSE,
+					 callback, cmd_r);
+}
+
 int imap_client_append_full(struct imap_client *client, const char *mailbox,
 			    const char *flags, const char *datetime,
 			    command_callback_t *callback, struct command **cmd_r)

src/client-state.h

@@ -91,6 +91,8 @@ void client_state_add_to_timer(enum client_state state,
 
 int imap_client_append(struct imap_client *client, const char *args, bool add_datetime,
 		       command_callback_t *callback, struct command **cmd_r);
+int imap_client_replace(struct imap_client *client, bool uid, const char *args,
+			command_callback_t *callback, struct command **cmd_r);
 int imap_client_append_full(struct imap_client *client, const char *mailbox,
 			    const char *flags, const char *datetime,
 			    command_callback_t *callback, struct command **cmd_r);

src/test-exec.c

@@ -823,8 +823,8 @@ static bool imap_arg_is_bad(const struct imap_arg *arg)
 }
 
 static bool
-append_has_body(struct test_exec_context *ctx, const char *str_args,
-		unsigned int str_args_len)
+append_has_body(struct test_exec_context *ctx, bool replace,
+		const char *str_args, unsigned int str_args_len)
 {
 	ARRAY_TYPE(imap_arg_list) *arg_list;
 	const struct imap_arg *args;
@@ -839,6 +839,10 @@ append_has_body(struct test_exec_context *ctx, const char *str_args,
 	if (args->type == IMAP_ARG_EOL)
 		return FALSE;
 
+	if (replace)
+		args++;
+	if (args->type == IMAP_ARG_EOL)
+		return FALSE;
 	if (args[1].type == IMAP_ARG_LIST)
 		args++;
 	if (args[1].type == IMAP_ARG_STRING)
@@ -867,10 +871,20 @@ static void test_send_next_command(struct test_exec_context *ctx,
 		(void)imap_client_append_full(client, NULL, NULL, NULL,
 					      test_cmd_callback, &cmd);
 	} else if (str_begins_icase(cmdline, "append ", &args) &&
-		   !append_has_body(ctx, args, strlen(args))) {
+		   !append_has_body(ctx, FALSE, args, strlen(args))) {
 		client->client.state = STATE_APPEND;
 		(void)imap_client_append(client, args, FALSE,
 					 test_cmd_callback, &cmd);
+	} else if (str_begins_icase(cmdline, "replace ", &args) &&
+		   !append_has_body(ctx, TRUE, args, strlen(args))) {
+		client->client.state = STATE_APPEND;
+		(void)imap_client_replace(client, FALSE, args,
+					  test_cmd_callback, &cmd);
+	} else if (str_begins_icase(cmdline, "uid replace ", &args) &&
+		   !append_has_body(ctx, TRUE, args, strlen(args))) {
+		client->client.state = STATE_APPEND;
+		(void)imap_client_replace(client, TRUE, args,
+					  test_cmd_callback, &cmd);
 	} else {
 		if (test_cmd->linenum == 0 ||
 		    strcasecmp(cmdline, "logout") == 0 ||