stax 0.96.1

Fast stacked Git branches and PRs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283

//! Comments command integration tests
//!
//! Tests for the `comments` command that shows PR comments.
//! Note: Full functionality requires GitHub API access, so we test
//! pre-condition validation that exits before API calls.

use crate::common;

use common::{OutputAssertions, TestRepo};
use std::fs;
use std::path::Path;
use wiremock::matchers::{method, path};
use wiremock::{Mock, MockServer, ResponseTemplate};

fn write_test_config(home: &Path, api_base_url: &str) {
    let config_dir = home.join(".config").join("stax");
    fs::create_dir_all(&config_dir).expect("config directory");
    fs::write(
        config_dir.join("config.toml"),
        format!("[remote]\napi_base_url = \"{api_base_url}\"\n"),
    )
    .expect("test config");
}

fn write_branch_pr_metadata(repo: &TestRepo, branch: &str, parent: &str, pr_number: u64) {
    let metadata = serde_json::json!({
        "parentBranchName": parent,
        "parentBranchRevision": repo.get_commit_sha(parent),
        "prInfo": { "number": pr_number, "state": "OPEN" }
    });
    let file = tempfile::NamedTempFile::new().expect("metadata file");
    fs::write(file.path(), metadata.to_string()).expect("metadata contents");
    let hash = repo.git(&["hash-object", "-w", file.path().to_str().unwrap()]);
    hash.assert_success();
    repo.git(&[
        "update-ref",
        &format!("refs/branch-metadata/{branch}"),
        TestRepo::stdout(&hash).trim(),
    ])
    .assert_success();
}

// =============================================================================
// Help Tests
// =============================================================================

#[test]
fn test_comments_help() {
    let repo = TestRepo::new();
    let output = repo.run_stax(&["comments", "--help"]);
    output.assert_success();

    let stdout = TestRepo::stdout(&output);
    assert!(stdout.contains("comments"));
    assert!(stdout.contains("PR"));
}

// =============================================================================
// Error Case Tests (validation before API calls)
// =============================================================================

#[test]
fn test_comments_on_trunk_fails() {
    let repo = TestRepo::new();
    // Stay on main (trunk)

    let output = repo.run_stax(&["comments"]);
    output.assert_failure();

    let stderr = TestRepo::stderr(&output);
    // On trunk, the command may fail with "not tracked", "trunk", or "No PR" message
    // depending on how the validation logic proceeds
    assert!(
        stderr.contains("not tracked") || stderr.contains("trunk") || stderr.contains("No PR"),
        "Expected message about untracked/trunk branch or missing PR, got: {}",
        stderr
    );
}

#[test]
fn test_comments_untracked_branch_fails() {
    let repo = TestRepo::new();

    // Create an untracked branch directly with git
    repo.git(&["checkout", "-b", "untracked-branch"]);
    repo.create_file("test.txt", "content");
    repo.commit("Untracked commit");

    let output = repo.run_stax(&["comments"]);
    output.assert_failure();

    let stderr = TestRepo::stderr(&output);
    assert!(
        stderr.contains("not tracked") || stderr.contains("track"),
        "Expected message about untracked branch, got: {}",
        stderr
    );
}

#[test]
fn test_comments_no_pr_fails() {
    let repo = TestRepo::new();

    // Create a tracked branch but without a PR
    repo.create_stack(&["feature-a"]);
    assert!(repo.current_branch_contains("feature-a"));

    let output = repo.run_stax(&["comments"]);
    output.assert_failure();

    let stderr = TestRepo::stderr(&output);
    assert!(
        stderr.contains("No PR") || stderr.contains("submit") || stderr.contains("PR"),
        "Expected message about missing PR, got: {}",
        stderr
    );
}

// =============================================================================
// Integration with Stack
// =============================================================================

#[test]
fn test_comments_from_deep_stack_no_pr() {
    let repo = TestRepo::new();

    // Create a deeper stack
    repo.create_stack(&["feature-a", "feature-b", "feature-c"]);
    assert!(repo.current_branch_contains("feature-c"));

    // Should still fail because no PR exists
    let output = repo.run_stax(&["comments"]);
    output.assert_failure();

    let stderr = TestRepo::stderr(&output);
    assert!(
        stderr.contains("No PR") || stderr.contains("submit"),
        "Expected message about missing PR, got: {}",
        stderr
    );
}

