[thirdparty/git.git] / t / lib-git-daemon.sh

# Shell library to run git-daemon in tests.  Ends the test early if
# GIT_TEST_GIT_DAEMON is not set.
#
# Usage:
#
#	. ./test-lib.sh
#	. "$TEST_DIRECTORY"/lib-git-daemon.sh
#	start_git_daemon
#
#	test_expect_success '...' '
#		...
#	'
#
#	test_expect_success ...
#
#	test_done

if ! git env--helper --type=bool --default=true --exit-code GIT_TEST_GIT_DAEMON
then
	skip_all="git-daemon testing disabled (unset GIT_TEST_GIT_DAEMON to enable)"
	test_done
fi

if test_have_prereq !PIPE
then
	test_skip_or_die GIT_TEST_GIT_DAEMON "file system does not support FIFOs"
fi

test_set_port LIB_GIT_DAEMON_PORT

GIT_DAEMON_PID=
GIT_DAEMON_PIDFILE="$PWD"/daemon.pid
GIT_DAEMON_DOCUMENT_ROOT_PATH="$PWD"/repo
GIT_DAEMON_HOST_PORT=127.0.0.1:$LIB_GIT_DAEMON_PORT
GIT_DAEMON_URL=git://$GIT_DAEMON_HOST_PORT

registered_stop_git_daemon_atexit_handler=
start_git_daemon() {
	if test -n "$GIT_DAEMON_PID"
	then
		error "start_git_daemon already called"
	fi

	mkdir -p "$GIT_DAEMON_DOCUMENT_ROOT_PATH"

	# One of the test scripts stops and then re-starts 'git daemon'.
	# Don't register and then run the same atexit handlers several times.
	if test -z "$registered_stop_git_daemon_atexit_handler"
	then
		test_atexit 'stop_git_daemon'
		registered_stop_git_daemon_atexit_handler=AlreadyDone
	fi

	say >&3 "Starting git daemon ..."
	mkfifo git_daemon_output
	${LIB_GIT_DAEMON_COMMAND:-git daemon} \
		--listen=127.0.0.1 --port="$LIB_GIT_DAEMON_PORT" \
		--reuseaddr --verbose --pid-file="$GIT_DAEMON_PIDFILE" \
		--base-path="$GIT_DAEMON_DOCUMENT_ROOT_PATH" \
		"$@" "$GIT_DAEMON_DOCUMENT_ROOT_PATH" \
		>&3 2>git_daemon_output &
	GIT_DAEMON_PID=$!
	{
		read -r line <&7
		printf "%s\n" "$line" >&4
		cat <&7 >&4 &
	} 7<git_daemon_output &&

	# Check expected output
	if test x"$(expr "$line" : "\[[0-9]*\] \(.*\)")" != x"Ready to rumble"
	then
		kill "$GIT_DAEMON_PID"
		wait "$GIT_DAEMON_PID"
		unset GIT_DAEMON_PID
		test_skip_or_die GIT_TEST_GIT_DAEMON \
			"git daemon failed to start"
	fi
}

stop_git_daemon() {
	if test -z "$GIT_DAEMON_PID"
	then
		return
	fi

	# kill git-daemon child of git
	say >&3 "Stopping git daemon ..."
	kill "$GIT_DAEMON_PID"
	wait "$GIT_DAEMON_PID" >&3 2>&4
	ret=$?
	if ! test_match_signal 15 $ret
	then
		error "git daemon exited with status: $ret"
	fi
	kill "$(cat "$GIT_DAEMON_PIDFILE")" 2>/dev/null
	GIT_DAEMON_PID=
	rm -f git_daemon_output "$GIT_DAEMON_PIDFILE"
}

# A stripped-down version of a netcat client, that connects to a "host:port"
# given in $1, sends its stdin followed by EOF, then dumps the response (until
# EOF) to stdout.
fake_nc() {
	if ! test_declared_prereq FAKENC
	then
		echo >&4 "fake_nc: need to declare FAKENC prerequisite"
		return 127
	fi
	perl -Mstrict -MIO::Socket::INET -e '
		my $s = IO::Socket::INET->new(shift)
			or die "unable to open socket: $!";
		print $s <STDIN>;
		$s->shutdown(1);
		print <$s>;
	' "$@"
}

test_lazy_prereq FAKENC '
	perl -MIO::Socket::INET -e "exit 0"
'
Commit	Line	Data
c74c7203 JN	1	# Shell library to run git-daemon in tests. Ends the test early if
	2	# GIT_TEST_GIT_DAEMON is not set.
	3	#
	4	# Usage:
	5	#
	6	# . ./test-lib.sh
	7	# . "$TEST_DIRECTORY"/lib-git-daemon.sh
	8	# start_git_daemon
	9	#
	10	# test_expect_success '...' '
	11	# ...
	12	# '
	13	#
	14	# test_expect_success ...
	15	#
c74c7203	16	# test_done
71039fb9	17
3b072c57	18	if ! git env--helper --type=bool --default=true --exit-code GIT_TEST_GIT_DAEMON
71039fb9	19	then
83d842dc	20	skip_all="git-daemon testing disabled (unset GIT_TEST_GIT_DAEMON to enable)"
71039fb9 CB	21	test_done
	22	fi
	23
