Mutation repairs

slither/tools/mutator/__main__.py

@@ -167,7 +167,10 @@ def main() -> None:  # pylint: disable=too-many-statements,too-many-branches,too
     # get all the contracts as a list from given codebase
     sol_file_list: List[str] = get_sol_file_list(Path(args.codebase), paths_to_ignore_list)
 
-    logger.info(blue("Preparing to mutate files:\n- " + "\n- ".join(sol_file_list)))
+    if not contract_names:
+        logger.info(blue("Preparing to mutate files:\n- " + "\n- ".join(sol_file_list)))
+    else:
+        logger.info(blue("Preparing to mutate contracts:\n- " + "\n- ".join(contract_names)))
 
     # folder where backup files and uncaught mutants are saved
     if output_dir is None:
@@ -240,7 +243,8 @@ def main() -> None:  # pylint: disable=too-many-statements,too-many-branches,too
 
         # perform mutations on {target_contract} in file {file_name}
         # setup placeholder val to signal whether we need to skip if no target_contract is found
-        target_contract = "SLITHER_SKIP_MUTATIONS" if contract_names else ""
+        skip_flag = "SLITHER_SKIP_MUTATIONS"
+        target_contract = skip_flag if contract_names else ""
         try:
             # loop through all contracts in file_name
             for compilation_unit_of_main_file in sl.compilation_units:
@@ -258,8 +262,7 @@ def main() -> None:  # pylint: disable=too-many-statements,too-many-branches,too
                     )
                     continue
 
-                if target_contract == "SLITHER_SKIP_MUTATIONS":
-                    logger.debug(f"Skipping mutations in {filename}")
+                if target_contract == skip_flag:
                     continue
 
                 # TODO: find a more specific way to omit interfaces
@@ -334,6 +337,10 @@ def main() -> None:  # pylint: disable=too-many-statements,too-many-branches,too
         # transfer and delete the backup files
         transfer_and_delete(files_dict)
 
+        if target_contract == skip_flag:
+            logger.debug(f"No target contracts found in {filename}, skipping")
+            continue
+
         # log results for this file
         logger.info(blue(f"Done mutating {target_contract}."))
         if total_mutant_counts[0] > 0:

slither/tools/mutator/mutators/AOR.py

@@ -65,11 +65,13 @@ def _mutate(self) -> Dict:
                             # Get the string
                             start = node.source_mapping.start
                             stop = start + node.source_mapping.length
-                            old_str = self.in_file_str[start:stop]
+                            old_str = node.source_mapping.content
                             line_no = node.source_mapping.lines
                             if not line_no[0] in self.dont_mutate_line:
