Completing work on --use_relpaths_for_solc_json (#8042)

ecb7ec74a1c2e7e1fed01f442ecc4ba7d682cf0f

Author: shellygr

scripts/CertoraProver/certoraBuild.py

@@ -1543,7 +1543,8 @@ def standard_json(self,
                       contract_file_posix_abs: Path,
                       contract_file_as_provided: str,
                       remappings: List[str],
-                      compiler_collector: CompilerCollector) -> Dict[str, Any]:
+                      compiler_collector: CompilerCollector,
+                      compile_wd: Path) -> Dict[str, Any]:
         """
         when calling solc with the standard_json api, instead of passing it flags, we pass it json to request what we
         want -- currently we only use this to retrieve storage layout as this is the only way to do that,
@@ -1554,7 +1555,7 @@ def standard_json(self,
         @param compiler_collector: Solidity or Vyper compiler collector
         @return:
         """
-        solc_json_contract_key = contract_file_as_provided if self.context.use_relpaths_for_solc_json else contract_file_posix_abs
+        solc_json_contract_key = os.path.relpath(contract_file_as_provided, compile_wd) if self.context.use_relpaths_for_solc_json else contract_file_posix_abs
         compiler_collector_lang = compiler_collector.smart_contract_lang
         if compiler_collector_lang == CompilerLangSol() or compiler_collector_lang == CompilerLangYul():
             sources_dict = {str(solc_json_contract_key): {
@@ -1854,7 +1855,7 @@ def collect_for_file(self,
         # Standard JSON
         remappings = [] if isinstance(compiler_collector, CompilerCollectorYul) else self.context.remappings
         input_for_solc = self.standard_json(Path(file_abs_path), build_arg_contract_file, remappings,
-                                            compiler_collector)
+                                            compiler_collector, compile_wd)
         standard_json_input = json.dumps(input_for_solc).encode("utf-8")
         compiler_logger.debug(f"about to run in {compile_wd} the command: {collect_cmd}")
         compiler_logger.debug(f"solc input = {json.dumps(input_for_solc, indent=4)}")
@@ -1910,7 +1911,7 @@ def collect_for_file(self,
             contract_file_abs = str(Util.abs_norm_path(contract_file))
 
             # using os.path.relpath because Path.relative_to cannot go up the directory tree (no ..)
-            contract_file_rel = os.path.relpath(Path(contract_file_abs), Path.cwd())
+            contract_file_rel = os.path.relpath(Path(contract_file_abs), compile_wd)
 
             build_logger.debug(f"available keys: {data['contracts'].keys()}")
             if contract_file_rel in data[CONTRACTS]:
@@ -2009,7 +2010,15 @@ def collect_for_file(self,
             srclist = {"0": file_abs_path}
             report_srclist = {"0": file_abs_path}
 
-        report_source_file = report_srclist[[idx for idx in srclist if Util.abs_posix_path(srclist[idx]) == file_abs_path][0]]
+        # Annoyingly, this is currently used just for... presentation?!
+        # We should clean up report_source_file from all places...
+
+        build_logger.debug(f"Finding report source file, abs path {file_abs_path} relative to {compile_wd}")
+        if self.context.use_relpaths_for_solc_json:
+            orig_report_source_file = Util.abs_posix_path(os.path.relpath(file_abs_path, compile_wd))
+        else:
+            orig_report_source_file = file_abs_path
+        report_source_file = report_srclist[[idx for idx in srclist if Util.abs_posix_path(srclist[idx]) == orig_report_source_file][0]]
 
         # all "contracts in SDC" are the same for every primary contract of the compiled file.
         # we can therefore compute those just once...
@@ -2040,8 +2049,9 @@ def collect_for_file(self,
 
             build_logger.debug(f"finding primary contract address of {file_compiler_path}:{primary_contract} in "
                                f"{contracts_with_chosen_addresses}")
+            path_to_find = os.path.relpath(file_compiler_path, compile_wd) if self.context.use_relpaths_for_solc_json else file_compiler_path
             primary_contract_address = \
-                self.find_contract_address_str(file_compiler_path,
+                self.find_contract_address_str(path_to_find,
                                                primary_contract,
                                                contracts_with_chosen_addresses)
             build_logger.debug(f"Contracts in SDC {sdc_name}: {[contract.name for contract in contracts_in_sdc]}")
@@ -2102,6 +2112,7 @@ def build_report_srclist(self,
                 report_srclist = srclist
         else:
             report_srclist = srclist
+        build_logger.debug(f"Report source list={report_srclist}")
         return report_srclist
 
     def get_bytecode(self,
@@ -3014,7 +3025,7 @@ def handle_erc7201_annotations(self) -> None:
             target_file = self.context.contract_to_file[target.name]
             base_contracts = self.retrieve_base_contracts_list(
                 target_file,
-                Util.abs_posix_path(target_file),
+                target_file if self.context.use_relpaths_for_solc_json else Util.abs_posix_path(target_file),
                 target.name
             )
             extensions: Set[str] = set()
@@ -3090,19 +3101,20 @@ def handle_one_extension(storage_ext: str) -> tuple[Any, str, List[Dict[str, Any
 
             # let's try to find the AST now
             build_file_ast = None
+            orig_path = os.path.relpath(ext_instance.original_file, Path.cwd()) if self.context.use_relpaths_for_solc_json else ext_instance.original_file
             for (k, v) in self.asts.items():
-                if ext_instance.original_file in v:
+                if orig_path in v:
                     build_file_ast = k
                     break
             if build_file_ast is None:
                 raise RuntimeError(f"Couldn't find file for storage extension file {storage_ext}")
 
             contract_def_node = self.get_contract_def_node_ref(
                 build_file_ast,
-                ext_instance.original_file,
+                orig_path,
                 storage_ext
             )
-            def_node = self.asts[build_file_ast][ext_instance.original_file][contract_def_node]
+            def_node = self.asts[build_file_ast][orig_path][contract_def_node]
             nodes = def_node.get("nodes")
             if not isinstance(nodes, list):
                 raise RuntimeError(f"Couldn't find nodes for body of {storage_ext}")