Fixed diff_ignore not working

Author: dag-andersen

.gitignore

@@ -3,3 +3,4 @@ target/
 argocd/
 secrets/
 output/
+.vscode/

Cargo.lock

@@ -6,13 +6,13 @@ edition = "2021"
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
 [dependencies]
-tokio = {version="1.4.0",features = ["full"]}
-base64 = "0.22.0"
+tokio = {version="1.37.0",features = ["full"]}
+base64 = "0.22.1"
 serde = "1.0"
 serde_yaml = "0.9"
-serde_json = "1.0.115"
+serde_json = "1.0.117"
 walkdir = "2.5.0"
-schemars = "0.8.16"
+schemars = "0.8.19"
 structopt = { version = "0.3" }
 regex = "1.10.4"
 log = "0.4.21"

Cargo.toml

@@ -34,7 +34,7 @@ RUN rm ./target/release/deps/argocd_diff_preview-*
 RUN cargo build --release
 
 # our final base
-FROM rust:1-slim-buster
+FROM rust:1-slim-bookworm
 
 COPY --from=docker:dind /usr/local/bin/docker /usr/local/bin/
 

Dockerfile_AMD64

@@ -34,7 +34,7 @@ RUN rm ./target/release/deps/argocd_diff_preview-*
 RUN cargo build --release
 
 # our final base
-FROM rust:1-slim-buster
+FROM rust:1-slim-bookworm
 
 COPY --from=docker:dind /usr/local/bin/docker /usr/local/bin/
 
@@ -46,4 +46,4 @@ COPY --from=build /argocd-diff-preview/target/release/argocd-diff-preview .
 RUN apt-get update && apt-get install -y git
 
 # set the startup command to run your binary
-CMD ["./argocd-diff-preview"]
+ENTRYPOINT ["./argocd-diff-preview"]

Dockerfile_ARM64

@@ -286,8 +286,9 @@ OPTIONS:
         --base-branch-folder <folder>       Base branch folder [env: BASE_BRANCH_FOLDER=]  [default: base-branch]
     -i, --diff-ignore <diff-ignore>         Ignore lines in diff. Example: use 'v[1,9]+.[1,9]+.[1,9]+' for ignoring changes caused by version changes following semver [env: DIFF_IGNORE=]
     -r, --file-regex <file-regex>           Regex to filter files. Example: "/apps_.*\.yaml" [env: FILE_REGEX=]
-    -l, --line-count <line-count>           Generate diffs with <n> lines above and below the highlighted changes in the diff. Default: 10 [env: LINE_COUNT=]
+    -l, --line-count <line-count>           Generate diffs with <n> lines above and below the highlighted changes in the diff. [env: LINE_COUNT=]  [Default: 10] 
         --local-cluster-tool <tool>         Local cluster tool. Options: kind, minikube [env: LOCAL_CLUSTER_TOOL=] [default: auto]
+        --max-diff-length <length>          Max diff message character count. [env: MAX_DIFF_LENGTH=]  [Default: 65536] (GitHub comment limit)
     -o, --output-folder <output-folder>     Output folder where the diff will be saved [env: OUTPUT_FOLDER=]  [default: ./output]
         --repo <repo>                       Git Repository. Format: OWNER/REPO [env: REPO=]
     -s, --secrets-folder <secrets-folder>   Secrets folder where the secrets are read from [env: SECRETS_FOLDER=]  [default: ./secrets]
@@ -298,9 +299,6 @@ OPTIONS:
 
 ## Roadmap
 - Make a dedicated GitHub Action that wraps the Docker container, so the tool becomes more user-friendly.  
-- Let the user specify Argo CD version. Currently it always uses the newest version available.
-- Let the user specify how many lines above and below the code change they want to see. This is useful when the diff is too big to be displayed in a PR comment.
-- Let the user specify max characters in the diff. This is useful when the diff is too big to be displayed in a PR comment.
 - Delete Argo CD Applications, when they have been parsed by the tool, so Argo CD can focus on the remaining applications, which hopefully speeds up the rendering process.
 
 ## Questions, issues, or suggestions

