onetaskgraph-github-projects 0.7.0

//! Structural and residue-free write verification against GitHub's real Projects v2 API.
//!
//! This target is the credential's half alone: it points [`journey::enter`] at GitHub with
//! the process environment, which decides whether the lane may run and under which stamp,
//! opens the one session that may hold the credential, and hands the whole journey to
//! [`journey::run`]. The journey itself is shared, because the same code
//! is driven a second time against this crate's loopback fixture board — with no credential
//! — to count what one session costs. Two spellings of one journey would measure two
//! journeys.

use std::env;

use onetaskgraph_live::{Exclusivity, Session};

// The stand-ins that prove the budget precondition build their answers from `journey`'s
// own pinned names, and this target reaches none of them: it points the journey at GitHub,
// which needs no stand-in. So what it does not use is the other drives' rather than dead
// code — the same reason `tests/plugin.rs` carries this.
#[allow(dead_code)]
mod journey;
// Likewise `lane`: this target names only `SESSION_NAME`, and its other helpers are the
// admission, stamp and cleanup the fixture drives and `tests/lane_shape.rs` exercise.
#[allow(dead_code)]
mod lane;

use lane::SESSION_NAME;

#[tokio::test]
async fn real_projects_v2_contract_writes_and_leaves_no_residue() {
    if !onetaskgraph_github_live::quota::live_selected().unwrap() {
        journey::say(
            "GitHub live journey did not run: existing selection policy did not select the lane",
        );
        return;
    }
    journey::against(journey::Endpoints::configured().unwrap());
    // `Shared`: this lane takes no seat. Every artifact it writes carries this process's own
    // stamp, its cleanup removes only those, and what it recovers of an interrupted run's is
    // decided by that artifact's own stamp — so two sessions of this lane cannot reach each
    // other's work and there is nothing left for a seat to protect. What it never protected
    // is the case that remains: the hosted check runs on three platforms and a file on one
    // runner excludes nothing on another. The precondition that can decline this lane is the
    // budget one, inside `journey::run`, which `scripts/check-budget-decline.sh` drives
    // through to a red check without a credential. A session that is refused did not run and
    // did not pass, and says so.
    let mut recording = None;
    journey::enter(
        &|variable| match env::var(variable) {
            Ok(value) => Some(value),
            Err(env::VarError::NotPresent) => None,
            Err(env::VarError::NotUnicode(_)) => panic!("{variable} must be Unicode"),
        },
        |token| {
            let session = Session::open(SESSION_NAME, token, Exclusivity::Shared)
                .unwrap_or_else(|declined| declined.refuse());
            recording = Some(
                journey::quota::start(
                    onetaskgraph_github_live::quota::EntryPoint::Main,
                    std::sync::Arc::clone(&journey::SESSION),
                    onetaskgraph_github_live::quota::reference_workload(),
                )
                .unwrap_or_else(|error| panic!("live-session telemetry cannot start: {error}")),
            );
            session
        },
    )
    .await
    .unwrap_or_else(|error| panic!("the GitHub Projects live lane cannot run: {error}"));
    if recording.is_some() {
        journey::quota::complete()
            .unwrap_or_else(|error| panic!("live-session telemetry incomplete: {error}"));
    }
}

#[test]
fn propagated_selection_prevents_the_main_entry_point_from_opening_a_session() {
    for (selection, succeeds, message) in [
        (
            "not-selected",
            true,
            "existing selection policy did not select the lane",
        ),
        (
            "wrong",
            false,
            "GITHUB_LIVE_SELECTION must be run or not-selected",
        ),
    ] {
        let directory = tempfile::tempdir().unwrap();
        let output = std::process::Command::new(std::env::current_exe().unwrap())
            .args([
                "real_projects_v2_contract_writes_and_leaves_no_residue",
                "--exact",
                "--nocapture",
            ])
            .env("GITHUB_LIVE_SELECTION", selection)
            .env("ONETASKGRAPH_LIVE_REQUIRED", "1")
            .env("GH_PROJECTS_TOKEN", "test-token")
            .env("GH_PROJECTS_OWNER", "fixture-owner")
            .env("GH_PROJECTS_NUMBER", "1")
            .env("GH_PROJECTS_REPOSITORY", "fixture-owner/repository")
            .env("GITHUB_LIVE_SESSION_DIR", directory.path())
            .output()
            .unwrap();
        assert_eq!(
            output.status.success(),
            succeeds,
            "{}",
            String::from_utf8_lossy(&output.stderr)
        );
        assert!(String::from_utf8_lossy(&output.stderr).contains(message));
        assert!(!directory.path().join("main.json").exists());
    }
}

