ci_manager/

issue.rs

//! Contains the Issue struct and its associated methods.
//!
//! The Issue struct is used to represent a GitHub issue that will be created
//! in a repository. It contains a title, label, and body. The body is a
//! collection of FailedJob structs, which contain information about the failed
//! jobs in a GitHub Actions workflow run.
use crate::{ensure_https_prefix, err_parse::ErrorMessageSummary};
use anyhow::Ok;
use std::fmt::{self, Display, Formatter, Write};

pub mod similarity;

#[derive(Debug)]
pub struct Issue {
    title: String,
    labels: Vec<String>,
    body: IssueBody,
}

impl Issue {
    pub fn new(
        title: String,
        run_id: String,
        mut run_link: String,
        failed_jobs: Vec<FailedJob>,
        label: String,
    ) -> Self {
        let mut labels = vec![label];
        failed_jobs.iter().for_each(|job| {
            if let Some(failure_label) = job.failure_label() {
                if !labels.contains(&failure_label) {
                    log::debug!("Adding failure label {failure_label} to issue");
                    labels.push(failure_label);
                }
            }
        });
        ensure_https_prefix(&mut run_link);
        Self {
            title,
            labels,
            body: IssueBody::new(run_id, run_link, failed_jobs),
        }
    }

    pub fn title(&self) -> &str {
        self.title.as_str()
    }

    pub fn labels(&self) -> &[String] {
        self.labels.as_slice()
    }

    pub fn body(&mut self) -> String {
        self.body.to_markdown_string()
    }
}

#[derive(Debug)]
pub struct IssueBody {
    run_id: String,
    run_link: String,
    failed_jobs: Vec<FailedJob>,
}

impl IssueBody {
    pub fn new(run_id: String, run_link: String, failed_jobs: Vec<FailedJob>) -> Self {
        Self {
            run_id,
            run_link,
            failed_jobs,
        }
    }

    pub fn to_markdown_string(&mut self) -> String {
        let mut output_str = format!(
            "**Run ID**: {id} [LINK TO RUN]({run_url})

**{failed_jobs_list_title}**
{failed_jobs_name_list}",
            id = self.run_id,
            run_url = self.run_link,
            failed_jobs_list_title = format_args!(
                "{cnt} {job} failed:",
                cnt = self.failed_jobs.len(),
                job = if self.failed_jobs.len() == 1 {
                    "job"
                } else {
                    "jobs"
                }
            ),
            failed_jobs_name_list =
                self.failed_jobs
                    .iter()
                    .fold(String::new(), |mut s_out, job| {
                        let _ = writeln!(s_out, "- **`{}`**", job.name);
                        s_out
                    })
        );
        let output_len = output_str.len();
        let output_left_before_max = 65535 - output_len;
        assert_ne!(self.failed_jobs.len(), 0);
        let available_len_per_job = output_left_before_max / self.failed_jobs.len();

        let mut failed_jobs_str = String::new();
        for job in self.failed_jobs.as_mut_slice() {
            failed_jobs_str.push_str(job.to_markdown_formatted_limit(available_len_per_job));
        }

        output_str.push_str(&failed_jobs_str);

        // Final check if it is too long, if it is still too long, we failed to format it properly within the max length
        // to still create an issue we do a dumb truncate as a last out
        if output_str.len() > 65535 {
            let remove_content_len = 65535 - output_str.len();
            log::warn!("Failed to properly format issue body within content max length, truncating {remove_content_len} characters from the end of the issue body to fit within issue content limits");
            output_str.truncate(remove_content_len);
        }

        output_str
    }
}

#[derive(Debug, PartialEq)]
pub enum FirstFailedStep {
    NoStepsExecuted,
    StepName(String),
}

impl fmt::Display for FirstFailedStep {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        match self {
            FirstFailedStep::NoStepsExecuted => write!(f, "No Steps were executed"),
            FirstFailedStep::StepName(step_name) => write!(f, "{step_name}"),
        }
    }
}

