cursus 0.9.3

Library crate for the cursus release management CLI
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
//! Integration tests for `cursus change --auto`.

mod common;

use std::process::ExitCode;

use common::{
	add_local_remote, git_cmd, git_current_branch, git_log, git_push_to_remote,
	git_set_remote_head, temp_real_git_repo_with_cargo_workspace, temp_real_git_repo_with_project,
};
use cursus::model::config::{CargoConfig, GitConfig, PackageManager};

/// Sets up a real git repo with a remote and origin/HEAD configured, ready for --auto tests.
///
/// Returns `(repo_dir, remote_dir)`. Keep `remote_dir` alive for the test duration.
async fn setup_auto_repo(pm: PackageManager) -> (tempfile::TempDir, tempfile::TempDir) {
	let dir = temp_real_git_repo_with_project(pm).await;
	let remote = add_local_remote(dir.path());
	git_push_to_remote(dir.path());
	let branch = git_current_branch(dir.path());
	git_set_remote_head(dir.path(), &branch);
	(dir, remote)
}

/// Creates a conventional commit on the current branch of the repo.
fn make_conventional_commit(dir: &std::path::Path, file: &str, msg: &str) {
	std::fs::write(dir.join(file), format!("// changed by: {msg}")).unwrap();
	git_cmd(dir, &["add", "."]);
	git_cmd(dir, &["commit", "-m", msg]);
}

/// Finds the changeset `.md` files in the `.cursus` directory.
fn find_changesets(dir: &std::path::Path) -> Vec<std::path::PathBuf> {
	let cursus_dir = dir.join(".cursus");
	if !cursus_dir.is_dir() {
		return vec![];
	}
	std::fs::read_dir(&cursus_dir)
		.unwrap()
		.filter_map(|e| e.ok())
		.filter(|e| e.path().extension().is_some_and(|ext| ext == "md"))
		.map(|e| e.path())
		.collect()
}

#[tokio::test]
async fn change_auto_fix_commit_creates_patch_changeset() {
	let (dir, _remote) = setup_auto_repo(PackageManager::Cargo).await;
	make_conventional_commit(dir.path(), "src/lib.rs", "fix: resolve null pointer");

	let result = common::run_cursus(
		["cursus", "--no-interactive", "change", "--auto", "--no-git"],
		dir.path(),
	)
	.await;

	assert!(result.is_ok());
	assert_eq!(result.unwrap(), ExitCode::SUCCESS);

	let changesets = find_changesets(dir.path());
	assert_eq!(changesets.len(), 1, "Expected one changeset file");
	let content = std::fs::read_to_string(&changesets[0]).unwrap();
	assert!(
		content.contains("test-project = \"patch\""),
		"Expected patch changeset, got: {content}"
	);
	assert!(
		content.contains("resolve null pointer"),
		"Expected description in changeset, got: {content}"
	);
}

#[tokio::test]
async fn change_auto_feat_commit_creates_minor_changeset() {
	let (dir, _remote) = setup_auto_repo(PackageManager::Cargo).await;
	make_conventional_commit(dir.path(), "src/lib.rs", "feat: add new feature");

	let result = common::run_cursus(
		["cursus", "--no-interactive", "change", "--auto", "--no-git"],
		dir.path(),
	)
	.await;

	assert!(result.is_ok());
	let changesets = find_changesets(dir.path());
	assert_eq!(changesets.len(), 1);
	let content = std::fs::read_to_string(&changesets[0]).unwrap();
	assert!(
		content.contains("test-project = \"minor\""),
		"Expected minor changeset, got: {content}"
	);
}

#[tokio::test]
async fn change_auto_breaking_bang_creates_major_changeset() {
	let (dir, _remote) = setup_auto_repo(PackageManager::Cargo).await;
	make_conventional_commit(dir.path(), "src/lib.rs", "feat!: redesign public API");

	let result = common::run_cursus(
		["cursus", "--no-interactive", "change", "--auto", "--no-git"],
		dir.path(),
	)
	.await;

	assert!(result.is_ok());
	let changesets = find_changesets(dir.path());
	assert_eq!(changesets.len(), 1);
	let content = std::fs::read_to_string(&changesets[0]).unwrap();
	assert!(
		content.contains("test-project = \"major\""),
		"Expected major changeset, got: {content}"
	);
}

#[tokio::test]
async fn change_auto_chore_commit_skips_changeset() {
	let (dir, _remote) = setup_auto_repo(PackageManager::Cargo).await;
	make_conventional_commit(dir.path(), "src/lib.rs", "chore: update dependencies");

	let result = common::run_cursus(
		["cursus", "--no-interactive", "change", "--auto", "--no-git"],
		dir.path(),
	)
	.await;

	assert!(result.is_ok());
	assert_eq!(result.unwrap(), ExitCode::SUCCESS);
	let changesets = find_changesets(dir.path());
	assert!(
		changesets.is_empty(),
		"Expected no changeset for chore commit"
	);
}

