git-workflow 0.9.0

Git guardrails for AI coding agents - safe git workflows with clear state feedback
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
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
//! Comprehensive tests for GitHub integration
//!
//! Tests cover:
//! - PR state detection (open, merged, closed)
//! - Merge method detection (merge, squash, rebase)
//! - Error handling (auth errors, network errors)
//! - Edge cases (Japanese titles, special characters)

use super::client::{CommandOutput, GitHubClient};
use super::mock::{MockScenarioBuilder, fixtures};
use super::types::{MergeMethod, PrState};

/// Args for the `gh pr list --base <base> --state open` query, matching
/// `GitHubClient::open_prs_with_base`.
fn pr_list_args(base: &str) -> Vec<String> {
    [
        "pr",
        "list",
        "--base",
        base,
        "--state",
        "open",
        "--json",
        "number,title,url,state,baseRefName,headRefName,mergeCommit",
    ]
    .iter()
    .map(|s| s.to_string())
    .collect()
}

#[test]
fn test_open_prs_with_base_lists_children() {
    let executor = MockScenarioBuilder::new().gh_available().build();
    let args = pr_list_args("feature/base");
    let arg_refs: Vec<&str> = args.iter().map(String::as_str).collect();
    let json = r#"[
        {"number":10,"title":"child one","state":"OPEN","baseRefName":"feature/base","headRefName":"feature/child-1"},
        {"number":11,"title":"child two","state":"OPEN","baseRefName":"feature/base","headRefName":"feature/child-2"}
    ]"#;
    executor.on_command("gh", &arg_refs, CommandOutput::success(json));
    let client = GitHubClient::with_executor(executor);

    let prs = client.open_prs_with_base("feature/base").unwrap();
    assert_eq!(prs.len(), 2);
    assert_eq!(prs[0].number, 10);
    assert_eq!(prs[0].head_branch, "feature/child-1");
}

#[test]
fn test_open_prs_with_base_empty() {
    let executor = MockScenarioBuilder::new().gh_available().build();
    let args = pr_list_args("feature/base");
    let arg_refs: Vec<&str> = args.iter().map(String::as_str).collect();
    executor.on_command("gh", &arg_refs, CommandOutput::success("[]"));
    let client = GitHubClient::with_executor(executor);

    assert!(
        client
            .open_prs_with_base("feature/base")
            .unwrap()
            .is_empty()
    );
}

// =============================================================================
// gh CLI availability tests
// =============================================================================

#[test]
fn test_gh_available() {
    let executor = MockScenarioBuilder::new().gh_available().build();
    let client = GitHubClient::with_executor(executor);

    assert!(client.is_available());
    assert!(client.is_authenticated());
}

#[test]
fn test_gh_not_available() {
    let executor = MockScenarioBuilder::new().gh_not_available().build();
    let client = GitHubClient::with_executor(executor);

    assert!(!client.is_available());
}

#[test]
fn test_gh_not_authenticated() {
    let executor = MockScenarioBuilder::new().gh_not_authenticated().build();
    let client = GitHubClient::with_executor(executor);

    assert!(client.is_available());
    assert!(!client.is_authenticated());
}

// =============================================================================
// PR state detection tests
// =============================================================================

#[test]
fn test_get_open_pr() {
    let executor = MockScenarioBuilder::new()
        .gh_available()
        .with_pr("feature/test", &fixtures::open_pr(42, "feature/test"))
        .build();
    let client = GitHubClient::with_executor(executor);

    let pr = client.get_pr_for_branch("feature/test").unwrap().unwrap();

    assert_eq!(pr.number, 42);
    assert!(pr.state.is_open());
    assert!(!pr.state.is_merged());
    assert!(!pr.state.is_closed());
    assert_eq!(pr.base_branch, "main");
}

#[test]
fn test_get_merged_pr_with_squash() {
    let executor = MockScenarioBuilder::new()
        .gh_available()
        .with_pr("feature/test", &fixtures::merged_pr(42, "abc123"))
        .with_merge_commit("abc123", 1) // 1 parent = squash
        .build();
    let client = GitHubClient::with_executor(executor);

    let pr = client.get_pr_for_branch("feature/test").unwrap().unwrap();

    assert_eq!(pr.number, 42);
    assert!(pr.state.is_merged());
    match &pr.state {
        PrState::Merged {
            method,
            merge_commit,
        } => {
            assert_eq!(*method, MergeMethod::Squash);
            assert_eq!(merge_commit, &Some("abc123".to_string()));
        }
        _ => panic!("Expected Merged state"),
    }
}

