splashboard 0.3.0

//! `github_action_status` — current CI state for a repo, as a single badge plus optional
//! `Text` summary. Uses the latest workflow run across every workflow.

use async_trait::async_trait;
use serde::Deserialize;

use crate::options::OptionSchema;
use crate::payload::{BadgeData, Body, Payload, Status, TextData};
use crate::render::Shape;
use crate::samples;

use super::super::{FetchContext, FetchError, Fetcher, Safety};
use super::client::rest_get;
use super::common::{RepoSlug, cache_key, parse_options, payload, resolve_repo};

const SHAPES: &[Shape] = &[Shape::Badge, Shape::Text];

const OPTION_SCHEMAS: &[OptionSchema] = &[
    OptionSchema {
        name: "repo",
        type_hint: "\"owner/name\"",
        required: false,
        default: Some("git remote of cwd"),
        description: "Repository to query.",
    },
    OptionSchema {
        name: "branch",
        type_hint: "string",
        required: false,
        default: None,
        description: "Branch to filter the latest run by. Omit for the most recent run on any branch.",
    },
];

pub struct GithubActionStatus;

#[derive(Debug, Default, Deserialize)]
#[serde(deny_unknown_fields)]
pub struct Options {
    #[serde(default)]
    pub repo: Option<String>,
    #[serde(default)]
    pub branch: Option<String>,
}

#[async_trait]
impl Fetcher for GithubActionStatus {
    fn name(&self) -> &str {
        "github_action_status"
    }
    fn safety(&self) -> Safety {
        Safety::Safe
    }
    fn shapes(&self) -> &[Shape] {
        SHAPES
    }
    fn default_shape(&self) -> Shape {
        Shape::Badge
    }
    fn option_schemas(&self) -> &[OptionSchema] {
        OPTION_SCHEMAS
    }
    fn cache_key(&self, ctx: &FetchContext) -> String {
        let extra = repo_for_key(ctx);
        cache_key(self.name(), ctx, &extra)
    }
    fn sample_body(&self, shape: Shape) -> Option<Body> {
        Some(match shape {
            Shape::Badge => samples::badge(Status::Ok, "ci passing"),
            Shape::Text => samples::text("main · passing"),
            _ => return None,
        })
    }
    async fn fetch(&self, ctx: &FetchContext) -> Result<Payload, FetchError> {
        let opts: Options = parse_options(ctx.options.as_ref()).map_err(FetchError::Failed)?;
        let slug = resolve_repo(opts.repo.as_deref())?;
        let mut path = format!(
            "/repos/{}/{}/actions/runs?per_page=1",
            slug.owner, slug.name
        );
        if let Some(branch) = opts.branch.as_deref() {
            path.push_str(&format!("&branch={branch}"));
        }
        let res: RunsResponse = rest_get(&path).await?;
        let Some(run) = res.workflow_runs.into_iter().next() else {
            return Ok(payload(Body::Badge(BadgeData {
                status: Status::Warn,
                label: "no runs".into(),
            })));
        };
        Ok(payload(render_body(
            &run,
            ctx.shape.unwrap_or(Shape::Badge),
        )))
    }
}

#[derive(Debug, Deserialize)]
struct RunsResponse {
    #[serde(default)]
    workflow_runs: Vec<WorkflowRun>,
}

#[derive(Debug, Deserialize)]
struct WorkflowRun {
    #[serde(default)]
    status: String,
    #[serde(default)]
    conclusion: Option<String>,
    #[serde(default)]
    head_branch: Option<String>,
}

fn render_body(run: &WorkflowRun, shape: Shape) -> Body {
    let (status, label_word) = classify(run);
    match shape {
        Shape::Text => Body::Text(TextData {
            value: format!(
                "{} · {label_word}",
                run.head_branch.as_deref().unwrap_or("?")
            ),
        }),
        _ => Body::Badge(BadgeData {
            status,
            label: format!(
                "{} · {label_word}",
                run.head_branch.as_deref().unwrap_or("?")
            ),
        }),
    }
}

fn classify(run: &WorkflowRun) -> (Status, &'static str) {
    if run.status == "completed" {
        match run.conclusion.as_deref() {
            Some("success") => (Status::Ok, "passing"),
            Some("failure") | Some("timed_out") | Some("startup_failure") => {
                (Status::Error, "failing")
            }
            Some("cancelled") => (Status::Warn, "cancelled"),
            Some("neutral") | Some("skipped") => (Status::Warn, "skipped"),
            _ => (Status::Warn, "completed"),
        }
    } else {
        (Status::Warn, "running")
    }
}

fn repo_for_key(ctx: &FetchContext) -> String {
    ctx.options
        .as_ref()
        .and_then(|v| v.get("repo"))
        .and_then(|v| v.as_str())
        .map(String::from)
        .or_else(|| resolve_repo(None).ok().map(|s: RepoSlug| s.as_path()))
        .unwrap_or_default()
}

#[cfg(test)]
mod tests {
    use super::*;

    fn run(status: &str, conclusion: Option<&str>) -> WorkflowRun {
        WorkflowRun {
            status: status.into(),
            conclusion: conclusion.map(String::from),
            head_branch: Some("main".into()),
        }
    }

    #[test]
    fn completed_success_is_ok() {
        assert_eq!(classify(&run("completed", Some("success"))).0, Status::Ok);
    }

    #[test]
    fn completed_failure_is_error() {
        assert_eq!(
            classify(&run("completed", Some("failure"))).0,
            Status::Error
        );
    }

    #[test]
    fn in_progress_is_warn() {
        assert_eq!(classify(&run("in_progress", None)).0, Status::Warn);
    }
}