regress/cmdline/cleanup.sh

   1 #!/bin/sh
   2 #
   3 # Copyright (c) 2021 Stefan Sperling <stsp@openbsd.org>
   4 #
   5 # Permission to use, copy, modify, and distribute this software for any
   6 # purpose with or without fee is hereby granted, provided that the above
   7 # copyright notice and this permission notice appear in all copies.
   8 #
   9 # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16
  17 . ./common.sh
  18
  19 # disable automatic packing for these tests
  20 export GOT_TEST_PACK=""
  21
  22 test_cleanup_unreferenced_loose_objects() {
  23         local testroot=`test_init cleanup_unreferenced_loose_objects`
  24
  25         nloose0=`gotadmin info -r $testroot/repo | grep '^loose objects:' | \
  26                 cut -d ':' -f 2 | tr -d ' '`
  27         if [ "$nloose0" != "8" ]; then
  28                 echo "unexpected number of loose objects: $nloose0" >&2
  29                 test_done "$testroot" "1"
  30                 return 1
  31         fi
  32
  33         # create a branch with some changes
  34         got branch -r $testroot/repo newbranch >/dev/null
  35
  36         got checkout -b newbranch $testroot/repo $testroot/wt >/dev/null
  37         ret="$?"
  38         if [ "$ret" != "0" ]; then
  39                 echo "got checkout command failed unexpectedly"
  40                 test_done "$testroot" "$ret"
  41                 return 1
  42         fi
  43
  44         echo 'foo' > $testroot/wt/foo
  45         (cd $testroot/wt && got add foo > /dev/null)
  46         echo 'modified alpha' > $testroot/wt/alpha
  47         (cd $testroot/wt && got commit -m 'newbranch commit' > /dev/null)
  48         local commit1=`git_show_branch_head $testroot/repo newbranch`
  49         local tree1=`got cat -r $testroot/repo $newbranch_commit | \
  50                 grep ^tree | cut -d ' ' -f2`
  51         local alpha1=`got tree -r $testroot/repo -i -c $commit1 | \
  52                 grep "[0-9a-f] alpha$" | cut -d' ' -f 1`
  53         local foo1=`got tree -r $testroot/repo -i -c $commit1 | \
  54                 grep "[0-9a-f] foo$" | cut -d' ' -f 1`
  55
  56         nloose1=`gotadmin info -r $testroot/repo | grep '^loose objects:' | \
  57                 cut -d ':' -f 2 | tr -d ' '`
  58         if [ "$nloose1" != "12" ]; then
  59                 echo "unexpected number of loose objects: $nloose1" >&2
  60                 test_done "$testroot" "1"
  61                 return 1
  62         fi
  63
  64         # delete the branch
  65         got branch -r $testroot/repo -d newbranch >/dev/null
  66
  67         # remove worktree's base commit reference, which points at the branch
  68         wt_uuid=`(cd $testroot/wt && got info | grep 'UUID:' | \
  69                 cut -d ':' -f 2 | tr -d ' ')`
  70         got ref -r $testroot/repo -d "refs/got/worktree/base-$wt_uuid" \
  71                 > /dev/null
  72
  73         # cleanup -n should not remove any objects
  74         ls -R $testroot/repo/.git/objects > $testroot/objects-before
  75         gotadmin cleanup -a -n -q -r $testroot/repo > $testroot/stdout
  76         echo -n > $testroot/stdout.expected
  77         cmp -s $testroot/stdout.expected $testroot/stdout
  78         ret="$?"
  79         if [ "$ret" != "0" ]; then
  80                 diff -u $testroot/stdout.expected $testroot/stdout
  81                 test_done "$testroot" "$ret"
  82                 return 1
  83         fi
  84         ls -R $testroot/repo/.git/objects > $testroot/objects-after
  85         cmp -s $testroot/objects-before $testroot/objects-after
  86         ret="$?"
  87         if [ "$ret" != "0" ]; then
  88                 diff -u $testroot/objects-before $testroot/objects-after
  89                 test_done "$testroot" "$ret"
  90                 return 1
  91         fi
  92
  93         # cleanup should remove loose objects that belonged to the branch
  94         gotadmin cleanup -a -q -r $testroot/repo > $testroot/stdout
  95         ret="$?"
  96         if [ "$ret" != "0" ]; then
  97                 echo "gotadmin cleanup failed unexpectedly" >&2
  98                 test_done "$testroot" "$ret"
  99                 return 1
 100         fi
 101         echo -n > $testroot/stdout.expected
 102         cmp -s $testroot/stdout.expected $testroot/stdout
 103         ret="$?"
 104         if [ "$ret" != "0" ]; then
 105                 diff -u $testroot/stdout.expected $testroot/stdout
 106                 test_done "$testroot" "$ret"
 107                 return 1
 108         fi
 109
 110         nloose2=`gotadmin info -r $testroot/repo | grep '^loose objects:' | \
 111                 cut -d ':' -f 2 | tr -d ' '`
 112         if [ "$nloose2" != "$nloose0" ]; then
 113                 echo "unexpected number of loose objects: $nloose2" >&2
 114                 test_done "$testroot" "1"
 115                 return 1
 116         fi
 117
 118         for id in $commit1 $tree1 $alpha1 $foo1; do
 119                 path=`get_loose_object_path $testroot/repo $id`
 120                 if [ -e "$path" ]; then
 121                         echo "loose object $path was not purged" >&2
 122                         ret=1
 123                         break
 124                 fi
 125         done
 126
 127         test_done "$testroot" "$ret"
 128 }
 129
 130 test_cleanup_redundant_loose_objects() {
 131         local testroot=`test_init cleanup_redundant_loose_objects`
 132
 133         # tags should also be packed
 134         got tag -r $testroot/repo -m 1.0 1.0 >/dev/null
 135
 136         nloose0=`gotadmin info -r $testroot/repo | grep '^loose objects:' | \
 137                 cut -d ':' -f 2 | tr -d ' '`
 138         if [ "$nloose0" != "9" ]; then
 139                 echo "unexpected number of loose objects: $nloose0" >&2
 140                 test_done "$testroot" "1"
 141                 return 1
 142         fi
 143
 144         # no pack files should exist yet
 145         ls $testroot/repo/.git/objects/pack/ > $testroot/stdout
 146         ret="$?"
 147         if [ "$ret" != "0" ]; then
 148                 test_done "$testroot" "$ret"
 149                 return 1
 150         fi
 151         echo -n > $testroot/stdout.expected
 152         cmp -s $testroot/stdout.expected $testroot/stdout
 153         ret="$?"
 154         if [ "$ret" != "0" ]; then
 155                 diff -u $testroot/stdout.expected $testroot/stdout
 156                 test_done "$testroot" "$ret"
 157                 return 1
 158         fi
 159
 160         gotadmin pack -r $testroot/repo > /dev/null
 161
 162         npacked0=`gotadmin info -r $testroot/repo | grep '^packed objects:' | \
 163                 cut -d ':' -f 2 | tr -d ' '`
 164         if [ "$npacked0" != "9" ]; then
 165                 echo "unexpected number of loose objects: $npacked0" >&2
 166                 test_done "$testroot" "1"
 167                 return 1
 168         fi
 169
 170         # cleanup -n should not remove any objects
 171         ls -R $testroot/repo/.git/objects > $testroot/objects-before
 172         gotadmin cleanup -a -n -q -r $testroot/repo > $testroot/stdout
 173         echo -n > $testroot/stdout.expected
 174         cmp -s $testroot/stdout.expected $testroot/stdout
 175         ret="$?"
 176         if [ "$ret" != "0" ]; then
 177                 diff -u $testroot/stdout.expected $testroot/stdout
 178                 test_done "$testroot" "$ret"
 179                 return 1
 180         fi
 181         ls -R $testroot/repo/.git/objects > $testroot/objects-after
 182         cmp -s $testroot/objects-before $testroot/objects-after
 183         ret="$?"
 184         if [ "$ret" != "0" ]; then
 185                 diff -u $testroot/objects-before $testroot/objects-after
 186                 test_done "$testroot" "$ret"
 187                 return 1
 188         fi
 189
 190         nloose1=`gotadmin info -r $testroot/repo | grep '^loose objects:' | \
 191                 cut -d ':' -f 2 | tr -d ' '`
 192         if [ "$nloose1" != "$nloose0" ]; then
 193                 echo "unexpected number of loose objects: $nloose1" >&2
 194                 test_done "$testroot" "1"
 195                 return 1
 196         fi
 197
 198         # cleanup should remove all loose objects
 199         gotadmin cleanup -a -q -r $testroot/repo > $testroot/stdout
 200         ret="$?"
 201         if [ "$ret" != "0" ]; then
 202                 echo "gotadmin cleanup failed unexpectedly" >&2
 203                 test_done "$testroot" "$ret"
 204                 return 1
 205         fi
 206         echo -n > $testroot/stdout.expected
 207         cmp -s $testroot/stdout.expected $testroot/stdout
 208         ret="$?"
 209         if [ "$ret" != "0" ]; then
 210                 diff -u $testroot/stdout.expected $testroot/stdout
 211                 test_done "$testroot" "$ret"
 212                 return 1
 213         fi
 214
 215         nloose2=`gotadmin info -r $testroot/repo | grep '^loose objects:' | \
 216                 cut -d ':' -f 2 | tr -d ' '`
 217         if [ "$nloose2" != "0" ]; then
 218                 echo "unexpected number of loose objects: $nloose2" >&2
 219                 test_done "$testroot" "1"
 220                 return 1
 221         fi
 222
 223         for d in $testroot/repo/.git/objects/[0-9a-f][0-9a-f]; do
 224                 id0=`basename $d`
 225                 ret=0
 226                 for e in `ls $d`; do
 227                         obj_id=${id0}${e}
 228                         echo "loose object $obj_id was not purged" >&2
 229                         ret=1
 230                         break
 231                 done
 232                 if [ "$ret" = "1" ]; then
 233                         break
 234                 fi
 235         done
 236
 237         test_done "$testroot" "$ret"
 238 }
 239
 240 test_cleanup_precious_objects() {
 241         local testroot=`test_init cleanup_precious_objects`
 242
 243         # enable Git's preciousObjects extension
 244         (cd $testroot/repo && git config extensions.preciousObjects true)
 245
 246         # cleanup should now refuse to purge objects
 247         gotadmin cleanup -a -q -r $testroot/repo > $testroot/stdout \
 248                 2> $testroot/stderr
 249         ret="$?"
 250         if [ "$ret" = "0" ]; then
 251                 echo "gotadmin cleanup succeeded unexpectedly" >&2
 252                 test_done "$testroot" "1"
 253                 return 1
 254         fi
 255
 256         echo -n "gotadmin: the preciousObjects Git extension is enabled; " \
 257                 > $testroot/stderr.expected
 258         echo "this implies that objects must not be deleted" \
 259                 >> $testroot/stderr.expected
 260         cmp -s $testroot/stderr.expected $testroot/stderr
 261         ret="$?"
 262         if [ "$ret" != "0" ]; then
 263                 diff -u $testroot/stderr.expected $testroot/stderr
 264         fi
 265         test_done "$testroot" "$ret"
 266 }
 267
 268 test_cleanup_missing_pack_file() {
 269         local testroot=`test_init cleanup_missing_pack_file`
 270
 271         # no pack files should exist yet
 272         ls $testroot/repo/.git/objects/pack/ > $testroot/stdout
 273         ret="$?"
 274         if [ "$ret" != "0" ]; then
 275                 test_done "$testroot" "$ret"
 276                 return 1
 277         fi
 278         echo -n > $testroot/stdout.expected
 279         cmp -s $testroot/stdout.expected $testroot/stdout
 280         ret="$?"
 281         if [ "$ret" != "0" ]; then
 282                 diff -u $testroot/stdout.expected $testroot/stdout
 283                 test_done "$testroot" "$ret"
 284                 return 1
 285         fi
 286
 287         gotadmin pack -r $testroot/repo > $testroot/stdout
 288         packname=`grep ^Wrote $testroot/stdout | cut -d ' ' -f2`
 289         packhash=`echo $packname | sed -e 's:^objects/pack/pack-::' \
 290                 -e 's/.pack$//'`
 291
 292         # Some freshly cloned Git repositories suffer from lonely pack index
 293         # files. Remove the pack file we just wrote to simulate this issue.
 294         rm $testroot/repo/.git/objects/pack/pack-$packname
 295
 296         # cleanup should now refuse to purge objects
 297         gotadmin cleanup -a -q -r $testroot/repo > $testroot/stdout \
 298                 2> $testroot/stderr
 299         ret="$?"
 300         if [ "$ret" = "0" ]; then
 301                 echo "gotadmin cleanup succeeded unexpectedly" >&2
 302                 test_done "$testroot" "1"
 303                 return 1
 304         fi
 305
 306         echo -n "gotadmin: objects/pack/pack-${packhash}.idx: " \
 307                 > $testroot/stderr.expected
 308         echo -n "pack index has no corresponding pack file; pack file must " \
 309                 >> $testroot/stderr.expected
 310         echo "be restored or 'gotadmin cleanup -p' must be run" \
 311                 >> $testroot/stderr.expected
 312         cmp -s $testroot/stderr.expected $testroot/stderr
 313         ret="$?"
 314         if [ "$ret" != "0" ]; then
 315                 diff -u $testroot/stderr.expected $testroot/stderr
 316                 test_done "$testroot" "$ret"
 317                 return 1
 318         fi
 319
 320         gotadmin cleanup -a -r $testroot/repo -p -n > $testroot/stdout
 321         ret="$?"
 322         if [ "$ret" != "0" ]; then
 323                 echo "gotadmin cleanup failed unexpectedly" >&2
 324                 test_done "$testroot" "$ret"
 325                 return 1
 326         fi
 327         packidx_path=$testroot/repo/.git/objects/pack/pack-${packhash}.idx
 328         echo "$packidx_path could be removed" > $testroot/stdout.expected
 329         cmp -s $testroot/stdout.expected $testroot/stdout
 330         ret="$?"
 331         if [ "$ret" != "0" ]; then
 332                 diff -u $testroot/stdout.expected $testroot/stdout
 333                 test_done "$testroot" "$ret"
 334                 return 1
 335         fi
 336
 337         gotadmin cleanup -a -r $testroot/repo -p > $testroot/stdout
 338         ret="$?"
 339         if [ "$ret" != "0" ]; then
 340                 echo "gotadmin cleanup failed unexpectedly" >&2
 341                 test_done "$testroot" "$ret"
 342                 return 1
 343         fi
 344         echo "$packidx_path removed" > $testroot/stdout.expected
 345         cmp -s $testroot/stdout.expected $testroot/stdout
 346         ret="$?"
 347         if [ "$ret" != "0" ]; then
 348                 diff -u $testroot/stdout.expected $testroot/stdout
 349                 test_done "$testroot" "$ret"
 350                 return 1
 351         fi
 352
 353         # cleanup should now attempt to purge objects
 354         gotadmin cleanup -a -q -r $testroot/repo > $testroot/stdout \
 355                 2> $testroot/stderr
 356         ret="$?"
 357         if [ "$ret" != "0" ]; then
 358                 echo "gotadmin cleanup failed unexpectedly" >&2
 359                 test_done "$testroot" "1"
 360                 return 1
 361         fi
 362         test_done "$testroot" "$ret"
 363 }
 364
 365 test_parseargs "$@"
 366 run_test test_cleanup_unreferenced_loose_objects
 367 run_test test_cleanup_redundant_loose_objects
 368 run_test test_cleanup_precious_objects
 369 run_test test_cleanup_missing_pack_file