Add observeGuidance

rohanpadhye · Sep 5, 2024 · 6309564 · 6309564
1 parent 4786c1f
commit 6309564
Show file tree

Hide file tree

Showing 5 changed files with 27 additions and 10 deletions.
diff --git a/fuzz/src/main/java/edu/berkeley/cs/jqf/fuzz/afl/AFLGuidance.java b/fuzz/src/main/java/edu/berkeley/cs/jqf/fuzz/afl/AFLGuidance.java
@@ -167,6 +167,11 @@ public void finalize() {
         }
     }
 
+    @Override
+    public String observeGuidance() {
+        return "AFL";
+    }
+
 
     /**
      * Returns an input stream containing the bytes that AFL

diff --git a/fuzz/src/main/java/edu/berkeley/cs/jqf/fuzz/ei/ZestGuidance.java b/fuzz/src/main/java/edu/berkeley/cs/jqf/fuzz/ei/ZestGuidance.java
@@ -437,6 +437,14 @@ protected void appendLineToFile(File file, String line) throws GuidanceException
 
     }
 
+    @Override
+    public String observeGuidance() {
+        if (blind) {
+            return "Random";
+        }
+        return "Zest";
+    }
+
     /* Writes a line of text to the log file. */
     protected void infoLog(String str, Object... args) {
         if (verbose) {

diff --git a/fuzz/src/main/java/edu/berkeley/cs/jqf/fuzz/guidance/Guidance.java b/fuzz/src/main/java/edu/berkeley/cs/jqf/fuzz/guidance/Guidance.java
@@ -132,6 +132,14 @@ default void observeGeneratedArgs(Object[] args) {
         // Do nothing
     }
 
+    /**
+     * <p>This method is only invoked during optional observability
+     * logging to provide the type of guidance used for input generation.</p>
+     */
+    default String observeGuidance() {
+        return "";
+    }
+
     /**
      * Handles the end of a fuzzing trial.
      *

diff --git a/fuzz/src/main/java/edu/berkeley/cs/jqf/fuzz/junit/quickcheck/FuzzStatement.java b/fuzz/src/main/java/edu/berkeley/cs/jqf/fuzz/junit/quickcheck/FuzzStatement.java
@@ -187,16 +187,7 @@ public void evaluate() throws Throwable {
                         observability.addTiming(startTrialTime, endGenerationTime, endTrialTime);
                     }
                     observability.addArgs(args);
-
-                    if (guidance instanceof ZestGuidance) {
-                        observability.add("how_generated", "Zest");
-                    } else if (guidance instanceof NoGuidance) {
-                        observability.add("how_generated", "random");
-                    } else if (guidance instanceof ReproGuidance) {
-                        observability.add("how_generated", "repro");
-                    } else {
-                        observability.add("how_generated", "unknown");
-                    }
+                    observability.add("how_generated", guidance.observeGuidance());
 
                     observability.writeToFile();
                 }

diff --git a/fuzz/src/main/java/edu/berkeley/cs/jqf/fuzz/repro/ReproGuidance.java b/fuzz/src/main/java/edu/berkeley/cs/jqf/fuzz/repro/ReproGuidance.java
@@ -191,6 +191,11 @@ public void observeGeneratedArgs(Object[] args) {
         }
     }
 
+    @Override
+    public String observeGuidance() {
+        return "Repro";
+    }
+
     /**
      * Writes an object to a file
      *