use std::collections::{HashMap, HashSet};
use async_trait::async_trait;
use serde::Deserialize;
use crate::ci::error::{CiError, Result};
use crate::ci::exec::CommandRunner;
use crate::ci::model::{
Annotation, AnnotationLevel, Artifact, Capabilities, CiJob, CiRun, DagSource, JobId, JobStatus,
LogChunk, LogMode, LogStepMeta, PrComment, PullRequest, RunDetail, RunExtras, RunId,
ts_sort_key,
};
use crate::ci::provider::{ForgeProvider, ProviderKind};
pub type YamlCache = std::sync::Arc<std::sync::Mutex<HashMap<String, String>>>;
pub struct GitHubProvider {
runner: Box<dyn CommandRunner>,
yaml_cache: YamlCache,
workflows: Vec<String>,
branch: Option<String>,
}
impl GitHubProvider {
pub fn new(
runner: Box<dyn CommandRunner>,
workflows: Vec<String>,
branch: Option<String>,
yaml_cache: YamlCache,
) -> Self {
Self {
runner,
yaml_cache,
workflows,
branch,
}
}
async fn api(&self, path: &str) -> Result<String> {
self.runner
.run("gh", &["api".to_owned(), path.to_owned()])
.await
}
async fn api_raw(&self, path: &str) -> Result<String> {
self.runner
.run(
"gh",
&[
"api".to_owned(),
"-H".to_owned(),
"Accept: application/vnd.github.raw".to_owned(),
path.to_owned(),
],
)
.await
}
async fn fetch_reusable(&self, uses: &str, head_sha: &str) -> Result<Vec<JobSpec>> {
let path = reusable_contents_path(uses, head_sha).ok_or_else(|| CiError::Parse {
what: "reusable uses".into(),
message: uses.to_owned(),
})?;
let cached = self
.yaml_cache
.lock()
.ok()
.and_then(|cache| cache.get(&path).cloned());
let body = if let Some(body) = cached {
body
} else {
let body = self.api_raw(&path).await?;
if let Ok(mut cache) = self.yaml_cache.lock() {
cache.insert(path, body.clone());
}
body
};
parse_workflow(&body)
}
async fn expand_jobs(
&self,
specs: &[JobSpec],
run_jobs: &[RunJob],
head_sha: &str,
) -> Vec<CiJob> {
let mut children: HashMap<&str, (&str, Vec<JobSpec>)> = HashMap::new();
for spec in specs {
if let Some(uses) = &spec.uses
&& let Ok(fetched) = self.fetch_reusable(uses, head_sha).await
&& !fetched.is_empty()
{
children.insert(spec.id.as_str(), (spec.label.as_str(), fetched));
}
}
let mut jobs = Vec::new();
for spec in specs {
match children.get(spec.id.as_str()) {
Some((_, kids)) => {
for kid in kids {
let id = scope(&spec.label, &kid.id);
let status_label = scope(&spec.label, &kid.label);
let needs = if kid.needs.is_empty() {
spec.needs
.iter()
.flat_map(|d| resolve_dep(d, &children))
.map(JobId)
.collect()
} else {
kid.needs
.iter()
.map(|n| JobId(scope(&spec.label, n)))
.collect()
};
jobs.push(CiJob {
name: child_display(&id, &status_label, run_jobs),
status: aggregate_status(&id, &status_label, run_jobs),
id: JobId(id),
needs,
});
}
}
None => jobs.push(CiJob {
id: JobId(spec.id.clone()),
name: spec.label.clone(),
status: aggregate_status(&spec.id, &spec.label, run_jobs),
needs: spec
.needs
.iter()
.flat_map(|d| resolve_dep(d, &children))
.map(JobId)
.collect(),
}),
}
}
jobs
}
async fn artifacts(&self, run: &RunId) -> Result<Vec<Artifact>> {
let raw = self
.api(&format!(
"repos/{{owner}}/{{repo}}/actions/runs/{}/artifacts",
run.0
))
.await?;
let list: ArtifactList = serde_json::from_str(&raw).map_err(|e| CiError::Parse {
what: "gh api artifacts".into(),
message: e.to_string(),
})?;
Ok(list.artifacts.into_iter().map(ArtifactItem::into).collect())
}
async fn annotations(&self, run: &RunId) -> Result<Vec<Annotation>> {
let raw = self
.api(&format!(
"repos/{{owner}}/{{repo}}/actions/runs/{}/jobs",
run.0
))
.await?;
let jobs: JobsApi = serde_json::from_str(&raw).map_err(|e| CiError::Parse {
what: "gh api jobs".into(),
message: e.to_string(),
})?;
let mut annotations = Vec::new();
for job in jobs.jobs {
let Ok(raw) = self
.api(&format!("{}/annotations", job.check_run_url))
.await
else {
continue;
};
let Ok(items) = serde_json::from_str::<Vec<AnnotationItem>>(&raw) else {
continue;
};
annotations.extend(items.into_iter().map(AnnotationItem::into));
}
Ok(annotations)
}
}
#[async_trait]
impl ForgeProvider for GitHubProvider {
fn kind(&self) -> ProviderKind {
ProviderKind::GitHub
}
fn capabilities(&self) -> Capabilities {
Capabilities {
dag: DagSource::ConfigFile,
logs: LogMode::Dump,
}
}
async fn list_runs(&self, limit: usize) -> Result<Vec<CiRun>> {
let mut args = vec!["run".to_owned(), "list".to_owned()];
if let Some(branch) = &self.branch {
args.push("--branch".to_owned());
args.push(branch.clone());
}
args.extend(
[
"-L",
&limit.to_string(),
"--json",
"databaseId,displayTitle,headBranch,headSha,status,conclusion,workflowName,createdAt,url",
]
.map(str::to_owned),
);
let out = self.runner.run("gh", &args).await?;
let raw: Vec<RunListItem> = serde_json::from_str(&out).map_err(|e| CiError::Parse {
what: "gh run list".into(),
message: e.to_string(),
})?;
Ok(raw.into_iter().map(RunListItem::into_run).collect())
}
async fn run_detail(&self, run: &RunId) -> Result<RunDetail> {
let args = [
"run",
"view",
&run.0,
"--json",
"jobs,displayTitle,headBranch,headSha,status,conclusion,workflowName,createdAt,url",
]
.map(str::to_owned);
let out = self.runner.run("gh", &args).await?;
let view: RunView = serde_json::from_str(&out).map_err(|e| CiError::Parse {
what: "gh run view".into(),
message: e.to_string(),
})?;
let specs = self
.workflows
.iter()
.find(|yaml| workflow_name(yaml).as_deref() == Some(view.workflow_name.as_str()))
.and_then(|yaml| parse_workflow(yaml).ok())
.unwrap_or_default();
let jobs = if specs.is_empty() {
view.jobs
.iter()
.map(|j| CiJob {
id: JobId(j.name.clone()),
name: j.name.clone(),
status: map_status(&j.status, j.conclusion.as_deref()),
needs: Vec::new(),
})
.collect()
} else {
self.expand_jobs(&specs, &view.jobs, &view.head_sha).await
};
Ok(RunDetail {
run: view.into_run(run.clone()),
jobs,
})
}
async fn job_log(&self, run: &RunId, job: &JobId, offset: u64) -> Result<LogChunk> {
let out = self
.api(&format!(
"repos/{{owner}}/{{repo}}/actions/runs/{}/jobs",
run.0
))
.await?;
let view: JobList = serde_json::from_str(&out).map_err(|e| CiError::Parse {
what: "gh api jobs".into(),
message: e.to_string(),
})?;
let job = view
.jobs
.iter()
.find(|j| j.name == job.0 || job_matches(&j.name, &job.0, &job.0))
.ok_or_else(|| CiError::NotFound(format!("job {} in run {}", job.0, run.0)))?;
let steps = job.steps.iter().map(RunStep::to_meta).collect();
let done = job.status == "completed";
let log_path = format!(
"repos/{{owner}}/{{repo}}/actions/jobs/{}/logs",
job.database_id
);
match self.api(&log_path).await {
Ok(full) => {
let mut start = usize::try_from(offset)
.unwrap_or(usize::MAX)
.min(full.len());
while start > 0 && !full.is_char_boundary(start) {
start -= 1;
}
let next_offset = full.len() as u64;
Ok(LogChunk {
text: full.get(start..).unwrap_or_default().to_owned(),
steps,
next_offset,
done,
})
}
Err(_) if !done => Ok(LogChunk {
text: String::new(),
steps,
next_offset: offset,
done: false,
}),
Err(err) => Err(err),
}
}
async fn run_extras(&self, run: &RunId) -> Result<RunExtras> {
Ok(RunExtras {
artifacts: self.artifacts(run).await.unwrap_or_default(),
annotations: self.annotations(run).await.unwrap_or_default(),
})
}
async fn list_prs(&self) -> Result<Vec<PullRequest>> {
let args = [
"pr",
"list",
"--limit",
"50",
"--json",
"number,title,url,baseRefName,headRefName,headRefOid,author",
]
.map(str::to_owned);
let raw = self.runner.run("gh", &args).await?;
let items: Vec<PrListItem> =
serde_json::from_str(&raw).map_err(|err| crate::ci::CiError::Parse {
what: "pr list".to_owned(),
message: err.to_string(),
})?;
Ok(items.into_iter().map(PrListItem::into_pr).collect())
}
async fn pr_comments(&self, number: u64) -> Result<Vec<PrComment>> {
let args = [
"api".to_owned(),
"--paginate".to_owned(),
format!("repos/{{owner}}/{{repo}}/pulls/{number}/comments"),
];
let raw = self.runner.run("gh", &args).await?;
let items: Vec<ReviewCommentApi> = serde_json::from_str(&raw).unwrap_or_default();
Ok(items
.into_iter()
.map(ReviewCommentApi::into_comment)
.collect())
}
async fn post_pr_comment(&self, new: &crate::ci::NewPrComment) -> Result<PrComment> {
let args = [
"api".to_owned(),
"-X".to_owned(),
"POST".to_owned(),
format!("repos/{{owner}}/{{repo}}/pulls/{}/comments", new.number),
"-f".to_owned(),
format!("body={}", new.body),
"-f".to_owned(),
format!("commit_id={}", new.head_oid),
"-f".to_owned(),
format!("path={}", new.path),
"-F".to_owned(),
format!("line={}", new.line),
"-f".to_owned(),
format!("side={}", if new.new_side { "RIGHT" } else { "LEFT" }),
];
let raw = self.runner.run("gh", &args).await?;
parse_posted(&raw)
}
async fn reply_pr_comment(
&self,
number: u64,
remote_id: &str,
body: &str,
) -> Result<PrComment> {
let args = [
"api".to_owned(),
"-X".to_owned(),
"POST".to_owned(),
format!("repos/{{owner}}/{{repo}}/pulls/{number}/comments/{remote_id}/replies"),
"-f".to_owned(),
format!("body={body}"),
];
let raw = self.runner.run("gh", &args).await?;
parse_posted(&raw)
}
async fn submit_pr_review(&self, review: &crate::ci::NewPrReview) -> Result<()> {
let comments: Vec<serde_json::Value> = review
.comments
.iter()
.map(|c| {
serde_json::json!({
"path": c.path,
"line": c.line,
"side": if c.new_side { "RIGHT" } else { "LEFT" },
"body": c.body,
})
})
.collect();
let payload = serde_json::json!({
"commit_id": review.head_oid,
"event": "COMMENT",
"comments": comments,
});
let input = std::env::temp_dir().join(format!("diffler-review-{}.json", review.number));
std::fs::write(&input, payload.to_string()).map_err(|err| crate::ci::CiError::Exec {
cmd: "write review payload".to_owned(),
message: err.to_string(),
})?;
let args = [
"api".to_owned(),
"-X".to_owned(),
"POST".to_owned(),
format!("repos/{{owner}}/{{repo}}/pulls/{}/reviews", review.number),
"--input".to_owned(),
input.to_string_lossy().into_owned(),
];
let result = self.runner.run("gh", &args).await;
let _ = std::fs::remove_file(&input);
result.map(|_| ())
}
async fn current_pr(&self) -> Result<Option<PullRequest>> {
let Some(branch) = &self.branch else {
return Ok(None);
};
let args = [
"pr",
"view",
branch,
"--json",
"number,title,url,baseRefName,headRefOid",
]
.map(str::to_owned);
let Ok(raw) = self.runner.run("gh", &args).await else {
return Ok(None);
};
let Ok(pr) = serde_json::from_str::<PrView>(&raw) else {
return Ok(None);
};
Ok(Some(PullRequest {
number: pr.number,
title: pr.title,
url: (!pr.url.is_empty()).then_some(pr.url),
base_ref: pr.base_ref_name,
head_ref: pr.head_ref_name,
head_oid: pr.head_ref_oid,
author: String::new(),
}))
}
}
struct JobSpec {
id: String,
label: String,
needs: Vec<String>,
uses: Option<String>,
}
fn workflow_name(yaml: &str) -> Option<String> {
let value: serde_norway::Value = serde_norway::from_str(yaml).ok()?;
value
.get("name")
.and_then(serde_norway::Value::as_str)
.map(str::to_owned)
}
fn parse_workflow(yaml: &str) -> Result<Vec<JobSpec>> {
let value: serde_norway::Value = serde_norway::from_str(yaml).map_err(|e| CiError::Parse {
what: "workflow YAML".into(),
message: e.to_string(),
})?;
let jobs = value
.get("jobs")
.and_then(serde_norway::Value::as_mapping)
.ok_or_else(|| CiError::Parse {
what: "workflow YAML".into(),
message: "no `jobs` mapping".into(),
})?;
let mut specs = Vec::new();
for (key, job) in jobs {
let Some(id) = key.as_str() else { continue };
let label = job
.get("name")
.and_then(serde_norway::Value::as_str)
.unwrap_or(id)
.to_owned();
specs.push(JobSpec {
id: id.to_owned(),
label,
needs: needs_of(job),
uses: job
.get("uses")
.and_then(serde_norway::Value::as_str)
.map(str::to_owned),
});
}
Ok(specs)
}
fn needs_of(job: &serde_norway::Value) -> Vec<String> {
match job.get("needs") {
Some(serde_norway::Value::String(one)) => vec![one.clone()],
Some(serde_norway::Value::Sequence(many)) => many
.iter()
.filter_map(|v| v.as_str().map(str::to_owned))
.collect(),
_ => Vec::new(),
}
}
fn scope(caller: &str, child: &str) -> String {
format!("{caller} / {child}")
}
fn reusable_contents_path(uses: &str, head_sha: &str) -> Option<String> {
if let Some(local) = uses.strip_prefix("./") {
return Some(format!(
"repos/{{owner}}/{{repo}}/contents/{local}?ref={head_sha}"
));
}
let (path, git_ref) = uses.rsplit_once('@')?;
let mut segments = path.splitn(3, '/');
let owner = segments.next()?;
let repo = segments.next()?;
let file = segments.next()?;
Some(format!(
"repos/{owner}/{repo}/contents/{file}?ref={git_ref}"
))
}
fn reusable_terminals(caller: &str, children: &[JobSpec]) -> Vec<String> {
let needed: HashSet<&str> = children
.iter()
.flat_map(|c| c.needs.iter().map(String::as_str))
.collect();
children
.iter()
.filter(|c| !needed.contains(c.id.as_str()))
.map(|c| scope(caller, &c.id))
.collect()
}
fn resolve_dep(dep: &str, expanded: &HashMap<&str, (&str, Vec<JobSpec>)>) -> Vec<String> {
match expanded.get(dep) {
Some((label, children)) => reusable_terminals(label, children),
None => vec![dep.to_owned()],
}
}
fn child_display(scoped_id: &str, scoped_label: &str, jobs: &[RunJob]) -> String {
if scoped_label.contains("${{") {
return jobs
.iter()
.find(|j| job_matches(&j.name, scoped_id, scoped_label))
.map_or_else(|| scoped_id.to_owned(), |j| j.name.clone());
}
scoped_label.to_owned()
}
fn name_matches(run_job_name: &str, candidate: &str) -> bool {
if let Some((prefix, _)) = candidate.split_once("${{") {
return !prefix.is_empty() && run_job_name.starts_with(prefix);
}
run_job_name == candidate
|| run_job_name.starts_with(&format!("{candidate} ("))
|| run_job_name.starts_with(&format!("{candidate} / "))
}
fn job_matches(run_job_name: &str, id: &str, label: &str) -> bool {
name_matches(run_job_name, label) || name_matches(run_job_name, id)
}
fn aggregate_status(id: &str, label: &str, jobs: &[RunJob]) -> JobStatus {
jobs.iter()
.filter(|j| job_matches(&j.name, id, label))
.map(|j| map_status(&j.status, j.conclusion.as_deref()))
.reduce(JobStatus::worse)
.unwrap_or(JobStatus::Queued)
}
fn map_status(status: &str, conclusion: Option<&str>) -> JobStatus {
match conclusion {
Some("success") => JobStatus::Ok,
Some("failure" | "timed_out" | "startup_failure") => JobStatus::Failed,
Some("skipped") => JobStatus::Skipped,
Some("cancelled") => JobStatus::Neutral,
_ => match status {
"in_progress" => JobStatus::Running,
"completed" => JobStatus::Neutral,
_ => JobStatus::Queued,
},
}
}
fn parse_created(raw: &str) -> Option<time::OffsetDateTime> {
time::OffsetDateTime::parse(raw, &time::format_description::well_known::Rfc3339).ok()
}
#[derive(Deserialize)]
struct RunListItem {
#[serde(rename = "databaseId")]
database_id: u64,
#[serde(rename = "displayTitle")]
display_title: String,
#[serde(rename = "headBranch")]
head_branch: String,
#[serde(rename = "headSha")]
head_sha: String,
status: String,
conclusion: Option<String>,
#[serde(rename = "workflowName")]
workflow_name: String,
#[serde(rename = "createdAt")]
created_at: String,
url: String,
}
impl RunListItem {
fn into_run(self) -> CiRun {
let name = if self.workflow_name.is_empty() {
self.display_title.clone()
} else {
self.workflow_name
};
CiRun {
id: RunId(self.database_id.to_string()),
name,
title: self.display_title,
branch: self.head_branch,
commit: self.head_sha,
author: String::new(),
created: parse_created(&self.created_at),
status: map_status(&self.status, self.conclusion.as_deref()),
url: Some(self.url),
remote: None,
}
}
}
#[derive(Deserialize)]
struct JobList {
jobs: Vec<RunJob>,
}
#[derive(Deserialize)]
struct RunView {
jobs: Vec<RunJob>,
#[serde(rename = "displayTitle")]
display_title: String,
#[serde(rename = "headBranch")]
head_branch: String,
#[serde(rename = "headSha")]
head_sha: String,
status: String,
conclusion: Option<String>,
#[serde(rename = "workflowName")]
workflow_name: String,
#[serde(rename = "createdAt")]
created_at: String,
url: String,
}
impl RunView {
fn into_run(self, id: RunId) -> CiRun {
CiRun {
id,
name: self.workflow_name,
title: self.display_title,
branch: self.head_branch,
commit: self.head_sha,
author: String::new(),
created: parse_created(&self.created_at),
status: map_status(&self.status, self.conclusion.as_deref()),
url: Some(self.url),
remote: None,
}
}
}
#[derive(Deserialize)]
struct RunJob {
#[serde(rename = "databaseId", alias = "id")]
database_id: u64,
name: String,
status: String,
conclusion: Option<String>,
#[serde(default)]
steps: Vec<RunStep>,
}
#[derive(Deserialize)]
struct RunStep {
name: String,
status: String,
conclusion: Option<String>,
#[serde(rename = "startedAt", alias = "started_at")]
started_at: Option<String>,
#[serde(rename = "completedAt", alias = "completed_at")]
completed_at: Option<String>,
}
impl RunStep {
fn to_meta(&self) -> LogStepMeta {
let started = self.started_at.as_deref().and_then(parse_created);
let dur = started
.zip(self.completed_at.as_deref().and_then(parse_created))
.map(|(start, end)| (end - start).whole_seconds());
let ran = started.is_some_and(|t| t.year() >= 2000);
LogStepMeta {
name: self.name.clone(),
status: map_status(&self.status, self.conclusion.as_deref()),
start_key: if ran {
self.started_at.as_deref().map_or(0, ts_sort_key)
} else {
0
},
duration_secs: dur,
}
}
}
#[derive(Deserialize)]
struct ArtifactList {
artifacts: Vec<ArtifactItem>,
}
#[derive(Deserialize)]
struct ArtifactItem {
name: String,
#[serde(rename = "size_in_bytes")]
size_in_bytes: u64,
expired: bool,
}
impl From<ArtifactItem> for Artifact {
fn from(item: ArtifactItem) -> Self {
Artifact {
name: item.name,
size_bytes: item.size_in_bytes,
expired: item.expired,
}
}
}
#[derive(Deserialize)]
struct JobsApi {
jobs: Vec<JobApi>,
}
fn parse_posted(raw: &str) -> Result<PrComment> {
let item: ReviewCommentApi =
serde_json::from_str(raw).map_err(|err| crate::ci::CiError::Parse {
what: "pr comment".to_owned(),
message: err.to_string(),
})?;
Ok(item.into_comment())
}
#[derive(Deserialize)]
struct ReviewCommentApi {
id: u64,
#[serde(default)]
path: String,
#[serde(default)]
line: Option<u32>,
#[serde(default)]
original_line: Option<u32>,
#[serde(default)]
side: Option<String>,
#[serde(default)]
body: String,
#[serde(default)]
user: UserApi,
#[serde(default)]
in_reply_to_id: Option<u64>,
#[serde(default)]
created_at: String,
}
#[derive(Deserialize, Default)]
struct UserApi {
#[serde(default)]
login: String,
}
impl ReviewCommentApi {
fn into_comment(self) -> PrComment {
PrComment {
id: self.id.to_string(),
path: self.path,
line: self.line.or(self.original_line),
new_side: self.side.as_deref() != Some("LEFT"),
body: self.body,
author: self.user.login,
reply_to: self.in_reply_to_id.map(|id| id.to_string()),
at: created_epoch(&self.created_at),
}
}
}
fn created_epoch(iso: &str) -> u64 {
parse_created(iso)
.and_then(|t| u64::try_from(t.unix_timestamp()).ok())
.unwrap_or(0)
}
#[derive(Deserialize)]
#[serde(rename_all = "camelCase")]
struct PrListItem {
number: u64,
title: String,
#[serde(default)]
url: String,
#[serde(default)]
base_ref_name: String,
#[serde(default)]
head_ref_name: String,
#[serde(default)]
head_ref_oid: String,
#[serde(default)]
author: AuthorApi,
}
#[derive(Deserialize, Default)]
struct AuthorApi {
#[serde(default)]
login: String,
}
impl PrListItem {
fn into_pr(self) -> PullRequest {
PullRequest {
number: self.number,
title: self.title,
url: (!self.url.is_empty()).then_some(self.url),
base_ref: self.base_ref_name,
head_ref: self.head_ref_name,
head_oid: self.head_ref_oid,
author: self.author.login,
}
}
}
#[derive(Deserialize)]
#[serde(rename_all = "camelCase")]
struct PrView {
number: u64,
title: String,
#[serde(default)]
url: String,
#[serde(default)]
base_ref_name: String,
#[serde(default)]
head_ref_name: String,
#[serde(default)]
head_ref_oid: String,
}
#[derive(Deserialize)]
struct JobApi {
check_run_url: String,
}
#[derive(Deserialize)]
struct AnnotationItem {
annotation_level: Option<String>,
title: Option<String>,
message: Option<String>,
path: Option<String>,
start_line: Option<u64>,
}
impl From<AnnotationItem> for Annotation {
fn from(item: AnnotationItem) -> Self {
let level = match item.annotation_level.as_deref() {
Some("failure") => AnnotationLevel::Failure,
Some("warning") => AnnotationLevel::Warning,
_ => AnnotationLevel::Notice,
};
Annotation {
level,
title: item.title.unwrap_or_default(),
message: item.message.unwrap_or_default(),
path: item.path.unwrap_or_default(),
start_line: item.start_line,
}
}
}
#[cfg(test)]
mod tests {
use super::*;
use crate::ci::exec::test_support::RecordingRunner;
const WORKFLOW: &str = r"
name: CI
on: push
jobs:
lint:
runs-on: ubuntu-latest
test:
needs: lint
runs-on: ubuntu-latest
publish:
name: Publish
needs: [lint, test]
runs-on: ubuntu-latest
";
const RELEASE_WORKFLOW: &str = r"
name: Release
on: push
jobs:
publish:
runs-on: ubuntu-latest
";
const DEPLOY_WORKFLOW: &str = r"
name: Auth Service Deploy
on: push
jobs:
audit:
name: Audit dependencies
runs-on: ubuntu-latest
deploy:
name: Build and deploy
needs: audit
uses: syte-tech/syte-ci-tooling/.github/workflows/app-deploy.yml@main
";
const APP_DEPLOY_WORKFLOW: &str = r"
name: Build and Deploy Application
on:
workflow_call:
jobs:
prepare-deployment:
runs-on: ubuntu-latest
build-and-push:
needs: [prepare-deployment]
uses: syte-tech/syte-ci-tooling/.github/workflows/docker-build-push.yml@main
deploy:
name: Deploy to ${{ needs.prepare-deployment.outputs.env }}
needs: [prepare-deployment, build-and-push]
runs-on: ubuntu-latest
";
fn provider(responses: &[(&'static str, &str)]) -> GitHubProvider {
GitHubProvider::new(
Box::new(RecordingRunner::new(responses)),
vec![WORKFLOW.to_owned()],
None,
YamlCache::default(),
)
}
#[tokio::test]
async fn list_runs_scopes_to_the_branch() {
let json = r#"[{"databaseId":1,"displayTitle":"x","headBranch":"feat/x","headSha":"a",
"status":"completed","conclusion":"success","workflowName":"CI",
"createdAt":"2026-06-18T10:00:00Z","url":"u"}]"#;
let runs = GitHubProvider::new(
Box::new(RecordingRunner::new(&[("list --branch feat/x", json)])),
vec![WORKFLOW.to_owned()],
Some("feat/x".to_owned()),
YamlCache::default(),
)
.list_runs(10)
.await
.expect("runs");
assert_eq!(runs.len(), 1);
assert_eq!(runs[0].branch, "feat/x");
}
#[tokio::test]
async fn run_detail_builds_the_dag_from_the_runs_own_workflow() {
let view = r#"{
"displayTitle":"cut","headBranch":"main","headSha":"abc","status":"completed",
"conclusion":"success","workflowName":"Release",
"createdAt":"2026-06-18T10:00:00Z","url":"https://gh/run/9",
"jobs":[{"databaseId":1,"name":"publish","status":"completed","conclusion":"success"}]
}"#;
let detail = GitHubProvider::new(
Box::new(RecordingRunner::new(&[("run view", view)])),
vec![WORKFLOW.to_owned(), RELEASE_WORKFLOW.to_owned()],
None,
YamlCache::default(),
)
.run_detail(&RunId("9".into()))
.await
.expect("detail");
let ids: Vec<&str> = detail.jobs.iter().map(|j| j.id.0.as_str()).collect();
assert_eq!(ids, ["publish"], "matched the Release workflow, not CI");
}
#[tokio::test]
async fn list_runs_parses_gh_json() {
let json = r#"[
{"databaseId":42,"displayTitle":"fix things","headBranch":"main","headSha":"abc1234",
"status":"completed","conclusion":"success","workflowName":"CI",
"createdAt":"2026-06-18T10:00:00Z","url":"https://gh/run/42"}
]"#;
let runs = provider(&[("run list", json)])
.list_runs(10)
.await
.expect("runs");
assert_eq!(runs.len(), 1);
assert_eq!(runs[0].id, RunId("42".into()));
assert_eq!(runs[0].name, "CI");
assert_eq!(runs[0].branch, "main");
assert_eq!(runs[0].status, JobStatus::Ok);
assert!(runs[0].created.is_some());
}
#[tokio::test]
async fn run_detail_builds_dag_with_matrix_aggregation() {
let view = r#"{
"displayTitle":"fix things","headBranch":"main","headSha":"abc","status":"in_progress",
"conclusion":null,"workflowName":"CI",
"createdAt":"2026-06-18T10:00:00Z","url":"https://gh/run/42",
"jobs":[
{"databaseId":1,"name":"lint","status":"completed","conclusion":"success"},
{"databaseId":2,"name":"test (ubuntu-latest)","status":"completed","conclusion":"success"},
{"databaseId":3,"name":"test (windows-latest)","status":"in_progress","conclusion":null}
]
}"#;
let detail = provider(&[("run view", view)])
.run_detail(&RunId("42".into()))
.await
.expect("detail");
let ids: Vec<&str> = detail.jobs.iter().map(|j| j.id.0.as_str()).collect();
assert_eq!(ids, ["lint", "test", "publish"]);
assert_eq!(detail.jobs[2].name, "Publish");
assert_eq!(
detail.jobs[2].needs,
vec![JobId("lint".into()), JobId("test".into())]
);
assert_eq!(detail.jobs[0].status, JobStatus::Ok, "lint succeeded");
assert_eq!(detail.jobs[1].status, JobStatus::Running, "a test leg runs");
assert_eq!(
detail.jobs[2].status,
JobStatus::Queued,
"publish not started"
);
}
#[tokio::test]
async fn run_detail_inlines_a_reusable_workflows_jobs_with_edges() {
let view = r#"{
"displayTitle":"deploy","headBranch":"main","headSha":"abc","status":"in_progress",
"conclusion":null,"workflowName":"Auth Service Deploy",
"createdAt":"2026-06-18T10:00:00Z","url":"https://gh/run/9",
"jobs":[
{"databaseId":1,"name":"Audit dependencies","status":"completed","conclusion":"success"},
{"databaseId":2,"name":"Build and deploy / prepare-deployment","status":"completed","conclusion":"success"},
{"databaseId":3,"name":"Build and deploy / build-and-push / build-and-push-to-registry","status":"in_progress","conclusion":null},
{"databaseId":4,"name":"Build and deploy / Deploy to staging","status":"queued","conclusion":null}
]
}"#;
let detail = GitHubProvider::new(
Box::new(RecordingRunner::new(&[
("run view", view),
(
"contents/.github/workflows/app-deploy.yml",
APP_DEPLOY_WORKFLOW,
),
])),
vec![DEPLOY_WORKFLOW.to_owned()],
None,
YamlCache::default(),
)
.run_detail(&RunId("9".into()))
.await
.expect("detail");
let by_id = |id: &str| detail.jobs.iter().find(|j| j.id.0 == id).cloned();
let ids: Vec<&str> = detail.jobs.iter().map(|j| j.id.0.as_str()).collect();
assert_eq!(
ids,
[
"audit",
"Build and deploy / prepare-deployment",
"Build and deploy / build-and-push",
"Build and deploy / deploy"
],
"the reusable `deploy` job is replaced by the fetched workflow's jobs"
);
assert_eq!(
by_id("Build and deploy / prepare-deployment")
.unwrap()
.needs,
vec![JobId("audit".into())]
);
assert_eq!(
by_id("Build and deploy / deploy").unwrap().needs,
vec![
JobId("Build and deploy / prepare-deployment".into()),
JobId("Build and deploy / build-and-push".into())
]
);
assert_eq!(
by_id("Build and deploy / deploy").unwrap().name,
"Build and deploy / Deploy to staging"
);
assert_eq!(
by_id("Build and deploy / build-and-push").unwrap().status,
JobStatus::Running
);
assert_eq!(
by_id("Build and deploy / prepare-deployment")
.unwrap()
.status,
JobStatus::Ok
);
assert_eq!(by_id("audit").unwrap().status, JobStatus::Ok);
}
#[tokio::test]
async fn reusable_workflows_fetch_once_across_provider_rebuilds() {
let view = r#"{
"displayTitle":"deploy","headBranch":"main","headSha":"abc","status":"in_progress",
"conclusion":null,"workflowName":"Auth Service Deploy",
"createdAt":"2026-06-18T10:00:00Z","url":"https://gh/run/9","jobs":[]
}"#;
let runner = std::sync::Arc::new(RecordingRunner::new(&[
("run view", view),
(
"contents/.github/workflows/app-deploy.yml",
APP_DEPLOY_WORKFLOW,
),
]));
let cache = YamlCache::default();
for _ in 0..2 {
GitHubProvider::new(
Box::new(runner.clone()),
vec![DEPLOY_WORKFLOW.to_owned()],
None,
cache.clone(),
)
.run_detail(&RunId("9".into()))
.await
.expect("detail");
}
let fetches = runner
.calls()
.iter()
.filter(|c| c.contains("contents/"))
.count();
assert_eq!(fetches, 1, "second poll served from the cache");
}
#[tokio::test]
async fn job_log_resolves_an_inlined_reusable_child_node() {
let jobs = r#"{"jobs":[{"id":7,
"name":"Build and deploy / build-and-push / build-and-push-to-registry",
"status":"completed","conclusion":"success","steps":[]}]}"#;
let chunk = provider(&[("runs/9/jobs", jobs), ("/logs", "pushed\n")])
.job_log(
&RunId("9".into()),
&JobId("Build and deploy / build-and-push".into()),
0,
)
.await
.expect("log resolves for an inlined child");
assert!(chunk.text.contains("pushed"));
}
#[tokio::test]
async fn job_log_fetches_a_completed_job_from_the_rest_api() {
let jobs = r#"{"jobs":[{"id":7,"name":"lint","status":"completed","conclusion":"success",
"steps":[{"name":"Run x","status":"completed","conclusion":"success",
"started_at":"2026-06-20T00:00:00Z","completed_at":"2026-06-20T00:00:03Z"}]}]}"#;
let chunk = provider(&[("runs/42/jobs", jobs), ("/logs", "line one\nline two\n")])
.job_log(&RunId("42".into()), &JobId("lint".into()), 0)
.await
.expect("log");
assert!(chunk.text.contains("line one"));
assert!(chunk.done);
assert_eq!(chunk.steps.len(), 1);
assert_eq!(chunk.steps[0].duration_secs, Some(3));
assert_eq!(chunk.next_offset, chunk.text.len() as u64);
}
#[tokio::test]
async fn job_log_in_progress_returns_live_steps_without_text() {
let jobs = r#"{"jobs":[{"id":7,"name":"lint","status":"in_progress","conclusion":null,
"steps":[{"name":"Run x","status":"in_progress","conclusion":null,
"started_at":"2026-06-20T00:00:00Z","completed_at":null}]}]}"#;
let chunk = provider(&[("runs/42/jobs", jobs)])
.job_log(&RunId("42".into()), &JobId("lint".into()), 0)
.await
.expect("log");
assert!(chunk.text.is_empty(), "no log archive while running");
assert!(!chunk.done, "keep polling until the job completes");
assert_eq!(chunk.steps.len(), 1, "live step states are shown");
assert_eq!(chunk.steps[0].status, JobStatus::Running);
}
#[tokio::test]
async fn run_extras_collects_artifacts_and_annotations() {
let artifacts = r#"{"artifacts":[
{"name":"coverage","size_in_bytes":2048,"expired":false},
{"name":"old-logs","size_in_bytes":10,"expired":true}
]}"#;
let jobs = r#"{"jobs":[
{"check_run_url":"https://api.github.com/repos/o/r/check-runs/99"}
]}"#;
let annotations = r#"[
{"annotation_level":"warning","title":"clippy","message":"unused import",
"path":"src/lib.rs","start_line":12},
{"annotation_level":"failure","title":"test","message":"assert failed",
"path":"src/x.rs","start_line":null}
]"#;
let extras = provider(&[
("artifacts", artifacts),
("/jobs", jobs),
("annotations", annotations),
])
.run_extras(&RunId("42".into()))
.await
.expect("extras");
assert_eq!(extras.artifacts.len(), 2);
assert_eq!(extras.artifacts[0].name, "coverage");
assert!(extras.artifacts[1].expired);
assert_eq!(extras.annotations.len(), 2);
assert_eq!(extras.annotations[0].level, AnnotationLevel::Warning);
assert_eq!(extras.annotations[0].start_line, Some(12));
assert_eq!(extras.annotations[1].level, AnnotationLevel::Failure);
}
#[tokio::test]
async fn run_extras_degrades_to_artifacts_when_annotations_fail() {
let artifacts =
r#"{"artifacts":[{"name":"coverage","size_in_bytes":2048,"expired":false}]}"#;
let jobs =
r#"{"jobs":[{"check_run_url":"https://api.github.com/repos/o/r/check-runs/99"}]}"#;
let extras = provider(&[("artifacts", artifacts), ("/jobs", jobs)])
.run_extras(&RunId("42".into()))
.await
.expect("extras never errors");
assert_eq!(extras.artifacts.len(), 1);
assert!(extras.annotations.is_empty(), "failed job is skipped");
}
#[tokio::test]
async fn current_pr_parses_the_branch_pr() {
let json = r#"{"number":28,"title":"Inline CI runs","url":"https://gh/pull/28","baseRefName":"main","headRefOid":"abc123"}"#;
let pr = GitHubProvider::new(
Box::new(RecordingRunner::new(&[("pr view feat/x", json)])),
vec![],
Some("feat/x".to_owned()),
YamlCache::default(),
)
.current_pr()
.await
.expect("pr call");
let pr = pr.expect("a pr");
assert_eq!(pr.number, 28);
assert_eq!(pr.url.as_deref(), Some("https://gh/pull/28"));
}
#[tokio::test]
async fn current_pr_is_none_without_a_branch() {
let pr = provider(&[]).current_pr().await.expect("pr call");
assert!(pr.is_none(), "no branch → no PR, no gh call");
}
#[tokio::test]
async fn capabilities_are_config_dag_and_dump_logs() {
let caps = provider(&[]).capabilities();
assert_eq!(caps.dag, DagSource::ConfigFile);
assert_eq!(caps.logs, LogMode::Dump);
}
}