commit 6af1ccbdf63b237381457325b73c8baadf0c8038
from: Stefan Sperling <stsp@stsp.name>
date: Fri Aug 16 11:16:50 2019 UTC

sort tree object entries the way git likes it

commit - 1898815031048b5ecb7d11ec849101d030d21d9d
commit + 6af1ccbdf63b237381457325b73c8baadf0c8038
blob - 867b2d236255af662c58302c5e1d984d299dbc85
blob + 2b08ba5d97e69119774c87eb16982e7aa747a436
--- lib/object_create.c
+++ lib/object_create.c
@@ -39,6 +39,7 @@
 #include "got_lib_deflate.h"
 #include "got_lib_delta.h"
 #include "got_lib_object.h"
+#include "got_lib_object_parse.h"
 #include "got_lib_lockfile.h"
 
 #ifndef nitems
@@ -207,11 +208,117 @@ mode2str(char *buf, size_t len, mode_t mode)
 	if (ret == -1 || ret >= len)
 		return got_error(GOT_ERR_NO_SPACE);
 	return NULL;
+}
+
+
+static const struct got_error *
+te_git_name(char **name, struct got_tree_entry *te)
+{
+	const struct got_error *err = NULL;
+
+	if (S_ISDIR(te->mode)) {
+		if (asprintf(name, "%s/", te->name) == -1)
+			err = got_error_from_errno("asprintf");
+	} else {
+		*name = strdup(te->name);
+		if (*name == NULL)
+			err = got_error_from_errno("strdup");
+	}
+	return err;
+}
+
+static const struct got_error *
+insert_tree_entry(struct got_tree_entries *sorted, struct got_tree_entry *new)
+{
+	const struct got_error *err = NULL;
+	struct got_tree_entry *te = NULL, *prev = NULL;
+	char *name;
+	int cmp;
+
+	if (SIMPLEQ_EMPTY(&sorted->head)) {
+		SIMPLEQ_INSERT_HEAD(&sorted->head, new, entry);
+		sorted->nentries++;
+		return NULL;
+	}
+
+	err = te_git_name(&name, new);
+	if (err)
+		return err;
+
+	te = SIMPLEQ_FIRST(&sorted->head);
+	while (te) {
+		char *te_name;
+		if (prev == NULL) {
+			prev = te;
+			te = SIMPLEQ_NEXT(te, entry);
+			continue;
+		}
+		err = te_git_name(&te_name, te);
+		if (err)
+			goto done;
+		cmp = strcmp(te_name, name);
+		free(te_name);
+		if (cmp == 0) {
+			err = got_error(GOT_ERR_TREE_DUP_ENTRY);
+			goto done;
+		}
+		if (cmp > 0) {
+			SIMPLEQ_INSERT_AFTER(&sorted->head, prev, new, entry);
+			sorted->nentries++;
+			break;
+		}
+		prev = te;
+		te = SIMPLEQ_NEXT(te, entry);
+	}
+
+	if (te == NULL) {
+		SIMPLEQ_INSERT_TAIL(&sorted->head, new, entry);
+		sorted->nentries++;
+	}
+done:
+	free(name);
+	return err;
+}
+
+/*
+ * Git expects directory tree entries to be sorted with an imaginary slash
+ * appended to their name, and will break otherwise. Let's be nice.
+ */
+static const struct got_error *
+sort_tree_entries_the_way_git_likes_it(struct got_tree_entries **sorted,
+    struct got_tree_entries *tree_entries)
+{
+	const struct got_error *err = NULL;
+	struct got_tree_entry *te;
+
+	*sorted = malloc(sizeof(**sorted));
+	if (*sorted == NULL)
+		return got_error_from_errno("malloc");
+
+	(*sorted)->nentries = 0;
+	SIMPLEQ_INIT(&(*sorted)->head);
+
+	SIMPLEQ_FOREACH(te, &tree_entries->head, entry) {
+		struct got_tree_entry *new;
+		err = got_object_tree_entry_dup(&new, te);
+		if (err)
+			break;
+		err = insert_tree_entry(*sorted, new);
+		if (err)
+			break;
+	}
+
+	if (err) {
+		free(*sorted);
+		*sorted = NULL;
+	}
+
+	return err;
 }
 
 const struct got_error *
 got_object_tree_create(struct got_object_id **id,
-    struct got_tree_entries *entries, struct got_repository *repo)
+    struct got_tree_entries *tree_entries, struct got_repository *repo)
 {
 	const struct got_error *err = NULL;
 	char modebuf[sizeof("100644 ")];
@@ -219,16 +326,21 @@ got_object_tree_create(struct got_object_id **id,
 	char *header = NULL;
 	size_t headerlen, len = 0, n;
 	FILE *treefile = NULL;
+	struct got_tree_entries *entries; /* sorted according to Git rules */
 	struct got_tree_entry *te;
 
 	*id = NULL;
 
 	SHA1Init(&sha1_ctx);
 
+	err = sort_tree_entries_the_way_git_likes_it(&entries, tree_entries);
+	if (err)
+		return err;
+
 	SIMPLEQ_FOREACH(te, &entries->head, entry) {
 		err = mode2str(modebuf, sizeof(modebuf), te->mode);
 		if (err)
-			return err;
+			goto done;
 		len += strlen(modebuf) + strlen(te->name) + 1 +
 		    SHA1_DIGEST_LENGTH;
 	}
@@ -297,6 +409,8 @@ got_object_tree_create(struct got_object_id **id,
 	err = create_object_file(*id, treefile, repo);
 done:
 	free(header);
+	got_object_tree_entries_close(entries);
+	free(entries);
 	if (treefile && fclose(treefile) != 0 && err == NULL)
 		err = got_error_from_errno("fclose");
 	if (err) {
blob - 337efdca5808b7edb4d64cd7afaaefaa1c1355b7
blob + 451b7e6f6979220b6f28c544d8bac7eeb6380112
--- regress/cmdline/commit.sh
+++ regress/cmdline/commit.sh
@@ -577,8 +577,35 @@ function test_commit_no_email {
 	fi
 	test_done "$testroot" "$ret"
 }
+
+function test_commit_tree_entry_sorting {
+	local testroot=`test_init commit_tree_entry_sorting`
+
+	got checkout $testroot/repo $testroot/wt > /dev/null
+	ret="$?"
+	if [ "$ret" != "0" ]; then
+		test_done "$testroot" "$ret"
+		return 1
+	fi
+
+	# Git's index gets corrupted when tree entries are written in the
+	# order defined by got_path_cmp() rather than Git's own ordering.
+	# Create a new tree where a directory "got" and a file "got-version"
+	# would sort in the wrong order according to Git's opinion.
+	mkdir $testroot/wt/got
+	touch $testroot/wt/got/foo
+	echo foo > $testroot/wt/got-version
+	echo zzz > $testroot/wt/zzz
+	(cd $testroot/wt && got add got-version got/foo zzz > /dev/null)
 
+	(cd $testroot/wt && got commit -m 'test' > /dev/null)
 
+	# Let git-fsck verify the newly written tree to make sure Git is happy
+	(cd $testroot/repo && git fsck --strict  \
+		> $testroot/fsck.stdout 2> $testroot/fsck.stderr)
+	ret="$?"
+	test_done "$testroot" "$ret"
+}
 
 run_test test_commit_basic
 run_test test_commit_new_subdir
@@ -594,3 +621,4 @@ run_test test_commit_dir_path
 run_test test_commit_selected_paths
 run_test test_commit_outside_refs_heads
 run_test test_commit_no_email
+run_test test_commit_tree_entry_sorting