Test json output & update serializers

Caleb-T-Owens · Caleb-T-Owens · commit 6bc1391f8a22 · 2025-11-10T14:12:45.000+01:00
diff --git a/crates/but-worktrees/Cargo.toml b/crates/but-worktrees/Cargo.toml
@@ -23,6 +23,7 @@ gitbutler-stack.workspace = true
 gitbutler-oxidize.workspace = true
 gitbutler-workspace.workspace = true
 gitbutler-branch-actions.workspace = true
+gitbutler-serde.workspace = true
 serde.workspace = true
 uuid.workspace = true
 bstr.workspace = true
diff --git a/crates/but-worktrees/src/lib.rs b/crates/but-worktrees/src/lib.rs
@@ -15,7 +15,7 @@ pub mod new;
 
 /// A worktree name.
 #[derive(Debug, Clone, PartialEq, Eq, Hash, Serialize, Deserialize)]
-pub struct WorktreeId(BString);
+pub struct WorktreeId(#[serde(with = "gitbutler_serde::bstring_lossy")] BString);
 
 impl WorktreeId {
     /// Create a new worktree ID using a random UUID.
@@ -79,7 +79,9 @@ pub struct Worktree {
     /// The canonicalized filesystem path to the worktree.
     pub path: PathBuf,
     /// The git reference this worktree was created from.
+    #[serde(with = "gitbutler_serde::fullname_opt")]
     pub created_from_ref: Option<gix::refs::FullName>,
     /// The base which we will use in a cherry-pick.
+    #[serde(with = "gitbutler_serde::object_id_opt")]
     pub base: Option<gix::ObjectId>,
 }
diff --git a/crates/but/tests/but/snapshots/worktree/worktree_list_after_creation.stdout.json b/crates/but/tests/but/snapshots/worktree/worktree_list_after_creation.stdout.json
@@ -0,0 +1,10 @@
+{
+  "entries": [
+    {
+      "id": "list-test",
+      "path": "[TEMP_PATH]/.git/gitbutler/worktrees/list-test",
+      "createdFromRef": "refs/heads/A",
+      "base": "9477ae721ab521d9d0174f70e804ce3ff9f6fb56"
+    }
+  ]
+}
diff --git a/crates/but/tests/but/snapshots/worktree/worktree_new_deduplication_first.stdout.json b/crates/but/tests/but/snapshots/worktree/worktree_new_deduplication_first.stdout.json
@@ -0,0 +1,10 @@
+{
+  "created": {
+    "id": "test",
+    "path": "[TEMP_PATH]/.git/gitbutler/worktrees/test",
+    "createdFromRef": "refs/heads/A",
+    "base": "9477ae721ab521d9d0174f70e804ce3ff9f6fb56"
+  },
+  "branchName": "gitbutler/worktree/test",
+  "baseCommitMessage": "add A/n"
+}
diff --git a/crates/but/tests/but/snapshots/worktree/worktree_new_deduplication_second.stdout.json b/crates/but/tests/but/snapshots/worktree/worktree_new_deduplication_second.stdout.json
@@ -0,0 +1,10 @@
+{
+  "created": {
+    "id": "test-a",
+    "path": "[TEMP_PATH]/.git/gitbutler/worktrees/test-a",
+    "createdFromRef": "refs/heads/A",
+    "base": "9477ae721ab521d9d0174f70e804ce3ff9f6fb56"
+  },
+  "branchName": "gitbutler/worktree/test-a",
+  "baseCommitMessage": "add A/n"
+}
diff --git a/crates/but/tests/but/snapshots/worktree/worktree_new_deduplication_third.stdout.json b/crates/but/tests/but/snapshots/worktree/worktree_new_deduplication_third.stdout.json
@@ -0,0 +1,10 @@
+{
+  "created": {
+    "id": "test-b",
+    "path": "[TEMP_PATH]/.git/gitbutler/worktrees/test-b",
+    "createdFromRef": "refs/heads/A",
+    "base": "9477ae721ab521d9d0174f70e804ce3ff9f6fb56"
+  },
+  "branchName": "gitbutler/worktree/test-b",
+  "baseCommitMessage": "add A/n"
+}
diff --git a/crates/but/tests/but/snapshots/worktree/worktree_new_default_deduplication.stdout.json b/crates/but/tests/but/snapshots/worktree/worktree_new_default_deduplication.stdout.json
@@ -0,0 +1,10 @@
+{
+  "created": {
+    "id": "A-a",
+    "path": "[TEMP_PATH]/.git/gitbutler/worktrees/A-a",
+    "createdFromRef": "refs/heads/A",
+    "base": "9477ae721ab521d9d0174f70e804ce3ff9f6fb56"
+  },
+  "branchName": "gitbutler/worktree/A-a",
+  "baseCommitMessage": "add A/n"
+}
diff --git a/crates/but/tests/but/snapshots/worktree/worktree_new_multiple_from_a.stdout.json b/crates/but/tests/but/snapshots/worktree/worktree_new_multiple_from_a.stdout.json
@@ -0,0 +1,10 @@
+{
+  "created": {
+    "id": "from-a",
+    "path": "[TEMP_PATH]/.git/gitbutler/worktrees/from-a",
+    "createdFromRef": "refs/heads/A",
+    "base": "9477ae721ab521d9d0174f70e804ce3ff9f6fb56"
+  },
+  "branchName": "gitbutler/worktree/from-a",
+  "baseCommitMessage": "add A/n"
+}
diff --git a/crates/but/tests/but/snapshots/worktree/worktree_new_multiple_from_b.stdout.json b/crates/but/tests/but/snapshots/worktree/worktree_new_multiple_from_b.stdout.json
@@ -0,0 +1,10 @@
+{
+  "created": {
+    "id": "from-b",
+    "path": "[TEMP_PATH]/.git/gitbutler/worktrees/from-b",
+    "createdFromRef": "refs/heads/B",
+    "base": "d3e2ba36c529fbdce8de90593e22aceae21f9b17"
+  },
+  "branchName": "gitbutler/worktree/from-b",
+  "baseCommitMessage": "add B/n"
+}
diff --git a/crates/but/tests/but/snapshots/worktree/worktree_new_multiple_list.stdout.json b/crates/but/tests/but/snapshots/worktree/worktree_new_multiple_list.stdout.json
@@ -0,0 +1,16 @@
+{
+  "entries": [
+    {
+      "id": "from-a",
+      "path": "[TEMP_PATH]/.git/gitbutler/worktrees/from-a",
+      "createdFromRef": "refs/heads/A",
+      "base": "9477ae721ab521d9d0174f70e804ce3ff9f6fb56"
+    },
+    {
+      "id": "from-b",
+      "path": "[TEMP_PATH]/.git/gitbutler/worktrees/from-b",
+      "createdFromRef": "refs/heads/B",
+      "base": "d3e2ba36c529fbdce8de90593e22aceae21f9b17"
+    }
+  ]
+}
diff --git a/crates/but/tests/but/snapshots/worktree/worktree_new_with_custom_name.stdout.json b/crates/but/tests/but/snapshots/worktree/worktree_new_with_custom_name.stdout.json
@@ -0,0 +1,10 @@
+{
+  "created": {
+    "id": "experiment",
+    "path": "[TEMP_PATH]/.git/gitbutler/worktrees/experiment",
+    "createdFromRef": "refs/heads/A",
+    "base": "9477ae721ab521d9d0174f70e804ce3ff9f6fb56"
+  },
+  "branchName": "gitbutler/worktree/experiment",
+  "baseCommitMessage": "add A/n"
+}
diff --git a/crates/but/tests/but/snapshots/worktree/worktree_new_with_default_name.stdout.json b/crates/but/tests/but/snapshots/worktree/worktree_new_with_default_name.stdout.json
@@ -0,0 +1,10 @@
+{
+  "created": {
+    "id": "A",
+    "path": "[TEMP_PATH]/.git/gitbutler/worktrees/A",
+    "createdFromRef": "refs/heads/A",
+    "base": "9477ae721ab521d9d0174f70e804ce3ff9f6fb56"
+  },
+  "branchName": "gitbutler/worktree/A",
+  "baseCommitMessage": "add A/n"
+}
diff --git a/crates/but/tests/but/snapshots/worktree/worktree_new_with_long_flag.stdout.json b/crates/but/tests/but/snapshots/worktree/worktree_new_with_long_flag.stdout.json
@@ -0,0 +1,10 @@
+{
+  "created": {
+    "id": "long-flag-test",
+    "path": "[TEMP_PATH]/.git/gitbutler/worktrees/long-flag-test",
+    "createdFromRef": "refs/heads/A",
+    "base": "9477ae721ab521d9d0174f70e804ce3ff9f6fb56"
+  },
+  "branchName": "gitbutler/worktree/long-flag-test",
+  "baseCommitMessage": "add A/n"
+}
diff --git a/crates/but/tests/but/worktree.rs b/crates/but/tests/but/worktree.rs
@@ -211,3 +211,166 @@ fn worktree_new_default_uses_shortened_branch_name() -> anyhow::Result<()> {
 
     Ok(())
 }
+
+// JSON snapshot tests - mirroring all terminal output tests
+
+#[test]
+fn worktree_new_with_default_name_json() -> anyhow::Result<()> {
+    let env = Sandbox::init_scenario_with_target("two-stacks")?;
+    setup_metadata(&env, &["A", "B"])?;
+
+    // Create worktree without custom name - should use shortened branch name
+    env.but("--json worktree new A")
+        .with_assert(env.assert_with_path_redactions())
+        .assert()
+        .success()
+        .stdout_eq(snapbox::file![
+            "snapshots/worktree/worktree_new_with_default_name.stdout.json"
+        ]);
+
+    Ok(())
+}
+
+#[test]
+fn worktree_new_with_custom_name_json() -> anyhow::Result<()> {
+    let env = Sandbox::init_scenario_with_target("two-stacks")?;
+    setup_metadata(&env, &["A", "B"])?;
+
+    // Create worktree with custom name
+    env.but("--json worktree new A -b experiment")
+        .with_assert(env.assert_with_path_redactions())
+        .assert()
+        .success()
+        .stdout_eq(snapbox::file![
+            "snapshots/worktree/worktree_new_with_custom_name.stdout.json"
+        ]);
+
+    Ok(())
+}
+
+#[test]
+fn worktree_new_deduplication_json() -> anyhow::Result<()> {
+    let env = Sandbox::init_scenario_with_target("two-stacks")?;
+    setup_metadata(&env, &["A", "B"])?;
+
+    // Create first worktree with name "test"
+    env.but("--json worktree new A -b test")
+        .with_assert(env.assert_with_path_redactions())
+        .assert()
+        .success()
+        .stdout_eq(snapbox::file![
+            "snapshots/worktree/worktree_new_deduplication_first.stdout.json"
+        ]);
+
+    // Create second worktree with same name - should get "test-a"
+    env.but("--json worktree new A -b test")
+        .with_assert(env.assert_with_path_redactions())
+        .assert()
+        .success()
+        .stdout_eq(snapbox::file![
+            "snapshots/worktree/worktree_new_deduplication_second.stdout.json"
+        ]);
+
+    // Create third worktree with same name - should get "test-b"
+    env.but("--json worktree new A -b test")
+        .with_assert(env.assert_with_path_redactions())
+        .assert()
+        .success()
+        .stdout_eq(snapbox::file![
+            "snapshots/worktree/worktree_new_deduplication_third.stdout.json"
+        ]);
+
+    Ok(())
+}
+
+#[test]
+fn worktree_list_after_creation_json() -> anyhow::Result<()> {
+    let env = Sandbox::init_scenario_with_target("two-stacks")?;
+    setup_metadata(&env, &["A", "B"])?;
+
+    // Create a worktree
+    env.but("worktree new A -b list-test").assert().success();
+
+    // List worktrees - should show our newly created one
+    env.but("--json worktree list")
+        .with_assert(env.assert_with_path_redactions())
+        .assert()
+        .success()
+        .stdout_eq(snapbox::file![
+            "snapshots/worktree/worktree_list_after_creation.stdout.json"
+        ]);
+
+    Ok(())
+}
+
+#[test]
+fn worktree_new_multiple_from_different_branches_json() -> anyhow::Result<()> {
+    let env = Sandbox::init_scenario_with_target("two-stacks")?;
+    setup_metadata(&env, &["A", "B"])?;
+
+    // Create worktree from branch A
+    env.but("--json worktree new A -b from-a")
+        .with_assert(env.assert_with_path_redactions())
+        .assert()
+        .success()
+        .stdout_eq(snapbox::file![
+            "snapshots/worktree/worktree_new_multiple_from_a.stdout.json"
+        ]);
+
+    // Create worktree from branch B
+    env.but("--json worktree new B -b from-b")
+        .with_assert(env.assert_with_path_redactions())
+        .assert()
+        .success()
+        .stdout_eq(snapbox::file![
+            "snapshots/worktree/worktree_new_multiple_from_b.stdout.json"
+        ]);
+
+    // List should show both
+    env.but("--json worktree list")
+        .with_assert(env.assert_with_path_redactions())
+        .assert()
+        .success()
+        .stdout_eq(snapbox::file![
+            "snapshots/worktree/worktree_new_multiple_list.stdout.json"
+        ]);
+
+    Ok(())
+}
+
+#[test]
+fn worktree_new_with_long_flag_json() -> anyhow::Result<()> {
+    let env = Sandbox::init_scenario_with_target("two-stacks")?;
+    setup_metadata(&env, &["A", "B"])?;
+
+    // Test with --name long flag instead of -b
+    env.but("--json worktree new A --name long-flag-test")
+        .with_assert(env.assert_with_path_redactions())
+        .assert()
+        .success()
+        .stdout_eq(snapbox::file![
+            "snapshots/worktree/worktree_new_with_long_flag.stdout.json"
+        ]);
+
+    Ok(())
+}
+
+#[test]
+fn worktree_new_default_uses_shortened_branch_name_json() -> anyhow::Result<()> {
+    let env = Sandbox::init_scenario_with_target("two-stacks")?;
+    setup_metadata(&env, &["A", "B"])?;
+
+    // Create without custom name - should deduplicate using shortened ref
+    env.but("--json worktree new A").assert().success();
+
+    // Second one should get -a suffix
+    env.but("--json worktree new A")
+        .with_assert(env.assert_with_path_redactions())
+        .assert()
+        .success()
+        .stdout_eq(snapbox::file![
+            "snapshots/worktree/worktree_new_default_deduplication.stdout.json"
+        ]);
+
+    Ok(())
+}
diff --git a/crates/gitbutler-serde/src/lib.rs b/crates/gitbutler-serde/src/lib.rs
@@ -5,14 +5,22 @@ pub use bstring::BStringForFrontend;
 
 pub mod bstring_lossy {
     use bstr::{BString, ByteSlice};
-    use serde::Serialize;
+    use serde::{Deserialize, Deserializer, Serialize};
 
     pub fn serialize<S>(v: &BString, s: S) -> Result<S::Ok, S::Error>
     where
         S: serde::Serializer,
     {
         v.to_str_lossy().serialize(s)
     }
+
+    pub fn deserialize<'de, D>(d: D) -> Result<BString, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        let s = String::deserialize(d)?;
+        Ok(BString::from(s))
+    }
 }
 
 pub mod bstring_vec_lossy {
@@ -207,3 +215,28 @@ pub mod oid {
             .map_err(|err: git2::Error| serde::de::Error::custom(err.to_string()))
     }
 }
+
+/// use like `#[serde(with = "gitbutler_serde::fullname_opt")]` to serialize [`Option<gix::refs::FullName>`].
+pub mod fullname_opt {
+    use bstr::ByteSlice;
+    use serde::{Deserialize, Deserializer, Serialize};
+
+    pub fn serialize<S>(v: &Option<gix::refs::FullName>, s: S) -> Result<S::Ok, S::Error>
+    where
+        S: serde::Serializer,
+    {
+        v.as_ref().map(|v| v.as_bstr().to_str_lossy()).serialize(s)
+    }
+
+    pub fn deserialize<'de, D>(d: D) -> Result<Option<gix::refs::FullName>, D::Error>
+    where
+        D: Deserializer<'de>,
+    {
+        let name = <Option<String> as Deserialize>::deserialize(d)?;
+        name.map(|v| {
+            gix::refs::FullName::try_from(v.as_str())
+                .map_err(|err| serde::de::Error::custom(err.to_string()))
+        })
+        .transpose()
+    }
+}
