cerc-io/solidity
16
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

prepare_report.py: Print some statistics about contracts and errors

Browse Source
This commit is contained in:
Kamil Śliwak 2020-12-22 04:10:58 +01:00
parent 4576b1ec89
commit 67fe5fb145
2 changed files with 122 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

104
scripts/bytecodecompare/prepare_report.py
View File

@ -83,6 +83,33 @@ class FileReport:
return '.' return '.'
@dataclass
class Statistics:
file_count: int = 0
contract_count: int = 0
error_count: int = 0
missing_bytecode_count: int = 0
missing_metadata_count: int = 0
def aggregate(self, report: FileReport):
contract_reports = report.contract_reports if report.contract_reports is not None else []
self.file_count += 1
self.contract_count += len(contract_reports)
self.error_count += (1 if report.contract_reports is None else 0)
self.missing_bytecode_count += sum(1 for c in contract_reports if c.bytecode is None)
self.missing_metadata_count += sum(1 for c in contract_reports if c.metadata is None)
def __str__(self) -> str:
return "test cases: {}, contracts: {}, errors: {}, missing bytecode: {}, missing metadata: {}".format(
self.file_count,
str(self.contract_count) + ('+' if self.error_count > 0 else ''),
self.error_count,
self.missing_bytecode_count,
self.missing_metadata_count,
)
def load_source(path: Union[Path, str], smt_use: SMTUse) -> str: def load_source(path: Union[Path, str], smt_use: SMTUse) -> str:
# NOTE: newline='' disables newline conversion. # NOTE: newline='' disables newline conversion.
# We want the file exactly as is because changing even a single byte in the source affects metadata. # We want the file exactly as is because changing even a single byte in the source affects metadata.
@ -292,7 +319,7 @@ def run_compiler( # pylint: disable=too-many-arguments
return parse_cli_output(Path(source_file_name), process.stdout) return parse_cli_output(Path(source_file_name), process.stdout)
def generate_report( # pylint: disable=too-many-arguments def generate_report( # pylint: disable=too-many-arguments,too-many-locals
source_file_names: List[str], source_file_names: List[str],
compiler_path: Path, compiler_path: Path,
interface: CompilerInterface, interface: CompilerInterface,
@ -302,42 +329,49 @@ def generate_report( # pylint: disable=too-many-arguments
verbose: bool, verbose: bool,
exit_on_error: bool, exit_on_error: bool,
): ):
statistics = Statistics()
metadata_option_supported = detect_metadata_cli_option_support(compiler_path) metadata_option_supported = detect_metadata_cli_option_support(compiler_path)
with open(report_file_path, mode='w', encoding='utf8', newline='\n') as report_file: try:
for optimize in [False, True]: with open(report_file_path, mode='w', encoding='utf8', newline='\n') as report_file:
with TemporaryDirectory(prefix='prepare_report-') as tmp_dir: for optimize in [False, True]:
for source_file_name in sorted(source_file_names): with TemporaryDirectory(prefix='prepare_report-') as tmp_dir:
try: for source_file_name in sorted(source_file_names):
report = run_compiler( try:
compiler_path, report = run_compiler(
Path(source_file_name), compiler_path,
optimize, Path(source_file_name),
force_no_optimize_yul, optimize,
interface, force_no_optimize_yul,
smt_use, interface,
metadata_option_supported, smt_use,
Path(tmp_dir), metadata_option_supported,
exit_on_error, Path(tmp_dir),
) exit_on_error,
print(report.format_summary(verbose), end=('\n' if verbose else ''), flush=True) )
report_file.write(report.format_report())
except subprocess.CalledProcessError as exception: statistics.aggregate(report)
print( print(report.format_summary(verbose), end=('\n' if verbose else ''), flush=True)
f"\n\nInterrupted by an exception while processing file "
f"'{source_file_name}' with optimize={optimize}\n\n" report_file.write(report.format_report())
f"COMPILER STDOUT:\n{exception.stdout}\n" except subprocess.CalledProcessError as exception:
f"COMPILER STDERR:\n{exception.stderr}\n", print(
file=sys.stderr f"\n\nInterrupted by an exception while processing file "
) f"'{source_file_name}' with optimize={optimize}\n\n"
raise f"COMPILER STDOUT:\n{exception.stdout}\n"
except: f"COMPILER STDERR:\n{exception.stderr}\n",
print( file=sys.stderr
f"\n\nInterrupted by an exception while processing file " )
f"'{source_file_name}' with optimize={optimize}\n", raise
file=sys.stderr except:
) print(
raise f"\n\nInterrupted by an exception while processing file "
f"'{source_file_name}' with optimize={optimize}\n",
file=sys.stderr
)
raise
finally:
print('\n', statistics, '\n', sep='')
def commandline_parser() -> ArgumentParser: def commandline_parser() -> ArgumentParser:

54
test/scripts/test_bytecodecompare_prepare_report.py
View File

@ -9,7 +9,7 @@ from unittest_helpers import FIXTURE_DIR, LIBSOLIDITY_TEST_DIR, load_fixture, lo
# NOTE: This test file file only works with scripts/ added to PYTHONPATH so pylint can't find the imports # NOTE: This test file file only works with scripts/ added to PYTHONPATH so pylint can't find the imports
# pragma pylint: disable=import-error # pragma pylint: disable=import-error
from bytecodecompare.prepare_report import CompilerInterface, FileReport, ContractReport, SMTUse from bytecodecompare.prepare_report import CompilerInterface, FileReport, ContractReport, SMTUse, Statistics
from bytecodecompare.prepare_report import load_source, parse_cli_output, parse_standard_json_output, prepare_compiler_input from bytecodecompare.prepare_report import load_source, parse_cli_output, parse_standard_json_output, prepare_compiler_input
# pragma pylint: enable=import-error # pragma pylint: enable=import-error
@ -99,6 +99,58 @@ class TestFileReport(PrepareReportTestBase):
self.assertEqual(report.format_report(), '') self.assertEqual(report.format_report(), '')
class TestPrepareReport_Statistics(unittest.TestCase):
def test_initialization(self):
self.assertEqual(Statistics(), Statistics(0, 0, 0, 0, 0))
def test_aggregate_bytecode_and_metadata_present(self):
statistics = Statistics()
statistics.aggregate(FileReport(file_name=Path('F'), contract_reports=[ContractReport('C', 'c.sol', 'B', 'M')]))
self.assertEqual(statistics, Statistics(1, 1, 0, 0, 0))
def test_aggregate_bytecode_missing(self):
statistics = Statistics()
statistics.aggregate(FileReport(file_name=Path('F'), contract_reports=[ContractReport('C', 'c.sol', None, 'M')]))
self.assertEqual(statistics, Statistics(1, 1, 0, 1, 0))
def test_aggregate_metadata_missing(self):
statistics = Statistics()
statistics.aggregate(FileReport(file_name=Path('F'), contract_reports=[ContractReport('C', 'c.sol', 'B', None)]))
self.assertEqual(statistics, Statistics(1, 1, 0, 0, 1))
def test_aggregate_no_contract_reports(self):
statistics = Statistics()
statistics.aggregate(FileReport(file_name=Path('F'), contract_reports=[]))
self.assertEqual(statistics, Statistics(1, 0, 0, 0, 0))
def test_aggregate_missing_contract_report_list(self):
statistics = Statistics()
statistics.aggregate(FileReport(file_name=Path('F'), contract_reports=None))
self.assertEqual(statistics, Statistics(1, 0, 1, 0, 0))
def test_aggregate_multiple_contract_reports(self):
statistics = Statistics()
statistics.aggregate(FileReport(file_name=Path('F'), contract_reports=[
ContractReport('C', 'c.sol', 'B', 'M'),
ContractReport('C', 'c.sol', None, 'M'),
ContractReport('C', 'c.sol', 'B', None),
ContractReport('C', 'c.sol', None, None),
]))
self.assertEqual(statistics, Statistics(1, 4, 0, 2, 2))
def test_str(self):
statistics = Statistics()
statistics.aggregate(FileReport(file_name=Path('F'), contract_reports=[
ContractReport('C', 'c.sol', 'B', 'M'),
ContractReport('C', 'c.sol', None, 'M'),
ContractReport('C', 'c.sol', 'B', None),
ContractReport('C', 'c.sol', None, None),
]))
statistics.aggregate(FileReport(file_name=Path('F'), contract_reports=None))
self.assertEqual(statistics, Statistics(2, 4, 1, 2, 2))
self.assertEqual(str(statistics), "test cases: 2, contracts: 4+, errors: 1, missing bytecode: 2, missing metadata: 2")
class TestLoadSource(PrepareReportTestBase): class TestLoadSource(PrepareReportTestBase):
def test_load_source_should_strip_smt_pragmas_if_requested(self): def test_load_source_should_strip_smt_pragmas_if_requested(self):