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"
16 #include "test_framework.h"
17 #include "reftable-tests.h"
18 #include "reftable-writer.h"
20 static const int update_index
= 5;
22 static void test_buffer(void)
24 struct strbuf buf
= STRBUF_INIT
;
25 struct reftable_block_source source
= { NULL
};
26 struct reftable_block out
= { NULL
};
28 uint8_t in
[] = "hello";
29 strbuf_add(&buf
, in
, sizeof(in
));
30 block_source_from_strbuf(&source
, &buf
);
31 EXPECT(block_source_size(&source
) == 6);
32 n
= block_source_read_block(&source
, &out
, 0, sizeof(in
));
33 EXPECT(n
== sizeof(in
));
34 EXPECT(!memcmp(in
, out
.data
, n
));
35 reftable_block_done(&out
);
37 n
= block_source_read_block(&source
, &out
, 1, 2);
39 EXPECT(!memcmp(out
.data
, "el", 2));
41 reftable_block_done(&out
);
42 block_source_close(&source
);
46 static void write_table(char ***names
, struct strbuf
*buf
, int N
,
47 int block_size
, uint32_t hash_id
)
49 struct reftable_write_options opts
= {
50 .block_size
= block_size
,
53 struct reftable_writer
*w
=
54 reftable_new_writer(&strbuf_add_void
, buf
, &opts
);
55 struct reftable_ref_record ref
= { NULL
};
57 struct reftable_log_record log
= { NULL
};
58 const struct reftable_stats
*stats
= NULL
;
59 *names
= reftable_calloc(sizeof(char *) * (N
+ 1));
60 reftable_writer_set_limits(w
, update_index
, update_index
);
61 for (i
= 0; i
< N
; i
++) {
62 uint8_t hash
[GIT_SHA256_RAWSZ
] = { 0 };
66 set_test_hash(hash
, i
);
68 snprintf(name
, sizeof(name
), "refs/heads/branch%02d", i
);
71 ref
.update_index
= update_index
;
72 ref
.value_type
= REFTABLE_REF_VAL1
;
73 ref
.value
.val1
= hash
;
74 (*names
)[i
] = xstrdup(name
);
76 n
= reftable_writer_add_ref(w
, &ref
);
80 for (i
= 0; i
< N
; i
++) {
81 uint8_t hash
[GIT_SHA256_RAWSZ
] = { 0 };
85 set_test_hash(hash
, i
);
87 snprintf(name
, sizeof(name
), "refs/heads/branch%02d", i
);
90 log
.update_index
= update_index
;
91 log
.value_type
= REFTABLE_LOG_UPDATE
;
92 log
.value
.update
.new_hash
= hash
;
93 log
.value
.update
.message
= "message";
95 n
= reftable_writer_add_log(w
, &log
);
99 n
= reftable_writer_close(w
);
102 stats
= reftable_writer_stats(w
);
103 for (i
= 0; i
< stats
->ref_stats
.blocks
; i
++) {
104 int off
= i
* opts
.block_size
;
107 (hash_id
== GIT_SHA256_FORMAT_ID
) ? 2 : 1);
109 EXPECT(buf
->buf
[off
] == 'r');
112 EXPECT(stats
->log_stats
.blocks
> 0);
113 reftable_writer_free(w
);
116 static void test_log_buffer_size(void)
118 struct strbuf buf
= STRBUF_INIT
;
119 struct reftable_write_options opts
= {
124 struct reftable_log_record
125 log
= { .refname
= "refs/heads/master",
127 .value_type
= REFTABLE_LOG_UPDATE
,
128 .value
= { .update
= {
129 .name
= "Han-Wen Nienhuys",
130 .email
= "hanwen@google.com",
133 .message
= "commit: 9\n",
135 struct reftable_writer
*w
=
136 reftable_new_writer(&strbuf_add_void
, &buf
, &opts
);
138 /* This tests buffer extension for log compression. Must use a random
139 hash, to ensure that the compressed part is larger than the original.
141 uint8_t hash1
[GIT_SHA1_RAWSZ
], hash2
[GIT_SHA1_RAWSZ
];
142 for (i
= 0; i
< GIT_SHA1_RAWSZ
; i
++) {
143 hash1
[i
] = (uint8_t)(git_rand() % 256);
144 hash2
[i
] = (uint8_t)(git_rand() % 256);
146 log
.value
.update
.old_hash
= hash1
;
147 log
.value
.update
.new_hash
= hash2
;
148 reftable_writer_set_limits(w
, update_index
, update_index
);
149 err
= reftable_writer_add_log(w
, &log
);
151 err
= reftable_writer_close(w
);
153 reftable_writer_free(w
);
154 strbuf_release(&buf
);
157 static void test_log_overflow(void)
159 struct strbuf buf
= STRBUF_INIT
;
160 char msg
[256] = { 0 };
161 struct reftable_write_options opts
= {
162 .block_size
= ARRAY_SIZE(msg
),
165 struct reftable_log_record
166 log
= { .refname
= "refs/heads/master",
168 .value_type
= REFTABLE_LOG_UPDATE
,
169 .value
= { .update
= {
170 .name
= "Han-Wen Nienhuys",
171 .email
= "hanwen@google.com",
176 struct reftable_writer
*w
=
177 reftable_new_writer(&strbuf_add_void
, &buf
, &opts
);
179 uint8_t hash1
[GIT_SHA1_RAWSZ
] = {1}, hash2
[GIT_SHA1_RAWSZ
] = { 2 };
181 memset(msg
, 'x', sizeof(msg
) - 1);
182 log
.value
.update
.old_hash
= hash1
;
183 log
.value
.update
.new_hash
= hash2
;
184 reftable_writer_set_limits(w
, update_index
, update_index
);
185 err
= reftable_writer_add_log(w
, &log
);
186 EXPECT(err
== REFTABLE_ENTRY_TOO_BIG_ERROR
);
187 reftable_writer_free(w
);
188 strbuf_release(&buf
);
191 static void test_log_write_read(void)
194 char **names
= reftable_calloc(sizeof(char *) * (N
+ 1));
196 struct reftable_write_options opts
= {
199 struct reftable_ref_record ref
= { NULL
};
201 struct reftable_log_record log
= { NULL
};
203 struct reftable_iterator it
= { NULL
};
204 struct reftable_reader rd
= { NULL
};
205 struct reftable_block_source source
= { NULL
};
206 struct strbuf buf
= STRBUF_INIT
;
207 struct reftable_writer
*w
=
208 reftable_new_writer(&strbuf_add_void
, &buf
, &opts
);
209 const struct reftable_stats
*stats
= NULL
;
210 reftable_writer_set_limits(w
, 0, N
);
211 for (i
= 0; i
< N
; i
++) {
213 struct reftable_ref_record ref
= { NULL
};
214 snprintf(name
, sizeof(name
), "b%02d%0*d", i
, 130, 7);
215 names
[i
] = xstrdup(name
);
217 ref
.update_index
= i
;
219 err
= reftable_writer_add_ref(w
, &ref
);
222 for (i
= 0; i
< N
; i
++) {
223 uint8_t hash1
[GIT_SHA1_RAWSZ
], hash2
[GIT_SHA1_RAWSZ
];
224 struct reftable_log_record log
= { NULL
};
225 set_test_hash(hash1
, i
);
226 set_test_hash(hash2
, i
+ 1);
228 log
.refname
= names
[i
];
229 log
.update_index
= i
;
230 log
.value_type
= REFTABLE_LOG_UPDATE
;
231 log
.value
.update
.old_hash
= hash1
;
232 log
.value
.update
.new_hash
= hash2
;
234 err
= reftable_writer_add_log(w
, &log
);
238 n
= reftable_writer_close(w
);
241 stats
= reftable_writer_stats(w
);
242 EXPECT(stats
->log_stats
.blocks
> 0);
243 reftable_writer_free(w
);
246 block_source_from_strbuf(&source
, &buf
);
248 err
= init_reader(&rd
, &source
, "file.log");
251 err
= reftable_reader_seek_ref(&rd
, &it
, names
[N
- 1]);
254 err
= reftable_iterator_next_ref(&it
, &ref
);
257 /* end of iteration. */
258 err
= reftable_iterator_next_ref(&it
, &ref
);
261 reftable_iterator_destroy(&it
);
262 reftable_ref_record_release(&ref
);
264 err
= reftable_reader_seek_log(&rd
, &it
, "");
269 int err
= reftable_iterator_next_log(&it
, &log
);
275 EXPECT_STREQ(names
[i
], log
.refname
);
276 EXPECT(i
== log
.update_index
);
278 reftable_log_record_release(&log
);
282 reftable_iterator_destroy(&it
);
285 strbuf_release(&buf
);
290 static void test_log_zlib_corruption(void)
292 struct reftable_write_options opts
= {
295 struct reftable_iterator it
= { 0 };
296 struct reftable_reader rd
= { 0 };
297 struct reftable_block_source source
= { 0 };
298 struct strbuf buf
= STRBUF_INIT
;
299 struct reftable_writer
*w
=
300 reftable_new_writer(&strbuf_add_void
, &buf
, &opts
);
301 const struct reftable_stats
*stats
= NULL
;
302 uint8_t hash1
[GIT_SHA1_RAWSZ
] = { 1 };
303 uint8_t hash2
[GIT_SHA1_RAWSZ
] = { 2 };
304 char message
[100] = { 0 };
307 struct reftable_log_record log
= {
308 .refname
= "refname",
309 .value_type
= REFTABLE_LOG_UPDATE
,
315 .email
= "myname@invalid",
321 for (i
= 0; i
< sizeof(message
) - 1; i
++)
322 message
[i
] = (uint8_t)(git_rand() % 64 + ' ');
324 reftable_writer_set_limits(w
, 1, 1);
326 err
= reftable_writer_add_log(w
, &log
);
329 n
= reftable_writer_close(w
);
332 stats
= reftable_writer_stats(w
);
333 EXPECT(stats
->log_stats
.blocks
> 0);
334 reftable_writer_free(w
);
337 /* corrupt the data. */
340 block_source_from_strbuf(&source
, &buf
);
342 err
= init_reader(&rd
, &source
, "file.log");
345 err
= reftable_reader_seek_log(&rd
, &it
, "refname");
346 EXPECT(err
== REFTABLE_ZLIB_ERROR
);
348 reftable_iterator_destroy(&it
);
351 strbuf_release(&buf
);
355 static void test_table_read_write_sequential(void)
358 struct strbuf buf
= STRBUF_INIT
;
360 struct reftable_iterator it
= { NULL
};
361 struct reftable_block_source source
= { NULL
};
362 struct reftable_reader rd
= { NULL
};
366 write_table(&names
, &buf
, N
, 256, GIT_SHA1_FORMAT_ID
);
368 block_source_from_strbuf(&source
, &buf
);
370 err
= init_reader(&rd
, &source
, "file.ref");
373 err
= reftable_reader_seek_ref(&rd
, &it
, "");
377 struct reftable_ref_record ref
= { NULL
};
378 int r
= reftable_iterator_next_ref(&it
, &ref
);
383 EXPECT(0 == strcmp(names
[j
], ref
.refname
));
384 EXPECT(update_index
== ref
.update_index
);
387 reftable_ref_record_release(&ref
);
390 reftable_iterator_destroy(&it
);
391 strbuf_release(&buf
);
397 static void test_table_write_small_table(void)
400 struct strbuf buf
= STRBUF_INIT
;
402 write_table(&names
, &buf
, N
, 4096, GIT_SHA1_FORMAT_ID
);
403 EXPECT(buf
.len
< 200);
404 strbuf_release(&buf
);
408 static void test_table_read_api(void)
411 struct strbuf buf
= STRBUF_INIT
;
413 struct reftable_reader rd
= { NULL
};
414 struct reftable_block_source source
= { NULL
};
417 struct reftable_log_record log
= { NULL
};
418 struct reftable_iterator it
= { NULL
};
420 write_table(&names
, &buf
, N
, 256, GIT_SHA1_FORMAT_ID
);
422 block_source_from_strbuf(&source
, &buf
);
424 err
= init_reader(&rd
, &source
, "file.ref");
427 err
= reftable_reader_seek_ref(&rd
, &it
, names
[0]);
430 err
= reftable_iterator_next_log(&it
, &log
);
431 EXPECT(err
== REFTABLE_API_ERROR
);
433 strbuf_release(&buf
);
434 for (i
= 0; i
< N
; i
++) {
435 reftable_free(names
[i
]);
437 reftable_iterator_destroy(&it
);
438 reftable_free(names
);
440 strbuf_release(&buf
);
443 static void test_table_read_write_seek(int index
, int hash_id
)
446 struct strbuf buf
= STRBUF_INIT
;
448 struct reftable_reader rd
= { NULL
};
449 struct reftable_block_source source
= { NULL
};
453 struct reftable_iterator it
= { NULL
};
454 struct strbuf pastLast
= STRBUF_INIT
;
455 struct reftable_ref_record ref
= { NULL
};
457 write_table(&names
, &buf
, N
, 256, hash_id
);
459 block_source_from_strbuf(&source
, &buf
);
461 err
= init_reader(&rd
, &source
, "file.ref");
463 EXPECT(hash_id
== reftable_reader_hash_id(&rd
));
466 rd
.ref_offsets
.index_offset
= 0;
468 EXPECT(rd
.ref_offsets
.index_offset
> 0);
471 for (i
= 1; i
< N
; i
++) {
472 int err
= reftable_reader_seek_ref(&rd
, &it
, names
[i
]);
474 err
= reftable_iterator_next_ref(&it
, &ref
);
476 EXPECT(0 == strcmp(names
[i
], ref
.refname
));
477 EXPECT(REFTABLE_REF_VAL1
== ref
.value_type
);
478 EXPECT(i
== ref
.value
.val1
[0]);
480 reftable_ref_record_release(&ref
);
481 reftable_iterator_destroy(&it
);
484 strbuf_addstr(&pastLast
, names
[N
- 1]);
485 strbuf_addstr(&pastLast
, "/");
487 err
= reftable_reader_seek_ref(&rd
, &it
, pastLast
.buf
);
489 struct reftable_ref_record ref
= { NULL
};
490 int err
= reftable_iterator_next_ref(&it
, &ref
);
496 strbuf_release(&pastLast
);
497 reftable_iterator_destroy(&it
);
499 strbuf_release(&buf
);
500 for (i
= 0; i
< N
; i
++) {
501 reftable_free(names
[i
]);
503 reftable_free(names
);
507 static void test_table_read_write_seek_linear(void)
509 test_table_read_write_seek(0, GIT_SHA1_FORMAT_ID
);
512 static void test_table_read_write_seek_linear_sha256(void)
514 test_table_read_write_seek(0, GIT_SHA256_FORMAT_ID
);
517 static void test_table_read_write_seek_index(void)
519 test_table_read_write_seek(1, GIT_SHA1_FORMAT_ID
);
522 static void test_table_refs_for(int indexed
)
525 char **want_names
= reftable_calloc(sizeof(char *) * (N
+ 1));
526 int want_names_len
= 0;
527 uint8_t want_hash
[GIT_SHA1_RAWSZ
];
529 struct reftable_write_options opts
= {
532 struct reftable_ref_record ref
= { NULL
};
536 struct reftable_reader rd
;
537 struct reftable_block_source source
= { NULL
};
539 struct strbuf buf
= STRBUF_INIT
;
540 struct reftable_writer
*w
=
541 reftable_new_writer(&strbuf_add_void
, &buf
, &opts
);
543 struct reftable_iterator it
= { NULL
};
546 set_test_hash(want_hash
, 4);
548 for (i
= 0; i
< N
; i
++) {
549 uint8_t hash
[GIT_SHA1_RAWSZ
];
550 char fill
[51] = { 0 };
552 uint8_t hash1
[GIT_SHA1_RAWSZ
];
553 uint8_t hash2
[GIT_SHA1_RAWSZ
];
554 struct reftable_ref_record ref
= { NULL
};
556 memset(hash
, i
, sizeof(hash
));
557 memset(fill
, 'x', 50);
558 /* Put the variable part in the start */
559 snprintf(name
, sizeof(name
), "br%02d%s", i
, fill
);
563 set_test_hash(hash1
, i
/ 4);
564 set_test_hash(hash2
, 3 + i
/ 4);
565 ref
.value_type
= REFTABLE_REF_VAL2
;
566 ref
.value
.val2
.value
= hash1
;
567 ref
.value
.val2
.target_value
= hash2
;
569 /* 80 bytes / entry, so 3 entries per block. Yields 17
572 n
= reftable_writer_add_ref(w
, &ref
);
575 if (!memcmp(hash1
, want_hash
, GIT_SHA1_RAWSZ
) ||
576 !memcmp(hash2
, want_hash
, GIT_SHA1_RAWSZ
)) {
577 want_names
[want_names_len
++] = xstrdup(name
);
581 n
= reftable_writer_close(w
);
584 reftable_writer_free(w
);
587 block_source_from_strbuf(&source
, &buf
);
589 err
= init_reader(&rd
, &source
, "file.ref");
592 rd
.obj_offsets
.is_present
= 0;
595 err
= reftable_reader_seek_ref(&rd
, &it
, "");
597 reftable_iterator_destroy(&it
);
599 err
= reftable_reader_refs_for(&rd
, &it
, want_hash
);
604 int err
= reftable_iterator_next_ref(&it
, &ref
);
610 EXPECT(j
< want_names_len
);
611 EXPECT(0 == strcmp(ref
.refname
, want_names
[j
]));
613 reftable_ref_record_release(&ref
);
615 EXPECT(j
== want_names_len
);
617 strbuf_release(&buf
);
618 free_names(want_names
);
619 reftable_iterator_destroy(&it
);
623 static void test_table_refs_for_no_index(void)
625 test_table_refs_for(0);
628 static void test_table_refs_for_obj_index(void)
630 test_table_refs_for(1);
633 static void test_write_empty_table(void)
635 struct reftable_write_options opts
= { 0 };
636 struct strbuf buf
= STRBUF_INIT
;
637 struct reftable_writer
*w
=
638 reftable_new_writer(&strbuf_add_void
, &buf
, &opts
);
639 struct reftable_block_source source
= { NULL
};
640 struct reftable_reader
*rd
= NULL
;
641 struct reftable_ref_record rec
= { NULL
};
642 struct reftable_iterator it
= { NULL
};
645 reftable_writer_set_limits(w
, 1, 1);
647 err
= reftable_writer_close(w
);
648 EXPECT(err
== REFTABLE_EMPTY_TABLE_ERROR
);
649 reftable_writer_free(w
);
651 EXPECT(buf
.len
== header_size(1) + footer_size(1));
653 block_source_from_strbuf(&source
, &buf
);
655 err
= reftable_new_reader(&rd
, &source
, "filename");
658 err
= reftable_reader_seek_ref(rd
, &it
, "");
661 err
= reftable_iterator_next_ref(&it
, &rec
);
664 reftable_iterator_destroy(&it
);
665 reftable_reader_free(rd
);
666 strbuf_release(&buf
);
669 static void test_write_object_id_min_length(void)
671 struct reftable_write_options opts
= {
674 struct strbuf buf
= STRBUF_INIT
;
675 struct reftable_writer
*w
=
676 reftable_new_writer(&strbuf_add_void
, &buf
, &opts
);
677 uint8_t hash
[GIT_SHA1_RAWSZ
] = {42};
678 struct reftable_ref_record ref
= {
680 .value_type
= REFTABLE_REF_VAL1
,
686 reftable_writer_set_limits(w
, 1, 1);
688 /* Write the same hash in many refs. If there is only 1 hash, the
689 * disambiguating prefix is length 0 */
690 for (i
= 0; i
< 256; i
++) {
692 snprintf(name
, sizeof(name
), "ref%05d", i
);
694 err
= reftable_writer_add_ref(w
, &ref
);
698 err
= reftable_writer_close(w
);
700 EXPECT(reftable_writer_stats(w
)->object_id_len
== 2);
701 reftable_writer_free(w
);
702 strbuf_release(&buf
);
705 static void test_write_object_id_length(void)
707 struct reftable_write_options opts
= {
710 struct strbuf buf
= STRBUF_INIT
;
711 struct reftable_writer
*w
=
712 reftable_new_writer(&strbuf_add_void
, &buf
, &opts
);
713 uint8_t hash
[GIT_SHA1_RAWSZ
] = {42};
714 struct reftable_ref_record ref
= {
716 .value_type
= REFTABLE_REF_VAL1
,
722 reftable_writer_set_limits(w
, 1, 1);
724 /* Write the same hash in many refs. If there is only 1 hash, the
725 * disambiguating prefix is length 0 */
726 for (i
= 0; i
< 256; i
++) {
728 snprintf(name
, sizeof(name
), "ref%05d", i
);
730 ref
.value
.val1
[15] = i
;
731 err
= reftable_writer_add_ref(w
, &ref
);
735 err
= reftable_writer_close(w
);
737 EXPECT(reftable_writer_stats(w
)->object_id_len
== 16);
738 reftable_writer_free(w
);
739 strbuf_release(&buf
);
742 static void test_write_empty_key(void)
744 struct reftable_write_options opts
= { 0 };
745 struct strbuf buf
= STRBUF_INIT
;
746 struct reftable_writer
*w
=
747 reftable_new_writer(&strbuf_add_void
, &buf
, &opts
);
748 struct reftable_ref_record ref
= {
751 .value_type
= REFTABLE_REF_DELETION
,
755 reftable_writer_set_limits(w
, 1, 1);
756 err
= reftable_writer_add_ref(w
, &ref
);
757 EXPECT(err
== REFTABLE_API_ERROR
);
759 err
= reftable_writer_close(w
);
760 EXPECT(err
== REFTABLE_EMPTY_TABLE_ERROR
);
761 reftable_writer_free(w
);
762 strbuf_release(&buf
);
765 static void test_write_key_order(void)
767 struct reftable_write_options opts
= { 0 };
768 struct strbuf buf
= STRBUF_INIT
;
769 struct reftable_writer
*w
=
770 reftable_new_writer(&strbuf_add_void
, &buf
, &opts
);
771 struct reftable_ref_record refs
[2] = {
775 .value_type
= REFTABLE_REF_SYMREF
,
782 .value_type
= REFTABLE_REF_SYMREF
,
790 reftable_writer_set_limits(w
, 1, 1);
791 err
= reftable_writer_add_ref(w
, &refs
[0]);
793 err
= reftable_writer_add_ref(w
, &refs
[1]);
794 EXPECT(err
== REFTABLE_API_ERROR
);
795 reftable_writer_close(w
);
796 reftable_writer_free(w
);
797 strbuf_release(&buf
);
800 static void test_corrupt_table_empty(void)
802 struct strbuf buf
= STRBUF_INIT
;
803 struct reftable_block_source source
= { NULL
};
804 struct reftable_reader rd
= { NULL
};
807 block_source_from_strbuf(&source
, &buf
);
808 err
= init_reader(&rd
, &source
, "file.log");
809 EXPECT(err
== REFTABLE_FORMAT_ERROR
);
812 static void test_corrupt_table(void)
814 uint8_t zeros
[1024] = { 0 };
815 struct strbuf buf
= STRBUF_INIT
;
816 struct reftable_block_source source
= { NULL
};
817 struct reftable_reader rd
= { NULL
};
819 strbuf_add(&buf
, zeros
, sizeof(zeros
));
821 block_source_from_strbuf(&source
, &buf
);
822 err
= init_reader(&rd
, &source
, "file.log");
823 EXPECT(err
== REFTABLE_FORMAT_ERROR
);
824 strbuf_release(&buf
);
827 int readwrite_test_main(int argc
, const char *argv
[])
829 RUN_TEST(test_log_zlib_corruption
);
830 RUN_TEST(test_corrupt_table
);
831 RUN_TEST(test_corrupt_table_empty
);
832 RUN_TEST(test_log_write_read
);
833 RUN_TEST(test_write_key_order
);
834 RUN_TEST(test_table_read_write_seek_linear_sha256
);
835 RUN_TEST(test_log_buffer_size
);
836 RUN_TEST(test_table_write_small_table
);
837 RUN_TEST(test_buffer
);
838 RUN_TEST(test_table_read_api
);
839 RUN_TEST(test_table_read_write_sequential
);
840 RUN_TEST(test_table_read_write_seek_linear
);
841 RUN_TEST(test_table_read_write_seek_index
);
842 RUN_TEST(test_table_refs_for_no_index
);
843 RUN_TEST(test_table_refs_for_obj_index
);
844 RUN_TEST(test_write_empty_key
);
845 RUN_TEST(test_write_empty_table
);
846 RUN_TEST(test_log_overflow
);
847 RUN_TEST(test_write_object_id_length
);
848 RUN_TEST(test_write_object_id_min_length
);