sparse-checkout: check for dirty status

The index-merge performed by 'git sparse-checkout' will erase any staged
changes, which can lead to data loss. Prevent these attempts by requiring
a clean 'git status' output.

Helped-by: Szeder Gábor <szeder.dev@gmail.com>
Signed-off-by: Derrick Stolee <dstolee@microsoft.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>

diff --git a/builtin/sparse-checkout.c b/builtin/sparse-checkout.c
index 5dbfb2a7e0c6f81fd4cf190aec297424046cfe0d..a542d617a5fe25b2ec0d7b80c4dc172387ef7302 100644 (file)
--- a/builtin/sparse-checkout.c
+++ b/builtin/sparse-checkout.c
@@ -12,6 +12,7 @@
 #include "lockfile.h"
 #include "resolve-undo.h"
 #include "unpack-trees.h"
+#include "wt-status.h"
 
 static const char *empty_base = "";
 
@@ -256,6 +257,10 @@ static int sparse_checkout_init(int argc, const char **argv)
                OPT_END(),
        };
 
+       repo_read_index(the_repository);
+       require_clean_work_tree(the_repository,
+                               N_("initialize sparse-checkout"), NULL, 1, 0);
+
        argc = parse_options(argc, argv, NULL,
                             builtin_sparse_checkout_init_options,
                             builtin_sparse_checkout_init_usage, 0);
@@ -368,6 +373,10 @@ static int sparse_checkout_set(int argc, const char **argv, const char *prefix)
                OPT_END(),
        };
 
+       repo_read_index(the_repository);
+       require_clean_work_tree(the_repository,
+                               N_("set sparse-checkout patterns"), NULL, 1, 0);
+
        memset(&pl, 0, sizeof(pl));
 
        argc = parse_options(argc, argv, prefix,
@@ -427,6 +436,10 @@ static int sparse_checkout_disable(int argc, const char **argv)
        struct pattern_list pl;
        struct strbuf match_all = STRBUF_INIT;
 
+       repo_read_index(the_repository);
+       require_clean_work_tree(the_repository,
+                               N_("disable sparse-checkout"), NULL, 1, 0);
+
        memset(&pl, 0, sizeof(pl));
        hashmap_init(&pl.recursive_hashmap, pl_hashmap_cmp, NULL, 0);
        hashmap_init(&pl.parent_hashmap, pl_hashmap_cmp, NULL, 0);

diff --git a/t/t1091-sparse-checkout-builtin.sh b/t/t1091-sparse-checkout-builtin.sh
index e61ddb4ad5feea74f54bdceade49d625615d8fdd..d5e289252633d9090b4ef5f0caaff7101bb785f2 100755 (executable)
--- a/t/t1091-sparse-checkout-builtin.sh
+++ b/t/t1091-sparse-checkout-builtin.sh
@@ -250,10 +250,11 @@ test_expect_success 'cone mode: set with nested folders' '
 '
 
 test_expect_success 'revert to old sparse-checkout on bad update' '
+       test_when_finished git -C repo reset --hard &&
        echo update >repo/deep/deeper2/a &&
        cp repo/.git/info/sparse-checkout expect &&
        test_must_fail git -C repo sparse-checkout set deep/deeper1 2>err &&
-       test_i18ngrep "Cannot update sparse checkout" err &&
+       test_i18ngrep "cannot set sparse-checkout patterns" err &&
        test_cmp repo/.git/info/sparse-checkout expect &&
        ls repo/deep >dir &&
        cat >expect <<-EOF &&
@@ -291,4 +292,16 @@ test_expect_success '.gitignore should not warn about cone mode' '
        test_i18ngrep ! "disabling cone patterns" err
 '
 
+test_expect_success 'sparse-checkout (init|set|disable) fails with dirty status' '
+       git clone repo dirty &&
+       echo dirty >dirty/folder1/a &&
+       test_must_fail git -C dirty sparse-checkout init &&
+       test_must_fail git -C dirty sparse-checkout set /folder2/* /deep/deeper1/* &&
+       test_must_fail git -C dirty sparse-checkout disable &&
+       git -C dirty reset --hard &&
+       git -C dirty sparse-checkout init &&
+       git -C dirty sparse-checkout set /folder2/* /deep/deeper1/* &&
+       git -C dirty sparse-checkout disable
+'
+
 test_done