a390d7e8 JS	24	if test_have_prereq !PIPE
a390d7e8 JS	25	then
3b072c57	26	test_skip_or_die GIT_TEST_GIT_DAEMON "file system does not support FIFOs"
a390d7e8 JS	27	fi
a390d7e8 JS	28
fa840581	29	test_set_port LIB_GIT_DAEMON_PORT
71039fb9 CB	30
71039fb9 CB	31	GIT_DAEMON_PID=
80a539ac	32	GIT_DAEMON_PIDFILE="$PWD"/daemon.pid
71039fb9	33	GIT_DAEMON_DOCUMENT_ROOT_PATH="$PWD"/repo
4414a150 JK	34	GIT_DAEMON_HOST_PORT=127.0.0.1:$LIB_GIT_DAEMON_PORT
4414a150 JK	35	GIT_DAEMON_URL=git://$GIT_DAEMON_HOST_PORT
71039fb9	36
9f82b2a6	37	registered_stop_git_daemon_atexit_handler=
71039fb9 CB	38	start_git_daemon() {
	39	if test -n "$GIT_DAEMON_PID"
	40	then
	41	error "start_git_daemon already called"
	42	fi
	43
	44	mkdir -p "$GIT_DAEMON_DOCUMENT_ROOT_PATH"
	45
9f82b2a6 JS	46	# One of the test scripts stops and then re-starts 'git daemon'.
	47	# Don't register and then run the same atexit handlers several times.
	48	if test -z "$registered_stop_git_daemon_atexit_handler"
	49	then
	50	test_atexit 'stop_git_daemon'
	51	registered_stop_git_daemon_atexit_handler=AlreadyDone
	52	fi
71039fb9 CB	53
71039fb9 CB	54	say >&3 "Starting git daemon ..."
561b133c	55	mkfifo git_daemon_output
bd4d9d99 JK	56	${LIB_GIT_DAEMON_COMMAND:-git daemon} \
bd4d9d99 JK	57	--listen=127.0.0.1 --port="$LIB_GIT_DAEMON_PORT" \
80a539ac	58	--reuseaddr --verbose --pid-file="$GIT_DAEMON_PIDFILE" \
71039fb9 CB	59	--base-path="$GIT_DAEMON_DOCUMENT_ROOT_PATH" \
71039fb9 CB	60	"$@" "$GIT_DAEMON_DOCUMENT_ROOT_PATH" \
561b133c	61	>&3 2>git_daemon_output &
71039fb9	62	GIT_DAEMON_PID=$!
561b133c	63	{
314a73d6	64	read -r line <&7
3c78e97d TG	65	printf "%s\n" "$line" >&4
	66	cat <&7 >&4 &
	67	} 7<git_daemon_output &&
561b133c	68
46e35815 JS	69	# Check expected output
	70	if test x"$(expr "$line" : "\[[0-9]\] \(.\)")" != x"Ready to rumble"
	71	then
	72	kill "$GIT_DAEMON_PID"
	73	wait "$GIT_DAEMON_PID"
9f82b2a6	74	unset GIT_DAEMON_PID
3b072c57	75	test_skip_or_die GIT_TEST_GIT_DAEMON \
83d842dc	76	"git daemon failed to start"
46e35815	77	fi
71039fb9 CB	78	}
	79
	80	stop_git_daemon() {
	81	if test -z "$GIT_DAEMON_PID"
	82	then
	83	return
	84	fi
	85
71039fb9 CB	86	# kill git-daemon child of git
	87	say >&3 "Stopping git daemon ..."
	88	kill "$GIT_DAEMON_PID"
	89	wait "$GIT_DAEMON_PID" >&3 2>&4
	90	ret=$?
4c2eb064	91	if ! test_match_signal 15 $ret
71039fb9 CB	92	then
	93	error "git daemon exited with status: $ret"
	94	fi
80a539ac	95	kill "$(cat "$GIT_DAEMON_PIDFILE")" 2>/dev/null
71039fb9	96	GIT_DAEMON_PID=
80a539ac	97	rm -f git_daemon_output "$GIT_DAEMON_PIDFILE"
71039fb9	98	}
4414a150 JK	99
	100	# A stripped-down version of a netcat client, that connects to a "host:port"
	101	# given in $1, sends its stdin followed by EOF, then dumps the response (until
	102	# EOF) to stdout.
	103	fake_nc() {
	104	if ! test_declared_prereq FAKENC
	105	then
	106	echo >&4 "fake_nc: need to declare FAKENC prerequisite"
	107	return 127
	108	fi
	109	perl -Mstrict -MIO::Socket::INET -e '
	110	my $s = IO::Socket::INET->new(shift)
	111	or die "unable to open socket: $!";
	112	print $s <STDIN>;
	113	$s->shutdown(1);
	114	print <$s>;
	115	' "$@"
	116	}
	117
	118	test_lazy_prereq FAKENC '
	119	perl -MIO::Socket::INET -e "exit 0"
	120	'