#[test]
fn loopback_configuration_cannot_forward_a_credential_to_a_remote_or_signed_url() {
    for (graphql, rest) in [
        ("https://api.github.com/graphql", "http://127.0.0.1:12345"),
        ("http://example.com:12345/graphql", "http://127.0.0.1:12345"),
        (
            "http://user:secret@127.0.0.1:12345/graphql",
            "http://127.0.0.1:12345",
        ),
        (
            "http://127.0.0.1:12345/graphql?token=secret",
            "http://127.0.0.1:12345",
        ),
        ("http://127.0.0.1:12345/graphql", "https://api.github.com"),
    ] {
        let output = std::process::Command::new(std::env::current_exe().unwrap())
            .args([
                "real_projects_v2_contract_writes_and_leaves_no_residue",
                "--exact",
                "--nocapture",
            ])
            .env("GITHUB_LIVE_SELECTION", "run")
            .env("GITHUB_LIVE_TEST_GRAPHQL", graphql)
            .env("GITHUB_LIVE_TEST_REST", rest)
            .env("GH_PROJECTS_TOKEN", "test-token")
            .output()
            .unwrap();
        assert!(!output.status.success());
        assert!(String::from_utf8_lossy(&output.stderr).contains("plain HTTP loopback URLs"));
    }
    let real = journey::Endpoints::github();
    assert!(
        real.settle
            > onetaskgraph_github_projects::change_token::SETTLED
                .to_std()
                .unwrap()
    );
}

#[test]
fn the_actual_main_entry_point_reaches_only_its_loopback_allowance_boundary() {
    use std::io::{BufRead, Write};
    let listener = std::net::TcpListener::bind("127.0.0.1:0").unwrap();
    let host = format!("http://{}", listener.local_addr().unwrap());
    let server = std::thread::spawn(move || {
        let (mut stream, _) = listener.accept().unwrap();
        let mut reader = std::io::BufReader::new(&stream);
        let mut request = String::new();
        loop {
            let mut line = String::new();
            assert!(reader.read_line(&mut line).unwrap() > 0);
            if line == "\r\n" {
                break;
            }
            request.push_str(&line);
        }
        assert!(request.starts_with("GET /rate_limit "));
        assert!(
            request
                .to_ascii_lowercase()
                .contains("authorization: bearer test-token")
        );
        let body = journey::budget::documented_answer(4321, 0, 4321, 1775000000).to_string();
        write!(stream, "HTTP/1.1 200 OK\r\nContent-Type: application/json\r\nContent-Length: {}\r\nConnection: close\r\n\r\n{body}", body.len()).unwrap();
    });
    let output = std::process::Command::new(std::env::current_exe().unwrap())
        .args([
            "real_projects_v2_contract_writes_and_leaves_no_residue",
            "--exact",
            "--nocapture",
        ])
        .env("GITHUB_LIVE_SELECTION", "run")
        .env("GITHUB_LIVE_TEST_GRAPHQL", format!("{host}/graphql"))
        .env("GITHUB_LIVE_TEST_REST", &host)
        .env("ONETASKGRAPH_LIVE_REQUIRED", "1")
        .env("GH_PROJECTS_TOKEN", "test-token")
        .env("GH_PROJECTS_OWNER", "fixture-owner")
        .env("GH_PROJECTS_NUMBER", "1")
        .env("GH_PROJECTS_REPOSITORY", "fixture-owner/repository")
        .env_remove("GITHUB_LIVE_SESSION_DIR")
        .output()
        .unwrap();
    server.join().unwrap();
    assert!(!output.status.success());
    let said = String::from_utf8_lossy(&output.stderr);
    assert!(said.contains("DID NOT RUN"), "{said}");
    // The design total (`tests/fixtures/session-cost.md`).
    assert!(said.contains("estimated to spend 327"), "{said}");
}

#[test]
fn malformed_required_flag_cannot_become_an_optional_main_skip() {
    let output = std::process::Command::new(std::env::current_exe().unwrap())
        .args([
            "real_projects_v2_contract_writes_and_leaves_no_residue",
            "--exact",
            "--nocapture",
        ])
        .env("GITHUB_LIVE_SELECTION", "run")
        .env(
            "ONETASKGRAPH_LIVE_REQUIRED",
            journey::malformed_required_flag(),
        )
        .env_remove("GH_PROJECTS_OWNER")
        .env_remove("GH_PROJECTS_NUMBER")
        .env_remove("GH_PROJECTS_TOKEN")
        .env_remove("GH_PROJECTS_REPOSITORY")
        .env_remove("GITHUB_LIVE_TEST_GRAPHQL")
        .env_remove("GITHUB_LIVE_TEST_REST")
        .output()
        .unwrap();
    assert!(!output.status.success());
    assert!(String::from_utf8_lossy(&output.stderr).contains("ONETASKGRAPH_LIVE_REQUIRED must be"));
}