shiplog 0.7.0

CLI evidence compiler for review-cycle packets with receipts, coverage, gaps, and safe share profiles.
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

//! Edge-case tests for the GitHub ingest module.
//!
//! Covers adaptive date slicing behavior, SQLite cache integration,
//! rate limit / pagination API surface, and GitHub Enterprise base URL
//! configuration—all without making real network calls.

use chrono::NaiveDate;
use shiplog::ingest::github::GithubIngestor;
use shiplog::ports::Ingestor;

fn date(y: i32, m: u32, d: u32) -> NaiveDate {
    NaiveDate::from_ymd_opt(y, m, d).unwrap()
}

// ── Adaptive date slicing: ingest validates since < until ────────────────

#[test]
fn ingest_single_day_window_is_valid() {
    // since=2025-06-01, until=2025-06-02 → exactly one day, passes date check.
    // Result depends on network/token, but must NOT be a date-range error.
    let ing = GithubIngestor::new("user".into(), date(2025, 6, 1), date(2025, 6, 2));
    match ing.ingest() {
        Ok(_) => {} // token present, succeeded
        Err(e) => assert!(
            !e.to_string().contains("since must be < until"),
            "single-day window should pass date validation: {e}"
        ),
    }
}

#[test]
fn ingest_multi_year_window_passes_date_validation() {
    let ing = GithubIngestor::new("user".into(), date(2020, 1, 1), date(2025, 12, 31));
    match ing.ingest() {
        Ok(_) => {}
        Err(e) => assert!(
            !e.to_string().contains("since must be < until"),
            "multi-year window should pass date validation: {e}"
        ),
    }
}

#[test]
fn ingest_leap_day_boundary_accepted() {
    let ing = GithubIngestor::new("user".into(), date(2024, 2, 28), date(2024, 3, 1));
    match ing.ingest() {
        Ok(_) => {}
        Err(e) => assert!(
            !e.to_string().contains("since must be < until"),
            "leap-year boundary window should be valid: {e}"
        ),
    }
}

// ── SQLite cache integration (tempfile) ──────────────────────────────────

#[test]
fn with_cache_nested_deep_directory_creates_all_parents() {
    let temp = tempfile::tempdir().unwrap();
    let deep = temp.path().join("a").join("b").join("c").join("d");
    let ing = GithubIngestor::new("user".into(), date(2025, 1, 1), date(2025, 2, 1))
        .with_cache(&deep)
        .unwrap();
    assert!(ing.cache.is_some());
    assert!(deep.join("github-api-cache.db").exists());
}

#[test]
fn in_memory_cache_is_distinct_per_call() {
    let ing1 = GithubIngestor::new("user".into(), date(2025, 1, 1), date(2025, 2, 1))
        .with_in_memory_cache()
        .unwrap();
    let ing2 = GithubIngestor::new("user".into(), date(2025, 1, 1), date(2025, 2, 1))
        .with_in_memory_cache()
        .unwrap();
    // Both should have caches, and they should be independent instances
    assert!(ing1.cache.is_some());
    assert!(ing2.cache.is_some());
}

#[test]
fn with_cache_same_path_twice_succeeds() {
    let temp = tempfile::tempdir().unwrap();
    let ing = GithubIngestor::new("user".into(), date(2025, 1, 1), date(2025, 2, 1))
        .with_cache(temp.path())
        .unwrap()
        .with_cache(temp.path())
        .unwrap();
    assert!(ing.cache.is_some());
}

#[test]
fn cache_db_file_persists_after_ingestor_drop() {
    let temp = tempfile::tempdir().unwrap();
    let db_path = temp.path().join("github-api-cache.db");
    {
        let _ing = GithubIngestor::new("user".into(), date(2025, 1, 1), date(2025, 2, 1))
            .with_cache(temp.path())
            .unwrap();
        // _ing dropped here
    }
    assert!(db_path.exists(), "cache DB should persist after drop");
}

// ── Rate limit / throttle configuration ──────────────────────────────────

#[test]
fn throttle_ms_can_be_set_to_large_value() {
    let mut ing = GithubIngestor::new("user".into(), date(2025, 1, 1), date(2025, 2, 1));
    ing.throttle_ms = 60_000; // 60 seconds
    assert_eq!(ing.throttle_ms, 60_000);
}

#[test]
fn throttle_ms_zero_is_no_throttle() {
    let ing = GithubIngestor::new("user".into(), date(2025, 1, 1), date(2025, 2, 1));
    assert_eq!(ing.throttle_ms, 0);
}

// ── Pagination surface: fetch_details flag ───────────────────────────────

#[test]
fn fetch_details_can_be_disabled() {
    let mut ing = GithubIngestor::new("user".into(), date(2025, 1, 1), date(2025, 2, 1));
    ing.fetch_details = false;
    assert!(!ing.fetch_details);
}

