]> git.ipfire.org Git - thirdparty/git.git/commitdiff
bundle: let "-" mean stdin for reading operations
authorJeff King <peff@peff.net>
Sat, 4 Mar 2023 10:26:14 +0000 (05:26 -0500)
committerJunio C Hamano <gitster@pobox.com>
Mon, 6 Mar 2023 21:12:55 +0000 (13:12 -0800)
For writing, "bundle create -" indicates that the bundle should be
written to stdout. But there's no matching handling of "-" for reading
operations. This is inconsistent, and a little inflexible (though one
can always use "/dev/stdin" on systems that support it).

However, it's easy to change. Once upon a time, the bundle-reading code
required a seekable descriptor, but that was fixed long ago in
e9ee84cf28b (bundle: allowing to read from an unseekable fd,
2011-10-13). So we just need to handle "-" explicitly when opening the
file.

We _could_ do this by handling "-" in read_bundle_header(), which the
reading functions all call already. But that is probably a bad idea.
It's also used by low-level code like the transport functions, and we
may want to be more careful there. We do not know that stdin is even
available to us, and certainly we would not want to get confused by a
configured URL that happens to point to "-".

So instead, let's add a helper to builtin/bundle.c. Since both the
bundle code and some of the callers refer to the bundle by name for
error messages, let's use the string "<stdin>" to make the output a bit
nicer to read.

Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
builtin/bundle.c
t/t6020-bundle-misc.sh

index acceef6200172cf7a44de45bfa6f3e940b6444c9..02dab1cfa023dd0b565b5ffaf2433379eb8c50df 100644 (file)
@@ -107,6 +107,23 @@ static int cmd_bundle_create(int argc, const char **argv, const char *prefix) {
        return ret;
 }
 
+/*
+ * Similar to read_bundle_header(), but handle "-" as stdin.
+ */
+static int open_bundle(const char *path, struct bundle_header *header,
+                      const char **name)
+{
+       if (!strcmp(path, "-")) {
+               if (name)
+                       *name = "<stdin>";
+               return read_bundle_header_fd(0, header, "<stdin>");
+       }
+
+       if (name)
+               *name = path;
+       return read_bundle_header(path, header);
+}
+
 static int cmd_bundle_verify(int argc, const char **argv, const char *prefix) {
        struct bundle_header header = BUNDLE_HEADER_INIT;
        int bundle_fd = -1;
@@ -118,12 +135,13 @@ static int cmd_bundle_verify(int argc, const char **argv, const char *prefix) {
                OPT_END()
        };
        char *bundle_file;
+       const char *name;
 
        argc = parse_options_cmd_bundle(argc, argv, prefix,
                        builtin_bundle_verify_usage, options, &bundle_file);
        /* bundle internals use argv[1] as further parameters */
 
-       if ((bundle_fd = read_bundle_header(bundle_file, &header)) < 0) {
+       if ((bundle_fd = open_bundle(bundle_file, &header, &name)) < 0) {
                ret = 1;
                goto cleanup;
        }
@@ -134,7 +152,7 @@ static int cmd_bundle_verify(int argc, const char **argv, const char *prefix) {
                goto cleanup;
        }
 
-       fprintf(stderr, _("%s is okay\n"), bundle_file);
+       fprintf(stderr, _("%s is okay\n"), name);
        ret = 0;
 cleanup:
        free(bundle_file);
@@ -155,7 +173,7 @@ static int cmd_bundle_list_heads(int argc, const char **argv, const char *prefix
                        builtin_bundle_list_heads_usage, options, &bundle_file);
        /* bundle internals use argv[1] as further parameters */
 
-       if ((bundle_fd = read_bundle_header(bundle_file, &header)) < 0) {
+       if ((bundle_fd = open_bundle(bundle_file, &header, NULL)) < 0) {
                ret = 1;
                goto cleanup;
        }
@@ -185,7 +203,7 @@ static int cmd_bundle_unbundle(int argc, const char **argv, const char *prefix)
                        builtin_bundle_unbundle_usage, options, &bundle_file);
        /* bundle internals use argv[1] as further parameters */
 
-       if ((bundle_fd = read_bundle_header(bundle_file, &header)) < 0) {
+       if ((bundle_fd = open_bundle(bundle_file, &header, NULL)) < 0) {
                ret = 1;
                goto cleanup;
        }
index 3a1cf30b1d737e3bc5cb34039822b7d45ab99445..063e8ce6b4a73dafb863ad69855f60e881eb2918 100755 (executable)
@@ -566,4 +566,19 @@ test_expect_success 'cloning from filtered bundle has useful error' '
        grep "cannot clone from filtered bundle" err
 '
 
+test_expect_success 'read bundle over stdin' '
+       git bundle create some.bundle HEAD &&
+
+       git bundle verify - <some.bundle 2>err &&
+       grep "<stdin> is okay" err &&
+
+       git bundle list-heads some.bundle >expect &&
+       git bundle list-heads - <some.bundle >actual &&
+       test_cmp expect actual &&
+
+       git bundle unbundle some.bundle >expect &&
+       git bundle unbundle - <some.bundle >actual &&
+       test_cmp expect actual
+'
+
 test_done