Commit 28cf319f780087bba863715f31d4ec417eb87a6d

Stefan Sperling 2021-01-28T17:06:22

add 'got commit -F' option to commit with a log message stored in a file To avoid accidents commit -F opens the prepared log message in an editor so it can be reviewed before the commit is created. For non-interactive use the -N option is required in addition to -F. ok millert@

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
diff --git a/got/got.1 b/got/got.1
index 5a69c33..1991d42 100644
--- a/got/got.1
+++ b/got/got.1
@@ -1216,7 +1216,7 @@ is a directory.
 .It Cm rv
 Short alias for
 .Cm revert .
-.It Cm commit Oo Fl m Ar message Oc Oo Fl S Oc Op Ar path ...
+.It Cm commit Oo Fl F Ar path Oc Oo Fl m Ar message Oc Oo Fl N Oc Oo Fl S Oc Op Ar path ...
 Create a new commit in the repository from changes in a work tree
 and use this commit as the new base commit for the work tree.
 If no
@@ -1229,6 +1229,17 @@ If changes have been explicitly staged for commit with
 only commit staged changes and reject any specified paths which
 have not been staged.
 .Pp
+.Cm got commit
+opens a temporary file in an editor where a log message can be written
+unless the
+.Fl m
+option is used
+or the
+.Fl F
+and
+.Fl N
+options are used together.
+.Pp
 Show the status of each affected file, using the following status codes:
 .Bl -column YXZ description
 .It M Ta modified file
@@ -1269,13 +1280,28 @@ The options for
 .Cm got commit
 are as follows:
 .Bl -tag -width Ds
+.It Fl F Ar path
+Use the prepared log message stored in the file found at
+.Ar path
+when creating the new commit.
+.Cm got commit
+opens a temporary file in an editor where the prepared log message can be
+reviewed and edited further if needed.
+Cannot be used together with the
+.Fl m
+option.
 .It Fl m Ar message
 Use the specified log message when creating the new commit.
-Without the
-.Fl m
-option,
+Cannot be used together with the
+.Fl F
+option.
+.It Fl N
+This option prevents
 .Cm got commit
-opens a temporary file in an editor where a log message can be written.
+from opening the commit message in an editor.
+It has no effect unless it is used together with the
+.Fl F
+option and is intended for non-interactive use such as scripting.
 .It Fl S
 Allow the addition of symbolic links which point outside of the path space
 that is under version control.
@@ -2126,16 +2152,9 @@ with a pre-defined log message.
 .Pp
 Alternatively, create a new commit from local changes in a work tree
 directory with a log message that has been prepared in the file
-.Pa /tmp/msg .
-If
-.Xr vi 1
-is set as the
-.Ev EDITOR ,
-.Pa /tmp/msg
-can be read into the buffer for review:
+.Pa /tmp/msg:
 .Pp
-.Dl $ got commit
-.Dl :r /tmp/msg
+.Dl $ got commit -F /tmp/msg
 .Pp
 Update any work tree checked out from the
 .Dq unified-buffer-cache