README.md

@@ -2,6 +2,7 @@ gitops_repo ?= argocd-diff-preview
 github_org ?= dag-andersen
 base_branch := main
 docker_file := Dockerfile_ARM64
+timeout := 120
 
 pull-repostory:
 	@rm -rf base-branch || true && mkdir -p base-branch
@@ -10,7 +11,7 @@ pull-repostory:
 	cd target-branch && gh repo clone $(github_org)/$(gitops_repo) -- --depth=1 --branch "$(target_branch)" && cp -r $(gitops_repo)/. . && rm -rf .git && echo "*" > .gitignore && rm -rf $(gitops_repo) && cd -
 
 local-test-cargo: pull-repostory
-	cargo run -- -b "$(base_branch)" -t "$(target_branch)" --repo $(github_org)/$(gitops_repo) -r "$(regex)" --debug
+	cargo run -- -b "$(base_branch)" -t "$(target_branch)" --repo $(github_org)/$(gitops_repo) -r "$(regex)" --debug --diff-ignore "$(diff-ignore)" --timeout $(timeout)
 
 local-test-docker: pull-repostory
 	docker build . -f $(docker_file) -t image
@@ -26,4 +27,6 @@ local-test-docker: pull-repostory
 		-e TARGET_BRANCH=$(target_branch) \
 		-e REPO=$(github_org)/$(gitops_repo) \
 		-e FILE_REGEX="$(regex)" \
+		-e DIFF_IGNORE="$(diff-ignore)" \
+		-e TIMEOUT=$(timeout) \
 		image

makefile

@@ -1,4 +1,4 @@
-use log::info;
+use log::{debug, info};
 use std::fs;
 use std::{error::Error, process::Output};
 
@@ -20,45 +20,54 @@ pub async fn generate_diff(
         base_branch_name, target_branch_name
     );
 
