fsci-conformance 0.3.0

Differential conformance testing harness for FrankenSciPy
#![forbid(unsafe_code)]
//! Live SciPy differential coverage for fsci_sparse::bellman_ford.
//!
//! Resolves [frankenscipy-hl6fj]. 1e-12 abs on distance vectors.

use std::collections::{BTreeMap, HashMap};
use std::fs;
use std::io::Write;
use std::path::PathBuf;
use std::process::Stdio;
use std::time::{Instant, SystemTime, UNIX_EPOCH};

use fsci_conformance::{ArmCounts, CompareLedger};
use fsci_sparse::{CsrMatrix, Shape2D, bellman_ford};
use serde::{Deserialize, Serialize};

const PACKET_ID: &str = "FSCI-P2C-007";
const ABS_TOL: f64 = 1.0e-12;
const REQUIRE_SCIPY_ENV: &str = "FSCI_REQUIRE_SCIPY_ORACLE";

#[derive(Debug, Clone, Serialize)]
struct PointCase {
    case_id: String,
    rows: usize,
    cols: usize,
    adj_flat: Vec<f64>,
    source: usize,
}

#[derive(Debug, Clone, Serialize)]
struct OracleQuery {
    points: Vec<PointCase>,
}

#[derive(Debug, Clone, Deserialize)]
struct PointArm {
    case_id: String,
    distances: Option<Vec<f64>>,
}

#[derive(Debug, Clone, Deserialize)]
struct OracleResult {
    points: Vec<PointArm>,
}

#[derive(Debug, Clone, Serialize)]
struct CaseDiff {
    case_id: String,
    abs_diff: f64,
    pass: bool,
}

#[derive(Debug, Clone, Serialize)]
struct DiffLog {
    test_id: String,
    category: String,
    case_count: usize,
    compared: BTreeMap<String, ArmCounts>,
    max_abs_diff: f64,
    pass: bool,
    timestamp_ms: u128,
    duration_ns: u128,
    cases: Vec<CaseDiff>,
}

fn output_dir() -> PathBuf {
    PathBuf::from(env!("CARGO_MANIFEST_DIR")).join(format!("fixtures/artifacts/{PACKET_ID}/diff"))
}

fn ensure_output_dir() {
    fs::create_dir_all(output_dir()).expect("create bellman diff output dir");
}

fn timestamp_ms() -> u128 {
    SystemTime::now()
        .duration_since(UNIX_EPOCH)
        .map_or(0, |d| d.as_millis())
}

fn emit_log(log: &DiffLog) {
    ensure_output_dir();
    let path = output_dir().join(format!("{}.json", log.test_id));
    let json = serde_json::to_string_pretty(log).expect("serialize bellman diff log");
    fs::write(path, json).expect("write bellman diff log");
}

fn dense_to_csr(rows: usize, cols: usize, dense: &[f64]) -> CsrMatrix {
    let mut data = Vec::new();
    let mut indices = Vec::new();
    let mut indptr = Vec::with_capacity(rows + 1);
    indptr.push(0);
    for r in 0..rows {
        for c in 0..cols {
            let v = dense[r * cols + c];
            if v != 0.0 {
                data.push(v);
                indices.push(c);
            }
        }
        indptr.push(data.len());
    }
    CsrMatrix::from_components(Shape2D::new(rows, cols), data, indices, indptr, true)
        .expect("dense_to_csr build")
}

fn generate_query() -> OracleQuery {
    let adj_6 = vec![
        0.0, 7.0, 9.0, 0.0, 0.0, 14.0, 7.0, 0.0, 10.0, 15.0, 0.0, 0.0, 9.0, 10.0, 0.0, 11.0, 0.0,
        2.0, 0.0, 15.0, 11.0, 0.0, 6.0, 0.0, 0.0, 0.0, 0.0, 6.0, 0.0, 9.0, 14.0, 0.0, 2.0, 0.0,
        9.0, 0.0,
    ];
    let adj_4_chain = vec![
        0.0, 1.0, 0.0, 0.0, 1.0, 0.0, 2.0, 0.0, 0.0, 2.0, 0.0, 3.0, 0.0, 0.0, 3.0, 0.0,
    ];
    let adj_5_star = vec![
        0.0, 2.0, 3.0, 5.0, 1.0, 2.0, 0.0, 0.0, 0.0, 0.0, 3.0, 0.0, 0.0, 0.0, 0.0, 5.0, 0.0, 0.0,
        0.0, 0.0, 1.0, 0.0, 0.0, 0.0, 0.0,
    ];

    let mut points = Vec::new();
    for source in [0_usize, 2, 5] {
        points.push(PointCase {
            case_id: format!("6n_s{source}"),
            rows: 6,
            cols: 6,
            adj_flat: adj_6.clone(),
            source,
        });
    }
    for source in [0_usize, 3] {
        points.push(PointCase {
            case_id: format!("4n_chain_s{source}"),
            rows: 4,
            cols: 4,
            adj_flat: adj_4_chain.clone(),
            source,
        });
    }
    for source in [0_usize, 3] {
        points.push(PointCase {
            case_id: format!("5n_star_s{source}"),
            rows: 5,
            cols: 5,
            adj_flat: adj_5_star.clone(),
            source,
        });
    }
    OracleQuery { points }
}

