pub struct GitWrapper { /* private fields */ }
Expand description
Wrapper around a Git
instance which cleans up the repository once dropped.
Implementations§
Source§impl GitWrapper
impl GitWrapper
Sourcepub fn duplicate_repo(&self) -> Result<Self>
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>§
Sourcepub fn preprocess_output(&self, stdout: String) -> Result<String>
pub fn preprocess_output(&self, stdout: String) -> Result<String>
Replace dynamic strings in the output, for testing purposes.
Sourcepub fn get_path_for_env(&self) -> OsString
pub fn get_path_for_env(&self) -> OsString
Get the PATH
environment variable to use for testing.
Sourcepub fn get_base_env(&self, time: isize) -> Vec<(OsString, OsString)>
pub fn get_base_env(&self, time: isize) -> Vec<(OsString, OsString)>
Get the environment variables needed to run git in the test environment.
Sourcepub fn run_with_options<S: AsRef<str> + Debug>(
&self,
args: &[S],
options: &GitRunOptions,
) -> Result<(String, String)>
pub fn run_with_options<S: AsRef<str> + Debug>( &self, args: &[S], options: &GitRunOptions, ) -> Result<(String, String)>
Run a Git command.
Sourcepub fn run<S: AsRef<str> + Debug>(&self, args: &[S]) -> Result<(String, String)>
pub fn run<S: AsRef<str> + Debug>(&self, args: &[S]) -> Result<(String, String)>
Run a Git command.
Sourcepub fn branchless(
&self,
subcommand: &str,
args: &[&str],
) -> Result<(String, String)>
pub fn branchless( &self, subcommand: &str, args: &[&str], ) -> Result<(String, String)>
Convenience method to call branchless_with_options
with the default
options.
Sourcepub fn branchless_with_options(
&self,
subcommand: &str,
args: &[&str],
options: &GitRunOptions,
) -> Result<(String, String)>
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
.
Sourcepub fn init_repo_with_options(&self, options: &GitInitOptions) -> Result<()>
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.
Sourcepub fn init_repo(&self) -> Result<()>
pub fn init_repo(&self) -> Result<()>
Set up a Git repo in the directory and initialize git-branchless to work with it.
Sourcepub fn clone_repo_into(
&self,
target: &Git,
additional_args: &[&str],
) -> Result<()>
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).
Sourcepub fn write_file_txt(&self, name: &str, contents: &str) -> Result<()>
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).
Sourcepub fn write_file(&self, name: &str, contents: &str) -> Result<()>
pub fn write_file(&self, name: &str, contents: &str) -> Result<()>
Write the provided contents to the provided file in the repository root.
Sourcepub fn delete_file(&self, name: &str) -> Result<()>
pub fn delete_file(&self, name: &str) -> Result<()>
Delete the provided file in the repository root.
Sourcepub fn set_file_permissions(
&self,
name: &str,
permissions: Permissions,
) -> Result<()>
pub fn set_file_permissions( &self, name: &str, permissions: Permissions, ) -> Result<()>
Delete the provided file in the repository root.
Sourcepub fn get_trimmed_diff(&self, file: &str, commit: &str) -> Result<String>
pub fn get_trimmed_diff(&self, file: &str, commit: &str) -> Result<String>
Get a diff of a commit with the a/b file header removed. Only works for commits with a single file.
Sourcepub fn commit_file_with_contents_and_message(
&self,
name: &str,
time: isize,
contents: &str,
message_prefix: &str,
) -> Result<NonZeroOid>
pub fn commit_file_with_contents_and_message( &self, name: &str, time: isize, contents: &str, message_prefix: &str, ) -> Result<NonZeroOid>
Commit a file with given contents and message. The time
argument is
used to set the commit timestamp, which is factored into the commit
hash. The filename is always appended to the message prefix.
Sourcepub fn commit_file_with_contents(
&self,
name: &str,
time: isize,
contents: &str,
) -> Result<NonZeroOid>
pub fn commit_file_with_contents( &self, name: &str, time: isize, contents: &str, ) -> Result<NonZeroOid>
Commit a file with given contents and a default message. The time
argument is used to set the commit timestamp, which is factored into the
commit hash.
Sourcepub fn commit_file(&self, name: &str, time: isize) -> Result<NonZeroOid>
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.
Sourcepub fn detach_head(&self) -> Result<()>
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.
Sourcepub fn get_version(&self) -> Result<GitVersion>
pub fn get_version(&self) -> Result<GitVersion>
Get the version of the Git executable.
Sourcepub fn get_git_run_info(&self) -> GitRunInfo
pub fn get_git_run_info(&self) -> GitRunInfo
Get the GitRunInfo
to use for this repository.
Sourcepub fn supports_reference_transactions(&self) -> Result<bool>
pub fn supports_reference_transactions(&self) -> Result<bool>
Determine if the Git executable supports the reference-transaction
hook.
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.
Sourcepub fn supports_log_exclude_decoration(&self) -> Result<bool>
pub fn supports_log_exclude_decoration(&self) -> Result<bool>
The log.excludeDecoration
configuration option was introduced in Git
v2.27.
Sourcepub fn produces_auto_merge_refs(&self) -> Result<bool>
pub fn produces_auto_merge_refs(&self) -> Result<bool>
Git v2.44 produces AUTO_MERGE
refs as part of some operations, which
changes the event log according to the reference-transaction
hook.
Sourcepub fn resolve_file(&self, name: &str, contents: &str) -> Result<()>
pub fn resolve_file(&self, name: &str, contents: &str) -> Result<()>
Resolve a file during a merge or rebase conflict with the provided contents.
Sourcepub fn clear_event_log(&self) -> Result<()>
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§
Auto Trait Implementations§
impl Freeze for GitWrapper
impl RefUnwindSafe for GitWrapper
impl Send for GitWrapper
impl Sync for GitWrapper
impl Unpin for GitWrapper
impl UnwindSafe for GitWrapper
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait>
(where Trait: Downcast
) to Box<dyn Any>
. Box<dyn Any>
can
then be further downcast
into Box<ConcreteType>
where ConcreteType
implements Trait
.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait>
(where Trait: Downcast
) to Rc<Any>
. Rc<Any>
can then be
further downcast
into Rc<ConcreteType>
where ConcreteType
implements Trait
.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &Any
’s vtable from &Trait
’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait
(where Trait: Downcast
) to &Any
. This is needed since Rust cannot
generate &mut Any
’s vtable from &mut Trait
’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<D> OwoColorize for D
impl<D> OwoColorize for D
Source§fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>where
C: Color,
Source§fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>where
C: Color,
Source§fn black(&self) -> FgColorDisplay<'_, Black, Self>
fn black(&self) -> FgColorDisplay<'_, Black, Self>
Source§fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
fn on_black(&self) -> BgColorDisplay<'_, Black, Self>
Source§fn red(&self) -> FgColorDisplay<'_, Red, Self>
fn red(&self) -> FgColorDisplay<'_, Red, Self>
Source§fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
fn on_red(&self) -> BgColorDisplay<'_, Red, Self>
Source§fn green(&self) -> FgColorDisplay<'_, Green, Self>
fn green(&self) -> FgColorDisplay<'_, Green, Self>
Source§fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
fn on_green(&self) -> BgColorDisplay<'_, Green, Self>
Source§fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>
Source§fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>
Source§fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
fn blue(&self) -> FgColorDisplay<'_, Blue, Self>
Source§fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>
Source§fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>
Source§fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>
Source§fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>
Source§fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>
Source§fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>
Source§fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>
Source§fn white(&self) -> FgColorDisplay<'_, White, Self>
fn white(&self) -> FgColorDisplay<'_, White, Self>
Source§fn on_white(&self) -> BgColorDisplay<'_, White, Self>
fn on_white(&self) -> BgColorDisplay<'_, White, Self>
Source§fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
fn default_color(&self) -> FgColorDisplay<'_, Default, Self>
Source§fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>
Source§fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>
Source§fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>
Source§fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>
Source§fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>
Source§fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>
Source§fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>
Source§fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>
Source§fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>
Source§fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>
Source§fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>
Source§fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Source§fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Source§fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>
Source§fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>
Source§fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>
Source§fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>
Source§fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>
Source§fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>
Source§fn bold(&self) -> BoldDisplay<'_, Self>
fn bold(&self) -> BoldDisplay<'_, Self>
Source§fn dimmed(&self) -> DimDisplay<'_, Self>
fn dimmed(&self) -> DimDisplay<'_, Self>
Source§fn italic(&self) -> ItalicDisplay<'_, Self>
fn italic(&self) -> ItalicDisplay<'_, Self>
Source§fn underline(&self) -> UnderlineDisplay<'_, Self>
fn underline(&self) -> UnderlineDisplay<'_, Self>
Source§fn blink(&self) -> BlinkDisplay<'_, Self>
fn blink(&self) -> BlinkDisplay<'_, Self>
Source§fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>
Source§fn reversed(&self) -> ReversedDisplay<'_, Self>
fn reversed(&self) -> ReversedDisplay<'_, Self>
Source§fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>
Source§fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::fg
or
a color-specific method, such as OwoColorize::green
, Read moreSource§fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>where
Color: DynColor,
OwoColorize::bg
or
a color-specific method, such as OwoColorize::on_yellow
, Read more