From 6a0885a8829cbe3c0d7a4befef4c39e4afa7d332 Mon Sep 17 00:00:00 2001 From: James Liu Date: Wed, 24 Apr 2024 11:52:17 +1000 Subject: [PATCH 1/2] advice: allow advice type to be provided in tests advise_if_enabled() has a special branch to handle backwards-compatibility with the `pushUpdateRejected` and `pushNonFastForward` advice types, which went untested. Modify the `test-tool advise` command so the advice type can be changed between nestedTag (the previous behaviour) and pushUpdateRejected. Signed-off-by: James Liu --- t/helper/test-advise.c | 20 ++++++++++++++------ t/t0018-advice.sh | 30 +++++++++++++++++++++++++++--- 2 files changed, 41 insertions(+), 9 deletions(-) diff --git a/t/helper/test-advise.c b/t/helper/test-advise.c index 8a3fd0009a0..c18b18e0596 100644 --- a/t/helper/test-advise.c +++ b/t/helper/test-advise.c @@ -5,18 +5,26 @@ int cmd__advise_if_enabled(int argc, const char **argv) { - if (argc != 2) - die("usage: %s ", argv[0]); + if (argc != 3) + die("usage: %s nestedTag|pushUpdateRejected ", argv[0]); setup_git_directory(); git_config(git_default_config, NULL); /* - * Any advice type can be used for testing, but NESTED_TAG was - * selected here and in t0018 where this command is being - * executed. + * Any advice type can be used for testing, but ADVICE_NESTED_TAG and + * ADVICE_PUSH_UPDATE_REJECTED were selected here and used in t0018 + * where this command is being executed. + * + * This allows test cases to exercise the normal and special branch + * within advice_enabled(). */ - advise_if_enabled(ADVICE_NESTED_TAG, "%s", argv[1]); + if (!strcmp(argv[1], "nestedTag")) + advise_if_enabled(ADVICE_NESTED_TAG, "%s", argv[2]); + else if (!strcmp(argv[1], "pushUpdateRejected")) + advise_if_enabled(ADVICE_PUSH_UPDATE_REJECTED, "%s", argv[2]); + else + die("advice type should be nestedTag|pushUpdateRejected"); return 0; } diff --git a/t/t0018-advice.sh b/t/t0018-advice.sh index 0dcfb760a2b..8010796e1ff 100755 --- a/t/t0018-advice.sh +++ b/t/t0018-advice.sh @@ -10,7 +10,16 @@ test_expect_success 'advice should be printed when config variable is unset' ' hint: This is a piece of advice hint: Disable this message with "git config advice.nestedTag false" EOF - test-tool advise "This is a piece of advice" 2>actual && + test-tool advise nestedTag "This is a piece of advice" 2>actual && + test_cmp expect actual +' + +test_expect_success 'advice should be printed when advice.pushUpdateRejected and its alias are unset' ' + cat >expect <<-\EOF && + hint: This is a piece of advice + hint: Disable this message with "git config advice.pushUpdateRejected false" + EOF + test-tool advise pushUpdateRejected "This is a piece of advice" 2>actual && test_cmp expect actual ' @@ -19,14 +28,29 @@ test_expect_success 'advice should be printed when config variable is set to tru hint: This is a piece of advice EOF test_config advice.nestedTag true && - test-tool advise "This is a piece of advice" 2>actual && + test-tool advise nestedTag "This is a piece of advice" 2>actual && test_cmp expect actual ' test_expect_success 'advice should not be printed when config variable is set to false' ' test_config advice.nestedTag false && - test-tool advise "This is a piece of advice" 2>actual && + test-tool advise nestedTag "This is a piece of advice" 2>actual && test_must_be_empty actual ' +test_expect_success 'advice should not be printed when advice.pushUpdateRejected is unset but its alias is set to false' ' + test_config advice.pushNonFastForward false && + test-tool advise pushUpdateRejected "This is a piece of advice" 2>actual && + test_must_be_empty actual +' + +test_expect_success 'advice should be printed when advice.pushUpdateRejected is set to true and its alias is unset' ' + cat >expect <<-\EOF && + hint: This is a piece of advice + EOF + test_config advice.pushUpdateRejected true && + test-tool advise pushUpdateRejected "This is a piece of advice" 2>actual && + test_cmp expect actual +' + test_done -- GitLab From ddd7c1ee7bb19a523840baddb445535fc93fe14f Mon Sep 17 00:00:00 2001 From: James Liu Date: Thu, 18 Apr 2024 13:22:37 +1000 Subject: [PATCH 2/2] advice: add "all" option to disable all hints Advice hints must be disabled individually by setting the relevant advice.* variables to false in the Git configuration. For server-side usages of Git where hints aren't necessary, it can be cumbersome to maintain configuration to disable all advice hints. This is especially the case if/when new advice hints are added. Add a new "all" advice variable which acts as a toggle for all advice types. When this is being used, individual advice hints can be enabled by setting their respective configs to true. Signed-off-by: James Liu --- Documentation/config/advice.txt | 5 +++++ advice.c | 8 ++++++++ advice.h | 1 + t/t0018-advice.sh | 33 +++++++++++++++++++++++++++++++++ 4 files changed, 47 insertions(+) diff --git a/Documentation/config/advice.txt b/Documentation/config/advice.txt index 0e35ae5240f..0516a23b6ba 100644 --- a/Documentation/config/advice.txt +++ b/Documentation/config/advice.txt @@ -5,6 +5,11 @@ advice.*:: that you do not need the help message by setting these to `false`: + -- + all:: + Convenience option that allows all advice hints to be + disabled when set to false. When false, individual + advice hints can be enabled by setting them to true. + Setting this to true is a no-op. addEmbeddedRepo:: Shown when the user accidentally adds one git repo inside of another. diff --git a/advice.c b/advice.c index 75111191ad5..9f0860f1435 100644 --- a/advice.c +++ b/advice.c @@ -43,6 +43,7 @@ static struct { const char *key; enum advice_level level; } advice_setting[] = { + [ADVICE_ALL] = { "all" }, [ADVICE_ADD_EMBEDDED_REPO] = { "addEmbeddedRepo" }, [ADVICE_ADD_EMPTY_PATHSPEC] = { "addEmptyPathspec" }, [ADVICE_ADD_IGNORED_FILE] = { "addIgnoredFile" }, @@ -132,6 +133,13 @@ int advice_enabled(enum advice_type type) return enabled && advice_enabled(ADVICE_PUSH_UPDATE_REJECTED_ALIAS); + /* + * We still allow for specific advice hints to be enabled if + * advice.all == false. + */ + if (advice_setting[ADVICE_ALL].level == ADVICE_LEVEL_DISABLED) + return advice_setting[type].level == ADVICE_LEVEL_ENABLED; + return enabled; } diff --git a/advice.h b/advice.h index c8d29f97f39..b5ac99a645d 100644 --- a/advice.h +++ b/advice.h @@ -11,6 +11,7 @@ struct string_list; * Call advise_if_enabled to print your advice. */ enum advice_type { + ADVICE_ALL, ADVICE_ADD_EMBEDDED_REPO, ADVICE_ADD_EMPTY_PATHSPEC, ADVICE_ADD_IGNORED_FILE, diff --git a/t/t0018-advice.sh b/t/t0018-advice.sh index 8010796e1ff..19318cc9bb9 100755 --- a/t/t0018-advice.sh +++ b/t/t0018-advice.sh @@ -53,4 +53,37 @@ test_expect_success 'advice should be printed when advice.pushUpdateRejected is test_cmp expect actual ' +test_expect_success 'advice should not be printed when advice.all is set to false' ' + test_config advice.all false && + test-tool advise nestedTag "This is a piece of advice" 2>actual && + test_must_be_empty actual +' + +test_expect_success 'advice should not be printed for pushUpdateRejected when advice.all is set to false' ' + test_config advice.all false && + test-tool advise pushUpdateRejected "This is a piece of advice" 2>actual && + test_must_be_empty actual +' + +test_expect_success 'advice should be printed when advice.all is set to false, but specific advice is set to true' ' + cat >expect <<-\EOF && + hint: This is a piece of advice + EOF + test_config advice.all false && + test_config advice.nestedTag true && + test-tool advise nestedTag "This is a piece of advice" 2>actual && + test_cmp expect actual +' + +test_expect_success 'advice should be printed when advice.all is set to false, but advice.pushUpdateRejected and its alias are set to true' ' + cat >expect <<-\EOF && + hint: This is a piece of advice + EOF + test_config advice.all false && + test_config advice.pushUpdateRejected true && + test_config advice.pushNonFastForward true && + test-tool advise pushUpdateRejected "This is a piece of advice" 2>actual && + test_cmp expect actual +' + test_done -- GitLab