Support the notion of a home directory separately from global configuration directory #6455
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
ethomson
force-pushed
the
ethomson/sysdir
branch
3 times, most recently
from
0c68d75
to
81e1fbb
Compare
ethomson
force-pushed
the
ethomson/sysdir
branch
3 times, most recently
from
4e11cc5
to
67a5870
Compare
The windows sysdir functions are libgit2-specific and for git compatibility only; remove them from the shared util directory and bring them into the libgit2 source tree.
Provide a mechanism to look up the user's home directory, using the same mechanism that we use for locating the global configuration path (a fancy name for saying "the home directory"). SSH known hosts lookups now use this, instead of simply looking at the HOME environment variable, to support Windows-style home directory lookups in `HOME`, `HOMEPATH`, or `USERPROFILE`.
Use `git_sysdir_find_homedir_file` to identify the path to the home directory's `.ssh/known_hosts`; this takes Windows paths into account by preferring `HOME`, then falling back to `HOMEPATH` and `USERPROFILE` directories.
I spent an hour banging my head against this, when it was because the remote didn't trust my key.
Users can specify an attribute file to be included in the home directory using `~/filename` syntax. Instead of looking in the global configuration location (which may be overridden), use the user's _actual_ home directory. This allows callers to change the global configuration location separately from the home directory.
Users can specify a config file to be included in the home directory using `~/filename` syntax. Instead of looking in the global configuration location (which may be overridden), use the user's _actual_ home directory. This allows callers to change the global configuration location separately from the home directory.
Some callers -- like our test suite and the test suites of our language bindings -- want to isolate the home directory to avoid accidentally including the executing user's actual home directory data. Previously, we combined the notion of a home directory and global configuration -- now that this is separated, we provide users the ability to configure both.
Now that we've split the notion of the home directory from the global configuration store, our tests should use the appropriate one based on what they're doing.
Use a dummy home directory for tests to avoid user data leaking into test execution.
libgit2 can now isolate its home directory, and our test runner (by default) isolates the home directory. In our CI environment, we want to set up some pieces (like ssh configuration) in a fake homedir. Continue to do so and propagate that to clar.
Teach the clone tests how to clone from github.com, when given a keypair with a passphrase and known_hosts data. This allows us to better exercise our known_hosts checking and ensure that the lifecycle of the certificate callback matches our expectations.
We provide `BUILD_PATH` to our build script; provide it and mutate `PATH` when running our tests as well.
We provide `BUILD_PATH` to our build script; provide it and mutate `PATH` when running our tests as well. We were previously using `cygpath` to try to convert a _list_ of Windows paths into cygwin / Unix style `PATH` format. This does not work -- it treats the path list as a single path (with semicolons -- understandably as those are allowed characters in a Windows path). For example, `C:\One;C:\Two;C:\Three` is converted to `/c/one;c:/two;c:/three`. Add a new function to convert path lists, so that paths are split by semicolon and fed to `cygpath` independently, then re-joined with a colon. This means that our example `C:\One;C:\Two;C:\Three` is correctly converted to `/c/one:/c/two:/c/three`.
ethomson
force-pushed
the
ethomson/sysdir
branch
from
67a5870
to
afe01d4
Compare
ethomson
force-pushed
the
ethomson/sysdir
branch
from
afe01d4
to
e0220e6
Compare
|
I backported this into v1.4 and v1.5. 😅 |
netbsd-srcmastr
pushed a commit
to NetBSD/pkgsrc
that referenced
this pull request
Feb 25, 2023
v1.6 ---- This is release v1.6.0, "Hubbeliges Krokodil". This release adds experimental SHA256 support and includes many new features and bugfixes. ## What's Changed ### New features * **Support for bare repositories with SHA256 support (experimental)** by @ethomson in libgit2/libgit2#6191 You can configure experimental SHA256 support in libgit2 with `cmake -DEXPERIMENTAL_SHA256=ON` during project setup. This is useful for considering future integrations, work on clients, and work on language bindings. At present, working with bare repositories should largely work, including remote operations. But many pieces of functionality - including working with the index - are not yet supported. As a result, **libgit2 with SHA256 support should not be used in production or released with package distribution.** * **Support the notion of a home directory separately from global configuration directory** by @ethomson in libgit2/libgit2#6455 and libgit2/libgit2#6456 Callers and language bindings can now configure the home directory that libgit2 uses for file lookups (eg, the `.ssh` directory). This configuration is separate from the git global configuration path. * **stash: partial stash specific files** by @gitkraken-jacobw in libgit2/libgit2#6330 A stash can be created with only specific files, using a pathspec. This is similar to the `git stash push` command. * **push: revparse refspec source, so you can push things that are not refs** by @sven-of-cord in libgit2/libgit2#6362 Pushes can be performed using refspecs instead of only references. * **Support OpenSSL3** by @ethomson in libgit2/libgit2#6464 and libgit2/libgit2#6471 OpenSSL 3 is now supported, both when compiled directly and dynamically loaded. ### Bug fixes * winhttp: support long custom headers by @kcsaul in libgit2/libgit2#6363 * Fix memory leak by @csware in libgit2/libgit2#6382 * Don't fail the whole clone if you can't find a default branch by @torvalds in libgit2/libgit2#6369 * #6366: When a worktree is missing, return `GIT_ENOTFOUND`. by @arroz in libgit2/libgit2#6395 * commit-graph: only verify csum on `git_commit_graph_open()`. by @derrickstolee in libgit2/libgit2#6420 * Ignore missing 'safe.directory' config during ownership checks by @kcsaul in libgit2/libgit2#6408 * Fix leak in `git_tag_create_from_buffer` by @julianmesa-gitkraken in libgit2/libgit2#6421 * http: Update httpclient options when reusing an existing connection. by @slackner in libgit2/libgit2#6416 * Add support for `safe.directory *` by @csware in libgit2/libgit2#6429 * URL parsing for google-compatible URLs by @ethomson in libgit2/libgit2#6326 * Fixes #6433: `git_submodule_update` fails to update configured but missing submodule by @tagesuhu in libgit2/libgit2#6434 * transport: fix capabilities calculation by @russell in libgit2/libgit2#6435 * push: use resolved oid as the source by @ethomson in libgit2/libgit2#6452 * Use `git_clone__submodule` to avoid file checks in workdir by @abizjak in libgit2/libgit2#6444 * #6422: handle dangling symbolic refs gracefully by @arroz in libgit2/libgit2#6423 * `diff_file`: Fix crash when freeing a patch representing an empty untracked file by @jorio in libgit2/libgit2#6475 * clone: clean up options on failure by @ethomson in libgit2/libgit2#6479 * stash: update strarray usage by @ethomson in libgit2/libgit2#6487 * #6491: Sets `oid_type` on repos open with `git_repository_open_bare` by @arroz in libgit2/libgit2#6492 * Handle Win32 shares by @ethomson in libgit2/libgit2#6493 * Make failure to connect to ssh-agent non-fatal by @fxcoudert in libgit2/libgit2#6497 * odb: don't unconditionally add `oid_type` to stream by @ethomson in libgit2/libgit2#6499 * Pass hostkey & port to host verify callback by @fxcoudert in libgit2/libgit2#6503 ### Security fixes ### Code cleanups * meta: update version number to v1.6.0-alpha by @ethomson in libgit2/libgit2#6352 * sha256: indirection for experimental functions by @ethomson in libgit2/libgit2#6354 * Delete `create.c.bak` by @lrm29 in libgit2/libgit2#6398 * Support non-cmake builds with an in-tree `experimental.h` by @ethomson in libgit2/libgit2#6405 ### Build and CI improvements * tests: skip flaky-ass googlesource tests by @ethomson in libgit2/libgit2#6353 * clar: remove ftrunacte from libgit2 tests by @boretrk in libgit2/libgit2#6357 * CI Improvements by @ethomson in libgit2/libgit2#6403 * fix compile on Windows with `-DWIN32_LEAN_AND_MEAN` by @christoph-cullmann in libgit2/libgit2#6373 * Fixes #6365 : Uppercase windows.h include fails build in case-sensitive OS by @Vinz2008 in libgit2/libgit2#6377 * ci: update version numbers of actions by @ethomson in libgit2/libgit2#6448 * thread: avoid warnings when building without threads by @ethomson in libgit2/libgit2#6432 * src: hide unused hmac() prototype by @0-wiz-0 in libgit2/libgit2#6458 * tests: update clar test runner by @ethomson in libgit2/libgit2#6459 * ci: always create test summaries, even on failure by @ethomson in libgit2/libgit2#6460 * Fix build failure with `-DEMBED_SSH_PATH` by @vicr123 in libgit2/libgit2#6374 * Define correct `off64_t` for AIX by @bzEq in libgit2/libgit2#6376 * Fix some warnings in main by @ethomson in libgit2/libgit2#6480 * strarray: remove deprecated declaration by @ethomson in libgit2/libgit2#6486 * tests: always unset `HTTP_PROXY` before starting tests by @ethomson in libgit2/libgit2#6498 ### Documentation improvements * add 2-clause BSD license to COPYING by @martinvonz in libgit2/libgit2#6413 * Add new PHP bindings project to language bindings section of README.md by @RogerGee in libgit2/libgit2#6473 * README: clarify the linking exception by @ethomson in libgit2/libgit2#6494 * Correct the definition of "empty" in the docs for `git_repository_is_empty` by @timrogers in libgit2/libgit2#6500
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Today, we muddle the notion of the global git configuration (which lives in the home directory) and the home directory. This means that -- for example -- when our configuration parsing code tries to include something that is tilde-prefixed, for example
~/.git/other_config, then we look up the global configuration path to resolve this.We also have some code that tries to look up the home directory by looking at the
HOMEenvironment variable because the global configuration would be the wrong place to look for this, and may be reset by our tests, the binding's tests, or the application itself.This PR breaks the notion of the home directory from the global configuration path. At the moment, they both have the same default lookup mechanisms, but can be configured separately. This allows test frameworks to configure them independently. This is especially useful for things like ssh configuration, which we may want to set up at the beginning of a CI run (based on the ssh server information) and then use within the test execution.
Since this brings the existing Windows home directory lookup logic (which was used for the global configuration path) to the home directory logic. As a result, this fixes #6453.
I tried to structure this in a way that we can cherry-pick only the bits related directly to #6453 to the v1.4 and v1.5 maintenance branches, so that (either) they will simply use the global config path for ssh keys or use a home dir that is not runtime-configurable. (I can see arguments for doing either, but I haven't yet formed a strong opinion. I would like to ensure this actually resolves #6453 before dealing with the backporting.)