Struct branchless::testing::Git

pub struct Git {
    pub repo_path: PathBuf,
    pub path_to_git: PathBuf,
}

Wrapper around the Git executable, for testing.

Fields

repo_path: PathBuf

The path to the repository on disk. The directory itself must exist, although it might not have a .git folder in it. (Use Git::init_repo to initialize it.)

path_to_git: PathBuf

The path to the Git executable on disk. This is important since we test against multiple Git versions.

Implementations

impl Git

pub fn new(repo_path: PathBuf, git_run_info: GitRunInfo) -> Self

Constructor.

pub fn preprocess_output(&self, stdout: String) -> Result<String>

Replace dynamic strings in the output, for testing purposes.

pub fn get_path_for_env(&self) -> OsString

Get the PATH environment variable to use for testing.

pub fn get_base_env(&self, time: isize) -> Vec<(OsString, OsString)>

Get the environment variables needed to run git in the test environment.

pub fn run_with_options<S: AsRef<str> + Debug>(
    &self,
    args: &[S],
    options: &GitRunOptions
) -> Result<(String, String)>

Run a Git command.

pub fn run<S: AsRef<str> + Debug>(&self, args: &[S]) -> Result<(String, String)>

Run a Git command.

pub fn init_repo_with_options(&self, options: &GitInitOptions) -> Result<()>

Set up a Git repo in the directory and initialize git-branchless to work with it.

pub fn init_repo(&self) -> Result<()>

Set up a Git repo in the directory and initialize git-branchless to work with it.

pub fn clone_repo_into(
    &self,
    target: &Git,
    additional_args: &[&str]
) -> Result<()>

Clone this repository into the target repository (which must not have been initialized).

pub fn write_file(&self, name: &str, contents: &str) -> Result<()>

Write the provided contents to the provided file in the repository root.

pub fn delete_file(&self, name: &str) -> Result<()>

Delete the provided file in the repository root.

pub fn set_file_permissions(
    &self,
    name: &str,
    permissions: Permissions
) -> Result<()>

Delete the provided file in the repository root.

pub fn commit_file_with_contents(
    &self,
    name: &str,
    time: isize,
    contents: &str
) -> Result<NonZeroOid>

Commit a file with default contents. The time argument is used to set the commit timestamp, which is factored into the commit hash.

pub fn commit_file(&self, name: &str, time: isize) -> Result<NonZeroOid>

Commit a file with default contents. The time argument is used to set the commit timestamp, which is factored into the commit hash.

pub fn detach_head(&self) -> Result<()>

Detach HEAD. This is useful to call to make sure that no branch is checked out, and therefore that future commit operations don’t move any branches.

pub fn get_repo(&self) -> Result<Repo>

Get a Repo object for this repository.

pub fn get_version(&self) -> Result<GitVersion>

Get the version of the Git executable.

pub fn supports_reference_transactions(&self) -> Result<bool>

Determine if the Git executable supports the reference-transaction hook.

pub fn supports_committer_date_is_author_date(&self) -> Result<bool>

Determine if the --committer-date-is-author-date option to git rebase -i is respected.

This affects whether we can rely on the timestamps being preserved during a rebase when branchless.restack.preserveTimestamps is set.

pub fn supports_log_exclude_decoration(&self) -> Result<bool>

The log.excludeDecoration configuration option was introduced in Git v2.27.

pub fn resolve_file(&self, name: &str, contents: &str) -> Result<()>

Resolve a file during a merge or rebase conflict with the provided contents.

Trait Implementations

impl Clone for Git

fn clone(&self) -> Git

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Git

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.