From patchwork Tue Oct 27 09:41:36 2020 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= X-Patchwork-Id: 11859719 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org X-Spam-Level: X-Spam-Status: No, score=-17.6 required=3.0 tests=BAYES_00,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,FREEMAIL_FORGED_FROMDOMAIN,FREEMAIL_FROM, HEADER_FROM_DIFFERENT_DOMAINS,INCLUDES_PATCH,MAILING_LIST_MULTI, MENTIONS_GIT_HOSTING,SIGNED_OFF_BY,SPF_HELO_NONE,SPF_PASS,URIBL_BLOCKED, USER_AGENT_GIT autolearn=ham autolearn_force=no version=3.4.0 Received: from mail.kernel.org (mail.kernel.org [198.145.29.99]) by smtp.lore.kernel.org (Postfix) with ESMTP id B56A1C4363A for ; Tue, 27 Oct 2020 09:41:53 +0000 (UTC) Received: from vger.kernel.org (vger.kernel.org [23.128.96.18]) by mail.kernel.org (Postfix) with ESMTP id 529DD22265 for ; Tue, 27 Oct 2020 09:41:53 +0000 (UTC) Authentication-Results: mail.kernel.org; dkim=pass (2048-bit key) header.d=gmail.com header.i=@gmail.com header.b="h1g6wXyy" Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S2895727AbgJ0Jlw (ORCPT ); Tue, 27 Oct 2020 05:41:52 -0400 Received: from mail-wr1-f67.google.com ([209.85.221.67]:43706 "EHLO mail-wr1-f67.google.com" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S2895724AbgJ0Jlv (ORCPT ); Tue, 27 Oct 2020 05:41:51 -0400 Received: by mail-wr1-f67.google.com with SMTP id g12so1066860wrp.10 for ; Tue, 27 Oct 2020 02:41:48 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20161025; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=DtB+ZWPAEaH8Ju8KtW2uy11BRz9AXX5z21HmRSnx6uM=; b=h1g6wXyy0pBkafVa4VgGTsWSvNaxudXymx40pYR9OcuoqS5kp01O77h4bJOEL0zhtv A03yPS1TG/bR9/Ng2qal7SsBmSgv4lXNEzpv3ekYsGxmMGd7rnZ5Pp/5nKEnYvrCXekh 0owGNwMzLNG0sibNvc5AFG8N5rgTUXtnVgQk7+6NV1slFjEvUH9e0GKrlBo4eBwrb1gL 4vS7gd/oHw5fa21qVeATrRFWEWDdbxKu9q5/VaJGELIIors3N93iwOOnp2fvmbuJ1vEe nJ/K/GpV3LrNYq2Nn0ajEjo4EWMuFH/vpWMuZE+/iJR2L0hUTJZBvXmTJdOavYEPJqL0 Wjcg== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20161025; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=DtB+ZWPAEaH8Ju8KtW2uy11BRz9AXX5z21HmRSnx6uM=; b=aK7OvCTTqFuQirhHXgtl+AMhe1Mixj8m0K/pxNAusREpK3tDnyX/+9qZG2FHy517v1 wfHAlZgUTYuTZ/FFbLibFEw5LXlgrp3qsDXvF7B3fO/uJ6HFPcwIIuFUHPE1NB+v7WhT 8raceO4ULwYhmEaTd1zsJzOsgpnrflIwyVeqwkp9jbXpgeTfVJVBc2uw4LVAXAkOTNO+ 1bKL4Y9AQGVjWhfNrtVw9RofS8aRMJ3VQL92KT5wIwMFskn24pOB9pjLl1K5U5trepwC BwmDhqIAZs65nqpFfnWkvjkxspBaQia8n0xeoXUujpifVrMI1JYpTXjV4+52qmWeHz3b bxMw== X-Gm-Message-State: AOAM5330HRHhxOvXgitlAfmI06vxX6X7sXhNID9wZqD/TZE+wMWA4gk0 1nL7mHC3bTCKTz0zgYXgSDkmUPezyMhikg== X-Google-Smtp-Source: ABdhPJyUzzgIYpfWtvduwuC+QRk+Dw0+AxWUsdHer//m75i0Juhb3UyBXqBQfuMaaFrcLBzUCslhIw== X-Received: by 2002:adf:ecc1:: with SMTP id s1mr1727908wro.120.1603791707271; Tue, 27 Oct 2020 02:41:47 -0700 (PDT) Received: from vm.nix.is (vm.nix.is. [2a01:4f8:120:2468::2]) by smtp.gmail.com with ESMTPSA id d2sm1223546wrq.34.2020.10.27.02.41.45 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 27 Oct 2020 02:41:46 -0700 (PDT) From: =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBCamFybWFzb24=?= To: git@vger.kernel.org Cc: Junio C Hamano , Bert Wesarg , Jeff King , Christian Couder , Eric Sunshine , =?utf-8?b?w4Z2YXIgQXJuZmrDtnLDsCBC?= =?utf-8?b?amFybWFzb24=?= Subject: [PATCH v2] remote: add meaningful exit code on missing/existing Date: Tue, 27 Oct 2020 10:41:36 +0100 Message-Id: <20201027094136.7994-1-avarab@gmail.com> X-Mailer: git-send-email 2.28.0.297.g1956fa8f8d In-Reply-To: References: MIME-Version: 1.0 Precedence: bulk List-ID: X-Mailing-List: git@vger.kernel.org Change the exit code for the likes of "git remote add/rename" to exit with 2 if the remote in question doesn't exist, and 3 if it does. Before we'd just die() and exit with the general 128 exit code. This changes the output message from e.g.: fatal: remote origin already exists. To: error: remote origin already exists. Which I believe is a feature, since we generally use "fatal" for the generic errors, and "error" for the more specific ones with a custom exit code, but this part of the change may break code that already relies on stderr parsing (not that we ever supported that...). The motivation for this is a discussion around some code in GitLab's gitaly which wanted to check this, and had to parse stderr to do so: https://gitlab.com/gitlab-org/gitaly/-/merge_requests/2695 It's worth noting as an aside that a method of checking this that doesn't rely on that is to check with "git config" whether the value in question does or doesn't exist. That introduces a TOCTOU race condition, but on the other hand this code (e.g. "git remote add") already has a TOCTOU race. We go through the config.lock for the actual setting of the config, but the pseudocode logic is: read_config(); check_config_and_arg_sanity(); save_config(); So e.g. if a sleep() is added right after the remote_is_configured() check in add() we'll clobber remote.NAME.url, and add another (usually duplicate) remote.NAME.fetch entry (and other values, depending on invocation). Signed-off-by: Ævar Arnfjörð Bjarmason --- On Mon, Oct 26 2020, Junio C Hamano wrote: > Jeff King writes: > >> This is a run-on sentence; the comma after `2` should be a period. >> >> I'd also put an Oxford comma after `rename`, but that's a stylistic >> choice. :) > > Will queue with this squashed in. Thanks, here's that version plus Eric's suggested typo fix in the commit message. Range-diff: 1: 26037f6294 ! 1: 4e44aed049 remote: add meaningful exit code on missing/existing @@ Commit message save_config(); So e.g. if a sleep() is added right after the remote_is_configured() - check in add() we'll clobber rermote.NAME.url, and add - another (usually duplicate) remote.NAME.fetch entry (and other values, - depending on invocation). + check in add() we'll clobber remote.NAME.url, and add another (usually + duplicate) remote.NAME.fetch entry (and other values, depending on + invocation). Signed-off-by: Ævar Arnfjörð Bjarmason @@ Documentation/git-remote.txt: The remote configuration is achieved using the `re + +On success, the exit status is `0`. + -+When subcommands such as 'add', 'rename' and 'remove' can't find the -+remote in question the exit status is `2`, when the remote already -+exists the exit status is `3`. ++When subcommands such as 'add', 'rename', and 'remove' can't find the ++remote in question, the exit status is `2`. When the remote already ++exists, the exit status is `3`. + +On any other error, the exit status may be any other non-zero value. + Documentation/git-remote.txt | 11 ++++++++++ builtin/remote.c | 42 ++++++++++++++++++++++++------------ t/t5505-remote.sh | 16 +++++++------- 3 files changed, 47 insertions(+), 22 deletions(-) diff --git a/Documentation/git-remote.txt b/Documentation/git-remote.txt index ea73386c81..31c29c9b31 100644 --- a/Documentation/git-remote.txt +++ b/Documentation/git-remote.txt @@ -203,6 +203,17 @@ The remote configuration is achieved using the `remote.origin.url` and `remote.origin.fetch` configuration variables. (See linkgit:git-config[1]). +EXIT STATUS +----------- + +On success, the exit status is `0`. + +When subcommands such as 'add', 'rename', and 'remove' can't find the +remote in question, the exit status is `2`. When the remote already +exists, the exit status is `3`. + +On any other error, the exit status may be any other non-zero value. + EXAMPLES -------- diff --git a/builtin/remote.c b/builtin/remote.c index 64b4b551eb..c1828ca7d2 100644 --- a/builtin/remote.c +++ b/builtin/remote.c @@ -191,8 +191,10 @@ static int add(int argc, const char **argv) url = argv[1]; remote = remote_get(name); - if (remote_is_configured(remote, 1)) - die(_("remote %s already exists."), name); + if (remote_is_configured(remote, 1)) { + error(_("remote %s already exists."), name); + exit(3); + } strbuf_addf(&buf2, "refs/heads/test:refs/remotes/%s/test", name); if (!valid_fetch_refspec(buf2.buf)) @@ -686,15 +688,19 @@ static int mv(int argc, const char **argv) rename.remote_branches = &remote_branches; oldremote = remote_get(rename.old_name); - if (!remote_is_configured(oldremote, 1)) - die(_("No such remote: '%s'"), rename.old_name); + if (!remote_is_configured(oldremote, 1)) { + error(_("No such remote: '%s'"), rename.old_name); + exit(2); + } if (!strcmp(rename.old_name, rename.new_name) && oldremote->origin != REMOTE_CONFIG) return migrate_file(oldremote); newremote = remote_get(rename.new_name); - if (remote_is_configured(newremote, 1)) - die(_("remote %s already exists."), rename.new_name); + if (remote_is_configured(newremote, 1)) { + error(_("remote %s already exists."), rename.new_name); + exit(3); + } strbuf_addf(&buf, "refs/heads/test:refs/remotes/%s/test", rename.new_name); if (!valid_fetch_refspec(buf.buf)) @@ -829,8 +835,10 @@ static int rm(int argc, const char **argv) usage_with_options(builtin_remote_rm_usage, options); remote = remote_get(argv[1]); - if (!remote_is_configured(remote, 1)) - die(_("No such remote: '%s'"), argv[1]); + if (!remote_is_configured(remote, 1)) { + error(_("No such remote: '%s'"), argv[1]); + exit(2); + } known_remotes.to_delete = remote; for_each_remote(add_known_remote, &known_remotes); @@ -1511,8 +1519,10 @@ static int set_remote_branches(const char *remotename, const char **branches, strbuf_addf(&key, "remote.%s.fetch", remotename); remote = remote_get(remotename); - if (!remote_is_configured(remote, 1)) - die(_("No such remote '%s'"), remotename); + if (!remote_is_configured(remote, 1)) { + error(_("No such remote '%s'"), remotename); + exit(2); + } if (!add_mode && remove_all_fetch_refspecs(key.buf)) { strbuf_release(&key); @@ -1565,8 +1575,10 @@ static int get_url(int argc, const char **argv) remotename = argv[0]; remote = remote_get(remotename); - if (!remote_is_configured(remote, 1)) - die(_("No such remote '%s'"), remotename); + if (!remote_is_configured(remote, 1)) { + error(_("No such remote '%s'"), remotename); + exit(2); + } url_nr = 0; if (push_mode) { @@ -1633,8 +1645,10 @@ static int set_url(int argc, const char **argv) oldurl = newurl; remote = remote_get(remotename); - if (!remote_is_configured(remote, 1)) - die(_("No such remote '%s'"), remotename); + if (!remote_is_configured(remote, 1)) { + error(_("No such remote '%s'"), remotename); + exit(2); + } if (push_mode) { strbuf_addf(&name_buf, "remote.%s.pushurl", remotename); diff --git a/t/t5505-remote.sh b/t/t5505-remote.sh index 8d62edd98b..c99659d39e 100755 --- a/t/t5505-remote.sh +++ b/t/t5505-remote.sh @@ -145,8 +145,8 @@ test_expect_success 'remove remote protects local branches' ' test_expect_success 'remove errors out early when deleting non-existent branch' ' ( cd test && - echo "fatal: No such remote: '\''foo'\''" >expect && - test_must_fail git remote rm foo 2>actual && + echo "error: No such remote: '\''foo'\''" >expect && + test_expect_code 2 git remote rm foo 2>actual && test_i18ncmp expect actual ) ' @@ -173,24 +173,24 @@ test_expect_success 'remove remote with a branch without configured merge' ' test_expect_success 'rename errors out early when deleting non-existent branch' ' ( cd test && - echo "fatal: No such remote: '\''foo'\''" >expect && - test_must_fail git remote rename foo bar 2>actual && + echo "error: No such remote: '\''foo'\''" >expect && + test_expect_code 2 git remote rename foo bar 2>actual && test_i18ncmp expect actual ) ' test_expect_success 'add existing foreign_vcs remote' ' test_config remote.foo.vcs bar && - echo "fatal: remote foo already exists." >expect && - test_must_fail git remote add foo bar 2>actual && + echo "error: remote foo already exists." >expect && + test_expect_code 3 git remote add foo bar 2>actual && test_i18ncmp expect actual ' test_expect_success 'add existing foreign_vcs remote' ' test_config remote.foo.vcs bar && test_config remote.bar.vcs bar && - echo "fatal: remote bar already exists." >expect && - test_must_fail git remote rename foo bar 2>actual && + echo "error: remote bar already exists." >expect && + test_expect_code 3 git remote rename foo bar 2>actual && test_i18ncmp expect actual '