-                                # Replace the expression with true
-                                new_str = f"{old_str.split(ir.type.value)[0]}{op.value}{old_str.split(ir.type.value)[1]}"
+                                halves = old_str.split(ir.type.value)
+                                if len(halves) != 2:
+                                    continue  # skip if assembly
+                                new_str = f"{halves[0]}{op.value}{halves[1]}"
                                 create_patch_with_line(
                                     result,
                                     self.in_file,

slither/tools/mutator/mutators/ASOR.py

@@ -48,7 +48,7 @@ def _mutate(self) -> Dict:
                             if op != ir.expression:
                                 start = node.source_mapping.start
                                 stop = start + node.source_mapping.length
-                                old_str = self.in_file_str[start:stop]
+                                old_str = node.source_mapping.content
                                 line_no = node.source_mapping.lines
                                 if not line_no[0] in self.dont_mutate_line:
                                     # Replace the expression with true

slither/tools/mutator/mutators/BOR.py

@@ -31,11 +31,14 @@ def _mutate(self) -> Dict:
                             # Get the string
                             start = node.source_mapping.start
                             stop = start + node.source_mapping.length
-                            old_str = self.in_file_str[start:stop]
+                            old_str = node.source_mapping.content
                             line_no = node.source_mapping.lines
                             if not line_no[0] in self.dont_mutate_line:
                                 # Replace the expression with true
-                                new_str = f"{old_str.split(ir.type.value)[0]}{op.value}{old_str.split(ir.type.value)[1]}"
+                                halves = old_str.split(ir.type.value)
+                                if len(halves) != 2:
+                                    continue  # skip if assembly
+                                new_str = f"{halves[0]}{op.value}{halves[1]}"
                                 create_patch_with_line(
                                     result,
                                     self.in_file,

slither/tools/mutator/mutators/CR.py

@@ -23,7 +23,7 @@ def _mutate(self) -> Dict:
                     # Get the string
                     start = node.source_mapping.start
                     stop = start + node.source_mapping.length
-                    old_str = self.in_file_str[start:stop]
+                    old_str = node.source_mapping.content
                     line_no = node.source_mapping.lines
                     if not line_no[0] in self.dont_mutate_line:
                         new_str = "//" + old_str

slither/tools/mutator/mutators/FHR.py

@@ -22,7 +22,7 @@ def _mutate(self) -> Dict:
         for function in self.contract.functions_and_modifiers_declared:
             start = function.source_mapping.start
             stop = start + function.source_mapping.content.find("{")
-            old_str = self.in_file_str[start:stop]
+            old_str = function.source_mapping.content
             line_no = function.source_mapping.lines
             if not line_no[0] in self.dont_mutate_line:
                 for value in function_header_replacements:

slither/tools/mutator/mutators/LIR.py

@@ -36,7 +36,7 @@ def _mutate(self) -> Dict:  # pylint: disable=too-many-branches
                     # Get the string
                     start = variable.source_mapping.start
                     stop = start + variable.source_mapping.length
-                    old_str = self.in_file_str[start:stop]
+                    old_str = variable.source_mapping.content
                     line_no = variable.node_initialization.source_mapping.lines
                     if not line_no[0] in self.dont_mutate_line:
                         for value in literal_replacements:
@@ -67,7 +67,7 @@ def _mutate(self) -> Dict:  # pylint: disable=too-many-branches
                             literal_replacements.append("-1")
                     start = variable.source_mapping.start
                     stop = start + variable.source_mapping.length
-                    old_str = self.in_file_str[start:stop]
+                    old_str = variable.source_mapping.content
                     line_no = variable.source_mapping.lines
                     if not line_no[0] in self.dont_mutate_line:
                         for new_value in literal_replacements:

slither/tools/mutator/mutators/LOR.py

@@ -29,7 +29,7 @@ def _mutate(self) -> Dict:
                             # Get the string
                             start = node.source_mapping.start
                             stop = start + node.source_mapping.length
-                            old_str = self.in_file_str[start:stop]
+                            old_str = node.source_mapping.content
                             line_no = node.source_mapping.lines
                             if not line_no[0] in self.dont_mutate_line:
                                 # Replace the expression with true

slither/tools/mutator/mutators/MIA.py

@@ -17,7 +17,7 @@ def _mutate(self) -> Dict:
                     # Get the string
                     start = node.expression.source_mapping.start
                     stop = start + node.expression.source_mapping.length
-                    old_str = self.in_file_str[start:stop]
+                    old_str = node.source_mapping.content
                     line_no = node.source_mapping.lines
                     if not line_no[0] in self.dont_mutate_line:
                         # Replace the expression with true and false

slither/tools/mutator/mutators/MVIE.py

@@ -24,7 +24,7 @@ def _mutate(self) -> Dict:
                     # Get the string
                     start = variable.source_mapping.start
                     stop = variable.expression.source_mapping.start
-                    old_str = self.in_file_str[start:stop]
+                    old_str = variable.source_mapping.content
                     new_str = old_str[: old_str.find("=")]
                     line_no = variable.node_initialization.source_mapping.lines
                     if not line_no[0] in self.dont_mutate_line:
@@ -44,7 +44,7 @@ def _mutate(self) -> Dict:
                     # Get the string
                     start = variable.source_mapping.start
                     stop = variable.expression.source_mapping.start
-                    old_str = self.in_file_str[start:stop]
+                    old_str = variable.source_mapping.content
                     new_str = old_str[: old_str.find("=")]
                     line_no = variable.source_mapping.lines
                     if not line_no[0] in self.dont_mutate_line:

slither/tools/mutator/mutators/MVIV.py

@@ -24,7 +24,7 @@ def _mutate(self) -> Dict:
                     # Get the string
                     start = variable.source_mapping.start
                     stop = variable.expression.source_mapping.start
-                    old_str = self.in_file_str[start:stop]
+                    old_str = variable.source_mapping.content
                     new_str = old_str[: old_str.find("=")]
                     line_no = variable.node_initialization.source_mapping.lines
                     if not line_no[0] in self.dont_mutate_line:
@@ -43,7 +43,7 @@ def _mutate(self) -> Dict:
                 if variable.initialized and isinstance(variable.expression, Literal):
                     start = variable.source_mapping.start
                     stop = variable.expression.source_mapping.start
-                    old_str = self.in_file_str[start:stop]
+                    old_str = variable.source_mapping.content
                     new_str = old_str[: old_str.find("=")]
                     line_no = variable.source_mapping.lines
                     if not line_no[0] in self.dont_mutate_line:

slither/tools/mutator/mutators/MWA.py

@@ -18,7 +18,7 @@ def _mutate(self) -> Dict:
                     # Get the string
                     start = node.source_mapping.start
                     stop = start + node.source_mapping.length
-                    old_str = self.in_file_str[start:stop]
+                    old_str = node.source_mapping.content
                     line_no = node.source_mapping.lines
                     if not line_no[0] in self.dont_mutate_line:
                         if not isinstance(node.expression, UnaryOperation):

slither/tools/mutator/mutators/ROR.py

@@ -36,11 +36,11 @@ def _mutate(self) -> Dict:
                                 # Get the string
                                 start = ir.expression.source_mapping.start
                                 stop = start + ir.expression.source_mapping.length
-                                old_str = self.in_file_str[start:stop]
+                                old_str = node.source_mapping.content
                                 line_no = node.source_mapping.lines
                                 if not line_no[0] in self.dont_mutate_line:
                                     # Replace the expression with true
-                                    new_str = f"{old_str.split(ir.type.value)[0]} {op.value} {old_str.split(ir.type.value)[1]}"
+                                    new_str = f"{old_str.split(ir.type.value)[0]}{op.value}{old_str.split(ir.type.value)[1]}"
                                     create_patch_with_line(
                                         result,
                                         self.in_file,

slither/tools/mutator/mutators/RR.py

@@ -15,15 +15,21 @@ def _mutate(self) -> Dict:
             for node in function.nodes:
                 if node.type not in (
                     NodeType.ENTRYPOINT,
+                    NodeType.IF,
                     NodeType.ENDIF,
                     NodeType.ENDLOOP,
+                    NodeType.PLACEHOLDER,
                 ):
                     # Get the string
                     start = node.source_mapping.start
                     stop = start + node.source_mapping.length
-                    old_str = self.in_file_str[start:stop]
-                    line_no = node.source_mapping.lines
-                    if not line_no[0] in self.dont_mutate_line:
+                    old_str = node.source_mapping.content
+                    line_no = node.source_mapping.lines[0]
+                    if not line_no in self.dont_mutate_line:
+                        if node.type == NodeType.RETURN and not old_str.lstrip().startswith(
+                            "return"
+                        ):
+                            continue  # skip the return declarations in fn signatures
                         if not old_str.lstrip().startswith("revert"):
                             new_str = "revert()"
                             create_patch_with_line(
@@ -33,6 +39,6 @@ def _mutate(self) -> Dict:
                                 stop,
                                 old_str,
                                 new_str,
-                                line_no[0],
+                                line_no,
                             )
         return result

slither/tools/mutator/mutators/SBR.py

@@ -64,7 +64,7 @@ def _mutate(self) -> Dict:
                     # Get the string
                     start = node.source_mapping.start
                     stop = start + node.source_mapping.length
-                    old_str = self.in_file_str[start:stop]
+                    old_str = node.source_mapping.content
                     line_no = node.source_mapping.lines
                     if not line_no[0] in self.dont_mutate_line:
                         for value in solidity_rules:
@@ -89,7 +89,7 @@ def _mutate(self) -> Dict:
             if node:
                 start = node.source_mapping.start
                 stop = start + node.source_mapping.length
-                old_str = self.in_file_str[start:stop]
+                old_str = node.source_mapping.content
                 line_no = node.source_mapping.lines
                 if not line_no[0] in self.dont_mutate_line:
                     for value in solidity_rules:

slither/tools/mutator/mutators/UOR.py

@@ -29,7 +29,7 @@ def _mutate(self) -> Dict:
                     continue
                 start = node.source_mapping.start
                 stop = start + node.source_mapping.length
-                old_str = self.in_file_str[start:stop]
+                old_str = node.source_mapping.content
                 line_no = node.source_mapping.lines
                 if not line_no[0] in self.dont_mutate_line:
                     if (

slither/tools/mutator/mutators/abstract_mutator.py

@@ -6,6 +6,7 @@
 from slither.formatters.utils.patches import apply_patch, create_diff
 from slither.tools.mutator.utils.testing_generated_mutant import test_patch
 from slither.core.declarations import Contract
+from slither.utils.colors import red
 
 logger = logging.getLogger("Slither-Mutate")
 
@@ -70,13 +71,18 @@ def __init__(  # pylint: disable=too-many-arguments
 
     @abc.abstractmethod
     def _mutate(self) -> Dict:
-        """TODO Documentation"""
+        """Abstract placeholder, will be overwritten by each mutator"""
         return {}
 
     # pylint: disable=too-many-branches
     def mutate(self) -> Tuple[List[int], List[int], List[int]]:
-        # call _mutate function from different mutators
-        (all_patches) = self._mutate()
+        all_patches: Dict = {}
+        # pylint: disable=broad-exception-caught
+        try:
+            # call _mutate function from different mutators
+            (all_patches) = self._mutate()
+        except Exception as e:
+            logger.error(red("%s mutator failed in %s: %s"), self.NAME, self.contract.name, str(e))
         if "patches" not in all_patches:
             logger.debug("No patches found by %s", self.NAME)
             return [0, 0, 0], [0, 0, 0], self.dont_mutate_line

slither/tools/mutator/utils/testing_generated_mutant.py

@@ -109,9 +109,7 @@ def test_patch(  # pylint: disable=too-many-arguments
 
             create_mutant_file(output_folder, file, generator_name)
             logger.info(
-                red(
-                    f"[{generator_name}] Line {patch['line_number']}: '{patch['old_string']}' ==> '{patch['new_string']}' --> UNCAUGHT"
-                )
+                f"[{generator_name}] Line {patch['line_number']}: '{patch['old_string']}' ==> '{patch['new_string']}' --> UNCAUGHT"
             )
             reset_file(file)