#[test]
fn test_get_merged_pr_with_merge() {
    let executor = MockScenarioBuilder::new()
        .gh_available()
        .with_pr("feature/test", &fixtures::merged_pr(42, "def456"))
        .with_merge_commit("def456", 2) // 2 parents = regular merge
        .build();
    let client = GitHubClient::with_executor(executor);

    let pr = client.get_pr_for_branch("feature/test").unwrap().unwrap();

    assert!(pr.state.is_merged());
    match &pr.state {
        PrState::Merged { method, .. } => {
            assert_eq!(*method, MergeMethod::Merge);
        }
        _ => panic!("Expected Merged state"),
    }
}

#[test]
fn test_get_merged_pr_with_rebase() {
    let executor = MockScenarioBuilder::new()
        .gh_available()
        .with_pr("feature/test", &fixtures::merged_pr_rebase(42))
        .build();
    let client = GitHubClient::with_executor(executor);

    let pr = client.get_pr_for_branch("feature/test").unwrap().unwrap();

    assert!(pr.state.is_merged());
    match &pr.state {
        PrState::Merged {
            method,
            merge_commit,
        } => {
            assert_eq!(*method, MergeMethod::Rebase);
            assert!(merge_commit.is_none());
        }
        _ => panic!("Expected Merged state"),
    }
}

#[test]
fn test_get_closed_pr() {
    let executor = MockScenarioBuilder::new()
        .gh_available()
        .with_pr("feature/abandoned", &fixtures::closed_pr(99))
        .build();
    let client = GitHubClient::with_executor(executor);

    let pr = client
        .get_pr_for_branch("feature/abandoned")
        .unwrap()
        .unwrap();

    assert_eq!(pr.number, 99);
    assert!(pr.state.is_closed());
    assert!(!pr.state.is_merged());
    assert!(!pr.state.is_open());
}

#[test]
fn test_no_pr_found() {
    let executor = MockScenarioBuilder::new()
        .gh_available()
        .with_no_pr("feature/no-pr")
        .build();
    let client = GitHubClient::with_executor(executor);

    let result = client.get_pr_for_branch("feature/no-pr").unwrap();

    assert!(result.is_none());
}

// =============================================================================
// Error handling tests
// =============================================================================

#[test]
fn test_auth_error() {
    let executor = MockScenarioBuilder::new()
        .gh_available()
        .with_auth_error("feature/test")
        .build();
    let client = GitHubClient::with_executor(executor);

    let result = client.get_pr_for_branch("feature/test");

    assert!(result.is_err());
    let err = result.unwrap_err();
    assert!(err.to_string().contains("not authenticated"));
}

// =============================================================================
// Remote branch deletion tests
// =============================================================================

#[test]
fn test_delete_remote_branch_success() {
    let executor = MockScenarioBuilder::new()
        .with_remote_delete_success("feature/test")
        .build();
    let client = GitHubClient::with_executor(executor.clone());

    let result = client.delete_remote_branch("feature/test");

    assert!(result.is_ok());
    assert!(executor.was_called("git", &["push", "origin", "--delete", "feature/test"]));
}

#[test]
fn test_delete_remote_branch_already_deleted() {
    let executor = MockScenarioBuilder::new()
        .with_remote_already_deleted("feature/test")
        .build();
    let client = GitHubClient::with_executor(executor);

    let result = client.delete_remote_branch("feature/test");

    // Should succeed even if branch doesn't exist
    assert!(result.is_ok());
}

#[test]
fn test_delete_remote_branch_failure() {
    let executor = MockScenarioBuilder::new()
        .with_remote_delete_failure("feature/test", "permission denied")
        .build();
    let client = GitHubClient::with_executor(executor);

    let result = client.delete_remote_branch("feature/test");

    assert!(result.is_err());
    assert!(
        result
            .unwrap_err()
            .to_string()
            .contains("permission denied")
    );
}

// =============================================================================
// Edge case tests
// =============================================================================

#[test]
fn test_pr_with_japanese_title() {
    let executor = MockScenarioBuilder::new()
        .gh_available()
        .with_pr("feature/ja", &fixtures::pr_with_japanese_title(50))
        .build();
    let client = GitHubClient::with_executor(executor);

    let pr = client.get_pr_for_branch("feature/ja").unwrap().unwrap();

    assert_eq!(pr.title, "feat: 日本語タイトル");
}