#[tokio::test]
async fn change_auto_multiple_commits_skips() {
	let (dir, _remote) = setup_auto_repo(PackageManager::Cargo).await;
	make_conventional_commit(dir.path(), "src/lib.rs", "fix: first fix");
	make_conventional_commit(dir.path(), "src/lib.rs", "fix: second fix");

	let result = common::run_cursus(
		["cursus", "--no-interactive", "change", "--auto", "--no-git"],
		dir.path(),
	)
	.await;

	assert!(result.is_ok());
	assert_eq!(result.unwrap(), ExitCode::SUCCESS);
	let changesets = find_changesets(dir.path());
	assert!(
		changesets.is_empty(),
		"Expected no changeset with multiple commits"
	);
}

#[tokio::test]
async fn change_auto_zero_commits_ahead_fails() {
	let (dir, _remote) = setup_auto_repo(PackageManager::Cargo).await;

	let result = common::run_cursus(
		["cursus", "--no-interactive", "change", "--auto", "--no-git"],
		dir.path(),
	)
	.await;

	assert!(result.is_err());
	let err = result.unwrap_err().to_string();
	assert!(
		err.contains("No commits ahead"),
		"Expected 'No commits ahead' error, got: {err}"
	);
}

#[tokio::test]
async fn change_auto_invalid_commit_message_fails() {
	let (dir, _remote) = setup_auto_repo(PackageManager::Cargo).await;
	make_conventional_commit(dir.path(), "src/lib.rs", "not a conventional commit");

	let result = common::run_cursus(
		["cursus", "--no-interactive", "change", "--auto", "--no-git"],
		dir.path(),
	)
	.await;

	assert!(result.is_err());
}

#[tokio::test]
async fn change_auto_dry_run_writes_nothing() {
	let (dir, _remote) = setup_auto_repo(PackageManager::Cargo).await;
	make_conventional_commit(dir.path(), "src/lib.rs", "fix: fix a bug");

	let result = common::run_cursus(
		[
			"cursus",
			"--no-interactive",
			"--dry-run",
			"change",
			"--auto",
			"--no-git",
		],
		dir.path(),
	)
	.await;

	assert!(result.is_ok());
	assert_eq!(result.unwrap(), ExitCode::SUCCESS);
	let changesets = find_changesets(dir.path());
	assert!(
		changesets.is_empty(),
		"Expected no changeset written in dry-run mode"
	);
}

#[tokio::test]
async fn change_auto_changeset_includes_body() {
	let (dir, _remote) = setup_auto_repo(PackageManager::Cargo).await;
	std::fs::write(dir.path().join("src/lib.rs"), "// modified").unwrap();
	git_cmd(dir.path(), &["add", "."]);
	git_cmd(
		dir.path(),
		&[
			"commit",
			"-m",
			"fix: fix the thing\n\nThis fixes the issue described in #42.",
		],
	);

	let result = common::run_cursus(
		["cursus", "--no-interactive", "change", "--auto", "--no-git"],
		dir.path(),
	)
	.await;

	assert!(result.is_ok());
	let changesets = find_changesets(dir.path());
	assert_eq!(changesets.len(), 1);
	let content = std::fs::read_to_string(&changesets[0]).unwrap();
	assert!(
		content.contains("fix the thing"),
		"Expected description in changeset, got: {content}"
	);
	assert!(
		content.contains("fixes the issue"),
		"Expected body in changeset, got: {content}"
	);
}

#[tokio::test]
async fn change_auto_strips_trailers_from_body() {
	let (dir, _remote) = setup_auto_repo(PackageManager::Cargo).await;
	std::fs::write(dir.path().join("src/lib.rs"), "// modified").unwrap();
	git_cmd(dir.path(), &["add", "."]);
	git_cmd(
		dir.path(),
		&[
			"commit",
			"-m",
			"fix: fix the thing\n\nThis fixes the issue described in #42.\n\nSigned-off-by: Test User <test@example.com>\nCo-authored-by: Bot <bot@example.com>",
		],
	);

	let result = common::run_cursus(
		["cursus", "--no-interactive", "change", "--auto", "--no-git"],
		dir.path(),
	)
	.await;

	assert!(result.is_ok());
	let changesets = find_changesets(dir.path());
	assert_eq!(changesets.len(), 1);
	let content = std::fs::read_to_string(&changesets[0]).unwrap();
	assert!(
		content.contains("fixes the issue"),
		"Expected body prose in changeset, got: {content}"
	);
	assert!(
		!content.contains("Signed-off-by"),
		"Expected trailers stripped from changeset, got: {content}"
	);
	assert!(
		!content.contains("Co-authored-by"),
		"Expected trailers stripped from changeset, got: {content}"
	);
}

