thodg/got/regress/cmdline/cleanup.sh

• Show log

  Commit

• Hash : ef8ec606
  Author :
  Date : 2021-07-27T13:08:52
  

  prevent a race where 'gotadmin cleanup' deletes concurrently created objects

Download

• regress/cmdline/cleanup.sh

• #!/bin/sh
  #
  # Copyright (c) 2021 Stefan Sperling <stsp@openbsd.org>
  #
  # Permission to use, copy, modify, and distribute this software for any
  # purpose with or without fee is hereby granted, provided that the above
  # copyright notice and this permission notice appear in all copies.
  #
  # THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  # WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  # MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  # ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  # WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  # ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  # OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  
  . ./common.sh
  
  # disable automatic packing for these tests
  export GOT_TEST_PACK=""
  
  test_cleanup_unreferenced_loose_objects() {
  	local testroot=`test_init cleanup_unreferenced_loose_objects`
  
  	nloose0=`gotadmin info -r $testroot/repo | grep '^loose objects:' | \
  		cut -d ':' -f 2 | tr -d ' '`
  	if [ "$nloose0" != "8" ]; then
  		echo "unexpected number of loose objects: $nloose0" >&2
  		test_done "$testroot" "1"
  		return 1
  	fi
  
  	# create a branch with some changes
  	got branch -r $testroot/repo newbranch >/dev/null
  
  	got checkout -b newbranch $testroot/repo $testroot/wt >/dev/null
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		echo "got checkout command failed unexpectedly"
  		test_done "$testroot" "$ret"
  		return 1
  	fi
  
  	echo 'foo' > $testroot/wt/foo
  	(cd $testroot/wt && got add foo > /dev/null)
  	echo 'modified alpha' > $testroot/wt/alpha
  	(cd $testroot/wt && got commit -m 'newbranch commit' > /dev/null)
  	local commit1=`git_show_branch_head $testroot/repo newbranch`
  	local tree1=`got cat -r $testroot/repo $newbranch_commit | \
  		grep ^tree | cut -d ' ' -f2`
  	local alpha1=`got tree -r $testroot/repo -i -c $commit1 | \
  		grep "[0-9a-f] alpha$" | cut -d' ' -f 1`
  	local foo1=`got tree -r $testroot/repo -i -c $commit1 | \
  		grep "[0-9a-f] foo$" | cut -d' ' -f 1`
  
  	nloose1=`gotadmin info -r $testroot/repo | grep '^loose objects:' | \
  		cut -d ':' -f 2 | tr -d ' '`
  	if [ "$nloose1" != "12" ]; then
  		echo "unexpected number of loose objects: $nloose1" >&2
  		test_done "$testroot" "1"
  		return 1
  	fi
  
  	# delete the branch
  	got branch -r $testroot/repo -d newbranch >/dev/null
  
  	# remove worktree's base commit reference, which points at the branch
  	wt_uuid=`(cd $testroot/wt && got info | grep 'UUID:' | \
  		cut -d ':' -f 2 | tr -d ' ')`
  	got ref -r $testroot/repo -d "refs/got/worktree/base-$wt_uuid" \
  		> /dev/null
  
  	# cleanup -n should not remove any objects
  	ls -R $testroot/repo/.git/objects > $testroot/objects-before
  	gotadmin cleanup -a -n -q -r $testroot/repo > $testroot/stdout
  	echo -n > $testroot/stdout.expected
  	cmp -s $testroot/stdout.expected $testroot/stdout
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		diff -u $testroot/stdout.expected $testroot/stdout
  		test_done "$testroot" "$ret"
  		return 1
  	fi
  	ls -R $testroot/repo/.git/objects > $testroot/objects-after
  	cmp -s $testroot/objects-before $testroot/objects-after
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		diff -u $testroot/objects-before $testroot/objects-after
  		test_done "$testroot" "$ret"
  		return 1
  	fi
  
  	# cleanup should remove loose objects that belonged to the branch
  	gotadmin cleanup -a -q -r $testroot/repo > $testroot/stdout
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		echo "gotadmin cleanup failed unexpectedly" >&2
  		test_done "$testroot" "$ret"
  		return 1
  	fi
  	echo -n > $testroot/stdout.expected
  	cmp -s $testroot/stdout.expected $testroot/stdout
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		diff -u $testroot/stdout.expected $testroot/stdout
  		test_done "$testroot" "$ret"
  		return 1
  	fi
  
  	nloose2=`gotadmin info -r $testroot/repo | grep '^loose objects:' | \
  		cut -d ':' -f 2 | tr -d ' '`
  	if [ "$nloose2" != "$nloose0" ]; then
  		echo "unexpected number of loose objects: $nloose2" >&2
  		test_done "$testroot" "1"
  		return 1
  	fi
  
  	for id in $commit1 $tree1 $alpha1 $foo1; do
  		path=`get_loose_object_path $testroot/repo $id`
  		if [ -e "$path" ]; then
  			echo "loose object $path was not purged" >&2
  			ret=1
  			break
  		fi
  	done
  
  	test_done "$testroot" "$ret"
  }
  
  test_cleanup_redundant_loose_objects() {
  	local testroot=`test_init cleanup_redundant_loose_objects`
  
  	# tags should also be packed
  	got tag -r $testroot/repo -m 1.0 1.0 >/dev/null
  
  	nloose0=`gotadmin info -r $testroot/repo | grep '^loose objects:' | \
  		cut -d ':' -f 2 | tr -d ' '`
  	if [ "$nloose0" != "9" ]; then
  		echo "unexpected number of loose objects: $nloose0" >&2
  		test_done "$testroot" "1"
  		return 1
  	fi
  
  	# no pack files should exist yet
  	ls $testroot/repo/.git/objects/pack/ > $testroot/stdout
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		test_done "$testroot" "$ret"
  		return 1
  	fi
  	echo -n > $testroot/stdout.expected
  	cmp -s $testroot/stdout.expected $testroot/stdout
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		diff -u $testroot/stdout.expected $testroot/stdout
  		test_done "$testroot" "$ret"
  		return 1
  	fi
  
  	gotadmin pack -r $testroot/repo > /dev/null
  
  	npacked0=`gotadmin info -r $testroot/repo | grep '^packed objects:' | \
  		cut -d ':' -f 2 | tr -d ' '`
  	if [ "$npacked0" != "9" ]; then
  		echo "unexpected number of loose objects: $npacked0" >&2
  		test_done "$testroot" "1"
  		return 1
  	fi
  
  	# cleanup -n should not remove any objects
  	ls -R $testroot/repo/.git/objects > $testroot/objects-before
  	gotadmin cleanup -a -n -q -r $testroot/repo > $testroot/stdout
  	echo -n > $testroot/stdout.expected
  	cmp -s $testroot/stdout.expected $testroot/stdout
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		diff -u $testroot/stdout.expected $testroot/stdout
  		test_done "$testroot" "$ret"
  		return 1
  	fi
  	ls -R $testroot/repo/.git/objects > $testroot/objects-after
  	cmp -s $testroot/objects-before $testroot/objects-after
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		diff -u $testroot/objects-before $testroot/objects-after
  		test_done "$testroot" "$ret"
  		return 1
  	fi
  
  	nloose1=`gotadmin info -r $testroot/repo | grep '^loose objects:' | \
  		cut -d ':' -f 2 | tr -d ' '`
  	if [ "$nloose1" != "$nloose0" ]; then
  		echo "unexpected number of loose objects: $nloose1" >&2
  		test_done "$testroot" "1"
  		return 1
  	fi
  
  	# cleanup should remove all loose objects
  	gotadmin cleanup -a -q -r $testroot/repo > $testroot/stdout
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		echo "gotadmin cleanup failed unexpectedly" >&2
  		test_done "$testroot" "$ret"
  		return 1
  	fi
  	echo -n > $testroot/stdout.expected
  	cmp -s $testroot/stdout.expected $testroot/stdout
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		diff -u $testroot/stdout.expected $testroot/stdout
  		test_done "$testroot" "$ret"
  		return 1
  	fi
  
  	nloose2=`gotadmin info -r $testroot/repo | grep '^loose objects:' | \
  		cut -d ':' -f 2 | tr -d ' '`
  	if [ "$nloose2" != "0" ]; then
  		echo "unexpected number of loose objects: $nloose2" >&2
  		test_done "$testroot" "1"
  		return 1
  	fi
  
  	for d in $testroot/repo/.git/objects/[0-9a-f][0-9a-f]; do
  		id0=`basename $d`
  		ret=0
  		for e in `ls $d`; do
  			obj_id=${id0}${e}
  			echo "loose object $obj_id was not purged" >&2
  			ret=1
  			break
  		done
  		if [ "$ret" = "1" ]; then
  			break
  		fi
  	done
  
  	test_done "$testroot" "$ret"
  }
  
  test_cleanup_precious_objects() {
  	local testroot=`test_init cleanup_precious_objects`
  
  	# enable Git's preciousObjects extension
  	(cd $testroot/repo && git config extensions.preciousObjects true)
  
  	# cleanup should now refuse to purge objects
  	gotadmin cleanup -a -q -r $testroot/repo > $testroot/stdout \
  		2> $testroot/stderr
  	ret="$?"
  	if [ "$ret" == "0" ]; then
  		echo "gotadmin cleanup succeeded unexpectedly" >&2
  		test_done "$testroot" "1"
  		return 1
  	fi
  
  	echo -n "gotadmin: the preciousObjects Git extension is enabled; " \
  		> $testroot/stderr.expected
  	echo "this implies that objects must not be deleted" \
  		>> $testroot/stderr.expected
  	cmp -s $testroot/stderr.expected $testroot/stderr
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		diff -u $testroot/stderr.expected $testroot/stderr
  	fi
  	test_done "$testroot" "$ret"
  }
  
  test_cleanup_missing_pack_file() {
  	local testroot=`test_init cleanup_missing_pack_file`
  
  	# no pack files should exist yet
  	ls $testroot/repo/.git/objects/pack/ > $testroot/stdout
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		test_done "$testroot" "$ret"
  		return 1
  	fi
  	echo -n > $testroot/stdout.expected
  	cmp -s $testroot/stdout.expected $testroot/stdout
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		diff -u $testroot/stdout.expected $testroot/stdout
  		test_done "$testroot" "$ret"
  		return 1
  	fi
  
  	gotadmin pack -r $testroot/repo > $testroot/stdout
  	packname=`grep ^Wrote $testroot/stdout | cut -d ' ' -f2`
  	packhash=`echo $packname | sed -e 's:^objects/pack/pack-::' \
  		-e 's/.pack$//'`
  
  	# Some freshly cloned Git repositories suffer from lonely pack index
  	# files. Remove the pack file we just wrote to simulate this issue.
  	rm $testroot/repo/.git/objects/pack/pack-$packname
  
  	# cleanup should now refuse to purge objects
  	gotadmin cleanup -a -q -r $testroot/repo > $testroot/stdout \
  		2> $testroot/stderr
  	ret="$?"
  	if [ "$ret" == "0" ]; then
  		echo "gotadmin cleanup succeeded unexpectedly" >&2
  		test_done "$testroot" "1"
  		return 1
  	fi
  
  	echo -n "gotadmin: objects/pack/pack-${packhash}.idx: " \
  		> $testroot/stderr.expected
  	echo -n "pack index has no corresponding pack file; pack file must " \
  		>> $testroot/stderr.expected
  	echo "be restored or 'gotadmin cleanup -p' must be run" \
  		>> $testroot/stderr.expected
  	cmp -s $testroot/stderr.expected $testroot/stderr
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		diff -u $testroot/stderr.expected $testroot/stderr
  		test_done "$testroot" "$ret"
  		return 1
  	fi
  
  	gotadmin cleanup -a -r $testroot/repo -p -n > $testroot/stdout
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		echo "gotadmin cleanup failed unexpectedly" >&2
  		test_done "$testroot" "$ret"
  		return 1
  	fi
  	packidx_path=$testroot/repo/.git/objects/pack/pack-${packhash}.idx
  	echo "$packidx_path could be removed" > $testroot/stdout.expected
  	cmp -s $testroot/stdout.expected $testroot/stdout
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		diff -u $testroot/stdout.expected $testroot/stdout
  		test_done "$testroot" "$ret"
  		return 1
  	fi
  
  	gotadmin cleanup -a -r $testroot/repo -p > $testroot/stdout
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		echo "gotadmin cleanup failed unexpectedly" >&2
  		test_done "$testroot" "$ret"
  		return 1
  	fi
  	echo "$packidx_path removed" > $testroot/stdout.expected
  	cmp -s $testroot/stdout.expected $testroot/stdout
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		diff -u $testroot/stdout.expected $testroot/stdout
  		test_done "$testroot" "$ret"
  		return 1
  	fi
  
  	# cleanup should now attempt to purge objects
  	gotadmin cleanup -a -q -r $testroot/repo > $testroot/stdout \
  		2> $testroot/stderr
  	ret="$?"
  	if [ "$ret" != "0" ]; then
  		echo "gotadmin cleanup failed unexpectedly" >&2
  		test_done "$testroot" "1"
  		return 1
  	fi
  	test_done "$testroot" "$ret"
  }
  
  test_parseargs "$@"
  run_test test_cleanup_unreferenced_loose_objects
  run_test test_cleanup_redundant_loose_objects
  run_test test_cleanup_precious_objects
  run_test test_cleanup_missing_pack_file
  

Download