-    let list_of_patterns_to_ignore = match diff_ignore {
-        Some(s) => format!("--ignore-matching-lines='{}'", s),
+    let patterns_to_ignore = match diff_ignore {
+        Some(s) => format!("--ignore-matching-lines {}", s),
         None => "".to_string(),
     };
 
     let parse_diff_output = |output: Result<Output, Output>| -> String {
-        match output {
-            Ok(_) => "No changes found".to_string(),
-            Err(e) => String::from_utf8_lossy(&e.stdout).trim().to_string(),
+        let o = match output {
+            Err(e) if !e.stderr.is_empty() => panic!(
+                "Error running diff command with error: {}",
+                String::from_utf8_lossy(&e.stderr)
+            ),
+            Ok(e) => String::from_utf8_lossy(&e.stdout).trim_end().to_string(),
+            Err(e) => String::from_utf8_lossy(&e.stdout).trim_end().to_string(),
+        };
+        if o.trim().is_empty() {
+            return "No changes found".to_string();
+        } else {
+            o
         }
     };
 
-    let summary_as_string = parse_diff_output(
-        run_command(
-            &format!(
-                "git --no-pager diff --compact-summary --no-index {} {} {}",
-                list_of_patterns_to_ignore,
-                Branch::Base,
-                Branch::Target
-            ),
-            Some(output_folder),
-        )
-        .await,
+    let summary_diff_command = format!(
+        "git --no-pager diff --compact-summary --no-index {} {} {}",
+        patterns_to_ignore,
+        Branch::Base,
+        Branch::Target
     );
 
-    let diff_as_string = parse_diff_output(
-        run_command(
-            &format!(
-                "git --no-pager diff --no-prefix -U{} --no-index {} {} {}",
-                line_count.unwrap_or(10),
-                list_of_patterns_to_ignore,
-                Branch::Base,
-                Branch::Target
-            ),
-            Some(output_folder),
-        )
-        .await,
+    debug!(
+        "Getting summary diff with command: {}",
+        summary_diff_command
+    );
+
+    let summary_as_string =
+        parse_diff_output(run_command(&summary_diff_command, Some(output_folder)).await);
+
+    let diff_command = &format!(
+        "git --no-pager diff --no-prefix -U{} --no-index {} {} {}",
+        line_count.unwrap_or(10),
+        patterns_to_ignore,
+        Branch::Base,
+        Branch::Target
     );
 
+    debug!("Getting diff with command: {}", diff_command);
+
+    let diff_as_string = parse_diff_output(run_command(diff_command, Some(output_folder)).await);
+
     let remaining_max_chars =
         max_diff_message_char_count - markdown_template_length() - summary_as_string.len();
 

src/diff.rs

@@ -15,7 +15,7 @@ static ERROR_MESSAGES: [&str; 7] = [
     "path does not exist",
     "error converting YAML to JSON",
     "Unknown desc = `helm template .",
-    "Unknown desc = Unable to resolve"
+    "Unknown desc = Unable to resolve",
 ];
 
 static TIMEOUT_MESSAGES: [&str; 4] = [
@@ -146,10 +146,7 @@ pub async fn get_resources(
             if !other_errors.is_empty() {
                 error!("❌ Applications with 'ComparisonError' errors:");
                 for (name, msg) in &other_errors {
-                    error!(
-                        "❌ {}, {}",
-                        name, msg
-                    );
+                    error!("❌ {}, {}", name, msg);
                 }
             }
             return Err("Timed out".into());
@@ -231,7 +228,8 @@ pub async fn delete_applications() {
             .await
             .map(|o| String::from_utf8_lossy(&o.stdout).to_string())
             .map(|e| e.trim().is_empty())
-            .unwrap_or_default() {
+            .unwrap_or_default()
+        {
             let _ = child.kill();
             break;
         }
@@ -241,7 +239,8 @@ pub async fn delete_applications() {
             .await
             .map(|o| String::from_utf8_lossy(&o.stdout).to_string())
             .map(|e| e.trim().is_empty())
-            .unwrap_or_default() {
+            .unwrap_or_default()
+        {
             let _ = child.kill();
             break;
         }

src/extract.rs

@@ -10,9 +10,7 @@ use log::{debug, error, info};
 use std::path::PathBuf;
 use structopt::StructOpt;
 
-use crate::utils::{
-    check_if_folder_exists, create_folder_if_not_exists, run_command,
-};
+use crate::utils::{check_if_folder_exists, create_folder_if_not_exists, run_command};
 mod argocd;
 mod diff;
 mod extract;
@@ -45,7 +43,7 @@ struct Opt {
     diff_ignore: Option<String>,
 
     /// Generate diffs with <n> lines above and below the highlighted changes in the diff. Default: 10
-    #[structopt(short, long, env)] 
+    #[structopt(short, long, env)]
     line_count: Option<usize>,
 
     /// Argo CD version. Default: stable
@@ -138,12 +136,15 @@ async fn main() -> Result<(), Box<dyn Error>> {
     let base_branch_name = opt.base_branch;
     let target_branch_name = opt.target_branch;
     let repo = opt.repo;
-    let diff_ignore = opt.diff_ignore;
+    let diff_ignore = opt.diff_ignore.filter(|f| !f.trim().is_empty());
     let timeout = opt.timeout;
     let output_folder = opt.output_folder.as_str();
     let secrets_folder = opt.secrets_folder.as_str();
     let line_count = opt.line_count;
-    let argocd_version = opt.argocd_version.as_deref();
+    let argocd_version = opt
+        .argocd_version
+        .as_deref()
+        .filter(|f| !f.trim().is_empty());
     let max_diff_length = opt.max_diff_length;
 
     // select local cluster tool