From 05d5667fec9650b049f47edd8cca23a43b135365 Mon Sep 17 00:00:00 2001 From: Adam Roben Date: Wed, 23 Apr 2008 15:17:46 -0400 Subject: git-cat-file: Add --batch-check option This new option allows multiple objects to be specified on stdin. For each object specified, a line of the following form is printed: SP SP LF If the object does not exist in the repository, a line of the following form is printed: SP missing LF Signed-off-by: Adam Roben Signed-off-by: Junio C Hamano --- Documentation/git-cat-file.txt | 31 +++++++++++++++--- builtin-cat-file.c | 74 ++++++++++++++++++++++++++++++++++++++++-- t/t1006-cat-file.sh | 65 +++++++++++++++++++++++++++++++++++++ 3 files changed, 163 insertions(+), 7 deletions(-) diff --git a/Documentation/git-cat-file.txt b/Documentation/git-cat-file.txt index df42cb10f..d5821af30 100644 --- a/Documentation/git-cat-file.txt +++ b/Documentation/git-cat-file.txt @@ -9,12 +9,16 @@ git-cat-file - Provide content or type/size information for repository objects SYNOPSIS -------- 'git-cat-file' [-t | -s | -e | -p | ] +'git-cat-file' --batch-check < DESCRIPTION ----------- -Provides content or type of objects in the repository. The type -is required unless '-t' or '-p' is used to find the object type, -or '-s' is used to find the object size. +In the first form, provides content or type of objects in the repository. The +type is required unless '-t' or '-p' is used to find the object type, or '-s' +is used to find the object size. + +In the second form, a list of object (separated by LFs) is provided on stdin, +and the SHA1, type, and size of each object is printed on stdout. OPTIONS ------- @@ -46,6 +50,10 @@ OPTIONS or to ask for a "blob" with being a tag object that points at it. +--batch-check:: + Print the SHA1, type, and size of each object provided on stdin. May not be + combined with any other options or arguments. + OUTPUT ------ If '-t' is specified, one of the . @@ -56,9 +64,22 @@ If '-e' is specified, no output. If '-p' is specified, the contents of are pretty-printed. -Otherwise the raw (though uncompressed) contents of the will -be returned. +If is specified, the raw (though uncompressed) contents of the +will be returned. + +If '--batch-check' is specified, output of the following form is printed for +each object specified fon stdin: + +------------ + SP SP LF +------------ + +Additionally, output of the following form is printed for each object specified +on stdin that does not exist in the repository: +------------ + SP missing LF +------------ Author ------ diff --git a/builtin-cat-file.c b/builtin-cat-file.c index a76bb16b4..832cfd184 100644 --- a/builtin-cat-file.c +++ b/builtin-cat-file.c @@ -143,11 +143,48 @@ static int cat_one_file(int opt, const char *exp_type, const char *obj_name) return 0; } -static const char cat_file_usage[] = "git-cat-file [-t|-s|-e|-p|] "; +static int batch_one_object(const char *obj_name) +{ + unsigned char sha1[20]; + enum object_type type; + unsigned long size; + + if (!obj_name) + return 1; + + if (get_sha1(obj_name, sha1)) { + printf("%s missing\n", obj_name); + return 0; + } + + type = sha1_object_info(sha1, &size); + if (type <= 0) + return 1; + + printf("%s %s %lu\n", sha1_to_hex(sha1), typename(type), size); + + return 0; +} + +static int batch_objects(void) +{ + struct strbuf buf; + + strbuf_init(&buf, 0); + while (strbuf_getline(&buf, stdin, '\n') != EOF) { + int error = batch_one_object(buf.buf); + if (error) + return error; + } + + return 0; +} + +static const char cat_file_usage[] = "git-cat-file [ [-t|-s|-e|-p|] | --batch-check < ]"; int cmd_cat_file(int argc, const char **argv, const char *prefix) { - int i, opt = 0; + int i, opt = 0, batch_check = 0; const char *exp_type = NULL, *obj_name = NULL; git_config(git_default_config); @@ -155,7 +192,28 @@ int cmd_cat_file(int argc, const char **argv, const char *prefix) for (i = 1; i < argc; ++i) { const char *arg = argv[i]; + if (!strcmp(arg, "--batch-check")) { + if (opt) { + error("git-cat-file: Can't use --batch-check with -%c", opt); + usage(cat_file_usage); + } else if (exp_type) { + error("git-cat-file: Can't use --batch-check when a type (\"%s\") is specified", exp_type); + usage(cat_file_usage); + } else if (obj_name) { + error("git-cat-file: Can't use --batch-check when an object (\"%s\") is specified", obj_name); + usage(cat_file_usage); + } + + batch_check = 1; + continue; + } + if (!strcmp(arg, "-t") || !strcmp(arg, "-s") || !strcmp(arg, "-e") || !strcmp(arg, "-p")) { + if (batch_check) { + error("git-cat-file: Can't use %s with --batch-check", arg); + usage(cat_file_usage); + } + exp_type = arg; opt = exp_type[1]; continue; @@ -165,6 +223,11 @@ int cmd_cat_file(int argc, const char **argv, const char *prefix) usage(cat_file_usage); if (!exp_type) { + if (batch_check) { + error("git-cat-file: Can't specify a type (\"%s\") with --batch-check", arg); + usage(cat_file_usage); + } + exp_type = arg; continue; } @@ -172,10 +235,17 @@ int cmd_cat_file(int argc, const char **argv, const char *prefix) if (obj_name) usage(cat_file_usage); + // We should have hit one of the earlier if (batch_check) cases before + // getting here. + assert(!batch_check); + obj_name = arg; break; } + if (batch_check) + return batch_objects(); + if (!exp_type || !obj_name) usage(cat_file_usage); diff --git a/t/t1006-cat-file.sh b/t/t1006-cat-file.sh index 0f7cc0371..decba0274 100755 --- a/t/t1006-cat-file.sh +++ b/t/t1006-cat-file.sh @@ -67,6 +67,19 @@ run_tests () { false fi ' + + test_expect_success "--batch-check output of $type is correct" ' + expect="$sha1 $type $size" + actual="$(echo_without_newline $sha1 | git cat-file --batch-check)" + if test "z$expect" = "z$actual" + then + : happy + else + echo "Oops: expected $expect" + echo "but got $actual" + false + fi + ' } hello_content="Hello World" @@ -118,4 +131,56 @@ test_expect_success \ "Reach a blob from a tag pointing to it" \ "test '$hello_content' = \"\$(git cat-file blob $tag_sha1)\"" +for opt in t s e p +do + test_expect_success "Passing -$opt with --batch-check fails" ' + test_must_fail git cat-file --batch-check -$opt $hello_sha1 + ' + + test_expect_success "Passing --batch-check with -$opt fails" ' + test_must_fail git cat-file -$opt --batch-check $hello_sha1 + ' +done + +test_expect_success "Passing with --batch-check fails" ' + test_must_fail git cat-file --batch-check blob $hello_sha1 +' + +test_expect_success "Passing --batch-check with fails" ' + test_must_fail git cat-file blob --batch-check $hello_sha1 +' + +test_expect_success "Passing sha1 with --batch-check fails" ' + test_must_fail git cat-file --batch-check $hello_sha1 +' + +test_expect_success "--batch-check for a non-existent object" ' + test "deadbeef missing" = \ + "$(echo_without_newline deadbeef | git cat-file --batch-check)" +' + +test_expect_success "--batch-check for an emtpy line" ' + test " missing" = "$(echo | git cat-file --batch-check)" +' + +batch_check_input="$hello_sha1 +$tree_sha1 +$commit_sha1 +$tag_sha1 +deadbeef + +" + +batch_check_output="$hello_sha1 blob $hello_size +$tree_sha1 tree $tree_size +$commit_sha1 commit $commit_size +$tag_sha1 tag $tag_size +deadbeef missing + missing" + +test_expect_success "--batch-check with multiple sha1s gives correct format" ' + test "$batch_check_output" = \ + "$(echo_without_newline "$batch_check_input" | git cat-file --batch-check)" +' + test_done -- cgit v1.2.1