fluidattacks_core_git/
errors.rs

1use std::io;
2use std::path::PathBuf;
3use std::process::ExitStatus;
4use std::time::Duration;
5
6/// A file call failed at `path`; `source` keeps the errno.
7#[derive(Debug, thiserror::Error)]
8#[error("{action} {}: {source}", path.display())]
9pub struct FileError {
10    pub action: &'static str,
11    pub path: PathBuf,
12    #[source]
13    pub source: io::Error,
14}
15
16/// Removing the symlinks or the out-of-scope files failed.
17#[derive(Debug, thiserror::Error)]
18pub enum PruneError {
19    #[error(transparent)]
20    File(#[from] FileError),
21    /// The git that lists the out-of-scope files failed.
22    #[error(transparent)]
23    Git(#[from] GitCallError),
24}
25
26/// Why `reset_repo` failed.
27#[derive(Debug, thiserror::Error)]
28pub enum ResetError {
29    /// `git reset --hard` failed, as it does for a path that is not the root.
30    #[error(transparent)]
31    Git(#[from] GitCallError),
32    #[error(transparent)]
33    Symlinks(#[from] FileError),
34}
35
36/// Why an `HttpsAccess` could not be built, worded as the python worded it.
37#[derive(Debug, PartialEq, Eq, thiserror::Error)]
38pub enum HttpsAccessError {
39    /// git reads a credential line by line: a line break could add a field, a nul cuts it short.
40    #[error("Invalid credentials: a line break or a nul byte")]
41    CredentialLineBreak,
42    #[error("expected an http or https url")]
43    NotHttp,
44    /// The url stays out of the message: it may carry a user and password.
45    #[error("Invalid url: its host or port could not be parsed")]
46    Unparsable,
47    #[error("expected an https credential")]
48    NotHttpsCredential,
49}
50
51/// Why `clone_to_temp` failed, by the step that failed.
52#[derive(Debug, thiserror::Error)]
53pub enum CloneError {
54    #[error(transparent)]
55    Access(#[from] HttpsAccessError),
56    #[error(transparent)]
57    Git(#[from] GitCallError),
58    /// The mirror cloned but its `.info.json` could not be written, so the clone was removed.
59    #[error(transparent)]
60    Info(#[from] FileError),
61    #[error(transparent)]
62    SshKey(#[from] SshKeyError),
63    #[error(transparent)]
64    Sts(#[from] StsError),
65}
66
67/// Why the SSH key could not be handed to git.
68#[derive(Debug, thiserror::Error)]
69pub enum SshKeyError {
70    #[error("the SSH key is not base64: {0}")]
71    Decode(#[from] base64::DecodeError),
72    #[error("the SSH key could not be written: {0}")]
73    File(#[source] io::Error),
74    #[error("the SSH key path cannot be quoted for the shell: {0}")]
75    Path(#[from] shlex::QuoteError),
76}
77
78/// Why an ls-remote over ssh could not ask; a refusal or a timeout is an answer, not this.
79#[derive(Debug, thiserror::Error)]
80pub enum LsRemoteError {
81    #[error(transparent)]
82    SshKey(#[from] SshKeyError),
83    #[error(transparent)]
84    Git(#[from] GitCallError),
85}
86
87/// Why no session came out of STS for a role.
88#[derive(Debug, thiserror::Error)]
89pub enum StsError {
90    /// STS answered with an error, as it does for a role that does not trust us.
91    #[error("STS refused the role {arn}: {code}: {message}")]
92    Refused {
93        arn: String,
94        code: String,
95        message: String,
96    },
97    /// No answer came: no network, no local credentials or a timeout.
98    #[error("STS could not be asked for the role {arn}: {reason}")]
99    Unreachable { arn: String, reason: String },
100    #[error("STS answered the role {arn} without credentials")]
101    NoCredentials { arn: String },
102}
103
104#[derive(Debug, thiserror::Error)]
105pub enum GitCallError {
106    #[error("git {command} could not start: {source}")]
107    NotStarted {
108        command: &'static str,
109        source: io::Error,
110    },
111    #[error("git {command} did not finish within {after:?}")]
112    TimedOut {
113        command: &'static str,
114        after: Duration,
115    },
116    /// git ran and refused, as it does for a missing repository or revision.
117    #[error("git {command} exited with {status}: {stderr}")]
118    Refused {
119        command: &'static str,
120        status: ExitStatus,
121        stderr: String,
122    },
123    /// No process can receive a NUL, so std turns the call down before it starts.
124    #[error("git {command} got an argument with an embedded null byte")]
125    NullByte { command: &'static str },
126    #[error("git {command} printed something unreadable: {reason}")]
127    Malformed {
128        command: &'static str,
129        reason: String,
130    },
131}
132
133/// Why `download_and_extract_repo` failed, by the step that failed.
134#[derive(Debug, thiserror::Error)]
135pub enum DownloadError {
136    /// The parent of the destination or the archive could not be created or
137    /// written.
138    #[error("writing the archive: {0}")]
139    Write(#[source] io::Error),
140    #[error(transparent)]
141    Fetch(#[from] FetchError),
142    #[error(transparent)]
143    Extract(#[from] ExtractError),
144    /// `git reset --hard` did not restore the working tree.
145    #[error(transparent)]
146    Reset(#[from] GitCallError),
147    #[error("pruning the working tree: {0}")]
148    Prune(#[from] PruneError),
149    /// The repository could not take the place of the destination, or the
150    /// work directory beside it could not be made.
151    #[error("placing the repository: {0}")]
152    Place(#[source] io::Error),
153}
154
155/// How the request for the archive failed.
156#[derive(Debug, thiserror::Error)]
157pub enum FetchError {
158    #[error("invalid url {url}: {reason}")]
159    InvalidUrl { url: String, reason: String },
160    #[error("not an http url: {0}")]
161    NonHttpUrl(String),
162    /// DNS, a refused connection or a TLS handshake that failed.
163    #[error("could not connect: {0}")]
164    Connect(#[source] reqwest::Error),
165    #[error("connecting timed out: {0}")]
166    ConnectTimeout(#[source] reqwest::Error),
167    /// The total timeout ran out before the response headers arrived.
168    #[error("no response in time: {0}")]
169    Timeout(#[source] reqwest::Error),
170    /// The server closed the connection before it answered.
171    #[error("the server disconnected: {0}")]
172    Disconnected(#[source] reqwest::Error),
173    /// The socket failed while the request was sent; `errno` is the one of
174    /// the socket call.
175    #[error("the socket failed: {source}")]
176    Socket {
177        reset: bool,
178        errno: Option<i32>,
179        source: reqwest::Error,
180    },
181    #[error("malformed response: {0}")]
182    Malformed(#[source] reqwest::Error),
183    #[error("the server answered {0}")]
184    Status(reqwest::StatusCode),
185    /// The body ended before its length, or the connection broke mid-read.
186    #[error("the body was cut: {0}")]
187    BodyCut(#[source] reqwest::Error),
188    /// The total timeout ran out while the body was read.
189    #[error("the body did not arrive in time: {0}")]
190    BodyTimeout(#[source] reqwest::Error),
191    #[error("the request failed: {0}")]
192    Other(#[source] reqwest::Error),
193}
194
195/// How turning the archive into a repository failed.
196#[derive(Debug, thiserror::Error)]
197pub enum ExtractError {
198    /// The archive is not gzip, its tar or deflate data is broken, or its
199    /// checksum does not match.
200    #[error("corrupt archive: {0}")]
201    Corrupt(#[source] io::Error),
202    /// The gzip stream ends before its trailer.
203    #[error("truncated archive: {0}")]
204    Truncated(#[source] io::Error),
205    /// The archive holds no top directory with a real `.git` directory.
206    #[error("the archive holds no repository: {0}")]
207    NoRepository(String),
208    #[error("extracting the archive: {0}")]
209    Io(#[source] io::Error),
210}
fluidattacks_core_git/errors.rs

fluidattacks_core_git/
errors.rs