#[tokio::test]
async fn change_auto_no_matching_projects_skips() {
	// Use a cargo workspace with a package in a subfolder; modify only a file
	// at the root (outside any package) so no project matches.
	let dir =
		temp_real_git_repo_with_cargo_workspace(&[("pkg-a", "0.1.0")], GitConfig::default()).await;
	let _remote = add_local_remote(dir.path());
	git_push_to_remote(dir.path());
	let branch = git_current_branch(dir.path());
	git_set_remote_head(dir.path(), &branch);

	std::fs::write(dir.path().join(".github-actions.yml"), "# ci").unwrap();
	git_cmd(dir.path(), &["add", "."]);
	git_cmd(dir.path(), &["commit", "-m", "fix: update ci config"]);

	let result = common::run_cursus(
		["cursus", "--no-interactive", "change", "--auto", "--no-git"],
		dir.path(),
	)
	.await;

	assert!(result.is_ok());
	assert_eq!(result.unwrap(), ExitCode::SUCCESS);
	let changesets = find_changesets(dir.path());
	assert!(
		changesets.is_empty(),
		"Expected no changeset when no project matched"
	);
}

#[tokio::test]
async fn change_auto_monorepo_only_affected_project_in_changeset() {
	let dir = temp_real_git_repo_with_cargo_workspace(
		&[("pkg-a", "0.1.0"), ("pkg-b", "0.1.0")],
		GitConfig::default(),
	)
	.await;
	let _remote = add_local_remote(dir.path());
	git_push_to_remote(dir.path());
	let branch = git_current_branch(dir.path());
	git_set_remote_head(dir.path(), &branch);

	std::fs::write(dir.path().join("pkg-a/src/lib.rs"), "// modified").unwrap();
	git_cmd(dir.path(), &["add", "."]);
	git_cmd(dir.path(), &["commit", "-m", "fix: fix pkg-a only"]);

	let result = common::run_cursus(
		["cursus", "--no-interactive", "change", "--auto", "--no-git"],
		dir.path(),
	)
	.await;

	assert!(result.is_ok());
	let changesets = find_changesets(dir.path());
	assert_eq!(changesets.len(), 1);
	let content = std::fs::read_to_string(&changesets[0]).unwrap();
	assert!(
		content.contains("pkg-a"),
		"Expected pkg-a in changeset, got: {content}"
	);
	assert!(
		!content.contains("pkg-b"),
		"Expected pkg-b NOT in changeset, got: {content}"
	);
}

#[tokio::test]
async fn change_auto_no_git_skips_commit() {
	let (dir, _remote) = setup_auto_repo(PackageManager::Cargo).await;
	make_conventional_commit(dir.path(), "src/lib.rs", "fix: a small bugfix");
	let commits_before = git_log(dir.path()).len();

	let result = common::run_cursus(
		["cursus", "--no-interactive", "change", "--auto", "--no-git"],
		dir.path(),
	)
	.await;

	assert!(result.is_ok());
	let changesets = find_changesets(dir.path());
	assert_eq!(changesets.len(), 1, "Changeset should be written");

	let commits_after = git_log(dir.path()).len();
	assert_eq!(
		commits_after, commits_before,
		"Expected no new commit with --no-git"
	);
}

#[tokio::test]
async fn change_auto_with_git_commits_and_pushes() {
	let (dir, _remote) = setup_auto_repo(PackageManager::Cargo).await;
	make_conventional_commit(dir.path(), "src/lib.rs", "fix: another fix");

	let env = common::test_env(dir.path());
	let config = cursus::model::config::Config::new()
		.with_cargo(CargoConfig::enabled())
		.with_git(GitConfig::enabled_config());
	config.save(env.fs(), env.git().path()).await.unwrap();

	let result = common::run_cursus(
		["cursus", "--no-interactive", "change", "--auto"],
		dir.path(),
	)
	.await;

	assert!(result.is_ok(), "Expected success, got: {:?}", result.err());
	let changesets = find_changesets(dir.path());
	assert_eq!(changesets.len(), 1, "Expected one changeset");

	let log = git_log(dir.path());
	assert!(
		log.iter().any(|s| s.contains("add changeset")),
		"Expected 'add changeset' commit in log, got: {log:?}"
	);
}

/// `--auto` with git disabled in config (no `--no-git` flag) must write changeset but not commit.
///
/// Guards `&&`→`||` on `commit_to_git = config.git.enabled() && !args.no_git`: if that
/// becomes `||`, a disabled-git config with no `--no-git` flag would still commit
/// (since `!args.no_git` is true), creating an unexpected commit.
#[tokio::test]
async fn change_auto_git_disabled_in_config_no_commit() {
	// setup_auto_repo uses temp_real_git_repo_with_project which saves config WITHOUT git enabled.
	let (dir, _remote) = setup_auto_repo(PackageManager::Cargo).await;
	make_conventional_commit(dir.path(), "src/lib.rs", "fix: small fix for config test");
	let commits_before = git_log(dir.path()).len();

	// No --no-git flag — git commit_to_git must still be false because config disables git.
	let result = common::run_cursus(
		["cursus", "--no-interactive", "change", "--auto"],
		dir.path(),
	)
	.await;

	assert!(result.is_ok(), "Expected Ok, got: {result:?}");
	let changesets = find_changesets(dir.path());
	assert_eq!(changesets.len(), 1, "Changeset should be written");

	let commits_after = git_log(dir.path()).len();
	assert_eq!(
		commits_after, commits_before,
		"Expected no new commit when git disabled in config (without --no-git flag)"
	);
}