]> git.ipfire.org Git - thirdparty/git.git/blobdiff - builtin/bisect--helper.c
bisect--helper: reimplement `bisect_next` and `bisect_auto_next` shell functions...
[thirdparty/git.git] / builtin / bisect--helper.c
index 45e46d4471ff9904ca3fda3a1c7912082ba5d8b0..64f16d5d92ffb0c1433e92735b3e3b5516f9b124 100644 (file)
@@ -8,6 +8,7 @@
 #include "run-command.h"
 #include "prompt.h"
 #include "quote.h"
+#include "revision.h"
 
 static GIT_PATH_FUNC(git_path_bisect_terms, "BISECT_TERMS")
 static GIT_PATH_FUNC(git_path_bisect_expected_rev, "BISECT_EXPECTED_REV")
@@ -29,10 +30,17 @@ static const char * const git_bisect_helper_usage[] = {
        N_("git bisect--helper --bisect-terms [--term-good | --term-old | --term-bad | --term-new]"),
        N_("git bisect--helper --bisect-start [--term-{old,good}=<term> --term-{new,bad}=<term>]"
                                            " [--no-checkout] [--first-parent] [<bad> [<good>...]] [--] [<paths>...]"),
+       N_("git bisect--helper --bisect-next"),
+       N_("git bisect--helper --bisect-auto-next"),
        N_("git bisect--helper --bisect-autostart"),
        NULL
 };
 
