Add more debug logging and --logger-level option

Author: StefanosChaliasos

.gitignore

@@ -1,3 +1,4 @@
+output*
 .vscode
 tags
 *.*.swp

src/zkregex_fuzzer/cli.py

@@ -84,9 +84,17 @@ def main():
         type=str,
         help="Path to the ptau (powers-of-tau) file for the proving step"
     )
+    parser.add_argument(
+        "--logger-level",
+        choices=["DEBUG", "INFO", "WARNING", "ERROR", "CRITICAL"],
+        default="INFO",
+        help="Set the logger level (default: INFO)."
+    )
 
     args = parser.parse_args()
 
+    logger.setLevel(args.logger_level)
+
     if args.oracle == "valid" and not args.valid_input_generator:
         print("Valid input generator is required for valid oracle.")
         exit(1)

src/zkregex_fuzzer/runner/circom.py

@@ -251,6 +251,7 @@ def compile(self, regex: str) -> None:
         """
         Compile the regex.
         """
+        logger.debug(f"Compiling regex starts")
         # Create JSON for the regex for zk-regex 
         base_json = {
             "parts": []
@@ -269,25 +270,31 @@ def compile(self, regex: str) -> None:
         circom_file_path = tempfile.NamedTemporaryFile(suffix=".circom", delete=False).name
 
         # Call zk-regex to generate the circom code
+        logger.debug(f"Generating circom code starts")
         ZkRegexSubprocess.compile(json_file_path, circom_file_path, self._template_name)
+        logger.debug(f"Generating circom code ends")
 
         # Append the circom file to include the main function
         with open(circom_file_path, 'a') as f:
             f.write("\n\n")
             f.write("component main {public [msg]} = " + f"{self._template_name}({self._circom_max_input_size});")
 
         # Compile the circom code to wasm
+        logger.debug(f"Compiling circom code starts")
         self._wasm_path, self._r1cs_path = CircomSubprocess.compile(circom_file_path, self._link_path)
+        logger.debug(f"Compiling circom code ends")
 
         # Also setup the proving and verification key if the flag is set
         if self._run_the_prover:
             self._zkey_path = SnarkjsSubprocess.setup_zkey(self._r1cs_path, self._ptau_path)
             self._vkey_path = SnarkjsSubprocess.export_verification_key(self._zkey_path)
+        logger.debug(f"Compiling regex ends")
 
     def match(self, input: str) -> tuple[bool, str]:
         """
         Match the regex on an input.
         """
+        logger.debug(f"Matching regex starts")
         # Convert input to list of decimal ASCII values and pad input with zeroes
         numeric_input = [ord(c) for c in input] + [0] * (self._circom_max_input_size - len(input))
 
@@ -298,10 +305,12 @@ def match(self, input: str) -> tuple[bool, str]:
 
         # Skip if input is larger than circuit max input size
         if len(numeric_input) > self._circom_max_input_size:
-            raise RegexRunError(f"Input too large for input: {input}")
+            raise RegexRunError(f"Input too large for input: {len(numeric_input)}")
 
         # Generate the witness
+        logger.debug(f"Generating witness starts")
         witness_path = SnarkjsSubprocess.witness_gen(self._wasm_path, input_path)
+        logger.debug(f"Generating witness ends")
         # Remove input file
         Path(input_path).unlink()
 
@@ -320,6 +329,7 @@ def match(self, input: str) -> tuple[bool, str]:
 
         # Return the output of the match
         output = int(result[1])
+        logger.debug(f"Matching regex ends")
         return output == 1, ""
 
     def clean(self):

src/zkregex_fuzzer/vinpgen.py

@@ -53,6 +53,7 @@ def generate_many(self, n: int) -> List[str]:
         If the generator is able to generate less than n valid inputs, 
         it will silently return the number of valid inputs generated.
         """
+        logger.debug("Start generating valid inputs.")
         valid_inputs = []
         attempts = 0
         logger.debug(f"Generating {n} valid inputs for the regex: {self.regex} with {self._max_attempts} attempts using {self.__class__.__name__}.")
@@ -66,7 +67,8 @@ def generate_many(self, n: int) -> List[str]:
             attempts += 1
         if len(valid_inputs) == 0:
             raise ValueError("Failed to generate any valid input for the regex.")
-        logger.debug(f"Generated valid inputs for the regex: {valid_inputs}.")
+        #logger.debug(f"Generated valid inputs for the regex: {valid_inputs}.")
+        logger.debug("Finished generating valid inputs.")
         return valid_inputs
 
     @abstractmethod