From 36ade4e8f80033945767a52bf6cbb1bc797bccd1 Mon Sep 17 00:00:00 2001
From: Ronald Eytchison <58823072+reytchison@users.noreply.github.com>
Date: Fri, 8 Aug 2025 13:13:46 -0400
Subject: [PATCH] Fix merger-bot bug by using PathLike[str] interface (#256)

Also add integration test for merger bot

Co-authored-by: Brad Swain <brad.swain@trailofbits.com>
---
 .github/workflows/integration.yml                 | 15 +++++++++++++++
 .../src/buttercup/fuzzing_infra/corpus_merger.py  | 14 +++++++-------
 2 files changed, 22 insertions(+), 7 deletions(-)

diff --git a/.github/workflows/integration.yml b/.github/workflows/integration.yml
index 2403153d..e53c1af0 100644
--- a/.github/workflows/integration.yml
+++ b/.github/workflows/integration.yml
@@ -35,6 +35,10 @@ on:
         description: "Timeout for SARIF submission in minutes"
         required: false
         default: ""
+      merger_timeout:
+        description: "Timeout for merger bot in minutes"
+        required: false
+        default: ""
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -47,6 +51,7 @@ env:
   BUNDLE_TIMEOUT: ${{ inputs.bundle_timeout || 5 }}
   SARIF_TIMEOUT: ${{ inputs.sarif_timeout || 5 }}
   SEED_GEN_TIMEOUT: ${{ inputs.seed_gen_timeout || 25 }}
+  MERGER_TIMEOUT: ${{ inputs.merger_timeout || 10 }}
 
 permissions:
   contents: read
@@ -137,6 +142,16 @@ jobs:
             sleep 60
           done
 
+      - name: Wait for merger-bot to submit files to remote corpus and prune local corpus
+        timeout-minutes: ${{ fromJSON(env.MERGER_TIMEOUT) }}
+        run: |
+          while ! kubectl logs -n $BUTTERCUP_NAMESPACE -l app=merger-bot -c merger-bot --tail=-1  | grep "Synced [1-9][0-9]* files that add coverage to remote corpus"; do
+            sleep 60
+          done
+          while ! kubectl logs -n $BUTTERCUP_NAMESPACE -l app=merger-bot -c merger-bot --tail=-1  | grep "Removed [1-9][0-9]* files from local corpus .* that don't add coverage"; do
+            sleep 60
+          done
+
       - name: Wait for patch to be recorded
         timeout-minutes: ${{ fromJSON(env.PATCH_TIMEOUT) }}
         run: |
diff --git a/fuzzer/src/buttercup/fuzzing_infra/corpus_merger.py b/fuzzer/src/buttercup/fuzzing_infra/corpus_merger.py
index 2ee93375..82751222 100644
--- a/fuzzer/src/buttercup/fuzzing_infra/corpus_merger.py
+++ b/fuzzer/src/buttercup/fuzzing_infra/corpus_merger.py
@@ -97,7 +97,7 @@ class PartitionedCorpus:
 
         for file in local_files_list:
             try:
-                shutil.copy(os.path.join(self.corpus.path, file), os.path.join(str(self.local_dir), file))
+                shutil.copy(os.path.join(self.corpus.path, file), os.path.join(self.local_dir, file))
                 new_local_only_files.add(file)
                 if len(new_local_only_files) >= self.max_local_files:
                     break
@@ -111,10 +111,10 @@ class PartitionedCorpus:
 
         for file in self.remote_files:
             try:
-                shutil.copy(os.path.join(self.corpus.path, file), os.path.join(str(self.remote_dir), file))
+                shutil.copy(os.path.join(self.corpus.path, file), os.path.join(self.remote_dir, file))
             except Exception as e:
                 # Copy this from the remote storage instead (slow, but shouldn't dissappear from there)
-                shutil.copy(os.path.join(self.corpus.remote_path, file), os.path.join(str(self.remote_dir), file))
+                shutil.copy(os.path.join(self.corpus.remote_path, file), os.path.join(self.remote_dir, file))
                 logger.debug(f"Error copying file {file} to remote directory: {e}. Copied from remote storage instead.")
 
     def to_final(self) -> FinalCorpus:
@@ -125,10 +125,10 @@ class PartitionedCorpus:
         Will rehash any files in the remote_directory as the merge operation may have changed the file names.
         Then it will partition the files into push_remotely and delete_locally sets and return a FinalCorpus object.
         """
-        self.corpus.hash_corpus(str(self.remote_dir))
+        self.corpus.hash_corpus(os.fspath(self.remote_dir))
 
         # Partition the files into push_remotely and delete_locally sets
-        files_in_new_remote_dir = set(os.listdir(str(self.remote_dir)))
+        files_in_new_remote_dir = set(os.listdir(self.remote_dir))
 
         # All remote files must still be in merged files
         assert self.remote_files.issubset(files_in_new_remote_dir), "Some remote files were lost during merge"
@@ -237,7 +237,7 @@ class MergerBot:
 
                 # Run merge from local_dir to remote_dir to find which files add coverage
                 fuzz_conf = FuzzConfiguration(
-                    str(local_dir),
+                    os.fspath(local_dir),
                     str(build_dir / task.harness_name),
                     build.engine,
                     build.sanitizer,
@@ -264,7 +264,7 @@ class MergerBot:
                     )
 
                     # We specify the remote_dir as the target dir as that will cause any `local_dir` files that adds coverage to be moved to remote_dir.
-                    self.runner.merge_corpus(fuzz_conf, str(remote_dir))
+                    self.runner.merge_corpus(fuzz_conf, os.fspath(remote_dir))
                     span.set_status(Status(StatusCode.OK))
 
     def run_task(self, task: WeightedHarness, builds: list[BuildOutput]) -> bool: