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
13 #include "blocksource.h"
14 #include "constants.h"
17 #include "test_framework.h"
18 #include "reftable-tests.h"
19 #include "reftable-writer.h"
21 static const int update_index
= 5;
23 static void test_buffer(void)
25 struct strbuf buf
= STRBUF_INIT
;
26 struct reftable_block_source source
= { NULL
};
27 struct reftable_block out
= { NULL
};
29 uint8_t in
[] = "hello";
30 strbuf_add(&buf
, in
, sizeof(in
));
31 block_source_from_strbuf(&source
, &buf
);
32 EXPECT(block_source_size(&source
) == 6);
33 n
= block_source_read_block(&source
, &out
, 0, sizeof(in
));
34 EXPECT(n
== sizeof(in
));
35 EXPECT(!memcmp(in
, out
.data
, n
));
36 reftable_block_done(&out
);
38 n
= block_source_read_block(&source
, &out
, 1, 2);
40 EXPECT(!memcmp(out
.data
, "el", 2));
42 reftable_block_done(&out
);
43 block_source_close(&source
);
47 static void write_table(char ***names
, struct strbuf
*buf
, int N
,
48 int block_size
, uint32_t hash_id
)
50 struct reftable_write_options opts
= {
51 .block_size
= block_size
,
54 struct reftable_writer
*w
=
55 reftable_new_writer(&strbuf_add_void
, buf
, &opts
);
56 struct reftable_ref_record ref
= { NULL
};
58 struct reftable_log_record log
= { NULL
};
59 const struct reftable_stats
*stats
= NULL
;
60 *names
= reftable_calloc(sizeof(char *) * (N
+ 1));
61 reftable_writer_set_limits(w
, update_index
, update_index
);
62 for (i
= 0; i
< N
; i
++) {
63 uint8_t hash
[GIT_SHA256_RAWSZ
] = { 0 };
67 set_test_hash(hash
, i
);
69 snprintf(name
, sizeof(name
), "refs/heads/branch%02d", i
);
72 ref
.update_index
= update_index
;
73 ref
.value_type
= REFTABLE_REF_VAL1
;
74 ref
.value
.val1
= hash
;
75 (*names
)[i
] = xstrdup(name
);
77 n
= reftable_writer_add_ref(w
, &ref
);
81 for (i
= 0; i
< N
; i
++) {
82 uint8_t hash
[GIT_SHA256_RAWSZ
] = { 0 };
86 set_test_hash(hash
, i
);
88 snprintf(name
, sizeof(name
), "refs/heads/branch%02d", i
);
91 log
.update_index
= update_index
;
92 log
.value_type
= REFTABLE_LOG_UPDATE
;
93 log
.value
.update
.new_hash
= hash
;
94 log
.value
.update
.message
= "message";
96 n
= reftable_writer_add_log(w
, &log
);
100 n
= reftable_writer_close(w
);
103 stats
= writer_stats(w
);
104 for (i
= 0; i
< stats
->ref_stats
.blocks
; i
++) {
105 int off
= i
* opts
.block_size
;
108 (hash_id
== GIT_SHA256_FORMAT_ID
) ? 2 : 1);
110 EXPECT(buf
->buf
[off
] == 'r');
113 EXPECT(stats
->log_stats
.blocks
> 0);
114 reftable_writer_free(w
);
117 static void test_log_buffer_size(void)
119 struct strbuf buf
= STRBUF_INIT
;
120 struct reftable_write_options opts
= {
125 struct reftable_log_record
126 log
= { .refname
= "refs/heads/master",
128 .value_type
= REFTABLE_LOG_UPDATE
,
129 .value
= { .update
= {
130 .name
= "Han-Wen Nienhuys",
131 .email
= "hanwen@google.com",
134 .message
= "commit: 9\n",
136 struct reftable_writer
*w
=
137 reftable_new_writer(&strbuf_add_void
, &buf
, &opts
);
139 /* This tests buffer extension for log compression. Must use a random
140 hash, to ensure that the compressed part is larger than the original.
142 uint8_t hash1
[GIT_SHA1_RAWSZ
], hash2
[GIT_SHA1_RAWSZ
];
143 for (i
= 0; i
< GIT_SHA1_RAWSZ
; i
++) {
144 hash1
[i
] = (uint8_t)(rand() % 256);
145 hash2
[i
] = (uint8_t)(rand() % 256);
147 log
.value
.update
.old_hash
= hash1
;
148 log
.value
.update
.new_hash
= hash2
;
149 reftable_writer_set_limits(w
, update_index
, update_index
);
150 err
= reftable_writer_add_log(w
, &log
);
152 err
= reftable_writer_close(w
);
154 reftable_writer_free(w
);
155 strbuf_release(&buf
);
158 static void test_log_write_read(void)
161 char **names
= reftable_calloc(sizeof(char *) * (N
+ 1));
163 struct reftable_write_options opts
= {
166 struct reftable_ref_record ref
= { NULL
};
168 struct reftable_log_record log
= { NULL
};
170 struct reftable_iterator it
= { NULL
};
171 struct reftable_reader rd
= { NULL
};
172 struct reftable_block_source source
= { NULL
};
173 struct strbuf buf
= STRBUF_INIT
;
174 struct reftable_writer
*w
=
175 reftable_new_writer(&strbuf_add_void
, &buf
, &opts
);
176 const struct reftable_stats
*stats
= NULL
;
177 reftable_writer_set_limits(w
, 0, N
);
178 for (i
= 0; i
< N
; i
++) {
180 struct reftable_ref_record ref
= { NULL
};
181 snprintf(name
, sizeof(name
), "b%02d%0*d", i
, 130, 7);
182 names
[i
] = xstrdup(name
);
184 ref
.update_index
= i
;
186 err
= reftable_writer_add_ref(w
, &ref
);
189 for (i
= 0; i
< N
; i
++) {
190 uint8_t hash1
[GIT_SHA1_RAWSZ
], hash2
[GIT_SHA1_RAWSZ
];
191 struct reftable_log_record log
= { NULL
};
192 set_test_hash(hash1
, i
);
193 set_test_hash(hash2
, i
+ 1);
195 log
.refname
= names
[i
];
196 log
.update_index
= i
;
197 log
.value_type
= REFTABLE_LOG_UPDATE
;
198 log
.value
.update
.old_hash
= hash1
;
199 log
.value
.update
.new_hash
= hash2
;
201 err
= reftable_writer_add_log(w
, &log
);
205 n
= reftable_writer_close(w
);
208 stats
= writer_stats(w
);
209 EXPECT(stats
->log_stats
.blocks
> 0);
210 reftable_writer_free(w
);
213 block_source_from_strbuf(&source
, &buf
);
215 err
= init_reader(&rd
, &source
, "file.log");
218 err
= reftable_reader_seek_ref(&rd
, &it
, names
[N
- 1]);
221 err
= reftable_iterator_next_ref(&it
, &ref
);
224 /* end of iteration. */
225 err
= reftable_iterator_next_ref(&it
, &ref
);
228 reftable_iterator_destroy(&it
);
229 reftable_ref_record_release(&ref
);
231 err
= reftable_reader_seek_log(&rd
, &it
, "");
236 int err
= reftable_iterator_next_log(&it
, &log
);
242 EXPECT_STREQ(names
[i
], log
.refname
);
243 EXPECT(i
== log
.update_index
);
245 reftable_log_record_release(&log
);
249 reftable_iterator_destroy(&it
);
252 strbuf_release(&buf
);
257 static void test_log_zlib_corruption(void)
259 struct reftable_write_options opts
= {
262 struct reftable_iterator it
= { 0 };
263 struct reftable_reader rd
= { 0 };
264 struct reftable_block_source source
= { 0 };
265 struct strbuf buf
= STRBUF_INIT
;
266 struct reftable_writer
*w
=
267 reftable_new_writer(&strbuf_add_void
, &buf
, &opts
);
268 const struct reftable_stats
*stats
= NULL
;
269 uint8_t hash1
[GIT_SHA1_RAWSZ
] = { 1 };
270 uint8_t hash2
[GIT_SHA1_RAWSZ
] = { 2 };
271 char message
[100] = { 0 };
274 struct reftable_log_record log
= {
275 .refname
= "refname",
276 .value_type
= REFTABLE_LOG_UPDATE
,
282 .email
= "myname@invalid",
288 for (i
= 0; i
< sizeof(message
) - 1; i
++)
289 message
[i
] = (uint8_t)(rand() % 64 + ' ');
291 reftable_writer_set_limits(w
, 1, 1);
293 err
= reftable_writer_add_log(w
, &log
);
296 n
= reftable_writer_close(w
);
299 stats
= writer_stats(w
);
300 EXPECT(stats
->log_stats
.blocks
> 0);
301 reftable_writer_free(w
);
304 /* corrupt the data. */
307 block_source_from_strbuf(&source
, &buf
);
309 err
= init_reader(&rd
, &source
, "file.log");
312 err
= reftable_reader_seek_log(&rd
, &it
, "refname");
313 EXPECT(err
== REFTABLE_ZLIB_ERROR
);
315 reftable_iterator_destroy(&it
);
318 strbuf_release(&buf
);
322 static void test_table_read_write_sequential(void)
325 struct strbuf buf
= STRBUF_INIT
;
327 struct reftable_iterator it
= { NULL
};
328 struct reftable_block_source source
= { NULL
};
329 struct reftable_reader rd
= { NULL
};
333 write_table(&names
, &buf
, N
, 256, GIT_SHA1_FORMAT_ID
);
335 block_source_from_strbuf(&source
, &buf
);
337 err
= init_reader(&rd
, &source
, "file.ref");
340 err
= reftable_reader_seek_ref(&rd
, &it
, "");
344 struct reftable_ref_record ref
= { NULL
};
345 int r
= reftable_iterator_next_ref(&it
, &ref
);
350 EXPECT(0 == strcmp(names
[j
], ref
.refname
));
351 EXPECT(update_index
== ref
.update_index
);
354 reftable_ref_record_release(&ref
);
357 reftable_iterator_destroy(&it
);
358 strbuf_release(&buf
);
364 static void test_table_write_small_table(void)
367 struct strbuf buf
= STRBUF_INIT
;
369 write_table(&names
, &buf
, N
, 4096, GIT_SHA1_FORMAT_ID
);
370 EXPECT(buf
.len
< 200);
371 strbuf_release(&buf
);
375 static void test_table_read_api(void)
378 struct strbuf buf
= STRBUF_INIT
;
380 struct reftable_reader rd
= { NULL
};
381 struct reftable_block_source source
= { NULL
};
384 struct reftable_log_record log
= { NULL
};
385 struct reftable_iterator it
= { NULL
};
387 write_table(&names
, &buf
, N
, 256, GIT_SHA1_FORMAT_ID
);
389 block_source_from_strbuf(&source
, &buf
);
391 err
= init_reader(&rd
, &source
, "file.ref");
394 err
= reftable_reader_seek_ref(&rd
, &it
, names
[0]);
397 err
= reftable_iterator_next_log(&it
, &log
);
398 EXPECT(err
== REFTABLE_API_ERROR
);
400 strbuf_release(&buf
);
401 for (i
= 0; i
< N
; i
++) {
402 reftable_free(names
[i
]);
404 reftable_iterator_destroy(&it
);
405 reftable_free(names
);
407 strbuf_release(&buf
);
410 static void test_table_read_write_seek(int index
, int hash_id
)
413 struct strbuf buf
= STRBUF_INIT
;
415 struct reftable_reader rd
= { NULL
};
416 struct reftable_block_source source
= { NULL
};
420 struct reftable_iterator it
= { NULL
};
421 struct strbuf pastLast
= STRBUF_INIT
;
422 struct reftable_ref_record ref
= { NULL
};
424 write_table(&names
, &buf
, N
, 256, hash_id
);
426 block_source_from_strbuf(&source
, &buf
);
428 err
= init_reader(&rd
, &source
, "file.ref");
430 EXPECT(hash_id
== reftable_reader_hash_id(&rd
));
433 rd
.ref_offsets
.index_offset
= 0;
435 EXPECT(rd
.ref_offsets
.index_offset
> 0);
438 for (i
= 1; i
< N
; i
++) {
439 int err
= reftable_reader_seek_ref(&rd
, &it
, names
[i
]);
441 err
= reftable_iterator_next_ref(&it
, &ref
);
443 EXPECT(0 == strcmp(names
[i
], ref
.refname
));
444 EXPECT(REFTABLE_REF_VAL1
== ref
.value_type
);
445 EXPECT(i
== ref
.value
.val1
[0]);
447 reftable_ref_record_release(&ref
);
448 reftable_iterator_destroy(&it
);
451 strbuf_addstr(&pastLast
, names
[N
- 1]);
452 strbuf_addstr(&pastLast
, "/");
454 err
= reftable_reader_seek_ref(&rd
, &it
, pastLast
.buf
);
456 struct reftable_ref_record ref
= { NULL
};
457 int err
= reftable_iterator_next_ref(&it
, &ref
);
463 strbuf_release(&pastLast
);
464 reftable_iterator_destroy(&it
);
466 strbuf_release(&buf
);
467 for (i
= 0; i
< N
; i
++) {
468 reftable_free(names
[i
]);
470 reftable_free(names
);
474 static void test_table_read_write_seek_linear(void)
476 test_table_read_write_seek(0, GIT_SHA1_FORMAT_ID
);
479 static void test_table_read_write_seek_linear_sha256(void)
481 test_table_read_write_seek(0, GIT_SHA256_FORMAT_ID
);
484 static void test_table_read_write_seek_index(void)
486 test_table_read_write_seek(1, GIT_SHA1_FORMAT_ID
);
489 static void test_table_refs_for(int indexed
)
492 char **want_names
= reftable_calloc(sizeof(char *) * (N
+ 1));
493 int want_names_len
= 0;
494 uint8_t want_hash
[GIT_SHA1_RAWSZ
];
496 struct reftable_write_options opts
= {
499 struct reftable_ref_record ref
= { NULL
};
503 struct reftable_reader rd
;
504 struct reftable_block_source source
= { NULL
};
506 struct strbuf buf
= STRBUF_INIT
;
507 struct reftable_writer
*w
=
508 reftable_new_writer(&strbuf_add_void
, &buf
, &opts
);
510 struct reftable_iterator it
= { NULL
};
513 set_test_hash(want_hash
, 4);
515 for (i
= 0; i
< N
; i
++) {
516 uint8_t hash
[GIT_SHA1_RAWSZ
];
517 char fill
[51] = { 0 };
519 uint8_t hash1
[GIT_SHA1_RAWSZ
];
520 uint8_t hash2
[GIT_SHA1_RAWSZ
];
521 struct reftable_ref_record ref
= { NULL
};
523 memset(hash
, i
, sizeof(hash
));
524 memset(fill
, 'x', 50);
525 /* Put the variable part in the start */
526 snprintf(name
, sizeof(name
), "br%02d%s", i
, fill
);
530 set_test_hash(hash1
, i
/ 4);
531 set_test_hash(hash2
, 3 + i
/ 4);
532 ref
.value_type
= REFTABLE_REF_VAL2
;
533 ref
.value
.val2
.value
= hash1
;
534 ref
.value
.val2
.target_value
= hash2
;
536 /* 80 bytes / entry, so 3 entries per block. Yields 17
539 n
= reftable_writer_add_ref(w
, &ref
);
542 if (!memcmp(hash1
, want_hash
, GIT_SHA1_RAWSZ
) ||
543 !memcmp(hash2
, want_hash
, GIT_SHA1_RAWSZ
)) {
544 want_names
[want_names_len
++] = xstrdup(name
);
548 n
= reftable_writer_close(w
);
551 reftable_writer_free(w
);
554 block_source_from_strbuf(&source
, &buf
);
556 err
= init_reader(&rd
, &source
, "file.ref");
559 rd
.obj_offsets
.is_present
= 0;
562 err
= reftable_reader_seek_ref(&rd
, &it
, "");
564 reftable_iterator_destroy(&it
);
566 err
= reftable_reader_refs_for(&rd
, &it
, want_hash
);
571 int err
= reftable_iterator_next_ref(&it
, &ref
);
577 EXPECT(j
< want_names_len
);
578 EXPECT(0 == strcmp(ref
.refname
, want_names
[j
]));
580 reftable_ref_record_release(&ref
);
582 EXPECT(j
== want_names_len
);
584 strbuf_release(&buf
);
585 free_names(want_names
);
586 reftable_iterator_destroy(&it
);
590 static void test_table_refs_for_no_index(void)
592 test_table_refs_for(0);
595 static void test_table_refs_for_obj_index(void)
597 test_table_refs_for(1);
600 static void test_write_empty_table(void)
602 struct reftable_write_options opts
= { 0 };
603 struct strbuf buf
= STRBUF_INIT
;
604 struct reftable_writer
*w
=
605 reftable_new_writer(&strbuf_add_void
, &buf
, &opts
);
606 struct reftable_block_source source
= { NULL
};
607 struct reftable_reader
*rd
= NULL
;
608 struct reftable_ref_record rec
= { NULL
};
609 struct reftable_iterator it
= { NULL
};
612 reftable_writer_set_limits(w
, 1, 1);
614 err
= reftable_writer_close(w
);
615 EXPECT(err
== REFTABLE_EMPTY_TABLE_ERROR
);
616 reftable_writer_free(w
);
618 EXPECT(buf
.len
== header_size(1) + footer_size(1));
620 block_source_from_strbuf(&source
, &buf
);
622 err
= reftable_new_reader(&rd
, &source
, "filename");
625 err
= reftable_reader_seek_ref(rd
, &it
, "");
628 err
= reftable_iterator_next_ref(&it
, &rec
);
631 reftable_iterator_destroy(&it
);
632 reftable_reader_free(rd
);
633 strbuf_release(&buf
);
636 static void test_write_key_order(void)
638 struct reftable_write_options opts
= { 0 };
639 struct strbuf buf
= STRBUF_INIT
;
640 struct reftable_writer
*w
=
641 reftable_new_writer(&strbuf_add_void
, &buf
, &opts
);
642 struct reftable_ref_record refs
[2] = {
646 .value_type
= REFTABLE_REF_SYMREF
,
653 .value_type
= REFTABLE_REF_SYMREF
,
661 reftable_writer_set_limits(w
, 1, 1);
662 err
= reftable_writer_add_ref(w
, &refs
[0]);
664 err
= reftable_writer_add_ref(w
, &refs
[1]);
665 EXPECT(err
== REFTABLE_API_ERROR
);
666 reftable_writer_close(w
);
667 reftable_writer_free(w
);
668 strbuf_release(&buf
);
671 static void test_corrupt_table_empty(void)
673 struct strbuf buf
= STRBUF_INIT
;
674 struct reftable_block_source source
= { NULL
};
675 struct reftable_reader rd
= { NULL
};
678 block_source_from_strbuf(&source
, &buf
);
679 err
= init_reader(&rd
, &source
, "file.log");
680 EXPECT(err
== REFTABLE_FORMAT_ERROR
);
683 static void test_corrupt_table(void)
685 uint8_t zeros
[1024] = { 0 };
686 struct strbuf buf
= STRBUF_INIT
;
687 struct reftable_block_source source
= { NULL
};
688 struct reftable_reader rd
= { NULL
};
690 strbuf_add(&buf
, zeros
, sizeof(zeros
));
692 block_source_from_strbuf(&source
, &buf
);
693 err
= init_reader(&rd
, &source
, "file.log");
694 EXPECT(err
== REFTABLE_FORMAT_ERROR
);
695 strbuf_release(&buf
);
698 int readwrite_test_main(int argc
, const char *argv
[])
700 RUN_TEST(test_log_zlib_corruption
);
701 RUN_TEST(test_corrupt_table
);
702 RUN_TEST(test_corrupt_table_empty
);
703 RUN_TEST(test_log_write_read
);
704 RUN_TEST(test_write_key_order
);
705 RUN_TEST(test_table_read_write_seek_linear_sha256
);
706 RUN_TEST(test_log_buffer_size
);
707 RUN_TEST(test_table_write_small_table
);
708 RUN_TEST(test_buffer
);
709 RUN_TEST(test_table_read_api
);
710 RUN_TEST(test_table_read_write_sequential
);
711 RUN_TEST(test_table_read_write_seek_linear
);
712 RUN_TEST(test_table_read_write_seek_index
);
713 RUN_TEST(test_table_refs_for_no_index
);
714 RUN_TEST(test_table_refs_for_obj_index
);
715 RUN_TEST(test_write_empty_table
);