t0303: resurrect commit message as test documentation
The commit message which added those tests (861444f
't: add test
harness for external credential helpers' 2011-12-10) provided nice
documentation in the commit message. Let's make it more visible
by putting it in the test description.
The documentation is updated to reflect the fact that
GIT_TEST_CREDENTIAL_HELPER must be set for
GIT_TEST_CREDENTIAL_HELPER_TIMEOUT to be used
and GIT_TEST_CREDENTIAL_HELPER_SETUP can be used.
Based-on-commit-message-by: Jeff King <peff@peff.net>
Signed-off-by: Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl>
Acked-by: Jeff King <peff@peff.net>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
parent
16e44810c9
commit
6c556cb8e6
@ -1,6 +1,34 @@
|
||||
#!/bin/sh
|
||||
|
||||
test_description='external credential helper tests'
|
||||
test_description='external credential helper tests
|
||||
|
||||
This is a tool for authors of external helper tools to sanity-check
|
||||
their helpers. If you have written the "git-credential-foo" helper,
|
||||
you check it with:
|
||||
|
||||
make GIT_TEST_CREDENTIAL_HELPER=foo t0303-credential-external.sh
|
||||
|
||||
This assumes that your helper is capable of both storing and
|
||||
retrieving credentials (some helpers may be read-only, and they will
|
||||
fail these tests).
|
||||
|
||||
Please note that the individual tests do not verify all of the
|
||||
preconditions themselves, but rather build on each other. A failing
|
||||
test means that tests later in the sequence can return false "OK"
|
||||
results.
|
||||
|
||||
If your helper supports time-based expiration with a configurable
|
||||
timeout, you can test that feature with:
|
||||
|
||||
make GIT_TEST_CREDENTIAL_HELPER=foo \
|
||||
GIT_TEST_CREDENTIAL_HELPER_TIMEOUT="foo --timeout=1" \
|
||||
t0303-credential-external.sh
|
||||
|
||||
If your helper requires additional setup before the tests are started,
|
||||
you can set GIT_TEST_CREDENTIAL_HELPER_SETUP to a sequence of shell
|
||||
commands.
|
||||
'
|
||||
|
||||
. ./test-lib.sh
|
||||
. "$TEST_DIRECTORY"/lib-credential.sh
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user