f137f45388
It's very common for a user to specify an SSH remote that refers to an alias in their gitconfig file. For example, if a user must use different SSH keys when pushing to different remotes, setting different aliases that use those different keys is the simplest and easiest way to accomplish that goal. Unfortunately, our parsing logic was broken for SSH remotes that used bare SSH URLs (that is, without “ssh://”) with a hostname or alias, but without a username component. The URL parser we used saw the hostname portion as the scheme of a URL, and we passed through any URLs with unknown schemes. This led to a failure to push, since we misparsed the URL as a non-SSH URL and gave up when it also didn't look like an HTTP(S) URL. If we get an unknown “scheme” when parsing a URL, check if the URL uses a remote helper (that is, it contains a double colon), and pass it through. Otherwise, do what Git does, and assume the URL is in fact an SSH URL, and handle it accordingly. We already handle the url.insteadof syntax properly, even if it looks like a scheme. Add tests that we continue to do so, and for the new code and all the various permutations mentioned above, and update the existing integration test to reflect our new parsing strategy. |
||
---|---|---|
.. | ||
cmd | ||
fixtures | ||
git-lfs-test-server-api | ||
Makefile | ||
README.md | ||
t-askpass.sh | ||
t-batch-error-handling.sh | ||
t-batch-retries.sh | ||
t-batch-transfer.sh | ||
t-batch-unknown-oids.sh | ||
t-checkout.sh | ||
t-chunked-transfer-encoding.sh | ||
t-clean.sh | ||
t-clone-deprecated.sh | ||
t-clone.sh | ||
t-commit-delete-push.sh | ||
t-config.sh | ||
t-content-type.sh | ||
t-credentials-no-prompt.sh | ||
t-credentials.sh | ||
t-custom-transfers.sh | ||
t-duplicate-oids.sh | ||
t-env.sh | ||
t-expired.sh | ||
t-ext.sh | ||
t-extra-header.sh | ||
t-fetch-include.sh | ||
t-fetch-paths.sh | ||
t-fetch-recent.sh | ||
t-fetch-refspec.sh | ||
t-fetch.sh | ||
t-filter-branch.sh | ||
t-filter-process.sh | ||
t-fsck.sh | ||
t-happy-path.sh | ||
t-install-custom-hooks-path-unsupported.sh | ||
t-install-custom-hooks-path.sh | ||
t-install.sh | ||
t-lock.sh | ||
t-locks.sh | ||
t-logs.sh | ||
t-ls-files.sh | ||
t-malformed-pointers.sh | ||
t-mergetool.sh | ||
t-migrate-export.sh | ||
t-migrate-fixup.sh | ||
t-migrate-import-no-rewrite.sh | ||
t-migrate-import.sh | ||
t-migrate-info.sh | ||
t-object-authenticated.sh | ||
t-pointer.sh | ||
t-post-checkout.sh | ||
t-post-commit.sh | ||
t-post-merge.sh | ||
t-pre-push.sh | ||
t-progress-meter.sh | ||
t-progress.sh | ||
t-prune-worktree.sh | ||
t-prune.sh | ||
t-pull.sh | ||
t-push-bad-dns.sh | ||
t-push-failures-local.sh | ||
t-push-failures-remote.sh | ||
t-push-file-with-branch-name.sh | ||
t-push.sh | ||
t-reference-clone.sh | ||
t-resume-http-range.sh | ||
t-resume-tus.sh | ||
t-smudge.sh | ||
t-ssh.sh | ||
t-status.sh | ||
t-submodule-lfsconfig.sh | ||
t-submodule.sh | ||
t-track-attrs.sh | ||
t-track-wildcards.sh | ||
t-track.sh | ||
t-uninstall.sh | ||
t-unlock.sh | ||
t-untrack.sh | ||
t-unusual-filenames.sh | ||
t-update.sh | ||
t-verify.sh | ||
t-version.sh | ||
t-worktree.sh | ||
t-zero-len-file.sh | ||
test-alternates.sh | ||
testenv.sh | ||
testhelpers.sh | ||
testlib.sh |
t
This directory contains one of the two types of tests that the Git LFS project
uses to protect against regression. The first, scattered in *_test.go
files
throughout the repository are unit tests, and written in Go, designed to
uncover failures at the unit level.
The second kind--and the one contained in this directory--are integration
tests, which are designed to exercise Git LFS in an end-to-end fashion,
running the git
, and git-lfs
binaries, along with a mock Git server.
You can run all tests in this directory with any of the following:
$ make
$ make test
$ make PROVE_EXTRA_ARGS=-j9 test
Or run a single test (for example, t-checkout.sh
) by any of the following:
$ make ./t-checkout.sh
$ make PROVE_EXTRA_ARGS=-v ./t-checkout.sh
$ ./t-checkout.sh
Alternatively, one can run a selection of tests (via explicitly listing them or making use of the built-in shell globbing) by any of the following:
$ make ./t-*.sh
$ make PROVE_EXTRA_ARGS=-j9 ./t-*.sh
$ ./t-*.sh
Test File(s)
There are a few important kinds of files to know about in the t
directory:
-
cmd/
: contains the source code of binaries that are useful during test time, like the mocked Git server, or the test counting binary. For more about the contents of this directory, see test lifecycle below.The file
t/cmd/testutils.go
is automatically linked and included during the build process of each file incmd
. -
fixtures/
: contains shell scripts that load fixture repositories useful for testing against. -
t-*.sh
: file(s) containing zero or more tests, typically related to a similar topic (c.f,.t/t-push.sh
,t/t-pull.sh
, etc.) -
testenv.sh
: loads environment variables useful during tests. This file is sourced bytestlib.sh
. -
testhelpers.sh
: loads shell functions useful during tests, likesetup_remote_repo
, andclone_repo
. -
testlib.sh
: loads thebegin_test
,end_test
, and similar functions useful for instantiating a particular test.
Test Lifecycle
When a test is run, the following occurs, in order:
-
Missing test binaries are compiled into the
bin
directory in the repository root. Note: this does not include thegit-lfs
binary, which is re-compiled viascript/boostrap
. -
An integration server is started by either (1) the
Makefile
or (2) thecmd/lfstest-count-test.go
program, which keeps track of the number of running tests and starts an integration server any time the number of active tests goes from0
to1
, and stops the server when it goes fromn
to0
. -
After sourcing
t/testlib.sh
(& loadingt/testenv.sh
), each test is run in sequence per file. (In other words, multiple test files can be run in parallel, but the tests in a single file are run in sequence.) -
An individual test will finish, and (if running under
prove
) another will be started in its place. Once all tests are done,t/test_count
will go to0
, and the test server will be torn down.
Test Environment
There are a few environment variables that you can set to change the test suite behavior:
-
GIT_LFS_TEST_DIR=path
- This sets the directory that is used as the current working directory of the tests. By default, this will be in your temp dir. It's recommended that this is set to a directory outside of any Git repository. -
KEEPTRASH=1
- This will leave the local repository data in atmp
directory and the remote repository data intest/remote
.
Also ensure that your noproxy
environment variable contains 127.0.0.1
host,
to allow git commands to reach the local Git server lfstest-gitserver
.
Writing new tests
A new test file should be named t/t-*.sh
, where *
is the topic of Git LFS
being tested. It should look as follows:
#!/usr/bin/env bash
. "$(dirname "$0")/testlib.sh"
begin_test "my test"
(
set -e
# ...
)
end_test