diff --git a/got/got.c b/got/got.c
index f1d6902..7a85d64 100644
--- a/got/got.c
+++ b/got/got.c
@@ -431,7 +431,8 @@ doneediting:
 
 static const struct got_error *
 edit_logmsg(char **logmsg, const char *editor, const char *logmsg_path,
-    const char *initial_content, size_t initial_content_len, int check_comments)
+    const char *initial_content, size_t initial_content_len,
+    int require_modification)
 {
 	const struct got_error *err = NULL;
 	char *line = NULL;
@@ -453,7 +454,8 @@ edit_logmsg(char **logmsg, const char *editor, const char *logmsg_path,
 	if (stat(logmsg_path, &st2) == -1)
 		return got_error_from_errno("stat");
 
-	if (st.st_mtime == st2.st_mtime && st.st_size == st2.st_size)
+	if (require_modification &&
+	    st.st_mtime == st2.st_mtime && st.st_size == st2.st_size)
 		return got_error_msg(GOT_ERR_COMMIT_MSG_EMPTY,
 		    "no changes made to commit message, aborting");
 
@@ -526,7 +528,8 @@ edit_logmsg(char **logmsg, const char *editor, const char *logmsg_path,
 		    "commit message cannot be empty, aborting");
 		goto done;
 	}
-	if (check_comments && strcmp(*logmsg, initial_content_stripped) == 0)
+	if (require_modification &&
+	    strcmp(*logmsg, initial_content_stripped) == 0)
 		err = got_error_msg(GOT_ERR_COMMIT_MSG_EMPTY,
 		    "no changes made to commit message, aborting");
 done:
@@ -6927,13 +6930,15 @@ done:
 __dead static void
 usage_commit(void)
 {
-	fprintf(stderr, "usage: %s commit [-m msg] [-S] [path ...]\n",
-	    getprogname());
+	fprintf(stderr, "usage: %s commit [-F path] [-m msg] [-N] [-S] "
+	    "[path ...]\n", getprogname());
 	exit(1);
 }
 
 struct collect_commit_logmsg_arg {
 	const char *cmdline_log;
+	const char *prepared_log;
+	int non_interactive;
 	const char *editor;
 	const char *worktree_path;
 	const char *branch_name;
@@ -6943,6 +6948,56 @@ struct collect_commit_logmsg_arg {
 };
 
 static const struct got_error *
+read_prepared_logmsg(char **logmsg, const char *path)
+{
+	const struct got_error *err = NULL;
+	FILE *f = NULL;
+	struct stat sb;
+	size_t r;
+
+	*logmsg = NULL;
+	memset(&sb, 0, sizeof(sb));
+
+	f = fopen(path, "r");
+	if (f == NULL)
+		return got_error_from_errno2("fopen", path);
+
+	if (fstat(fileno(f), &sb) == -1) {
+		err = got_error_from_errno2("fstat", path);
+		goto done;
+	}
+	if (sb.st_size == 0) {
+		err = got_error(GOT_ERR_COMMIT_MSG_EMPTY);
+		goto done;
+	}
+
+	*logmsg = malloc(sb.st_size + 1);
+	if (*logmsg == NULL) {
+		err = got_error_from_errno("malloc");
+		goto done;
+	}
+
+	r = fread(*logmsg, 1, sb.st_size, f);
+	if (r != sb.st_size) {
+		if (ferror(f))
+			err = got_error_from_errno2("fread", path);
+		else
+			err = got_error(GOT_ERR_IO);
+		goto done;
+	}
+	(*logmsg)[sb.st_size] = '\0';
+done:
+	if (fclose(f) == EOF && err == NULL)
+		err = got_error_from_errno2("fclose", path);
+	if (err) {
+		free(*logmsg);
+		*logmsg = NULL;
+	}
+	return err;
+	
+}
+
+static const struct got_error *
 collect_commit_logmsg(struct got_pathlist_head *commitable_paths, char **logmsg,
     void *arg)
 {
@@ -6963,20 +7018,36 @@ collect_commit_logmsg(struct got_pathlist_head *commitable_paths, char **logmsg,
 			return got_error_from_errno("malloc");
 		strlcpy(*logmsg, a->cmdline_log, len);
 		return NULL;
-	}
+	} else if (a->prepared_log != NULL && a->non_interactive)
+		return read_prepared_logmsg(logmsg, a->prepared_log);
 
 	if (asprintf(&template, "%s/logmsg", a->worktree_path) == -1)
 		return got_error_from_errno("asprintf");
 
+	err = got_opentemp_named_fd(&a->logmsg_path, &fd, template);
+	if (err)
+		goto done;
+
+	if (a->prepared_log) {
+		char *msg;
+		err = read_prepared_logmsg(&msg, a->prepared_log);
+		if (err)
+			goto done;
+		if (write(fd, msg, strlen(msg)) == -1) {
+			err = got_error_from_errno2("write", a->logmsg_path);
+			free(msg);
+			goto done;
+		}
+		free(msg);
+	}
+
 	initial_content_len = asprintf(&initial_content,
 	    "\n# changes to be committed on branch %s:\n",
 	    a->branch_name);
-	if (initial_content_len == -1)
-		return got_error_from_errno("asprintf");
-
-	err = got_opentemp_named_fd(&a->logmsg_path, &fd, template);
-	if (err)
+	if (initial_content_len == -1) {
+		err = got_error_from_errno("asprintf");
 		goto done;
+	}
 
 	if (write(fd, initial_content, initial_content_len) == -1) {
 		err = got_error_from_errno2("write", a->logmsg_path);
@@ -6991,7 +7062,7 @@ collect_commit_logmsg(struct got_pathlist_head *commitable_paths, char **logmsg,
 	}
 
 	err = edit_logmsg(logmsg, a->editor, a->logmsg_path, initial_content,
-	    initial_content_len, 1);
+	    initial_content_len, a->prepared_log ? 0 : 1);
 done:
 	free(initial_content);
 	free(template);
@@ -7018,20 +7089,34 @@ cmd_commit(int argc, char *argv[])
 	char *cwd = NULL, *id_str = NULL;
 	struct got_object_id *id = NULL;
 	const char *logmsg = NULL;
+	char *prepared_logmsg = NULL;
 	struct collect_commit_logmsg_arg cl_arg;
 	char *gitconfig_path = NULL, *editor = NULL, *author = NULL;
 	int ch, rebase_in_progress, histedit_in_progress, preserve_logmsg = 0;
-	int allow_bad_symlinks = 0;
+	int allow_bad_symlinks = 0, non_interactive = 0;
 	struct got_pathlist_head paths;
 
 	TAILQ_INIT(&paths);
 	cl_arg.logmsg_path = NULL;
 
-	while ((ch = getopt(argc, argv, "m:S")) != -1) {
+	while ((ch = getopt(argc, argv, "F:m:NS")) != -1) {
 		switch (ch) {
+		case 'F':
+			if (logmsg != NULL)
+				option_conflict('F', 'm');
+			prepared_logmsg = realpath(optarg, NULL);
+			if (prepared_logmsg == NULL)
+				return got_error_from_errno2("realpath",
+				    optarg);
+			break;
 		case 'm':
+			if (prepared_logmsg)
+				option_conflict('m', 'F');
 			logmsg = optarg;
 			break;
+		case 'N':
+			non_interactive = 1;
+			break;
 		case 'S':
 			allow_bad_symlinks = 1;
 			break;
@@ -7104,6 +7189,8 @@ cmd_commit(int argc, char *argv[])
 
 	cl_arg.editor = editor;
 	cl_arg.cmdline_log = logmsg;
+	cl_arg.prepared_log = prepared_logmsg;
+	cl_arg.non_interactive = non_interactive;
 	cl_arg.worktree_path = got_worktree_get_root_path(worktree);
 	cl_arg.branch_name = got_worktree_get_head_ref_name(worktree);
 	if (!histedit_in_progress) {
@@ -7145,6 +7232,7 @@ done:
 	free(gitconfig_path);
 	free(editor);
 	free(author);
+	free(prepared_logmsg);
 	return error;
 }
 
diff --git a/regress/cmdline/commit.sh b/regress/cmdline/commit.sh
index 1e055a9..3956dc0 100755
--- a/regress/cmdline/commit.sh
+++ b/regress/cmdline/commit.sh
@@ -1357,6 +1357,106 @@ test_commit_fix_bad_symlink() {
 	test_done "$testroot" "0"
 }
 
+test_commit_prepared_logmsg() {
+	local testroot=`test_init commit_prepared_logmsg`
+
+	got checkout $testroot/repo $testroot/wt > /dev/null
+	ret="$?"
+	if [ "$ret" != "0" ]; then
+		test_done "$testroot" "$ret"
+		return 1
+	fi
+
+	echo "modified alpha" > $testroot/wt/alpha
+	(cd $testroot/wt && got rm beta >/dev/null)
+	echo "new file" > $testroot/wt/new
+	(cd $testroot/wt && got add new >/dev/null)
+
+	echo 'test commit_prepared_logmsg' > $testroot/logmsg
+
+	cat > $testroot/editor.sh <<EOF
+#!/bin/sh
+sed -i 's/foo/bar/' "\$1"
+EOF
+	chmod +x $testroot/editor.sh
+
+	(cd $testroot/wt && env EDITOR="$testroot/editor.sh" \
+		got commit -F "$testroot/logmsg" > $testroot/stdout)
+
+	local head_rev=`git_show_head $testroot/repo`
+	echo "A  new" > $testroot/stdout.expected
+	echo "M  alpha" >> $testroot/stdout.expected
+	echo "D  beta" >> $testroot/stdout.expected
+	echo "Created commit $head_rev" >> $testroot/stdout.expected
+
+	cmp -s $testroot/stdout.expected $testroot/stdout
+	ret="$?"
+	if [ "$ret" != "0" ]; then
+		diff -u $testroot/stdout.expected $testroot/stdout
+		test_done "$testroot" "$ret"
+		return 1
+	fi
+
+	local author_time=`git_show_author_time $testroot/repo`
+	d=`env TZ=UTC date -r $author_time +"%a %b %e %X %Y UTC"`
+	echo "-----------------------------------------------" > $testroot/stdout.expected
+	echo "commit $head_rev (master)" >> $testroot/stdout.expected
+	echo "from: $GOT_AUTHOR" >> $testroot/stdout.expected
+	echo "date: $d" >> $testroot/stdout.expected
+	echo " " >> $testroot/stdout.expected
+	echo " test commit_prepared_logmsg" >> $testroot/stdout.expected
+	echo " " >> $testroot/stdout.expected
+
+	(cd $testroot/wt && got log -l 1 > $testroot/stdout)
+	cmp -s $testroot/stdout.expected $testroot/stdout
+	ret="$?"
+	if [ "$ret" != "0" ]; then
+		diff -u $testroot/stdout.expected $testroot/stdout
+		test_done "$testroot" "$ret"
+		return 1
+	fi
+
+	echo "modified alpha again" > $testroot/wt/alpha
+
+	echo 'test commit_prepared_logmsg non-interactive' \
+		> $testroot/logmsg
+
+	(cd $testroot/wt && got commit -N -F "$testroot/logmsg" \
+		> $testroot/stdout)
+
+	local head_rev=`git_show_head $testroot/repo`
+	echo "M  alpha" > $testroot/stdout.expected
+	echo "Created commit $head_rev" >> $testroot/stdout.expected
+
+	cmp -s $testroot/stdout.expected $testroot/stdout
+	ret="$?"
+	if [ "$ret" != "0" ]; then
+		diff -u $testroot/stdout.expected $testroot/stdout
+		test_done "$testroot" "$ret"
+		return 1
+	fi
+
+	local author_time=`git_show_author_time $testroot/repo`
+	d=`env TZ=UTC date -r $author_time +"%a %b %e %X %Y UTC"`
+	echo "-----------------------------------------------" \
+		> $testroot/stdout.expected
+	echo "commit $head_rev (master)" >> $testroot/stdout.expected
+	echo "from: $GOT_AUTHOR" >> $testroot/stdout.expected
+	echo "date: $d" >> $testroot/stdout.expected
+	echo " " >> $testroot/stdout.expected
+	echo " test commit_prepared_logmsg non-interactive" \
+		>> $testroot/stdout.expected
+	echo " " >> $testroot/stdout.expected
+
+	(cd $testroot/wt && got log -l 1 > $testroot/stdout)
+	cmp -s $testroot/stdout.expected $testroot/stdout
+	ret="$?"
+	if [ "$ret" != "0" ]; then
+		diff -u $testroot/stdout.expected $testroot/stdout
+	fi
+	test_done "$testroot" "$ret"
+}
+
 test_parseargs "$@"
 run_test test_commit_basic
 run_test test_commit_new_subdir
@@ -1382,3 +1482,4 @@ run_test test_commit_normalizes_filemodes
 run_test test_commit_with_unrelated_submodule
 run_test test_commit_symlink
 run_test test_commit_fix_bad_symlink
+run_test test_commit_prepared_logmsg