refs/reftable: print errors on compaction failure
[alt-git.git] / reftable / stack_test.c
blob887f458e5c3b5adba67ea363958740766487d241
1 /*
2 Copyright 2020 Google LLC
4 Use of this source code is governed by a BSD-style
5 license that can be found in the LICENSE file or at
6 https://developers.google.com/open-source/licenses/bsd
7 */
9 #include "stack.h"
11 #include "system.h"
13 #include "reftable-reader.h"
14 #include "merged.h"
15 #include "basics.h"
16 #include "record.h"
17 #include "test_framework.h"
18 #include "reftable-tests.h"
19 #include "reader.h"
21 #include <sys/types.h>
22 #include <dirent.h>
24 static void clear_dir(const char *dirname)
26 struct strbuf path = STRBUF_INIT;
27 strbuf_addstr(&path, dirname);
28 remove_dir_recursively(&path, 0);
29 strbuf_release(&path);
32 static int count_dir_entries(const char *dirname)
34 DIR *dir = opendir(dirname);
35 int len = 0;
36 struct dirent *d;
37 if (!dir)
38 return 0;
40 while ((d = readdir(dir))) {
41 if (!strcmp(d->d_name, "..") || !strcmp(d->d_name, "."))
42 continue;
43 len++;
45 closedir(dir);
46 return len;
50 * Work linenumber into the tempdir, so we can see which tests forget to
51 * cleanup.
53 static char *get_tmp_template(int linenumber)
55 const char *tmp = getenv("TMPDIR");
56 static char template[1024];
57 snprintf(template, sizeof(template) - 1, "%s/stack_test-%d.XXXXXX",
58 tmp ? tmp : "/tmp", linenumber);
59 return template;
62 static char *get_tmp_dir(int linenumber)
64 char *dir = get_tmp_template(linenumber);
65 EXPECT(mkdtemp(dir));
66 return dir;
69 static void test_read_file(void)
71 char *fn = get_tmp_template(__LINE__);
72 int fd = mkstemp(fn);
73 char out[1024] = "line1\n\nline2\nline3";
74 int n, err;
75 char **names = NULL;
76 char *want[] = { "line1", "line2", "line3" };
77 int i = 0;
79 EXPECT(fd > 0);
80 n = write_in_full(fd, out, strlen(out));
81 EXPECT(n == strlen(out));
82 err = close(fd);
83 EXPECT(err >= 0);
85 err = read_lines(fn, &names);
86 EXPECT_ERR(err);
88 for (i = 0; names[i]; i++) {
89 EXPECT(0 == strcmp(want[i], names[i]));
91 free_names(names);
92 (void) remove(fn);
95 static void test_parse_names(void)
97 char buf[] = "line\n";
98 char **names = NULL;
99 parse_names(buf, strlen(buf), &names);
101 EXPECT(NULL != names[0]);
102 EXPECT(0 == strcmp(names[0], "line"));
103 EXPECT(NULL == names[1]);
104 free_names(names);
107 static void test_names_equal(void)
109 char *a[] = { "a", "b", "c", NULL };
110 char *b[] = { "a", "b", "d", NULL };
111 char *c[] = { "a", "b", NULL };
113 EXPECT(names_equal(a, a));
114 EXPECT(!names_equal(a, b));
115 EXPECT(!names_equal(a, c));
118 static int write_test_ref(struct reftable_writer *wr, void *arg)
120 struct reftable_ref_record *ref = arg;
121 reftable_writer_set_limits(wr, ref->update_index, ref->update_index);
122 return reftable_writer_add_ref(wr, ref);
125 struct write_log_arg {
126 struct reftable_log_record *log;
127 uint64_t update_index;
130 static int write_test_log(struct reftable_writer *wr, void *arg)
132 struct write_log_arg *wla = arg;
134 reftable_writer_set_limits(wr, wla->update_index, wla->update_index);
135 return reftable_writer_add_log(wr, wla->log);
138 static void test_reftable_stack_add_one(void)
140 char *dir = get_tmp_dir(__LINE__);
141 struct strbuf scratch = STRBUF_INIT;
142 int mask = umask(002);
143 struct reftable_write_options cfg = {
144 .default_permissions = 0660,
146 struct reftable_stack *st = NULL;
147 int err;
148 struct reftable_ref_record ref = {
149 .refname = "HEAD",
150 .update_index = 1,
151 .value_type = REFTABLE_REF_SYMREF,
152 .value.symref = "master",
154 struct reftable_ref_record dest = { NULL };
155 struct stat stat_result = { 0 };
156 err = reftable_new_stack(&st, dir, cfg);
157 EXPECT_ERR(err);
159 err = reftable_stack_add(st, &write_test_ref, &ref);
160 EXPECT_ERR(err);
162 err = reftable_stack_read_ref(st, ref.refname, &dest);
163 EXPECT_ERR(err);
164 EXPECT(0 == strcmp("master", dest.value.symref));
165 EXPECT(st->readers_len > 0);
167 printf("testing print functionality:\n");
168 err = reftable_stack_print_directory(dir, GIT_SHA1_FORMAT_ID);
169 EXPECT_ERR(err);
171 err = reftable_stack_print_directory(dir, GIT_SHA256_FORMAT_ID);
172 EXPECT(err == REFTABLE_FORMAT_ERROR);
174 #ifndef GIT_WINDOWS_NATIVE
175 strbuf_addstr(&scratch, dir);
176 strbuf_addstr(&scratch, "/tables.list");
177 err = stat(scratch.buf, &stat_result);
178 EXPECT(!err);
179 EXPECT((stat_result.st_mode & 0777) == cfg.default_permissions);
181 strbuf_reset(&scratch);
182 strbuf_addstr(&scratch, dir);
183 strbuf_addstr(&scratch, "/");
184 /* do not try at home; not an external API for reftable. */
185 strbuf_addstr(&scratch, st->readers[0]->name);
186 err = stat(scratch.buf, &stat_result);
187 EXPECT(!err);
188 EXPECT((stat_result.st_mode & 0777) == cfg.default_permissions);
189 #else
190 (void) stat_result;
191 #endif
193 reftable_ref_record_release(&dest);
194 reftable_stack_destroy(st);
195 strbuf_release(&scratch);
196 clear_dir(dir);
197 umask(mask);
200 static void test_reftable_stack_uptodate(void)
202 struct reftable_write_options cfg = { 0 };
203 struct reftable_stack *st1 = NULL;
204 struct reftable_stack *st2 = NULL;
205 char *dir = get_tmp_dir(__LINE__);
207 int err;
208 struct reftable_ref_record ref1 = {
209 .refname = "HEAD",
210 .update_index = 1,
211 .value_type = REFTABLE_REF_SYMREF,
212 .value.symref = "master",
214 struct reftable_ref_record ref2 = {
215 .refname = "branch2",
216 .update_index = 2,
217 .value_type = REFTABLE_REF_SYMREF,
218 .value.symref = "master",
222 /* simulate multi-process access to the same stack
223 by creating two stacks for the same directory.
225 err = reftable_new_stack(&st1, dir, cfg);
226 EXPECT_ERR(err);
228 err = reftable_new_stack(&st2, dir, cfg);
229 EXPECT_ERR(err);
231 err = reftable_stack_add(st1, &write_test_ref, &ref1);
232 EXPECT_ERR(err);
234 err = reftable_stack_add(st2, &write_test_ref, &ref2);
235 EXPECT(err == REFTABLE_OUTDATED_ERROR);
237 err = reftable_stack_reload(st2);
238 EXPECT_ERR(err);
240 err = reftable_stack_add(st2, &write_test_ref, &ref2);
241 EXPECT_ERR(err);
242 reftable_stack_destroy(st1);
243 reftable_stack_destroy(st2);
244 clear_dir(dir);
247 static void test_reftable_stack_transaction_api(void)
249 char *dir = get_tmp_dir(__LINE__);
251 struct reftable_write_options cfg = { 0 };
252 struct reftable_stack *st = NULL;
253 int err;
254 struct reftable_addition *add = NULL;
256 struct reftable_ref_record ref = {
257 .refname = "HEAD",
258 .update_index = 1,
259 .value_type = REFTABLE_REF_SYMREF,
260 .value.symref = "master",
262 struct reftable_ref_record dest = { NULL };
265 err = reftable_new_stack(&st, dir, cfg);
266 EXPECT_ERR(err);
268 reftable_addition_destroy(add);
270 err = reftable_stack_new_addition(&add, st);
271 EXPECT_ERR(err);
273 err = reftable_addition_add(add, &write_test_ref, &ref);
274 EXPECT_ERR(err);
276 err = reftable_addition_commit(add);
277 EXPECT_ERR(err);
279 reftable_addition_destroy(add);
281 err = reftable_stack_read_ref(st, ref.refname, &dest);
282 EXPECT_ERR(err);
283 EXPECT(REFTABLE_REF_SYMREF == dest.value_type);
284 EXPECT(0 == strcmp("master", dest.value.symref));
286 reftable_ref_record_release(&dest);
287 reftable_stack_destroy(st);
288 clear_dir(dir);
291 static void test_reftable_stack_transaction_api_performs_auto_compaction(void)
293 char *dir = get_tmp_dir(__LINE__);
294 struct reftable_write_options cfg = {0};
295 struct reftable_addition *add = NULL;
296 struct reftable_stack *st = NULL;
297 int i, n = 20, err;
299 err = reftable_new_stack(&st, dir, cfg);
300 EXPECT_ERR(err);
302 for (i = 0; i <= n; i++) {
303 struct reftable_ref_record ref = {
304 .update_index = reftable_stack_next_update_index(st),
305 .value_type = REFTABLE_REF_SYMREF,
306 .value.symref = "master",
308 char name[100];
310 snprintf(name, sizeof(name), "branch%04d", i);
311 ref.refname = name;
314 * Disable auto-compaction for all but the last runs. Like this
315 * we can ensure that we indeed honor this setting and have
316 * better control over when exactly auto compaction runs.
318 st->disable_auto_compact = i != n;
320 err = reftable_stack_new_addition(&add, st);
321 EXPECT_ERR(err);
323 err = reftable_addition_add(add, &write_test_ref, &ref);
324 EXPECT_ERR(err);
326 err = reftable_addition_commit(add);
327 EXPECT_ERR(err);
329 reftable_addition_destroy(add);
332 * The stack length should grow continuously for all runs where
333 * auto compaction is disabled. When enabled, we should merge
334 * all tables in the stack.
336 if (i != n)
337 EXPECT(st->merged->stack_len == i + 1);
338 else
339 EXPECT(st->merged->stack_len == 1);
342 reftable_stack_destroy(st);
343 clear_dir(dir);
346 static void test_reftable_stack_auto_compaction_fails_gracefully(void)
348 struct reftable_ref_record ref = {
349 .refname = "refs/heads/master",
350 .update_index = 1,
351 .value_type = REFTABLE_REF_VAL1,
352 .value.val1 = {0x01},
354 struct reftable_write_options cfg = {0};
355 struct reftable_stack *st;
356 struct strbuf table_path = STRBUF_INIT;
357 char *dir = get_tmp_dir(__LINE__);
358 int err;
360 err = reftable_new_stack(&st, dir, cfg);
361 EXPECT_ERR(err);
363 err = reftable_stack_add(st, write_test_ref, &ref);
364 EXPECT_ERR(err);
365 EXPECT(st->merged->stack_len == 1);
366 EXPECT(st->stats.attempts == 0);
367 EXPECT(st->stats.failures == 0);
370 * Lock the newly written table such that it cannot be compacted.
371 * Adding a new table to the stack should not be impacted by this, even
372 * though auto-compaction will now fail.
374 strbuf_addf(&table_path, "%s/%s.lock", dir, st->readers[0]->name);
375 write_file_buf(table_path.buf, "", 0);
377 ref.update_index = 2;
378 err = reftable_stack_add(st, write_test_ref, &ref);
379 EXPECT_ERR(err);
380 EXPECT(st->merged->stack_len == 2);
381 EXPECT(st->stats.attempts == 1);
382 EXPECT(st->stats.failures == 1);
384 reftable_stack_destroy(st);
385 strbuf_release(&table_path);
386 clear_dir(dir);
389 static void test_reftable_stack_validate_refname(void)
391 struct reftable_write_options cfg = { 0 };
392 struct reftable_stack *st = NULL;
393 int err;
394 char *dir = get_tmp_dir(__LINE__);
396 int i;
397 struct reftable_ref_record ref = {
398 .refname = "a/b",
399 .update_index = 1,
400 .value_type = REFTABLE_REF_SYMREF,
401 .value.symref = "master",
403 char *additions[] = { "a", "a/b/c" };
405 err = reftable_new_stack(&st, dir, cfg);
406 EXPECT_ERR(err);
408 err = reftable_stack_add(st, &write_test_ref, &ref);
409 EXPECT_ERR(err);
411 for (i = 0; i < ARRAY_SIZE(additions); i++) {
412 struct reftable_ref_record ref = {
413 .refname = additions[i],
414 .update_index = 1,
415 .value_type = REFTABLE_REF_SYMREF,
416 .value.symref = "master",
419 err = reftable_stack_add(st, &write_test_ref, &ref);
420 EXPECT(err == REFTABLE_NAME_CONFLICT);
423 reftable_stack_destroy(st);
424 clear_dir(dir);
427 static int write_error(struct reftable_writer *wr, void *arg)
429 return *((int *)arg);
432 static void test_reftable_stack_update_index_check(void)
434 char *dir = get_tmp_dir(__LINE__);
436 struct reftable_write_options cfg = { 0 };
437 struct reftable_stack *st = NULL;
438 int err;
439 struct reftable_ref_record ref1 = {
440 .refname = "name1",
441 .update_index = 1,
442 .value_type = REFTABLE_REF_SYMREF,
443 .value.symref = "master",
445 struct reftable_ref_record ref2 = {
446 .refname = "name2",
447 .update_index = 1,
448 .value_type = REFTABLE_REF_SYMREF,
449 .value.symref = "master",
452 err = reftable_new_stack(&st, dir, cfg);
453 EXPECT_ERR(err);
455 err = reftable_stack_add(st, &write_test_ref, &ref1);
456 EXPECT_ERR(err);
458 err = reftable_stack_add(st, &write_test_ref, &ref2);
459 EXPECT(err == REFTABLE_API_ERROR);
460 reftable_stack_destroy(st);
461 clear_dir(dir);
464 static void test_reftable_stack_lock_failure(void)
466 char *dir = get_tmp_dir(__LINE__);
468 struct reftable_write_options cfg = { 0 };
469 struct reftable_stack *st = NULL;
470 int err, i;
472 err = reftable_new_stack(&st, dir, cfg);
473 EXPECT_ERR(err);
474 for (i = -1; i != REFTABLE_EMPTY_TABLE_ERROR; i--) {
475 err = reftable_stack_add(st, &write_error, &i);
476 EXPECT(err == i);
479 reftable_stack_destroy(st);
480 clear_dir(dir);
483 static void test_reftable_stack_add(void)
485 int i = 0;
486 int err = 0;
487 struct reftable_write_options cfg = {
488 .exact_log_message = 1,
489 .default_permissions = 0660,
491 struct reftable_stack *st = NULL;
492 char *dir = get_tmp_dir(__LINE__);
493 struct reftable_ref_record refs[2] = { { NULL } };
494 struct reftable_log_record logs[2] = { { NULL } };
495 struct strbuf path = STRBUF_INIT;
496 struct stat stat_result;
497 int N = ARRAY_SIZE(refs);
499 err = reftable_new_stack(&st, dir, cfg);
500 EXPECT_ERR(err);
501 st->disable_auto_compact = 1;
503 for (i = 0; i < N; i++) {
504 char buf[256];
505 snprintf(buf, sizeof(buf), "branch%02d", i);
506 refs[i].refname = xstrdup(buf);
507 refs[i].update_index = i + 1;
508 refs[i].value_type = REFTABLE_REF_VAL1;
509 set_test_hash(refs[i].value.val1, i);
511 logs[i].refname = xstrdup(buf);
512 logs[i].update_index = N + i + 1;
513 logs[i].value_type = REFTABLE_LOG_UPDATE;
515 logs[i].value.update.new_hash = reftable_malloc(GIT_SHA1_RAWSZ);
516 logs[i].value.update.email = xstrdup("identity@invalid");
517 set_test_hash(logs[i].value.update.new_hash, i);
520 for (i = 0; i < N; i++) {
521 int err = reftable_stack_add(st, &write_test_ref, &refs[i]);
522 EXPECT_ERR(err);
525 for (i = 0; i < N; i++) {
526 struct write_log_arg arg = {
527 .log = &logs[i],
528 .update_index = reftable_stack_next_update_index(st),
530 int err = reftable_stack_add(st, &write_test_log, &arg);
531 EXPECT_ERR(err);
534 err = reftable_stack_compact_all(st, NULL);
535 EXPECT_ERR(err);
537 for (i = 0; i < N; i++) {
538 struct reftable_ref_record dest = { NULL };
540 int err = reftable_stack_read_ref(st, refs[i].refname, &dest);
541 EXPECT_ERR(err);
542 EXPECT(reftable_ref_record_equal(&dest, refs + i,
543 GIT_SHA1_RAWSZ));
544 reftable_ref_record_release(&dest);
547 for (i = 0; i < N; i++) {
548 struct reftable_log_record dest = { NULL };
549 int err = reftable_stack_read_log(st, refs[i].refname, &dest);
550 EXPECT_ERR(err);
551 EXPECT(reftable_log_record_equal(&dest, logs + i,
552 GIT_SHA1_RAWSZ));
553 reftable_log_record_release(&dest);
556 #ifndef GIT_WINDOWS_NATIVE
557 strbuf_addstr(&path, dir);
558 strbuf_addstr(&path, "/tables.list");
559 err = stat(path.buf, &stat_result);
560 EXPECT(!err);
561 EXPECT((stat_result.st_mode & 0777) == cfg.default_permissions);
563 strbuf_reset(&path);
564 strbuf_addstr(&path, dir);
565 strbuf_addstr(&path, "/");
566 /* do not try at home; not an external API for reftable. */
567 strbuf_addstr(&path, st->readers[0]->name);
568 err = stat(path.buf, &stat_result);
569 EXPECT(!err);
570 EXPECT((stat_result.st_mode & 0777) == cfg.default_permissions);
571 #else
572 (void) stat_result;
573 #endif
575 /* cleanup */
576 reftable_stack_destroy(st);
577 for (i = 0; i < N; i++) {
578 reftable_ref_record_release(&refs[i]);
579 reftable_log_record_release(&logs[i]);
581 strbuf_release(&path);
582 clear_dir(dir);
585 static void test_reftable_stack_log_normalize(void)
587 int err = 0;
588 struct reftable_write_options cfg = {
591 struct reftable_stack *st = NULL;
592 char *dir = get_tmp_dir(__LINE__);
594 uint8_t h1[GIT_SHA1_RAWSZ] = { 0x01 }, h2[GIT_SHA1_RAWSZ] = { 0x02 };
596 struct reftable_log_record input = { .refname = "branch",
597 .update_index = 1,
598 .value_type = REFTABLE_LOG_UPDATE,
599 .value = { .update = {
600 .new_hash = h1,
601 .old_hash = h2,
602 } } };
603 struct reftable_log_record dest = {
604 .update_index = 0,
606 struct write_log_arg arg = {
607 .log = &input,
608 .update_index = 1,
611 err = reftable_new_stack(&st, dir, cfg);
612 EXPECT_ERR(err);
614 input.value.update.message = "one\ntwo";
615 err = reftable_stack_add(st, &write_test_log, &arg);
616 EXPECT(err == REFTABLE_API_ERROR);
618 input.value.update.message = "one";
619 err = reftable_stack_add(st, &write_test_log, &arg);
620 EXPECT_ERR(err);
622 err = reftable_stack_read_log(st, input.refname, &dest);
623 EXPECT_ERR(err);
624 EXPECT(0 == strcmp(dest.value.update.message, "one\n"));
626 input.value.update.message = "two\n";
627 arg.update_index = 2;
628 err = reftable_stack_add(st, &write_test_log, &arg);
629 EXPECT_ERR(err);
630 err = reftable_stack_read_log(st, input.refname, &dest);
631 EXPECT_ERR(err);
632 EXPECT(0 == strcmp(dest.value.update.message, "two\n"));
634 /* cleanup */
635 reftable_stack_destroy(st);
636 reftable_log_record_release(&dest);
637 clear_dir(dir);
640 static void test_reftable_stack_tombstone(void)
642 int i = 0;
643 char *dir = get_tmp_dir(__LINE__);
645 struct reftable_write_options cfg = { 0 };
646 struct reftable_stack *st = NULL;
647 int err;
648 struct reftable_ref_record refs[2] = { { NULL } };
649 struct reftable_log_record logs[2] = { { NULL } };
650 int N = ARRAY_SIZE(refs);
651 struct reftable_ref_record dest = { NULL };
652 struct reftable_log_record log_dest = { NULL };
655 err = reftable_new_stack(&st, dir, cfg);
656 EXPECT_ERR(err);
658 /* even entries add the refs, odd entries delete them. */
659 for (i = 0; i < N; i++) {
660 const char *buf = "branch";
661 refs[i].refname = xstrdup(buf);
662 refs[i].update_index = i + 1;
663 if (i % 2 == 0) {
664 refs[i].value_type = REFTABLE_REF_VAL1;
665 set_test_hash(refs[i].value.val1, i);
668 logs[i].refname = xstrdup(buf);
669 /* update_index is part of the key. */
670 logs[i].update_index = 42;
671 if (i % 2 == 0) {
672 logs[i].value_type = REFTABLE_LOG_UPDATE;
673 logs[i].value.update.new_hash =
674 reftable_malloc(GIT_SHA1_RAWSZ);
675 set_test_hash(logs[i].value.update.new_hash, i);
676 logs[i].value.update.email =
677 xstrdup("identity@invalid");
680 for (i = 0; i < N; i++) {
681 int err = reftable_stack_add(st, &write_test_ref, &refs[i]);
682 EXPECT_ERR(err);
685 for (i = 0; i < N; i++) {
686 struct write_log_arg arg = {
687 .log = &logs[i],
688 .update_index = reftable_stack_next_update_index(st),
690 int err = reftable_stack_add(st, &write_test_log, &arg);
691 EXPECT_ERR(err);
694 err = reftable_stack_read_ref(st, "branch", &dest);
695 EXPECT(err == 1);
696 reftable_ref_record_release(&dest);
698 err = reftable_stack_read_log(st, "branch", &log_dest);
699 EXPECT(err == 1);
700 reftable_log_record_release(&log_dest);
702 err = reftable_stack_compact_all(st, NULL);
703 EXPECT_ERR(err);
705 err = reftable_stack_read_ref(st, "branch", &dest);
706 EXPECT(err == 1);
708 err = reftable_stack_read_log(st, "branch", &log_dest);
709 EXPECT(err == 1);
710 reftable_ref_record_release(&dest);
711 reftable_log_record_release(&log_dest);
713 /* cleanup */
714 reftable_stack_destroy(st);
715 for (i = 0; i < N; i++) {
716 reftable_ref_record_release(&refs[i]);
717 reftable_log_record_release(&logs[i]);
719 clear_dir(dir);
722 static void test_reftable_stack_hash_id(void)
724 char *dir = get_tmp_dir(__LINE__);
726 struct reftable_write_options cfg = { 0 };
727 struct reftable_stack *st = NULL;
728 int err;
730 struct reftable_ref_record ref = {
731 .refname = "master",
732 .value_type = REFTABLE_REF_SYMREF,
733 .value.symref = "target",
734 .update_index = 1,
736 struct reftable_write_options cfg32 = { .hash_id = GIT_SHA256_FORMAT_ID };
737 struct reftable_stack *st32 = NULL;
738 struct reftable_write_options cfg_default = { 0 };
739 struct reftable_stack *st_default = NULL;
740 struct reftable_ref_record dest = { NULL };
742 err = reftable_new_stack(&st, dir, cfg);
743 EXPECT_ERR(err);
745 err = reftable_stack_add(st, &write_test_ref, &ref);
746 EXPECT_ERR(err);
748 /* can't read it with the wrong hash ID. */
749 err = reftable_new_stack(&st32, dir, cfg32);
750 EXPECT(err == REFTABLE_FORMAT_ERROR);
752 /* check that we can read it back with default config too. */
753 err = reftable_new_stack(&st_default, dir, cfg_default);
754 EXPECT_ERR(err);
756 err = reftable_stack_read_ref(st_default, "master", &dest);
757 EXPECT_ERR(err);
759 EXPECT(reftable_ref_record_equal(&ref, &dest, GIT_SHA1_RAWSZ));
760 reftable_ref_record_release(&dest);
761 reftable_stack_destroy(st);
762 reftable_stack_destroy(st_default);
763 clear_dir(dir);
766 static void test_log2(void)
768 EXPECT(1 == fastlog2(3));
769 EXPECT(2 == fastlog2(4));
770 EXPECT(2 == fastlog2(5));
773 static void test_sizes_to_segments(void)
775 uint64_t sizes[] = { 2, 3, 4, 5, 7, 9 };
776 /* .................0 1 2 3 4 5 */
778 size_t seglen = 0;
779 struct segment *segs =
780 sizes_to_segments(&seglen, sizes, ARRAY_SIZE(sizes));
781 EXPECT(segs[2].log == 3);
782 EXPECT(segs[2].start == 5);
783 EXPECT(segs[2].end == 6);
785 EXPECT(segs[1].log == 2);
786 EXPECT(segs[1].start == 2);
787 EXPECT(segs[1].end == 5);
788 reftable_free(segs);
791 static void test_sizes_to_segments_empty(void)
793 size_t seglen = 0;
794 struct segment *segs = sizes_to_segments(&seglen, NULL, 0);
795 EXPECT(seglen == 0);
796 reftable_free(segs);
799 static void test_sizes_to_segments_all_equal(void)
801 uint64_t sizes[] = { 5, 5 };
802 size_t seglen = 0;
803 struct segment *segs =
804 sizes_to_segments(&seglen, sizes, ARRAY_SIZE(sizes));
805 EXPECT(seglen == 1);
806 EXPECT(segs[0].start == 0);
807 EXPECT(segs[0].end == 2);
808 reftable_free(segs);
811 static void test_suggest_compaction_segment(void)
813 uint64_t sizes[] = { 128, 64, 17, 16, 9, 9, 9, 16, 16 };
814 /* .................0 1 2 3 4 5 6 */
815 struct segment min =
816 suggest_compaction_segment(sizes, ARRAY_SIZE(sizes));
817 EXPECT(min.start == 2);
818 EXPECT(min.end == 7);
821 static void test_suggest_compaction_segment_nothing(void)
823 uint64_t sizes[] = { 64, 32, 16, 8, 4, 2 };
824 struct segment result =
825 suggest_compaction_segment(sizes, ARRAY_SIZE(sizes));
826 EXPECT(result.start == result.end);
829 static void test_reflog_expire(void)
831 char *dir = get_tmp_dir(__LINE__);
833 struct reftable_write_options cfg = { 0 };
834 struct reftable_stack *st = NULL;
835 struct reftable_log_record logs[20] = { { NULL } };
836 int N = ARRAY_SIZE(logs) - 1;
837 int i = 0;
838 int err;
839 struct reftable_log_expiry_config expiry = {
840 .time = 10,
842 struct reftable_log_record log = { NULL };
845 err = reftable_new_stack(&st, dir, cfg);
846 EXPECT_ERR(err);
848 for (i = 1; i <= N; i++) {
849 char buf[256];
850 snprintf(buf, sizeof(buf), "branch%02d", i);
852 logs[i].refname = xstrdup(buf);
853 logs[i].update_index = i;
854 logs[i].value_type = REFTABLE_LOG_UPDATE;
855 logs[i].value.update.time = i;
856 logs[i].value.update.new_hash = reftable_malloc(GIT_SHA1_RAWSZ);
857 logs[i].value.update.email = xstrdup("identity@invalid");
858 set_test_hash(logs[i].value.update.new_hash, i);
861 for (i = 1; i <= N; i++) {
862 struct write_log_arg arg = {
863 .log = &logs[i],
864 .update_index = reftable_stack_next_update_index(st),
866 int err = reftable_stack_add(st, &write_test_log, &arg);
867 EXPECT_ERR(err);
870 err = reftable_stack_compact_all(st, NULL);
871 EXPECT_ERR(err);
873 err = reftable_stack_compact_all(st, &expiry);
874 EXPECT_ERR(err);
876 err = reftable_stack_read_log(st, logs[9].refname, &log);
877 EXPECT(err == 1);
879 err = reftable_stack_read_log(st, logs[11].refname, &log);
880 EXPECT_ERR(err);
882 expiry.min_update_index = 15;
883 err = reftable_stack_compact_all(st, &expiry);
884 EXPECT_ERR(err);
886 err = reftable_stack_read_log(st, logs[14].refname, &log);
887 EXPECT(err == 1);
889 err = reftable_stack_read_log(st, logs[16].refname, &log);
890 EXPECT_ERR(err);
892 /* cleanup */
893 reftable_stack_destroy(st);
894 for (i = 0; i <= N; i++) {
895 reftable_log_record_release(&logs[i]);
897 clear_dir(dir);
898 reftable_log_record_release(&log);
901 static int write_nothing(struct reftable_writer *wr, void *arg)
903 reftable_writer_set_limits(wr, 1, 1);
904 return 0;
907 static void test_empty_add(void)
909 struct reftable_write_options cfg = { 0 };
910 struct reftable_stack *st = NULL;
911 int err;
912 char *dir = get_tmp_dir(__LINE__);
914 struct reftable_stack *st2 = NULL;
917 err = reftable_new_stack(&st, dir, cfg);
918 EXPECT_ERR(err);
920 err = reftable_stack_add(st, &write_nothing, NULL);
921 EXPECT_ERR(err);
923 err = reftable_new_stack(&st2, dir, cfg);
924 EXPECT_ERR(err);
925 clear_dir(dir);
926 reftable_stack_destroy(st);
927 reftable_stack_destroy(st2);
930 static void test_reftable_stack_auto_compaction(void)
932 struct reftable_write_options cfg = { 0 };
933 struct reftable_stack *st = NULL;
934 char *dir = get_tmp_dir(__LINE__);
936 int err, i;
937 int N = 100;
939 err = reftable_new_stack(&st, dir, cfg);
940 EXPECT_ERR(err);
942 st->disable_auto_compact = 1; /* call manually below for coverage. */
943 for (i = 0; i < N; i++) {
944 char name[100];
945 struct reftable_ref_record ref = {
946 .refname = name,
947 .update_index = reftable_stack_next_update_index(st),
948 .value_type = REFTABLE_REF_SYMREF,
949 .value.symref = "master",
951 snprintf(name, sizeof(name), "branch%04d", i);
953 err = reftable_stack_add(st, &write_test_ref, &ref);
954 EXPECT_ERR(err);
956 err = reftable_stack_auto_compact(st);
957 EXPECT_ERR(err);
958 EXPECT(i < 3 || st->merged->stack_len < 2 * fastlog2(i));
961 EXPECT(reftable_stack_compaction_stats(st)->entries_written <
962 (uint64_t)(N * fastlog2(N)));
964 reftable_stack_destroy(st);
965 clear_dir(dir);
968 static void test_reftable_stack_add_performs_auto_compaction(void)
970 struct reftable_write_options cfg = { 0 };
971 struct reftable_stack *st = NULL;
972 struct strbuf refname = STRBUF_INIT;
973 char *dir = get_tmp_dir(__LINE__);
974 int err, i, n = 20;
976 err = reftable_new_stack(&st, dir, cfg);
977 EXPECT_ERR(err);
979 for (i = 0; i <= n; i++) {
980 struct reftable_ref_record ref = {
981 .update_index = reftable_stack_next_update_index(st),
982 .value_type = REFTABLE_REF_SYMREF,
983 .value.symref = "master",
987 * Disable auto-compaction for all but the last runs. Like this
988 * we can ensure that we indeed honor this setting and have
989 * better control over when exactly auto compaction runs.
991 st->disable_auto_compact = i != n;
993 strbuf_reset(&refname);
994 strbuf_addf(&refname, "branch-%04d", i);
995 ref.refname = refname.buf;
997 err = reftable_stack_add(st, &write_test_ref, &ref);
998 EXPECT_ERR(err);
1001 * The stack length should grow continuously for all runs where
1002 * auto compaction is disabled. When enabled, we should merge
1003 * all tables in the stack.
1005 if (i != n)
1006 EXPECT(st->merged->stack_len == i + 1);
1007 else
1008 EXPECT(st->merged->stack_len == 1);
1011 reftable_stack_destroy(st);
1012 strbuf_release(&refname);
1013 clear_dir(dir);
1016 static void test_reftable_stack_compaction_concurrent(void)
1018 struct reftable_write_options cfg = { 0 };
1019 struct reftable_stack *st1 = NULL, *st2 = NULL;
1020 char *dir = get_tmp_dir(__LINE__);
1022 int err, i;
1023 int N = 3;
1025 err = reftable_new_stack(&st1, dir, cfg);
1026 EXPECT_ERR(err);
1028 for (i = 0; i < N; i++) {
1029 char name[100];
1030 struct reftable_ref_record ref = {
1031 .refname = name,
1032 .update_index = reftable_stack_next_update_index(st1),
1033 .value_type = REFTABLE_REF_SYMREF,
1034 .value.symref = "master",
1036 snprintf(name, sizeof(name), "branch%04d", i);
1038 err = reftable_stack_add(st1, &write_test_ref, &ref);
1039 EXPECT_ERR(err);
1042 err = reftable_new_stack(&st2, dir, cfg);
1043 EXPECT_ERR(err);
1045 err = reftable_stack_compact_all(st1, NULL);
1046 EXPECT_ERR(err);
1048 reftable_stack_destroy(st1);
1049 reftable_stack_destroy(st2);
1051 EXPECT(count_dir_entries(dir) == 2);
1052 clear_dir(dir);
1055 static void unclean_stack_close(struct reftable_stack *st)
1057 /* break abstraction boundary to simulate unclean shutdown. */
1058 int i = 0;
1059 for (; i < st->readers_len; i++) {
1060 reftable_reader_free(st->readers[i]);
1062 st->readers_len = 0;
1063 FREE_AND_NULL(st->readers);
1066 static void test_reftable_stack_compaction_concurrent_clean(void)
1068 struct reftable_write_options cfg = { 0 };
1069 struct reftable_stack *st1 = NULL, *st2 = NULL, *st3 = NULL;
1070 char *dir = get_tmp_dir(__LINE__);
1072 int err, i;
1073 int N = 3;
1075 err = reftable_new_stack(&st1, dir, cfg);
1076 EXPECT_ERR(err);
1078 for (i = 0; i < N; i++) {
1079 char name[100];
1080 struct reftable_ref_record ref = {
1081 .refname = name,
1082 .update_index = reftable_stack_next_update_index(st1),
1083 .value_type = REFTABLE_REF_SYMREF,
1084 .value.symref = "master",
1086 snprintf(name, sizeof(name), "branch%04d", i);
1088 err = reftable_stack_add(st1, &write_test_ref, &ref);
1089 EXPECT_ERR(err);
1092 err = reftable_new_stack(&st2, dir, cfg);
1093 EXPECT_ERR(err);
1095 err = reftable_stack_compact_all(st1, NULL);
1096 EXPECT_ERR(err);
1098 unclean_stack_close(st1);
1099 unclean_stack_close(st2);
1101 err = reftable_new_stack(&st3, dir, cfg);
1102 EXPECT_ERR(err);
1104 err = reftable_stack_clean(st3);
1105 EXPECT_ERR(err);
1106 EXPECT(count_dir_entries(dir) == 2);
1108 reftable_stack_destroy(st1);
1109 reftable_stack_destroy(st2);
1110 reftable_stack_destroy(st3);
1112 clear_dir(dir);
1115 int stack_test_main(int argc, const char *argv[])
1117 RUN_TEST(test_empty_add);
1118 RUN_TEST(test_log2);
1119 RUN_TEST(test_names_equal);
1120 RUN_TEST(test_parse_names);
1121 RUN_TEST(test_read_file);
1122 RUN_TEST(test_reflog_expire);
1123 RUN_TEST(test_reftable_stack_add);
1124 RUN_TEST(test_reftable_stack_add_one);
1125 RUN_TEST(test_reftable_stack_auto_compaction);
1126 RUN_TEST(test_reftable_stack_add_performs_auto_compaction);
1127 RUN_TEST(test_reftable_stack_compaction_concurrent);
1128 RUN_TEST(test_reftable_stack_compaction_concurrent_clean);
1129 RUN_TEST(test_reftable_stack_hash_id);
1130 RUN_TEST(test_reftable_stack_lock_failure);
1131 RUN_TEST(test_reftable_stack_log_normalize);
1132 RUN_TEST(test_reftable_stack_tombstone);
1133 RUN_TEST(test_reftable_stack_transaction_api);
1134 RUN_TEST(test_reftable_stack_transaction_api_performs_auto_compaction);
1135 RUN_TEST(test_reftable_stack_auto_compaction_fails_gracefully);
1136 RUN_TEST(test_reftable_stack_update_index_check);
1137 RUN_TEST(test_reftable_stack_uptodate);
1138 RUN_TEST(test_reftable_stack_validate_refname);
1139 RUN_TEST(test_sizes_to_segments);
1140 RUN_TEST(test_sizes_to_segments_all_equal);
1141 RUN_TEST(test_sizes_to_segments_empty);
1142 RUN_TEST(test_suggest_compaction_segment);
1143 RUN_TEST(test_suggest_compaction_segment_nothing);
1144 return 0;