Skip to content

Commit

Permalink
mktree: allow deeper paths in input
Browse files Browse the repository at this point in the history 
Update 'git mktree' to handle entries nested inside of directories (e.g.
'path/to/a/file.txt'). This functionality requires a series of changes:

* In 'sort_and_dedup_tree_entry_array()', remove entries inside of
  directories that come after them in input order.
* Also in 'sort_and_dedup_tree_entry_array()', mark directories that contain
  entries that come after them in input order (e.g., 'folder/' followed by
  'folder/file.txt') as "need to expand".
* In 'add_tree_entry_to_index()', if a tree entry is marked as "need to
  expand", recurse into it with 'read_tree_at()' & 'build_index_from_tree'.
* In 'build_index_from_tree()', if a user-specified tree entry is contained
  within the current iterated entry, return 'READ_TREE_RECURSIVE' to recurse
  into the iterated tree.

Signed-off-by: Victoria Dye <[email protected]>
  • Loading branch information
@vdye
vdye committed Jun 19, 2024
1 parent 4b88f84 commit 46756c4
Show file tree
Hide file tree
Showing 3 changed files with 200 additions and 13 deletions.
5 changes: 5 additions & 0 deletions Documentation/git-mktree.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,11 @@ Higher stages represent conflicted files in an index; this information
cannot be represented in a tree object. The command will fail without
writing the tree if a higher order stage is specified for any entry.

Entries may use full pathnames containing directory separators to specify
entries nested within one or more directories. These entries are inserted
into the appropriate tree in the base tree-ish if one exists. Otherwise,
empty parent trees are created to contain the entries.

