crate-cli 0.2.4

A command-line tool for managing Cargo package lifecycles: version bump, workspace dependency sync, members-ordered publish and code formatting.
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
431
432
use super::*;

#[test]
fn test_sync_report_creation() {
    let report: SyncReport = SyncReport {
        workspace_version: "1.2.3".to_string(),
        renamed_entries: vec![("old".to_string(), "new".to_string())],
        versioned_entries: vec![("a".to_string(), "b".to_string())],
        file_changed: true,
    };
    assert_eq!(report.workspace_version, "1.2.3");
    assert_eq!(report.renamed_entries.len(), 1);
    assert_eq!(report.versioned_entries.len(), 1);
    assert!(report.file_changed);
}

#[test]
fn test_sync_report_clone() {
    let report: SyncReport = SyncReport {
        workspace_version: "0.1.0".to_string(),
        renamed_entries: Vec::new(),
        versioned_entries: Vec::new(),
        file_changed: false,
    };
    let cloned: SyncReport = report.clone();
    assert_eq!(cloned, report);
}

#[test]
fn test_sync_report_equality() {
    let report_a: SyncReport = SyncReport {
        workspace_version: "1.0.0".to_string(),
        renamed_entries: vec![],
        versioned_entries: vec![],
        file_changed: false,
    };
    let report_b: SyncReport = SyncReport {
        workspace_version: "1.0.0".to_string(),
        renamed_entries: vec![],
        versioned_entries: vec![],
        file_changed: false,
    };
    assert_eq!(report_a, report_b);
}

#[test]
fn test_sync_error_display() {
    let error_a: SyncError = SyncError::ManifestParseError;
    assert!(error_a.to_string().contains("Failed to parse"));
    let error_b: SyncError = SyncError::ManifestSerializeError;
    assert!(error_b.to_string().contains("Failed to serialize"));
    let error_c: SyncError = SyncError::WorkspaceVersionMissing("test".to_string());
    assert!(error_c.to_string().contains("workspace.package.version"));
    assert!(error_c.to_string().contains("test"));
    let error_d: SyncError = SyncError::WorkspaceMembersMissing("test".to_string());
    assert!(error_d.to_string().contains("workspace.members"));
    let error_e: SyncError = SyncError::MemberManifestMissing("test".to_string());
    assert!(error_e.to_string().contains("member crate Cargo.toml"));
    let error_f: SyncError = SyncError::MemberNameMissing("test".to_string());
    assert!(error_f.to_string().contains("[package].name"));
}

#[test]
fn test_sync_error_from_io() {
    let io_error: io::Error = io::Error::new(io::ErrorKind::NotFound, "missing");
    let sync_error: SyncError = SyncError::from(io_error);
    assert!(sync_error.to_string().contains("IO error"));
}

#[tokio::test]
async fn test_execute_sync_idempotent_when_already_synced() {
    let tmp_dir: PathBuf = PathBuf::from("./tmp/test_sync_idempotent");
    create_dir_all(&tmp_dir).await.unwrap();
    let workspace_manifest: PathBuf = tmp_dir.join("Cargo.toml");
    let member_dir: PathBuf = tmp_dir.join("alpha");
    create_dir_all(&member_dir).await.unwrap();
    let member_manifest: PathBuf = member_dir.join("Cargo.toml");
    let workspace_content: &str = r#"[workspace]
members = ["alpha"]

[workspace.package]
version = "0.1.0"

[workspace.dependencies]
alpha = { path = "alpha", version = "0.1.0" }
"#;
    write(&workspace_manifest, workspace_content).await.unwrap();
    let member_content: &str = r#"[package]
name = "alpha"
version = "0.1.0"
edition = "2024"
"#;
    write(&member_manifest, member_content).await.unwrap();
    let report: SyncReport = execute_sync(workspace_manifest.to_str().unwrap())
        .await
        .unwrap();
    assert_eq!(report.workspace_version, "0.1.0");
    assert_eq!(report.versioned_entries.len(), 0);
    assert_eq!(report.renamed_entries.len(), 0);
    assert!(!report.file_changed);
    let second_report: SyncReport = execute_sync(workspace_manifest.to_str().unwrap())
        .await
        .unwrap();
    assert!(!second_report.file_changed);
}

