Fix checkout behavior when its hands are tied So, @nulltoken created a failing test case for checkout that proved to be particularly daunting. If checkout is given only a very limited strategy mask (e.g. just GIT_CHECKOUT_CREATE_MISSING) then it is possible for typechange/rename modifications to leave it unable to complete the request. That's okay, but the existing code did not have enough information not to generate an error (at least for tree/blob conflicts). This led me to a significant reorganization of the code to handle the failing case, but it has three benefits: 1. The test case is handled correctly (I think) 2. The new code should actually be much faster than the old code since I decided to make checkout aware of diff list internals. 3. The progress value accuracy is hugely increased since I added a fourth pass which calculates exactly what work needs to be done before doing anything.
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 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490
diff --git a/src/checkout.c b/src/checkout.c
index b9a5399..e4a397c 100644
--- a/src/checkout.c
+++ b/src/checkout.c
@@ -21,6 +21,7 @@
#include "repository.h"
#include "filter.h"
#include "blob.h"
+#include "diff.h"
struct checkout_diff_data
{
@@ -43,20 +44,23 @@ static int buffer_to_file(
int file_open_flags,
mode_t file_mode)
{
- int fd, error, error_close;
+ int fd, error;
if ((error = git_futils_mkpath2file(path, dir_mode)) < 0)
return error;
- if ((fd = p_open(path, file_open_flags, file_mode)) < 0)
+ if ((fd = p_open(path, file_open_flags, file_mode)) < 0) {
+ giterr_set(GITERR_OS, "Could not open '%s' for writing", path);
return fd;
+ }
- error = p_write(fd, git_buf_cstr(buffer), git_buf_len(buffer));
-
- error_close = p_close(fd);
-
- if (!error)
- error = error_close;
+ if ((error = p_write(fd, git_buf_cstr(buffer), git_buf_len(buffer))) < 0) {
+ giterr_set(GITERR_OS, "Could not write to '%s'", path);
+ (void)p_close(fd);
+ } else {
+ if ((error = p_close(fd)) < 0)
+ giterr_set(GITERR_OS, "Error while closing '%s'", path);
+ }
if (!error &&
(file_mode & 0100) != 0 &&
@@ -160,8 +164,8 @@ static int checkout_submodule(
}
static void report_progress(
- struct checkout_diff_data *data,
- const char *path)
+ struct checkout_diff_data *data,
+ const char *path)
{
if (data->checkout_opts->progress_cb)
data->checkout_opts->progress_cb(
@@ -176,12 +180,19 @@ static int checkout_blob(
const git_diff_file *file)
{
git_blob *blob;
- int error;
+ int error = 0;
git_buf_truncate(data->path, data->workdir_len);
if (git_buf_joinpath(data->path, git_buf_cstr(data->path), file->path) < 0)
return -1;
+ /* If there is a directory where this blob should go, then there is an
+ * existing tree that conflicts with this file, but REMOVE_UNTRACKED must
+ * not have been passed in. Signal to caller with GIT_ENOTFOUND.
+ */
+ if (git_path_isdir(git_buf_cstr(data->path)))
+ return GIT_ENOTFOUND;
+
if ((error = git_blob_lookup(&blob, data->owner, &file->oid)) < 0)
return error;
@@ -197,90 +208,6 @@ static int checkout_blob(
return error;
}
-static int checkout_remove_the_old(
- void *cb_data, const git_diff_delta *delta, float progress)
-{
- struct checkout_diff_data *data = cb_data;
- git_checkout_opts *opts = data->checkout_opts;
-
- GIT_UNUSED(progress);
-
- if ((delta->status == GIT_DELTA_UNTRACKED &&
- (opts->checkout_strategy & GIT_CHECKOUT_REMOVE_UNTRACKED) != 0) ||
- (delta->status == GIT_DELTA_TYPECHANGE &&
- (opts->checkout_strategy & GIT_CHECKOUT_OVERWRITE_MODIFIED) != 0))
- {
- data->error = git_futils_rmdir_r(
- delta->new_file.path,
- git_repository_workdir(data->owner),
- GIT_RMDIR_REMOVE_FILES | GIT_RMDIR_EMPTY_PARENTS);
-
- data->completed_steps++;
- report_progress(data, delta->new_file.path);
- }
-
- return data->error;
-}
-
-static int checkout_create_the_new(
- void *cb_data, const git_diff_delta *delta, float progress)
-{
- int error = 0;
- struct checkout_diff_data *data = cb_data;
- git_checkout_opts *opts = data->checkout_opts;
- bool do_checkout = false, do_notify = false;
-
- GIT_UNUSED(progress);
-
- if (delta->status == GIT_DELTA_MODIFIED ||
- delta->status == GIT_DELTA_TYPECHANGE)
- {
- if ((opts->checkout_strategy & GIT_CHECKOUT_OVERWRITE_MODIFIED) != 0)
- do_checkout = true;
- else if (opts->skipped_notify_cb != NULL)
- do_notify = !data->create_submodules;
- }
- else if (delta->status == GIT_DELTA_DELETED &&
- (opts->checkout_strategy & GIT_CHECKOUT_CREATE_MISSING) != 0)
- do_checkout = true;
-
- if (do_notify) {
- if (opts->skipped_notify_cb(
- delta->old_file.path, &delta->old_file.oid,
- delta->old_file.mode, opts->notify_payload))
- {
- giterr_clear();
- error = GIT_EUSER;
- }
- }
-
- if (do_checkout) {
- bool is_submodule = S_ISGITLINK(delta->old_file.mode);
-
- if (is_submodule) {
- data->found_submodules = true;
- }
-
- if (!is_submodule && !data->create_submodules) {
- error = checkout_blob(data, &delta->old_file);
- data->completed_steps++;
- report_progress(data, delta->old_file.path);
- }
-
- else if (is_submodule && data->create_submodules) {
- error = checkout_submodule(data, &delta->old_file);
- data->completed_steps++;
- report_progress(data, delta->old_file.path);
- }
-
- }
-
- if (error)
- data->error = error;
-
- return error;
-}
-
static int retrieve_symlink_capabilities(git_repository *repo, bool *can_symlink)
{
git_config *cfg;
@@ -324,6 +251,177 @@ static void normalize_options(git_checkout_opts *normalized, git_checkout_opts *
normalized->file_open_flags = O_CREAT | O_TRUNC | O_WRONLY;
}
+enum {
+ CHECKOUT_ACTION__NONE = 0,
+ CHECKOUT_ACTION__REMOVE = 1,
+ CHECKOUT_ACTION__CREATE_BLOB = 2,
+ CHECKOUT_ACTION__CREATE_SUBMODULE = 4,
+ CHECKOUT_ACTION__NOTIFY = 8
+};
+
+static uint32_t checkout_action_for_delta(
+ git_checkout_opts *opts,
+ const git_diff_delta *delta)
+{
+ uint32_t action = CHECKOUT_ACTION__NONE;
+
+ switch (delta->status) {
+ case GIT_DELTA_UNTRACKED:
+ if ((opts->checkout_strategy & GIT_CHECKOUT_REMOVE_UNTRACKED) != 0)
+ action |= CHECKOUT_ACTION__REMOVE;
+ break;
+
+ case GIT_DELTA_TYPECHANGE:
+ if ((opts->checkout_strategy & GIT_CHECKOUT_OVERWRITE_MODIFIED) != 0)
+ action |= CHECKOUT_ACTION__REMOVE | CHECKOUT_ACTION__CREATE_BLOB;
+ else if (opts->skipped_notify_cb != NULL)
+ action = CHECKOUT_ACTION__NOTIFY;
+ break;
+
+ case GIT_DELTA_DELETED:
+ if ((opts->checkout_strategy & GIT_CHECKOUT_CREATE_MISSING) != 0)
+ action |= CHECKOUT_ACTION__CREATE_BLOB;
+ break;
+
+ case GIT_DELTA_MODIFIED:
+ if ((opts->checkout_strategy & GIT_CHECKOUT_OVERWRITE_MODIFIED) != 0)
+ action |= CHECKOUT_ACTION__CREATE_BLOB;
+ else if (opts->skipped_notify_cb != NULL)
+ action = CHECKOUT_ACTION__NOTIFY;
+ break;
+
+ default:
+ break;
+ }
+
+ if ((action & CHECKOUT_ACTION__CREATE_BLOB) != 0 &&
+ S_ISGITLINK(delta->old_file.mode))
+ action = (action & ~CHECKOUT_ACTION__CREATE_BLOB) |
+ CHECKOUT_ACTION__CREATE_SUBMODULE;
+
+ return action;
+}
+
+static int checkout_get_actions(
+ uint32_t **actions_ptr,
+ size_t **counts_ptr,
+ git_diff_list *diff,
+ git_checkout_opts *opts)
+{
+ git_diff_delta *delta;
+ size_t i, *counts;
+ uint32_t *actions;
+
+ *counts_ptr = counts =
+ git__calloc(CHECKOUT_ACTION__NOTIFY, sizeof(size_t));
+ GITERR_CHECK_ALLOC(counts);
+
+ *actions_ptr = actions =
+ git__calloc(diff->deltas.length, sizeof(uint32_t));
+ GITERR_CHECK_ALLOC(actions);
+
+ git_vector_foreach(&diff->deltas, i, delta) {
+ actions[i] = checkout_action_for_delta(opts, delta);
+
+ if (actions[i] & CHECKOUT_ACTION__REMOVE)
+ counts[CHECKOUT_ACTION__REMOVE]++;
+
+ if (actions[i] & CHECKOUT_ACTION__CREATE_BLOB)
+ counts[CHECKOUT_ACTION__CREATE_BLOB]++;
+
+ if (actions[i] & CHECKOUT_ACTION__CREATE_SUBMODULE)
+ counts[CHECKOUT_ACTION__CREATE_SUBMODULE]++;
+
+ if (actions[i] & CHECKOUT_ACTION__NOTIFY)
+ counts[CHECKOUT_ACTION__NOTIFY]++;
+ }
+
+ return 0;
+}
+
+static int checkout_remove_the_old(
+ git_diff_list *diff,
+ unsigned int *actions,
+ struct checkout_diff_data *data)
+{
+ git_diff_delta *delta;
+ size_t i;
+
+ git_vector_foreach(&diff->deltas, i, delta) {
+ if (actions[i] & CHECKOUT_ACTION__REMOVE) {
+ int error = git_futils_rmdir_r(
+ delta->new_file.path, git_buf_cstr(data->path),
+ GIT_RMDIR_REMOVE_FILES | GIT_RMDIR_EMPTY_PARENTS);
+ if (error < 0)
+ return error;
+
+ data->completed_steps++;
+ report_progress(data, delta->new_file.path);
+ }
+ }
+
+ return 0;
+}
+
+static int checkout_create_the_new(
+ git_diff_list *diff,
+ unsigned int *actions,
+ struct checkout_diff_data *data)
+{
+ git_diff_delta *delta;
+ size_t i;
+
+ git_vector_foreach(&diff->deltas, i, delta) {
+ if (actions[i] & CHECKOUT_ACTION__CREATE_BLOB) {
+ int error = checkout_blob(data, &delta->old_file);
+
+ /* ENOTFOUND means unable to create the file because of
+ * an existing parent dir. Probably flags were given
+ * asking to create new blobs without allowing removal
+ * of a conflicting tree (or vice versa).
+ */
+ if (error == GIT_ENOTFOUND)
+ giterr_clear();
+ else if (error < 0)
+ return error;
+
+ data->completed_steps++;
+ report_progress(data, delta->old_file.path);
+ }
+
+ if (actions[i] & CHECKOUT_ACTION__NOTIFY) {
+ if (data->checkout_opts->skipped_notify_cb(
+ delta->old_file.path, &delta->old_file.oid,
+ delta->old_file.mode, data->checkout_opts->notify_payload))
+ return GIT_EUSER;
+ }
+ }
+
+ return 0;
+}
+
+static int checkout_create_submodules(
+ git_diff_list *diff,
+ unsigned int *actions,
+ struct checkout_diff_data *data)
+{
+ git_diff_delta *delta;
+ size_t i;
+
+ git_vector_foreach(&diff->deltas, i, delta) {
+ if (actions[i] & CHECKOUT_ACTION__CREATE_SUBMODULE) {
+ int error = checkout_submodule(data, &delta->old_file);
+ if (error < 0)
+ return error;
+
+ data->completed_steps++;
+ report_progress(data, delta->old_file.path);
+ }
+ }
+
+ return 0;
+}
+
int git_checkout_index(
git_repository *repo,
git_checkout_opts *opts)
@@ -336,6 +434,9 @@ int git_checkout_index(
struct checkout_diff_data data;
git_buf workdir = GIT_BUF_INIT;
+ uint32_t *actions = NULL;
+ size_t *counts = NULL;
+
int error;
assert(repo);
@@ -359,44 +460,54 @@ int git_checkout_index(
normalize_options(&checkout_opts, opts);
- memset(&data, 0, sizeof(data));
+ /* Checkout is best performed with up to four passes through the diff.
+ *
+ * 0. Figure out what actions should be taken and record for later.
+ * 1. Next do removes, because we iterate in alphabetical order, thus
+ * a new untracked directory will end up sorted *after* a blob that
+ * should be checked out with the same name.
+ * 2. Then checkout all blobs.
+ * 3. Then checkout all submodules in case a new .gitmodules blob was
+ * checked out during pass #2.
+ */
+ if ((error = checkout_get_actions(&actions, &counts, diff, &checkout_opts)) < 0)
+ goto cleanup;
+ memset(&data, 0, sizeof(data));
data.path = &workdir;
data.workdir_len = git_buf_len(&workdir);
data.checkout_opts = &checkout_opts;
data.owner = repo;
- data.total_steps = (size_t)git_diff_num_deltas(diff);
+ data.total_steps = counts[CHECKOUT_ACTION__REMOVE] +
+ counts[CHECKOUT_ACTION__CREATE_BLOB] +
+ counts[CHECKOUT_ACTION__CREATE_SUBMODULE];
if ((error = retrieve_symlink_capabilities(repo, &data.can_symlink)) < 0)
goto cleanup;
- /* Checkout is best performed with three passes through the diff.
- *
- * 1. First do removes, because we iterate in alphabetical order, thus
- * a new untracked directory will end up sorted *after* a blob that
- * should be checked out with the same name.
- * 2. Then checkout all blobs.
- * 3. Then checkout all submodules in case a new .gitmodules blob was
- * checked out during pass #2.
- */
-
report_progress(&data, NULL);
- if (!(error = git_diff_foreach(
- diff, &data, checkout_remove_the_old, NULL, NULL)) &&
- !(error = git_diff_foreach(
- diff, &data, checkout_create_the_new, NULL, NULL)) &&
- data.found_submodules)
- {
- data.create_submodules = true;
- error = git_diff_foreach(
- diff, &data, checkout_create_the_new, NULL, NULL);
- }
+ if (counts[CHECKOUT_ACTION__REMOVE] > 0 &&
+ (error = checkout_remove_the_old(diff, actions, &data)) < 0)
+ goto cleanup;
+
+ if ((counts[CHECKOUT_ACTION__CREATE_BLOB] +
+ counts[CHECKOUT_ACTION__NOTIFY]) > 0 &&
+ (error = checkout_create_the_new(diff, actions, &data)) < 0)
+ goto cleanup;
+
+ if (counts[CHECKOUT_ACTION__CREATE_SUBMODULE] > 0 &&
+ (error = checkout_create_submodules(diff, actions, &data)) < 0)
+ goto cleanup;
+
+ assert(data.completed_steps == data.total_steps);
cleanup:
if (error == GIT_EUSER)
- error = (data.error != 0) ? data.error : -1;
+ giterr_clear();
+ git__free(actions);
+ git__free(counts);
git_diff_list_free(diff);
git_buf_free(&workdir);
@@ -449,7 +560,7 @@ int git_checkout_head(
if ((error = git_repository_head(&head, repo)) < 0)
return error;
-
+
if ((error = git_reference_peel(&tree, head, GIT_OBJ_TREE)) < 0)
goto cleanup;
diff --git a/tests-clar/checkout/index.c b/tests-clar/checkout/index.c
index 89bc1da..18c59a4 100644
--- a/tests-clar/checkout/index.c
+++ b/tests-clar/checkout/index.c
@@ -351,7 +351,7 @@ void test_checkout_index__wont_notify_of_expected_line_ending_changes(void)
{
cl_git_pass(p_unlink("./testrepo/.gitattributes"));
set_core_autocrlf_to(true);
-
+
cl_git_mkfile("./testrepo/new.txt", "my new file\r\n");
g_opts.checkout_strategy = GIT_CHECKOUT_CREATE_MISSING;
@@ -377,3 +377,34 @@ void test_checkout_index__calls_progress_callback(void)
cl_git_pass(git_checkout_index(g_repo, &g_opts));
cl_assert_equal_i(was_called, true);
}
+
+void test_checkout_index__can_overcome_name_clashes(void)
+{
+ git_index *index;
+
+ cl_git_pass(git_repository_index(&index, g_repo));
+ git_index_clear(index);
+
+ cl_git_mkfile("./testrepo/path0", "content\r\n");
+ cl_git_pass(p_mkdir("./testrepo/path1", 0777));
+ cl_git_mkfile("./testrepo/path1/file1", "content\r\n");
+
+ cl_git_pass(git_index_add(index, "path0", 0));
+ cl_git_pass(git_index_add(index, "path1/file1", 0));
+
+ cl_git_pass(p_unlink("./testrepo/path0"));
+ cl_git_pass(git_futils_rmdir_r(
+ "./testrepo/path1", NULL, GIT_RMDIR_REMOVE_FILES));
+
+ cl_git_mkfile("./testrepo/path1", "content\r\n");
+ cl_git_pass(p_mkdir("./testrepo/path0", 0777));
+ cl_git_mkfile("./testrepo/path0/file0", "content\r\n");
+
+ g_opts.checkout_strategy = GIT_CHECKOUT_CREATE_MISSING;
+ cl_git_pass(git_checkout_index(g_repo, &g_opts));
+
+ cl_assert(git_path_isfile("./testrepo/path1"));
+ cl_assert(git_path_isfile("./testrepo/path0/file0"));
+
+ git_index_free(index);
+}