feat: add fix-patch-path output variable

resolves #376

If there are any auto-fixes available, then a patch full of them is created and its path is set to a new output `fix-patch-path` output variable.

If there were no auto-fixes, then the output variable is not set, which is treated as an empty in `steps.linter.outputs.fix-patch-path` context).

Author: 2bndy5

cpp-linter/src/cli/structs.rs

@@ -233,6 +233,10 @@ pub struct ClangParams {
 impl ClangParams {
     /// The directory name to use for caching clang-tidy and clang-format results.
     pub(crate) const CACHE_DIR: &str = ".cpp-linter-cache";
+
+    /// The file name for aggregating auto-fixes into a unified patch.
+    pub(crate) const AUTO_FIX_PATCH: &str = "auto_fix.patch";
+
     pub(crate) fn get_cache_path(&self) -> PathBuf {
         self.repo_root.join(Self::CACHE_DIR).join("patched")
     }

cpp-linter/src/common_fs.rs

@@ -3,6 +3,7 @@
 use std::{
     fmt::Debug,
     fs,
+    io::Write,
     num::NonZeroU32,
     ops::RangeInclusive,
     path::{Path, PathBuf},
@@ -16,7 +17,7 @@ use crate::{
     clang_tools::{
         ReviewComments, Suggestion, clang_format::FormatAdvice, clang_tidy::TidyAdvice, make_patch,
     },
-    cli::LinesChangedOnly,
+    cli::{ClangParams, LinesChangedOnly},
     error::FileObjError,
 };
 
@@ -162,6 +163,57 @@ impl FileObj {
         false
     }
 
+    /// If the file has a cached fixes, then append them to a unified patched file.
+    ///
+    /// This is the alternative to [`FileObj::make_suggestions_from_patch()`] when
+    /// a PR review is not being posted. Both function have to create a patch by
+    /// reading the original file and patched file (in cache), but
+    /// [`FileObj::make_suggestions_from_patch()`] does more with the diff than this function.
+    pub fn maybe_append_patch(&self, repo_root: &Path) -> Result<(), FileObjError> {
+        let patched = match &self.patched_path {
+            Some(patched_path) if patched_path.exists() => {
+                fs::read_to_string(patched_path).map_err(FileObjError::ReadFile)?
+            }
+            _ => return Ok(()),
+        };
+        let original_content =
+            fs::read_to_string(repo_root.join(&self.name)).map_err(FileObjError::ReadFile)?;
+        let (diff, input) = make_patch(patched.as_str(), &original_content);
+        let file_name = self.name.to_string_lossy().replace("\\", "/");
+        Self::append_patch(&file_name, &input, &diff, repo_root)?;
+        Ok(())
+    }
+
+    /// write fixes to a unified patch file in the cache directory.
+    fn append_patch(
+        file_name: &str,
+        input: &InternedInput<&str>,
+        diff: &Diff,
+        repo_root: &Path,
+    ) -> Result<(), FileObjError> {
+        let printer = BasicLineDiffPrinter(&input.interner);
+        let mut diff_config = UnifiedDiffConfig::default();
+        diff_config.context_len(0);
+        let unified_diff = diff.unified_diff(&printer, diff_config, input).to_string();
+        if !unified_diff.is_empty() {
+            let patch_path_parent = repo_root.join(ClangParams::CACHE_DIR);
+            fs::create_dir_all(&patch_path_parent).map_err(FileObjError::MkDirFailed)?;
+            let patch_file_path = patch_path_parent.join(ClangParams::AUTO_FIX_PATCH);
+            let mut patch_file = fs::OpenOptions::new()
+                .append(true)
+                .create(true)
+                .truncate(false)
+                .open(&patch_file_path)
+                .map_err(FileObjError::OpenPatchFileFailed)?;
+            patch_file
+                .write_all(
+                    format!("--- a/{file_name}\n+++ b/{file_name}\n{unified_diff}",).as_bytes(),
+                )
+                .map_err(FileObjError::WritePatchFailed)?;
+        }
+        Ok(())
+    }
+
     /// Create a list of [`Suggestion`](struct@crate::clang_tools::Suggestion) from a
     /// generated diff and store them in the given
     /// [`ReviewComments`](struct@crate::clang_tools::ReviewComments).
@@ -183,7 +235,8 @@ impl FileObj {
         let original_content =
             fs::read_to_string(repo_root.join(&self.name)).map_err(FileObjError::ReadFile)?;
         let (diff, input) = make_patch(patched.as_str(), &original_content);
-        let file_name = self.name.to_str().unwrap_or_default().replace("\\", "/");
+        let file_name = self.name.to_string_lossy().replace("\\", "/");
+        Self::append_patch(&file_name, &input, &diff, repo_root)?;
 
         self.get_suggestions(review_comments, &diff, &input, summary_only)
             .map_err(FileObjError::DisplayStringFailed)?;

cpp-linter/src/error.rs

@@ -17,6 +17,18 @@ pub enum FileObjError {
     /// Error when failing to generate a patch for a file.
     #[error("Failed to print a hunk to a string buffer: {0}")]
     DisplayStringFailed(#[source] std::fmt::Error),
+
+    /// Error when failing to create the cache directory for the patch file.
+    #[error("Failed to create cache directory for the patch file: {0}")]
+    MkDirFailed(#[source] std::io::Error),
+
+    /// Error when failing to open the patch file for writing.
+    #[error("Failed to open patch file for writing: {0}")]
+    OpenPatchFileFailed(#[source] std::io::Error),
+
+    /// Error when failing to write to the patch file.
+    #[error("Failed to write to the patch file: {0}")]
+    WritePatchFailed(#[source] std::io::Error),
 }
 
 /// Errors related to the REST client used for posting feedback and special logging.

cpp-linter/src/rest_client.rs

@@ -18,7 +18,7 @@ use crate::{
         clang_format::{summarize_style, tally_format_advice},
         clang_tidy::tally_tidy_advice,
     },
-    cli::{FeedbackInput, ThreadComments},
+    cli::{ClangParams, FeedbackInput, ThreadComments},
     common_fs::FileObj,
     error::ClientError,
 };
@@ -232,6 +232,23 @@ impl RestClient {
                 summary_only,
             );
             self.client.post_pr_review(&options).await?;
+        } else {
+            for file in files {
+                let file = file
+                    .lock()
+                    .map_err(|e| ClientError::MutexPoisoned(e.to_string()))?;
+                file.maybe_append_patch(&feedback_inputs.repo_root)?;
+            }
+        }
+        let auto_fix_patch_patch = feedback_inputs
+            .repo_root
+            .join(ClangParams::CACHE_DIR)
+            .join(ClangParams::AUTO_FIX_PATCH);
+        if auto_fix_patch_patch.exists() {
+            self.client.write_output_variables(&[OutputVariable {
+                name: "fix-patch-path".to_string(),
+                value: auto_fix_patch_patch.to_string_lossy().replace("\\", "/"),
+            }])?;
         }
         Ok(format_checks_failed + tidy_checks_failed)
     }

cpp-linter/tests/comments.rs

@@ -252,7 +252,7 @@ async fn setup(lib_root: &Path, tmp_dir: &TempDir, test_params: &TestParams) {
         format!("--thread-comments={}", test_params.thread_comments),
         format!("--no-lgtm={}", test_params.no_lgtm),
         "-p=build".to_string(),
-        "-i=build".to_string(),
+        "-i=build/**".to_string(),
         format!("--repo-root={}", tmp_dir.path().to_str().unwrap()),
     ];
     if test_params.force_lgtm {
@@ -274,6 +274,13 @@ async fn setup(lib_root: &Path, tmp_dir: &TempDir, test_params: &TestParams) {
     for mock in mocks {
         mock.assert();
     }
+    let patch_path = tmp_dir
+        .path()
+        .join(".cpp-linter-cache")
+        .join("auto_fix.patch");
+    let patch_content =
+        std::fs::read_to_string(patch_path).expect("Failed to read generated patch file.");
+    println!("Generated patch content:\n{patch_content}");
 }
 
 async fn test_comment(test_params: &TestParams) {

cpp-linter/tests/reviews.rs

@@ -231,7 +231,7 @@ async fn setup(lib_root: &Path, tmp_dir: &TempDir, test_params: &TestParams) {
         format!("--passive-reviews={}", test_params.passive_reviews),
         format!("--no-lgtm={}", test_params.no_lgtm),
         "-p=build".to_string(),
-        "-i=build".to_string(),
+        "-i=build/**".to_string(),
         format!("--repo-root={}", tmp_dir.path().to_str().unwrap()),
     ];
     if test_params.force_lgtm {