Skip to content

Commit

Permalink
git-cat-file: Add --batch option
Browse files Browse the repository at this point in the history 
--batch is similar to --batch-check, except that the contents of each object is
also printed. The output's form is:

<sha1> SP <type> SP <size> LF
<contents> LF

Signed-off-by: Adam Roben <aroben@apple.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
  • Loading branch information
Adam Roben authored and Junio C Hamano committed May 6, 2008
1 parent 05d5667 commit a8128ed
Show file tree
Hide file tree
Showing 3 changed files with 117 additions and 38 deletions.
18 changes: 15 additions & 3 deletions Documentation/git-cat-file.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ git-cat-file - Provide content or type/size information for repository objects
SYNOPSIS
--------
'git-cat-file' [-t | -s | -e | -p | <type>] <object>
'git-cat-file' --batch-check < <list-of-objects>
'git-cat-file' [--batch | --batch-check] < <list-of-objects>

DESCRIPTION
-----------
Expand Down Expand Up @@ -50,6 +50,10 @@ OPTIONS
or to ask for a "blob" with <object> being a tag object that
points at it.

--batch::
Print the SHA1, type, size, and contents of each object provided on
stdin. May not be combined with any other options or arguments.

--batch-check::
Print the SHA1, type, and size of each object provided on stdin. May not be
combined with any other options or arguments.
Expand All @@ -67,15 +71,23 @@ If '-p' is specified, the contents of <object> are pretty-printed.
If <type> is specified, the raw (though uncompressed) contents of the <object>
will be returned.

If '--batch' is specified, output of the following form is printed for each
object specified on stdin:

------------
<sha1> SP <type> SP <size> LF
<contents> LF
------------

If '--batch-check' is specified, output of the following form is printed for
each object specified fon stdin:

------------
<sha1> SP <type> SP <size> LF
------------

Additionally, output of the following form is printed for each object specified
on stdin that does not exist in the repository:
For both '--batch' and '--batch-check', output of the following form is printed
for each object specified on stdin that does not exist in the repository:

------------
<object> SP missing LF
Expand Down
63 changes: 45 additions & 18 deletions builtin-cat-file.c
View file
Original file line number Diff line number Diff line change
Expand Up @@ -143,11 +143,12 @@ static int cat_one_file(int opt, const char *exp_type, const char *obj_name)
return 0;
}

static int batch_one_object(const char *obj_name)
static int batch_one_object(const char *obj_name, int print_contents)
{
unsigned char sha1[20];
enum object_type type;
unsigned long size;
void *contents = contents;

if (!obj_name)
return 1;
Expand All @@ -157,60 +158,85 @@ static int batch_one_object(const char *obj_name)
return 0;
}

type = sha1_object_info(sha1, &size);
if (print_contents)
contents = read_sha1_file(sha1, &type, &size);
else
type = sha1_object_info(sha1, &size);

if (type <= 0)
return 1;

printf("%s %s %lu\n", sha1_to_hex(sha1), typename(type), size);
fflush(stdout);

if (print_contents) {
write_or_die(1, contents, size);
printf("\n");
fflush(stdout);
}

return 0;
}

static int batch_objects(void)
static int batch_objects(int print_contents)
{
struct strbuf buf;

strbuf_init(&buf, 0);
while (strbuf_getline(&buf, stdin, '\n') != EOF) {
int error = batch_one_object(buf.buf);
int error = batch_one_object(buf.buf, print_contents);
if (error)
return error;
}

return 0;
}

static const char cat_file_usage[] = "git-cat-file [ [-t|-s|-e|-p|<type>] <sha1> | --batch-check < <list_of_sha1s> ]";
static const char cat_file_usage[] = "git-cat-file [ [-t|-s|-e|-p|<type>] <sha1> | [--batch|--batch-check] < <list_of_sha1s> ]";