#[derive(Debug)]
pub struct FailedJob {
    name: String,
    id: String,
    url: String,
    failed_step: FirstFailedStep,
    error_message: ErrorMessageSummary,
    markdown_formatted: Option<String>,
}

impl FailedJob {
    pub fn new(
        name: String,
        id: String,
        mut url: String,
        failed_step: FirstFailedStep,
        error_message: ErrorMessageSummary,
    ) -> Self {
        ensure_https_prefix(&mut url);
        Self {
            name,
            id,
            url,
            failed_step,
            error_message,
            markdown_formatted: None,
        }
    }

    pub fn failure_label(&self) -> Option<String> {
        self.error_message.failure_label()
    }

    pub fn markdown_formatted_len(&mut self) -> usize {
        if let Some(markdown_formatted_str) = self.markdown_formatted.as_deref() {
            markdown_formatted_str.len()
        } else {
            // Format it and then check the length
            self.to_markdown_formatted().len()
        }
    }

    pub fn to_markdown_formatted(&mut self) -> &str {
        if self.markdown_formatted.is_none() {
            self.markdown_formatted = Some(self.to_string());
        }
        self.markdown_formatted.as_deref().unwrap()
    }

    pub fn to_markdown_formatted_limit(&mut self, max_len: usize) -> &str {
        // If the formatting hasn't been done yet or it has been formatted resulting in a larger length than `max_len`, format it again to meet the max_len criteria.
        if self.markdown_formatted.is_none()
            || self
                .markdown_formatted
                .as_deref()
                .is_some_and(|md| md.len() > max_len)
        {
            let summary = self.error_message.summary();
            let optional_log = match (self.error_message.logfile_name(), self.error_message.log()) {
                (Some(name), Some(contents)) => format!(
                    "
<details>
<summary>{name}</summary>
<br>

```
{contents}
```

</details>"
                ),
                _ => String::from(""),
            };
            let mut formatted_preface_str: String = format!(
                "
### `{name}` (ID {id})
**Step failed:** `{failed_step}`
\\
**Log:** {url}",
                name = self.name,
                id = self.id,
                failed_step = self.failed_step,
                url = self.url,
            );

            let orig_formatted_err_str = if self.failed_step == FirstFailedStep::NoStepsExecuted {
                "".to_string()
            } else {
                // Only add the `Best effort error summary` text if steps were actually executed
                formatted_preface_str.push_str(
                    "
\\
*Best effort error summary*:",
                );
                format!(
                    "\n```\n{error_message}```{optional_log}",
                    error_message = summary,
                )
            };
            let preface_len = formatted_preface_str.len();
            let formatted_err_str_len = orig_formatted_err_str.len();
            let mkdown_len = preface_len + formatted_err_str_len;
            if mkdown_len > max_len {
                let len_diff = mkdown_len - max_len;
                let target_formatted_err_str_len = orig_formatted_err_str.len() - len_diff;
                let error_message = summary.to_string();
                debug_assert!(error_message.len() >= len_diff);
                let formatted_err_str = if error_message.len() >= len_diff {
                    let (_, error_message) = error_message.split_at(len_diff);
                    let formatted_err_str = format!("\n```\n{error_message}```{optional_log}",);
                    debug_assert_eq!(formatted_err_str.len(), target_formatted_err_str_len);
                    formatted_err_str
                } else {
                    // Removing the error message is not enough to reach the target max_len so instead we remove the error summary completely
                    "(content > max len)".to_string()
                };
                formatted_preface_str.push_str(&formatted_err_str);
            } else {
                formatted_preface_str.push_str(&orig_formatted_err_str);
            }
            let final_mkdown = formatted_preface_str;
            self.markdown_formatted = Some(final_mkdown);
        }

        self.markdown_formatted.as_deref().unwrap()
    }
}

impl Display for FailedJob {
    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
        let summary = self.error_message.summary();
        let optional_log = match (self.error_message.logfile_name(), self.error_message.log()) {
            (Some(name), Some(contents)) => format!(
                "
<details>
<summary>{name}</summary>
<br>

```
{contents}
```
</details>"
            ),
            _ => String::from(""),
        };

