t/t0450-txt-doc-vs-help.sh

   1 #!/bin/sh
   2
   3 test_description='assert (unbuilt) Documentation/*.txt and -h output
   4
   5 Run this with --debug to see a summary of where we still fail to make
   6 the two versions consistent with one another.'
   7
   8 TEST_PASSES_SANITIZE_LEAK=true
   9 . ./test-lib.sh
  10
  11 test_expect_success 'setup: list of builtins' '
  12         git --list-cmds=builtins >builtins
  13 '
  14
  15 test_expect_success 'list of txt and help mismatches is sorted' '
  16         sort -u "$TEST_DIRECTORY"/t0450/txt-help-mismatches >expect &&
  17         if ! test_cmp expect "$TEST_DIRECTORY"/t0450/txt-help-mismatches
  18         then
  19                 BUG "please keep the list of txt and help mismatches sorted"
  20         fi
  21 '
  22
  23 help_to_synopsis () {
  24         builtin="$1" &&
  25         out_dir="out/$builtin" &&
  26         out="$out_dir/help.synopsis" &&
  27         if test -f "$out"
  28         then
  29                 echo "$out" &&
  30                 return 0
  31         fi &&
  32         mkdir -p "$out_dir" &&
  33         test_expect_code 129 git $builtin -h >"$out.raw" 2>&1 &&
  34         sed -n \
  35                 -e '1,/^$/ {
  36                         /^$/d;
  37                         s/^usage: //;
  38                         s/^ *or: //;
  39                         p;
  40                 }' <"$out.raw" >"$out" &&
  41         echo "$out"
  42 }
  43
  44 builtin_to_txt () {
  45        echo "$GIT_BUILD_DIR/Documentation/git-$1.txt"
  46 }
  47
  48 txt_to_synopsis () {
  49         builtin="$1" &&
  50         out_dir="out/$builtin" &&
  51         out="$out_dir/txt.synopsis" &&
  52         if test -f "$out"
  53         then
  54                 echo "$out" &&
  55                 return 0
  56         fi &&
  57         b2t="$(builtin_to_txt "$builtin")" &&
  58         sed -n \
  59                 -E '/^\[(verse|synopsis)\]$/,/^$/ {
  60                         /^$/d;
  61                         /^\[(verse|synopsis)\]$/d;
  62                         s/\{litdd\}/--/g;
  63                         s/'\''(git[ a-z-]*)'\''/\1/g;
  64
  65                         p;
  66                 }' \
  67                 <"$b2t" >"$out" &&
  68         echo "$out"
  69 }
  70
  71 check_dashed_labels () {
  72         ! grep -E "<[^>_-]+_" "$1"
  73 }
  74
  75 HT="    "
  76
  77 align_after_nl () {
  78         builtin="$1" &&
  79         len=$(printf "git %s " "$builtin" | wc -c) &&
  80         pad=$(printf "%${len}s" "") &&
  81
  82         sed "s/^[ $HT][ $HT]*/$pad/"
  83 }
  84
  85 test_debug '>failing'
  86 while read builtin
  87 do
  88         # -h output assertions
  89         test_expect_success "$builtin -h output has no \t" '
  90                 h2s="$(help_to_synopsis "$builtin")" &&
  91                 ! grep "$HT" "$h2s"
  92         '
  93
  94         test_expect_success "$builtin -h output has dashed labels" '
  95                 check_dashed_labels "$(help_to_synopsis "$builtin")"
  96         '
  97
  98         test_expect_success "$builtin -h output has consistent spacing" '
  99                 h2s="$(help_to_synopsis "$builtin")" &&
 100                 sed -n \
 101                         -e "/^ / {
 102                                 s/[^ ].*//;
 103                                 p;
 104                         }" \
 105                         <"$h2s" >help &&
 106                 sort -u help >help.ws &&
 107                 if test -s help.ws
 108                 then
 109                         test_line_count = 1 help.ws
 110                 fi
 111         '
 112
 113         txt="$(builtin_to_txt "$builtin")" &&
 114         preq="$(echo BUILTIN_TXT_$builtin | tr '[:lower:]-' '[:upper:]_')" &&
 115
 116         if test -f "$txt"
 117         then
 118                 test_set_prereq "$preq"
 119         fi &&
 120
 121         # *.txt output assertions
 122         test_expect_success "$preq" "$builtin *.txt SYNOPSIS has dashed labels" '
 123                 check_dashed_labels "$(txt_to_synopsis "$builtin")"
 124         '
 125
 126         # *.txt output consistency assertions
 127         result=
 128         if grep -q "^$builtin$" "$TEST_DIRECTORY"/t0450/txt-help-mismatches
 129         then
 130                 result=failure
 131         else
 132                 result=success
 133         fi &&
 134         test_expect_$result "$preq" "$builtin -h output and SYNOPSIS agree" '
 135                 t2s="$(txt_to_synopsis "$builtin")" &&
 136                 if test "$builtin" = "merge-tree"
 137                 then
 138                         test_when_finished "rm -f t2s.new" &&
 139                         sed -e '\''s/ (deprecated)$//g'\'' <"$t2s" >t2s.new
 140                         t2s=t2s.new
 141                 fi &&
 142                 h2s="$(help_to_synopsis "$builtin")" &&
 143
 144                 # The *.txt and -h use different spacing for the
 145                 # alignment of continued usage output, normalize it.
 146                 align_after_nl "$builtin" <"$t2s" >txt &&
 147                 align_after_nl "$builtin" <"$h2s" >help &&
 148                 test_cmp txt help
 149         '
 150
 151         if test_have_prereq "$preq" && test -e txt && test -e help
 152         then
 153                 test_debug '
 154                         if test_cmp txt help >cmp 2>/dev/null
 155                         then
 156                                 echo "=== DONE: $builtin ==="
 157                         else
 158                                 echo "=== TODO: $builtin ===" &&
 159                                 cat cmp
 160                         fi >>failing
 161                 '
 162
 163                 # Not in test_expect_success in case --run is being
 164                 # used with --debug
 165                 rm -f txt help tmp 2>/dev/null
 166         fi
 167 done <builtins
 168
 169 test_debug 'say "$(cat failing)"'
 170
 171 test_done