#[test]
fn include_reviews_flag_toggles() {
    let mut ing = GithubIngestor::new("user".into(), date(2025, 1, 1), date(2025, 2, 1));
    assert!(!ing.include_reviews);
    ing.include_reviews = true;
    assert!(ing.include_reviews);
    ing.include_reviews = false;
    assert!(!ing.include_reviews);
}

// ── GitHub Enterprise base URL configuration ─────────────────────────────

#[test]
fn ghes_api_base_with_v3_path() {
    let mut ing = GithubIngestor::new("user".into(), date(2025, 1, 1), date(2025, 2, 1));
    ing.api_base = "https://github.corp.com/api/v3".to_string();
    assert_eq!(ing.api_base, "https://github.corp.com/api/v3");
}

#[test]
fn ghes_api_base_with_custom_port() {
    let mut ing = GithubIngestor::new("user".into(), date(2025, 1, 1), date(2025, 2, 1));
    ing.api_base = "https://ghes.internal:9443/api/v3".to_string();
    assert_eq!(ing.api_base, "https://ghes.internal:9443/api/v3");
}

#[test]
fn ghes_api_base_http_scheme() {
    let mut ing = GithubIngestor::new("user".into(), date(2025, 1, 1), date(2025, 2, 1));
    ing.api_base = "http://ghes.local/api/v3".to_string();
    assert_eq!(ing.api_base, "http://ghes.local/api/v3");
}

#[test]
fn ghes_token_can_be_set_with_enterprise_base() {
    let mut ing = GithubIngestor::new("user".into(), date(2025, 1, 1), date(2025, 2, 1));
    ing.api_base = "https://github.enterprise.com/api/v3".to_string();
    ing.token = Some("ghp_enterprise_token_12345".to_string());
    assert_eq!(ing.api_base, "https://github.enterprise.com/api/v3");
    assert_eq!(ing.token.as_deref(), Some("ghp_enterprise_token_12345"));
}

#[test]
fn ghes_mode_and_include_reviews_with_enterprise() {
    let mut ing = GithubIngestor::new("user".into(), date(2025, 1, 1), date(2025, 2, 1));
    ing.api_base = "https://ghes.corp/api/v3".to_string();
    ing.mode = "created".to_string();
    ing.include_reviews = true;
    assert_eq!(ing.mode, "created");
    assert!(ing.include_reviews);
}

#[test]
fn ghes_with_cache_and_enterprise_base() {
    let temp = tempfile::tempdir().unwrap();
    let mut ing = GithubIngestor::new("user".into(), date(2025, 1, 1), date(2025, 2, 1))
        .with_cache(temp.path())
        .unwrap();
    ing.api_base = "https://ghes.corp/api/v3".to_string();
    assert!(ing.cache.is_some());
    assert_eq!(ing.api_base, "https://ghes.corp/api/v3");
}

// ── All builder fields compose correctly ─────────────────────────────────

#[test]
fn full_builder_chain_with_all_options() {
    let temp = tempfile::tempdir().unwrap();
    let mut ing = GithubIngestor::new("alice".into(), date(2025, 1, 1), date(2025, 6, 1))
        .with_cache(temp.path())
        .unwrap();
    ing.mode = "created".to_string();
    ing.include_reviews = true;
    ing.fetch_details = false;
    ing.throttle_ms = 250;
    ing.token = Some("ghp_abc".to_string());
    ing.api_base = "https://ghes.corp/api/v3".to_string();

    assert_eq!(ing.user, "alice");
    assert_eq!(ing.mode, "created");
    assert!(ing.include_reviews);
    assert!(!ing.fetch_details);
    assert_eq!(ing.throttle_ms, 250);
    assert_eq!(ing.token.as_deref(), Some("ghp_abc"));
    assert_eq!(ing.api_base, "https://ghes.corp/api/v3");
    assert!(ing.cache.is_some());
}

// ── Date validation edge cases ───────────────────────────────────────────

#[test]
fn ingest_since_one_day_before_until_succeeds_date_check() {
    let ing = GithubIngestor::new("user".into(), date(2025, 1, 31), date(2025, 2, 1));
    match ing.ingest() {
        Ok(_) => {}
        Err(e) => assert!(
            !e.to_string().contains("since must be < until"),
            "adjacent-day window should pass date validation: {e}"
        ),
    }
}

#[test]
fn ingest_year_boundary_window_passes_date_check() {
    let ing = GithubIngestor::new("user".into(), date(2024, 12, 31), date(2025, 1, 1));
    match ing.ingest() {
        Ok(_) => {}
        Err(e) => assert!(
            !e.to_string().contains("since must be < until"),
            "year-boundary window should pass: {e}"
        ),
    }
}