        write!(
            f,
            "
### `{name}` (ID {id})
**Step failed:** `{failed_step}`
\\
**Log:** {url}
\\
*Best effort error summary*:
```
{error_message}```{optional_log}",
            name = self.name,
            id = self.id,
            failed_step = self.failed_step,
            url = self.url,
            error_message = summary,
            optional_log = optional_log
        )
    }
}

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

    const EXAMPLE_ISSUE_BODY: &str = r#"**Run ID**: 7858139663 [LINK TO RUN]( https://github.com/luftkode/distro-template/actions/runs/7850874958)

**2 jobs failed:**
- **`Test template xilinx`**
- **`Test template raspberry`**

### `Test template xilinx` (ID 21442749267)
**Step failed:** `📦 Build yocto image`
\
**Log:** https://github.com/luftkode/distro-template/actions/runs/7850874958/job/21442749267
\
*Best effort error summary*:
```
Yocto error: ERROR: No recipes available for: ...
```
### `Test template raspberry` (ID 21442749166)
**Step failed:** `📦 Build yocto image`
\
**Log:** https://github.com/luftkode/distro-template/actions/runs/7850874958/job/21442749166
\
*Best effort error summary*:
```
Yocto error: ERROR: No recipes available for: ...
```"#;

    #[test]
    fn test_issue_new() {
        let run_id = "7858139663".to_string();
        let run_link =
            "https://github.com/luftkode/distro-template/actions/runs/7850874958".to_string();
        let failed_jobs = vec![
            FailedJob::new(
                "Test template xilinx".to_string(),
                "21442749267".to_string(),
                "https://github.com/luftkode/distro-template/actions/runs/7850874958/job/21442749267".to_string(),
                FirstFailedStep::StepName("📦 Build yocto image".to_owned()),
                ErrorMessageSummary::Other("Yocto error: ERROR: No recipes available for: ...
".to_string()),
            ),
            FailedJob::new(
                "Test template raspberry".to_string(),
                "21442749166".to_string(),
                "https://github.com/luftkode/distro-template/actions/runs/7850874958/job/21442749166".to_string(),
                FirstFailedStep::StepName("📦 Build yocto image".to_owned()),
                ErrorMessageSummary::Other("Yocto error: ERROR: No recipes available for: ...
".to_string()),
            ),
        ];
        let label = "bug".to_string();
        let issue = Issue::new(
            "Scheduled run failed".to_string(),
            run_id,
            run_link,
            failed_jobs,
            label,
        );
        assert_eq!(issue.title, "Scheduled run failed");
        assert_eq!(issue.labels, ["bug"]);
        assert_eq!(issue.body.failed_jobs.len(), 2);
        assert_eq!(issue.body.failed_jobs[0].id, "21442749267");
    }

    #[test]
    fn test_issue_body_display() {
        let run_id = "7858139663".to_string();
        let run_link =
            " https://github.com/luftkode/distro-template/actions/runs/7850874958".to_string();
        let failed_jobs = vec![
            FailedJob::new(
                "Test template xilinx".to_string(),
                "21442749267".to_string(),
                "https://github.com/luftkode/distro-template/actions/runs/7850874958/job/21442749267".to_string(),
                FirstFailedStep::StepName("📦 Build yocto image".to_owned()),
                ErrorMessageSummary::Other("Yocto error: ERROR: No recipes available for: ...
".to_string()),
            ),
            FailedJob::new(
                "Test template raspberry".to_string(),
                "21442749166".to_string(),
                "https://github.com/luftkode/distro-template/actions/runs/7850874958/job/21442749166".to_string(),
                FirstFailedStep::StepName("📦 Build yocto image".to_owned()),
                ErrorMessageSummary::Other("Yocto error: ERROR: No recipes available for: ...
".to_string()),
            ),
            ];

        let mut issue_body = IssueBody::new(run_id, run_link, failed_jobs);
        assert_eq!(issue_body.to_markdown_string(), EXAMPLE_ISSUE_BODY);
        //std::fs::write("test2.md", issue_body.to_markdown_string()).unwrap();
    }
}