Skip to content
  • Gábor Szeder's avatar
    tests: use 'test_must_be_empty' instead of 'test_cmp <empty> <out>' · 1c5e94f4
    Gábor Szeder authored and Junio C Hamano's avatar Junio C Hamano committed
    
    
    Using 'test_must_be_empty' is shorter and more idiomatic than
    
      >empty &&
      test_cmp empty out
    
    as it saves the creation of an empty file.  Furthermore, sometimes the
    expected empty file doesn't have such a descriptive name like 'empty',
    and its creation is far away from the place where it's finally used
    for comparison (e.g. in 't7600-merge.sh', where two expected empty
    files are created in the 'setup' test, but are used only about 500
    lines later).
    
    These cases were found by instrumenting 'test_cmp' to error out the
    test script when it's used to compare empty files, and then converted
    manually.
    
    Note that even after this patch there still remain a lot of cases
    where we use 'test_cmp' to check empty files:
    
      - Sometimes the expected output is not hard-coded in the test, but
        'test_cmp' is used to ensure that two similar git commands produce
        the same output, and that output happens to be empty, e.g. the
        test 'submodule update --merge  - ignores --merge  for new
        submodules' in 't7406-submodule-update.sh'.
    
      - Repetitive common tasks, including preparing the expected results
        and running 'test_cmp', are often extracted into a helper
        function, and some of this helper's callsites expect no output.
    
      - For the same reason as above, the whole 'test_expect_success'
        block is within a helper function, e.g. in 't3070-wildmatch.sh'.
    
      - Or 'test_cmp' is invoked in a loop, e.g. the test 'cvs update
        (-p)' in 't9400-git-cvsserver-server.sh'.
    
    Signed-off-by: default avatarSZEDER Gábor <szeder.dev@gmail.com>
    Signed-off-by: default avatarJunio C Hamano <gitster@pobox.com>
    1c5e94f4