2013-11-25 21:03:06 +00:00
|
|
|
# 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 ...
|
|
|
|
#
|
|
|
|
# stop_git_daemon
|
|
|
|
# test_done
|
2012-01-07 11:42:45 +00:00
|
|
|
|
tests: turn on network daemon tests by default
We do not run the httpd nor git-daemon tests by default, as
they are rather heavyweight and require network access
(albeit over localhost). However, it would be nice if more
pepole ran them, for two reasons:
1. We would get more test coverage on more systems.
2. The point of the test suite is to find regressions. It
is very easy to change some of the underlying code and
break the httpd code without realizing you are even
affecting it. Running the httpd tests helps find these
problems sooner (ideally before the patches even hit
the list).
We still want to leave an "out", though, for people who really do
not want to run them. For that reason, the GIT_TEST_HTTPD and
GIT_TEST_GIT_DAEMON variables are now tri-state booleans
(true/false/auto), so you can say GIT_TEST_HTTPD=false to turn the
tests back off. To support those who want a stable single way to
disable these tests across versions of Git before and after this
change, an empty string explicitly set to these variables is also
taken as "false", so the behaviour changes only for those who:
a. did not express any preference by leaving these variables
unset. They did not test these features before, but now they
do; or
b. did express that they want to test these features by setting
GIT_TEST_FEATURE=false (or any equivalent other ways to tell
"false" to Git, e.g. "0"), which has been a valid but funny way
to say that they do want to test the feature only because we
used to interpret any non-empty string to mean "yes please
test". They no longer test that feature.
In addition, we are forgiving of common setup failures (e.g., you do
not have apache installed, or have an old version) when the
tri-state is "auto" (or unset), but report an error when it is
"true". This makes "auto" a sane default, as we should not cause
failures on setups where the tests cannot run. But it allows people
who use "true" to catch regressions in their system (e.g., they
uninstalled apache, but were expecting their automated test runs to
test git-httpd, and would want to be notified).
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-02-10 21:29:37 +00:00
|
|
|
test_tristate GIT_TEST_GIT_DAEMON
|
|
|
|
if test "$GIT_TEST_GIT_DAEMON" = false
|
2012-01-07 11:42:45 +00:00
|
|
|
then
|
tests: turn on network daemon tests by default
We do not run the httpd nor git-daemon tests by default, as
they are rather heavyweight and require network access
(albeit over localhost). However, it would be nice if more
pepole ran them, for two reasons:
1. We would get more test coverage on more systems.
2. The point of the test suite is to find regressions. It
is very easy to change some of the underlying code and
break the httpd code without realizing you are even
affecting it. Running the httpd tests helps find these
problems sooner (ideally before the patches even hit
the list).
We still want to leave an "out", though, for people who really do
not want to run them. For that reason, the GIT_TEST_HTTPD and
GIT_TEST_GIT_DAEMON variables are now tri-state booleans
(true/false/auto), so you can say GIT_TEST_HTTPD=false to turn the
tests back off. To support those who want a stable single way to
disable these tests across versions of Git before and after this
change, an empty string explicitly set to these variables is also
taken as "false", so the behaviour changes only for those who:
a. did not express any preference by leaving these variables
unset. They did not test these features before, but now they
do; or
b. did express that they want to test these features by setting
GIT_TEST_FEATURE=false (or any equivalent other ways to tell
"false" to Git, e.g. "0"), which has been a valid but funny way
to say that they do want to test the feature only because we
used to interpret any non-empty string to mean "yes please
test". They no longer test that feature.
In addition, we are forgiving of common setup failures (e.g., you do
not have apache installed, or have an old version) when the
tri-state is "auto" (or unset), but report an error when it is
"true". This makes "auto" a sane default, as we should not cause
failures on setups where the tests cannot run. But it allows people
who use "true" to catch regressions in their system (e.g., they
uninstalled apache, but were expecting their automated test runs to
test git-httpd, and would want to be notified).
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-02-10 21:29:37 +00:00
|
|
|
skip_all="git-daemon testing disabled (unset GIT_TEST_GIT_DAEMON to enable)"
|
2012-01-07 11:42:45 +00:00
|
|
|
test_done
|
|
|
|
fi
|
|
|
|
|
2016-01-27 16:19:48 +00:00
|
|
|
if test_have_prereq !PIPE
|
|
|
|
then
|
|
|
|
test_skip_or_die $GIT_TEST_GIT_DAEMON "file system does not support FIFOs"
|
|
|
|
fi
|
|
|
|
|
2014-02-10 19:16:38 +00:00
|
|
|
LIB_GIT_DAEMON_PORT=${LIB_GIT_DAEMON_PORT-${this_test#t}}
|
2012-01-07 11:42:45 +00:00
|
|
|
|
|
|
|
GIT_DAEMON_PID=
|
|
|
|
GIT_DAEMON_DOCUMENT_ROOT_PATH="$PWD"/repo
|
t/lib-git-daemon: add network-protocol helpers
All of our git-protocol tests rely on invoking the client
and having it make a request of a server. That gives a nice
real-world test of how the two behave together, but it
doesn't leave any room for testing how a server might react
to _other_ clients.
Let's add a few test helper functions which can be used to
manually conduct a git-protocol conversation with a remote
git-daemon:
1. To connect to a remote git-daemon, we need something
like "netcat". But not everybody will have netcat. And
even if they do, the behavior with respect to
half-duplex shutdowns is not portable (openbsd netcat
has "-N", with others you must rely on "-q 1", which is
racy).
Here we provide a "fake_nc" that is capable of doing
a client-side netcat, with sane half-duplex semantics.
It relies on perl's IO::Socket::INET. That's been in
the base distribution since 5.6.0, so it's probably
available everywhere. But just to be on the safe side,
we'll add a prereq.
2. To help tests speak and read pktline, this patch adds
packetize() and depacketize() functions.
I've put fake_nc() into lib-git-daemon.sh, since that's
really the only server where we'd need to use a network
socket. Whereas the pktline helpers may be of more general
use, so I've added them to test-lib-functions.sh. Programs
like upload-pack speak pktline, but can talk directly over
stdio without a network socket.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2018-01-25 00:58:19 +00:00
|
|
|
GIT_DAEMON_HOST_PORT=127.0.0.1:$LIB_GIT_DAEMON_PORT
|
|
|
|
GIT_DAEMON_URL=git://$GIT_DAEMON_HOST_PORT
|
2012-01-07 11:42:45 +00:00
|
|
|
|
|
|
|
start_git_daemon() {
|
|
|
|
if test -n "$GIT_DAEMON_PID"
|
|
|
|
then
|
|
|
|
error "start_git_daemon already called"
|
|
|
|
fi
|
|
|
|
|
|
|
|
mkdir -p "$GIT_DAEMON_DOCUMENT_ROOT_PATH"
|
|
|
|
|
|
|
|
trap 'code=$?; stop_git_daemon; (exit $code); die' EXIT
|
|
|
|
|
|
|
|
say >&3 "Starting git daemon ..."
|
2012-01-07 11:42:47 +00:00
|
|
|
mkfifo git_daemon_output
|
2017-02-25 09:37:30 +00:00
|
|
|
${LIB_GIT_DAEMON_COMMAND:-git daemon} \
|
|
|
|
--listen=127.0.0.1 --port="$LIB_GIT_DAEMON_PORT" \
|
2012-01-07 11:42:45 +00:00
|
|
|
--reuseaddr --verbose \
|
|
|
|
--base-path="$GIT_DAEMON_DOCUMENT_ROOT_PATH" \
|
|
|
|
"$@" "$GIT_DAEMON_DOCUMENT_ROOT_PATH" \
|
2012-01-07 11:42:47 +00:00
|
|
|
>&3 2>git_daemon_output &
|
2012-01-07 11:42:45 +00:00
|
|
|
GIT_DAEMON_PID=$!
|
2018-01-25 19:16:41 +00:00
|
|
|
>daemon.log
|
2012-01-07 11:42:47 +00:00
|
|
|
{
|
2018-01-25 19:16:41 +00:00
|
|
|
read -r line <&7
|
|
|
|
printf "%s\n" "$line"
|
|
|
|
printf >&4 "%s\n" "$line"
|
|
|
|
(
|
|
|
|
while read -r line <&7
|
|
|
|
do
|
|
|
|
printf "%s\n" "$line"
|
|
|
|
printf >&4 "%s\n" "$line"
|
|
|
|
done
|
|
|
|
) &
|
|
|
|
} 7<git_daemon_output >>"$TRASH_DIRECTORY/daemon.log" &&
|
2012-01-07 11:42:47 +00:00
|
|
|
|
2012-04-26 21:00:39 +00:00
|
|
|
# Check expected output
|
|
|
|
if test x"$(expr "$line" : "\[[0-9]*\] \(.*\)")" != x"Ready to rumble"
|
|
|
|
then
|
|
|
|
kill "$GIT_DAEMON_PID"
|
|
|
|
wait "$GIT_DAEMON_PID"
|
|
|
|
trap 'die' EXIT
|
tests: turn on network daemon tests by default
We do not run the httpd nor git-daemon tests by default, as
they are rather heavyweight and require network access
(albeit over localhost). However, it would be nice if more
pepole ran them, for two reasons:
1. We would get more test coverage on more systems.
2. The point of the test suite is to find regressions. It
is very easy to change some of the underlying code and
break the httpd code without realizing you are even
affecting it. Running the httpd tests helps find these
problems sooner (ideally before the patches even hit
the list).
We still want to leave an "out", though, for people who really do
not want to run them. For that reason, the GIT_TEST_HTTPD and
GIT_TEST_GIT_DAEMON variables are now tri-state booleans
(true/false/auto), so you can say GIT_TEST_HTTPD=false to turn the
tests back off. To support those who want a stable single way to
disable these tests across versions of Git before and after this
change, an empty string explicitly set to these variables is also
taken as "false", so the behaviour changes only for those who:
a. did not express any preference by leaving these variables
unset. They did not test these features before, but now they
do; or
b. did express that they want to test these features by setting
GIT_TEST_FEATURE=false (or any equivalent other ways to tell
"false" to Git, e.g. "0"), which has been a valid but funny way
to say that they do want to test the feature only because we
used to interpret any non-empty string to mean "yes please
test". They no longer test that feature.
In addition, we are forgiving of common setup failures (e.g., you do
not have apache installed, or have an old version) when the
tri-state is "auto" (or unset), but report an error when it is
"true". This makes "auto" a sane default, as we should not cause
failures on setups where the tests cannot run. But it allows people
who use "true" to catch regressions in their system (e.g., they
uninstalled apache, but were expecting their automated test runs to
test git-httpd, and would want to be notified).
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2014-02-10 21:29:37 +00:00
|
|
|
test_skip_or_die $GIT_TEST_GIT_DAEMON \
|
|
|
|
"git daemon failed to start"
|
2012-04-26 21:00:39 +00:00
|
|
|
fi
|
2012-01-07 11:42:45 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
stop_git_daemon() {
|
|
|
|
if test -z "$GIT_DAEMON_PID"
|
|
|
|
then
|
|
|
|
return
|
|
|
|
fi
|
|
|
|
|
|
|
|
trap 'die' EXIT
|
|
|
|
|
|
|
|
# kill git-daemon child of git
|
|
|
|
say >&3 "Stopping git daemon ..."
|
|
|
|
kill "$GIT_DAEMON_PID"
|
|
|
|
wait "$GIT_DAEMON_PID" >&3 2>&4
|
|
|
|
ret=$?
|
2016-06-24 19:45:12 +00:00
|
|
|
if test_match_signal 15 $?
|
2012-01-07 11:42:45 +00:00
|
|
|
then
|
|
|
|
error "git daemon exited with status: $ret"
|
|
|
|
fi
|
|
|
|
GIT_DAEMON_PID=
|
2012-01-07 11:42:47 +00:00
|
|
|
rm -f git_daemon_output
|
2012-01-07 11:42:45 +00:00
|
|
|
}
|
t/lib-git-daemon: add network-protocol helpers
All of our git-protocol tests rely on invoking the client
and having it make a request of a server. That gives a nice
real-world test of how the two behave together, but it
doesn't leave any room for testing how a server might react
to _other_ clients.
Let's add a few test helper functions which can be used to
manually conduct a git-protocol conversation with a remote
git-daemon:
1. To connect to a remote git-daemon, we need something
like "netcat". But not everybody will have netcat. And
even if they do, the behavior with respect to
half-duplex shutdowns is not portable (openbsd netcat
has "-N", with others you must rely on "-q 1", which is
racy).
Here we provide a "fake_nc" that is capable of doing
a client-side netcat, with sane half-duplex semantics.
It relies on perl's IO::Socket::INET. That's been in
the base distribution since 5.6.0, so it's probably
available everywhere. But just to be on the safe side,
we'll add a prereq.
2. To help tests speak and read pktline, this patch adds
packetize() and depacketize() functions.
I've put fake_nc() into lib-git-daemon.sh, since that's
really the only server where we'd need to use a network
socket. Whereas the pktline helpers may be of more general
use, so I've added them to test-lib-functions.sh. Programs
like upload-pack speak pktline, but can talk directly over
stdio without a network socket.
Signed-off-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
2018-01-25 00:58:19 +00:00
|
|
|
|
|
|
|
# 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"
|
|
|
|
'
|