prepare_report.py: Don't use --metadata option with compiler versions that do not support it

- Before 0.4.3 the option was unavailable but ignored.
- Between 0.4.3 and 0.4.6 an attempt to use that option causes an error.

Author: cameel

scripts/bytecodecompare/prepare_report.py

@@ -146,6 +146,7 @@ def prepare_compiler_input(  # pylint: disable=too-many-arguments
     force_no_optimize_yul: bool,
     interface: CompilerInterface,
     smt_use: SMTUse,
+    metadata_option_supported: bool,
 ) -> Tuple[List[str], str]:
 
     if interface == CompilerInterface.STANDARD_JSON:
@@ -168,7 +169,9 @@ def prepare_compiler_input(  # pylint: disable=too-many-arguments
     else:
         assert interface == CompilerInterface.CLI
 
-        compiler_options = [str(source_file_name), '--bin', '--metadata']
+        compiler_options = [str(source_file_name), '--bin']
+        if metadata_option_supported:
+            compiler_options.append('--metadata')
         if optimize:
             compiler_options.append('--optimize')
         elif force_no_optimize_yul:
@@ -182,13 +185,37 @@ def prepare_compiler_input(  # pylint: disable=too-many-arguments
     return (command_line, compiler_input)
 
 
+def detect_metadata_cli_option_support(compiler_path: Path):
+    process = subprocess.run(
+        [str(compiler_path), '--metadata', '-'],
+        input="contract C {}",
+        encoding='utf8',
+        capture_output=True,
+        check=False,
+    )
+
+    negative_response = "unrecognised option '--metadata'".strip()
+    if (process.returncode == 0) != (process.stderr != negative_response):
+        # If the error is other than expected or there's an error message but no error, don't try
+        # to guess. Just fail.
+        print(
+            f"Compiler exit code: {process.returncode}\n"
+            f"Compiler output:\n{process.stderr}\n",
+            file=sys.stderr
+        )
+        raise Exception("Failed to determine if the compiler supports the --metadata option.")
+
+    return process.returncode == 0
+
+
 def run_compiler(  # pylint: disable=too-many-arguments
     compiler_path: Path,
     source_file_name: Path,
     optimize: bool,
     force_no_optimize_yul: bool,
     interface: CompilerInterface,
     smt_use: SMTUse,
+    metadata_option_supported: bool,
     tmp_dir: Path,
 ) -> FileReport:
 
@@ -200,6 +227,7 @@ def run_compiler(  # pylint: disable=too-many-arguments
             force_no_optimize_yul,
             interface,
             smt_use,
+            metadata_option_supported,
         )
 
         process = subprocess.run(
@@ -222,6 +250,7 @@ def run_compiler(  # pylint: disable=too-many-arguments
             force_no_optimize_yul,
             interface,
             smt_use,
+            metadata_option_supported,
         )
 
         # Create a copy that we can use directly with the CLI interface
@@ -249,6 +278,8 @@ def generate_report(
     smt_use: SMTUse,
     force_no_optimize_yul: bool
 ):
+    metadata_option_supported = detect_metadata_cli_option_support(compiler_path)
+
     with open('report.txt', mode='w', encoding='utf8', newline='\n') as report_file:
         for optimize in [False, True]:
             with TemporaryDirectory(prefix='prepare_report-') as tmp_dir:
@@ -261,6 +292,7 @@ def generate_report(
                             force_no_optimize_yul,
                             interface,
                             smt_use,
+                            metadata_option_supported,
                             Path(tmp_dir),
                         )
                         report_file.write(report.format_report())

test/scripts/test_bytecodecompare_prepare_report.py

@@ -176,6 +176,7 @@ def test_prepare_compiler_input_should_work_with_standard_json_interface(self):
             force_no_optimize_yul=False,
             interface=CompilerInterface.STANDARD_JSON,
             smt_use=SMTUse.DISABLE,
+            metadata_option_supported=True,
         )
 
         self.assertEqual(command_line, ['solc', '--standard-json'])
@@ -189,6 +190,7 @@ def test_prepare_compiler_input_should_work_with_cli_interface(self):
             force_no_optimize_yul=False,
             interface=CompilerInterface.CLI,
             smt_use=SMTUse.DISABLE,
+            metadata_option_supported=True,
         )
 
         self.assertEqual(
@@ -223,6 +225,7 @@ def test_prepare_compiler_input_for_json_preserves_newlines(self):
             force_no_optimize_yul=False,
             interface=CompilerInterface.STANDARD_JSON,
             smt_use=SMTUse.DISABLE,
+            metadata_option_supported=True,
         )
 
         self.assertEqual(command_line, ['solc', '--standard-json'])
@@ -236,6 +239,7 @@ def test_prepare_compiler_input_for_cli_preserves_newlines(self):
             force_no_optimize_yul=True,
             interface=CompilerInterface.CLI,
             smt_use=SMTUse.DISABLE,
+            metadata_option_supported=True,
         )
 
         self.assertEqual(compiler_input, SMT_CONTRACT_WITH_MIXED_NEWLINES_SOL_CODE)
@@ -248,6 +252,7 @@ def test_prepare_compiler_input_for_cli_should_handle_force_no_optimize_yul_flag
             force_no_optimize_yul=True,
             interface=CompilerInterface.CLI,
             smt_use=SMTUse.DISABLE,
+            metadata_option_supported=True,
         )
 
         self.assertEqual(
@@ -256,6 +261,23 @@ def test_prepare_compiler_input_for_cli_should_handle_force_no_optimize_yul_flag
         )
         self.assertEqual(compiler_input, SMT_SMOKE_TEST_SOL_CODE)
 
+    def test_prepare_compiler_input_for_cli_should_not_use_metadata_option_if_not_supported(self):
+        (command_line, compiler_input) = prepare_compiler_input(
+            Path('solc'),
+            SMT_SMOKE_TEST_SOL_PATH,
+            optimize=True,
+            force_no_optimize_yul=False,
+            interface=CompilerInterface.CLI,
+            smt_use=SMTUse.PRESERVE,
+            metadata_option_supported=False,
+        )
+
+        self.assertEqual(
+            command_line,
+            ['solc', str(SMT_SMOKE_TEST_SOL_PATH), '--bin', '--optimize'],
+        )
+        self.assertEqual(compiler_input, SMT_SMOKE_TEST_SOL_CODE)
+
 
 class TestParseStandardJSONOutput(PrepareReportTestBase):
     def test_parse_standard_json_output(self):