#[tokio::test]
async fn test_execute_sync_rewrites_version_literal() {
    let tmp_dir: PathBuf = PathBuf::from("./tmp/test_sync_rewrite_version");
    create_dir_all(&tmp_dir).await.unwrap();
    let workspace_manifest: PathBuf = tmp_dir.join("Cargo.toml");
    let member_dir: PathBuf = tmp_dir.join("beta");
    create_dir_all(&member_dir).await.unwrap();
    let member_manifest: PathBuf = member_dir.join("Cargo.toml");
    let workspace_content: &str = r#"[workspace]
members = ["beta"]

[workspace.package]
version = "0.2.0"

[workspace.dependencies]
beta = { path = "beta", version = "0.1.5" }
"#;
    write(&workspace_manifest, workspace_content).await.unwrap();
    let member_content: &str = r#"[package]
name = "beta"
version = "0.1.5"
edition = "2024"
"#;
    write(&member_manifest, member_content).await.unwrap();
    let report: SyncReport = execute_sync(workspace_manifest.to_str().unwrap())
        .await
        .unwrap();
    assert_eq!(report.workspace_version, "0.2.0");
    assert!(report.file_changed);
    let updated: String = read_to_string(&workspace_manifest).await.unwrap();
    assert!(updated.contains(r#"beta = { path = "beta", version = "0.2.0" }"#));
    assert!(!updated.contains(r#"version = "0.1.5""#));
    let second_report: SyncReport = execute_sync(workspace_manifest.to_str().unwrap())
        .await
        .unwrap();
    assert!(!second_report.file_changed);
}

#[tokio::test]
async fn test_execute_sync_renames_dep_alias_to_match_member_crate_name() {
    let tmp_dir: PathBuf = PathBuf::from("./tmp/test_sync_rename_alias");
    create_dir_all(&tmp_dir).await.unwrap();
    let workspace_manifest: PathBuf = tmp_dir.join("Cargo.toml");
    let member_dir: PathBuf = tmp_dir.join("gamma");
    create_dir_all(&member_dir).await.unwrap();
    let member_manifest: PathBuf = member_dir.join("Cargo.toml");
    let workspace_content: &str = r#"[workspace]
members = ["gamma"]

[workspace.package]
version = "0.3.0"

[workspace.dependencies]
stale_alias = { path = "gamma", version = "0.3.0" }
"#;
    write(&workspace_manifest, workspace_content).await.unwrap();
    let member_content: &str = r#"[package]
name = "gamma"
version = "0.3.0"
edition = "2024"
"#;
    write(&member_manifest, member_content).await.unwrap();
    let report: SyncReport = execute_sync(workspace_manifest.to_str().unwrap())
        .await
        .unwrap();
    assert_eq!(report.renamed_entries.len(), 1);
    assert_eq!(report.renamed_entries[0].0, "stale_alias");
    assert_eq!(report.renamed_entries[0].1, "gamma");
    assert!(report.file_changed);
    let updated: String = read_to_string(&workspace_manifest).await.unwrap();
    assert!(updated.contains(r#"gamma = { path = "gamma", version = "0.3.0" }"#));
    assert!(!updated.contains("stale_alias"));
}

#[tokio::test]
async fn test_execute_sync_handles_multiple_members() {
    let tmp_dir: PathBuf = PathBuf::from("./tmp/test_sync_multiple");
    create_dir_all(&tmp_dir).await.unwrap();
    let workspace_manifest: PathBuf = tmp_dir.join("Cargo.toml");
    for member in ["one", "two", "three"] {
        let member_dir: PathBuf = tmp_dir.join(member);
        create_dir_all(&member_dir).await.unwrap();
        let member_content: String = format!(
            r#"[package]
name = "{member}"
version = "0.0.0"
edition = "2024"
"#
        );
        write(&member_dir.join("Cargo.toml"), member_content)
            .await
            .unwrap();
    }
    let workspace_content: &str = r#"[workspace]
members = ["one", "two", "three"]

[workspace.package]
version = "9.9.9"

[workspace.dependencies]
one = { path = "one", version = "0.0.0" }
two = { path = "two", version = "0.0.0" }
three = { path = "three", version = "0.0.0" }
"#;
    write(&workspace_manifest, workspace_content).await.unwrap();
    let report: SyncReport = execute_sync(workspace_manifest.to_str().unwrap())
        .await
        .unwrap();
    assert_eq!(report.workspace_version, "9.9.9");
    assert_eq!(report.versioned_entries.len(), 3);
    let updated: String = read_to_string(&workspace_manifest).await.unwrap();
    for member in ["one", "two", "three"] {
        assert!(
            updated.contains(&format!(
                r#"{member} = {{ path = "{member}", version = "9.9.9" }}"#
            )),
            "expected preserved inline-form workspace.dependencies.{member} entry in:\n{updated}"
        );
    }
}

#[tokio::test]
async fn test_execute_sync_errors_on_missing_member_manifest() {
    let tmp_dir: PathBuf = PathBuf::from("./tmp/test_sync_missing_member");
    create_dir_all(&tmp_dir).await.unwrap();
    let workspace_manifest: PathBuf = tmp_dir.join("Cargo.toml");
    let workspace_content: &str = r#"[workspace]
members = ["does_not_exist"]

[workspace.package]
version = "1.0.0"
"#;
    write(&workspace_manifest, workspace_content).await.unwrap();
    let result: Result<SyncReport, SyncError> =
        execute_sync(workspace_manifest.to_str().unwrap()).await;
    assert!(result.is_err());
    match result.unwrap_err() {
        SyncError::MemberManifestMissing(_) => {}
        other => panic!("expected MemberManifestMissing, got {other:?}"),
    }
}

#[tokio::test]
async fn test_execute_sync_errors_on_missing_workspace_version() {
    let tmp_dir: PathBuf = PathBuf::from("./tmp/test_sync_no_version");
    create_dir_all(&tmp_dir).await.unwrap();
    let workspace_manifest: PathBuf = tmp_dir.join("Cargo.toml");
    let member_dir: PathBuf = tmp_dir.join("inheritor");
    create_dir_all(&member_dir).await.unwrap();
    write(
        &member_dir.join("Cargo.toml"),
        r#"[package]
name = "inheritor"
version.workspace = true
edition = "2024"
"#,
    )
    .await
    .unwrap();
    let workspace_content: &str = r#"[workspace]
members = ["inheritor"]

[workspace.dependencies]
inheritor = { path = "inheritor", version = "0.1.0" }
"#;
    write(&workspace_manifest, workspace_content).await.unwrap();
    let result: Result<SyncReport, SyncError> =
        execute_sync(workspace_manifest.to_str().unwrap()).await;
    assert!(result.is_err());
}

#[tokio::test]
async fn test_execute_sync_heterogeneous_workspace_uses_member_versions() {
    let tmp_dir: PathBuf = PathBuf::from("./tmp/test_sync_heterogeneous");
    create_dir_all(&tmp_dir).await.unwrap();
    let workspace_manifest: PathBuf = tmp_dir.join("Cargo.toml");
    for (name, version) in [("alpha", "1.2.1"), ("beta", "0.7.1")] {
        let member_dir: PathBuf = tmp_dir.join(name);
        create_dir_all(&member_dir).await.unwrap();
        write(
            &member_dir.join("Cargo.toml"),
            format!("[package]\nname = \"{name}\"\nversion = \"{version}\"\nedition = \"2024\"\n"),
        )
        .await
        .unwrap();
    }
    let workspace_content: &str = r#"[workspace]
members = ["alpha", "beta"]

[workspace.dependencies]
alpha = { path = "alpha", version = "0.0.0" }
beta = { path = "beta", version = "0.0.0" }
"#;
    write(&workspace_manifest, workspace_content).await.unwrap();
    let report: SyncReport = execute_sync(workspace_manifest.to_str().unwrap())
        .await
        .unwrap();
    assert!(report.file_changed);
    assert_eq!(report.versioned_entries.len(), 2);
    let synced: String = read_to_string(&workspace_manifest).await.unwrap();
    assert!(synced.contains("alpha = { path = \"alpha\", version = \"1.2.1\" }"));
    assert!(synced.contains("beta = { path = \"beta\", version = \"0.7.1\" }"));
}

#[tokio::test]
async fn test_execute_sync_skips_members_without_dep_entry() {
    let tmp_dir: PathBuf = PathBuf::from("./tmp/test_sync_no_dep");
    create_dir_all(&tmp_dir).await.unwrap();
    let workspace_manifest: PathBuf = tmp_dir.join("Cargo.toml");
    let member_dir: PathBuf = tmp_dir.join("solo");
    create_dir_all(&member_dir).await.unwrap();
    write(
        &member_dir.join("Cargo.toml"),
        r#"[package]
name = "solo"
version = "0.0.0"
edition = "2024"
"#,
    )
    .await
    .unwrap();
    let workspace_content: &str = r#"[workspace]
members = ["solo"]

[workspace.package]
version = "0.1.0"
"#;
    write(&workspace_manifest, workspace_content).await.unwrap();
    let report: SyncReport = execute_sync(workspace_manifest.to_str().unwrap())
        .await
        .unwrap();
    assert!(!report.file_changed);
    assert_eq!(report.versioned_entries.len(), 0);
}

#[tokio::test]
async fn test_execute_sync_preserves_manifest_formatting() {
    let tmp_dir: PathBuf = PathBuf::from("./tmp/test_sync_preserve_format");
    create_dir_all(&tmp_dir).await.unwrap();
    let workspace_manifest: PathBuf = tmp_dir.join("Cargo.toml");
    let member_dir: PathBuf = tmp_dir.join("delta");
    create_dir_all(&member_dir).await.unwrap();
    let workspace_content: &str = r#"[workspace]
members = ["delta"]

[workspace.package]
version = "1.0.0"

# comment above workspace.dependencies must survive
[workspace.dependencies]
delta = { path = "delta", version = "0.9.9" }
serde = { version = "1.0.0", features = ["derive"] }

[profile.dev]
opt-level = 3
"#;
    let expected_content: &str = r#"[workspace]
members = ["delta"]

[workspace.package]
version = "1.0.0"

# comment above workspace.dependencies must survive
[workspace.dependencies]
delta = { path = "delta", version = "1.0.0" }
serde = { version = "1.0.0", features = ["derive"] }

[profile.dev]
opt-level = 3
"#;
    write(&workspace_manifest, workspace_content).await.unwrap();
    write(
        &member_dir.join("Cargo.toml"),
        r#"[package]
name = "delta"
version = "0.9.9"
edition = "2024"
"#,
    )
    .await
    .unwrap();
    let report: SyncReport = execute_sync(workspace_manifest.to_str().unwrap())
        .await
        .unwrap();
    assert!(report.file_changed);
    let updated: String = read_to_string(&workspace_manifest).await.unwrap();
    assert_eq!(updated, expected_content);
}

#[tokio::test]
async fn test_execute_sync_falls_back_to_package_version() {
    let tmp_dir: PathBuf = PathBuf::from("./tmp/test_sync_package_version_fallback");
    create_dir_all(&tmp_dir).await.unwrap();
    let workspace_manifest: PathBuf = tmp_dir.join("Cargo.toml");
    let member_dir: PathBuf = tmp_dir.join("epsilon");
    create_dir_all(&member_dir).await.unwrap();
    let workspace_content: &str = r#"[package]
name = "root"
version = "2.0.0"

[workspace]
members = ["epsilon"]

[workspace.dependencies]
epsilon = { path = "epsilon", version = "1.0.0" }
"#;
    write(&workspace_manifest, workspace_content).await.unwrap();
    write(
        &member_dir.join("Cargo.toml"),
        r#"[package]
name = "epsilon"
version = "1.0.0"
edition = "2024"
"#,
    )
    .await
    .unwrap();
    let report: SyncReport = execute_sync(workspace_manifest.to_str().unwrap())
        .await
        .unwrap();
    assert_eq!(report.workspace_version, "2.0.0");
    assert!(report.file_changed);
    let updated: String = read_to_string(&workspace_manifest).await.unwrap();
    assert!(updated.contains(r#"epsilon = { path = "epsilon", version = "2.0.0" }"#));
    assert!(updated.contains("[package]\nname = \"root\"\nversion = \"2.0.0\""));
}