#[tokio::test]
async fn reviews_alias_lists_a_stack_inbox_as_json() {
    let _ = rustls::crypto::ring::default_provider().install_default();
    let server = MockServer::start().await;
    let repo = TestRepo::new();
    let home = repo.clean_home();
    write_test_config(Path::new(&home), &server.uri());
    repo.git(&[
        "remote",
        "add",
        "origin",
        "https://github.com/test/repo.git",
    ])
    .assert_success();
    let branches = repo.create_stack(&["review-parent", "review-child"]);
    write_branch_pr_metadata(&repo, &branches[0], "main", 41);
    write_branch_pr_metadata(&repo, &branches[1], &branches[0], 42);

    for (number, body) in [(41, "Please add a test"), (42, "Looks good")] {
        Mock::given(method("GET"))
            .and(path(format!("/repos/test/repo/issues/{number}/comments")))
            .respond_with(
                ResponseTemplate::new(200).set_body_json(serde_json::json!([{
                    "id": number,
                    "body": body,
                    "user": { "login": "reviewer" },
                    "created_at": "2026-07-10T12:00:00Z"
                }])),
            )
            .mount(&server)
            .await;
        Mock::given(method("GET"))
            .and(path(format!("/repos/test/repo/pulls/{number}/comments")))
            .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!([])))
            .mount(&server)
            .await;
    }

    let output = repo.run_stax_with_env(
        &["reviews", "--stack", "--json"],
        &[("STAX_GITHUB_TOKEN", "mock-token")],
    );
    output.assert_success();
    let inbox: serde_json::Value = serde_json::from_slice(&output.stdout).expect("inbox JSON");
    assert_eq!(inbox["scope"], "stack");
    assert_eq!(inbox["total_comments"], 2);
    assert_eq!(inbox["pull_requests"][0]["branch"], branches[0]);
    assert_eq!(
        inbox["pull_requests"][0]["comments"][0]["body"],
        "Please add a test"
    );
    assert_eq!(inbox["pull_requests"][1]["branch"], branches[1]);
}

#[tokio::test]
async fn reviews_inbox_renders_inline_comment_location() {
    let _ = rustls::crypto::ring::default_provider().install_default();
    let server = MockServer::start().await;
    let repo = TestRepo::new();
    let home = repo.clean_home();
    write_test_config(Path::new(&home), &server.uri());
    repo.git(&[
        "remote",
        "add",
        "origin",
        "https://github.com/test/repo.git",
    ])
    .assert_success();
    let branch = repo.create_stack(&["inline-review"]).remove(0);
    write_branch_pr_metadata(&repo, &branch, "main", 43);

    Mock::given(method("GET"))
        .and(path("/repos/test/repo/issues/43/comments"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!([])))
        .mount(&server)
        .await;
    Mock::given(method("GET"))
        .and(path("/repos/test/repo/pulls/43/comments"))
        .respond_with(
            ResponseTemplate::new(200).set_body_json(serde_json::json!([{
                "id": 430,
                "body": "Please simplify this block",
                "user": { "login": "reviewer" },
                "path": "src/lib.rs",
                "line": 14,
                "start_line": 12,
                "created_at": "2026-07-10T12:00:00Z",
                "diff_hunk": "@@ -12,3 +12,3 @@"
            }])),
        )
        .mount(&server)
        .await;

    let output = repo.run_stax_with_env(
        &["reviews", "--stack", "--plain"],
        &[("STAX_GITHUB_TOKEN", "mock-token")],
    );

    output.assert_success();
    output.assert_stdout_contains("src/lib.rs:12-14");
    output.assert_stdout_contains("Please simplify this block");
}

#[tokio::test]
async fn reviews_inbox_reports_comment_api_failures() {
    let _ = rustls::crypto::ring::default_provider().install_default();
    let server = MockServer::start().await;
    let repo = TestRepo::new();
    let home = repo.clean_home();
    write_test_config(Path::new(&home), &server.uri());
    repo.git(&[
        "remote",
        "add",
        "origin",
        "https://github.com/test/repo.git",
    ])
    .assert_success();
    let branch = repo.create_stack(&["failed-review-fetch"]).remove(0);
    write_branch_pr_metadata(&repo, &branch, "main", 44);

    Mock::given(method("GET"))
        .and(path("/repos/test/repo/issues/44/comments"))
        .respond_with(ResponseTemplate::new(500).set_body_json(serde_json::json!({
            "message": "temporary failure"
        })))
        .mount(&server)
        .await;
    Mock::given(method("GET"))
        .and(path("/repos/test/repo/pulls/44/comments"))
        .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!([])))
        .mount(&server)
        .await;

    let output = repo.run_stax_with_env(
        &["reviews", "--stack", "--json"],
        &[("STAX_GITHUB_TOKEN", "mock-token")],
    );

    output.assert_failure();
    output.assert_stderr_contains("Failed to list issue comments");
}