1use super::types::GitHubReview;
7use chrono::{DateTime, Duration, Utc};
8use jsonwebtoken::{encode, Algorithm, EncodingKey, Header};
9use reqwest::{header, Client, StatusCode};
10use serde::{Deserialize, Serialize};
11use std::collections::HashMap;
12use std::sync::{Arc, Mutex, RwLock};
13use std::time::Duration as StdDuration;
14
15const JWT_IAT_SKEW_SECS: i64 = 60;
16const JWT_EXP_FROM_NOW_SECS: i64 = 9 * 60;
17const USER_AGENT: &str = "orch/0.1 (reqwest)";
18
19#[derive(Debug, Clone, Copy, PartialEq, Eq)]
20pub(crate) enum ReviewEvent {
21 Approve,
22 RequestChanges,
23}
24
25impl ReviewEvent {
26 fn as_str(self) -> &'static str {
27 match self {
28 Self::Approve => "APPROVE",
29 Self::RequestChanges => "REQUEST_CHANGES",
30 }
31 }
32}
33
34struct CachedToken {
35 token: String,
36 expires_at: DateTime<Utc>,
37}
38
39#[derive(Serialize, Deserialize)]
40struct Claims {
41 iss: String,
42 iat: i64,
43 exp: i64,
44}
45
46#[derive(Deserialize)]
47struct Installation {
48 id: u64,
49}
50
51#[derive(Deserialize)]
52struct AccessTokenResponse {
53 token: String,
54 expires_at: DateTime<Utc>,
55}
56
57#[derive(Deserialize)]
58struct AppInfo {
59 slug: String,
60}
61
62const REVIEW_CHECK: &str = "orch/review";
63const PR_FILE_PAGES: u32 = 30;
65
66pub(crate) enum CheckRunState<'a> {
67 InProgress,
68 Completed { approved: bool, summary: &'a str },
69}
70
71#[derive(Debug, Clone, PartialEq, Eq)]
72pub(crate) struct InlineComment {
73 pub path: String,
74 pub line: u32,
75 pub body: String,
76}
77
78#[derive(Deserialize)]
79struct PrFile {
80 filename: String,
81 patch: Option<String>,
82}
83
84pub(crate) fn right_side_ranges(patch: &str) -> Vec<(u32, u32)> {
86 patch
87 .lines()
88 .filter_map(|line| line.strip_prefix("@@ "))
89 .filter_map(|header| header.split_whitespace().find(|part| part.starts_with('+')))
90 .filter_map(|right| {
91 let mut parts = right.trim_start_matches('+').split(',');
92 let start: u32 = parts.next()?.parse().ok()?;
93 let count: u32 = parts.next().map_or(Some(1), |c| c.parse().ok())?;
94 (count > 0).then(|| (start, start + count - 1))
95 })
96 .collect()
97}
98
99pub(crate) fn split_inline(
101 issues: &[crate::engine::runner::response::ReviewIssue],
102 hunks: &HashMap<String, Vec<(u32, u32)>>,
103) -> (Vec<InlineComment>, Vec<String>) {
104 let mut inline = Vec::new();
105 let mut rest = Vec::new();
106
107 for issue in issues {
108 let body = format!("**{}:** {}", issue.severity, issue.description);
109 let in_hunk = issue.line.filter(|line| {
110 hunks
111 .get(&issue.file)
112 .is_some_and(|ranges| ranges.iter().any(|(a, b)| (a..=b).contains(&line)))
113 });
114
115 match in_hunk {
116 Some(line) => inline.push(InlineComment {
117 path: issue.file.clone(),
118 line,
119 body,
120 }),
121 None => rest.push(match issue.line {
122 Some(line) => format!("- `{}:{line}` {body}", issue.file),
123 None => format!("- `{}` {body}", issue.file),
124 }),
125 }
126 }
127
128 (inline, rest)
129}
130
131pub(crate) struct AppAuth {
132 app_id: String,
133 pem: String,
134 installations: Mutex<HashMap<String, Option<u64>>>,
136 tokens: Mutex<HashMap<u64, CachedToken>>,
137 login: Mutex<Option<String>>,
138 refresh: tokio::sync::Mutex<()>,
139 http: Client,
140 api_base: String,
141}
142
143impl std::fmt::Debug for AppAuth {
145 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
146 f.debug_struct("AppAuth")
147 .field("app_id", &self.app_id)
148 .finish_non_exhaustive()
149 }
150}
151
152fn lock<T>(mutex: &Mutex<T>) -> std::sync::MutexGuard<'_, T> {
153 mutex.lock().unwrap_or_else(|err| err.into_inner())
154}
155
156static SHARED: RwLock<Option<Arc<AppAuth>>> = RwLock::new(None);
157const LOAD_RETRY: StdDuration = StdDuration::from_secs(300);
158
159pub(crate) fn shared() -> Option<Arc<AppAuth>> {
161 SHARED.read().unwrap_or_else(|err| err.into_inner()).clone()
162}
163
164fn publish(app: Arc<AppAuth>) {
165 *SHARED.write().unwrap_or_else(|err| err.into_inner()) = Some(app);
166}
167
168pub fn start_loader() {
171 if cfg!(any(test, debug_assertions)) {
174 return;
175 }
176
177 tokio::spawn(run_loader(load_from_config, publish, LOAD_RETRY));
178}
179
180async fn run_loader<L, P>(load: L, publish: P, retry: StdDuration)
182where
183 L: Fn() -> anyhow::Result<Option<AppAuth>> + Clone + Send + 'static,
184 P: Fn(Arc<AppAuth>),
185{
186 let mut warned = false;
187
188 loop {
189 let attempt = load.clone();
190 let result = tokio::task::spawn_blocking(attempt)
191 .await
192 .map_err(anyhow::Error::from)
193 .and_then(|r| r);
194
195 match result {
196 Ok(Some(app)) => {
197 tracing::info!(app_id = %app.app_id, "GitHub App loaded, App reviews are on");
198 publish(Arc::new(app));
199 return;
200 }
201 Ok(None) => return,
202 Err(err) if !warned => {
203 tracing::warn!(error = %err, "GitHub App unavailable, using the owner token and comment reviews, retrying every 5 minutes");
204 warned = true;
205 }
206 Err(_) => {}
207 }
208
209 tokio::time::sleep(retry).await;
210 }
211}
212
213fn load_from_config() -> anyhow::Result<Option<AppAuth>> {
214 let Some(id) = nonempty_config("gh.app.id") else {
215 return Ok(None);
216 };
217 AppAuth::from_config(id).map(Some)
218}
219
220impl AppAuth {
221 fn from_config(app_id: String) -> anyhow::Result<Self> {
222 if !app_id.chars().all(|c| c.is_ascii_digit()) {
223 anyhow::bail!("gh.app.id must be digits");
224 }
225 let pem = read_key()?;
226 sign_jwt(&app_id, &pem, Utc::now().timestamp())?;
228 Ok(Self::new(app_id, pem, "https://api.github.com".to_string()))
229 }
230
231 pub(crate) fn new(app_id: String, pem: String, api_base: String) -> Self {
232 let http = Client::builder()
233 .user_agent(USER_AGENT)
234 .timeout(StdDuration::from_secs(30))
235 .build()
236 .unwrap_or_default();
237 Self {
238 app_id,
239 pem,
240 installations: Mutex::new(HashMap::new()),
241 tokens: Mutex::new(HashMap::new()),
242 login: Mutex::new(None),
243 refresh: tokio::sync::Mutex::new(()),
244 http,
245 api_base,
246 }
247 }
248
249 pub(crate) fn invalidate(&self) {
251 lock(&self.tokens).clear();
252 }
253
254 pub(crate) async fn token_for_repo(&self, repo: &str) -> anyhow::Result<Option<String>> {
256 let Some(id) = self.installation_for(repo).await? else {
257 return Ok(None);
258 };
259 self.installation_token(id).await.map(Some)
260 }
261
262 async fn installation_for(&self, repo: &str) -> anyhow::Result<Option<u64>> {
264 if let Some(found) = lock(&self.installations).get(repo) {
265 return Ok(*found);
266 }
267 let jwt = sign_jwt(&self.app_id, &self.pem, Utc::now().timestamp())?;
268 let url = format!("{}/repos/{repo}/installation", self.api_base);
269 let found = match self.send_status(self.http.get(&url), &jwt).await? {
270 (status, body) if status.is_success() => {
271 let installation: Installation = serde_json::from_str(&body)
272 .map_err(|_| anyhow::anyhow!("GitHub App installation could not be read"))?;
273 Some(installation.id)
274 }
275 (StatusCode::NOT_FOUND, _) => None,
276 (status, _) => {
277 anyhow::bail!("GitHub App installation lookup for {repo} failed: {status}")
278 }
279 };
280 lock(&self.installations).insert(repo.to_string(), found);
281 Ok(found)
282 }
283
284 async fn installation_token(&self, id: u64) -> anyhow::Result<String> {
285 if let Some(token) = self.cached_fresh_token(id) {
286 return Ok(token);
287 }
288 let _guard = self.refresh.lock().await;
289 if let Some(token) = self.cached_fresh_token(id) {
290 return Ok(token);
291 }
292 let jwt = sign_jwt(&self.app_id, &self.pem, Utc::now().timestamp())?;
293 let url = format!("{}/app/installations/{id}/access_tokens", self.api_base);
294 let body = self.send(self.http.post(&url), &jwt).await?;
295 let parsed: AccessTokenResponse = serde_json::from_str(&body)
296 .map_err(|_| anyhow::anyhow!("GitHub installation token response could not be read"))?;
297 if parsed.token.is_empty() {
298 anyhow::bail!("GitHub installation token response has no token");
299 }
300 lock(&self.tokens).insert(
301 id,
302 CachedToken {
303 token: parsed.token.clone(),
304 expires_at: parsed.expires_at,
305 },
306 );
307 Ok(parsed.token)
308 }
309
310 fn cached_fresh_token(&self, id: u64) -> Option<String> {
311 let tokens = lock(&self.tokens);
312 let cached = tokens.get(&id)?;
313 token_is_fresh(cached.expires_at, Utc::now()).then(|| cached.token.clone())
314 }
315
316 pub(crate) async fn login(&self) -> anyhow::Result<String> {
319 if let Some(login) = lock(&self.login).clone() {
320 return Ok(login);
321 }
322 let jwt = sign_jwt(&self.app_id, &self.pem, Utc::now().timestamp())?;
323 let url = format!("{}/app", self.api_base);
324 let body = self.send(self.http.get(&url), &jwt).await?;
325 let info: AppInfo = serde_json::from_str(&body)
326 .map_err(|_| anyhow::anyhow!("GitHub App info could not be read"))?;
327 if info.slug.is_empty() {
328 anyhow::bail!("GitHub App info has no slug");
329 }
330 let login = format!("{}[bot]", info.slug);
331 *lock(&self.login) = Some(login.clone());
332 Ok(login)
333 }
334
335 pub(crate) async fn submit_review(
337 &self,
338 repo: &str,
339 pr_number: u64,
340 event: ReviewEvent,
341 body: &str,
342 commit_id: &str,
343 comments: &[InlineComment],
344 ) -> anyhow::Result<()> {
345 let token = self.repo_token(repo).await?;
346 let url = format!("{}/repos/{repo}/pulls/{pr_number}/reviews", self.api_base);
347 let comments: Vec<serde_json::Value> = comments
348 .iter()
349 .map(|c| {
350 serde_json::json!({
351 "path": c.path,
352 "line": c.line,
353 "side": "RIGHT",
354 "body": super::http::redact_posted_body(&c.body),
355 })
356 })
357 .collect();
358 let payload = serde_json::json!({
359 "event": event.as_str(),
360 "body": super::http::redact_posted_body(body),
361 "commit_id": commit_id,
362 "comments": comments,
363 });
364 let result = self.send(self.http.post(&url).json(&payload), &token).await;
365 if result
366 .as_ref()
367 .is_err_and(|err| err.to_string().contains(StatusCode::UNAUTHORIZED.as_str()))
368 {
369 self.invalidate();
370 }
371 result.map(|_| ())
372 }
373
374 async fn repo_token(&self, repo: &str) -> anyhow::Result<String> {
375 match self.token_for_repo(repo).await? {
376 Some(token) => Ok(token),
377 None => anyhow::bail!("the GitHub App is not installed on {repo}"),
378 }
379 }
380
381 pub(crate) async fn post_check_run(
383 &self,
384 repo: &str,
385 head_sha: &str,
386 state: CheckRunState<'_>,
387 ) -> anyhow::Result<()> {
388 let token = self.repo_token(repo).await?;
389 let url = format!("{}/repos/{repo}/check-runs", self.api_base);
390 let payload = match state {
391 CheckRunState::InProgress => serde_json::json!({
392 "name": REVIEW_CHECK,
393 "head_sha": head_sha,
394 "status": "in_progress",
395 }),
396 CheckRunState::Completed { approved, summary } => serde_json::json!({
397 "name": REVIEW_CHECK,
398 "head_sha": head_sha,
399 "status": "completed",
400 "conclusion": if approved { "success" } else { "failure" },
401 "output": {
402 "title": if approved { "Approved by automated review" } else { "Automated review requested changes" },
403 "summary": super::http::redact_posted_body(summary),
404 },
405 }),
406 };
407 self.send(self.http.post(&url).json(&payload), &token)
408 .await
409 .map(|_| ())
410 }
411
412 pub(crate) async fn pull_request_hunks(
414 &self,
415 repo: &str,
416 pr_number: u64,
417 ) -> anyhow::Result<HashMap<String, Vec<(u32, u32)>>> {
418 let token = self.repo_token(repo).await?;
419 let mut hunks = HashMap::new();
420
421 for page in 1..=PR_FILE_PAGES {
422 let url = format!(
423 "{}/repos/{repo}/pulls/{pr_number}/files?per_page=100&page={page}",
424 self.api_base
425 );
426 let body = self.send(self.http.get(&url), &token).await?;
427 let files: Vec<PrFile> = serde_json::from_str(&body)
428 .map_err(|_| anyhow::anyhow!("pull request files could not be read"))?;
429 let last = files.len() < 100;
430
431 for file in files {
432 hunks.insert(
433 file.filename,
434 right_side_ranges(file.patch.as_deref().unwrap_or("")),
435 );
436 }
437
438 if last {
439 break;
440 }
441 }
442
443 Ok(hunks)
444 }
445
446 async fn send(&self, builder: reqwest::RequestBuilder, bearer: &str) -> anyhow::Result<String> {
447 let (status, body) = self.send_status(builder, bearer).await?;
448 if status.is_success() {
449 return Ok(body);
450 }
451 let message = error_message(&body);
452 anyhow::bail!("GitHub App API {status}: {message}")
453 }
454
455 async fn send_status(
456 &self,
457 builder: reqwest::RequestBuilder,
458 bearer: &str,
459 ) -> anyhow::Result<(StatusCode, String)> {
460 let resp = builder
461 .header(header::AUTHORIZATION, format!("Bearer {bearer}"))
462 .header(header::ACCEPT, "application/vnd.github+json")
463 .header("X-GitHub-Api-Version", "2022-11-28")
464 .send()
465 .await
466 .map_err(|err| anyhow::anyhow!("GitHub App request failed to send: {err}"))?;
468 let status = resp.status();
469 let body = resp.text().await.unwrap_or_default();
470 Ok((status, body))
471 }
472}
473
474fn error_message(body: &str) -> String {
476 let Ok(value) = serde_json::from_str::<serde_json::Value>(body) else {
477 return String::new();
478 };
479 let safe = |text: String| (!crate::security::has_leaks(&text)).then_some(text);
480 let message = value
481 .get("message")
482 .and_then(|msg| msg.as_str())
483 .map(str::to_owned)
484 .and_then(safe)
485 .unwrap_or_default();
486 let details: Vec<String> = value
487 .get("errors")
488 .and_then(|errors| errors.as_array())
489 .into_iter()
490 .flatten()
491 .filter_map(error_entry)
492 .filter_map(safe)
493 .collect();
494
495 if details.is_empty() {
496 message
497 } else {
498 format!("{message} ({})", details.join("; "))
499 }
500}
501
502fn error_entry(entry: &serde_json::Value) -> Option<String> {
503 if let Some(text) = entry.as_str() {
504 return Some(text.to_owned());
505 }
506 let field = |name: &str| entry.get(name).and_then(|v| v.as_str());
507 if let Some(text) = field("message") {
508 return Some(text.to_owned());
509 }
510 let code = field("code")?;
511 let place = [field("resource"), field("field")]
512 .into_iter()
513 .flatten()
514 .collect::<Vec<_>>()
515 .join(".");
516
517 Some(if place.is_empty() {
518 code.to_owned()
519 } else {
520 format!("{place}: {code}")
521 })
522}
523
524fn token_is_fresh(expires_at: DateTime<Utc>, now: DateTime<Utc>) -> bool {
525 expires_at > now + Duration::minutes(10)
526}
527
528fn nonempty_config(key: &str) -> Option<String> {
529 crate::config::get(key)
530 .ok()
531 .map(|value| value.trim().to_string())
532 .filter(|value| !value.is_empty())
533}
534
535fn read_key() -> anyhow::Result<String> {
536 if let Some(reference) = nonempty_config("gh.app.private_key") {
538 return normalize_pem(&crate::secret_ref::resolve(&reference)?);
539 }
540 if let Some(path) = nonempty_config("gh.app.private_key_path") {
541 let raw = std::fs::read_to_string(&path)
542 .map_err(|err| anyhow::anyhow!("failed to read GitHub App private key file: {err}"))?;
543 return normalize_pem(&raw);
544 }
545 if let Some(name) = nonempty_config("gh.app.private_key_env") {
546 let raw = std::env::var(&name).unwrap_or_default();
547 return normalize_pem(&raw).map_err(|_| {
548 anyhow::anyhow!("GitHub App private key variable {name} is unset or empty")
549 });
550 }
551 anyhow::bail!("set gh.app.private_key, gh.app.private_key_env or gh.app.private_key_path")
552}
553
554fn normalize_pem(raw: &str) -> anyhow::Result<String> {
556 let pem = raw.replace("\\n", "\n").trim().to_string();
557 if pem.is_empty() {
558 anyhow::bail!("GitHub App private key is empty");
559 }
560 Ok(pem)
561}
562
563fn sign_jwt(app_id: &str, pem: &str, now: i64) -> anyhow::Result<String> {
564 let claims = Claims {
565 iss: app_id.to_string(),
566 iat: now - JWT_IAT_SKEW_SECS,
567 exp: now + JWT_EXP_FROM_NOW_SECS,
568 };
569 let key = EncodingKey::from_rsa_pem(pem.as_bytes())
570 .map_err(|_| anyhow::anyhow!("GitHub App private key is not a usable RSA PEM"))?;
571 encode(&Header::new(Algorithm::RS256), &claims, &key)
572 .map_err(|_| anyhow::anyhow!("failed to sign GitHub App JWT"))
573}
574
575pub(crate) async fn bot_login() -> Option<String> {
577 let app = shared()?;
578 match app.login().await {
579 Ok(login) => Some(login),
580 Err(err) => {
581 tracing::warn!(error = %err, "GitHub App login unreadable, review gate reads comments only");
582 None
583 }
584 }
585}
586
587pub(crate) fn same_login(left: &str, right: &str) -> bool {
589 let strip = |login: &str| login.strip_suffix("[bot]").unwrap_or(login).to_string();
590 strip(left).eq_ignore_ascii_case(&strip(right))
591}
592
593fn on_head(review: &GitHubReview, head_sha: &str) -> bool {
594 !head_sha.is_empty()
595 && review
596 .commit_id
597 .as_deref()
598 .is_some_and(|sha| sha.eq_ignore_ascii_case(head_sha))
599}
600
601pub(crate) fn reviews_for_gate(
603 reviews: &[GitHubReview],
604 head_sha: &str,
605 app_login: Option<&str>,
606) -> Vec<GitHubReview> {
607 reviews
608 .iter()
609 .filter(|review| {
610 app_login.is_none_or(|login| {
611 !same_login(&review.user.login, login) || on_head(review, head_sha)
612 })
613 })
614 .cloned()
615 .collect()
616}
617
618pub(crate) fn effective_comment_flags(
620 reviews: &[GitHubReview],
621 head_sha: &str,
622 app_login: Option<&str>,
623 comment_approved: bool,
624 comment_changes_requested: bool,
625) -> (bool, bool) {
626 let replaced = app_login.is_some_and(|login| {
627 reviews.iter().any(|review| {
628 same_login(&review.user.login, login)
629 && on_head(review, head_sha)
630 && (review.state == "APPROVED" || review.state == "CHANGES_REQUESTED")
631 })
632 });
633 if replaced {
634 (false, false)
635 } else {
636 (comment_approved, comment_changes_requested)
637 }
638}
639
640#[cfg(test)]
642fn test_keys() -> &'static (String, String) {
643 use rsa::pkcs8::{EncodePrivateKey, EncodePublicKey, LineEnding};
644 static KEYS: std::sync::OnceLock<(String, String)> = std::sync::OnceLock::new();
645 KEYS.get_or_init(|| {
646 let key = rsa::RsaPrivateKey::new(&mut rand::rngs::OsRng, 2048).expect("rsa");
647 let private = key.to_pkcs8_pem(LineEnding::LF).expect("pem").to_string();
648 let public = rsa::RsaPublicKey::from(&key)
649 .to_public_key_pem(LineEnding::LF)
650 .expect("public pem");
651 (private, public)
652 })
653}
654
655#[cfg(test)]
656pub(crate) fn test_pem() -> &'static str {
657 &test_keys().0
658}
659
660#[cfg(test)]
661mod tests {
662 use super::*;
663 use crate::github::types::GitHubUser;
664 use jsonwebtoken::{decode, DecodingKey, Validation};
665 use std::sync::atomic::{AtomicUsize, Ordering};
666 use wiremock::matchers::{body_partial_json, header as header_is, method, path};
667 use wiremock::{Mock, MockServer, Request, ResponseTemplate};
668
669 fn app(server: &MockServer) -> AppAuth {
670 AppAuth::new("12345".to_string(), test_pem().to_string(), server.uri())
671 }
672
673 async fn installed(server: &MockServer, repo: &str, id: u64) {
674 Mock::given(method("GET"))
675 .and(path(format!("/repos/{repo}/installation")))
676 .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({"id": id})))
677 .mount(server)
678 .await;
679 }
680
681 fn review(login: &str, state: &str, sha: &str, at: &str) -> GitHubReview {
682 GitHubReview {
683 id: 1,
684 user: GitHubUser {
685 login: login.to_string(),
686 },
687 body: None,
688 state: state.to_string(),
689 html_url: None,
690 submitted_at: at.to_string(),
691 commit_id: Some(sha.to_string()),
692 }
693 }
694
695 fn decode_claims(jwt: &str) -> Claims {
696 let mut validation = Validation::new(Algorithm::RS256);
697 validation.validate_exp = false;
698 let key = DecodingKey::from_rsa_pem(test_keys().1.as_bytes()).expect("decode key");
699 decode::<Claims>(jwt, &key, &validation)
700 .expect("signed with the app key")
701 .claims
702 }
703
704 #[test]
705 fn jwt_has_the_app_claims_and_is_signed_with_the_key() {
706 let now = 1_700_000_000;
707 let jwt = sign_jwt("12345", test_pem(), now).expect("sign");
708 let claims = decode_claims(&jwt);
709 assert_eq!(claims.iss, "12345");
710 assert_eq!(claims.iat, now - 60);
711 assert!(claims.exp > now && claims.exp - now <= 600);
712 assert!(
713 crate::security::has_leaks(&jwt),
714 "a jwt must trip the leak scan"
715 );
716 assert!(
717 crate::security::has_leaks(test_pem()),
718 "a key must trip the leak scan"
719 );
720 }
721
722 #[test]
723 fn error_message_includes_the_errors_entries() {
724 let body = serde_json::json!({
725 "message": "Unprocessable Entity",
726 "errors": [
727 "Can not approve your own pull request",
728 {"message": "line must be part of the diff"},
729 {"resource": "PullRequestReview", "field": "commit_id", "code": "invalid"}
730 ]
731 })
732 .to_string();
733 assert_eq!(
734 error_message(&body),
735 "Unprocessable Entity (Can not approve your own pull request; line must be part of \
736 the diff; PullRequestReview.commit_id: invalid)"
737 );
738 }
739
740 #[test]
741 fn error_message_drops_an_entry_that_trips_the_leak_scan() {
742 let body = serde_json::json!({
743 "message": "Unprocessable Entity",
744 "errors": ["still readable", test_pem()]
745 })
746 .to_string();
747 let message = error_message(&body);
748 assert_eq!(message, "Unprocessable Entity (still readable)");
749 assert!(!message.contains("PRIVATE"));
750 assert_eq!(error_message("not json"), "");
751 }
752
753 #[test]
754 fn a_bad_key_is_rejected_without_echoing_it() {
755 let pem = format!("-----{} {}-----\nMARKERMATERIAL\n", "BEGIN", "PRIVATE KEY");
756 let err = sign_jwt("12345", &pem, 0).expect_err("bad key").to_string();
757 assert!(!err.contains("MARKERMATERIAL"), "{err}");
758 }
759
760 #[test]
761 fn normalize_pem_expands_escaped_newlines() {
762 let pem = normalize_pem(" A\\nB\\nC ").expect("pem");
763 assert_eq!(pem, "A\nB\nC");
764 assert!(normalize_pem(" ").is_err());
765 }
766
767 #[tokio::test]
768 async fn installation_token_is_cached_and_refreshed_before_expiry() {
769 let server = MockServer::start().await;
770 installed(&server, "o/r", 42).await;
771 let posts = Arc::new(AtomicUsize::new(0));
772 let counter = posts.clone();
773 Mock::given(method("POST"))
774 .and(path("/app/installations/42/access_tokens"))
775 .respond_with(move |_req: &Request| {
776 let n = counter.fetch_add(1, Ordering::SeqCst) + 1;
777 ResponseTemplate::new(201).set_body_json(serde_json::json!({
778 "token": format!("inst-{n}"),
779 "expires_at": "2099-01-01T00:00:00Z",
780 }))
781 })
782 .mount(&server)
783 .await;
784 let app = app(&server);
785
786 assert_eq!(
787 app.token_for_repo("o/r").await.unwrap().as_deref(),
788 Some("inst-1")
789 );
790 assert_eq!(
791 app.token_for_repo("o/r").await.unwrap().as_deref(),
792 Some("inst-1")
793 );
794 assert_eq!(posts.load(Ordering::SeqCst), 1);
795
796 let requests = server.received_requests().await.expect("requests");
797 let auth = requests[0]
798 .headers
799 .get("authorization")
800 .and_then(|value| value.to_str().ok())
801 .unwrap_or_default();
802 let claims = decode_claims(auth.trim_start_matches("Bearer "));
803 assert_eq!(claims.iss, "12345");
804
805 lock(&app.tokens).get_mut(&42).unwrap().expires_at = Utc::now() + Duration::minutes(9);
807 assert_eq!(
808 app.token_for_repo("o/r").await.unwrap().as_deref(),
809 Some("inst-2")
810 );
811 assert_eq!(posts.load(Ordering::SeqCst), 2);
812 }
813
814 #[tokio::test]
815 async fn a_repo_without_the_app_gets_no_token_and_is_looked_up_once() {
816 let server = MockServer::start().await;
817 Mock::given(method("GET"))
818 .and(path("/repos/other-org/x/installation"))
819 .respond_with(ResponseTemplate::new(404))
820 .expect(1)
821 .mount(&server)
822 .await;
823 let app = app(&server);
824 assert_eq!(app.token_for_repo("other-org/x").await.unwrap(), None);
825 assert_eq!(app.token_for_repo("other-org/x").await.unwrap(), None);
826 }
827
828 #[tokio::test]
829 async fn an_account_and_an_organization_get_their_own_installation_tokens() {
830 let server = MockServer::start().await;
831 installed(&server, "me/a", 42).await;
832 installed(&server, "org/b", 77).await;
833 for (id, token) in [(42, "inst-me"), (77, "inst-org")] {
834 Mock::given(method("POST"))
835 .and(path(format!("/app/installations/{id}/access_tokens")))
836 .respond_with(ResponseTemplate::new(201).set_body_json(serde_json::json!({
837 "token": token,
838 "expires_at": "2099-01-01T00:00:00Z",
839 })))
840 .expect(1)
841 .mount(&server)
842 .await;
843 }
844 let app = app(&server);
845 assert_eq!(
846 app.token_for_repo("me/a").await.unwrap().as_deref(),
847 Some("inst-me")
848 );
849 assert_eq!(
850 app.token_for_repo("org/b").await.unwrap().as_deref(),
851 Some("inst-org")
852 );
853 }
854
855 #[tokio::test]
856 async fn a_failed_lookup_is_an_error_and_is_not_cached() {
857 let server = MockServer::start().await;
858 Mock::given(method("GET"))
859 .and(path("/repos/o/r/installation"))
860 .respond_with(ResponseTemplate::new(500))
861 .mount(&server)
862 .await;
863 let app = app(&server);
864 assert!(app.token_for_repo("o/r").await.is_err());
865 assert!(lock(&app.installations).get("o/r").is_none());
866 }
867
868 #[tokio::test]
869 async fn login_is_the_slug_with_the_bot_suffix() {
870 let server = MockServer::start().await;
871 Mock::given(method("GET"))
872 .and(path("/app"))
873 .respond_with(
874 ResponseTemplate::new(200).set_body_json(serde_json::json!({"slug": "orch-app"})),
875 )
876 .expect(1)
877 .mount(&server)
878 .await;
879 let app = app(&server);
880 assert_eq!(app.login().await.unwrap(), "orch-app[bot]");
881 assert_eq!(app.login().await.unwrap(), "orch-app[bot]");
882 }
883
884 #[tokio::test]
885 async fn a_review_is_submitted_on_the_head_sha_with_the_installation_token() {
886 let server = MockServer::start().await;
887 installed(&server, "o/r", 42).await;
888 Mock::given(method("POST"))
889 .and(path("/app/installations/42/access_tokens"))
890 .respond_with(ResponseTemplate::new(201).set_body_json(serde_json::json!({
891 "token": "inst-1",
892 "expires_at": "2099-01-01T00:00:00Z",
893 })))
894 .mount(&server)
895 .await;
896 Mock::given(method("POST"))
897 .and(path("/repos/o/r/pulls/9/reviews"))
898 .and(header_is("authorization", "Bearer inst-1"))
899 .and(body_partial_json(serde_json::json!({
900 "event": "APPROVE",
901 "commit_id": "abc123",
902 "body": "looks good",
903 })))
904 .respond_with(ResponseTemplate::new(200).set_body_json(serde_json::json!({"id": 1})))
905 .expect(1)
906 .mount(&server)
907 .await;
908 app(&server)
909 .submit_review("o/r", 9, ReviewEvent::Approve, "looks good", "abc123", &[])
910 .await
911 .expect("review submitted");
912 }
913
914 #[tokio::test]
915 async fn a_review_on_a_repo_without_the_app_fails_clearly() {
916 let server = MockServer::start().await;
917 Mock::given(method("GET"))
918 .and(path("/repos/org/b/installation"))
919 .respond_with(ResponseTemplate::new(404))
920 .mount(&server)
921 .await;
922 let err = app(&server)
923 .submit_review("org/b", 9, ReviewEvent::Approve, "ok", "abc123", &[])
924 .await
925 .unwrap_err()
926 .to_string();
927 assert!(err.contains("not installed on org/b"), "{err}");
928 }
929
930 #[test]
931 fn an_app_approval_on_an_older_sha_does_not_pass_the_gate() {
932 let reviews = vec![review(
933 "orch-app[bot]",
934 "APPROVED",
935 "old",
936 "2026-01-01T00:00:00Z",
937 )];
938 assert!(reviews_for_gate(&reviews, "new", Some("orch-app[bot]")).is_empty());
939 assert_eq!(
940 reviews_for_gate(&reviews, "old", Some("orch-app[bot]")).len(),
941 1
942 );
943 assert!(reviews_for_gate(&reviews, "new", Some("orch-app")).is_empty());
945 }
946
947 #[test]
948 fn human_reviews_stay_and_no_app_keeps_everything() {
949 let reviews = vec![
950 review("human", "CHANGES_REQUESTED", "old", "2026-01-01T00:00:00Z"),
951 review("orch-app[bot]", "APPROVED", "old", "2026-01-02T00:00:00Z"),
952 ];
953 let kept = reviews_for_gate(&reviews, "new", Some("orch-app[bot]"));
954 assert_eq!(kept.len(), 1);
955 assert_eq!(kept[0].user.login, "human");
956 assert_eq!(reviews_for_gate(&reviews, "new", None).len(), 2);
957 }
958
959 #[test]
960 fn an_app_review_on_the_head_replaces_the_comment_decision() {
961 let on_head = vec![review(
962 "orch-app",
963 "CHANGES_REQUESTED",
964 "head",
965 "2026-01-01T00:00:00Z",
966 )];
967 assert_eq!(
968 effective_comment_flags(&on_head, "head", Some("orch-app[bot]"), true, false),
969 (false, false)
970 );
971 assert_eq!(
973 effective_comment_flags(&on_head, "new", Some("orch-app[bot]"), true, false),
974 (true, false)
975 );
976 assert_eq!(
977 effective_comment_flags(&on_head, "head", None, true, false),
978 (true, false)
979 );
980 }
981
982 #[test]
983 fn hunk_headers_give_the_right_side_line_ranges() {
984 let patch =
985 "@@ -1,2 +10,3 @@\n a\n+b\n@@ -40 +44 @@ fn x()\n-c\n+d\n@@ -60,3 +70,0 @@\n-gone";
986 assert_eq!(right_side_ranges(patch), vec![(10, 12), (44, 44)]);
987 assert!(right_side_ranges("").is_empty());
988 assert!(right_side_ranges("@@ garbage @@").is_empty());
989 }
990
991 #[test]
992 fn issues_on_a_hunk_line_go_inline_and_the_rest_are_listed() {
993 use crate::engine::runner::response::ReviewIssue;
994 let issue = |file: &str, line: Option<u32>| ReviewIssue {
995 file: file.to_string(),
996 line,
997 severity: "warning".to_string(),
998 description: "check".to_string(),
999 };
1000 let hunks = HashMap::from([("a.rs".to_string(), vec![(10, 12)])]);
1001 let (inline, rest) = split_inline(
1002 &[
1003 issue("a.rs", Some(12)),
1004 issue("a.rs", Some(13)),
1005 issue("b.rs", None),
1006 ],
1007 &hunks,
1008 );
1009 assert_eq!(
1010 inline,
1011 vec![InlineComment {
1012 path: "a.rs".to_string(),
1013 line: 12,
1014 body: "**warning:** check".to_string(),
1015 }]
1016 );
1017 assert_eq!(
1018 rest,
1019 vec![
1020 "- `a.rs:13` **warning:** check",
1021 "- `b.rs` **warning:** check"
1022 ]
1023 );
1024 }
1025
1026 #[tokio::test]
1027 async fn a_failed_key_read_retries_and_a_later_read_publishes_the_app() {
1028 let calls = Arc::new(AtomicUsize::new(0));
1029 let counter = Arc::clone(&calls);
1030 let load = move || {
1031 if counter.fetch_add(1, Ordering::SeqCst) == 0 {
1032 anyhow::bail!("nobody answered the prompt");
1033 }
1034 Ok(Some(AppAuth::new(
1035 "12345".to_string(),
1036 test_pem().to_string(),
1037 "http://127.0.0.1:9".to_string(),
1038 )))
1039 };
1040 let published = Arc::new(Mutex::new(Vec::new()));
1041 let sink = Arc::clone(&published);
1042
1043 run_loader(
1044 load,
1045 move |app| lock(&sink).push(app.app_id.clone()),
1046 StdDuration::from_millis(5),
1047 )
1048 .await;
1049 assert_eq!(calls.load(Ordering::SeqCst), 2);
1050 assert_eq!(*lock(&published), vec!["12345".to_string()]);
1051 }
1052
1053 #[tokio::test]
1054 async fn no_app_configured_stops_the_loader_without_publishing() {
1055 let published = Arc::new(Mutex::new(0));
1056 let sink = Arc::clone(&published);
1057 run_loader(
1058 || Ok(None),
1059 move |_| *lock(&sink) += 1,
1060 StdDuration::from_millis(5),
1061 )
1062 .await;
1063 assert_eq!(*lock(&published), 0);
1064 }
1065}