1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
//! The Failed run: why a Run can't end with a ready PR. The Delivery takes
//! a Run down the Failed run path; this is what that path ends with.
use std::fmt;
use std::path::PathBuf;
use anyhow::anyhow;
use crate::interrupt;
/// Why a Run did not end with a ready PR, and what the user should see.
pub struct FailedRun {
pub recovery: Option<Box<crate::recovery::Recovery>>,
pub error: anyhow::Error,
/// The Issue branch's open PR, if it has one.
pub pr_url: Option<String>,
/// The Session trace of the session the failure came from, else the most
/// recent one, if a session was started.
pub log: Option<PathBuf>,
/// Whether the Run was interrupted, as it was when the Run failed.
pub interrupted: bool,
/// In a Spec run, a line on each Ticket it landed or did not get done;
/// empty in a Run.
pub ticket_lines: Vec<String>,
}
impl FailedRun {
/// Whether a policy, security or merge hold held its Self-merge, leaving
/// its pull request ready for review on the head whose CI was watched.
pub fn held(&self) -> bool {
is_hold(&self.error)
}
}
/// Whether `error` is a policy, security or merge hold: a Self-merge held
/// with its pull request already ready.
pub fn is_hold(error: &anyhow::Error) -> bool {
error.is::<PolicyRefusal>()
|| error.is::<crate::security::review::Hold>()
|| error.is::<MergeHold>()
}
/// A repository policy that prevents Self-merge of a ready PR. The Run
/// fails without pushing a failure commit or converting the PR to a draft.
#[derive(Debug)]
pub enum PolicyRefusal {
/// A refused merge whose next Repair round found nothing to fix.
NothingToFix,
/// A structured review decision that blocks the merge before a request.
ReviewRequired { pr_url: String },
}
impl std::error::Error for PolicyRefusal {}
impl fmt::Display for PolicyRefusal {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
match self {
Self::NothingToFix => f.write_str(
"the merge was refused with nothing left to fix, so the PR stays ready for review",
),
Self::ReviewRequired { pr_url } => write!(
f,
"PR {pr_url} needs an approving review before it can merge; it is ready for review"
),
}
}
}
/// A Self-merge held before the merge request, with the pull request already
/// ready. The run fails without drafting the pull request. A protected path
/// in a Custom process is one; `reason` names the path.
#[derive(Debug)]
pub struct MergeHold {
pub reason: String,
}
impl std::error::Error for MergeHold {}
impl fmt::Display for MergeHold {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
f.write_str(&self.reason)
}
}
/// A failure with nothing to push or clean up, as before the worktree exists.
impl From<anyhow::Error> for FailedRun {
fn from(error: anyhow::Error) -> Self {
let interrupted = interrupt::requested();
FailedRun {
recovery: None,
error: interrupted_or(error, interrupted),
pr_url: None,
log: None,
interrupted,
ticket_lines: Vec::new(),
}
}
}
/// `interrupted` if the Run was, else `error`: an interrupt can surface as
/// some other error, such as a killed git.
pub fn interrupted_or(error: anyhow::Error, interrupted: bool) -> anyhow::Error {
if interrupted {
anyhow!("interrupted")
} else {
error
}
}