Merge branch 'basic-worktree-support'

Author: Byron

.github/workflows/ci.yml

@@ -52,7 +52,7 @@ jobs:
           tool: nextest
           version: 0.9
       - name: "Test (nextest)"
-        run: cargo nextest run --all
+        run: cargo nextest run --all --no-fail-fast
       - name: "Install prerequisites"
         run: vcpkg install  zlib:x64-windows-static-md
         if: startsWith(matrix.os, 'windows')

Cargo.lock

@@ -130,6 +130,7 @@ members = [
     "git-validate",
     "git-ref",
     "git-config",
+    "git-discover",
     "git-features",
     "git-commitgraph",
     "git-chunk",

Cargo.toml

@@ -125,6 +125,7 @@ Crates that seem feature complete and need to see some more use before they can
   * [git-revision](https://github.com/Byron/gitoxide/blob/main/crate-status.md#git-revision)
   * [git-attributes](https://github.com/Byron/gitoxide/blob/main/crate-status.md#git-attributes)
   * [git-path](https://github.com/Byron/gitoxide/blob/main/crate-status.md#git-path)
+  * [git-discover](https://github.com/Byron/gitoxide/blob/main/crate-status.md#git-discover)
 * **idea**
   * [git-note](https://github.com/Byron/gitoxide/blob/main/crate-status.md#git-note)
   * [git-filter](https://github.com/Byron/gitoxide/blob/main/crate-status.md#git-filter)

README.md

@@ -237,6 +237,14 @@ Check out the [performance discussion][git-traverse-performance] as well.
 A mechanism to associate metadata with any object, and keep revisions of it using git itself.
 
 * [ ] CRUD for git notes
+* 
+### git-discover
+
+* [x] check if a git directory is a git repository
+* [x] find a git repository by searching upward
+* [x] handle linked worktrees
+* [ ] a way to handle `safe.directory`
+     - note that it's less critical to support it as `gitoxide` allows access but prevents untrusted configuration to become effective.
 
 ### git-date
 * [ ] parse git dates
@@ -256,6 +264,10 @@ Provide base-implementations for dealing with smudge and clean filters as well a
 
 Provides a trust model to share across gitoxide crates. It helps configuring how to interact with external processes, among other things.
 
+* **integrations**
+   * [x] git-config
+   * [x] git-repository
+
 ### git-rebase
 * [ ] obtain rebase status
 * [ ] drive a rebase operation
@@ -274,7 +286,7 @@ Make it the best-performing implementation and the most convenient one.
 * [x] a type for pattern matching of paths and non-paths, optionally case-insensitively.
 
 ### git-worktree
-* handle the working tree/checkout
+* handle the working **tree/checkout**
   - [x] checkout an index of files, executables and symlinks just as fast as git
      - [x] forbid symlinks in directories
      - [ ] handle submodules
@@ -290,8 +302,8 @@ Make it the best-performing implementation and the most convenient one.
      - [ ] `ident`
      - [ ] filter processes
      - [ ] single-invocation clean/smudge filters
-* manage multiple worktrees
-* deal with exclude specifications, like .gitignore and other exclude files.
+* [x] access to all .gitignore/exclude information 
+* [ ] access to all attributes information
 
 ### git-revision
 * find specifications for revisions (like `git name-rev`)
@@ -437,7 +449,10 @@ See its [README.md](https://github.com/Byron/gitoxide/blob/main/git-lock/README.
     * [ ] run transaction hooks and handle special repository states like quarantine
     * [ ] support for different backends like `files` and `reftable`
   * **worktrees**
-    * [ ] open a repository with worktrees
+    * [x] open a repository with worktrees and interact with them
+    * [ ] proper handling of worktree related refs
+    * [ ] create, move and remove
+    * [ ] read per-worktree config if `extensions.worktreeConfig` is enabled.
   * [ ] remotes with push and pull
   * [x] mailmap   
   * [x] object replacements (`git replace`)
@@ -475,6 +490,9 @@ See its [README.md](https://github.com/Byron/gitoxide/blob/main/git-lock/README.
     * [ ] special handling of `FETCH_HEAD` and `MERGE_HEAD`
     * [x] iterate refs with optional prefix
     * [ ] [worktree support]
+        * [ ] support multiple bases and classify refs to know which one to use
+        * [ ] special support for ref iteration to not accidentally (see iterator setup)
+        * [ ] potentially special support for iteration to support listing worktree refs for bisect/rewritten,… from the main worktree
     * ~~symbolic ref support, using symbolic links~~
         * This is a legacy feature which is not in use anymore.
     * **transactions** 

crate-status.md

@@ -21,6 +21,7 @@ echo "in root: gitoxide CLI"
 (enter git-pathspec && indent cargo diet -n --package-size-limit 5KB)
 (enter git-path && indent cargo diet -n --package-size-limit 10KB)
 (enter git-attributes && indent cargo diet -n --package-size-limit 10KB)
+(enter git-discover && indent cargo diet -n --package-size-limit 8KB)
 (enter git-index && indent cargo diet -n --package-size-limit 30KB)
 (enter git-worktree && indent cargo diet -n --package-size-limit 25KB)
 (enter git-quote && indent cargo diet -n --package-size-limit 5KB)

etc/check-package-size.sh

@@ -0,0 +1,3 @@
+version https://git-lfs.github.com/spec/v1
+oid sha256:6b424f371fffe6557669ecaccd3e944e23c1efcd5764b017b5d6709058f6210b
+size 10536

git-attributes/tests/fixtures/generated-archives/make_global_and_external_and_dir_ignores.tar.xz

@@ -1,3 +1,3 @@
 version https://git-lfs.github.com/spec/v1
-oid sha256:9b4140a06af5353cd0436b59b74fc724b546b176ce110ac73c9843fe45bba2f5
-size 17148
+oid sha256:f9ebb33f4370bf3b2a2c39957b586b3ee003b8f8539aa98fb89d4009f8f99cef
+size 17144

git-diff/tests/fixtures/generated-archives/make_diff_repo.tar.xz

@@ -0,0 +1,29 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## 0.0.0 (2022-05-06)
+
+The first release, an empty crate.
+
+### Commit Statistics
+
+<csr-read-only-do-not-edit/>
+
+ - 1 commit contributed to the release.
+ - 0 commits where understood as [conventional](https://www.conventionalcommits.org).
+ - 1 unique issue was worked on: [#301](https://github.com/Byron/gitoxide/issues/301)
+
+### Commit Details
+
+<csr-read-only-do-not-edit/>
+
+<details><summary>view details</summary>
+
+ * **[#301](https://github.com/Byron/gitoxide/issues/301)**
+    - Add empty git-discover crate ([`6565f16`](https://github.com/Byron/gitoxide/commit/6565f163ba464f5adf63d214143a4e12f48b00fc))
+</details>
+

git-discover/CHANGELOG.md

@@ -0,0 +1,27 @@
+[package]
+name = "git-discover"
+version = "0.1.0"
+repository = "https://github.com/Byron/gitoxide"
+license = "MIT/Apache-2.0"
+description = "Discover git repositories and check if a directory is a git repository"
+authors = ["Sebastian Thiel <[email protected]>"]
+edition = "2018"
+include = ["src/**/*", "CHANGELOG.md"]
+
+[lib]
+doctest = false
+
+# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
+
+[dependencies]
+git-sec = { version = "^0.1.0", path = "../git-sec", features = ["thiserror"] }
+git-path = { version = "^0.1.0", path = "../git-path" }
+git-ref = { version = "^0.12.1", path = "../git-ref" }
+git-hash = { version = "^0.9.3", path = "../git-hash" }
+
+bstr = { version = "0.2.13", default-features = false, features = ["std", "unicode"] }
+thiserror = "1.0.26"
+
+[dev-dependencies]
+git-testtools = { path = "../tests/tools" }
+is_ci = "1.1.1"

git-discover/Cargo.toml

@@ -0,0 +1,86 @@
+use std::borrow::Cow;
+use std::{ffi::OsStr, path::Path};
+
+/// Returns true if the given `git_dir` seems to be a bare repository.
+///
+/// Please note that repositories without an index generally _look_ bare, even though they might also be uninitialized.
+pub fn bare(git_dir_candidate: impl AsRef<Path>) -> bool {
+    let git_dir = git_dir_candidate.as_ref();
+    !(git_dir.join("index").exists() || (git_dir.file_name() == Some(OsStr::new(".git")) && git_dir.is_file()))
+}
+
+/// What constitutes a valid git repository, returning the guessed repository kind
+/// purely based on the presence of files. Note that the git-config ultimately decides what's bare.
+///
+/// Returns the Kind of git directory that was passed, possibly alongside the supporting private worktree git dir
+///
+/// Note that `.git` files are followed to a valid git directory, which then requires
+///
+/// * a valid head
+/// * an objects directory
+/// * a refs directory
+pub fn git(git_dir: impl AsRef<Path>) -> Result<crate::repository::Kind, crate::is_git::Error> {
+    let (dot_git, common_dir, git_dir_is_linked_worktree) = match crate::path::from_gitdir_file(git_dir.as_ref()) {
+        Ok(private_git_dir) => {
+            let common_dir = private_git_dir.join("commondir");
+            let common_dir = crate::path::from_plain_file(&common_dir)
+                .ok_or_else(|| crate::is_git::Error::MissingCommonDir {
+                    missing: common_dir.clone(),
+                })?
+                .map_err(|_| crate::is_git::Error::MissingCommonDir { missing: common_dir })?;
+            let common_dir = private_git_dir.join(common_dir);
+            (Cow::Owned(private_git_dir), Cow::Owned(common_dir), true)
+        }
+        // TODO: use ::IsDirectory as well when stabilized, but it's permission denied on windows
+        #[cfg(not(windows))]
+        Err(crate::path::from_gitdir_file::Error::Io(err)) if err.raw_os_error() == Some(21) => {
+            (Cow::Borrowed(git_dir.as_ref()), Cow::Borrowed(git_dir.as_ref()), false)
+        }
+        #[cfg(windows)]
+        Err(crate::path::from_gitdir_file::Error::Io(err)) if err.kind() == std::io::ErrorKind::PermissionDenied => {
+            (Cow::Borrowed(git_dir.as_ref()), Cow::Borrowed(git_dir.as_ref()), false)
+        }
+        Err(err) => return Err(err.into()),
+    };
+
+    {
+        // We expect to be able to parse any ref-hash, so we shouldn't have to know the repos hash here.
+        // With ref-table, the has is probably stored as part of the ref-db itself, so we can handle it from there.
+        // In other words, it's important not to fail on detached heads here because we guessed the hash kind wrongly.
+        let object_hash_should_not_matter_here = git_hash::Kind::Sha1;
+        let refs = git_ref::file::Store::at(
+            dot_git.as_ref(),
+            git_ref::store::WriteReflog::Normal,
+            object_hash_should_not_matter_here,
+        );
+        let head = refs.find_loose("HEAD")?;
+        if head.name.as_bstr() != "HEAD" {
+            return Err(crate::is_git::Error::MisplacedHead {
+                name: head.name.into_inner(),
+            });
+        }
+    }
+
+    {
+        let objects_path = common_dir.join("objects");
+        if !objects_path.is_dir() {
+            return Err(crate::is_git::Error::MissingObjectsDirectory { missing: objects_path });
+        }
+    }
+    {
+        let refs_path = common_dir.join("refs");
+        if !refs_path.is_dir() {
+            return Err(crate::is_git::Error::MissingRefsDirectory { missing: refs_path });
+        }
+    }
+
+    Ok(if git_dir_is_linked_worktree {
+        crate::repository::Kind::WorkTree {
+            linked_git_dir: Some(dot_git.into_owned()),
+        }
+    } else if bare(git_dir) {
+        crate::repository::Kind::Bare
+    } else {
+        crate::repository::Kind::WorkTree { linked_git_dir: None }
+    })
+}

git-discover/src/is.rs

@@ -0,0 +1,47 @@
+//! Find git repositories or search them upwards from a starting point, or determine if a directory looks like a git repository.
+//!
+//! Note that detection methods are educated guesses using the presence of files, without looking too much into the details.
+#![forbid(unsafe_code, rust_2018_idioms)]
+#![deny(missing_docs)]
+
+///
+pub mod repository;
+
+///
+pub mod is_git {
+    use std::path::PathBuf;
+
+    /// The error returned by [`crate::is_git()`].
+    #[derive(Debug, thiserror::Error)]
+    #[allow(missing_docs)]
+    pub enum Error {
+        #[error("Could not find a valid HEAD reference")]
+        FindHeadRef(#[from] git_ref::file::find::existing::Error),
+        #[error("Expected HEAD at '.git/HEAD', got '.git/{}'", .name)]
+        MisplacedHead { name: bstr::BString },
+        #[error("Expected an objects directory at '{}'", .missing.display())]
+        MissingObjectsDirectory { missing: PathBuf },
+        #[error("The worktree's private repo is missing its commondir file at '{}' or it could not be read", .missing.display())]
+        MissingCommonDir { missing: PathBuf },
+        #[error("Expected a refs directory at '{}'", .missing.display())]
+        MissingRefsDirectory { missing: PathBuf },
+        #[error(transparent)]
+        GitFile(#[from] crate::path::from_gitdir_file::Error),
+    }
+
+    /// Options for [`crate::is_git()`].
+    pub struct Options {}
+}
+
+mod is;
+pub use is::{bare as is_bare, git as is_git};
+
+///
+pub mod upwards;
+pub use upwards::function::{discover as upwards, discover_opts as upwards_opts};
+
+///
+pub mod path;
+
+///
+pub mod parse;

git-discover/src/lib.rs

@@ -0,0 +1,32 @@
+use bstr::ByteSlice;
+use std::path::PathBuf;
+
+///
+pub mod gitdir {
+    use bstr::BString;
+
+    /// The error returned by [`parse::gitdir()`][super::gitdir()].
+    #[derive(Debug, thiserror::Error)]
+    #[allow(missing_docs)]
+    pub enum Error {
+        #[error("Format should be 'gitdir: <path>', but got: {:?}", .input)]
+        InvalidFormat { input: BString },
+        #[error("Couldn't decode {:?} as UTF8", .input)]
+        IllformedUtf8 { input: BString },
+    }
+}
+
+/// Parse typical `git_dir` files as seen in worktrees and submodules.
+pub fn gitdir(input: &[u8]) -> Result<PathBuf, gitdir::Error> {
+    let path = input
+        .strip_prefix(b"gitdir: ")
+        .ok_or_else(|| gitdir::Error::InvalidFormat { input: input.into() })?
+        .as_bstr();
+    let path = path.trim_end().as_bstr();
+    if path.is_empty() {
+        return Err(gitdir::Error::InvalidFormat { input: input.into() });
+    }
+    Ok(git_path::try_from_bstr(path)
+        .map_err(|_| gitdir::Error::IllformedUtf8 { input: input.into() })?
+        .into_owned())
+}