int cmd_cat_file(int argc, const char **argv, const char *prefix)
{
int i, opt = 0, batch_check = 0;
int i, opt = 0, batch = 0, batch_check = 0;
const char *exp_type = NULL, *obj_name = NULL;

git_config(git_default_config);

for (i = 1; i < argc; ++i) {
const char *arg = argv[i];
int is_batch = 0, is_batch_check = 0;

is_batch = !strcmp(arg, "--batch");
if (!is_batch)
is_batch_check = !strcmp(arg, "--batch-check");

if (!strcmp(arg, "--batch-check")) {
if (is_batch || is_batch_check) {
if (opt) {
error("git-cat-file: Can't use --batch-check with -%c", opt);
error("git-cat-file: Can't use %s with -%c", arg, 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);
error("git-cat-file: Can't use %s when a type (\"%s\") is specified", arg, 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);
error("git-cat-file: Can't use %s when an object (\"%s\") is specified", arg, obj_name);
usage(cat_file_usage);
}

batch_check = 1;
if ((is_batch && batch_check) || (is_batch_check && batch)) {
error("git-cat-file: Can't use %s with %s", arg, is_batch ? "--batch-check" : "--batch");
usage(cat_file_usage);
}

if (is_batch)
batch = 1;
else
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);
if (batch || batch_check) {
error("git-cat-file: Can't use %s with %s", arg, batch ? "--batch" : "--batch-check");
usage(cat_file_usage);
}

Expand All @@ -223,8 +249,8 @@ 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);
if (batch || batch_check) {
error("git-cat-file: Can't specify a type (\"%s\") with %s", arg, batch ? "--batch" : "--batch-check");
usage(cat_file_usage);
}

Expand All @@ -235,16 +261,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
// We should have hit one of the earlier if (batch || batch_check) cases before
// getting here.
assert(!batch);
assert(!batch_check);

obj_name = arg;
break;
}

if (batch_check)
return batch_objects();
if (batch || batch_check)
return batch_objects(batch);

if (!exp_type || !obj_name)
usage(cat_file_usage);
Expand Down
74 changes: 57 additions & 17 deletions t/t1006-cat-file.sh
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,9 @@ run_tests () {
pretty_content=$5
no_ts=$6

batch_output="$sha1 $type $size
$content"

test_expect_success "$type exists" '
git cat-file -e $sha1
'
Expand Down Expand Up @@ -68,6 +71,20 @@ run_tests () {
fi
'

test -z "$content" ||
test_expect_success "--batch output of $type is correct" '
expect="$(maybe_remove_timestamp "$batch_output" $no_ts)"
actual="$(maybe_remove_timestamp "$(echo $sha1 | git cat-file --batch)" no_ts)"
if test "z$expect" = "z$actual"
then
: happy
else
echo "Oops: expected $expect"
echo "but got $actual"
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)"
Expand Down Expand Up @@ -131,28 +148,31 @@ 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
for batch in batch batch-check
do
test_expect_success "Passing -$opt with --batch-check fails" '
test_must_fail git cat-file --batch-check -$opt $hello_sha1
for opt in t s e p
do
test_expect_success "Passing -$opt with --$batch fails" '
test_must_fail git cat-file --$batch -$opt $hello_sha1
'

test_expect_success "Passing --$batch with -$opt fails" '
test_must_fail git cat-file -$opt --$batch $hello_sha1
'
done

test_expect_success "Passing <type> with --$batch fails" '
test_must_fail git cat-file --$batch blob $hello_sha1
'

test_expect_success "Passing --batch-check with -$opt fails" '
test_must_fail git cat-file -$opt --batch-check $hello_sha1
test_expect_success "Passing --$batch with <type> fails" '
test_must_fail git cat-file blob --$batch $hello_sha1
'
done

test_expect_success "Passing <type> with --batch-check fails" '
test_must_fail git cat-file --batch-check blob $hello_sha1
'

test_expect_success "Passing --batch-check with <type> 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 "Passing sha1 with --$batch fails" '
test_must_fail git cat-file --$batch $hello_sha1
'
done

test_expect_success "--batch-check for a non-existent object" '
test "deadbeef missing" = \
Expand All @@ -163,6 +183,26 @@ test_expect_success "--batch-check for an emtpy line" '
test " missing" = "$(echo | git cat-file --batch-check)"
'

batch_input="$hello_sha1
$commit_sha1
$tag_sha1
deadbeef
"

batch_output="$hello_sha1 blob $hello_size
$hello_content
$commit_sha1 commit $commit_size
$commit_content
$tag_sha1 tag $tag_size
$tag_content
deadbeef missing
missing"

test_expect_success \
"--batch with multiple sha1s gives correct format" \
"test \"\$(maybe_remove_timestamp \"$batch_output\" 1)\" = \"\$(maybe_remove_timestamp \"\$(echo_without_newline \"$batch_input\" | git cat-file --batch)\" 1)\""

batch_check_input="$hello_sha1
$tree_sha1
$commit_sha1
Expand Down

0 comments on commit a8128ed

Please sign in to comment.