Add debugging utilities

Author: Caleb-T-Owens

Cargo.lock

@@ -66,6 +66,7 @@ gitbutler-forge = { path = "crates/gitbutler-forge" }
 gitbutler-hunk-dependency = { path = "crates/gitbutler-hunk-dependency" }
 gitbutler-settings = { path = "crates/gitbutler-settings" }
 gitbutler-workspace = { path = "crates/gitbutler-workspace" }
+but-debugging = { path = "crates/but-debugging" }
 but-core = { path = "crates/but-core" }
 but-workspace = { path = "crates/but-workspace" }
 

Cargo.toml

@@ -0,0 +1,13 @@
+[package]
+name = "but-debugging"
+version = "0.0.0"
+edition = "2021"
+authors = ["GitButler <[email protected]>"]
+publish = false
+
+[lib]
+doctest = false
+
+[dependencies]
+
+[dev-dependencies]

crates/but-debugging/Cargo.toml

@@ -0,0 +1,131 @@
+/// But Debugging contains utilities that aid in debugging gitbutler.
+/// Utilities defined inside of but-debugging should not be relied upon in
+/// tests or used in production code.
+use std::{path::Path, process::Command};
+
+/// Options passed to `git log`
+pub struct LogOptions {
+    /// Controls whether the `--oneline` flag is passed.
+    /// default: true
+    pub oneline: bool,
+    /// Controls whether the `--graph` flag is passed.
+    /// default: true
+    pub graph: bool,
+    /// Controls whether the `--all` flag is passed.
+    /// default: false
+    pub all: bool,
+    /// The reference that should be logged
+    /// default: "HEAD"
+    pub reference: String,
+}
+
+impl Default for LogOptions {
+    fn default() -> Self {
+        Self {
+            oneline: true,
+            graph: true,
+            all: false,
+            reference: "HEAD".to_string(),
+        }
+    }
+}
+
+impl LogOptions {
+    pub fn oneline(&mut self, oneline: bool) -> &mut Self {
+        self.oneline = oneline;
+        self
+    }
+
+    pub fn graph(&mut self, graph: bool) -> &mut Self {
+        self.graph = graph;
+        self
+    }
+
+    pub fn reference(&mut self, reference: String) -> &mut Self {
+        self.reference = reference;
+        self
+    }
+
+    pub fn all(&mut self, all: bool) -> &mut Self {
+        self.all = all;
+        self
+    }
+}
+
+/// Runs `git log` and passes the output to println!
+#[deprecated = "git_log should not be used in production code or testing infastructure"]
+pub fn git_log(path: &Path, options: &LogOptions) {
+    let path = if path.ends_with(".git") {
+        path.parent().unwrap()
+    } else {
+        path
+    };
+    let mut command = Command::new("git");
+    command.current_dir(path);
+    command.arg("log");
+    if options.oneline {
+        command.arg("--oneline");
+    }
+    if options.graph {
+        command.arg("--graph");
+    }
+    if options.all {
+        command.arg("--all");
+    }
+    command.arg("--decorate=short");
+    command.arg(options.reference.clone());
+    let result = command.output().unwrap().stdout;
+    println!("{:?}", command);
+    println!("{}", std::str::from_utf8(&result).unwrap());
+}
+
+/// Options passed to `git ls-tree`
+pub struct LsTreeOptions {
+    /// Controls whether the `-r` flag should be passed.
+    /// default: true
+    pub recursive: bool,
+    /// The reference that should be peeled to a tree
+    /// default: "HEAD"
+    pub reference: String,
+}
+
+impl Default for LsTreeOptions {
+    fn default() -> Self {
+        Self {
+            recursive: true,
+            reference: "HEAD".to_string(),
+        }
+    }
+}
+
+impl LsTreeOptions {
+    pub fn recursive(&mut self, recursive: bool) -> &mut Self {
+        self.recursive = recursive;
+        self
+    }
+
+    pub fn reference(&mut self, reference: String) -> &mut Self {
+        self.reference = reference;
+        self
+    }
+}
+
+/// Runs `git ls-tree` and passes the output to println!
+#[deprecated = "git_ls_tree should not be used in production code or testing infastructure"]
+pub fn git_ls_tree(path: &Path, options: &LsTreeOptions) {
+    let path = if path.ends_with(".git") {
+        path.parent().unwrap()
+    } else {
+        path
+    };
+    let mut command = Command::new("git");
+    command.current_dir(path);
+    command.arg("ls-tree");
+    if options.recursive {
+        command.arg("-r");
+    }
+    command.arg(options.reference.clone());
+    let result = command.output().unwrap().stdout;
+    println!("{:?}", command);
+    println!("{}", std::str::from_utf8(&result).unwrap());
+}

crates/but-debugging/src/lib.rs

@@ -0,0 +1 @@
+

crates/but-debugging/tests/core/main.rs

@@ -49,6 +49,7 @@ urlencoding = "2.1.3"
 reqwest = { version = "0.12.9", features = ["json"] }
 toml.workspace = true
 uuid.workspace = true
+but-debugging.workspace = true
 
 [dev-dependencies]
 once_cell = "1.20"