The order of the tree entries is normalized by `mktree` so pre-sorting the
input by path is not required. Multiple entries provided with the same path
are deduplicated, with only the last one specified added to the tree.
Expand Down
101 changes: 92 additions & 9 deletions builtin/mktree.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@ struct tree_entry {

/* Internal */
size_t order;
int expand_dir;

unsigned mode;
struct object_id oid;
Expand All @@ -39,6 +40,7 @@ struct tree_entry_array {
struct tree_entry **entries;

struct hashmap df_name_hash;
int has_nested_entries;
};

static int df_name_hash_cmp(const void *cmp_data UNUSED,
Expand Down Expand Up @@ -70,6 +72,13 @@ static void tree_entry_array_push(struct tree_entry_array *arr, struct tree_entr
arr->entries[arr->nr++] = ent;
}

static struct tree_entry *tree_entry_array_pop(struct tree_entry_array *arr)
{
if (!arr->nr)
return NULL;
return arr->entries[--arr->nr];
}

static void tree_entry_array_clear(struct tree_entry_array *arr, int free_entries)
{
if (free_entries) {
Expand Down Expand Up @@ -109,8 +118,10 @@ static void append_to_tree(unsigned mode, struct object_id *oid, const char *pat

if (!verify_path(ent->name, mode))
die(_("invalid path '%s'"), path);
if (strchr(ent->name, '/'))
die("path %s contains slash", path);

/* mark has_nested_entries if needed */
if (!arr->has_nested_entries && strchr(ent->name, '/'))
arr->has_nested_entries = 1;

/* Add trailing slash to dir */
if (S_ISDIR(mode))
Expand Down Expand Up @@ -168,6 +179,46 @@ static void sort_and_dedup_tree_entry_array(struct tree_entry_array *arr)
ignore_mode = 0;
QSORT_S(arr->entries, arr->nr, ent_compare, &ignore_mode);

if (arr->has_nested_entries) {
struct tree_entry_array parent_dir_ents = { 0 };

count = arr->nr;
arr->nr = 0;

/* Remove any entries where one of its parent dirs has a higher 'order' */
for (size_t i = 0; i < count; i++) {
const char *skipped_prefix;
struct tree_entry *parent;
struct tree_entry *curr = arr->entries[i];
int skip_entry = 0;

while ((parent = tree_entry_array_pop(&parent_dir_ents))) {
if (!skip_prefix(curr->name, parent->name, &skipped_prefix))
continue;

/* entry in dir, so we push the parent back onto the stack */
tree_entry_array_push(&parent_dir_ents, parent);

if (parent->order > curr->order)
skip_entry = 1;
else
parent->expand_dir = 1;

break;
}

if (!skip_entry) {
arr->entries[arr->nr++] = curr;
if (S_ISDIR(curr->mode))
tree_entry_array_push(&parent_dir_ents, curr);
} else {
FREE_AND_NULL(curr);
}
}

tree_entry_array_release(&parent_dir_ents, 0);
}

/* Finally, initialize the directory-file conflict hash map */
for (size_t i = 0; i < count; i++) {
struct tree_entry *curr = arr->entries[i];
Expand Down Expand Up @@ -212,15 +263,40 @@ struct build_index_data {
struct index_state istate;
};

static int build_index_from_tree(const struct object_id *oid,
struct strbuf *base, const char *filename,
unsigned mode, void *context);

static int add_tree_entry_to_index(struct build_index_data *data,
struct tree_entry *ent)
{
struct cache_entry *ce;
ce = make_cache_entry(&data->istate, ent->mode, &ent->oid, ent->name, 0, 0);
if (!ce)
return error(_("make_cache_entry failed for path '%s'"), ent->name);
if (ent->expand_dir) {
int ret = 0;
struct pathspec ps = { 0 };
struct tree *subtree = parse_tree_indirect(&ent->oid);
struct strbuf base_path = STRBUF_INIT;
strbuf_add(&base_path, ent->name, ent->len);

if (!subtree)
ret = error(_("not a tree object: %s"), oid_to_hex(&ent->oid));
else if (read_tree_at(the_repository, subtree, &base_path, 0, &ps,
build_index_from_tree, data) < 0)
ret = -1;

strbuf_release(&base_path);
if (ret)
return ret;

} else {
struct cache_entry *ce = make_cache_entry(&data->istate,
ent->mode, &ent->oid,
ent->name, 0, 0);
if (!ce)
return error(_("make_cache_entry failed for path '%s'"), ent->name);

add_index_entry(&data->istate, ce, ADD_CACHE_JUST_APPEND);
}

add_index_entry(&data->istate, ce, ADD_CACHE_JUST_APPEND);
return 0;
}

Expand All @@ -247,10 +323,12 @@ static int build_index_from_tree(const struct object_id *oid,
base_tree_ent->name[base_tree_ent->len - 1] = '/';

while (cbdata->iter.current) {
const char *skipped_prefix;
struct tree_entry *ent = cbdata->iter.current;
int cmp;

int cmp = name_compare(ent->name, ent->len,
base_tree_ent->name, base_tree_ent->len);
cmp = name_compare(ent->name, ent->len,
base_tree_ent->name, base_tree_ent->len);
if (!cmp || cmp < 0) {
tree_entry_iterator_advance(&cbdata->iter);

Expand All @@ -264,6 +342,11 @@ static int build_index_from_tree(const struct object_id *oid,
goto cleanup_and_return;
} else
continue;
} else if (skip_prefix(ent->name, base_tree_ent->name, &skipped_prefix) &&
S_ISDIR(base_tree_ent->mode)) {
/* The entry is in the current traversed tree entry, so we recurse */
result = READ_TREE_RECURSIVE;
goto cleanup_and_return;
}

break;
Expand Down
107 changes: 103 additions & 4 deletions t/t1010-mktree.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -85,12 +85,21 @@ test_expect_success 'mktree with invalid submodule OIDs' '
done
'

test_expect_success 'mktree refuses to read ls-tree -r output (1)' '
test_must_fail git mktree <all
test_expect_success 'mktree reads ls-tree -r output (1)' '
git mktree <all >actual &&
test_cmp tree actual
'

test_expect_success 'mktree refuses to read ls-tree -r output (2)' '
test_must_fail git mktree <all.withsub
test_expect_success 'mktree reads ls-tree -r output (2)' '
git mktree <all.withsub >actual &&
test_cmp tree.withsub actual
'

test_expect_success 'mktree de-duplicates files inside directories' '
git ls-tree $(cat tree) >everything &&
cat <all >top_and_all &&
git mktree <top_and_all >actual &&
test_cmp tree actual
'

test_expect_success 'mktree fails on malformed input' '
Expand Down Expand Up @@ -234,6 +243,50 @@ test_expect_success 'mktree with duplicate entries' '
test_cmp expect actual
'

test_expect_success 'mktree adds entry after nested entry' '
tree_oid=$(cat tree) &&
folder_oid=$(git rev-parse ${tree_oid}:folder) &&
one_oid=$(git rev-parse ${tree_oid}:folder/one) &&
{
printf "040000 tree $folder_oid\tearly\n" &&
printf "100644 blob $one_oid\tearly/one\n" &&
printf "100644 blob $one_oid\tlater\n" &&
printf "040000 tree $EMPTY_TREE\tnew-tree\n" &&
printf "100644 blob $one_oid\tnew-tree/one\n" &&
printf "100644 blob $one_oid\tzzz\n"
} >top.rec &&
git mktree <top.rec >tree.actual &&
{
printf "040000 tree $folder_oid\tearly\n" &&
printf "100644 blob $one_oid\tlater\n" &&
printf "040000 tree $folder_oid\tnew-tree\n" &&
printf "100644 blob $one_oid\tzzz\n"
} >expect &&
git ls-tree $(cat tree.actual) >actual &&
test_cmp expect actual
'

test_expect_success 'mktree inserts entries into directories' '
folder_oid=$(git rev-parse ${tree_oid}:folder) &&
one_oid=$(git rev-parse ${tree_oid}:folder/one) &&
blob_oid=$(git rev-parse ${tree_oid}:before) &&
{
printf "040000 tree $folder_oid\tfolder\n" &&
printf "100644 blob $blob_oid\tfolder/two\n"
} | git mktree >actual &&
{
printf "100644 blob $one_oid\tfolder/one\n" &&
printf "100644 blob $blob_oid\tfolder/two\n"
} >expect &&
git ls-tree -r $(cat actual) >actual &&
test_cmp expect actual
'

test_expect_success 'mktree with base tree' '
tree_oid=$(cat tree) &&
folder_oid=$(git rev-parse ${tree_oid}:folder) &&
Expand Down Expand Up @@ -270,4 +323,50 @@ test_expect_success 'mktree with base tree' '
test_cmp expect actual
'

test_expect_success 'mktree with base tree (deep)' '
tree_oid=$(cat tree) &&
folder_oid=$(git rev-parse ${tree_oid}:folder) &&
before_oid=$(git rev-parse ${tree_oid}:before) &&
folder_one_oid=$(git rev-parse ${tree_oid}:folder/one) &&
head_oid=$(git rev-parse HEAD) &&
{
printf "100755 blob $before_oid\tfolder/before\n" &&
printf "100644 blob $before_oid\tfolder/one.txt\n" &&
printf "160000 commit $head_oid\tfolder/sub\n" &&
printf "040000 tree $folder_oid\tfolder/one\n" &&
printf "040000 tree $folder_oid\tfolder/one/deeper\n"
} >top.append &&
git mktree <top.append $(cat tree) >tree.actual &&
{
printf "100755 blob $before_oid\tfolder/before\n" &&
printf "100644 blob $before_oid\tfolder/one.txt\n" &&
printf "100644 blob $folder_one_oid\tfolder/one/deeper/one\n" &&
printf "100644 blob $folder_one_oid\tfolder/one/one\n" &&
printf "160000 commit $head_oid\tfolder/sub\n"
} >expect &&
git ls-tree -r $(cat tree.actual) -- folder/ >actual &&
test_cmp expect actual
'

test_expect_success 'mktree fails on directory-file conflict' '
tree_oid="$(cat tree)" &&
blob_oid="$(git rev-parse $tree_oid:folder.txt)" &&
{
printf "100644 blob $blob_oid\ttest\n" &&
printf "100644 blob $blob_oid\ttest/deeper\n"
} |
test_must_fail git mktree 2>err &&
test_grep "You have both test and test/deeper" err &&
{
printf "100644 blob $blob_oid\tfolder/one/deeper/deep\n"
} |
test_must_fail git mktree $tree_oid 2>err &&
test_grep "You have both folder/one and folder/one/deeper/deep" err
'

test_done

0 comments on commit 46756c4

Please sign in to comment.