Struct branchless::testing::GitWrapper

pub struct GitWrapper { /* private fields */ }

Wrapper around a Git instance which cleans up the repository once dropped.

Implementations

impl GitWrapper

pub fn duplicate_repo(&self) -> Result<Self>

Make a copy of the repo on disk. This can be used to reuse testing setup. This is not the same as running git clone; it’s used to save initialization time as part of testing optimization.

The copied repo will be deleted once the returned value has been dropped.

Methods from Deref<Target = Git>

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 smartlog(&self) -> Result<String>

Render the smartlog for the repository.

pub fn branchless( &self, subcommand: &str, args: &[&str] ) -> Result<(String, String)>

Convenience method to call branchless_with_options with the default options.

pub fn branchless_with_options( &self, subcommand: &str, args: &[&str], options: &GitRunOptions ) -> Result<(String, String)>

Locate the git-branchless binary and run a git-branchless subcommand with the provided GitRunOptions. These subcommands are located using should_use_separate_command_binary.

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_txt(&self, name: &str, contents: &str) -> Result<()>

Write the provided contents to the provided file in the repository root. For historical reasons, the name is suffixed with .txt (this is technical debt).

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 get_git_run_info(&self) -> GitRunInfo

Get the GitRunInfo to use for this repository.

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.

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

Clear the event log on disk. Currently-existing commits will not have been observed by the new event log (once it’s created by another command).

Trait Implementations

impl Deref for GitWrapper

type Target = Git

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.