+struct add_bisect_ref_data {
+       struct rev_info *revs;
+       unsigned int object_flags;
+};
+
 struct bisect_terms {
        char *term_good;
        char *term_bad;
@@ -56,6 +64,8 @@ static void set_terms(struct bisect_terms *terms, const char *bad,
 static const char vocab_bad[] = "bad|new";
 static const char vocab_good[] = "good|old";
 
+static int bisect_autostart(struct bisect_terms *terms);
+
 /*
  * Check whether the string `term` belongs to the set of strings
  * included in the variable arguments.
@@ -80,7 +90,7 @@ static int write_in_file(const char *path, const char *mode, const char *format,
        FILE *fp = NULL;
        int res = 0;
 
-       if (strcmp(mode, "w"))
+       if (strcmp(mode, "w") && strcmp(mode, "a"))
                BUG("write-in-file does not support '%s' mode", mode);
        fp = fopen(path, mode);
        if (!fp)
@@ -109,6 +119,18 @@ static int write_to_file(const char *path, const char *format, ...)
        return res;
 }
 
+static int append_to_file(const char *path, const char *format, ...)
+{
+       int res;
+       va_list args;
+
+       va_start(args, format);
+       res = write_in_file(path, "a", format, args);
+       va_end(args);
+
+       return res;
+}
+
 static int check_term_format(const char *term, const char *orig_term)
 {
        int res;
@@ -451,6 +473,142 @@ finish:
        return res;
 }
 
+static int add_bisect_ref(const char *refname, const struct object_id *oid,
+                         int flags, void *cb)
+{
+       struct add_bisect_ref_data *data = cb;
+
+       add_pending_oid(data->revs, refname, oid, data->object_flags);
+
+       return 0;
+}
+
+static int prepare_revs(struct bisect_terms *terms, struct rev_info *revs)
+{
+       int res = 0;
+       struct add_bisect_ref_data cb = { revs };
+       char *good = xstrfmt("%s-*", terms->term_good);
+
+       /*
+        * We cannot use terms->term_bad directly in
+        * for_each_glob_ref_in() and we have to append a '*' to it,
+        * otherwise for_each_glob_ref_in() will append '/' and '*'.
+        */
+       char *bad = xstrfmt("%s*", terms->term_bad);
+
+       /*
+        * It is important to reset the flags used by revision walks
+        * as the previous call to bisect_next_all() in turn
+        * sets up a revision walk.
+        */
+       reset_revision_walk();
+       init_revisions(revs, NULL);
+       setup_revisions(0, NULL, revs, NULL);
+       for_each_glob_ref_in(add_bisect_ref, bad, "refs/bisect/", &cb);
+       cb.object_flags = UNINTERESTING;
+       for_each_glob_ref_in(add_bisect_ref, good, "refs/bisect/", &cb);
+       if (prepare_revision_walk(revs))
+               res = error(_("revision walk setup failed\n"));
+
+       free(good);
+       free(bad);
+       return res;
+}
+
+static int bisect_skipped_commits(struct bisect_terms *terms)
+{
+       int res;
+       FILE *fp = NULL;
+       struct rev_info revs;
+       struct commit *commit;
+       struct pretty_print_context pp = {0};
+       struct strbuf commit_name = STRBUF_INIT;
+
+       res = prepare_revs(terms, &revs);
+       if (res)
+               return res;
+
+       fp = fopen(git_path_bisect_log(), "a");
+       if (!fp)
+               return error_errno(_("could not open '%s' for appending"),
+                                 git_path_bisect_log());
+
+       if (fprintf(fp, "# only skipped commits left to test\n") < 0)
+               return error_errno(_("failed to write to '%s'"), git_path_bisect_log());
+
+       while ((commit = get_revision(&revs)) != NULL) {
+               strbuf_reset(&commit_name);
+               format_commit_message(commit, "%s",
+                                     &commit_name, &pp);
+               fprintf(fp, "# possible first %s commit: [%s] %s\n",
+                       terms->term_bad, oid_to_hex(&commit->object.oid),
+                       commit_name.buf);
+       }
+
+       /*
+        * Reset the flags used by revision walks in case
+        * there is another revision walk after this one.
+        */
+       reset_revision_walk();
+
+       strbuf_release(&commit_name);
+       fclose(fp);
+       return 0;
+}
+
+static int bisect_successful(struct bisect_terms *terms)
+{
+       struct object_id oid;
+       struct commit *commit;
+       struct pretty_print_context pp = {0};
+       struct strbuf commit_name = STRBUF_INIT;
+       char *bad_ref = xstrfmt("refs/bisect/%s",terms->term_bad);
+       int res;
+
+       read_ref(bad_ref, &oid);
+       commit = lookup_commit_reference_by_name(bad_ref);
+       format_commit_message(commit, "%s", &commit_name, &pp);
+
+       res = append_to_file(git_path_bisect_log(), "# first %s commit: [%s] %s\n",
+                           terms->term_bad, oid_to_hex(&commit->object.oid),
+                           commit_name.buf);
+
+       strbuf_release(&commit_name);
+       free(bad_ref);
+       return res;
+}
+
+static enum bisect_error bisect_next(struct bisect_terms *terms, const char *prefix)
+{
+       enum bisect_error res;
+
+       if (bisect_autostart(terms))
+               return BISECT_FAILED;
+
+       if (bisect_next_check(terms, terms->term_good))
+               return BISECT_FAILED;
+
+       /* Perform all bisection computation */
+       res = bisect_next_all(the_repository, prefix);
+
+       if (res == BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND) {
+               res = bisect_successful(terms);
+               return res ? res : BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND;
+       } else if (res == BISECT_ONLY_SKIPPED_LEFT) {
+               res = bisect_skipped_commits(terms);
+               return res ? res : BISECT_ONLY_SKIPPED_LEFT;
+       }
+       return res;
+}
+
+static enum bisect_error bisect_auto_next(struct bisect_terms *terms, const char *prefix)
+{
+       if (bisect_next_check(terms, NULL))
+               return BISECT_OK;
+
+       return bisect_next(terms, prefix);
+}
+
 static int bisect_start(struct bisect_terms *terms, const char **argv, int argc)
 {
        int no_checkout = 0;
@@ -700,6 +858,8 @@ int cmd_bisect__helper(int argc, const char **argv, const char *prefix)
                BISECT_TERMS,
                BISECT_START,
                BISECT_AUTOSTART,
+               BISECT_NEXT,
+               BISECT_AUTO_NEXT
        } cmdmode = 0;
        int res = 0, nolog = 0;
        struct option options[] = {
@@ -723,6 +883,10 @@ int cmd_bisect__helper(int argc, const char **argv, const char *prefix)
                         N_("print out the bisect terms"), BISECT_TERMS),
                OPT_CMDMODE(0, "bisect-start", &cmdmode,
                         N_("start the bisect session"), BISECT_START),
+               OPT_CMDMODE(0, "bisect-next", &cmdmode,
+                        N_("find the next bisection commit"), BISECT_NEXT),
+               OPT_CMDMODE(0, "bisect-auto-next", &cmdmode,
+                        N_("verify the next bisection state then checkout the next bisection commit"), BISECT_AUTO_NEXT),
                OPT_CMDMODE(0, "bisect-autostart", &cmdmode,
                         N_("start the bisection if it has not yet been started"), BISECT_AUTOSTART),
                OPT_BOOL(0, "no-log", &nolog,
@@ -784,6 +948,18 @@ int cmd_bisect__helper(int argc, const char **argv, const char *prefix)
                set_terms(&terms, "bad", "good");
                res = bisect_start(&terms, argv, argc);
                break;
+       case BISECT_NEXT:
+               if (argc)
+                       return error(_("--bisect-next requires 0 arguments"));
+               get_terms(&terms);
+               res = bisect_next(&terms, prefix);
+               break;
+       case BISECT_AUTO_NEXT:
+               if (argc)
+                       return error(_("--bisect-auto-next requires 0 arguments"));
+               get_terms(&terms);
+               res = bisect_auto_next(&terms, prefix);
+               break;
        case BISECT_AUTOSTART:
                if (argc)
                        return error(_("--bisect-autostart does not accept arguments"));
@@ -799,7 +975,7 @@ int cmd_bisect__helper(int argc, const char **argv, const char *prefix)
         * Handle early success
         * From check_merge_bases > check_good_are_ancestors_of_bad > bisect_next_all
         */
-       if (res == BISECT_INTERNAL_SUCCESS_MERGE_BASE)
+       if ((res == BISECT_INTERNAL_SUCCESS_MERGE_BASE) || (res == BISECT_INTERNAL_SUCCESS_1ST_BAD_FOUND))
                res = BISECT_OK;
 
        return -res;