1pub mod apply;
20pub mod invariants;
21pub mod lock;
22pub mod manifest;
23
24use camino::Utf8Path;
25
26pub use crate::projection::{
27 AGENTS_DESTINATION, BLOCK_BEGIN, BLOCK_DESTINATIONS, BLOCK_END, BRANCH_GRAMMAR,
28 CODE_SCANNING_DESTINATIONS, CODE_SCANNING_TECHS, GLOSSARY_DESTINATION, HOOK_TYPES_LINE,
29 HOOKS_BEGIN, HOOKS_DESTINATION, HOOKS_END, Kind, LINE_PREFIX_RE_TOKEN, LINE_PREFIX_TOKEN,
30 NIX_DESTINATIONS, NIX_WITHHOLDABLE, OWNER_TOKEN, REPO_PLACEHOLDER, REPO_TOKEN, SCOPE_SHAPE,
31 SCOPE_SHAPE_TOKEN, SCORECARD_DESTINATIONS, SECURITY_SPANS, STYLE_TOKEN, TRUNK_BRANCH_TOKEN,
32 authored, block_markers, destinations, extract_block, hooks_marker_defect, kind_of,
33 marker_defect, render, scope_is_shaped, splice_hooks_block, splice_marked_block, substitute,
34};
35pub use manifest::{CheckoutMode, Integration, Provider, Style};
36use serde::Serialize;
37
38use crate::diagnostic::{Diagnostic, Reason};
39use crate::error::RkError;
40
41pub use crate::profile::{Inputs, Params, Purpose};
42
43#[derive(Debug, Clone, Serialize)]
45pub struct Withheld {
46 pub path: String,
48 pub reason: String,
51}
52
53pub fn read_recorded(target: &Utf8Path, destination: &str) -> std::io::Result<Option<Vec<u8>>> {
64 let path = target.join(destination);
65 let bytes = match std::fs::read(&path) {
66 Ok(bytes) => bytes,
67 Err(e) if e.kind() == std::io::ErrorKind::NotFound => return Ok(None),
68 Err(e) => return Err(e),
69 };
70 if let Some((begin, end)) = block_markers(destination) {
71 let text = String::from_utf8_lossy(&bytes);
72 Ok(extract_block(&text, begin, end).map(|block| block.as_bytes().to_vec()))
73 } else {
74 Ok(Some(bytes))
75 }
76}
77
78#[derive(Debug)]
81pub struct Resolved {
82 pub forge: String,
84 pub repo: Option<String>,
86}
87
88pub fn resolve(
99 target: &Utf8Path,
100 forge_flag: Option<&str>,
101 repo_flag: Option<&str>,
102) -> Result<Resolved, RkError> {
103 let forge_flag = forge_flag
104 .map(|name| {
105 crate::detect::Forge::parse(name).ok_or_else(|| {
106 RkError::Usage(format!(
107 "unknown forge '{name}'; the forges are: github, gitlab"
108 ))
109 })
110 })
111 .transpose()?;
112 let detected = crate::detect::detect(target.as_std_path());
113 let forge = forge_flag
114 .or(detected.forge)
115 .map(|forge| forge.as_str().to_owned())
116 .ok_or_else(|| {
117 let message = detected.host.map_or_else(
118 || "no forge detected: the target has no origin remote".to_owned(),
119 |host| format!("no forge detected: the host {host} is not recognized"),
120 );
121 RkError::refusal(
122 Diagnostic::new(Reason::ForgeUndetected, message)
123 .expected("a github.com or gitlab remote, or --forge")
124 .action("pass --forge <github|gitlab>"),
125 )
126 })?;
127 Ok(Resolved {
128 forge,
129 repo: repo_flag.map(str::to_owned).or(detected.repo),
130 })
131}
132
133#[must_use]
136pub fn repo_unresolved() -> RkError {
137 RkError::missing(
138 Diagnostic::new(
139 Reason::ForgeUndetected,
140 "no repository detected: the target has no origin remote",
141 )
142 .expected("an origin remote naming the project")
143 .action("pass --repo <path>"),
144 )
145}
146
147#[cfg(test)]
148mod tests {
149 use super::{
150 AGENTS_DESTINATION, BLOCK_BEGIN, BLOCK_DESTINATIONS, BLOCK_END, BRANCH_GRAMMAR,
151 CheckoutMode, GLOSSARY_DESTINATION, HOOK_TYPES_LINE, HOOKS_BEGIN, HOOKS_DESTINATION,
152 HOOKS_END, Integration, Kind, Provider, SCOPE_SHAPE, Style, extract_block, kind_of, render,
153 splice_hooks_block, splice_marked_block,
154 };
155 use crate::embedded;
156 use crate::profile::{
157 CapabilityRequests, GitWorkflow, ProfileSnapshot, ReleaseIntent, ReleaseMode,
158 };
159 use crate::projection::{self, Projection, ProjectionInput, TargetEvidence};
160
161 const MODE_PAIRS: [(CheckoutMode, Integration); 4] = [
163 (CheckoutMode::MainWorktree, Integration::Forge),
164 (CheckoutMode::LinkedWorktree, Integration::Forge),
165 (CheckoutMode::MainWorktree, Integration::Local),
166 (CheckoutMode::LinkedWorktree, Integration::Local),
167 ];
168
169 fn destinations(params: &super::Params) -> Vec<String> {
172 Projection::compute(&ProjectionInput {
173 params: params.clone(),
174 evidence: TargetEvidence {
175 crate_shape: projection::CrateShape {
176 cargo_toml: Some(
177 "[package]\nname = \"widget\"\nversion = \"0.1.0\"\n".to_owned(),
178 ),
179 cargo_lock: true,
180 main_rs: true,
181 },
182 ..TargetEvidence::default()
183 },
184 })
185 .expect("the pair projects")
186 .candidates
187 .into_iter()
188 .map(|candidate| candidate.destination)
189 .collect()
190 }
191
192 fn routing_block(workflow_guards: bool) -> String {
193 projection::routing_block(workflow_guards).expect("the binary embeds the block")
194 }
195
196 fn hooks_block(mode: CheckoutMode) -> String {
197 projection::hooks_block(mode, Integration::Forge, true)
198 .expect("the binary embeds the block")
199 }
200
201 fn hooks_block_for(mode: CheckoutMode, integration: Integration) -> String {
202 projection::hooks_block(mode, integration, true).expect("the binary embeds the block")
203 }
204
205 fn unguarded_hooks_block(mode: CheckoutMode, integration: Integration) -> String {
206 projection::hooks_block(mode, integration, false).expect("the binary embeds the block")
207 }
208
209 fn glossary_block() -> String {
210 projection::glossary_block().expect("the binary embeds the block")
211 }
212
213 fn spliced(existing: Option<&str>, block: &str) -> String {
216 String::from_utf8(splice_marked_block(existing.map(str::as_bytes), block))
217 .expect("the fixtures are text")
218 }
219
220 #[test]
221 fn private_reporting_path_tokens_are_reproducible() {
222 for repo in [
223 "acme/widget",
224 "acme/group/widget",
225 "acme/OWNER-RK_STYLE-RK_SCOPE_SHAPE",
226 ] {
227 assert_eq!(
228 super::render(
229 b"RK_REPO RK_REPO OWNER RK_STYLE RK_SCOPE_SHAPE",
230 &super::Params::for_test(repo, Some(super::Style::Trunk))
231 ),
232 format!("{repo} {repo} acme trunk {}", super::SCOPE_SHAPE).as_bytes()
233 );
234 }
235 assert_eq!(super::kind_of("SECURITY.md"), Some(super::Kind::Rendered));
236 }
237
238 #[test]
243 fn each_forge_policy_carries_one_ordered_pair_of_every_span() {
244 for forge in ["github", "gitlab"] {
245 let bytes = embedded::SNIPPETS
246 .get_file(format!("_shared/{forge}/SECURITY.md"))
247 .expect("the policy ships")
248 .contents();
249 let text = String::from_utf8_lossy(bytes);
250 for (begin, end) in super::SECURITY_SPANS {
251 let begin = String::from_utf8_lossy(begin);
252 let end = String::from_utf8_lossy(end);
253 assert_eq!(text.matches(begin.as_ref()).count(), 1, "{forge} {begin}");
254 assert_eq!(text.matches(end.as_ref()).count(), 1, "{forge} {end}");
255 assert!(
256 text.find(begin.as_ref()) < text.find(end.as_ref()),
257 "{forge}: {begin} must precede {end}"
258 );
259 }
260 }
261 }
262
263 #[test]
268 fn the_security_spans_render_per_answer() {
269 for forge in ["github", "gitlab"] {
270 let bytes = embedded::SNIPPETS
271 .get_file(format!("_shared/{forge}/SECURITY.md"))
272 .expect("the policy ships")
273 .contents();
274 let authored = String::from_utf8_lossy(bytes);
275 let stripped = {
276 let mut text = authored.clone().into_owned();
277 for (begin, end) in super::SECURITY_SPANS {
278 text = text.replace(&String::from_utf8_lossy(begin).into_owned(), "");
279 text = text.replace(&String::from_utf8_lossy(end).into_owned(), "");
280 }
281 text
282 };
283 let mut default = super::Params::for_test_security("", crate::config::RESPONSE_DEFAULT);
284 default.set_pair_for_test("rust", forge);
285 let rendered = String::from_utf8(render(bytes, &default)).expect("text");
286 assert_eq!(
287 rendered,
288 stripped.replace("RK_REPO", "acme/widget"),
289 "{forge}: the default answers must reproduce the authored policy"
290 );
291 assert!(!rendered.contains("RK_SECURITY"), "{forge}: {rendered}");
292
293 let mut answered =
294 super::Params::for_test_security("OWNER RK_REPO <team@acme.example>", "14 days");
295 answered.set_pair_for_test("rust", forge);
296 let rendered = String::from_utf8(render(bytes, &answered)).expect("text");
297 assert!(
298 rendered.contains("OWNER RK_REPO <team@acme.example>"),
299 "{forge}: a contact spelling a token name lands literally: {rendered}"
300 );
301 assert!(
302 rendered.contains("Maintainers acknowledge a report within 14 days."),
303 "{forge}: {rendered}"
304 );
305 assert!(
306 rendered.contains("This policy commits to no disclosure deadline."),
307 "{forge}: {rendered}"
308 );
309 assert!(
310 !rendered.contains("best-effort basis"),
311 "{forge}: a stated window replaces the best-effort sentence: {rendered}"
312 );
313 assert!(
314 !rendered.contains("no response or disclosure deadline"),
315 "{forge}: a stated window contradicts the response disclaimer: {rendered}"
316 );
317 }
318 }
319
320 #[test]
323 fn a_defective_span_renders_unchanged() {
324 let (begin, end) = super::SECURITY_SPANS[0];
325 let begin = String::from_utf8_lossy(begin).into_owned();
326 let end = String::from_utf8_lossy(end).into_owned();
327 let params = super::Params::for_test_security("team@acme.example", "1 day");
328 for baseline in [
329 format!("contact {begin}a maintainer\n"),
330 format!("contact a maintainer{end}\n"),
331 format!("contact {end}a maintainer{begin}\n"),
332 "contact a maintainer\n".to_owned(),
333 ] {
334 assert_eq!(
335 render(baseline.as_bytes(), ¶ms),
336 baseline.as_bytes(),
337 "{baseline}"
338 );
339 }
340 }
341
342 #[test]
346 fn the_kind_table_closes_over_every_snippet() {
347 for tech_dir in embedded::SNIPPETS.dirs() {
348 for pair_dir in tech_dir.dirs() {
349 let prefix = format!("{}/", pair_dir.path().to_string_lossy());
350 for (path, _) in embedded::walk(pair_dir) {
351 let destination = path.strip_prefix(&prefix).unwrap_or(&path);
352 assert!(
353 kind_of(destination).is_some(),
354 "{destination}: no declared kind"
355 );
356 }
357 }
358 }
359 for block in BLOCK_DESTINATIONS {
360 assert_eq!(kind_of(block), Some(Kind::Rendered), "{block}");
361 }
362 assert_eq!(kind_of("something-else.txt"), None);
363 }
364
365 #[test]
370 fn rendering_substitutes_every_owner_occurrence() {
371 let baseline = b"if: repository_owner == 'OWNER'\n# OWNER again: OWNER\n";
372 let rendered = render(baseline, &super::Params::for_test("acme/sub/widget", None));
373 let text = String::from_utf8(rendered).expect("rendered bytes stay text");
374 assert_eq!(text, "if: repository_owner == 'acme'\n# acme again: acme\n");
375
376 let baseline = b"match (RK_SCOPE_SHAPE)\n";
377 let rendered = render(baseline, &super::Params::for_test("acme/widget", None));
378 let text = String::from_utf8(rendered).expect("rendered bytes stay text");
379 assert_eq!(text, format!("match ({SCOPE_SHAPE})\n"));
380 }
381
382 #[test]
386 fn the_scope_shape_drops_into_the_title_check() {
387 assert_eq!(SCOPE_SHAPE, "[a-z0-9._/-]+");
388 assert!(
389 !SCOPE_SHAPE.contains('\''),
390 "the title checks single-quote it"
391 );
392 }
393
394 #[test]
399 fn the_scope_predicate_and_the_rendered_pattern_agree() {
400 let body = SCOPE_SHAPE
401 .strip_prefix('[')
402 .and_then(|rest| rest.strip_suffix("]+"))
403 .expect("the shape is one bracket expression, repeated");
404 let chars: Vec<char> = body.chars().collect();
405 let mut admitted = std::collections::BTreeSet::new();
406 let mut at = 0;
407 while at < chars.len() {
408 if at + 2 < chars.len() && chars[at + 1] == '-' {
411 for c in chars[at]..=chars[at + 2] {
412 admitted.insert(c);
413 }
414 at += 3;
415 } else {
416 admitted.insert(chars[at]);
417 at += 1;
418 }
419 }
420 for byte in 0..=127u8 {
421 let c = char::from(byte);
422 assert_eq!(
423 super::scope_is_shaped(&c.to_string()),
424 admitted.contains(&c),
425 "the predicate and {SCOPE_SHAPE} disagree on {c:?}"
426 );
427 }
428 assert!(super::scope_is_shaped("guides/release"));
429 assert!(!super::scope_is_shaped(""), "a scope is never empty");
430 assert!(!super::scope_is_shaped("Specs Ugly"));
431 }
432
433 #[test]
437 fn the_shared_zone_composes_into_the_pair() {
438 let mut github = super::Params::for_test("acme/widget", Some(Style::Trunk));
439 github.set_pair_for_test("rust", "github");
440 let github = destinations(&github);
441 assert!(
442 github.contains(&".github/workflows/pr-title.yml".to_owned()),
443 "the shared title check lands with the pair"
444 );
445 assert!(github.contains(&"SECURITY.md".to_owned()));
446 let mut gitlab = super::Params::for_test("acme/widget", Some(Style::Trunk));
447 gitlab.set_pair_for_test("rust", "gitlab");
448 let gitlab = destinations(&gitlab);
449 assert!(
450 gitlab.contains(&".gitlab/ci/mr-title.yml".to_owned()),
451 "the shared title job lands with the pair"
452 );
453 assert!(
454 !crate::profile::catalog::known_drivers()
455 .iter()
456 .any(|driver| driver.starts_with('_')),
457 "the shared zone is no driver"
458 );
459 }
460
461 #[test]
464 fn params_from_a_record_round_trips() {
465 use super::{Params, manifest};
466 let dir = tempfile::tempdir().expect("a scratch target exists");
467 let target = camino::Utf8Path::from_path(dir.path()).expect("utf-8 path");
468 for tech in ["rust", "bash"] {
469 for forge in ["github", "gitlab"] {
470 for (checkout_mode, integration) in MODE_PAIRS {
471 for style in [None, Some(Style::Trunk), Some(Style::Lines)] {
472 for ((nix, scorecard), code_scanning) in [
473 ((false, false), None),
474 ((false, true), Some(Provider::Semgrep)),
475 ((true, false), Some(Provider::CodeQl)),
476 ((true, true), None),
477 ] {
478 let record = manifest::Manifest {
479 schema_version: manifest::SCHEMA_VERSION,
480 rk_version: "0.1.0".to_owned(),
481 origin: "init".to_owned(),
482 landed_at: "2026-08-29T00:00:00Z".to_owned(),
483 profile: ProfileSnapshot {
484 technologies: vec![tech.to_owned()],
485 forge: Some(forge.to_owned()),
486 release: ReleaseIntent {
487 mode: ReleaseMode::Automatic,
488 driver: Some(tech.to_owned()),
489 style,
490 line_prefix: Some(
491 crate::config::LINE_PREFIX_DEFAULT.to_owned(),
492 ),
493 },
494 },
495 git: GitWorkflow {
496 trunk: crate::config::TRUNK_DEFAULT.to_owned(),
497 checkout_mode,
498 integration,
499 },
500 capabilities: CapabilityRequests {
501 nix_packaging: nix,
502 reporting_policy: true,
503 scorecard,
504 code_scanning,
505 workflow_guards: Some(true),
506 },
507 parameters: manifest::Parameters {
508 repo: "acme/team/widget".to_owned(),
509 security_contact: String::new(),
510 security_response: crate::config::RESPONSE_DEFAULT.to_owned(),
511 required_check: "gate".to_owned(),
512 required_workflow: "ci".to_owned(),
513 },
514 files: Vec::new(),
515 pins: std::collections::BTreeMap::new(),
516 };
517 manifest::write(target, &record).expect("the record writes");
518 let loaded = manifest::load(target)
519 .expect("the record loads")
520 .expect("the record exists");
521 let params = Params::from_record(&loaded);
522 assert_eq!(params.driver(), Some(tech));
523 assert_eq!(params.forge(), Some(forge));
524 assert_eq!(params.repo(), "acme/team/widget");
525 assert_eq!(params.integration(), integration);
526 assert_eq!(params.style(), style);
527 assert_eq!(params.nix_packaging(), nix);
528 assert_eq!(params.scorecard(), scorecard);
529 assert_eq!(params.code_scanning(), code_scanning);
530 let mut direct = super::Params::for_test("acme/team/widget", style);
533 direct.set_pair_for_test(tech, forge);
534 direct.set_checkout_mode_for_test(checkout_mode);
535 direct.set_integration_for_test(integration);
536 direct.set_nix_for_test(nix);
537 direct.set_scorecard_for_test(scorecard);
538 direct.set_code_scanning_for_test(code_scanning);
539 assert_eq!(params, direct);
540 let projected = destinations(¶ms);
541 for block in
542 [AGENTS_DESTINATION, GLOSSARY_DESTINATION, HOOKS_DESTINATION]
543 {
544 assert!(projected.contains(&block.to_owned()), "{block}");
545 }
546 for destination in super::NIX_DESTINATIONS {
547 assert_eq!(
548 projected.contains(&destination.to_owned()),
549 nix && tech == "rust",
550 "{tech} {forge} nix={nix}: {destination}"
551 );
552 }
553 for destination in super::SCORECARD_DESTINATIONS {
557 assert_eq!(
558 projected.contains(&destination.to_owned()),
559 scorecard && forge == "github",
560 "{tech} {forge} scorecard={scorecard}: {destination}"
561 );
562 }
563 }
564 }
565 }
566 }
567 }
568 }
569
570 fn resolved_test_params(
571 tech: &str,
572 resolved: &super::Resolved,
573 checkout_mode: CheckoutMode,
574 style: Option<Style>,
575 nix: bool,
576 scorecard: bool,
577 code_scanning: Option<Provider>,
578 ) -> Result<super::Params, crate::error::RkError> {
579 let technologies = vec![tech.to_owned()];
580 super::Params::resolve(
581 camino::Utf8Path::new("."),
582 &super::Inputs {
583 technologies: &technologies,
584 forge: Some(&resolved.forge),
585 repo: resolved.repo.as_deref(),
586 release_mode: Some(ReleaseMode::Automatic),
587 release_driver: Some(tech),
588 style,
589 required_check: (resolved.forge == "github").then_some("gate"),
591 required_workflow: (resolved.forge == "github").then_some("ci"),
592 trunk: None,
593 checkout_mode: Some(checkout_mode),
594 integration: None,
595 nix: Some(nix),
596 reporting_policy: None,
597 scorecard: Some(scorecard),
598 code_scanning: Some(code_scanning),
599 workflow_guards: Some(true),
600 },
601 None,
602 None,
603 super::Purpose::Init,
604 )
605 }
606
607 #[test]
611 fn a_projection_renders_owned_files_and_keeps_seeded_judgment() {
612 let params = resolved_test_params(
613 "rust",
614 &super::Resolved {
615 forge: "github".to_owned(),
616 repo: Some("acme/widget".to_owned()),
617 },
618 CheckoutMode::MainWorktree,
619 Some(Style::Trunk),
620 false,
621 false,
622 None,
623 )
624 .expect("the parameters resolve");
625 let entries = Projection::compute(&ProjectionInput {
626 params,
627 evidence: TargetEvidence::default(),
628 })
629 .expect("the pair projects")
630 .candidates;
631 let workflow = entries
632 .iter()
633 .find(|entry| entry.destination.ends_with("release-plz.yml"))
634 .expect("the workflow projects");
635 assert_eq!(workflow.kind, Kind::Rendered);
636 let text = String::from_utf8_lossy(&workflow.bytes);
637 assert!(!text.contains("OWNER"), "an owner token survived rendering");
638 assert!(text.contains("'acme'"));
639 assert!(!text.contains("TODO(release-kit)"));
640 let title = entries
641 .iter()
642 .find(|entry| entry.destination.ends_with("pr-title.yml"))
643 .expect("the title check projects");
644 let text = String::from_utf8_lossy(&title.bytes);
645 assert!(text.contains(SCOPE_SHAPE), "{text}");
646 assert!(
647 !text.contains("RK_SCOPE_SHAPE"),
648 "a scope token survived: {text}"
649 );
650 let seeded = entries
651 .iter()
652 .find(|entry| entry.destination == "release-plz.toml")
653 .expect("the seeded file projects");
654 assert_eq!(seeded.kind, Kind::Seeded);
655 let authored = embedded::SNIPPETS
656 .get_file("rust/github/release-plz.toml")
657 .expect("the seed ships")
658 .contents();
659 assert_eq!(seeded.bytes, authored, "a seeded file lands as authored");
660 assert!(String::from_utf8_lossy(&seeded.bytes).contains("TODO(release-kit)"));
661 for block in BLOCK_DESTINATIONS {
662 let entry = entries
663 .iter()
664 .find(|entry| entry.destination == block)
665 .expect("every block is part of the projection");
666 let text = String::from_utf8_lossy(&entry.bytes);
667 assert!(
668 !text.contains("RK_SCOPE_SHAPE"),
669 "{block} kept a token: {text}"
670 );
671 }
672 }
673
674 #[test]
679 fn the_nix_destinations_project_only_under_the_opt_in() {
680 use super::NIX_DESTINATIONS;
681 let paths = |nix: bool, forge: &str| -> Vec<String> {
682 destinations(
683 &resolved_test_params(
684 "rust",
685 &super::Resolved {
686 forge: forge.to_owned(),
687 repo: Some("acme/widget".to_owned()),
688 },
689 CheckoutMode::LinkedWorktree,
690 Some(Style::Trunk),
691 nix,
692 false,
693 None,
694 )
695 .expect("the parameters resolve"),
696 )
697 };
698 let off = paths(false, "github");
699 for destination in NIX_DESTINATIONS {
700 assert!(!off.contains(&destination.to_owned()), "{destination}");
701 }
702 let on = paths(true, "github");
703 for destination in ["nix/package.nix", "flake.nix", "flake.lock"] {
704 assert!(on.contains(&destination.to_owned()), "{destination}");
705 }
706 let gitlab = paths(true, "gitlab");
711 assert!(gitlab.contains(&"nix/package.nix".to_owned()));
712 assert!(
713 !on.iter()
714 .chain(gitlab.iter())
715 .any(|destination| destination.contains("nix.yml"))
716 );
717 let bash = destinations(
718 &resolved_test_params(
719 "bash",
720 &super::Resolved {
721 forge: "github".to_owned(),
722 repo: Some("acme/widget".to_owned()),
723 },
724 CheckoutMode::LinkedWorktree,
725 Some(Style::Trunk),
726 true,
727 false,
728 None,
729 )
730 .expect("the parameters resolve"),
731 );
732 assert!(
733 bash.iter()
734 .all(|destination| !NIX_DESTINATIONS.contains(&destination.as_str()))
735 );
736 }
737
738 #[test]
743 fn the_nix_seeds_are_identical_across_forge_pairs() {
744 for name in ["nix/package.nix", "flake.nix", "flake.lock"] {
745 let github = embedded::SNIPPETS
746 .get_file(format!("rust/github/{name}"))
747 .expect("the github copy ships")
748 .contents();
749 let gitlab = embedded::SNIPPETS
750 .get_file(format!("rust/gitlab/{name}"))
751 .expect("the gitlab copy ships")
752 .contents();
753 assert_eq!(github, gitlab, "{name} diverged between the pairs");
754 }
755 }
756
757 #[test]
762 fn the_nix_withhold_judgment_covers_the_three_shapes() {
763 use super::NIX_DESTINATIONS;
764 let dir = tempfile::tempdir().expect("a scratch target exists");
765 let target = camino::Utf8Path::from_path(dir.path()).expect("utf-8 path");
766 let project = |nix: bool| {
767 let params = resolved_test_params(
768 "rust",
769 &super::Resolved {
770 forge: "github".to_owned(),
771 repo: Some("acme/widget".to_owned()),
772 },
773 CheckoutMode::LinkedWorktree,
774 Some(Style::Trunk),
775 nix,
776 false,
777 None,
778 )
779 .expect("the parameters resolve");
780 let evidence = TargetEvidence::gather(target, None).expect("the evidence reads");
781 Projection::compute(&ProjectionInput { params, evidence }).expect("the pair projects")
782 };
783 let withheld = |projection: &Projection| -> Vec<String> {
784 projection
785 .omissions
786 .iter()
787 .map(|omission| omission.destination.clone())
788 .collect()
789 };
790 let landed = |projection: &Projection, destination: &str| {
791 projection
792 .candidates
793 .iter()
794 .any(|candidate| candidate.destination == destination)
795 };
796
797 let all = project(true);
799 assert_eq!(
800 withheld(&all),
801 ["flake.lock", "flake.nix", "nix/package.nix"]
802 );
803 assert!(
804 all.candidates
805 .iter()
806 .all(|entry| !NIX_DESTINATIONS.contains(&entry.destination.as_str()))
807 );
808
809 std::fs::write(
812 target.join("Cargo.toml"),
813 "[package]\nname = \"widget\"\nversion = \"0.1.0\"\n",
814 )
815 .expect("the crate manifest writes");
816 std::fs::write(target.join("Cargo.lock"), "version = 4\n").expect("the lock writes");
817 std::fs::create_dir_all(target.join("src")).expect("the src dir exists");
818 std::fs::write(target.join("src/main.rs"), "fn main() {}\n").expect("the main writes");
819 std::fs::write(target.join("flake.nix"), "{ }\n").expect("the flake writes");
820 let all = project(true);
821 assert_eq!(withheld(&all), ["flake.lock", "flake.nix"]);
822 assert!(landed(&all, "nix/package.nix"));
823
824 std::fs::remove_file(target.join("flake.nix")).expect("the flake removes");
826 let all = project(true);
827 assert!(all.omissions.is_empty());
828 assert!(landed(&all, "flake.nix"));
829
830 let all = project(false);
832 assert!(all.omissions.is_empty());
833 assert!(!landed(&all, "flake.nix"));
834 }
835
836 #[test]
840 fn the_glossary_splices_into_every_shape() {
841 let owned = glossary_block();
842 let block = owned.as_str();
843
844 let fresh = spliced(None, block);
845 assert_eq!(fresh, format!("{block}\n"));
846 assert_eq!(extract_block(&fresh, BLOCK_BEGIN, BLOCK_END), Some(block));
847
848 let own = "# Glossary\n\n- `spike` — a throwaway branch.\n";
849 let appended = spliced(Some(own), block);
850 assert!(appended.starts_with(own));
851 assert_eq!(
852 extract_block(&appended, BLOCK_BEGIN, BLOCK_END),
853 Some(block)
854 );
855
856 let stale = appended.replace("full-implement", "do-everything");
857 let refreshed = spliced(Some(&stale), block);
858 assert_eq!(
859 extract_block(&refreshed, BLOCK_BEGIN, BLOCK_END),
860 Some(block)
861 );
862 assert_eq!(
863 refreshed.matches("BEGIN release-kit").count(),
864 1,
865 "a re-splice must replace, not accumulate"
866 );
867 }
868
869 #[test]
873 fn the_glossary_leaves_the_targets_region_alone() {
874 let owned = glossary_block();
875 let block = owned.as_str();
876 let below = "\n## Our own terms\n\n- `spike` — a throwaway branch, never merged.\n";
877 let landed = format!("{block}\n{below}");
878
879 let refreshed = spliced(Some(&landed), block);
880 assert!(
881 refreshed.ends_with(below),
882 "the target's own region changed: {refreshed}"
883 );
884 assert_eq!(
885 extract_block(&refreshed, BLOCK_BEGIN, BLOCK_END),
886 Some(block)
887 );
888 }
889
890 #[test]
894 fn an_append_rewrites_no_byte_the_target_wrote() {
895 let owned = glossary_block();
896 let block = owned.as_str();
897 for own in [
898 "# Glossary\n\n- `spike` — throwaway. \n\n\n",
899 "# Glossary\n\n- `spike` — throwaway.",
900 "# Glossary\r\n\r\n- `spike` — throwaway.\r\n",
901 ] {
902 let appended = spliced(Some(own), block);
903 assert!(
904 appended.starts_with(own),
905 "the target's bytes changed: {appended:?}"
906 );
907 assert_eq!(
908 extract_block(&appended, BLOCK_BEGIN, BLOCK_END),
909 Some(block),
910 "{appended:?}"
911 );
912 let marker = appended.find(BLOCK_BEGIN).expect("the block landed");
913 assert!(
914 appended[..marker].ends_with('\n'),
915 "the block must open its own line: {appended:?}"
916 );
917 }
918 }
919
920 #[test]
924 fn a_splice_decodes_no_byte_the_target_wrote() {
925 let owned = glossary_block();
926 let block = owned.as_str();
927
928 let own = b"# Glossary\n\ncaf\xe9\n";
930 let appended = splice_marked_block(Some(own), block);
931 assert!(
932 appended.starts_with(own),
933 "the target's bytes changed: {appended:?}"
934 );
935 assert!(!appended.contains(&0xEF), "a replacement character landed");
936
937 let mut landed = Vec::new();
939 landed.extend_from_slice(block.replace("full-implement", "do-everything").as_bytes());
940 landed.extend_from_slice(b"\n\ncaf\xe9\n");
941 let refreshed = splice_marked_block(Some(&landed), block);
942 assert!(
943 refreshed.ends_with(b"\n\ncaf\xe9\n"),
944 "the target's region below the markers changed: {refreshed:?}"
945 );
946 assert!(refreshed.starts_with(block.as_bytes()), "{refreshed:?}");
947 }
948
949 #[test]
952 fn the_glossary_block_carries_no_parameter() {
953 let block = glossary_block();
954 assert!(block.starts_with(BLOCK_BEGIN), "{block}");
955 assert!(block.ends_with(BLOCK_END), "{block}");
956 assert!(!block.contains("RK_"), "a token survived: {block}");
957 assert!(!block.contains("OWNER"), "an owner token survived: {block}");
958 for term in [
959 "implement-and-request",
960 "implement-and-merge",
961 "full-implement",
962 ] {
963 assert!(block.contains(term), "{term} is missing from {block}");
964 }
965 assert!(
966 routing_block(true).contains(GLOSSARY_DESTINATION),
967 "the routing block must name the destination it indexes"
968 );
969 assert!(
970 !routing_block(false).contains(GLOSSARY_DESTINATION),
971 "a target without the workflow guards lands no glossary to route to"
972 );
973 }
974
975 #[test]
976 fn the_block_splices_into_every_agents_shape() {
977 let owned = routing_block(false);
978 let block = owned.as_str();
979 let fresh = spliced(None, block);
980 assert_eq!(fresh, format!("{block}\n"));
981 assert_eq!(extract_block(&fresh, BLOCK_BEGIN, BLOCK_END), Some(block));
982
983 let appended = spliced(Some("# My project\n\nOwn rules.\n"), block);
984 assert!(appended.starts_with("# My project\n\nOwn rules.\n\n<!-- BEGIN release-kit -->"));
985 assert_eq!(
986 extract_block(&appended, BLOCK_BEGIN, BLOCK_END),
987 Some(block)
988 );
989
990 let stale = appended.replace("Never author a tag", "Do author a tag");
991 let refreshed = spliced(Some(&stale), block);
992 assert_eq!(
993 extract_block(&refreshed, BLOCK_BEGIN, BLOCK_END),
994 Some(block)
995 );
996 assert!(refreshed.starts_with("# My project"));
997 assert_eq!(
998 refreshed.matches("BEGIN release-kit").count(),
999 1,
1000 "a re-splice must replace, not accumulate"
1001 );
1002 }
1003
1004 #[test]
1007 fn the_hook_block_splices_under_repos() {
1008 let owned = hooks_block(CheckoutMode::MainWorktree);
1009 let block = owned.as_str();
1010 let fresh = splice_hooks_block(None, block).expect("a fresh file splices");
1011 assert!(fresh.starts_with(HOOK_TYPES_LINE));
1012 assert!(fresh.contains("\nrepos:\n# BEGIN release-kit\n"));
1013 assert_eq!(extract_block(&fresh, HOOKS_BEGIN, HOOKS_END), Some(block));
1014
1015 let own =
1016 "repos:\n - repo: https://example.com/own\n rev: v1\n hooks:\n - id: own\n";
1017 let spliced = splice_hooks_block(Some(own), block).expect("an unmarked file splices");
1018 assert!(spliced.starts_with("repos:\n# BEGIN release-kit\n"));
1019 assert!(spliced.contains("- id: own"), "the target's hooks survive");
1020 assert!(
1021 !spliced.contains(HOOK_TYPES_LINE),
1022 "an existing file's top level is the skills' duty, not the splice's"
1023 );
1024
1025 let stale = spliced.replace("--force-scope", "--no-scope");
1026 let refreshed = splice_hooks_block(Some(&stale), block).expect("a marked file re-splices");
1027 assert_eq!(
1028 extract_block(&refreshed, HOOKS_BEGIN, HOOKS_END),
1029 Some(block)
1030 );
1031 assert_eq!(refreshed.matches(HOOKS_BEGIN).count(), 1);
1032
1033 let err = splice_hooks_block(Some("minimum_pre_commit_version: '3.2.0'\n"), block)
1034 .expect_err("no repos: line refuses");
1035 assert!(err.contains("repos:"), "{err}");
1036
1037 let doubled = format!("repos:\n{block}\n{block}\n");
1041 let err = splice_hooks_block(Some(&doubled), block).expect_err("a second block refuses");
1042 assert!(err.contains("one block"), "{err}");
1043 let unmatched = "repos:\n# BEGIN release-kit\n - repo: local\n";
1044 let err =
1045 splice_hooks_block(Some(unmatched), block).expect_err("an unmatched marker refuses");
1046 assert!(err.contains("unmatched"), "{err}");
1047 }
1048
1049 #[test]
1055 fn the_blocks_render_per_mode_and_carry_the_one_grammar() {
1056 let worktree_hooks = hooks_block(CheckoutMode::LinkedWorktree);
1057 let branches_hooks = hooks_block(CheckoutMode::MainWorktree);
1058 assert!(worktree_hooks.contains("- id: rk-worktree-location"));
1059 assert!(
1060 worktree_hooks.contains("SKIP=no-commit-to-branch,rk-worktree-location"),
1061 "{worktree_hooks}"
1062 );
1063 assert!(!branches_hooks.contains("rk-worktree-location"));
1064 assert!(branches_hooks.contains("SKIP=no-commit-to-branch in"));
1065 for block in [&worktree_hooks, &branches_hooks] {
1066 assert!(block.contains(BRANCH_GRAMMAR), "the grammar has one owner");
1067 for token in [
1068 "RK_BRANCH_GRAMMAR",
1069 "RK_SWEEP_SKIP",
1070 "RK_SWEEP_NOTE",
1071 "RK_WORKTREE_GUARD",
1072 "RK_TRUNK_COMMIT_GUARD",
1073 "RK_TRUNK_PUSH_GUARD",
1074 ] {
1075 assert!(!block.contains(token), "{token} survived: {block}");
1076 }
1077 }
1078 for block in [&worktree_hooks, &branches_hooks] {
1083 for line in block.lines() {
1084 if let Some(value) = line.trim_start().strip_prefix("entry: ") {
1085 assert!(
1086 !value.contains(": "),
1087 "an entry value breaks the YAML plain scalar: {line}"
1088 );
1089 }
1090 }
1091 }
1092 let guard_line = worktree_hooks
1093 .lines()
1094 .position(|line| line.contains("id: rk-worktree-location"))
1095 .expect("the guard entry exists");
1096 let name_line = worktree_hooks
1097 .lines()
1098 .position(|line| line.contains("id: rk-branch-name"))
1099 .expect("the name hook exists");
1100 assert!(
1101 guard_line > name_line,
1102 "the guard lands directly after rk-branch-name"
1103 );
1104 }
1105
1106 #[test]
1111 fn the_routing_block_adds_only_the_policy_lines_under_the_guards() {
1112 let guarded = routing_block(true);
1113 let plain = routing_block(false);
1114 for block in [&guarded, &plain] {
1115 for token in ["RK_AGENT_POLICY", "RK_COMMIT_POLICY"] {
1116 assert!(!block.contains(token), "{token} survived: {block}");
1117 }
1118 for kept in [
1119 "runs the release-kit convention",
1120 "MUST be a scoped Conventional Commit",
1121 "Never author a tag",
1122 "Run `rk status` before changing",
1123 "`rk method --list`",
1124 ] {
1125 assert!(block.contains(kept), "{kept}: {block}");
1126 }
1127 for gone in [
1128 "`rk integrate <branch>`",
1129 "squash-merged pull request",
1130 "`rk issue start <issue>`",
1131 "`rk worktree add <branch>`",
1132 "Branches are worked in the main checkout",
1133 ] {
1134 assert!(!block.contains(gone), "{gone}: {block}");
1135 }
1136 }
1137 assert!(guarded.contains("guides and never drives"), "{guarded}");
1138 assert!(guarded.contains("`GLOSSARY.md`"), "{guarded}");
1139 assert!(guarded.contains("Every commit follows the same scoped convention"));
1140 assert!(!plain.contains("guides and never drives"), "{plain}");
1141 assert!(!plain.contains("Every commit follows"), "{plain}");
1142 let mut guarded_lines = guarded.lines();
1145 for line in plain.lines() {
1146 assert!(
1147 guarded_lines.any(|other| other == line),
1148 "the guards changed a line the plain block carries: {line}"
1149 );
1150 }
1151 }
1152
1153 #[test]
1157 fn the_hook_block_without_the_guards_keeps_the_release_hooks_alone() {
1158 for mode in [CheckoutMode::LinkedWorktree, CheckoutMode::MainWorktree] {
1159 for integration in [Integration::Forge, Integration::Local] {
1160 let block = unguarded_hooks_block(mode, integration);
1161 for kept in ["- id: rk-no-hand-authored-tag", "- id: rk-status-check"] {
1162 assert!(block.contains(kept), "{kept}: {block}");
1163 }
1164 for gone in [
1165 "conventional-pre-commit",
1166 "rk-message",
1167 "rk-branch-name",
1168 "rk-worktree-location",
1169 "rk-no-push-to-trunk",
1170 "no-commit-to-branch",
1171 ] {
1172 assert!(!block.contains(gone), "{gone}: {block}");
1173 }
1174 assert!(block.contains("A CI sweep needs no SKIP here"), "{block}");
1175 for token in [
1176 "RK_MESSAGE_GUARDS",
1177 "RK_BRANCH_NAME_GUARD",
1178 "RK_WORKTREE_GUARD",
1179 "RK_TRUNK_COMMIT_GUARD",
1180 "RK_TRUNK_PUSH_GUARD",
1181 "RK_SWEEP_NOTE",
1182 ] {
1183 assert!(!block.contains(token), "{token} survived: {block}");
1184 }
1185 assert_eq!(
1186 block.contains("--hook-stage manual"),
1187 integration == Integration::Local,
1188 "{block}"
1189 );
1190 }
1191 }
1192 }
1193
1194 #[test]
1204 fn the_integration_mode_decides_which_trunk_guards_render() {
1205 for mode in [CheckoutMode::LinkedWorktree, CheckoutMode::MainWorktree] {
1206 let forge = hooks_block_for(mode, Integration::Forge);
1207 let local = hooks_block_for(mode, Integration::Local);
1208 assert!(forge.contains("- id: no-commit-to-branch"), "{forge}");
1209 assert!(forge.contains("- id: rk-no-push-to-trunk"), "{forge}");
1210 assert!(!local.contains("no-commit-to-branch"), "{local}");
1211 assert!(!local.contains("rk-no-push-to-trunk"), "{local}");
1212 for kept in [
1214 "- id: conventional-pre-commit",
1215 "- id: rk-message",
1216 "- id: rk-branch-name",
1217 "- id: rk-no-hand-authored-tag",
1218 "- id: rk-status-check",
1219 ] {
1220 assert!(forge.contains(kept), "{kept}: {forge}");
1221 assert!(local.contains(kept), "{kept}: {local}");
1222 }
1223 let located = mode == CheckoutMode::LinkedWorktree;
1226 assert_eq!(forge.contains("- id: rk-worktree-location"), located);
1227 assert_eq!(local.contains("- id: rk-worktree-location"), located);
1228 assert!(
1230 local.contains("pre-commit run --hook-stage manual --all-files"),
1231 "{local}"
1232 );
1233 assert!(!forge.contains("--hook-stage manual"), "{forge}");
1234 for token in [
1235 "RK_TRUNK_COMMIT_GUARD",
1236 "RK_TRUNK_PUSH_GUARD",
1237 "RK_SWEEP_NOTE",
1238 ] {
1239 assert!(!local.contains(token), "{token} survived: {local}");
1240 assert!(!forge.contains(token), "{token} survived: {forge}");
1241 }
1242 }
1243 assert!(
1245 hooks_block_for(CheckoutMode::LinkedWorktree, Integration::Local)
1246 .contains("SKIP=rk-worktree-location in")
1247 );
1248 assert!(
1249 hooks_block_for(CheckoutMode::MainWorktree, Integration::Local)
1250 .contains("A CI sweep needs no SKIP here")
1251 );
1252 }
1253
1254 #[test]
1260 fn a_landed_sweep_note_invites_the_projects_own_skips() {
1261 let with_skip = hooks_block_for(CheckoutMode::LinkedWorktree, Integration::Local);
1262 assert!(
1263 with_skip.contains("SKIP=rk-worktree-location in"),
1264 "{with_skip}"
1265 );
1266 assert!(with_skip.contains("local-only"), "{with_skip}");
1267 assert!(with_skip.contains("the value is a list the"), "{with_skip}");
1268
1269 let without = hooks_block_for(CheckoutMode::MainWorktree, Integration::Local);
1270 assert!(
1271 without.contains("A CI sweep needs no SKIP here"),
1272 "{without}"
1273 );
1274 assert!(without.contains("local-only"), "{without}");
1275 }
1276
1277 #[test]
1283 fn a_landed_integrate_note_names_both_axes() {
1284 for mode in [CheckoutMode::LinkedWorktree, CheckoutMode::MainWorktree] {
1285 let local = hooks_block_for(mode, Integration::Local);
1286 assert!(
1287 local.contains("pre-commit run --hook-stage manual --all-files"),
1288 "{local}"
1289 );
1290 assert!(
1291 local.contains("continuous integration invoke the same stages"),
1292 "{local}"
1293 );
1294 assert!(
1295 local.contains("guards one side alone"),
1296 "the note states the consequence: {local}"
1297 );
1298 let forge = hooks_block_for(mode, Integration::Forge);
1300 assert!(!forge.contains("--hook-stage manual"), "{forge}");
1301 }
1302 }
1303
1304 #[test]
1308 fn the_hook_marker_defects_are_named() {
1309 use super::hooks_marker_defect;
1310 let owned = hooks_block(CheckoutMode::MainWorktree);
1311 let block = owned.as_str();
1312 assert_eq!(hooks_marker_defect(""), None);
1313 assert_eq!(hooks_marker_defect(&format!("repos:\n{block}\n")), None);
1314 for (case, text) in [
1315 (
1316 "a second begin",
1317 format!("repos:\n{block}\n# BEGIN release-kit\n"),
1318 ),
1319 (
1320 "a second end",
1321 format!("repos:\n{block}\n# END release-kit\n"),
1322 ),
1323 (
1324 "an unpaired begin",
1325 "repos:\n# BEGIN release-kit\n".to_owned(),
1326 ),
1327 ("an unpaired end", "repos:\n# END release-kit\n".to_owned()),
1328 (
1329 "an end before its begin",
1330 "repos:\n# END release-kit\n# BEGIN release-kit\n".to_owned(),
1331 ),
1332 ] {
1333 assert!(
1334 hooks_marker_defect(&text).is_some(),
1335 "{case} must be a defect"
1336 );
1337 }
1338 }
1339}