[v2] t1309: use a neutral branch name in the `onbranch` test cases

Commit Message

Johannes Schindelin Nov. 19, 2020, 11:41 a.m. UTC

From: Johannes Schindelin <[e-mail]>

The `onbranch` test cases touched by this patch do not actually try to
include any other config. Their purpose is to avoid regressing on two
bugs in the `include.onbranch:<name>.path` code that we fixed in the
past, bugs that are actually unrelated to any concrete branch name.

The first bug was fixed in 85fe0e800ca (config: work around bug with
includeif:onbranch and early config, 2019-07-31). Essentially, when
reading early config, there would be a catch-22 trying to access the
refs, and therefore we simply cannot evaluate the condition at that
point. The test case ensures that we avoid emitting this bogus message:

	BUG: refs.c:1851: attempting to get main_ref_store outside of repository

The second test case concerns the non-Git scenario, where we simply do
not have a current branch to begin with (because we don't have a
repository in the first place), and the test case was introduced in
22932d9169f (config: stop checking whether the_repository is NULL,
2019-08-06) to ensure that we don't cause a segmentation fault should
the code still incorrectly try to look at any ref.

In short, neither of these two test cases will ever look at a current
branch name, even in case of regressions. Therefore, the actual branch
name does not matter at all. We can therefore easily avoid
racially-charged branch names here, and that's what this patch does.

Signed-off-by: Johannes Schindelin <[e-mail]>
---
    t1309: use a non-loaded branch name in the onbranch test cases
    
    Just something I stumbled over while working on 
    https://github.com/gitgitgadget/git/pull/762.
    
    Changes since v1:
    
     * The commit message was obviously not clear at all, which has been
       addressed.

Published-As: https://github.com/gitgitgadget/git/releases/tag/pr-791%2Fdscho%2Ft1309-onbranch-tests-v2
Fetch-It-Via: git fetch https://github.com/gitgitgadget/git pr-791/dscho/t1309-onbranch-tests-v2
Pull-Request: https://github.com/gitgitgadget/git/pull/791

Range-diff vs v1:

 1:  c78ddaf9ad ! 1:  7897650556 t1309: use a non-loaded branch name in the `onbranch` test cases
     @@ Metadata
      Author: Johannes Schindelin <[e-mail]>
      
       ## Commit message ##
     -    t1309: use a non-loaded branch name in the `onbranch` test cases
     +    t1309: use a neutral branch name in the `onbranch` test cases
      
     -    The `onbranch` test cases in question do not actually want to include
     -    anything; Instead, they want to verify that the `onbranch` code path
     -    does not regress in the early-config case or in the non-Git case, where
     -    the `onbranch` include is actually ignored.
     +    The `onbranch` test cases touched by this patch do not actually try to
     +    include any other config. Their purpose is to avoid regressing on two
     +    bugs in the `include.onbranch:<name>.path` code that we fixed in the
     +    past, bugs that are actually unrelated to any concrete branch name.
      
     -    Therefore, the actual branch name does not matter at all. We might just
     -    as well avoid racially-charged names here.
     +    The first bug was fixed in 85fe0e800ca (config: work around bug with
     +    includeif:onbranch and early config, 2019-07-31). Essentially, when
     +    reading early config, there would be a catch-22 trying to access the
     +    refs, and therefore we simply cannot evaluate the condition at that
     +    point. The test case ensures that we avoid emitting this bogus message:
     +
     +            BUG: refs.c:1851: attempting to get main_ref_store outside of repository
     +
     +    The second test case concerns the non-Git scenario, where we simply do
     +    not have a current branch to begin with (because we don't have a
     +    repository in the first place), and the test case was introduced in
     +    22932d9169f (config: stop checking whether the_repository is NULL,
     +    2019-08-06) to ensure that we don't cause a segmentation fault should
     +    the code still incorrectly try to look at any ref.
     +
     +    In short, neither of these two test cases will ever look at a current
     +    branch name, even in case of regressions. Therefore, the actual branch
     +    name does not matter at all. We can therefore easily avoid
     +    racially-charged branch names here, and that's what this patch does.
      
          Signed-off-by: Johannes Schindelin <[e-mail]>
      


 t/t1309-early-config.sh | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)


base-commit: e31aba42fb12bdeb0f850829e008e1e3f43af500

Patch

diff --git a/t/t1309-early-config.sh b/t/t1309-early-config.sh
index ebb8e1aecb..b4a9158307 100755
--- a/t/t1309-early-config.sh
+++ b/t/t1309-early-config.sh
@@ -91,11 +91,11 @@  test_expect_failure 'ignore .git/ with invalid config' '
 
 test_expect_success 'early config and onbranch' '
 	echo "[broken" >broken &&
-	test_with_config "[includeif \"onbranch:master\"]path=../broken"
+	test_with_config "[includeif \"onbranch:topic\"]path=../broken"
 '
 
 test_expect_success 'onbranch config outside of git repo' '
-	test_config_global includeIf.onbranch:master.path non-existent &&
+	test_config_global includeIf.onbranch:topic.path non-existent &&
 	nongit git help
 '