t7503: verify proper hook execution

diff --git a/progress.c b/progress.c
index a4da26c2aadac239098578ef4d82956a164ef00d..277db8afa26decf0d95a44663f477257213a48f6 100644 (file)
--- a/progress.c
+++ b/progress.c
@@ -35,6 +35,7 @@ struct progress {
        uint64_t total;
        unsigned last_percent;
        unsigned delay;
+       unsigned sparse;
        struct throughput *throughput;
        uint64_t start_ns;
        struct strbuf counters_sb;
@@ -87,7 +88,6 @@ static void display(struct progress *progress, uint64_t n, const char *done)
        const char *tp;
        struct strbuf *counters_sb = &progress->counters_sb;
        int show_update = 0;
-       int last_count_len = counters_sb->len;
 
        if (progress->delay && (!progress_update || --progress->delay))
                return;
@@ -115,26 +115,21 @@ static void display(struct progress *progress, uint64_t n, const char *done)
        if (show_update) {
                if (is_foreground_fd(fileno(stderr)) || done) {
                        const char *eol = done ? done : "\r";
-                       size_t clear_len = counters_sb->len < last_count_len ?
-                                       last_count_len - counters_sb->len + 1 :
-                                       0;
-                       size_t progress_line_len = progress->title_len +
-                                               counters_sb->len + 2;
-                       int cols = term_columns();
 
+                       term_clear_line();
                        if (progress->split) {
-                               fprintf(stderr, "  %s%*s", counters_sb->buf,
-                                       (int) clear_len, eol);
-                       } else if (!done && cols < progress_line_len) {
-                               clear_len = progress->title_len + 1 < cols ?
-                                           cols - progress->title_len - 1 : 0;
-                               fprintf(stderr, "%s:%*s\n  %s%s",
-                                       progress->title, (int) clear_len, "",
-                                       counters_sb->buf, eol);
+                               fprintf(stderr, "  %s%s", counters_sb->buf,
+                                       eol);
+                       } else if (!done &&
+                                  /* The "+ 2" accounts for the ": ". */
+                                  term_columns() < progress->title_len +
+                                                   counters_sb->len + 2) {
+                               fprintf(stderr, "%s:\n  %s%s",
+                                       progress->title, counters_sb->buf, eol);
                                progress->split = 1;
                        } else {
-                               fprintf(stderr, "%s: %s%*s", progress->title,
-                                       counters_sb->buf, (int) clear_len, eol);
+                               fprintf(stderr, "%s: %s%s", progress->title,
+                                       counters_sb->buf, eol);
                        }
                        fflush(stderr);
                }
@@ -149,8 +144,7 @@ static void throughput_string(struct strbuf *buf, uint64_t total,
        strbuf_addstr(buf, ", ");
        strbuf_humanise_bytes(buf, total);
        strbuf_addstr(buf, " | ");
-       strbuf_humanise_bytes(buf, rate * 1024);
-       strbuf_addstr(buf, "/s");
+       strbuf_humanise_rate(buf, rate * 1024);
 }
 
 void display_throughput(struct progress *progress, uint64_t total)
@@ -166,12 +160,10 @@ void display_throughput(struct progress *progress, uint64_t total)
        now_ns = getnanotime();
 
        if (!tp) {
-               progress->throughput = tp = calloc(1, sizeof(*tp));
-               if (tp) {
-                       tp->prev_total = tp->curr_total = total;
-                       tp->prev_ns = now_ns;
-                       strbuf_init(&tp->display, 0);
-               }
+               progress->throughput = tp = xcalloc(1, sizeof(*tp));
+               tp->prev_total = tp->curr_total = total;
+               tp->prev_ns = now_ns;
+               strbuf_init(&tp->display, 0);
                return;
        }
        tp->curr_total = total;
@@ -222,20 +214,15 @@ void display_progress(struct progress *progress, uint64_t n)
 }
 
 static struct progress *start_progress_delay(const char *title, uint64_t total,
-                                            unsigned delay)
+                                            unsigned delay, unsigned sparse)
 {
-       struct progress *progress = malloc(sizeof(*progress));
-       if (!progress) {
-               /* unlikely, but here's a good fallback */
-               fprintf(stderr, "%s...\n", title);
-               fflush(stderr);
-               return NULL;
-       }
+       struct progress *progress = xmalloc(sizeof(*progress));
        progress->title = title;
        progress->total = total;
        progress->last_value = -1;
        progress->last_percent = -1;
        progress->delay = delay;
+       progress->sparse = sparse;
        progress->throughput = NULL;
        progress->start_ns = getnanotime();
        strbuf_init(&progress->counters_sb, 0);
@@ -247,16 +234,46 @@ static struct progress *start_progress_delay(const char *title, uint64_t total,
 
 struct progress *start_delayed_progress(const char *title, uint64_t total)
 {
-       return start_progress_delay(title, total, 2);
+       return start_progress_delay(title, total, 2, 0);
 }
 
 struct progress *start_progress(const char *title, uint64_t total)
 {
-       return start_progress_delay(title, total, 0);
+       return start_progress_delay(title, total, 0, 0);
+}
+
+/*
+ * Here "sparse" means that the caller might use some sampling criteria to
+ * decide when to call display_progress() rather than calling it for every
+ * integer value in[0 .. total).  In particular, the caller might not call
+ * display_progress() for the last value in the range.
+ *
+ * When "sparse" is set, stop_progress() will automatically force the done
+ * message to show 100%.
+ */
+struct progress *start_sparse_progress(const char *title, uint64_t total)
+{
+       return start_progress_delay(title, total, 0, 1);
+}
+
+struct progress *start_delayed_sparse_progress(const char *title,
+                                              uint64_t total)
+{
+       return start_progress_delay(title, total, 2, 1);
+}
+
+static void finish_if_sparse(struct progress *progress)
+{
+       if (progress &&
+           progress->sparse &&
+           progress->last_value != progress->total)
+               display_progress(progress, progress->total);
 }
 
 void stop_progress(struct progress **p_progress)
 {
+       finish_if_sparse(*p_progress);
+
        stop_progress_msg(p_progress, _("done"));
 }