#[test]
fn test_pr_with_non_main_base() {
    let executor = MockScenarioBuilder::new()
        .gh_available()
        .with_pr("feature/dev", &fixtures::pr_with_develop_base(51))
        .build();
    let client = GitHubClient::with_executor(executor);

    let pr = client.get_pr_for_branch("feature/dev").unwrap().unwrap();

    assert_eq!(pr.base_branch, "develop");
}

#[test]
fn test_pr_with_special_characters_in_title() {
    let json = r#"{"number":52,"title":"fix: handle \"edge case\" & <special>","url":"https://github.com/owner/repo/pull/52","state":"OPEN","baseRefName":"main","mergeCommit":null,"mergedAt":null}"#;

    let executor = MockScenarioBuilder::new()
        .gh_available()
        .with_pr("feature/special", json)
        .build();
    let client = GitHubClient::with_executor(executor);

    let pr = client
        .get_pr_for_branch("feature/special")
        .unwrap()
        .unwrap();

    assert_eq!(pr.title, "fix: handle \"edge case\" & <special>");
}

// =============================================================================
// Command call verification tests
// =============================================================================

#[test]
fn test_commands_are_called_correctly() {
    let executor = MockScenarioBuilder::new()
        .gh_available()
        .with_pr("feature/verify", &fixtures::open_pr(60, "feature/verify"))
        .build();
    let client = GitHubClient::with_executor(executor.clone());

    // Clear any calls from setup
    executor.clear_calls();

    // Make the call
    let _ = client.get_pr_for_branch("feature/verify");

    // Verify the correct command was called
    let calls = executor.calls();
    assert_eq!(calls.len(), 1);
    assert_eq!(calls[0].program, "gh");
    assert!(calls[0].args.contains(&"pr".to_string()));
    assert!(calls[0].args.contains(&"view".to_string()));
    assert!(calls[0].args.contains(&"feature/verify".to_string()));
}

#[test]
fn test_merge_method_detection_calls_git() {
    let executor = MockScenarioBuilder::new()
        .gh_available()
        .with_pr("feature/merged", &fixtures::merged_pr(70, "sha123"))
        .with_merge_commit("sha123", 1)
        .build();
    let client = GitHubClient::with_executor(executor.clone());

    executor.clear_calls();

    let _ = client.get_pr_for_branch("feature/merged");

    // Should have called both gh and git
    assert!(executor.call_count("gh") >= 1);
    assert!(executor.call_count("git") >= 1);
    assert!(executor.was_called("git", &["cat-file", "-p", "sha123"]));
}

// =============================================================================
// Integration scenario tests
// =============================================================================

#[test]
fn test_cleanup_scenario_merged_pr() {
    // Simulates the cleanup command scenario where PR is merged
    let executor = MockScenarioBuilder::new()
        .gh_available()
        .with_pr("feature/done", &fixtures::merged_pr(100, "merge123"))
        .with_merge_commit("merge123", 1) // squash
        .with_remote_delete_success("feature/done")
        .build();
    let client = GitHubClient::with_executor(executor);

    // Step 1: Check PR state
    let pr = client.get_pr_for_branch("feature/done").unwrap().unwrap();
    assert!(pr.state.is_merged());

    // Step 2: Delete remote branch (should succeed because PR is merged)
    let delete_result = client.delete_remote_branch("feature/done");
    assert!(delete_result.is_ok());
}

#[test]
fn test_cleanup_scenario_open_pr() {
    // Simulates checking an open PR before cleanup
    let executor = MockScenarioBuilder::new()
        .gh_available()
        .with_pr("feature/wip", &fixtures::open_pr(101, "feature/wip"))
        .build();
    let client = GitHubClient::with_executor(executor);

    let pr = client.get_pr_for_branch("feature/wip").unwrap().unwrap();

    // PR is open - cleanup should warn about this
    assert!(pr.state.is_open());
    assert!(!pr.state.is_merged());
}

#[test]
fn test_cleanup_scenario_no_pr() {
    // Simulates cleanup when no PR exists
    let executor = MockScenarioBuilder::new()
        .gh_available()
        .with_no_pr("feature/local-only")
        .build();
    let client = GitHubClient::with_executor(executor);

    let result = client.get_pr_for_branch("feature/local-only").unwrap();

    // No PR - cleanup should handle this gracefully
    assert!(result.is_none());
}