t/t3301-notes.sh

   1 #!/bin/sh
   2 #
   3 # Copyright (c) 2007 Johannes E. Schindelin
   4 #
   5
   6 test_description='Test commit notes'
   7
   8 . ./test-lib.sh
   9
  10 cat > fake_editor.sh << \EOF
  11 echo "$MSG" > "$1"
  12 echo "$MSG" >& 2
  13 EOF
  14 chmod a+x fake_editor.sh
  15 GIT_EDITOR=./fake_editor.sh
  16 export GIT_EDITOR
  17
  18 test_expect_success 'cannot annotate non-existing HEAD' '
  19         (MSG=3 && export MSG && test_must_fail git notes edit)
  20 '
  21
  22 test_expect_success setup '
  23         : > a1 &&
  24         git add a1 &&
  25         test_tick &&
  26         git commit -m 1st &&
  27         : > a2 &&
  28         git add a2 &&
  29         test_tick &&
  30         git commit -m 2nd
  31 '
  32
  33 test_expect_success 'need valid notes ref' '
  34         (MSG=1 GIT_NOTES_REF=/ && export MSG GIT_NOTES_REF &&
  35          test_must_fail git notes edit) &&
  36         (MSG=2 GIT_NOTES_REF=/ && export MSG GIT_NOTES_REF &&
  37          test_must_fail git notes show)
  38 '
  39
  40 test_expect_success 'refusing to edit in refs/heads/' '
  41         (MSG=1 GIT_NOTES_REF=refs/heads/bogus &&
  42          export MSG GIT_NOTES_REF &&
  43          test_must_fail git notes edit)
  44 '
  45
  46 test_expect_success 'refusing to edit in refs/remotes/' '
  47         (MSG=1 GIT_NOTES_REF=refs/remotes/bogus &&
  48          export MSG GIT_NOTES_REF &&
  49          test_must_fail git notes edit)
  50 '
  51
  52 # 1 indicates caught gracefully by die, 128 means git-show barked
  53 test_expect_success 'handle empty notes gracefully' '
  54         git notes show ; test 1 = $?
  55 '
  56
  57 test_expect_success 'create notes' '
  58         git config core.notesRef refs/notes/commits &&
  59         MSG=b0 git notes edit &&
  60         test ! -f .git/NOTES_EDITMSG &&
  61         test 1 = $(git ls-tree refs/notes/commits | wc -l) &&
  62         test b0 = $(git notes show) &&
  63         git show HEAD^ &&
  64         test_must_fail git notes show HEAD^
  65 '
  66
  67 test_expect_success 'edit existing notes' '
  68         MSG=b1 git notes edit &&
  69         test ! -f .git/NOTES_EDITMSG &&
  70         test 1 = $(git ls-tree refs/notes/commits | wc -l) &&
  71         test b1 = $(git notes show) &&
  72         git show HEAD^ &&
  73         test_must_fail git notes show HEAD^
  74 '
  75
  76 cat > expect << EOF
  77 commit 268048bfb8a1fb38e703baceb8ab235421bf80c5
  78 Author: A U Thor <author@example.com>
  79 Date:   Thu Apr 7 15:14:13 2005 -0700
  80
  81     2nd
  82
  83 Notes:
  84     b1
  85 EOF
  86
  87 test_expect_success 'show notes' '
  88         ! (git cat-file commit HEAD | grep b1) &&
  89         git log -1 > output &&
  90         test_cmp expect output
  91 '
  92 test_expect_success 'create multi-line notes (setup)' '
  93         : > a3 &&
  94         git add a3 &&
  95         test_tick &&
  96         git commit -m 3rd &&
  97         MSG="b3
  98 c3c3c3c3
  99 d3d3d3" git notes edit
 100 '
 101
 102 cat > expect-multiline << EOF
 103 commit 1584215f1d29c65e99c6c6848626553fdd07fd75
 104 Author: A U Thor <author@example.com>
 105 Date:   Thu Apr 7 15:15:13 2005 -0700
 106
 107     3rd
 108
 109 Notes:
 110     b3
 111     c3c3c3c3
 112     d3d3d3
 113 EOF
 114
 115 printf "\n" >> expect-multiline
 116 cat expect >> expect-multiline
 117
 118 test_expect_success 'show multi-line notes' '
 119         git log -2 > output &&
 120         test_cmp expect-multiline output
 121 '
 122 test_expect_success 'create -F notes (setup)' '
 123         : > a4 &&
 124         git add a4 &&
 125         test_tick &&
 126         git commit -m 4th &&
 127         echo "xyzzy" > note5 &&
 128         git notes edit -F note5
 129 '
 130
 131 cat > expect-F << EOF
 132 commit 15023535574ded8b1a89052b32673f84cf9582b8
 133 Author: A U Thor <author@example.com>
 134 Date:   Thu Apr 7 15:16:13 2005 -0700
 135
 136     4th
 137
 138 Notes:
 139     xyzzy
 140 EOF
 141
 142 printf "\n" >> expect-F
 143 cat expect-multiline >> expect-F
 144
 145 test_expect_success 'show -F notes' '
 146         git log -3 > output &&
 147         test_cmp expect-F output
 148 '
 149
 150 cat >expect << EOF
 151 commit 15023535574ded8b1a89052b32673f84cf9582b8
 152 tree e070e3af51011e47b183c33adf9736736a525709
 153 parent 1584215f1d29c65e99c6c6848626553fdd07fd75
 154 author A U Thor <author@example.com> 1112912173 -0700
 155 committer C O Mitter <committer@example.com> 1112912173 -0700
 156
 157     4th
 158 EOF
 159 test_expect_success 'git log --pretty=raw does not show notes' '
 160         git log -1 --pretty=raw >output &&
 161         test_cmp expect output
 162 '
 163
 164 cat >>expect <<EOF
 165
 166 Notes:
 167     xyzzy
 168 EOF
 169 test_expect_success 'git log --show-notes' '
 170         git log -1 --pretty=raw --show-notes >output &&
 171         test_cmp expect output
 172 '
 173
 174 test_expect_success 'git log --no-notes' '
 175         git log -1 --no-notes >output &&
 176         ! grep xyzzy output
 177 '
 178
 179 test_expect_success 'git format-patch does not show notes' '
 180         git format-patch -1 --stdout >output &&
 181         ! grep xyzzy output
 182 '
 183
 184 test_expect_success 'git format-patch --show-notes does show notes' '
 185         git format-patch --show-notes -1 --stdout >output &&
 186         grep xyzzy output
 187 '
 188
 189 for pretty in \
 190         "" --pretty --pretty=raw --pretty=short --pretty=medium \
 191         --pretty=full --pretty=fuller --pretty=format:%s --oneline
 192 do
 193         case "$pretty" in
 194         "") p= not= negate="" ;;
 195         ?*) p="$pretty" not=" not" negate="!" ;;
 196         esac
 197         test_expect_success "git show $pretty does$not show notes" '
 198                 git show $p >output &&
 199                 eval "$negate grep xyzzy output"
 200         '
 201 done
 202
 203 test_expect_success 'create -m notes (setup)' '
 204         : > a5 &&
 205         git add a5 &&
 206         test_tick &&
 207         git commit -m 5th &&
 208         git notes edit -m spam -m "foo
 209 bar
 210 baz"
 211 '
 212
 213 whitespace="    "
 214 cat > expect-m << EOF
 215 commit bd1753200303d0a0344be813e504253b3d98e74d
 216 Author: A U Thor <author@example.com>
 217 Date:   Thu Apr 7 15:17:13 2005 -0700
 218
 219     5th
 220
 221 Notes:
 222     spam
 223 $whitespace
 224     foo
 225     bar
 226     baz
 227 EOF
 228
 229 printf "\n" >> expect-m
 230 cat expect-F >> expect-m
 231
 232 test_expect_success 'show -m notes' '
 233         git log -4 > output &&
 234         test_cmp expect-m output
 235 '
 236
 237 test_expect_success 'create other note on a different notes ref (setup)' '
 238         : > a6 &&
 239         git add a6 &&
 240         test_tick &&
 241         git commit -m 6th &&
 242         GIT_NOTES_REF="refs/notes/other" git notes edit -m "other note"
 243 '
 244
 245 cat > expect-other << EOF
 246 commit 387a89921c73d7ed72cd94d179c1c7048ca47756
 247 Author: A U Thor <author@example.com>
 248 Date:   Thu Apr 7 15:18:13 2005 -0700
 249
 250     6th
 251
 252 Notes:
 253     other note
 254 EOF
 255
 256 cat > expect-not-other << EOF
 257 commit 387a89921c73d7ed72cd94d179c1c7048ca47756
 258 Author: A U Thor <author@example.com>
 259 Date:   Thu Apr 7 15:18:13 2005 -0700
 260
 261     6th
 262 EOF
 263
 264 test_expect_success 'Do not show note on other ref by default' '
 265         git log -1 > output &&
 266         test_cmp expect-not-other output
 267 '
 268
 269 test_expect_success 'Do show note when ref is given in GIT_NOTES_REF' '
 270         GIT_NOTES_REF="refs/notes/other" git log -1 > output &&
 271         test_cmp expect-other output
 272 '
 273
 274 test_expect_success 'Do show note when ref is given in core.notesRef config' '
 275         git config core.notesRef "refs/notes/other" &&
 276         git log -1 > output &&
 277         test_cmp expect-other output
 278 '
 279
 280 test_expect_success 'Do not show note when core.notesRef is overridden' '
 281         GIT_NOTES_REF="refs/notes/wrong" git log -1 > output &&
 282         test_cmp expect-not-other output
 283 '
 284
 285 test_expect_success 'Allow notes on non-commits (trees, blobs, tags)' '
 286         echo "Note on a tree" > expect
 287         git notes edit -m "Note on a tree" HEAD: &&
 288         git notes show HEAD: > actual &&
 289         test_cmp expect actual &&
 290         echo "Note on a blob" > expect
 291         filename=$(git ls-tree --name-only HEAD | head -n1) &&
 292         git notes edit -m "Note on a blob" HEAD:$filename &&
 293         git notes show HEAD:$filename > actual &&
 294         test_cmp expect actual &&
 295         echo "Note on a tag" > expect
 296         git tag -a -m "This is an annotated tag" foobar HEAD^ &&
 297         git notes edit -m "Note on a tag" foobar &&
 298         git notes show foobar > actual &&
 299         test_cmp expect actual
 300 '
 301
 302 test_done