fn scipy_oracle_or_skip(query: &OracleQuery) -> Option<OracleResult> {
    let script = r#"
import json
import math
import sys
import numpy as np
from scipy.sparse import csr_matrix
from scipy.sparse.csgraph import bellman_ford

q = json.load(sys.stdin)
points = []
for case in q["points"]:
    cid = case["case_id"]
    r = int(case["rows"]); c = int(case["cols"])
    adj = np.array(case["adj_flat"], dtype=float).reshape(r, c)
    s = int(case["source"])
    try:
        dist = bellman_ford(csr_matrix(adj), directed=False, indices=s)
        flat = []
        for v in dist.tolist():
            if v == float("inf"):
                flat.append(1e308)
            else:
                flat.append(float(v))
        points.append({"case_id": cid, "distances": flat})
    except Exception:
        points.append({"case_id": cid, "distances": None})
print(json.dumps({"points": points}))
"#;
    let query_json = serde_json::to_string(query).expect("serialize bellman query");
    let mut child = match fsci_conformance::scipy_oracle_command()
        .arg("-c")
        .arg(script)
        .stdin(Stdio::piped())
        .stdout(Stdio::piped())
        .stderr(Stdio::piped())
        .spawn()
    {
        Ok(c) => c,
        Err(e) => {
            assert!(
                std::env::var(REQUIRE_SCIPY_ENV).is_err(),
                "failed to spawn python3 for bellman oracle: {e}"
            );
            eprintln!("skipping bellman oracle: python3 not available ({e})");
            return None;
        }
    };
    {
        let stdin = child.stdin.as_mut().expect("open bellman oracle stdin");
        if let Err(err) = stdin.write_all(query_json.as_bytes()) {
            let output = child.wait_with_output().expect("wait for failed oracle");
            let stderr = String::from_utf8_lossy(&output.stderr);
            assert!(
                std::env::var(REQUIRE_SCIPY_ENV).is_err(),
                "bellman oracle stdin write failed: {err}; stderr: {stderr}"
            );
            eprintln!("skipping bellman oracle: stdin write failed ({err})\n{stderr}");
            return None;
        }
    }
    let output = child.wait_with_output().expect("wait for bellman oracle");
    if !output.status.success() {
        let stderr = String::from_utf8_lossy(&output.stderr);
        assert!(
            std::env::var(REQUIRE_SCIPY_ENV).is_err(),
            "bellman oracle failed: {stderr}"
        );
        eprintln!("skipping bellman oracle: scipy not available\n{stderr}");
        return None;
    }
    let stdout = String::from_utf8_lossy(&output.stdout);
    Some(serde_json::from_str(&stdout).expect("parse bellman oracle JSON"))
}

#[test]
fn diff_sparse_bellman_ford() {
    let query = generate_query();
    let Some(oracle) = scipy_oracle_or_skip(&query) else {
        return;
    };
    assert_eq!(oracle.points.len(), query.points.len());

    let pmap: HashMap<String, PointArm> = oracle
        .points
        .into_iter()
        .map(|d| (d.case_id.clone(), d))
        .collect();

    let start = Instant::now();
    let mut diffs = Vec::new();
    let mut max_overall = 0.0_f64;
    let mut ledger = CompareLedger::new("diff_sparse_bellman_ford", &["bellman_ford"]);

    for case in &query.points {
        let scipy_arm = pmap.get(&case.case_id).expect("validated oracle");
        let csr = dense_to_csr(case.rows, case.cols, &case.adj_flat);
        let fsci_d = bellman_ford(&csr, false, case.source)
            .ok()
            .map(|res| res.distances);
        let Some((scipy_d, fsci_d)) = ledger.both(
            "bellman_ford",
            &case.case_id,
            scipy_arm.distances.as_ref(),
            fsci_d,
        ) else {
            continue;
        };
        let abs_d = if fsci_d.len() != scipy_d.len() {
            f64::INFINITY
        } else {
            fsci_d
                .iter()
                .zip(scipy_d.iter())
                .map(|(a, b)| {
                    let a_inf = a.is_infinite();
                    let b_sent = *b >= 1.0e307;
                    if a_inf && b_sent {
                        0.0
                    } else if a_inf || b_sent {
                        f64::INFINITY
                    } else {
                        (a - b).abs()
                    }
                })
                .fold(0.0_f64, f64::max)
        };
        // The max fold drops a NaN distance (0.0_f64.max(NaN) is 0.0), so reject one here.
        let pass = abs_d <= ABS_TOL && !fsci_d.iter().any(|v| v.is_nan());
        max_overall = max_overall.max(abs_d);
        ledger.compared("bellman_ford", &case.case_id, pass);
        diffs.push(CaseDiff {
            case_id: case.case_id.clone(),
            abs_diff: abs_d,
            pass,
        });
    }

    let all_pass = diffs.iter().all(|d| d.pass);

    let log = DiffLog {
        test_id: "diff_sparse_bellman_ford".into(),
        category: "scipy.sparse.csgraph.bellman_ford".into(),
        case_count: diffs.len(),
        compared: ledger.counts().clone(),
        max_abs_diff: max_overall,
        pass: all_pass,
        timestamp_ms: timestamp_ms(),
        duration_ns: start.elapsed().as_nanos(),
        cases: diffs.clone(),
    };
    emit_log(&log);

    for d in &diffs {
        if !d.pass {
            eprintln!("bellman mismatch: {} abs_diff={}", d.case_id, d.abs_diff);
        }
    }

    assert!(
        all_pass,
        "bellman_ford conformance failed: {} cases, max_diff={}",
        diffs.len(),
        max_overall
    );
    ledger.finish(query.points.len());
}