1use std::path::{Path, PathBuf};
16use std::sync::Arc;
17
18use agentplane::model::ModelProvider;
19use serde::{Deserialize, Serialize};
20use serde_json::{Value, json};
21use speccoder_core::acceptance::{Decided, PreFrozenAcceptance, Producer, SealedRef, VisibleTest};
22use speccoder_core::actions::Via;
23use speccoder_core::context::{ContextEntry, ContextKind};
24use speccoder_core::ladder::Rung;
25use speccoder_core::oracle::{
26 Ambiguity, AuthoredBy, Expectation, HeldOutSummary, OracleDiscarded, OracleOp, OracleRejected,
27 OracleState, OracleTest, OracleView, Reading, Resolution, Untestable,
28};
29use speccoder_core::snapshot::ProjectSnapshot;
30use speccoder_core::verify::{RedClass, classify_red};
31use speccoder_core::{CommandData, CommandResult, CommandStatus};
32
33use crate::format::{Adapter, OracleRequirement};
34use crate::integrity::sha256_hex;
35use crate::{sandbox, substrate, tools, worktree};
36
37pub const DIR: &str = "oracle";
39
40pub const LIMIT: usize = 4;
42
43#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
45pub struct Draft {
46 pub requirement: DraftRequirement,
48 pub samples: u8,
50 pub tests: Vec<DraftTest>,
52 pub discarded: Vec<OracleDiscarded>,
54 pub rejected: Vec<OracleRejected>,
56 pub expectations: Samples<Expectation>,
58 pub untestable: Samples<Untestable>,
60 pub ambiguities: Vec<Ambiguity>,
62 pub held_out: HeldOutSummary,
64 pub sealed: Option<SealedRef>,
66 pub notes: Vec<String>,
68 pub runs: Vec<String>,
70 pub context: Vec<ContextEntry>,
73}
74
75#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
77pub struct DraftRequirement {
78 pub key: String,
80 pub title: String,
82 pub text: String,
84 pub sha256: String,
86}
87
88#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
90pub struct DraftTest {
91 pub path: String,
93 pub sha256: String,
95 pub scenarios: Vec<String>,
97 pub argv: Vec<String>,
99 pub red_class: RedClass,
101 pub authored_by: AuthoredBy,
103 pub edited_by: Option<String>,
105}
106
107#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
109#[serde(bound(deserialize = "T: Deserialize<'de>"))]
110pub struct Samples<T> {
111 pub sample1: Vec<T>,
113 pub sample2: Vec<T>,
115}
116
117impl<T> Default for Samples<T> {
118 fn default() -> Self {
119 Self {
120 sample1: Vec::new(),
121 sample2: Vec::new(),
122 }
123 }
124}
125
126#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
128pub struct OracleEntry {
129 pub requirement_sha256: String,
131 pub manifest_sha256: String,
133 #[serde(default, skip_serializing_if = "Option::is_none")]
135 pub held_out_sha256: Option<String>,
136 pub by: String,
138 pub via: Via,
140 pub at: u64,
142}
143
144#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
147pub struct Frozen {
148 pub requirement_sha256: String,
150 pub wording: String,
152 pub manifest_sha256: String,
154 pub tests: Vec<FrozenTest>,
156}
157
158#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
160pub struct FrozenTest {
161 pub path: String,
163 pub sha256: String,
165 pub argv: Vec<String>,
167 pub scenarios: Vec<String>,
169}
170
171pub type Loaded = (Draft, Vec<(String, String)>);
173
174type Kept = (String, String, Vec<String>, Vec<String>);
176
177#[derive(Debug, Clone, PartialEq, Eq)]
179pub struct Tampered(pub String);
180
181fn slug(key: &str) -> String {
182 key.chars()
183 .map(|c| {
184 if c.is_ascii_alphanumeric() || matches!(c, '-' | '_' | '.') {
185 c
186 } else {
187 '_'
188 }
189 })
190 .collect()
191}
192
193#[must_use]
195pub fn dir(project_state: &Path, unit: &str, key: &str) -> PathBuf {
196 project_state.join(DIR).join(unit).join(slug(key))
197}
198
199fn now() -> u64 {
200 std::time::SystemTime::now()
201 .duration_since(std::time::UNIX_EPOCH)
202 .map_or(0, |d| d.as_secs())
203}
204
205fn digest_of(text: &str) -> String {
206 format!("sha256:{}", sha256_hex(text.as_bytes()))
207}
208
209fn write_atomic(file: &Path, text: &str) -> Result<(), String> {
210 if let Some(parent) = file.parent() {
211 std::fs::create_dir_all(parent).map_err(|e| format!("{}: {e}", parent.display()))?;
212 }
213 let tmp = file.with_extension("json.tmp");
214 std::fs::write(&tmp, text).map_err(|e| format!("{}: {e}", tmp.display()))?;
215 std::fs::rename(&tmp, file).map_err(|e| format!("{}: {e}", file.display()))
216}
217
218pub fn store(
221 project_state: &Path,
222 unit: &str,
223 draft: &Draft,
224 contents: &[(String, String)],
225) -> Result<(), String> {
226 let d = dir(project_state, unit, &draft.requirement.key);
227 let _ = std::fs::remove_dir_all(d.join("files"));
228 for t in &draft.tests {
229 let content = contents
230 .iter()
231 .find(|(p, _)| *p == t.path)
232 .map(|(_, c)| c)
233 .ok_or_else(|| format!("{} has no content", t.path))?;
234 if digest_of(content) != t.sha256 {
235 return Err(format!("{} does not match its digest", t.path));
236 }
237 let file = d.join("files").join(&t.path);
238 if let Some(parent) = file.parent() {
239 std::fs::create_dir_all(parent).map_err(|e| format!("{}: {e}", parent.display()))?;
240 }
241 std::fs::write(&file, content).map_err(|e| format!("{}: {e}", file.display()))?;
242 }
243 let text = serde_json::to_string_pretty(draft).map_err(|e| e.to_string())?;
244 write_atomic(&d.join("draft.json"), &text)
245}
246
247pub fn load(project_state: &Path, unit: &str, key: &str) -> Result<Option<Loaded>, Tampered> {
250 let d = dir(project_state, unit, key);
251 let Ok(text) = std::fs::read_to_string(d.join("draft.json")) else {
252 return Ok(None);
253 };
254 let draft: Draft = serde_json::from_str(&text)
255 .map_err(|e| Tampered(format!("the oracle draft of {key} is not valid: {e}")))?;
256 let mut contents = Vec::new();
257 for t in &draft.tests {
258 let content = std::fs::read_to_string(d.join("files").join(&t.path))
259 .map_err(|_| Tampered(format!("the test {} of {key} is missing", t.path)))?;
260 if digest_of(&content) != t.sha256 {
261 return Err(Tampered(format!("the test {} of {key} changed", t.path)));
262 }
263 contents.push((t.path.clone(), content));
264 }
265 Ok(Some((draft, contents)))
266}
267
268#[must_use]
270pub fn load_frozen(project_state: &Path, unit: &str, key: &str) -> Option<Frozen> {
271 std::fs::read_to_string(dir(project_state, unit, key).join("frozen.json"))
272 .ok()
273 .and_then(|t| serde_json::from_str(&t).ok())
274}
275
276#[must_use]
279pub fn manifest_digest<'a>(
280 tests: impl IntoIterator<Item = (&'a str, &'a str, &'a [String])>,
281) -> String {
282 let mut lines: Vec<String> = tests
283 .into_iter()
284 .map(|(path, sha, argv)| {
285 format!(
286 "{path}={sha} argv={}",
287 serde_json::to_string(argv).unwrap_or_default()
288 )
289 })
290 .collect();
291 lines.sort();
292 digest_of(&lines.join("\n"))
293}
294
295impl Draft {
296 pub fn red(&self) -> impl Iterator<Item = &DraftTest> {
298 self.tests.iter().filter(|t| t.red_class.is_red())
299 }
300
301 #[must_use]
303 pub fn manifest(&self) -> Option<String> {
304 let red: Vec<&DraftTest> = self.red().collect();
305 (!red.is_empty()).then(|| {
306 manifest_digest(
307 red.iter()
308 .map(|t| (t.path.as_str(), t.sha256.as_str(), t.argv.as_slice())),
309 )
310 })
311 }
312
313 pub fn open_ambiguities(&self) -> impl Iterator<Item = &Ambiguity> {
315 self.ambiguities.iter().filter(|a| a.open())
316 }
317
318 fn all_notes(&self) -> Vec<String> {
320 self.rejected
321 .iter()
322 .map(|r| format!("Rejected `{}`: {}", r.path, r.reason))
323 .chain(self.notes.iter().cloned())
324 .collect()
325 }
326}
327
328#[derive(Debug, Clone, Copy)]
330pub struct ViewConfig {
331 pub samples: u8,
333 pub strength_target: Option<u8>,
335 pub held_out: bool,
337 pub acceptance: bool,
339}
340
341impl ViewConfig {
342 #[must_use]
344 pub fn at(root: &Path) -> Self {
345 let rc = crate::verify::find_config(root)
346 .and_then(|d| std::fs::read_to_string(d.join(crate::verify::config::FILE)).ok())
347 .and_then(|t| substrate::run_config::parse(&t).ok())
348 .unwrap_or_default();
349 Self::of(&rc)
350 }
351
352 #[must_use]
354 pub fn of(rc: &substrate::run_config::RunConfig) -> Self {
355 Self {
356 samples: rc.oracle_samples,
357 strength_target: rc.strength.min.map(|m| {
358 let percent = (m * 100.0).round().clamp(0.0, 100.0);
360 format!("{percent:.0}").parse().unwrap_or(0)
361 }),
362 held_out: rc.held_out,
363 acceptance: rc.acceptance,
364 }
365 }
366}
367
368fn test_view(t: &DraftTest, content: &str) -> OracleTest {
369 OracleTest {
370 path: t.path.clone(),
371 content: content.to_owned(),
372 scenarios: t.scenarios.clone(),
373 red_class: crate::pipeline::class_word(t.red_class),
374 red: t.red_class.is_red(),
375 authored_by: t.authored_by,
376 edited_by: t.edited_by.clone(),
377 }
378}
379
380#[must_use]
384pub fn view(
385 project_state: &Path,
386 unit: &str,
387 req: &OracleRequirement,
388 entry: Option<&OracleEntry>,
389 cfg: ViewConfig,
390) -> OracleView {
391 let digest = req.digest();
392 let mut v = OracleView {
393 req: req.key.clone(),
394 title: req.title.clone(),
395 scenarios: req.scenarios.clone(),
396 state: OracleState::None,
397 frozen_on: None,
398 frozen_by: None,
399 frozen_at: None,
400 tests: Vec::new(),
401 discarded: Vec::new(),
402 rejected: Vec::new(),
403 uncovered: req.scenarios.iter().map(|s| s.id.clone()).collect(),
404 untestable: Vec::new(),
405 ambiguities: Vec::new(),
406 held_out: HeldOutSummary {
407 state: if cfg.held_out { "absent" } else { "off" }.to_owned(),
408 count: 0,
409 manifest_sha256: None,
410 reason: None,
411 discarded: Vec::new(),
412 },
413 strength_target: cfg.strength_target,
414 calls: cfg.samples,
415 ambiguity_check: cfg.samples >= 2,
416 manifest_sha256: None,
417 error: (!cfg.acceptance)
418 .then(|| "acceptance tests are off ([acceptance] generate = false)".to_owned()),
419 };
420 let loaded = load(project_state, unit, &req.key);
421 let draft = match loaded {
422 Ok(d) => d,
423 Err(t) => {
424 v.state = OracleState::Failed;
425 v.error = Some(t.0);
426 None
427 }
428 };
429 let current = draft
430 .as_ref()
431 .filter(|(d, _)| d.requirement.sha256 == digest);
432 if let Some((d, contents)) = current {
433 let content = |p: &str| {
434 contents
435 .iter()
436 .find(|(q, _)| q == p)
437 .map(|(_, c)| c.as_str())
438 .unwrap_or_default()
439 };
440 v.tests = d
441 .tests
442 .iter()
443 .map(|t| test_view(t, content(&t.path)))
444 .collect();
445 v.discarded.clone_from(&d.discarded);
446 v.rejected.clone_from(&d.rejected);
447 v.untestable.clone_from(&d.untestable.sample1);
448 v.ambiguities.clone_from(&d.ambiguities);
449 v.held_out = if cfg.held_out {
450 d.held_out.clone()
451 } else {
452 HeldOutSummary {
453 state: "off".to_owned(),
454 count: 0,
455 manifest_sha256: None,
456 reason: None,
457 discarded: Vec::new(),
458 }
459 };
460 v.manifest_sha256 = d.manifest();
461 let covered: Vec<&String> = d.red().flat_map(|t| t.scenarios.iter()).collect();
462 v.uncovered.retain(|s| !covered.contains(&s));
463 v.state = if d.open_ambiguities().next().is_some() {
464 OracleState::Ambiguous
465 } else if d.red().next().is_none() {
466 OracleState::NotRed
467 } else {
468 OracleState::Written
469 };
470 } else if draft.is_some() {
471 v.error = Some("written for an earlier wording: write them again".to_owned());
472 }
473 if let Some(e) = entry {
474 if e.requirement_sha256 == digest {
475 v.frozen_by = Some(e.by.clone());
476 v.frozen_at = Some(e.at);
477 v.state = match crate::pre_frozen::load(project_state, unit, &req.key) {
478 Ok(Some((rec, files))) => {
479 let drafted = current.map(|(d, _)| d);
482 v.tests = rec
483 .visible
484 .iter()
485 .map(|t| {
486 let same = drafted.and_then(|d| {
487 d.tests
488 .iter()
489 .find(|x| x.path == t.path && x.sha256 == t.sha256)
490 });
491 OracleTest {
492 path: t.path.clone(),
493 content: files
494 .iter()
495 .find(|(p, _)| *p == t.path)
496 .map(|(_, c)| c.clone())
497 .unwrap_or_default(),
498 scenarios: t.cites.clone(),
499 red_class: same.map_or_else(
500 || crate::pipeline::class_word(RedClass::Assertion),
501 |x| crate::pipeline::class_word(x.red_class),
502 ),
503 red: true,
504 authored_by: same.map_or(AuthoredBy::Model, |x| x.authored_by),
505 edited_by: same.and_then(|x| x.edited_by.clone()),
506 }
507 })
508 .collect();
509 v.manifest_sha256 = Some(e.manifest_sha256.clone());
510 let covered: Vec<&String> =
511 rec.visible.iter().flat_map(|t| t.cites.iter()).collect();
512 v.uncovered = req
513 .scenarios
514 .iter()
515 .map(|s| s.id.clone())
516 .filter(|s| !covered.contains(&s))
517 .collect();
518 if cfg.held_out {
519 v.held_out = match &rec.held_out_sealed {
520 Some(h) => HeldOutSummary {
521 state: "kept".to_owned(),
522 count: h.count,
523 manifest_sha256: Some(format!("sha256:{}", h.manifest_sha256)),
524 reason: None,
525 discarded: Vec::new(),
526 },
527 None => HeldOutSummary {
528 state: "absent".to_owned(),
529 count: 0,
530 manifest_sha256: None,
531 reason: Some("none_kept".to_owned()),
532 discarded: Vec::new(),
533 },
534 };
535 }
536 OracleState::Frozen
537 }
538 Ok(None) => OracleState::FrozenElsewhere,
539 Err(t) => {
540 v.error = Some(format!("the frozen set was tampered with: {}", t.0));
541 OracleState::Frozen
542 }
543 };
544 } else if current.is_none() {
545 v.state = OracleState::Lapsed;
546 v.frozen_on = load_frozen(project_state, unit, &req.key).map(|f| f.wording);
547 v.frozen_by = Some(e.by.clone());
548 v.frozen_at = Some(e.at);
549 }
550 } else if let Ok(Some((rec, _))) = crate::pre_frozen::load(project_state, unit, &req.key)
551 && rec.producer == Producer::Run
552 && rec.is_current(&digest)
553 {
554 v.state = OracleState::Frozen;
556 v.frozen_by = Some(rec.decided.by.clone());
557 v.frozen_at = Some(rec.decided.at);
558 }
559 v
560}
561
562pub fn open_ambiguities(
569 project_state: &Path,
570 unit: &str,
571 requirements: &[OracleRequirement],
572) -> Result<Vec<(String, String)>, Tampered> {
573 let mut out = Vec::new();
574 for r in requirements {
575 let Some((d, _)) = load(project_state, unit, &r.key)? else {
576 continue;
577 };
578 if d.requirement.sha256 != r.digest() {
579 continue;
580 }
581 out.extend(
582 d.open_ambiguities()
583 .map(|a| (d.requirement.key.clone(), a.scenario.clone())),
584 );
585 }
586 Ok(out)
587}
588
589#[must_use]
591pub fn rung(format: &dyn Adapter, root: &Path, unit: &str) -> Rung {
592 speccoder_core::ladder::rung_of(unit, &format.standing_units(root))
593}
594
595#[derive(Debug, Clone)]
597pub struct Request<'a> {
598 pub req: &'a str,
600 pub op: OracleOp,
602 pub path: Option<&'a str>,
604 pub scenario: Option<&'a str>,
606 pub reading: Option<Reading>,
608 pub text: Option<&'a str>,
610}
611
612impl Request<'_> {
613 #[must_use]
615 pub fn needs_model(&self) -> bool {
616 matches!(self.op, OracleOp::Write | OracleOp::Again)
617 || (self.op == OracleOp::Reading && self.reading == Some(Reading::B))
618 }
619}
620
621struct Ctx {
623 root: PathBuf,
624 feature: String,
625 dir: String,
626 format: &'static dyn Adapter,
627 snapshot: ProjectSnapshot,
628 plane_dir: PathBuf,
629 config: substrate::run_config::RunConfig,
630 sandbox: sandbox::Config,
631 worktree: crate::prepare::Config,
632 state: PathBuf,
634 policy: tools::policy::Policy,
635 model: Option<substrate::model_config::ModelConfig>,
636}
637
638fn refuse(status: CommandStatus, code: &str, message: &str) -> CommandResult {
639 CommandResult::new("review", status, message).with_code(code)
640}
641
642fn open(path: &Path, feature: Option<&str>, state: &Path) -> Result<Ctx, Box<CommandResult>> {
643 let inspected = crate::inspect(path, feature);
644 let Some(CommandData::Inspect(snapshot)) = inspected.data() else {
645 return Err(Box::new(CommandResult::carried("review", &inspected)));
646 };
647 let snapshot = (**snapshot).clone();
648 let Some(f) = snapshot.feature.as_ref() else {
649 return Err(Box::new(CommandResult::new(
650 "review",
651 CommandStatus::SelectionNeeded,
652 inspected.message(),
653 )));
654 };
655 let root = PathBuf::from(&snapshot.root);
656 let config_root = crate::verify::find_config(&root).ok_or_else(|| {
657 Box::new(refuse(
658 CommandStatus::ConfigError,
659 "CONFIG-MISSING",
660 "the project has no speccoder.toml",
661 ))
662 })?;
663 let text =
664 std::fs::read_to_string(config_root.join(crate::verify::config::FILE)).unwrap_or_default();
665 let config = substrate::run_config::parse(&text).map_err(|e| {
666 Box::new(refuse(
667 CommandStatus::ConfigError,
668 "CONFIG-INVALID",
669 &format!("speccoder.toml: {e}"),
670 ))
671 })?;
672 let sandbox = sandbox::parse(&text).map_err(|e| {
673 Box::new(refuse(
674 CommandStatus::ConfigError,
675 "CONFIG-INVALID",
676 &format!("speccoder.toml: {e}"),
677 ))
678 })?;
679 let worktree_config = crate::prepare::parse(&text).map_err(|e| {
680 Box::new(refuse(
681 CommandStatus::ConfigError,
682 "CONFIG-INVALID",
683 &format!("speccoder.toml: {e}"),
684 ))
685 })?;
686 let format = crate::format::of(&snapshot);
687 let policy =
688 tools::policy::Policy::new(&crate::verify::check_argvs(&config_root), &config.allow)
689 .with_prefixes(config.allow_prefix.clone())
690 .rules(format.rules());
691 let model = substrate::model_config::parse(&text).ok().flatten();
692 Ok(Ctx {
693 feature: f.feature.name.clone(),
694 dir: f.feature.dir.clone(),
695 plane_dir: worktree::project_state_dir(state, &root),
696 root,
697 format,
698 snapshot,
699 config,
700 sandbox,
701 worktree: worktree_config,
702 state: state.to_path_buf(),
703 policy,
704 model,
705 })
706}
707
708fn project_in(root: &Path, worktree_root: &Path) -> PathBuf {
710 let canonical = |p: &Path| std::fs::canonicalize(p).unwrap_or_else(|_| p.to_path_buf());
711 let top = crate::git::Git::at(root)
712 .toplevel()
713 .ok()
714 .flatten()
715 .map_or_else(|| root.to_path_buf(), |t| canonical(&t));
716 match canonical(root).strip_prefix(&top) {
717 Ok(rel) if !rel.as_os_str().is_empty() => worktree_root.join(rel),
718 _ => worktree_root.to_path_buf(),
719 }
720}
721
722pub(crate) struct UnitLock(PathBuf);
726
727impl UnitLock {
728 pub(crate) fn take(project_state: &Path, unit: &str) -> Result<Self, String> {
729 let path = project_state.join(DIR).join(format!("{unit}.lock"));
730 if let Some(parent) = path.parent() {
731 std::fs::create_dir_all(parent).map_err(|e| format!("{}: {e}", parent.display()))?;
732 }
733 if std::fs::metadata(&path)
735 .ok()
736 .and_then(|m| m.modified().ok())
737 .and_then(|m| m.elapsed().ok())
738 .is_some_and(|age| age.as_secs() > 3600)
739 {
740 let _ = std::fs::remove_file(&path);
741 }
742 std::fs::OpenOptions::new()
743 .write(true)
744 .create_new(true)
745 .open(&path)
746 .map(|_| Self(path))
747 .map_err(|_| {
748 format!("{unit}'s tests are being written or frozen elsewhere right now: look again when that ends")
749 })
750 }
751}
752
753impl Drop for UnitLock {
754 fn drop(&mut self) {
755 let _ = std::fs::remove_file(&self.0);
756 }
757}
758
759fn stage(options: &crate::RunOptions, req: &str, stage: &str, n: u32, of: u32) {
761 if let Some(p) = &options.progress {
762 p.event(&crate::progress::Event::Oracle {
763 step: crate::progress::OracleEvent::Stage {
764 requirement: req.to_owned(),
765 stage: stage.to_owned(),
766 n,
767 of,
768 },
769 });
770 }
771}
772
773#[must_use]
776pub fn tests(
777 path: &Path,
778 feature: Option<&str>,
779 request: &Request<'_>,
780 via: Via,
781 state: Option<&Path>,
782 options: &crate::RunOptions,
783) -> CommandResult {
784 let Some(state) = state.map(Path::to_path_buf).or_else(worktree::state_dir) else {
785 return refuse(
786 CommandStatus::ConfigError,
787 "NO-STATE-DIR",
788 "no state directory (set SPECCODER_STATE_DIR or HOME)",
789 );
790 };
791 if !request.needs_model() {
792 return tests_with(path, feature, request, via, &state, None, options);
793 }
794 let ctx = match open(path, feature, &state) {
795 Ok(c) => c,
796 Err(r) => return *r,
797 };
798 if let Err(r) = check(&ctx, request) {
799 return *r;
800 }
801 let Some(model) = ctx.model.as_ref() else {
802 return refuse(
803 CommandStatus::ConfigError,
804 "CONFIG",
805 "speccoder.toml has no [model] section: the test author needs a model",
806 );
807 };
808 match substrate::model_config::open_driver(model) {
809 Ok((provider, _)) => {
810 tests_with(path, feature, request, via, &state, Some(provider), options)
811 }
812 Err(e) => substrate::model_config::refused("review", &e),
813 }
814}
815
816#[must_use]
818pub fn tests_with(
819 path: &Path,
820 feature: Option<&str>,
821 request: &Request<'_>,
822 via: Via,
823 state: &Path,
824 provider: Option<Arc<dyn ModelProvider>>,
825 options: &crate::RunOptions,
826) -> CommandResult {
827 let ctx = match open(path, feature, state) {
828 Ok(c) => c,
829 Err(r) => return *r,
830 };
831 let req = match check(&ctx, request) {
832 Ok(r) => r,
833 Err(r) => return *r,
834 };
835 let _lock = match UnitLock::take(&ctx.plane_dir, &ctx.feature) {
836 Ok(l) => l,
837 Err(e) => return refuse(CommandStatus::GitPrecondition, "RUN-ACTIVE", &e),
838 };
839 let who = crate::approvals::Who::local_in(&ctx.root, via);
840 let done = match request.op {
841 OracleOp::Write => write(&ctx, &req, provider, options),
842 OracleOp::Reject => reject(&ctx, &req, request, &who.name),
843 OracleOp::Again => again(&ctx, &req, request, &who.name, provider, options),
844 OracleOp::Edit => edit(&ctx, &req, request, &who.name),
845 OracleOp::Reading => reading(&ctx, &req, request, &who.name, provider, options),
846 };
847 match done {
848 Ok(message) => {
849 let r = crate::review::report_in(path, feature, Some(state));
850 let status = r.status();
851 r.reworded(status, &message)
852 }
853 Err(r) => *r,
854 }
855}
856
857fn check(ctx: &Ctx, request: &Request<'_>) -> Result<OracleRequirement, Box<CommandResult>> {
860 let unit_rung = rung(ctx.format, &ctx.root, &ctx.feature);
861 if unit_rung != Rung::Feature {
862 return Err(Box::new(
863 refuse(
864 CommandStatus::UsageError,
865 "REVIEW-TESTS-OWN-PIPELINE",
866 &format!(
867 "{} is a {} unit: its tests are written and confirmed by its own pipeline",
868 ctx.feature,
869 if unit_rung == Rung::Quick {
870 "quick-change"
871 } else {
872 "bug"
873 }
874 ),
875 )
876 .with_fix(vec![if unit_rung == Rung::Quick {
877 "speccoder do \"…\"".to_owned()
878 } else {
879 format!("speccoder bug confirm {}/<task>", ctx.feature)
880 }]),
881 ));
882 }
883 if !ctx.config.acceptance {
884 return Err(Box::new(refuse(
885 CommandStatus::ConfigError,
886 "ACCEPTANCE-OFF",
887 "acceptance tests are off ([acceptance] generate = false): no tests are written at review",
888 )));
889 }
890 let requirements = ctx.format.oracle_requirements(&ctx.snapshot);
891 let Some(req) = requirements
892 .iter()
893 .find(|r| r.key.eq_ignore_ascii_case(request.req))
894 .cloned()
895 else {
896 return Err(Box::new(refuse(
897 CommandStatus::UsageError,
898 "REVIEW-NO-SCENARIOS",
899 &format!(
900 "the spec has no requirement {}; it names {}",
901 request.req,
902 if requirements.is_empty() {
903 "none with scenarios".to_owned()
904 } else {
905 requirements
906 .iter()
907 .map(|r| r.key.as_str())
908 .collect::<Vec<_>>()
909 .join(", ")
910 }
911 ),
912 )));
913 };
914 if req.scenarios.is_empty() {
915 return Err(Box::new(refuse(
916 CommandStatus::UsageError,
917 "REVIEW-NO-SCENARIOS",
918 &format!(
919 "{} has no acceptance scenarios to write tests from",
920 req.key
921 ),
922 )));
923 }
924 let (entries, _) = crate::review::oracle_entries(&ctx.root, &ctx.dir)
927 .map_err(|e| Box::new(refuse(CommandStatus::NeedsHuman, "REVIEW-UNREADABLE", &e)))?;
928 if let Some(e) = entries
929 .get(&req.key)
930 .filter(|e| e.requirement_sha256 == req.digest())
931 {
932 return Err(Box::new(refuse(
933 CommandStatus::UsageError,
934 "ORACLE-FROZEN",
935 &format!(
936 "{}'s tests were frozen with the approval by {}: the run uses them as frozen — reword {} to lapse the freeze, then write its tests again",
937 req.key, e.by, req.key
938 ),
939 )));
940 }
941 Ok(req)
942}
943
944type Outcome = Result<String, Box<CommandResult>>;
945
946fn failed(message: impl Into<String>) -> Box<CommandResult> {
947 Box::new(refuse(
948 CommandStatus::RunFailed,
949 "ORACLE-AUTHOR-FAILED",
950 &message.into(),
951 ))
952}
953
954fn usage(message: &str) -> Box<CommandResult> {
955 Box::new(refuse(CommandStatus::UsageError, "USAGE", message))
956}
957
958fn existing(ctx: &Ctx, req: &OracleRequirement) -> Result<Loaded, Box<CommandResult>> {
959 match load(&ctx.plane_dir, &ctx.feature, &req.key) {
960 Ok(Some((d, c))) if d.requirement.sha256 == req.digest() => Ok((d, c)),
961 Ok(Some(_)) => Err(usage(&format!(
962 "{}'s tests were written for an earlier wording: write them again (`speccoder review tests {} --write`)",
963 req.key, req.key
964 ))),
965 Ok(None) => Err(usage(&format!(
966 "{} has no tests yet: `speccoder review tests {} --write`",
967 req.key, req.key
968 ))),
969 Err(t) => Err(Box::new(refuse(
970 CommandStatus::NeedsHuman,
971 "ORACLE-TAMPERED",
972 &t.0,
973 ))),
974 }
975}
976
977enum Held<'a, T> {
980 Own(T),
981 Lent(&'a T),
982}
983
984impl<T> std::ops::Deref for Held<'_, T> {
985 type Target = T;
986 fn deref(&self) -> &T {
987 match self {
988 Self::Own(t) => t,
989 Self::Lent(t) => t,
990 }
991 }
992}
993
994struct Author<'a> {
995 ctx: &'a Ctx,
996 rt: Held<'a, tokio::runtime::Runtime>,
997 plane: Held<'a, substrate::Plane>,
998 bundle: Value,
999 instructions: Vec<crate::instructions::Instruction>,
1000 test_layout: String,
1002}
1003
1004impl<'a> Author<'a> {
1005 fn open(
1006 ctx: &'a Ctx,
1007 req: &OracleRequirement,
1008 provider: Option<Arc<dyn ModelProvider>>,
1009 options: &crate::RunOptions,
1010 ) -> Result<Self, Box<CommandResult>> {
1011 let (Some(provider), Some(model)) = (provider, ctx.model.as_ref()) else {
1012 return Err(Box::new(refuse(
1013 CommandStatus::ConfigError,
1014 "CONFIG",
1015 "the test author needs a model ([model] in speccoder.toml)",
1016 )));
1017 };
1018 let rt = crate::pipeline::tokio_runtime().map_err(failed)?;
1019 let plane = rt
1020 .block_on(async {
1021 substrate::Plane::open_with(
1022 &ctx.plane_dir,
1023 model,
1024 provider,
1025 None,
1026 substrate::Hooks {
1027 format: Some(ctx.format),
1028 progress: options.progress.clone(),
1029 ..substrate::Hooks::default()
1030 },
1031 )
1032 })
1033 .map_err(|e| failed(e.0))?;
1034 Ok(Self::with(ctx, req, Held::Own(rt), Held::Own(plane)))
1035 }
1036
1037 fn lent(
1039 ctx: &'a Ctx,
1040 req: &OracleRequirement,
1041 rt: &'a tokio::runtime::Runtime,
1042 plane: &'a substrate::Plane,
1043 ) -> Self {
1044 Self::with(ctx, req, Held::Lent(rt), Held::Lent(plane))
1045 }
1046
1047 fn with(
1048 ctx: &'a Ctx,
1049 req: &OracleRequirement,
1050 rt: Held<'a, tokio::runtime::Runtime>,
1051 plane: Held<'a, substrate::Plane>,
1052 ) -> Self {
1053 let unit_dir = ctx.root.join(&ctx.dir);
1054 let [constitution, _, plan, _] = ctx.format.convergence_texts(&ctx.root, &unit_dir);
1055 let bundle = json!({
1056 "feature": ctx.feature,
1057 "constitution": constitution,
1058 "plan": plan,
1059 "story": req.text,
1060 "task": {
1061 "id": format!("req-{}", req.key),
1062 "title": format!("Acceptance tests for {}: {}", req.key, req.title),
1063 "phase": "Review",
1064 "subsection": "",
1065 "story": req.key,
1066 "parallel": false,
1067 },
1068 "dependencies": [],
1069 });
1070 let instructions =
1071 crate::instructions::collect(&ctx.root, &ctx.root, &[], &ctx.config.instructions);
1072 Self {
1073 ctx,
1074 rt,
1075 plane,
1076 bundle,
1077 instructions,
1078 test_layout: crate::layout::text_at(&ctx.root),
1079 }
1080 }
1081
1082 fn context(
1084 &self,
1085 req: &OracleRequirement,
1086 notes: &[String],
1087 ) -> speccoder_core::context::ContextManifest {
1088 let mut m = crate::context::Manifest::new();
1089 m.push(
1090 ContextKind::Story,
1091 "person",
1092 "/requirement",
1093 req.text.as_bytes(),
1094 );
1095 for s in &req.scenarios {
1096 m.push(
1097 ContextKind::Scenario,
1098 "person",
1099 &format!("/scenarios/{}", s.id),
1100 s.text.as_bytes(),
1101 );
1102 }
1103 m.push(
1104 ContextKind::Constitution,
1105 "worktree",
1106 "/bundle/constitution",
1107 self.bundle["constitution"]
1108 .as_str()
1109 .unwrap_or_default()
1110 .as_bytes(),
1111 );
1112 m.push(
1113 ContextKind::Plan,
1114 "worktree",
1115 "/bundle/plan",
1116 self.bundle["plan"].as_str().unwrap_or_default().as_bytes(),
1117 );
1118 m.push(
1119 ContextKind::TestLayout,
1120 "worktree",
1121 "/test_layout",
1122 self.test_layout.as_bytes(),
1123 );
1124 for (i, n) in notes.iter().enumerate() {
1125 let kind = if n.starts_with("Rejected `") {
1126 ContextKind::Rejection
1127 } else if n.starts_with("Comment ") {
1128 ContextKind::Comment
1129 } else {
1130 ContextKind::Note
1131 };
1132 m.push(kind, "person", &format!("/notes/{i}"), n.as_bytes());
1133 }
1134 m.finish()
1135 }
1136
1137 #[allow(clippy::too_many_arguments)]
1139 fn call(
1140 &self,
1141 req: &OracleRequirement,
1142 files: &[String],
1143 manifest: &str,
1144 notes: &[String],
1145 again: Option<(&str, &str)>,
1146 sample: u8,
1147 ) -> Result<(Value, String, Vec<ContextEntry>), String> {
1148 let context = self.context(req, notes);
1149 let input = substrate::acceptance::review_input(&substrate::acceptance::ReviewParts {
1150 bundle: self.bundle.clone(),
1151 requirement: json!({ "key": req.key, "title": req.title, "text": req.text }),
1152 scenarios: &req.scenarios,
1153 files,
1154 manifest,
1155 notes,
1156 again,
1157 instructions: &self.instructions,
1158 context: &context,
1159 sample,
1160 test_layout: Some(&self.test_layout),
1161 });
1162 let task = format!("req-{}", req.key);
1163 let outcome = self
1164 .rt
1165 .block_on(self.plane.acceptance(&self.ctx.feature, &task, input))
1166 .map_err(|e| format!("the test author failed: {}", e.0))?;
1167 let output = outcome
1168 .output
1169 .as_ref()
1170 .map(|o| o.peek().clone())
1171 .unwrap_or_default();
1172 let answer = output["answer"].clone();
1173 if !matches!(outcome.status, agentplane::prelude::RunStatus::Succeeded) || answer.is_null()
1174 {
1175 let status = format!("{:?}", outcome.status);
1176 return Err(substrate::provider_refusal(&status).map_or_else(
1177 || {
1178 format!(
1179 "the test author did not answer: {}",
1180 substrate::why_not(&outcome.status)
1181 )
1182 },
1183 |r| format!("the model provider refused the request: {r}"),
1184 ));
1185 }
1186 Ok((answer, outcome.run_id.to_string(), context.entries))
1187 }
1188}
1189
1190fn expectations(
1196 answer: &Value,
1197 req: &OracleRequirement,
1198) -> Result<(Vec<Expectation>, Vec<Untestable>), String> {
1199 let canonical = |id: &str| {
1200 req.scenarios
1201 .iter()
1202 .find(|s| s.id.eq_ignore_ascii_case(id.trim()))
1203 .map(|s| s.id.clone())
1204 .ok_or_else(|| {
1205 format!(
1206 "the test author's expectations name `{id}`, which {} does not have",
1207 req.key
1208 )
1209 })
1210 };
1211 let list = |field: &str| -> Result<Value, String> {
1212 match &answer[field] {
1213 Value::Null => Ok(Value::Array(Vec::new())),
1214 v @ Value::Array(_) => Ok(v.clone()),
1215 _ => Err(format!("the test author's `{field}` is not a list")),
1216 }
1217 };
1218 let mut e: Vec<Expectation> = serde_json::from_value(list("expectations")?)
1219 .map_err(|x| format!("the test author's expectations cannot be read: {x}"))?;
1220 let mut u: Vec<Untestable> = serde_json::from_value(list("untestable")?)
1221 .map_err(|x| format!("the test author's untestable list cannot be read: {x}"))?;
1222 for x in &mut e {
1223 x.scenario = canonical(&x.scenario)?;
1224 }
1225 for x in &mut u {
1226 x.scenario = canonical(&x.scenario)?;
1227 }
1228 if e.is_empty() && u.is_empty() {
1229 return Err(
1230 "the test author stated no expectation for any scenario: the readings cannot be compared"
1231 .to_owned(),
1232 );
1233 }
1234 Ok((e, u))
1235}
1236
1237struct Bench {
1240 root: PathBuf,
1243 _scratch: Option<worktree::Scratch>,
1244 project: PathBuf,
1245 runner: sandbox::Runner,
1246 tmp: PathBuf,
1247}
1248
1249impl Bench {
1250 fn open(ctx: &Ctx) -> Result<Self, Box<CommandResult>> {
1251 let tmp = ctx.plane_dir.join("tmp");
1252 let scratch = worktree::scratch(&ctx.root, &tmp)
1253 .map_err(|e| failed(format!("the scratch worktree could not be made: {}", e.0)))?;
1254 let project = project_in(&ctx.root, &scratch.path);
1255 let (runner, notice) = sandbox::runner(&scratch.path, &ctx.sandbox)
1256 .map_err(|e| Box::new(refuse(CommandStatus::ConfigError, "CONFIG", &e)))?;
1257 if !runner.is_sandboxed() {
1260 return Err(Box::new(
1261 refuse(
1262 CommandStatus::ConfigError,
1263 "SANDBOX-UNAVAILABLE",
1264 &format!(
1265 "the red check runs model-written tests and needs the OS sandbox: {}",
1266 notice.unwrap_or_else(|| "commands would run unsandboxed".to_owned())
1267 ),
1268 )
1269 .with_fix(vec![
1270 "set [sandbox] mode = \"auto\" on a machine with a sandbox backend (speccoder doctor)".to_owned(),
1271 ]),
1272 ));
1273 }
1274 crate::include::copy(&scratch.path, &project, &ctx.root, &ctx.worktree.include).map_err(
1276 |e| {
1277 Box::new(refuse(
1278 CommandStatus::ConfigError,
1279 "PREPARE-FAILED",
1280 &format!("the files [worktree] include names could not be copied: {e}"),
1281 ))
1282 },
1283 )?;
1284 if ctx.worktree.prepare && crate::prepare::needed(&project) {
1285 crate::prepare::prepare(&crate::prepare::Prepare {
1286 worktree: &scratch.path,
1287 project: &project,
1288 config: &ctx.worktree,
1289 runner: &runner,
1290 state: Some(&ctx.state),
1291 })
1292 .map_err(|f| {
1293 Box::new(
1294 refuse(CommandStatus::ConfigError, "PREPARE-FAILED", &f.message)
1295 .with_fix(f.fix)
1296 .with_commands(f.commands),
1297 )
1298 })?;
1299 }
1300 Ok(Self {
1301 root: scratch.path.clone(),
1302 _scratch: Some(scratch),
1303 project,
1304 runner,
1305 tmp,
1306 })
1307 }
1308
1309 fn here(ctx: &Ctx, wt_root: &Path, runner: sandbox::Runner) -> Self {
1312 Self {
1313 root: wt_root.to_path_buf(),
1314 _scratch: None,
1315 project: ctx.root.clone(),
1316 runner,
1317 tmp: ctx.plane_dir.join("tmp"),
1318 }
1319 }
1320
1321 fn files(&self) -> (Vec<String>, String) {
1322 let files: Vec<String> = worktree::checkpoint(&self.root, &self.tmp)
1323 .and_then(|c| worktree::files(&self.root, &c))
1324 .unwrap_or_default()
1325 .into_iter()
1326 .take(400)
1327 .collect();
1328 let manifest = crate::pipeline::MANIFESTS
1329 .iter()
1330 .find_map(|m| {
1331 std::fs::read_to_string(self.project.join(m))
1332 .ok()
1333 .map(|t| format!("{m}:\n{t}"))
1334 })
1335 .map(|t| t.chars().take(8192).collect::<String>())
1336 .unwrap_or_default();
1337 (files, manifest)
1338 }
1339
1340 fn red(
1346 &self,
1347 tests: &[(String, String, Vec<String>)],
1348 ) -> Result<Vec<Result<RedClass, &'static str>>, String> {
1349 let mut out = Vec::new();
1350 for (path, content, argv) in tests {
1351 let full = self.project.join(path);
1352 let _ = std::fs::remove_file(&full);
1353 let run = || crate::pipeline::acceptance_run(&self.project, argv, &self.runner);
1354 let (bare, summary) = run();
1355 if classify_red(&bare, summary.as_ref()).is_red() {
1356 out.push(Err("red_without_it"));
1357 continue;
1358 }
1359 if let Some(parent) = full.parent() {
1360 std::fs::create_dir_all(parent).map_err(|e| format!("{path}: {e}"))?;
1361 }
1362 std::fs::write(&full, content).map_err(|e| format!("{path}: {e}"))?;
1363 let (first, summary) = run();
1364 let class = classify_red(&first, summary.as_ref());
1365 let class = if !class.is_red() {
1366 class
1367 } else {
1368 let (second, summary) = run();
1369 if classify_red(&second, summary.as_ref()).is_red() {
1370 class
1371 } else {
1372 RedClass::Flaky
1373 }
1374 };
1375 std::fs::remove_file(&full).map_err(|e| format!("{path}: {e}"))?;
1376 out.push(Ok(class));
1377 }
1378 Ok(out)
1379 }
1380}
1381
1382fn keep(
1384 ctx: &Ctx,
1385 bench: &Bench,
1386 answer: &Value,
1387 req: &OracleRequirement,
1388 taken: &[(String, Vec<String>)],
1389) -> (Vec<Kept>, Vec<OracleDiscarded>) {
1390 let (valid, refused) =
1391 crate::pipeline::validate_answer(answer, &bench.project, &ctx.policy, &req.scenarios);
1392 let mut discarded: Vec<OracleDiscarded> = refused
1393 .into_iter()
1394 .map(|r| OracleDiscarded {
1395 path: r.path,
1396 why: r.why.to_owned(),
1397 })
1398 .collect();
1399 let set_argv: Vec<String> = crate::pipeline::acceptance::argv_of(&answer["argv"]);
1400 let layout = crate::layout::detect(&bench.project, &crate::verify::check_argvs(&ctx.root));
1401 let mut kept = Vec::new();
1402 for f in valid {
1403 let mut discard = |why: &str| {
1404 discarded.push(OracleDiscarded {
1405 path: f.path.clone(),
1406 why: why.to_owned(),
1407 });
1408 };
1409 if f.cited.is_empty() {
1410 discard("cites_no_scenario");
1411 continue;
1412 }
1413 if taken.iter().any(|(p, _)| *p == f.path)
1414 || kept.iter().any(|(p, ..): &(String, _, _, _)| *p == f.path)
1415 {
1416 discard("exists");
1417 continue;
1418 }
1419 let argv = if f.argv.is_empty() {
1420 set_argv.clone()
1421 } else {
1422 f.argv.clone()
1423 };
1424 if taken.iter().any(|(_, a)| *a == argv)
1427 || kept
1428 .iter()
1429 .any(|(.., a): &(_, _, _, Vec<String>)| *a == argv)
1430 {
1431 discard("command_shared");
1432 continue;
1433 }
1434 if argv.is_empty()
1435 || !crate::pipeline::test_command_allowed(
1436 &ctx.policy,
1437 Some(&layout),
1438 &argv,
1439 &[f.path.as_str()],
1440 )
1441 {
1442 discard("command_not_allowed");
1443 continue;
1444 }
1445 if kept.len() + taken.len() >= LIMIT {
1446 discard("limit");
1447 continue;
1448 }
1449 kept.push((f.path, f.content, f.cited, argv));
1450 }
1451 (kept, discarded)
1452}
1453
1454fn write(
1457 ctx: &Ctx,
1458 req: &OracleRequirement,
1459 provider: Option<Arc<dyn ModelProvider>>,
1460 options: &crate::RunOptions,
1461) -> Outcome {
1462 let samples = ctx.config.oracle_samples.clamp(1, 2);
1463 let author = Author::open(ctx, req, provider, options)?;
1464 let bench = Bench::open(ctx)?;
1465 let earlier = load(&ctx.plane_dir, &ctx.feature, &req.key).map_err(|t| {
1468 Box::new(
1469 refuse(
1470 CommandStatus::NeedsHuman,
1471 "ORACLE-TAMPERED",
1472 &format!(
1473 "{}: writing anew would lose the rejections and notes it holds",
1474 t.0
1475 ),
1476 )
1477 .with_fix(vec![format!(
1478 "→ restore it, or remove {} to start {}'s tests over",
1479 dir(&ctx.plane_dir, &ctx.feature, &req.key).display(),
1480 req.key
1481 )]),
1482 )
1483 })?;
1484 let (rejected, mut notes) = earlier
1485 .as_ref()
1486 .filter(|(d, _)| d.requirement.sha256 == req.digest())
1487 .map(|(d, _)| (d.rejected.clone(), d.notes.clone()))
1488 .unwrap_or_default();
1489 notes.dedup();
1490 let told: Vec<String> = rejected
1491 .iter()
1492 .map(|r| format!("Rejected `{}`: {}", r.path, r.reason))
1493 .chain(notes.iter().cloned())
1494 .collect();
1495 let (draft, contents) = draft(
1496 ctx, req, &author, &bench, samples, &told, rejected, notes, true, options,
1497 )?;
1498 store(&ctx.plane_dir, &ctx.feature, &draft, &contents).map_err(failed)?;
1499 let red = draft.red().count();
1500 let open = draft.open_ambiguities().count();
1501 Ok(format!(
1502 "wrote {} test(s) for {}: {red} red{}{}",
1503 draft.tests.len(),
1504 req.key,
1505 if draft.held_out.state == "kept" {
1506 format!(", {} held out", draft.held_out.count)
1507 } else {
1508 String::new()
1509 },
1510 if open > 0 {
1511 format!(
1512 "; {} — {open} scenario(s) read two ways: choose a reading or reword (`speccoder review tests {} --reading A|B <scenario>`)",
1513 req.key, req.key
1514 )
1515 } else {
1516 String::new()
1517 }
1518 ))
1519}
1520
1521#[allow(clippy::too_many_arguments)]
1524fn draft(
1525 ctx: &Ctx,
1526 req: &OracleRequirement,
1527 author: &Author<'_>,
1528 bench: &Bench,
1529 samples: u8,
1530 told: &[String],
1531 rejected: Vec<OracleRejected>,
1532 notes: Vec<String>,
1533 with_held_out: bool,
1534 options: &crate::RunOptions,
1535) -> Result<Loaded, Box<CommandResult>> {
1536 let (files, manifest) = bench.files();
1537 let of = u32::from(samples);
1538 stage(options, &req.key, "writing", 1, of);
1539 let (first, run1, mut context) = author
1540 .call(req, &files, &manifest, told, None, 1)
1541 .map_err(failed)?;
1542 let read = |answer: &Value| {
1545 let got = expectations(answer, req);
1546 if samples >= 2 {
1547 got.map_err(failed)
1548 } else {
1549 Ok(got.unwrap_or_default())
1550 }
1551 };
1552 let (e1, u1) = read(&first)?;
1553 let mut runs = vec![run1];
1554 let (mut e2, mut u2) = (Vec::new(), Vec::new());
1555 if samples >= 2 {
1556 stage(options, &req.key, "writing", 2, of);
1557 let (second, run2, more) = author
1558 .call(req, &files, &manifest, told, None, 2)
1559 .map_err(failed)?;
1560 (e2, u2) = read(&second)?;
1561 runs.push(run2);
1562 for c in more {
1563 if !context.contains(&c) {
1564 context.push(c);
1565 }
1566 }
1567 stage(options, &req.key, "comparing", 1, 1);
1568 }
1569 let ambiguities = if samples >= 2 {
1570 speccoder_core::oracle::compare(&e1, &u1, &e2, &u2)
1571 } else {
1572 Vec::new()
1573 };
1574 let (kept, mut discarded) = keep(ctx, bench, &first, req, &[]);
1575 stage(options, &req.key, "checking_red", 1, 1);
1576 let plan: Vec<(String, String, Vec<String>)> = kept
1577 .iter()
1578 .map(|(p, c, _, a)| (p.clone(), c.clone(), a.clone()))
1579 .collect();
1580 let classes = bench.red(&plan).map_err(failed)?;
1581 let mut tests: Vec<DraftTest> = Vec::new();
1582 let mut contents: Vec<(String, String)> = Vec::new();
1583 for ((path, content, cited, argv), class) in kept.into_iter().zip(classes) {
1584 match class {
1585 Ok(red_class) => {
1586 tests.push(DraftTest {
1587 path: path.clone(),
1588 sha256: digest_of(&content),
1589 scenarios: cited,
1590 argv,
1591 red_class,
1592 authored_by: AuthoredBy::Model,
1593 edited_by: None,
1594 });
1595 contents.push((path, content));
1596 }
1597 Err(why) => discarded.push(OracleDiscarded {
1598 path,
1599 why: why.to_owned(),
1600 }),
1601 }
1602 }
1603 let (held_out, sealed) = if with_held_out {
1605 held_out(ctx, author, bench, req, &tests, options)
1606 } else {
1607 (
1608 HeldOutSummary {
1609 state: "off".to_owned(),
1610 count: 0,
1611 manifest_sha256: None,
1612 reason: None,
1613 discarded: Vec::new(),
1614 },
1615 None,
1616 )
1617 };
1618 let draft = Draft {
1619 requirement: DraftRequirement {
1620 key: req.key.clone(),
1621 title: req.title.clone(),
1622 text: req.text.clone(),
1623 sha256: req.digest(),
1624 },
1625 samples,
1626 tests,
1627 discarded,
1628 rejected,
1629 expectations: Samples {
1630 sample1: e1,
1631 sample2: e2,
1632 },
1633 untestable: Samples {
1634 sample1: u1,
1635 sample2: u2,
1636 },
1637 ambiguities,
1638 held_out,
1639 sealed,
1640 notes,
1641 runs,
1642 context,
1643 };
1644 Ok((draft, contents))
1645}
1646
1647fn held_out(
1651 ctx: &Ctx,
1652 author: &Author<'_>,
1653 bench: &Bench,
1654 req: &OracleRequirement,
1655 tests: &[DraftTest],
1656 options: &crate::RunOptions,
1657) -> (HeldOutSummary, Option<SealedRef>) {
1658 let summary = |state: &str, reason: Option<&str>| HeldOutSummary {
1659 state: state.to_owned(),
1660 count: 0,
1661 manifest_sha256: None,
1662 reason: reason.map(str::to_owned),
1663 discarded: Vec::new(),
1664 };
1665 if !ctx.config.held_out {
1666 return (summary("off", None), None);
1667 }
1668 let red: Vec<&DraftTest> = tests.iter().filter(|t| t.red_class.is_red()).collect();
1669 if red.is_empty() {
1670 return (summary("absent", Some("not_red")), None);
1671 }
1672 stage(options, &req.key, "held_out", 1, 1);
1673 let visible = crate::pipeline::PreparedAcceptance {
1674 report: json!({ "files": red.iter().map(|t| t.path.clone()).collect::<Vec<_>>() }),
1675 argv: red.first().map(|t| t.argv.clone()),
1676 more_argv: Vec::new(),
1677 red: true,
1678 red_class: Some(RedClass::Assertion),
1679 held_out: None,
1680 generation_failed: None,
1681 skip_cause: None,
1682 };
1683 let task = format!("req-{}", req.key);
1684 let store = crate::held_out::sealed_dir(&ctx.plane_dir, &ctx.feature, &req.key);
1685 let (report, sha) = crate::pipeline::prepare_held_out(
1686 &crate::pipeline::AcceptanceSetup {
1687 rt: &author.rt,
1688 plane: &author.plane,
1689 project: &bench.project,
1690 worktree: &bench.root,
1691 tmp: &bench.tmp,
1692 policy: &ctx.policy,
1693 feature: &ctx.feature,
1694 task: &task,
1695 bundle: author.bundle.clone(),
1696 scenarios: &req.scenarios,
1697 instructions: &author.instructions,
1698 runner: &bench.runner,
1699 layout: None,
1700 },
1701 &visible,
1702 &req.scenarios,
1703 &store,
1704 false,
1705 );
1706 match sha {
1707 Some(sha) => {
1708 let count = report["kept"]
1709 .as_u64()
1710 .and_then(|n| usize::try_from(n).ok())
1711 .unwrap_or(0);
1712 (
1713 HeldOutSummary {
1714 state: "kept".to_owned(),
1715 count,
1716 manifest_sha256: Some(format!("sha256:{sha}")),
1717 reason: None,
1718 discarded: Vec::new(),
1719 },
1720 Some(SealedRef {
1721 key: req.key.clone(),
1722 manifest_sha256: sha,
1723 count,
1724 }),
1725 )
1726 }
1727 None => (
1728 HeldOutSummary {
1729 discarded: report["discarded"]
1730 .as_array()
1731 .into_iter()
1732 .flatten()
1733 .filter_map(|d| d["reason"].as_str().map(str::to_owned))
1734 .collect(),
1735 ..summary(
1736 "absent",
1737 Some(report["reason"].as_str().unwrap_or("none_kept")),
1738 )
1739 },
1740 None,
1741 ),
1742 }
1743}
1744
1745fn reject(ctx: &Ctx, req: &OracleRequirement, r: &Request<'_>, by: &str) -> Outcome {
1746 let Some(path) = r.path else {
1747 return Err(usage("name the test to reject (--reject PATH)"));
1748 };
1749 let Some(reason) = r.text.map(str::trim).filter(|t| !t.is_empty()) else {
1750 return Err(usage(
1751 "a rejection needs a reason: why is this test wrong? (--reason \"…\")",
1752 ));
1753 };
1754 let (mut d, contents) = existing(ctx, req)?;
1755 let Some(at) = d.tests.iter().position(|t| t.path == path) else {
1756 return Err(usage(&format!("{} has no test {path}", req.key)));
1757 };
1758 d.tests.remove(at);
1759 d.rejected.push(OracleRejected {
1760 path: path.to_owned(),
1761 reason: reason.to_owned(),
1762 by: by.to_owned(),
1763 at: now(),
1764 });
1765 store(&ctx.plane_dir, &ctx.feature, &d, &contents).map_err(failed)?;
1766 Ok(format!(
1767 "rejected {path} of {}: \"{reason}\" — later author calls for {} are told",
1768 req.key, req.key
1769 ))
1770}
1771
1772fn edit(ctx: &Ctx, req: &OracleRequirement, r: &Request<'_>, by: &str) -> Outcome {
1773 let Some(path) = r.path else {
1774 return Err(usage("name the test to edit (--edit PATH)"));
1775 };
1776 let Some(content) = r.text.filter(|t| !t.trim().is_empty()) else {
1777 return Err(usage("an edit needs the test's new content (--from FILE)"));
1778 };
1779 let (mut d, mut contents) = existing(ctx, req)?;
1780 let Some(at) = d.tests.iter().position(|t| t.path == path) else {
1781 return Err(usage(&format!("{} has no test {path}", req.key)));
1782 };
1783 let bench = Bench::open(ctx)?;
1784 let plan = [(
1785 path.to_owned(),
1786 content.to_owned(),
1787 d.tests[at].argv.clone(),
1788 )];
1789 let checked = bench
1790 .red(&plan)
1791 .map_err(failed)?
1792 .pop()
1793 .unwrap_or(Ok(RedClass::Unclassified));
1794 let class = checked.unwrap_or(RedClass::Unclassified);
1796 let t = &mut d.tests[at];
1797 t.sha256 = digest_of(content);
1798 t.red_class = class;
1799 t.authored_by = AuthoredBy::Person;
1800 t.edited_by = Some(by.to_owned());
1801 if let Some(c) = contents.iter_mut().find(|(p, _)| p == path) {
1802 c.1 = content.to_owned();
1803 }
1804 store(&ctx.plane_dir, &ctx.feature, &d, &contents).map_err(failed)?;
1805 Ok(format!(
1806 "edited {path} of {}: {}",
1807 req.key,
1808 if class.is_red() {
1809 format!("red ({})", crate::pipeline::class_word(class))
1810 } else if checked.is_err() {
1811 "its command is red without it — it decides nothing about this test, which cannot be frozen".to_owned()
1812 } else {
1813 format!(
1814 "not red ({}) — no evidence, it cannot be frozen",
1815 crate::pipeline::class_word(class)
1816 )
1817 }
1818 ))
1819}
1820
1821#[allow(clippy::too_many_arguments)]
1824fn rewrite(
1825 ctx: &Ctx,
1826 req: &OracleRequirement,
1827 mut d: Draft,
1828 mut contents: Vec<(String, String)>,
1829 replaced: &[String],
1830 note: String,
1831 again: Option<(&str, &str)>,
1832 only: Option<&str>,
1833 provider: Option<Arc<dyn ModelProvider>>,
1834 options: &crate::RunOptions,
1835) -> Result<(Draft, Vec<String>), Box<CommandResult>> {
1836 let author = Author::open(ctx, req, provider, options)?;
1837 let bench = Bench::open(ctx)?;
1838 let (files, manifest) = bench.files();
1839 d.notes.push(note);
1840 let told = d.all_notes();
1841 stage(options, &req.key, "writing", 1, 1);
1842 let (answer, run, context) = author
1843 .call(req, &files, &manifest, &told, again, 1)
1844 .map_err(failed)?;
1845 d.runs.push(run);
1846 for c in context {
1847 if !d.context.contains(&c) {
1848 d.context.push(c);
1849 }
1850 }
1851 let keep_paths: Vec<(String, Vec<String>)> = d
1852 .tests
1853 .iter()
1854 .filter(|t| !replaced.contains(&t.path))
1855 .map(|t| (t.path.clone(), t.argv.clone()))
1856 .collect();
1857 let mut answer = answer;
1859 if let Some(files) = answer["files"].as_array_mut() {
1860 files.retain(|f| {
1861 only.is_none_or(|s| {
1862 f["scenarios"]
1863 .as_array()
1864 .is_some_and(|c| c.iter().any(|v| v.as_str() == Some(s)))
1865 })
1866 });
1867 }
1868 let (new, discarded) = keep(ctx, &bench, &answer, req, &keep_paths);
1869 if new.is_empty() {
1870 return Err(failed(format!(
1871 "the test author wrote no usable test{}",
1872 discarded
1873 .first()
1874 .map(|x| format!(" ({} {})", x.path, x.why))
1875 .unwrap_or_default()
1876 )));
1877 }
1878 d.tests.retain(|t| !replaced.contains(&t.path));
1879 contents.retain(|(p, _)| !replaced.contains(p));
1880 d.discarded.extend(discarded);
1881 stage(options, &req.key, "checking_red", 1, 1);
1882 let plan: Vec<(String, String, Vec<String>)> = new
1884 .iter()
1885 .map(|(p, c, _, a)| (p.clone(), c.clone(), a.clone()))
1886 .collect();
1887 let classes = bench.red(&plan).map_err(failed)?;
1888 let mut written = Vec::new();
1889 for ((path, content, cited, argv), class) in new.into_iter().zip(classes) {
1890 let red_class = match class {
1891 Ok(c) => c,
1892 Err(why) => {
1893 d.discarded.push(OracleDiscarded {
1894 path,
1895 why: why.to_owned(),
1896 });
1897 continue;
1898 }
1899 };
1900 d.tests.push(DraftTest {
1901 sha256: digest_of(&content),
1902 scenarios: cited,
1903 argv,
1904 red_class,
1905 authored_by: AuthoredBy::Model,
1906 edited_by: None,
1907 path: path.clone(),
1908 });
1909 contents.push((path.clone(), content));
1910 written.push(path);
1911 }
1912 store(&ctx.plane_dir, &ctx.feature, &d, &contents).map_err(failed)?;
1913 Ok((d, written))
1914}
1915
1916fn again(
1917 ctx: &Ctx,
1918 req: &OracleRequirement,
1919 r: &Request<'_>,
1920 _by: &str,
1921 provider: Option<Arc<dyn ModelProvider>>,
1922 options: &crate::RunOptions,
1923) -> Outcome {
1924 let Some(path) = r.path else {
1925 return Err(usage("name the test to write again (--again PATH)"));
1926 };
1927 let comment = r
1928 .text
1929 .map(str::trim)
1930 .filter(|t| !t.is_empty())
1931 .unwrap_or("write it again");
1932 let (d, contents) = existing(ctx, req)?;
1933 let Some(content) = contents
1934 .iter()
1935 .find(|(p, _)| p == path)
1936 .map(|(_, c)| c.clone())
1937 else {
1938 return Err(usage(&format!("{} has no test {path}", req.key)));
1939 };
1940 let (d, written) = rewrite(
1941 ctx,
1942 req,
1943 d,
1944 contents,
1945 &[path.to_owned()],
1946 format!("Comment on `{path}`: {comment}"),
1947 Some((path, &content)),
1948 None,
1949 provider,
1950 options,
1951 )?;
1952 let red = d
1953 .tests
1954 .iter()
1955 .filter(|t| written.contains(&t.path) && t.red_class.is_red())
1956 .count();
1957 Ok(format!(
1958 "wrote {path} of {} again: {}",
1959 req.key,
1960 if written.is_empty() {
1961 "nothing kept — its command is red without it, so it decides nothing".to_owned()
1962 } else if red == written.len() {
1963 "red".to_owned()
1964 } else {
1965 "not red — no evidence, it cannot be frozen".to_owned()
1966 }
1967 ))
1968}
1969
1970fn reading(
1971 ctx: &Ctx,
1972 req: &OracleRequirement,
1973 r: &Request<'_>,
1974 by: &str,
1975 provider: Option<Arc<dyn ModelProvider>>,
1976 options: &crate::RunOptions,
1977) -> Outcome {
1978 let (Some(scenario), Some(choice)) = (r.scenario, r.reading) else {
1979 return Err(usage(
1980 "name the reading and the scenario (--reading A|B US1-2)",
1981 ));
1982 };
1983 let (mut d, contents) = existing(ctx, req)?;
1984 let Some(item) = d.ambiguities.iter_mut().find(|a| a.scenario == scenario) else {
1985 return Err(usage(&format!(
1986 "{} has no ambiguity on {scenario}",
1987 req.key
1988 )));
1989 };
1990 item.resolution = Some(Resolution {
1991 reading: choice,
1992 by: by.to_owned(),
1993 at: now(),
1994 });
1995 let meant = if choice == Reading::A {
1996 item.a.clone()
1997 } else {
1998 item.b.clone()
1999 };
2000 if choice == Reading::A {
2001 d.notes.push(format!(
2002 "For {scenario} the person means reading A: given {}, expect {}",
2003 meant.given, meant.expect
2004 ));
2005 store(&ctx.plane_dir, &ctx.feature, &d, &contents).map_err(failed)?;
2006 return Ok(format!(
2007 "{scenario} of {}: reading A is meant — the tests stay",
2008 req.key
2009 ));
2010 }
2011 let replaced: Vec<String> = d
2012 .tests
2013 .iter()
2014 .filter(|t| t.scenarios.iter().any(|s| s == scenario))
2015 .map(|t| t.path.clone())
2016 .collect();
2017 let (_, written) = rewrite(
2018 ctx,
2019 req,
2020 d,
2021 contents,
2022 &replaced,
2023 format!(
2024 "For {scenario} the person means reading B: given {}, expect {}",
2025 meant.given, meant.expect
2026 ),
2027 None,
2028 Some(scenario),
2029 provider,
2030 options,
2031 )?;
2032 Ok(format!(
2033 "{scenario} of {}: reading B is meant — wrote {} anew",
2034 req.key,
2035 written.join(", ")
2036 ))
2037}
2038
2039#[derive(Debug, Clone)]
2042pub struct Freezable {
2043 pub req: OracleRequirement,
2045 pub draft: Draft,
2047 pub contents: Vec<(String, String)>,
2049 pub manifest: String,
2051}
2052
2053pub fn freezable(
2056 project_state: &Path,
2057 unit: &str,
2058 requirements: &[OracleRequirement],
2059) -> Result<Vec<Freezable>, Tampered> {
2060 let mut out = Vec::new();
2061 for r in requirements {
2062 let Some((draft, contents)) = load(project_state, unit, &r.key)? else {
2063 continue;
2064 };
2065 if draft.requirement.sha256 != r.digest() || draft.open_ambiguities().next().is_some() {
2066 continue;
2067 }
2068 let Some(manifest) = draft.manifest() else {
2069 continue;
2070 };
2071 let red: Vec<String> = draft.red().map(|t| t.path.clone()).collect();
2072 out.push(Freezable {
2073 req: r.clone(),
2074 contents: contents
2075 .into_iter()
2076 .filter(|(p, _)| red.contains(p))
2077 .collect(),
2078 draft,
2079 manifest,
2080 });
2081 }
2082 Ok(out)
2083}
2084
2085pub fn freeze(
2089 project_state: &Path,
2090 unit: &str,
2091 f: &Freezable,
2092 approval_digest: &str,
2093 decided: Decided,
2094 producer: Producer,
2095) -> Result<PreFrozenAcceptance, String> {
2096 let red: Vec<&DraftTest> = f.draft.red().collect();
2097 freeze_tests(
2098 project_state,
2099 unit,
2100 f,
2101 &red,
2102 approval_digest,
2103 decided,
2104 producer,
2105 )
2106}
2107
2108fn freeze_tests(
2110 project_state: &Path,
2111 unit: &str,
2112 f: &Freezable,
2113 red: &[&DraftTest],
2114 approval_digest: &str,
2115 decided: Decided,
2116 producer: Producer,
2117) -> Result<PreFrozenAcceptance, String> {
2118 let sealed = match &f.draft.sealed {
2119 Some(s) => {
2120 crate::held_out::open_sealed(project_state, unit, s)
2121 .map_err(|t| format!("{}'s held-out set was tampered with: {}", f.req.key, t.0))?;
2122 Some(s.clone())
2123 }
2124 None => None,
2125 };
2126 let record = PreFrozenAcceptance {
2127 unit: unit.to_owned(),
2128 requirement: f.req.key.clone(),
2129 wording_digest: f.draft.requirement.sha256.clone(),
2130 approval_digest: approval_digest.to_owned(),
2131 visible: red
2132 .iter()
2133 .map(|t| VisibleTest {
2134 path: t.path.clone(),
2135 sha256: t.sha256.clone(),
2136 cites: t.scenarios.clone(),
2137 })
2138 .collect(),
2139 held_out_sealed: sealed,
2140 producer,
2141 decided,
2142 };
2143 crate::pre_frozen::store(project_state, &record, &f.contents)?;
2144 let frozen = Frozen {
2145 requirement_sha256: f.draft.requirement.sha256.clone(),
2146 wording: format!(
2147 "{}\n{}",
2148 f.draft.requirement.title, f.draft.requirement.text
2149 ),
2150 manifest_sha256: f.manifest.clone(),
2151 tests: red
2152 .iter()
2153 .map(|t| FrozenTest {
2154 path: t.path.clone(),
2155 sha256: t.sha256.clone(),
2156 argv: t.argv.clone(),
2157 scenarios: t.scenarios.clone(),
2158 })
2159 .collect(),
2160 };
2161 let text = serde_json::to_string_pretty(&frozen).map_err(|e| e.to_string())?;
2162 write_atomic(
2163 &dir(project_state, unit, &f.req.key).join("frozen.json"),
2164 &text,
2165 )?;
2166 Ok(record)
2167}
2168
2169fn not_kept(t: &DraftTest, many: bool) -> Option<String> {
2176 if many && t.scenarios.len() > 1 {
2177 return Some(format!(
2178 "it tests {} together — one file per scenario, so each turns green on its own",
2179 t.scenarios.join(", ")
2180 ));
2181 }
2182 (!usable(t)).then(|| format!("it did not fail on an assertion ({:?})", t.red_class))
2183}
2184
2185fn usable(t: &DraftTest) -> bool {
2186 match t.red_class {
2187 RedClass::Assertion | RedClass::Passed => true,
2188 RedClass::Absent => [".rs", ".go", ".java", ".kt", ".cs", ".swift"]
2189 .iter()
2190 .any(|e| t.path.ends_with(e)),
2191 _ => false,
2192 }
2193}
2194
2195#[derive(Debug)]
2199pub(crate) struct RunOracle {
2200 pub tests: Vec<FrozenTest>,
2203 pub contents: Vec<(String, String)>,
2205 pub contracts: Vec<Expectation>,
2207 pub untestable: Vec<Untestable>,
2209}
2210
2211#[allow(clippy::too_many_arguments)]
2218pub(crate) fn write_for_run(
2219 project: &Path,
2220 wt_root: &Path,
2221 feature: &str,
2222 state: &Path,
2223 story: &str,
2224 runner: sandbox::Runner,
2225 (rt, plane): (&tokio::runtime::Runtime, &substrate::Plane),
2226 (only, told): (&[String], &[String]),
2227 run: &str,
2228 options: &crate::RunOptions,
2229) -> Result<RunOracle, Box<CommandResult>> {
2230 let ctx = open(project, Some(feature), state)?;
2231 let requirements = ctx.format.oracle_requirements(&ctx.snapshot);
2232 let whole = (story == ctx.feature && !requirements.iter().any(|r| r.key == story)).then(|| {
2234 OracleRequirement {
2235 key: story.to_owned(),
2236 title: ctx.feature.clone(),
2237 text: requirements
2238 .iter()
2239 .map(|r| format!("{}: {}\n{}", r.key, r.title, r.text))
2240 .collect::<Vec<_>>()
2241 .join("\n\n"),
2242 scenarios: requirements
2243 .iter()
2244 .flat_map(|r| r.scenarios.clone())
2245 .collect(),
2246 }
2247 });
2248 let Some(mut req) = whole.or_else(|| requirements.into_iter().find(|r| r.key == story)) else {
2249 return Err(Box::new(refuse(
2250 CommandStatus::NeedsHuman,
2251 "ORACLE-UNWRITTEN",
2252 &format!("{story} has no scenarios to write tests for"),
2253 )));
2254 };
2255 if !only.is_empty() {
2257 req.scenarios.retain(|s| only.contains(&s.id));
2258 }
2259 let _lock = UnitLock::take(&ctx.plane_dir, &ctx.feature)
2260 .map_err(|e| Box::new(refuse(CommandStatus::GitPrecondition, "RUN-ACTIVE", &e)))?;
2261 let author = Author::lent(&ctx, &req, rt, plane);
2262 let many = req.scenarios.len() > 1;
2263 let bench = Bench::here(&ctx, wt_root, runner);
2264 let kept = |d: &Draft| -> Vec<String> {
2265 let mut covered: Vec<String> = d
2266 .tests
2267 .iter()
2268 .filter(|t| not_kept(t, many).is_none())
2269 .flat_map(|t| t.scenarios.iter().cloned())
2270 .collect();
2271 covered.sort();
2272 covered.dedup();
2273 covered
2274 };
2275 let (mut draft, mut contents) = draft(
2276 &ctx,
2277 &req,
2278 &author,
2279 &bench,
2280 1,
2281 told,
2282 Vec::new(),
2283 told.to_vec(),
2284 only.is_empty(),
2285 options,
2286 )?;
2287 let missing = |d: &Draft| -> Vec<String> {
2288 let covered = kept(d);
2289 req.scenarios
2290 .iter()
2291 .map(|s| s.id.clone())
2292 .filter(|id| !covered.contains(id))
2293 .collect()
2294 };
2295 let untestable: Vec<String> = draft
2299 .untestable
2300 .sample1
2301 .iter()
2302 .map(|u| u.scenario.clone())
2303 .collect();
2304 let broke =
2305 !draft.discarded.is_empty() || draft.tests.iter().any(|t| not_kept(t, many).is_some());
2306 let left: Vec<String> = missing(&draft)
2307 .into_iter()
2308 .filter(|id| !untestable.contains(id))
2309 .collect();
2310 if broke && !left.is_empty() {
2311 let told: Vec<String> = draft
2312 .discarded
2313 .iter()
2314 .map(|d| format!("Not kept `{}`: {}", d.path, d.why))
2315 .chain(draft.tests.iter().filter_map(|t| {
2316 not_kept(t, many).map(|why| format!("Not kept `{}`: {why}", t.path))
2317 }))
2318 .chain(std::iter::once(format!(
2319 "Write tests again for {} — each must build and be collected without the code it tests existing yet: exercise the story through its interface, import the code under test inside each test",
2320 left.join(", ")
2321 )))
2322 .collect();
2323 let (second, more) = self::draft(
2324 &ctx,
2325 &req,
2326 &author,
2327 &bench,
2328 1,
2329 &told,
2330 Vec::new(),
2331 told.clone(),
2332 only.is_empty(),
2333 options,
2334 )?;
2335 if missing(&second).len() < left.len() {
2336 (draft, contents) = (second, more);
2337 }
2338 }
2339 if only.is_empty() {
2341 store(&ctx.plane_dir, &ctx.feature, &draft, &contents).map_err(failed)?;
2342 }
2343 let keep: Vec<&DraftTest> = draft
2344 .tests
2345 .iter()
2346 .filter(|t| not_kept(t, many).is_none())
2347 .collect();
2348 if keep.is_empty() && draft.tests.is_empty() && draft.discarded.is_empty() {
2351 return Ok(RunOracle {
2352 tests: Vec::new(),
2353 contents: Vec::new(),
2354 contracts: draft.expectations.sample1.clone(),
2355 untestable: draft.untestable.sample1.clone(),
2356 });
2357 }
2358 if keep.is_empty() {
2359 return Err(Box::new(refuse(
2360 CommandStatus::NeedsHuman,
2361 "ORACLE-UNWRITTEN",
2362 &format!(
2363 "no test written for {story} could be used ({} not kept)",
2364 draft.tests.len() + draft.discarded.len()
2365 ),
2366 )));
2367 }
2368 let manifest = manifest_digest(
2369 keep.iter()
2370 .map(|t| (t.path.as_str(), t.sha256.as_str(), t.argv.as_slice())),
2371 );
2372 let paths: Vec<&str> = keep.iter().map(|t| t.path.as_str()).collect();
2373 let kept_contents: Vec<(String, String)> = contents
2374 .iter()
2375 .filter(|(p, _)| paths.contains(&p.as_str()))
2376 .cloned()
2377 .collect();
2378 let f = Freezable {
2379 req: req.clone(),
2380 draft: draft.clone(),
2381 contents: kept_contents.clone(),
2382 manifest,
2383 };
2384 if only.is_empty() {
2387 freeze_tests(
2388 &ctx.plane_dir,
2389 &ctx.feature,
2390 &f,
2391 &keep,
2392 &format!(
2393 "run:{run}{}",
2394 if only.is_empty() { "" } else { ":amendment" }
2395 ),
2396 Decided {
2397 by: "speccoder run".to_owned(),
2398 via: Via::Terminal,
2399 at: now(),
2400 },
2401 Producer::Run,
2402 )
2403 .map_err(failed)?;
2404 }
2405 Ok(RunOracle {
2406 tests: keep
2407 .iter()
2408 .map(|t| FrozenTest {
2409 path: t.path.clone(),
2410 sha256: t.sha256.clone(),
2411 argv: t.argv.clone(),
2412 scenarios: t.scenarios.clone(),
2413 })
2414 .collect(),
2415 contents: kept_contents,
2416 contracts: draft.expectations.sample1.clone(),
2417 untestable: draft.untestable.sample1.clone(),
2418 })
2419}
2420
2421pub(crate) fn refreeze(
2428 project_state: &Path,
2429 unit: &str,
2430 key: &str,
2431 tests: Vec<FrozenTest>,
2432) -> Result<(), String> {
2433 let mut frozen = load_frozen(project_state, unit, key)
2434 .ok_or_else(|| format!("{key} has no frozen oracle here"))?;
2435 frozen.manifest_sha256 = manifest_digest(
2436 tests
2437 .iter()
2438 .map(|t| (t.path.as_str(), t.sha256.as_str(), t.argv.as_slice())),
2439 );
2440 frozen.tests = tests;
2441 let text = serde_json::to_string_pretty(&frozen).map_err(|e| e.to_string())?;
2442 write_atomic(&dir(project_state, unit, key).join("frozen.json"), &text)
2443}
2444
2445#[derive(Debug)]
2447pub(crate) enum TaskReuse {
2448 Ready {
2450 record: Box<PreFrozenAcceptance>,
2452 files: Vec<(String, String)>,
2454 tests: Vec<crate::pipeline::ReusedTest>,
2456 manifest: String,
2458 },
2459 Reused {
2461 req: String,
2463 },
2464 Elsewhere {
2466 req: String,
2468 },
2469 Lapsed {
2471 req: String,
2473 frozen: String,
2475 current: String,
2477 },
2478 Tampered(String),
2480 Unreadable(String),
2482}
2483
2484pub(crate) fn for_task(
2489 project_state: &Path,
2490 project: &Path,
2491 wt_root: &Path,
2492 format: &dyn Adapter,
2493 snapshot: &ProjectSnapshot,
2494 scenarios: &[speccoder_core::spec::ScenarioRef],
2495) -> Option<TaskReuse> {
2496 let f = snapshot.feature.as_ref()?;
2497 let unit = f.feature.name.as_str();
2498 let (entries, approval) = match crate::review::oracle_entries(project, &f.feature.dir) {
2499 Ok(x) => x,
2500 Err(e) => return Some(TaskReuse::Unreadable(e)),
2502 };
2503 if entries.is_empty() {
2504 return None;
2505 }
2506 let ids: Vec<&str> = scenarios.iter().map(|s| s.id.as_str()).collect();
2507 let requirements = format.oracle_requirements(snapshot);
2508 let (req, entry) = requirements.iter().find_map(|r| {
2509 let e = entries.get(&r.key)?;
2510 r.scenarios
2511 .iter()
2512 .any(|s| ids.contains(&s.id.as_str()))
2513 .then_some((r, e))
2514 })?;
2515 let digest = req.digest();
2516 if entry.requirement_sha256 != digest {
2517 return Some(TaskReuse::Lapsed {
2518 req: req.key.clone(),
2519 frozen: entry.requirement_sha256.clone(),
2520 current: digest,
2521 });
2522 }
2523 let (record, files) = match crate::pre_frozen::load(project_state, unit, &req.key) {
2524 Ok(Some(x)) => x,
2525 Ok(None) => {
2526 return Some(TaskReuse::Elsewhere {
2527 req: req.key.clone(),
2528 });
2529 }
2530 Err(t) => return Some(TaskReuse::Tampered(t.0)),
2531 };
2532 let needle = format!("Acceptance: review manifest={} ", entry.manifest_sha256);
2536 let reused = crate::git::Git::at(wt_root)
2537 .run(&[
2538 "log",
2539 "--format=%H",
2540 "--fixed-strings",
2541 &format!("--grep={needle}"),
2542 "HEAD",
2543 ])
2544 .map(|out| !out.is_empty());
2545 match reused {
2546 Ok(true) => {
2547 return Some(TaskReuse::Reused {
2548 req: req.key.clone(),
2549 });
2550 }
2551 Ok(false) => {}
2552 Err(e) => {
2553 return Some(TaskReuse::Unreadable(format!(
2554 "the worktree's history cannot be read: {}",
2555 e.0
2556 )));
2557 }
2558 }
2559 if !record.is_current(&digest) {
2560 return Some(TaskReuse::Lapsed {
2561 req: req.key.clone(),
2562 frozen: record.wording_digest.clone(),
2563 current: digest,
2564 });
2565 }
2566 let Some(frozen) = load_frozen(project_state, unit, &req.key) else {
2567 return Some(TaskReuse::Tampered(format!(
2568 "{}'s frozen commands are missing from the state directory",
2569 req.key
2570 )));
2571 };
2572 let manifest = manifest_digest(
2573 frozen
2574 .tests
2575 .iter()
2576 .map(|t| (t.path.as_str(), t.sha256.as_str(), t.argv.as_slice())),
2577 );
2578 let same_files = frozen.tests.len() == record.visible.len()
2579 && frozen.tests.iter().all(|t| {
2580 record
2581 .visible
2582 .iter()
2583 .any(|v| v.path == t.path && v.sha256 == t.sha256)
2584 });
2585 if manifest != entry.manifest_sha256 || manifest != frozen.manifest_sha256 || !same_files {
2586 return Some(TaskReuse::Tampered(format!(
2587 "{}'s frozen tests no longer match the manifest review.json names",
2588 req.key
2589 )));
2590 }
2591 if approval.as_deref() != Some(record.approval_digest.as_str()) {
2594 return Some(TaskReuse::Tampered(format!(
2595 "{}'s frozen set names another approval than review.json{}",
2596 req.key,
2597 if approval.is_none() {
2598 " (which records none)"
2599 } else {
2600 ""
2601 }
2602 )));
2603 }
2604 let sealed = record
2605 .held_out_sealed
2606 .as_ref()
2607 .map(|h| format!("sha256:{}", h.manifest_sha256));
2608 if sealed != entry.held_out_sha256 {
2609 return Some(TaskReuse::Tampered(format!(
2610 "{}'s frozen held-out set is not the one review.json names",
2611 req.key
2612 )));
2613 }
2614 let tests = frozen
2615 .tests
2616 .iter()
2617 .map(|t| crate::pipeline::ReusedTest {
2618 path: t.path.clone(),
2619 cites: t.scenarios.clone(),
2620 argv: t.argv.clone(),
2621 green: false,
2622 })
2623 .collect();
2624 Some(TaskReuse::Ready {
2625 record: Box::new(record),
2626 files,
2627 tests,
2628 manifest,
2629 })
2630}
2631
2632pub(crate) fn note_lapse(project_state: &Path, unit: &str, req: &str, frozen: &str) -> bool {
2635 let file = project_state.join(DIR).join(unit).join("lapsed.json");
2636 let mut seen: Vec<String> = std::fs::read_to_string(&file)
2637 .ok()
2638 .and_then(|t| serde_json::from_str(&t).ok())
2639 .unwrap_or_default();
2640 let key = format!("{req}={frozen}");
2641 if seen.contains(&key) {
2642 return false;
2643 }
2644 seen.push(key);
2645 let _ = write_atomic(&file, &serde_json::to_string(&seen).unwrap_or_default());
2646 true
2647}
2648
2649#[must_use]
2651pub fn autopilot_denials(
2652 task: &str,
2653 tool_calls: &[Value],
2654) -> Vec<speccoder_core::oracle::AutopilotDenial> {
2655 tool_calls
2656 .iter()
2657 .enumerate()
2658 .filter(|(_, c)| {
2659 c["decision"] == "deny" && c["reason"].as_str() == Some(tools::policy::AUTOPILOT_DENIED)
2660 })
2661 .map(|(i, c)| {
2662 let object: Option<tools::policy::Object> =
2663 serde_json::from_value(c["object"].clone()).ok();
2664 speccoder_core::oracle::AutopilotDenial {
2665 task: task.to_owned(),
2666 turn: c["turn"]
2667 .as_u64()
2668 .and_then(|n| u32::try_from(n).ok())
2669 .unwrap_or_else(|| u32::try_from(i + 1).unwrap_or(u32::MAX)),
2670 class: object
2671 .as_ref()
2672 .map(|o| o.class().as_str().to_owned())
2673 .unwrap_or_default(),
2674 object: object.as_ref().map_or_else(
2675 || {
2676 c["arguments"]["path"]
2677 .as_str()
2678 .map(str::to_owned)
2679 .or_else(|| {
2680 c["arguments"]["argv"].as_array().map(|a| {
2681 a.iter()
2682 .filter_map(Value::as_str)
2683 .collect::<Vec<_>>()
2684 .join(" ")
2685 })
2686 })
2687 .unwrap_or_else(|| c["tool"].as_str().unwrap_or_default().to_owned())
2688 },
2689 tools::policy::Object::describe,
2690 ),
2691 reason: tools::policy::AUTOPILOT_DENIED.to_owned(),
2692 }
2693 })
2694 .collect()
2695}
2696
2697#[must_use]
2699pub fn last_denials(
2700 project_state: &Path,
2701 unit: &str,
2702) -> Vec<speccoder_core::oracle::AutopilotDenial> {
2703 std::fs::read_to_string(project_state.join(DIR).join(unit).join("autopilot.json"))
2704 .ok()
2705 .and_then(|t| serde_json::from_str(&t).ok())
2706 .unwrap_or_default()
2707}
2708
2709pub(crate) fn record_denials(
2711 project_state: &Path,
2712 unit: &str,
2713 denials: &[speccoder_core::oracle::AutopilotDenial],
2714) {
2715 let file = project_state.join(DIR).join(unit).join("autopilot.json");
2716 if denials.is_empty() {
2717 let _ = std::fs::remove_file(file);
2718 return;
2719 }
2720 let _ = write_atomic(
2721 &file,
2722 &serde_json::to_string_pretty(denials).unwrap_or_default(),
2723 );
2724}
2725
2726#[cfg(test)]
2727mod tests {
2728 use super::*;
2729
2730 fn draft(content: &str) -> Draft {
2731 Draft {
2732 requirement: DraftRequirement {
2733 key: "US1".to_owned(),
2734 title: "Greet".to_owned(),
2735 text: "### User Story 1 - Greet".to_owned(),
2736 sha256: "sha256:w".to_owned(),
2737 },
2738 samples: 2,
2739 tests: vec![DraftTest {
2740 path: "tests/acceptance_us1.rs".to_owned(),
2741 sha256: digest_of(content),
2742 scenarios: vec!["US1-1".to_owned()],
2743 argv: vec!["cargo".to_owned(), "test".to_owned()],
2744 red_class: RedClass::Assertion,
2745 authored_by: AuthoredBy::Model,
2746 edited_by: None,
2747 }],
2748 discarded: Vec::new(),
2749 rejected: Vec::new(),
2750 expectations: Samples::default(),
2751 untestable: Samples::default(),
2752 ambiguities: Vec::new(),
2753 held_out: HeldOutSummary {
2754 state: "absent".to_owned(),
2755 count: 0,
2756 manifest_sha256: None,
2757 reason: None,
2758 discarded: Vec::new(),
2759 },
2760 sealed: None,
2761 notes: Vec::new(),
2762 runs: Vec::new(),
2763 context: Vec::new(),
2764 }
2765 }
2766
2767 #[test]
2768 fn a_draft_round_trips_and_a_changed_test_is_tampering() {
2769 let state = tempfile::tempdir().unwrap_or_else(|e| panic!("{e}"));
2770 let d = draft("#[test] fn t() {}");
2771 let files = vec![(
2772 "tests/acceptance_us1.rs".to_owned(),
2773 "#[test] fn t() {}".to_owned(),
2774 )];
2775 store(state.path(), "001-greet", &d, &files).unwrap_or_else(|e| panic!("{e}"));
2776 let (back, contents) = load(state.path(), "001-greet", "US1")
2777 .unwrap_or_else(|e| panic!("{e:?}"))
2778 .unwrap_or_else(|| panic!("stored"));
2779 assert_eq!(back, d);
2780 assert_eq!(contents, files);
2781 std::fs::write(
2782 dir(state.path(), "001-greet", "US1").join("files/tests/acceptance_us1.rs"),
2783 "changed",
2784 )
2785 .unwrap_or_else(|e| panic!("{e}"));
2786 assert!(load(state.path(), "001-greet", "US1").is_err());
2787 assert!(store(state.path(), "001-greet", &d, &[]).is_err());
2788 assert!(
2789 load(state.path(), "001-greet", "US2")
2790 .unwrap_or_default()
2791 .is_none()
2792 );
2793 }
2794
2795 #[test]
2796 fn the_manifest_names_paths_contents_and_commands() {
2797 let argv = vec!["cargo".to_owned()];
2798 let other = vec!["make".to_owned()];
2799 let a = manifest_digest([("a", "sha256:1", argv.as_slice())]);
2800 assert_eq!(a, manifest_digest([("a", "sha256:1", argv.as_slice())]));
2801 assert_ne!(a, manifest_digest([("a", "sha256:2", argv.as_slice())]));
2802 assert_ne!(a, manifest_digest([("a", "sha256:1", other.as_slice())]));
2803 let both = manifest_digest([("a", "s", argv.as_slice()), ("b", "s", argv.as_slice())]);
2804 assert_eq!(
2805 both,
2806 manifest_digest([("b", "s", argv.as_slice()), ("a", "s", argv.as_slice())])
2807 );
2808 let mut d = draft("x");
2809 assert!(d.manifest().is_some());
2810 d.tests[0].red_class = RedClass::Passed;
2811 assert!(d.manifest().is_none());
2812 assert_eq!(slug("cap: a / b"), "cap__a___b");
2813 }
2814
2815 #[test]
2816 fn a_lapse_is_noted_once() {
2817 let state = tempfile::tempdir().unwrap_or_else(|e| panic!("{e}"));
2818 assert!(note_lapse(state.path(), "u", "US1", "sha256:a"));
2819 assert!(!note_lapse(state.path(), "u", "US1", "sha256:a"));
2820 assert!(note_lapse(state.path(), "u", "US1", "sha256:b"));
2821 }
2822}