diff --git a/test/scripts/fixtures/library_inherited2_sol_json_output.json b/test/scripts/fixtures/library_inherited2_sol_json_output.json new file mode 100644 index 000000000..2e48c685b --- /dev/null +++ b/test/scripts/fixtures/library_inherited2_sol_json_output.json @@ -0,0 +1,63 @@ +{ + "contracts": { + "syntaxTests/scoping/library_inherited2.sol": { + "A": { + "evm": { + "bytecode": { + "object": "6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea264697066735822122086e727f29d40b264a19bbfcad38d64493dca4bab5dbba8c82ffdaae389d2bba064736f6c63430008000033" + } + }, + "metadata": "{\"compiler\":{\"version\":\"0.8.0+commit.c7dfd78e\"},\"language\":\"Solidity\",\"output\":{\"abi\":[],\"devdoc\":{\"kind\":\"dev\",\"methods\":{},\"version\":1},\"userdoc\":{\"kind\":\"user\",\"methods\":{},\"version\":1}},\"settings\":{\"compilationTarget\":{\"syntaxTests/scoping/library_inherited2.sol\":\"A\"},\"evmVersion\":\"istanbul\",\"libraries\":{},\"metadata\":{\"bytecodeHash\":\"ipfs\"},\"optimizer\":{\"enabled\":false,\"runs\":200},\"remappings\":[]},\"sources\":{\"syntaxTests/scoping/library_inherited2.sol\":{\"keccak256\":\"0xd0619f00638fdfea187368965615dbd599fead93dd14b6558725e85ec7011d96\",\"urls\":[\"bzz-raw://ec7af066be66a223f0d25ba3bf9ba6dc103e1a57531a66a38a5ca2b6ce172f55\",\"dweb:/ipfs/QmW1NrqQNhnY1Tkgr3Z9oM8buCGLUJCJVCDTVejJTT5Vet\"]}},\"version\":1}" + }, + "B": { + "evm": { + "bytecode": { + "object": "608060405234801561001057600080fd5b506101cc806100206000396000f3fe608060405234801561001057600080fd5b506004361061002b5760003560e01c80630423a13214610030575b600080fd5b61004a6004803603810190610045919061009d565b610060565b60405161005791906100d5565b60405180910390f35b600061006b82610072565b9050919050565b6000602a8261008191906100f0565b9050919050565b6000813590506100978161017f565b92915050565b6000602082840312156100af57600080fd5b60006100bd84828501610088565b91505092915050565b6100cf81610146565b82525050565b60006020820190506100ea60008301846100c6565b92915050565b60006100fb82610146565b915061010683610146565b9250827fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0382111561013b5761013a610150565b5b828201905092915050565b6000819050919050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601160045260246000fd5b61018881610146565b811461019357600080fd5b5056fea2646970667358221220104c345633313efe410492448844d96d78452c3044ce126b5e041b7fbeaa790064736f6c63430008000033" + } + }, + "metadata": "{\"compiler\":{\"version\":\"0.8.0+commit.c7dfd78e\"},\"language\":\"Solidity\",\"output\":{\"abi\":[{\"inputs\":[{\"internalType\":\"uint256\",\"name\":\"value\",\"type\":\"uint256\"}],\"name\":\"bar\",\"outputs\":[{\"internalType\":\"uint256\",\"name\":\"\",\"type\":\"uint256\"}],\"stateMutability\":\"pure\",\"type\":\"function\"}],\"devdoc\":{\"kind\":\"dev\",\"methods\":{},\"version\":1},\"userdoc\":{\"kind\":\"user\",\"methods\":{},\"version\":1}},\"settings\":{\"compilationTarget\":{\"syntaxTests/scoping/library_inherited2.sol\":\"B\"},\"evmVersion\":\"istanbul\",\"libraries\":{},\"metadata\":{\"bytecodeHash\":\"ipfs\"},\"optimizer\":{\"enabled\":false,\"runs\":200},\"remappings\":[]},\"sources\":{\"syntaxTests/scoping/library_inherited2.sol\":{\"keccak256\":\"0xd0619f00638fdfea187368965615dbd599fead93dd14b6558725e85ec7011d96\",\"urls\":[\"bzz-raw://ec7af066be66a223f0d25ba3bf9ba6dc103e1a57531a66a38a5ca2b6ce172f55\",\"dweb:/ipfs/QmW1NrqQNhnY1Tkgr3Z9oM8buCGLUJCJVCDTVejJTT5Vet\"]}},\"version\":1}" + }, + "Lib": { + "evm": { + "bytecode": { + "object": "60566050600b82828239805160001a6073146043577f4e487b7100000000000000000000000000000000000000000000000000000000600052600060045260246000fd5b30600052607381538281f3fe73000000000000000000000000000000000000000030146080604052600080fdfea26469706673582212207f9515e2263fa71a7984707e2aefd82241fac15c497386ca798b526f14f8ba6664736f6c63430008000033" + } + }, + "metadata": "{\"compiler\":{\"version\":\"0.8.0+commit.c7dfd78e\"},\"language\":\"Solidity\",\"output\":{\"abi\":[],\"devdoc\":{\"kind\":\"dev\",\"methods\":{},\"version\":1},\"userdoc\":{\"kind\":\"user\",\"methods\":{},\"version\":1}},\"settings\":{\"compilationTarget\":{\"syntaxTests/scoping/library_inherited2.sol\":\"Lib\"},\"evmVersion\":\"istanbul\",\"libraries\":{},\"metadata\":{\"bytecodeHash\":\"ipfs\"},\"optimizer\":{\"enabled\":false,\"runs\":200},\"remappings\":[]},\"sources\":{\"syntaxTests/scoping/library_inherited2.sol\":{\"keccak256\":\"0xd0619f00638fdfea187368965615dbd599fead93dd14b6558725e85ec7011d96\",\"urls\":[\"bzz-raw://ec7af066be66a223f0d25ba3bf9ba6dc103e1a57531a66a38a5ca2b6ce172f55\",\"dweb:/ipfs/QmW1NrqQNhnY1Tkgr3Z9oM8buCGLUJCJVCDTVejJTT5Vet\"]}},\"version\":1}" + } + } + }, + "errors": [ + { + "component": "general", + "errorCode": "1878", + "formattedMessage": "Warning: SPDX license identifier not provided in source file. Before publishing, consider adding a comment containing \"SPDX-License-Identifier: \" to each source file. Use \"SPDX-License-Identifier: UNLICENSED\" for non-open-source code. Please see https://spdx.org for more information.\n--> syntaxTests/scoping/library_inherited2.sol\n\n", + "message": "SPDX license identifier not provided in source file. Before publishing, consider adding a comment containing \"SPDX-License-Identifier: \" to each source file. Use \"SPDX-License-Identifier: UNLICENSED\" for non-open-source code. Please see https://spdx.org for more information.", + "severity": "warning", + "sourceLocation": { + "end": -1, + "file": "syntaxTests/scoping/library_inherited2.sol", + "start": -1 + }, + "type": "Warning" + }, + { + "component": "general", + "errorCode": "3420", + "formattedMessage": "Warning: Source file does not specify required compiler version! Consider adding \"pragma solidity ^0.8.0;\"\n--> syntaxTests/scoping/library_inherited2.sol\n\n", + "message": "Source file does not specify required compiler version! Consider adding \"pragma solidity ^0.8.0;\"", + "severity": "warning", + "sourceLocation": { + "end": -1, + "file": "syntaxTests/scoping/library_inherited2.sol", + "start": -1 + }, + "type": "Warning" + } + ], + "sources": { + "syntaxTests/scoping/library_inherited2.sol": { + "id": 0 + } + } +} diff --git a/test/scripts/fixtures/unknown_pragma_sol_json_output.json b/test/scripts/fixtures/unknown_pragma_sol_json_output.json new file mode 100644 index 000000000..94d403984 --- /dev/null +++ b/test/scripts/fixtures/unknown_pragma_sol_json_output.json @@ -0,0 +1,44 @@ +{ + "errors": [ + { + "component": "general", + "errorCode": "1878", + "formattedMessage": "Warning: SPDX license identifier not provided in source file. Before publishing, consider adding a comment containing \"SPDX-License-Identifier: \" to each source file. Use \"SPDX-License-Identifier: UNLICENSED\" for non-open-source code. Please see https://spdx.org for more information.\n--> syntaxTests/pragma/unknown_pragma.sol\n\n", + "message": "SPDX license identifier not provided in source file. Before publishing, consider adding a comment containing \"SPDX-License-Identifier: \" to each source file. Use \"SPDX-License-Identifier: UNLICENSED\" for non-open-source code. Please see https://spdx.org for more information.", + "severity": "warning", + "sourceLocation": { + "end": -1, + "file": "syntaxTests/pragma/unknown_pragma.sol", + "start": -1 + }, + "type": "Warning" + }, + { + "component": "general", + "errorCode": "4936", + "formattedMessage": "SyntaxError: Unknown pragma \"thisdoesntexist\"\n --> syntaxTests/pragma/unknown_pragma.sol:1:1:\n |\n1 | pragma thisdoesntexist;\n | ^^^^^^^^^^^^^^^^^^^^^^^\n\n", + "message": "Unknown pragma \"thisdoesntexist\"", + "severity": "error", + "sourceLocation": { + "end": 23, + "file": "syntaxTests/pragma/unknown_pragma.sol", + "start": 0 + }, + "type": "SyntaxError" + }, + { + "component": "general", + "errorCode": "3420", + "formattedMessage": "Warning: Source file does not specify required compiler version! Consider adding \"pragma solidity ^0.8.0;\"\n--> syntaxTests/pragma/unknown_pragma.sol\n\n", + "message": "Source file does not specify required compiler version! Consider adding \"pragma solidity ^0.8.0;\"", + "severity": "warning", + "sourceLocation": { + "end": -1, + "file": "syntaxTests/pragma/unknown_pragma.sol", + "start": -1 + }, + "type": "Warning" + } + ], + "sources": {} +} diff --git a/test/scripts/test_bytecodecompare_prepare_report.py b/test/scripts/test_bytecodecompare_prepare_report.py new file mode 100644 index 000000000..8ec59c359 --- /dev/null +++ b/test/scripts/test_bytecodecompare_prepare_report.py @@ -0,0 +1,189 @@ +#!/usr/bin/env python + +import json +import unittest +from pathlib import Path +from textwrap import dedent + +from unittest_helpers import LIBSOLIDITY_TEST_DIR, load_fixture, load_libsolidity_test_case + +# NOTE: This test file file only works with scripts/ added to PYTHONPATH so pylint can't find the imports +# pragma pylint: disable=import-error +from bytecodecompare.prepare_report import FileReport, ContractReport +from bytecodecompare.prepare_report import load_source, parse_standard_json_output, prepare_compiler_input +# pragma pylint: enable=import-error + + +SMT_SMOKE_TEST_SOL_PATH = LIBSOLIDITY_TEST_DIR / 'smtCheckerTests/simple/smoke_test.sol' +SMT_SMOKE_TEST_SOL_CODE = load_libsolidity_test_case(SMT_SMOKE_TEST_SOL_PATH) + +SYNTAX_SMOKE_TEST_SOL_PATH = LIBSOLIDITY_TEST_DIR / 'syntaxTests/smoke_test.sol' +SYNTAX_SMOKE_TEST_SOL_CODE = load_libsolidity_test_case(SYNTAX_SMOKE_TEST_SOL_PATH) + +LIBRARY_INHERITED2_SOL_JSON_OUTPUT = load_fixture('library_inherited2_sol_json_output.json') + +UNKNOWN_PRAGMA_SOL_JSON_OUTPUT = load_fixture('unknown_pragma_sol_json_output.json') + + +class TestPrepareReport_FileReport(unittest.TestCase): + def test_format_report(self): + report = FileReport( + file_name=Path('syntaxTests/scoping/library_inherited2.sol'), + contract_reports=[ + ContractReport( + contract_name='A', + file_name=Path('syntaxTests/smoke_test.sol'), + bytecode=None, + metadata=None, + ), + ContractReport( + contract_name='B', + file_name=Path('syntaxTests/smoke_test.sol'), + bytecode=None, + metadata='{"language":"Solidity"}', + ), + ContractReport( + contract_name='Lib', + file_name=Path('syntaxTests/smoke_test.sol'), + bytecode='60566050600b828282398051', + metadata=None, + ), + ] + ) + + expected_output = dedent("""\ + syntaxTests/scoping/library_inherited2.sol:A + syntaxTests/scoping/library_inherited2.sol:A + syntaxTests/scoping/library_inherited2.sol:B + syntaxTests/scoping/library_inherited2.sol:B {"language":"Solidity"} + syntaxTests/scoping/library_inherited2.sol:Lib 60566050600b828282398051 + syntaxTests/scoping/library_inherited2.sol:Lib + """) + + self.assertEqual(report.format_report(), expected_output) + + def test_format_report_should_print_error_if_contract_report_list_is_missing(self): + report = FileReport(file_name=Path('file.sol'), contract_reports=None) + + expected_output = dedent("""\ + file.sol: + """) + + self.assertEqual(report.format_report(), expected_output) + + def test_format_report_should_not_print_anything_if_contract_report_list_is_empty(self): + report = FileReport(file_name=Path('file.sol'), contract_reports=[]) + + self.assertEqual(report.format_report(), '') + + +class TestPrepareReport(unittest.TestCase): + def setUp(self): + self.maxDiff = 10000 + + def test_load_source(self): + self.assertEqual(load_source(SMT_SMOKE_TEST_SOL_PATH), SMT_SMOKE_TEST_SOL_CODE) + + def test_prepare_compiler_input(self): + expected_compiler_input = { + 'language': 'Solidity', + 'sources': { + str(SMT_SMOKE_TEST_SOL_PATH): {'content': SMT_SMOKE_TEST_SOL_CODE}, + }, + 'settings': { + 'optimizer': {'enabled': True}, + 'outputSelection': {'*': {'*': ['evm.bytecode.object', 'metadata']}}, + 'modelChecker': {'engine': 'none'}, + } + } + + (command_line, compiler_input) = prepare_compiler_input( + Path('solc'), + SMT_SMOKE_TEST_SOL_PATH, + optimize=True, + ) + + self.assertEqual(command_line, ['solc', '--standard-json']) + self.assertEqual(json.loads(compiler_input), expected_compiler_input) + + def test_parse_standard_json_output(self): + expected_report = FileReport( + file_name=Path('syntaxTests/scoping/library_inherited2.sol'), + contract_reports=[ + # pragma pylint: disable=line-too-long + ContractReport( + contract_name='A', + file_name=Path('syntaxTests/scoping/library_inherited2.sol'), + bytecode='6080604052348015600f57600080fd5b50603f80601d6000396000f3fe6080604052600080fdfea264697066735822122086e727f29d40b264a19bbfcad38d64493dca4bab5dbba8c82ffdaae389d2bba064736f6c63430008000033', + metadata='{"compiler":{"version":"0.8.0+commit.c7dfd78e"},"language":"Solidity","output":{"abi":[],"devdoc":{"kind":"dev","methods":{},"version":1},"userdoc":{"kind":"user","methods":{},"version":1}},"settings":{"compilationTarget":{"syntaxTests/scoping/library_inherited2.sol":"A"},"evmVersion":"istanbul","libraries":{},"metadata":{"bytecodeHash":"ipfs"},"optimizer":{"enabled":false,"runs":200},"remappings":[]},"sources":{"syntaxTests/scoping/library_inherited2.sol":{"keccak256":"0xd0619f00638fdfea187368965615dbd599fead93dd14b6558725e85ec7011d96","urls":["bzz-raw://ec7af066be66a223f0d25ba3bf9ba6dc103e1a57531a66a38a5ca2b6ce172f55","dweb:/ipfs/QmW1NrqQNhnY1Tkgr3Z9oM8buCGLUJCJVCDTVejJTT5Vet"]}},"version":1}', + ), + ContractReport( + contract_name='B', + file_name=Path('syntaxTests/scoping/library_inherited2.sol'), + bytecode='608060405234801561001057600080fd5b506101cc806100206000396000f3fe608060405234801561001057600080fd5b506004361061002b5760003560e01c80630423a13214610030575b600080fd5b61004a6004803603810190610045919061009d565b610060565b60405161005791906100d5565b60405180910390f35b600061006b82610072565b9050919050565b6000602a8261008191906100f0565b9050919050565b6000813590506100978161017f565b92915050565b6000602082840312156100af57600080fd5b60006100bd84828501610088565b91505092915050565b6100cf81610146565b82525050565b60006020820190506100ea60008301846100c6565b92915050565b60006100fb82610146565b915061010683610146565b9250827fffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffffff0382111561013b5761013a610150565b5b828201905092915050565b6000819050919050565b7f4e487b7100000000000000000000000000000000000000000000000000000000600052601160045260246000fd5b61018881610146565b811461019357600080fd5b5056fea2646970667358221220104c345633313efe410492448844d96d78452c3044ce126b5e041b7fbeaa790064736f6c63430008000033', + metadata='{"compiler":{"version":"0.8.0+commit.c7dfd78e"},"language":"Solidity","output":{"abi":[{"inputs":[{"internalType":"uint256","name":"value","type":"uint256"}],"name":"bar","outputs":[{"internalType":"uint256","name":"","type":"uint256"}],"stateMutability":"pure","type":"function"}],"devdoc":{"kind":"dev","methods":{},"version":1},"userdoc":{"kind":"user","methods":{},"version":1}},"settings":{"compilationTarget":{"syntaxTests/scoping/library_inherited2.sol":"B"},"evmVersion":"istanbul","libraries":{},"metadata":{"bytecodeHash":"ipfs"},"optimizer":{"enabled":false,"runs":200},"remappings":[]},"sources":{"syntaxTests/scoping/library_inherited2.sol":{"keccak256":"0xd0619f00638fdfea187368965615dbd599fead93dd14b6558725e85ec7011d96","urls":["bzz-raw://ec7af066be66a223f0d25ba3bf9ba6dc103e1a57531a66a38a5ca2b6ce172f55","dweb:/ipfs/QmW1NrqQNhnY1Tkgr3Z9oM8buCGLUJCJVCDTVejJTT5Vet"]}},"version":1}', + ), + ContractReport( + contract_name='Lib', + file_name=Path('syntaxTests/scoping/library_inherited2.sol'), + bytecode='60566050600b82828239805160001a6073146043577f4e487b7100000000000000000000000000000000000000000000000000000000600052600060045260246000fd5b30600052607381538281f3fe73000000000000000000000000000000000000000030146080604052600080fdfea26469706673582212207f9515e2263fa71a7984707e2aefd82241fac15c497386ca798b526f14f8ba6664736f6c63430008000033', + metadata='{"compiler":{"version":"0.8.0+commit.c7dfd78e"},"language":"Solidity","output":{"abi":[],"devdoc":{"kind":"dev","methods":{},"version":1},"userdoc":{"kind":"user","methods":{},"version":1}},"settings":{"compilationTarget":{"syntaxTests/scoping/library_inherited2.sol":"Lib"},"evmVersion":"istanbul","libraries":{},"metadata":{"bytecodeHash":"ipfs"},"optimizer":{"enabled":false,"runs":200},"remappings":[]},"sources":{"syntaxTests/scoping/library_inherited2.sol":{"keccak256":"0xd0619f00638fdfea187368965615dbd599fead93dd14b6558725e85ec7011d96","urls":["bzz-raw://ec7af066be66a223f0d25ba3bf9ba6dc103e1a57531a66a38a5ca2b6ce172f55","dweb:/ipfs/QmW1NrqQNhnY1Tkgr3Z9oM8buCGLUJCJVCDTVejJTT5Vet"]}},"version":1}', + ), + # pragma pylint: enable=line-too-long + ] + ) + + report = parse_standard_json_output( + Path('syntaxTests/scoping/library_inherited2.sol'), + LIBRARY_INHERITED2_SOL_JSON_OUTPUT, + ) + self.assertEqual(report, expected_report) + + def test_parse_standard_json_output_should_report_error_on_compiler_errors(self): + expected_report = FileReport(file_name=Path('syntaxTests/pragma/unknown_pragma.sol'), contract_reports=None) + + report = parse_standard_json_output(Path('syntaxTests/pragma/unknown_pragma.sol'), UNKNOWN_PRAGMA_SOL_JSON_OUTPUT) + self.assertEqual(report, expected_report) + + def test_parse_standard_json_output_should_report_error_on_empty_json(self): + expected_report = FileReport(file_name=Path('file.sol'), contract_reports=None) + + self.assertEqual(parse_standard_json_output(Path('file.sol'), '{}'), expected_report) + + def test_parse_standard_json_output_should_report_error_if_contracts_is_empty(self): + compiler_output = '{"contracts": {}}' + + expected_report = FileReport(file_name=Path('contract.sol'), contract_reports=None) + + self.assertEqual(parse_standard_json_output(Path('contract.sol'), compiler_output), expected_report) + + def test_parse_standard_json_output_should_report_error_if_every_file_has_no_contracts(self): + compiler_output = dedent("""\ + { + "contracts": { + "contract1.sol": {}, + "contract2.sol": {} + } + } + """) + + expected_report = FileReport(file_name=Path('contract.sol'), contract_reports=None) + + self.assertEqual(parse_standard_json_output(Path('contract.sol'), compiler_output), expected_report) + + def test_parse_standard_json_output_should_not_report_error_if_there_is_at_least_one_file_with_contracts(self): + compiler_output = dedent("""\ + { + "contracts": { + "contract1.sol": {"A": {}}, + "contract2.sol": {} + } + } + """) + + expected_report = FileReport( + file_name=Path('contract.sol'), + contract_reports=[ContractReport(contract_name='A', file_name=Path('contract1.sol'), bytecode=None, metadata=None)] + ) + + self.assertEqual(parse_standard_json_output(Path('contract.sol'), compiler_output), expected_report) diff --git a/test/scripts/unittest_helpers.py b/test/scripts/unittest_helpers.py new file mode 100644 index 000000000..957e9007a --- /dev/null +++ b/test/scripts/unittest_helpers.py @@ -0,0 +1,15 @@ +from pathlib import Path +from typing import Union + +LIBSOLIDITY_TEST_DIR = Path(__file__).parent.parent / 'libsolidity' +FIXTURE_DIR = Path(__file__).parent / 'fixtures' + +def load_file(path: Union[Path, str]) -> str: + with open(path, 'r', encoding='utf-8') as f: + return f.read() + +def load_fixture(relative_path: Union[Path, str]) -> str: + return load_file(FIXTURE_DIR / relative_path) + +def load_libsolidity_test_case(relative_path: Union[Path, str]) -> str: + return load_file(LIBSOLIDITY_TEST_DIR / relative_path)