mirror of
https://github.com/pezkuwichain/revive-differential-tests.git
synced 2026-04-22 21:57:58 +00:00
Compare commits
47 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| dde74af22b | |||
| 453fcca4d6 | |||
| 31f69de3cb | |||
| f36a132e05 | |||
| a5a27957d5 | |||
| 680cc5c174 | |||
| 90214f1afe | |||
| b69aab903e | |||
| af1eba0ccf | |||
| 4b641b947b | |||
| 8b1afc36a3 | |||
| 60328cd493 | |||
| eb264fcc7b | |||
| 84b139d3b4 | |||
| d93824d973 | |||
| bec5a7e390 | |||
| 85033cfead | |||
| 76d6a154c1 | |||
| c58551803d | |||
| 185edcfad9 | |||
| 09d56f5177 | |||
| a59e287fa1 | |||
| f2045db0e9 | |||
| 5a11f44673 | |||
| 46aea0890d | |||
| 9b40c9b9e3 | |||
| f67a9bf643 | |||
| 67d767ffde | |||
| f7fbe094ec | |||
| 90b2dd4cfe | |||
| 64d63ef999 | |||
| 757bfbe116 | |||
| 8619e7feb0 | |||
| edba49b301 | |||
| 9980926d40 | |||
| ff993d44a5 | |||
| 8cbb1a9f77 | |||
| 56c2fe8c0c | |||
| 330a773a1c | |||
| f51693cb9f | |||
| 4db7009640 | |||
| 5a36e242ec | |||
| 33329632b5 | |||
| 429f2e92a2 | |||
| 65f41f2038 | |||
| 3ed8a1ca1c | |||
| 2923d675cd |
@@ -99,9 +99,12 @@ jobs:
|
|||||||
- name: Install Geth on Ubuntu
|
- name: Install Geth on Ubuntu
|
||||||
if: matrix.os == 'ubuntu-24.04'
|
if: matrix.os == 'ubuntu-24.04'
|
||||||
run: |
|
run: |
|
||||||
|
sudo add-apt-repository -y ppa:ethereum/ethereum
|
||||||
sudo apt-get update
|
sudo apt-get update
|
||||||
sudo apt-get install -y protobuf-compiler
|
sudo apt-get install -y protobuf-compiler
|
||||||
|
|
||||||
|
sudo apt-get install -y solc
|
||||||
|
|
||||||
# We were facing some issues in CI with the 1.16.* versions of geth, and specifically on
|
# We were facing some issues in CI with the 1.16.* versions of geth, and specifically on
|
||||||
# Ubuntu. Eventually, we found out that the last version of geth that worked in our CI was
|
# Ubuntu. Eventually, we found out that the last version of geth that worked in our CI was
|
||||||
# version 1.15.11. Thus, this is the version that we want to use in CI. The PPA sadly does
|
# version 1.15.11. Thus, this is the version that we want to use in CI. The PPA sadly does
|
||||||
@@ -122,12 +125,22 @@ jobs:
|
|||||||
wget -qO- "$URL" | sudo tar xz -C /usr/local/bin --strip-components=1
|
wget -qO- "$URL" | sudo tar xz -C /usr/local/bin --strip-components=1
|
||||||
geth --version
|
geth --version
|
||||||
|
|
||||||
|
curl -sL https://github.com/paritytech/revive/releases/download/v0.3.0/resolc-x86_64-unknown-linux-musl -o resolc
|
||||||
|
chmod +x resolc
|
||||||
|
sudo mv resolc /usr/local/bin
|
||||||
|
|
||||||
- name: Install Geth on macOS
|
- name: Install Geth on macOS
|
||||||
if: matrix.os == 'macos-14'
|
if: matrix.os == 'macos-14'
|
||||||
run: |
|
run: |
|
||||||
brew tap ethereum/ethereum
|
brew tap ethereum/ethereum
|
||||||
brew install ethereum protobuf
|
brew install ethereum protobuf
|
||||||
|
|
||||||
|
brew install solidity
|
||||||
|
|
||||||
|
curl -sL https://github.com/paritytech/revive/releases/download/v0.3.0/resolc-universal-apple-darwin -o resolc
|
||||||
|
chmod +x resolc
|
||||||
|
sudo mv resolc /usr/local/bin
|
||||||
|
|
||||||
- name: Machete
|
- name: Machete
|
||||||
uses: bnjbvr/cargo-machete@v0.7.1
|
uses: bnjbvr/cargo-machete@v0.7.1
|
||||||
|
|
||||||
@@ -143,5 +156,8 @@ jobs:
|
|||||||
- name: Check eth-rpc version
|
- name: Check eth-rpc version
|
||||||
run: eth-rpc --version
|
run: eth-rpc --version
|
||||||
|
|
||||||
|
- name: Check resolc version
|
||||||
|
run: resolc --version
|
||||||
|
|
||||||
- name: Test cargo workspace
|
- name: Test cargo workspace
|
||||||
run: make test
|
run: make test
|
||||||
|
|||||||
@@ -7,3 +7,7 @@ node_modules
|
|||||||
# We do not want to commit any log files that we produce from running the code locally so this is
|
# We do not want to commit any log files that we produce from running the code locally so this is
|
||||||
# added to the .gitignore file.
|
# added to the .gitignore file.
|
||||||
*.log
|
*.log
|
||||||
|
|
||||||
|
profile.json.gz
|
||||||
|
resolc-compiler-tests
|
||||||
|
workdir
|
||||||
Generated
+769
-24
File diff suppressed because it is too large
Load Diff
+19
-5
@@ -8,7 +8,7 @@ authors = ["Parity Technologies <admin@parity.io>"]
|
|||||||
license = "MIT/Apache-2.0"
|
license = "MIT/Apache-2.0"
|
||||||
edition = "2024"
|
edition = "2024"
|
||||||
repository = "https://github.com/paritytech/revive-differential-testing.git"
|
repository = "https://github.com/paritytech/revive-differential-testing.git"
|
||||||
rust-version = "1.85.0"
|
rust-version = "1.87.0"
|
||||||
|
|
||||||
[workspace.dependencies]
|
[workspace.dependencies]
|
||||||
revive-dt-common = { version = "0.1.0", path = "crates/common" }
|
revive-dt-common = { version = "0.1.0", path = "crates/common" }
|
||||||
@@ -25,28 +25,40 @@ revive-dt-solc-binaries = { version = "0.1.0", path = "crates/solc-binaries" }
|
|||||||
alloy-primitives = "1.2.1"
|
alloy-primitives = "1.2.1"
|
||||||
alloy-sol-types = "1.2.1"
|
alloy-sol-types = "1.2.1"
|
||||||
anyhow = "1.0"
|
anyhow = "1.0"
|
||||||
|
bson = { version = "2.15.0" }
|
||||||
|
cacache = { version = "13.1.0" }
|
||||||
clap = { version = "4", features = ["derive"] }
|
clap = { version = "4", features = ["derive"] }
|
||||||
|
dashmap = { version = "6.1.0" }
|
||||||
|
foundry-compilers-artifacts = { version = "0.18.0" }
|
||||||
futures = { version = "0.3.31" }
|
futures = { version = "0.3.31" }
|
||||||
hex = "0.4.3"
|
hex = "0.4.3"
|
||||||
reqwest = { version = "0.12.15", features = ["blocking", "json"] }
|
regex = "1"
|
||||||
|
moka = "0.12.10"
|
||||||
|
paste = "1.0.15"
|
||||||
|
reqwest = { version = "0.12.15", features = ["json"] }
|
||||||
once_cell = "1.21"
|
once_cell = "1.21"
|
||||||
rayon = { version = "1.10" }
|
|
||||||
semver = { version = "1.0", features = ["serde"] }
|
semver = { version = "1.0", features = ["serde"] }
|
||||||
serde = { version = "1.0", default-features = false, features = ["derive"] }
|
serde = { version = "1.0", default-features = false, features = ["derive"] }
|
||||||
serde_json = { version = "1.0", default-features = false, features = [
|
serde_json = { version = "1.0", default-features = false, features = [
|
||||||
"arbitrary_precision",
|
"arbitrary_precision",
|
||||||
"std",
|
"std",
|
||||||
|
"unbounded_depth",
|
||||||
] }
|
] }
|
||||||
|
serde_with = { version = "3.14.0" }
|
||||||
sha2 = { version = "0.10.9" }
|
sha2 = { version = "0.10.9" }
|
||||||
sp-core = "36.1.0"
|
sp-core = "36.1.0"
|
||||||
sp-runtime = "41.1.0"
|
sp-runtime = "41.1.0"
|
||||||
temp-dir = { version = "0.1.16" }
|
temp-dir = { version = "0.1.16" }
|
||||||
tempfile = "3.3"
|
tempfile = "3.3"
|
||||||
tokio = { version = "1", default-features = false, features = [
|
thiserror = "2"
|
||||||
|
tokio = { version = "1.47.0", default-features = false, features = [
|
||||||
"rt-multi-thread",
|
"rt-multi-thread",
|
||||||
|
"process",
|
||||||
|
"rt",
|
||||||
] }
|
] }
|
||||||
uuid = { version = "1.8", features = ["v4"] }
|
uuid = { version = "1.8", features = ["v4"] }
|
||||||
tracing = "0.1.41"
|
tracing = { version = "0.1.41" }
|
||||||
|
tracing-appender = { version = "0.2.3" }
|
||||||
tracing-subscriber = { version = "0.3.19", default-features = false, features = [
|
tracing-subscriber = { version = "0.3.19", default-features = false, features = [
|
||||||
"fmt",
|
"fmt",
|
||||||
"json",
|
"json",
|
||||||
@@ -81,3 +93,5 @@ features = [
|
|||||||
inherits = "release"
|
inherits = "release"
|
||||||
lto = true
|
lto = true
|
||||||
codegen-units = 1
|
codegen-units = 1
|
||||||
|
|
||||||
|
[workspace.lints.clippy]
|
||||||
|
|||||||
@@ -1,34 +1,210 @@
|
|||||||
# revive-differential-tests
|
<div align="center">
|
||||||
|
<h1><code>Revive Differential Tests</code></h1>
|
||||||
|
|
||||||
The revive differential testing framework allows to define smart contract tests in a declarative manner in order to compile and execute them against different Ethereum-compatible blockchain implmentations. This is useful to:
|
<p>
|
||||||
- Analyze observable differences in contract compilation and execution across different blockchain implementations, including contract storage, account balances, transaction output and emitted events on a per-transaction base.
|
<strong>Differential testing for Ethereum-compatible smart contract stacks</strong>
|
||||||
- Collect and compare benchmark metrics such as code size, gas usage or transaction throughput per seconds (TPS) of different blockchain implementations.
|
</p>
|
||||||
- Ensure reproducible contract builds across multiple compiler implementations or multiple host platforms.
|
</div>
|
||||||
- Implement end-to-end regression tests for Ethereum-compatible smart contract stacks.
|
|
||||||
|
|
||||||
# Declarative test format
|
This project compiles and executes declarative smart-contract tests against multiple platforms, then compares behavior (status, return data, events, and state diffs). Today it supports:
|
||||||
|
|
||||||
For now, the format used to write tests is the [matter-labs era compiler format](https://github.com/matter-labs/era-compiler-tests?tab=readme-ov-file#matter-labs-simplecomplex-format). This allows us to re-use many tests from their corpora.
|
- Geth (EVM reference implementation)
|
||||||
|
- Revive Kitchensink (Substrate-based PolkaVM + `eth-rpc` proxy)
|
||||||
|
|
||||||
# The `retester` utility
|
Use it to:
|
||||||
|
|
||||||
The `retester` helper utilty is used to run the tests. To get an idea of what `retester` can do, please consults its command line help:
|
- Detect observable differences between platforms (execution success, logs, state changes)
|
||||||
|
- Ensure reproducible builds across compilers/hosts
|
||||||
|
- Run end-to-end regression suites
|
||||||
|
|
||||||
```
|
This framework uses the [MatterLabs tests format](https://github.com/matter-labs/era-compiler-tests/tree/main/solidity) for declarative tests which is composed of the following:
|
||||||
cargo run -p revive-dt-core -- --help
|
|
||||||
|
- Metadata files, this is akin to a module of tests in Rust.
|
||||||
|
- Each metadata file contains multiple cases, a case is akin to a Rust test where a module can contain multiple tests.
|
||||||
|
- Each case contains multiple steps and assertions, this is akin to any Rust test that contains multiple statements.
|
||||||
|
|
||||||
|
Metadata files are JSON files, but Solidity files can also be metadata files if they include inline metadata provided as a comment at the top of the contract.
|
||||||
|
|
||||||
|
All of the steps contained within each test case are either:
|
||||||
|
|
||||||
|
- Transactions that need to be submitted and assertions to run on the submitted transactions.
|
||||||
|
- Assertions on the state of the chain (e.g., account balances, storage, etc...)
|
||||||
|
|
||||||
|
All of the transactions submitted by the this tool to the test nodes follow a similar logic to what wallets do. We first use alloy to estimate the transaction fees, then we attach that to the transaction and submit it to the node and then await the transaction receipt.
|
||||||
|
|
||||||
|
This repository contains none of the tests and only contains the testing framework or the test runner. The tests can be found in the [`resolc-compiler-tests`](https://github.com/paritytech/resolc-compiler-tests) repository which is a clone of [MatterLab's test suite](https://github.com/matter-labs/era-compiler-tests) with some modifications and adjustments made to suit our use case.
|
||||||
|
|
||||||
|
## Requirements
|
||||||
|
|
||||||
|
This section describes the required dependencies that this framework requires to run. Compiling this framework is pretty straightforward and no additional dependencies beyond what's specified in the `Cargo.toml` file should be required.
|
||||||
|
|
||||||
|
- Stable Rust
|
||||||
|
- Geth - When doing differential testing against the PVM we submit transactions to a Geth node and to Kitchensink to compare them.
|
||||||
|
- Kitchensink - When doing differential testing against the PVM we submit transactions to a Geth node and to Kitchensink to compare them.
|
||||||
|
- ETH-RPC - All communication with Kitchensink is done through the ETH RPC.
|
||||||
|
- Solc - This is actually a transitive dependency, while this tool doesn't require solc as it downloads the versions that it requires, resolc requires that Solc is installed and available in the path.
|
||||||
|
- Resolc - This is required to compile the contracts to PolkaVM bytecode.
|
||||||
|
|
||||||
|
All of the above need to be installed and available in the path in order for the tool to work.
|
||||||
|
|
||||||
|
## Running The Tool
|
||||||
|
|
||||||
|
This tool is being updated quite frequently. Therefore, it's recommended that you don't install the tool and then run it, but rather that you run it from the root of the directory using `cargo run --release`. The help command of the tool gives you all of the information you need to know about each of the options and flags that the tool offers.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ cargo run --release -- --help
|
||||||
|
Usage: retester [OPTIONS]
|
||||||
|
|
||||||
|
Options:
|
||||||
|
-s, --solc <SOLC>
|
||||||
|
The `solc` version to use if the test didn't specify it explicitly
|
||||||
|
|
||||||
|
[default: 0.8.29]
|
||||||
|
|
||||||
|
--wasm
|
||||||
|
Use the Wasm compiler versions
|
||||||
|
|
||||||
|
-r, --resolc <RESOLC>
|
||||||
|
The path to the `resolc` executable to be tested.
|
||||||
|
|
||||||
|
By default it uses the `resolc` binary found in `$PATH`.
|
||||||
|
|
||||||
|
If `--wasm` is set, this should point to the resolc Wasm ile.
|
||||||
|
|
||||||
|
[default: resolc]
|
||||||
|
|
||||||
|
-c, --corpus <CORPUS>
|
||||||
|
A list of test corpus JSON files to be tested
|
||||||
|
|
||||||
|
-w, --workdir <WORKING_DIRECTORY>
|
||||||
|
A place to store temporary artifacts during test execution.
|
||||||
|
|
||||||
|
Creates a temporary dir if not specified.
|
||||||
|
|
||||||
|
-g, --geth <GETH>
|
||||||
|
The path to the `geth` executable.
|
||||||
|
|
||||||
|
By default it uses `geth` binary found in `$PATH`.
|
||||||
|
|
||||||
|
[default: geth]
|
||||||
|
|
||||||
|
--geth-start-timeout <GETH_START_TIMEOUT>
|
||||||
|
The maximum time in milliseconds to wait for geth to start
|
||||||
|
|
||||||
|
[default: 5000]
|
||||||
|
|
||||||
|
--genesis <GENESIS_FILE>
|
||||||
|
Configure nodes according to this genesis.json file
|
||||||
|
|
||||||
|
[default: genesis.json]
|
||||||
|
|
||||||
|
-a, --account <ACCOUNT>
|
||||||
|
The signing account private key
|
||||||
|
|
||||||
|
[default: 0x4f3edf983ac636a65a842ce7c78d9aa706d3b113bce9c46f30d7d21715b23b1d]
|
||||||
|
|
||||||
|
--private-keys-count <PRIVATE_KEYS_TO_ADD>
|
||||||
|
This argument controls which private keys the nodes should have access to and be added to its wallet signers. With a value of N, private keys (0, N] will be added to the signer set of the node
|
||||||
|
|
||||||
|
[default: 100000]
|
||||||
|
|
||||||
|
-l, --leader <LEADER>
|
||||||
|
The differential testing leader node implementation
|
||||||
|
|
||||||
|
[default: geth]
|
||||||
|
|
||||||
|
Possible values:
|
||||||
|
- geth: The go-ethereum reference full node EVM implementation
|
||||||
|
- kitchensink: The kitchensink runtime provides the PolkaVM (PVM) based node implentation
|
||||||
|
|
||||||
|
-f, --follower <FOLLOWER>
|
||||||
|
The differential testing follower node implementation
|
||||||
|
|
||||||
|
[default: kitchensink]
|
||||||
|
|
||||||
|
Possible values:
|
||||||
|
- geth: The go-ethereum reference full node EVM implementation
|
||||||
|
- kitchensink: The kitchensink runtime provides the PolkaVM (PVM) based node implentation
|
||||||
|
|
||||||
|
--compile-only <COMPILE_ONLY>
|
||||||
|
Only compile against this testing platform (doesn't execute the tests)
|
||||||
|
|
||||||
|
Possible values:
|
||||||
|
- geth: The go-ethereum reference full node EVM implementation
|
||||||
|
- kitchensink: The kitchensink runtime provides the PolkaVM (PVM) based node implentation
|
||||||
|
|
||||||
|
--number-of-nodes <NUMBER_OF_NODES>
|
||||||
|
Determines the amount of nodes that will be spawned for each chain
|
||||||
|
|
||||||
|
[default: 1]
|
||||||
|
|
||||||
|
--number-of-threads <NUMBER_OF_THREADS>
|
||||||
|
Determines the amount of tokio worker threads that will will be used
|
||||||
|
|
||||||
|
[default: 16]
|
||||||
|
|
||||||
|
--number-concurrent-tasks <NUMBER_CONCURRENT_TASKS>
|
||||||
|
Determines the amount of concurrent tasks that will be spawned to run tests. Defaults to 10 x the number of nodes
|
||||||
|
|
||||||
|
-e, --extract-problems
|
||||||
|
Extract problems back to the test corpus
|
||||||
|
|
||||||
|
-k, --kitchensink <KITCHENSINK>
|
||||||
|
The path to the `kitchensink` executable.
|
||||||
|
|
||||||
|
By default it uses `substrate-node` binary found in `$PATH`.
|
||||||
|
|
||||||
|
[default: substrate-node]
|
||||||
|
|
||||||
|
-p, --eth_proxy <ETH_PROXY>
|
||||||
|
The path to the `eth_proxy` executable.
|
||||||
|
|
||||||
|
By default it uses `eth-rpc` binary found in `$PATH`.
|
||||||
|
|
||||||
|
[default: eth-rpc]
|
||||||
|
|
||||||
|
-i, --invalidate-compilation-cache
|
||||||
|
Controls if the compilation cache should be invalidated or not
|
||||||
|
|
||||||
|
-h, --help
|
||||||
|
Print help (see a summary with '-h')
|
||||||
```
|
```
|
||||||
|
|
||||||
For example, to run the [complex Solidity tests](https://github.com/matter-labs/era-compiler-tests/tree/main/solidity/complex), define a corpus structure as follows:
|
To run tests with this tool you need a corpus JSON file that defines the tests included in the corpus. The simplest corpus file looks like the following:
|
||||||
|
|
||||||
```json
|
```json
|
||||||
{
|
{
|
||||||
"name": "ML Solidity Complex",
|
"name": "MatterLabs Solidity Simple, Complex, and Semantic Tests",
|
||||||
"path": "/path/to/era-compiler-tests/solidity/complex"
|
"path": "resolc-compiler-tests/fixtures/solidity"
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
|
||||||
Assuming this to be saved in a `ml-solidity-complex.json` file, the following command will try to compile and execute the tests found inside the corpus:
|
> [!NOTE]
|
||||||
|
> Note that the tests can be found in the [`resolc-compiler-tests`](https://github.com/paritytech/resolc-compiler-tests) repository.
|
||||||
|
|
||||||
|
The above corpus file instructs the tool to look for all of the test cases contained within all of the metadata files of the specified directory.
|
||||||
|
|
||||||
|
The simplest command to run this tool is the following:
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
RUST_LOG=debug cargo r --release -p revive-dt-core -- --corpus ml-solidity-complex.json
|
RUST_LOG="info" cargo run --release -- \
|
||||||
|
--corpus path_to_your_corpus_file.json \
|
||||||
|
--workdir path_to_a_temporary_directory_to_cache_things_in \
|
||||||
|
--number-of-nodes 5 \
|
||||||
|
> logs.log \
|
||||||
|
2> output.log
|
||||||
|
```
|
||||||
|
|
||||||
|
The above command will run the tool executing every one of the tests discovered in the path specified in the corpus file. All of the logs from the execution will be persisted in the `logs.log` file and all of the output of the tool will be persisted to the `output.log` file. If all that you're looking for is to run the tool and check which tests succeeded and failed, then the `output.log` file is what you need to be looking at. However, if you're contributing the to the tool then the `logs.log` file will be very valuable.
|
||||||
|
|
||||||
|
If you only want to run a subset of tests, then you can specify that in your corpus file. The following is an example:
|
||||||
|
|
||||||
|
```json
|
||||||
|
{
|
||||||
|
"name": "MatterLabs Solidity Simple, Complex, and Semantic Tests",
|
||||||
|
"paths": [
|
||||||
|
"path/to/a/single/metadata/file/I/want/to/run.json",
|
||||||
|
"path/to/a/directory/to/find/all/metadata/files/within"
|
||||||
|
]
|
||||||
|
}
|
||||||
```
|
```
|
||||||
|
|||||||
@@ -1,13 +1,24 @@
|
|||||||
{
|
{
|
||||||
"modes": [
|
"modes": [
|
||||||
"Y >=0.8.9",
|
"Y >=0.8.9",
|
||||||
"E",
|
"E"
|
||||||
"I"
|
|
||||||
],
|
],
|
||||||
"cases": [
|
"cases": [
|
||||||
{
|
{
|
||||||
"name": "first",
|
"name": "first",
|
||||||
"inputs": [
|
"inputs": [
|
||||||
|
{
|
||||||
|
"address": "0xdeadbeef00000000000000000000000000000042",
|
||||||
|
"expected_balance": "1233"
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"address": "0xdeadbeef00000000000000000000000000000042",
|
||||||
|
"is_storage_empty": true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"address": "0xdeadbeef00000000000000000000000000000042",
|
||||||
|
"is_storage_empty": false
|
||||||
|
},
|
||||||
{
|
{
|
||||||
"instance": "WBTC_1",
|
"instance": "WBTC_1",
|
||||||
"method": "#deployer",
|
"method": "#deployer",
|
||||||
|
|||||||
@@ -0,0 +1 @@
|
|||||||
|
|
||||||
@@ -10,7 +10,11 @@ rust-version.workspace = true
|
|||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
anyhow = { workspace = true }
|
anyhow = { workspace = true }
|
||||||
futures = { workspace = true }
|
moka = { workspace = true, features = ["sync"] }
|
||||||
tracing = { workspace = true }
|
|
||||||
once_cell = { workspace = true }
|
once_cell = { workspace = true }
|
||||||
tokio = { workspace = true }
|
semver = { workspace = true }
|
||||||
|
serde = { workspace = true }
|
||||||
|
tokio = { workspace = true, default-features = false, features = ["time"] }
|
||||||
|
|
||||||
|
[lints]
|
||||||
|
workspace = true
|
||||||
|
|||||||
@@ -0,0 +1,49 @@
|
|||||||
|
//! This module implements a cached file system allowing for results to be stored in-memory rather
|
||||||
|
//! rather being queried from the file system again.
|
||||||
|
|
||||||
|
use std::fs;
|
||||||
|
use std::io::{Error, Result};
|
||||||
|
use std::path::{Path, PathBuf};
|
||||||
|
|
||||||
|
use moka::sync::Cache;
|
||||||
|
use once_cell::sync::Lazy;
|
||||||
|
|
||||||
|
pub fn read(path: impl AsRef<Path>) -> Result<Vec<u8>> {
|
||||||
|
static READ_CACHE: Lazy<Cache<PathBuf, Vec<u8>>> = Lazy::new(|| Cache::new(10_000));
|
||||||
|
|
||||||
|
let path = path.as_ref().canonicalize()?;
|
||||||
|
match READ_CACHE.get(path.as_path()) {
|
||||||
|
Some(content) => Ok(content),
|
||||||
|
None => {
|
||||||
|
let content = fs::read(path.as_path())?;
|
||||||
|
READ_CACHE.insert(path, content.clone());
|
||||||
|
Ok(content)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn read_to_string(path: impl AsRef<Path>) -> Result<String> {
|
||||||
|
let content = read(path)?;
|
||||||
|
String::from_utf8(content).map_err(|_| {
|
||||||
|
Error::new(
|
||||||
|
std::io::ErrorKind::InvalidData,
|
||||||
|
"The contents of the file are not valid UTF8",
|
||||||
|
)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn read_dir(path: impl AsRef<Path>) -> Result<Box<dyn Iterator<Item = Result<PathBuf>>>> {
|
||||||
|
static READ_DIR_CACHE: Lazy<Cache<PathBuf, Vec<PathBuf>>> = Lazy::new(|| Cache::new(10_000));
|
||||||
|
|
||||||
|
let path = path.as_ref().canonicalize()?;
|
||||||
|
match READ_DIR_CACHE.get(path.as_path()) {
|
||||||
|
Some(entries) => Ok(Box::new(entries.into_iter().map(Ok)) as Box<_>),
|
||||||
|
None => {
|
||||||
|
let entries = fs::read_dir(path.as_path())?
|
||||||
|
.flat_map(|maybe_entry| maybe_entry.map(|entry| entry.path()))
|
||||||
|
.collect();
|
||||||
|
READ_DIR_CACHE.insert(path.clone(), entries);
|
||||||
|
Ok(read_dir(path).unwrap())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,225 +0,0 @@
|
|||||||
//! The alloy crate __requires__ a tokio runtime.
|
|
||||||
//! We contain any async rust right here.
|
|
||||||
|
|
||||||
use std::{any::Any, panic::AssertUnwindSafe, pin::Pin, thread};
|
|
||||||
|
|
||||||
use futures::FutureExt;
|
|
||||||
use once_cell::sync::Lazy;
|
|
||||||
use tokio::{
|
|
||||||
runtime::Builder,
|
|
||||||
sync::{mpsc::UnboundedSender, oneshot},
|
|
||||||
};
|
|
||||||
use tracing::Instrument;
|
|
||||||
|
|
||||||
/// A blocking async executor.
|
|
||||||
///
|
|
||||||
/// This struct exposes the abstraction of a blocking async executor. It is a global and static
|
|
||||||
/// executor which means that it doesn't require for new instances of it to be created, it's a
|
|
||||||
/// singleton and can be accessed by any thread that wants to perform some async computation on the
|
|
||||||
/// blocking executor thread.
|
|
||||||
///
|
|
||||||
/// The API of the blocking executor is created in a way so that it's very natural, simple to use,
|
|
||||||
/// and unbounded to specific tasks or return types. The following is an example of using this
|
|
||||||
/// executor to drive an async computation:
|
|
||||||
///
|
|
||||||
/// ```rust
|
|
||||||
/// use revive_dt_common::concepts::*;
|
|
||||||
///
|
|
||||||
/// fn blocking_function() {
|
|
||||||
/// let result = BlockingExecutor::execute(async move {
|
|
||||||
/// tokio::time::sleep(std::time::Duration::from_secs(1)).await;
|
|
||||||
/// 0xFFu8
|
|
||||||
/// })
|
|
||||||
/// .expect("Computation failed");
|
|
||||||
///
|
|
||||||
/// assert_eq!(result, 0xFF);
|
|
||||||
/// }
|
|
||||||
/// ```
|
|
||||||
///
|
|
||||||
/// Users get to pass in their async tasks without needing to worry about putting them in a [`Box`],
|
|
||||||
/// [`Pin`], needing to perform down-casting, or the internal channel mechanism used by the runtime.
|
|
||||||
/// To the user, it just looks like a function that converts some async code into sync code.
|
|
||||||
///
|
|
||||||
/// This struct also handled panics that occur in the passed futures and converts them into errors
|
|
||||||
/// that can be handled by the user. This is done to allow the executor to be robust.
|
|
||||||
///
|
|
||||||
/// Internally, the executor communicates with the tokio runtime thread through channels which carry
|
|
||||||
/// the [`TaskMessage`] and the results of the execution.
|
|
||||||
pub struct BlockingExecutor;
|
|
||||||
|
|
||||||
impl BlockingExecutor {
|
|
||||||
pub fn execute<R>(future: impl Future<Output = R> + Send + 'static) -> Result<R, anyhow::Error>
|
|
||||||
where
|
|
||||||
R: Send + 'static,
|
|
||||||
{
|
|
||||||
// Note: The blocking executor is a singleton and therefore we store its state in a static
|
|
||||||
// so that it's assigned only once. Additionally, when we set the state of the executor we
|
|
||||||
// spawn the thread where the async runtime runs.
|
|
||||||
static STATE: Lazy<ExecutorState> = Lazy::new(|| {
|
|
||||||
tracing::trace!("Initializing the BlockingExecutor state");
|
|
||||||
|
|
||||||
// All communication with the tokio runtime thread happens over mspc channels where the
|
|
||||||
// producers here are the threads that want to run async tasks and the consumer here is
|
|
||||||
// the tokio runtime thread.
|
|
||||||
let (tx, mut rx) = tokio::sync::mpsc::unbounded_channel::<TaskMessage>();
|
|
||||||
|
|
||||||
thread::spawn(move || {
|
|
||||||
tracing::info!(
|
|
||||||
thread_id = ?std::thread::current().id(),
|
|
||||||
"Starting async runtime thread"
|
|
||||||
);
|
|
||||||
|
|
||||||
let runtime = Builder::new_current_thread()
|
|
||||||
.enable_all()
|
|
||||||
.build()
|
|
||||||
.expect("Failed to create the async runtime");
|
|
||||||
|
|
||||||
runtime.block_on(async move {
|
|
||||||
while let Some(TaskMessage {
|
|
||||||
future: task,
|
|
||||||
response_tx: response_channel,
|
|
||||||
}) = rx.recv().await
|
|
||||||
{
|
|
||||||
tracing::trace!("Received a new future to execute");
|
|
||||||
tokio::spawn(async move {
|
|
||||||
// One of the things that the blocking executor does is that it allows
|
|
||||||
// us to catch panics if they occur. By wrapping the given future in an
|
|
||||||
// AssertUnwindSafe::catch_unwind we are able to catch all panic unwinds
|
|
||||||
// in the given future and convert them into errors.
|
|
||||||
let task = AssertUnwindSafe(task).catch_unwind();
|
|
||||||
|
|
||||||
let result = task.await;
|
|
||||||
let _ = response_channel.send(result);
|
|
||||||
});
|
|
||||||
}
|
|
||||||
})
|
|
||||||
});
|
|
||||||
|
|
||||||
ExecutorState { tx }
|
|
||||||
});
|
|
||||||
|
|
||||||
// We need to perform blocking synchronous communication between the current thread and the
|
|
||||||
// tokio runtime thread with the result of the async computation and the oneshot channels
|
|
||||||
// from tokio allows us to do that. The sender side of the channel will be given to the
|
|
||||||
// tokio runtime thread to send the result when the computation is completed and the receive
|
|
||||||
// side of the channel will be kept with this thread to await for the response of the async
|
|
||||||
// task to come back.
|
|
||||||
let (response_tx, response_rx) =
|
|
||||||
oneshot::channel::<Result<Box<dyn Any + Send>, Box<dyn Any + Send>>>();
|
|
||||||
|
|
||||||
// The tokio runtime thread expects a Future<Output = Box<dyn Any + Send>> + Send to be
|
|
||||||
// sent to it to execute. However, this function has a typed Future<Output = R> + Send and
|
|
||||||
// therefore we need to change the type of the future to fit what the runtime thread expects
|
|
||||||
// in the task message. In doing this conversion, we lose some of the type information since
|
|
||||||
// we're converting R => dyn Any. However, we will perform down-casting on the result to
|
|
||||||
// convert it back into R.
|
|
||||||
let future = Box::pin(
|
|
||||||
async move { Box::new(future.await) as Box<dyn Any + Send> }.in_current_span(),
|
|
||||||
);
|
|
||||||
|
|
||||||
let task = TaskMessage::new(future, response_tx);
|
|
||||||
if let Err(error) = STATE.tx.send(task) {
|
|
||||||
tracing::error!(?error, "Failed to send the task to the blocking executor");
|
|
||||||
anyhow::bail!("Failed to send the task to the blocking executor: {error:?}")
|
|
||||||
}
|
|
||||||
|
|
||||||
let result = match response_rx.blocking_recv() {
|
|
||||||
Ok(result) => result,
|
|
||||||
Err(error) => {
|
|
||||||
tracing::error!(
|
|
||||||
?error,
|
|
||||||
"Failed to get the response from the blocking executor"
|
|
||||||
);
|
|
||||||
anyhow::bail!("Failed to get the response from the blocking executor: {error:?}")
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
let result = match result {
|
|
||||||
Ok(result) => result,
|
|
||||||
Err(error) => {
|
|
||||||
tracing::error!(?error, "An error occurred when running the async task");
|
|
||||||
anyhow::bail!("An error occurred when running the async task: {error:?}")
|
|
||||||
}
|
|
||||||
};
|
|
||||||
|
|
||||||
Ok(*result
|
|
||||||
.downcast::<R>()
|
|
||||||
.expect("An error occurred when downcasting into R. This is a bug"))
|
|
||||||
}
|
|
||||||
}
|
|
||||||
/// Represents the state of the async runtime. This runtime is designed to be a singleton runtime
|
|
||||||
/// which means that in the current running program there's just a single thread that has an async
|
|
||||||
/// runtime.
|
|
||||||
struct ExecutorState {
|
|
||||||
/// The sending side of the task messages channel. This is used by all of the other threads to
|
|
||||||
/// communicate with the async runtime thread.
|
|
||||||
tx: UnboundedSender<TaskMessage>,
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Represents a message that contains an asynchronous task that's to be executed by the runtime
|
|
||||||
/// as well as a way for the runtime to report back on the result of the execution.
|
|
||||||
struct TaskMessage {
|
|
||||||
/// The task that's being requested to run. This is a future that returns an object that does
|
|
||||||
/// implement [`Any`] and [`Send`] to allow it to be sent between the requesting thread and the
|
|
||||||
/// async thread.
|
|
||||||
future: Pin<Box<dyn Future<Output = Box<dyn Any + Send>> + Send>>,
|
|
||||||
|
|
||||||
/// A one shot sender channel where the sender of the task is expecting to hear back on the
|
|
||||||
/// result of the task.
|
|
||||||
response_tx: oneshot::Sender<Result<Box<dyn Any + Send>, Box<dyn Any + Send>>>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl TaskMessage {
|
|
||||||
pub fn new(
|
|
||||||
future: Pin<Box<dyn Future<Output = Box<dyn Any + Send>> + Send>>,
|
|
||||||
response_tx: oneshot::Sender<Result<Box<dyn Any + Send>, Box<dyn Any + Send>>>,
|
|
||||||
) -> Self {
|
|
||||||
Self {
|
|
||||||
future,
|
|
||||||
response_tx,
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod test {
|
|
||||||
use super::*;
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn simple_future_works() {
|
|
||||||
// Act
|
|
||||||
let result = BlockingExecutor::execute(async move {
|
|
||||||
tokio::time::sleep(std::time::Duration::from_secs(1)).await;
|
|
||||||
0xFFu8
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
assert_eq!(result, 0xFFu8);
|
|
||||||
}
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
#[allow(unreachable_code, clippy::unreachable)]
|
|
||||||
fn panics_in_futures_are_caught() {
|
|
||||||
// Act
|
|
||||||
let result = BlockingExecutor::execute(async move {
|
|
||||||
panic!(
|
|
||||||
"If this panic causes, well, a panic, then this is an issue. If it's caught then all good!"
|
|
||||||
);
|
|
||||||
0xFFu8
|
|
||||||
});
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
assert!(result.is_err());
|
|
||||||
|
|
||||||
// Act
|
|
||||||
let result = BlockingExecutor::execute(async move {
|
|
||||||
tokio::time::sleep(std::time::Duration::from_secs(1)).await;
|
|
||||||
0xFFu8
|
|
||||||
})
|
|
||||||
.unwrap();
|
|
||||||
|
|
||||||
// Assert
|
|
||||||
assert_eq!(result, 0xFFu8)
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,3 +0,0 @@
|
|||||||
mod blocking_executor;
|
|
||||||
|
|
||||||
pub use blocking_executor::*;
|
|
||||||
@@ -0,0 +1,31 @@
|
|||||||
|
use std::{
|
||||||
|
fs::{read_dir, remove_dir_all, remove_file},
|
||||||
|
path::Path,
|
||||||
|
};
|
||||||
|
|
||||||
|
use anyhow::{Context, Result};
|
||||||
|
|
||||||
|
/// This method clears the passed directory of all of the files and directories contained within
|
||||||
|
/// without deleting the directory.
|
||||||
|
pub fn clear_directory(path: impl AsRef<Path>) -> Result<()> {
|
||||||
|
for entry in read_dir(path.as_ref())
|
||||||
|
.with_context(|| format!("Failed to read directory: {}", path.as_ref().display()))?
|
||||||
|
{
|
||||||
|
let entry = entry.with_context(|| {
|
||||||
|
format!(
|
||||||
|
"Failed to read an entry in directory: {}",
|
||||||
|
path.as_ref().display()
|
||||||
|
)
|
||||||
|
})?;
|
||||||
|
let entry_path = entry.path();
|
||||||
|
|
||||||
|
if entry_path.is_file() {
|
||||||
|
remove_file(&entry_path)
|
||||||
|
.with_context(|| format!("Failed to remove file: {}", entry_path.display()))?
|
||||||
|
} else {
|
||||||
|
remove_dir_all(&entry_path)
|
||||||
|
.with_context(|| format!("Failed to remove directory: {}", entry_path.display()))?
|
||||||
|
}
|
||||||
|
}
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
mod clear_dir;
|
||||||
|
|
||||||
|
pub use clear_dir::*;
|
||||||
@@ -0,0 +1,3 @@
|
|||||||
|
mod poll;
|
||||||
|
|
||||||
|
pub use poll::*;
|
||||||
@@ -0,0 +1,72 @@
|
|||||||
|
use std::ops::ControlFlow;
|
||||||
|
use std::time::Duration;
|
||||||
|
|
||||||
|
use anyhow::{Context as _, Result, anyhow};
|
||||||
|
|
||||||
|
const EXPONENTIAL_BACKOFF_MAX_WAIT_DURATION: Duration = Duration::from_secs(60);
|
||||||
|
|
||||||
|
/// A function that polls for a fallible future for some period of time and errors if it fails to
|
||||||
|
/// get a result after polling.
|
||||||
|
///
|
||||||
|
/// Given a future that returns a [`Result<ControlFlow<O, ()>>`], this function calls the future
|
||||||
|
/// repeatedly (with some wait period) until the future returns a [`ControlFlow::Break`] or until it
|
||||||
|
/// returns an [`Err`] in which case the function stops polling and returns the error.
|
||||||
|
///
|
||||||
|
/// If the future keeps returning [`ControlFlow::Continue`] and fails to return a [`Break`] within
|
||||||
|
/// the permitted polling duration then this function returns an [`Err`]
|
||||||
|
///
|
||||||
|
/// [`Break`]: ControlFlow::Break
|
||||||
|
/// [`Continue`]: ControlFlow::Continue
|
||||||
|
pub async fn poll<F, O>(
|
||||||
|
polling_duration: Duration,
|
||||||
|
polling_wait_behavior: PollingWaitBehavior,
|
||||||
|
mut future: impl FnMut() -> F,
|
||||||
|
) -> Result<O>
|
||||||
|
where
|
||||||
|
F: Future<Output = Result<ControlFlow<O, ()>>>,
|
||||||
|
{
|
||||||
|
let mut retries = 0;
|
||||||
|
let mut total_wait_duration = Duration::ZERO;
|
||||||
|
let max_allowed_wait_duration = polling_duration;
|
||||||
|
|
||||||
|
loop {
|
||||||
|
if total_wait_duration >= max_allowed_wait_duration {
|
||||||
|
break Err(anyhow!(
|
||||||
|
"Polling failed after {} retries and a total of {:?} of wait time",
|
||||||
|
retries,
|
||||||
|
total_wait_duration
|
||||||
|
));
|
||||||
|
}
|
||||||
|
|
||||||
|
match future()
|
||||||
|
.await
|
||||||
|
.context("Polled future returned an error during polling loop")?
|
||||||
|
{
|
||||||
|
ControlFlow::Continue(()) => {
|
||||||
|
let next_wait_duration = match polling_wait_behavior {
|
||||||
|
PollingWaitBehavior::Constant(duration) => duration,
|
||||||
|
PollingWaitBehavior::ExponentialBackoff => {
|
||||||
|
Duration::from_secs(2u64.pow(retries))
|
||||||
|
.min(EXPONENTIAL_BACKOFF_MAX_WAIT_DURATION)
|
||||||
|
}
|
||||||
|
};
|
||||||
|
let next_wait_duration =
|
||||||
|
next_wait_duration.min(max_allowed_wait_duration - total_wait_duration);
|
||||||
|
total_wait_duration += next_wait_duration;
|
||||||
|
retries += 1;
|
||||||
|
|
||||||
|
tokio::time::sleep(next_wait_duration).await;
|
||||||
|
}
|
||||||
|
ControlFlow::Break(output) => {
|
||||||
|
break Ok(output);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default)]
|
||||||
|
pub enum PollingWaitBehavior {
|
||||||
|
Constant(Duration),
|
||||||
|
#[default]
|
||||||
|
ExponentialBackoff,
|
||||||
|
}
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
/// An iterator that could be either of two iterators.
|
||||||
|
#[derive(Clone, Debug)]
|
||||||
|
pub enum EitherIter<A, B> {
|
||||||
|
A(A),
|
||||||
|
B(B),
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<A, B, T> Iterator for EitherIter<A, B>
|
||||||
|
where
|
||||||
|
A: Iterator<Item = T>,
|
||||||
|
B: Iterator<Item = T>,
|
||||||
|
{
|
||||||
|
type Item = T;
|
||||||
|
|
||||||
|
fn next(&mut self) -> Option<Self::Item> {
|
||||||
|
match self {
|
||||||
|
EitherIter::A(iter) => iter.next(),
|
||||||
|
EitherIter::B(iter) => iter.next(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,4 +1,8 @@
|
|||||||
use std::{borrow::Cow, collections::HashSet, path::PathBuf};
|
use std::{
|
||||||
|
borrow::Cow,
|
||||||
|
collections::HashSet,
|
||||||
|
path::{Path, PathBuf},
|
||||||
|
};
|
||||||
|
|
||||||
/// An iterator that finds files of a certain extension in the provided directory. You can think of
|
/// An iterator that finds files of a certain extension in the provided directory. You can think of
|
||||||
/// this a glob pattern similar to: `${path}/**/*.md`
|
/// this a glob pattern similar to: `${path}/**/*.md`
|
||||||
@@ -15,14 +19,20 @@ pub struct FilesWithExtensionIterator {
|
|||||||
/// this vector then they will be returned when the [`Iterator::next`] method is called. If not
|
/// this vector then they will be returned when the [`Iterator::next`] method is called. If not
|
||||||
/// then we visit one of the next directories to visit.
|
/// then we visit one of the next directories to visit.
|
||||||
files_matching_allowed_extensions: Vec<PathBuf>,
|
files_matching_allowed_extensions: Vec<PathBuf>,
|
||||||
|
|
||||||
|
/// This option controls if the the cached file system should be used or not. This could be
|
||||||
|
/// better for certain cases where the entries in the directories do not change and therefore
|
||||||
|
/// caching can be used.
|
||||||
|
use_cached_fs: bool,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl FilesWithExtensionIterator {
|
impl FilesWithExtensionIterator {
|
||||||
pub fn new(root_directory: PathBuf) -> Self {
|
pub fn new(root_directory: impl AsRef<Path>) -> Self {
|
||||||
Self {
|
Self {
|
||||||
allowed_extensions: Default::default(),
|
allowed_extensions: Default::default(),
|
||||||
directories_to_search: vec![root_directory],
|
directories_to_search: vec![root_directory.as_ref().to_path_buf()],
|
||||||
files_matching_allowed_extensions: Default::default(),
|
files_matching_allowed_extensions: Default::default(),
|
||||||
|
use_cached_fs: Default::default(),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -33,6 +43,11 @@ impl FilesWithExtensionIterator {
|
|||||||
self.allowed_extensions.insert(allowed_extension.into());
|
self.allowed_extensions.insert(allowed_extension.into());
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn with_use_cached_fs(mut self, use_cached_fs: bool) -> Self {
|
||||||
|
self.use_cached_fs = use_cached_fs;
|
||||||
|
self
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Iterator for FilesWithExtensionIterator {
|
impl Iterator for FilesWithExtensionIterator {
|
||||||
@@ -45,16 +60,19 @@ impl Iterator for FilesWithExtensionIterator {
|
|||||||
|
|
||||||
let directory_to_search = self.directories_to_search.pop()?;
|
let directory_to_search = self.directories_to_search.pop()?;
|
||||||
|
|
||||||
// Read all of the entries in the directory. If we failed to read this dir's entires then we
|
let iterator = if self.use_cached_fs {
|
||||||
// elect to just ignore it and look in the next directory, we do that by calling the next
|
let Ok(dir_entries) = crate::cached_fs::read_dir(directory_to_search.as_path()) else {
|
||||||
// method again on the iterator, which is an intentional decision that we made here instead
|
return self.next();
|
||||||
// of panicking.
|
};
|
||||||
let Ok(dir_entries) = std::fs::read_dir(directory_to_search) else {
|
Box::new(dir_entries) as Box<dyn Iterator<Item = std::io::Result<PathBuf>>>
|
||||||
return self.next();
|
} else {
|
||||||
|
let Ok(dir_entries) = std::fs::read_dir(directory_to_search) else {
|
||||||
|
return self.next();
|
||||||
|
};
|
||||||
|
Box::new(dir_entries.map(|maybe_entry| maybe_entry.map(|entry| entry.path()))) as Box<_>
|
||||||
};
|
};
|
||||||
|
|
||||||
for entry in dir_entries.flatten() {
|
for entry_path in iterator.flatten() {
|
||||||
let entry_path = entry.path();
|
|
||||||
if entry_path.is_dir() {
|
if entry_path.is_dir() {
|
||||||
self.directories_to_search.push(entry_path)
|
self.directories_to_search.push(entry_path)
|
||||||
} else if entry_path.is_file()
|
} else if entry_path.is_file()
|
||||||
|
|||||||
@@ -1,3 +1,5 @@
|
|||||||
|
mod either_iter;
|
||||||
mod files_with_extension_iterator;
|
mod files_with_extension_iterator;
|
||||||
|
|
||||||
|
pub use either_iter::*;
|
||||||
pub use files_with_extension_iterator::*;
|
pub use files_with_extension_iterator::*;
|
||||||
|
|||||||
@@ -1,6 +1,9 @@
|
|||||||
//! This crate provides common concepts, functionality, types, macros, and more that other crates in
|
//! This crate provides common concepts, functionality, types, macros, and more that other crates in
|
||||||
//! the workspace can benefit from.
|
//! the workspace can benefit from.
|
||||||
|
|
||||||
pub mod concepts;
|
pub mod cached_fs;
|
||||||
|
pub mod fs;
|
||||||
|
pub mod futures;
|
||||||
pub mod iterators;
|
pub mod iterators;
|
||||||
pub mod macros;
|
pub mod macros;
|
||||||
|
pub mod types;
|
||||||
|
|||||||
@@ -1,3 +1,25 @@
|
|||||||
|
#[macro_export]
|
||||||
|
macro_rules! impl_for_wrapper {
|
||||||
|
(Display, $ident: ident) => {
|
||||||
|
#[automatically_derived]
|
||||||
|
impl std::fmt::Display for $ident {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
std::fmt::Display::fmt(&self.0, f)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
(FromStr, $ident: ident) => {
|
||||||
|
#[automatically_derived]
|
||||||
|
impl std::str::FromStr for $ident {
|
||||||
|
type Err = anyhow::Error;
|
||||||
|
|
||||||
|
fn from_str(s: &str) -> anyhow::Result<Self> {
|
||||||
|
s.parse().map(Self).map_err(Into::into)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
/// Defines wrappers around types.
|
/// Defines wrappers around types.
|
||||||
///
|
///
|
||||||
/// For example, the macro invocation seen below:
|
/// For example, the macro invocation seen below:
|
||||||
@@ -42,7 +64,13 @@
|
|||||||
macro_rules! define_wrapper_type {
|
macro_rules! define_wrapper_type {
|
||||||
(
|
(
|
||||||
$(#[$meta: meta])*
|
$(#[$meta: meta])*
|
||||||
$vis:vis struct $ident: ident($ty: ty);
|
$vis:vis struct $ident: ident($ty: ty)
|
||||||
|
|
||||||
|
$(
|
||||||
|
impl $($trait_ident: ident),*
|
||||||
|
)?
|
||||||
|
|
||||||
|
;
|
||||||
) => {
|
) => {
|
||||||
$(#[$meta])*
|
$(#[$meta])*
|
||||||
$vis struct $ident($ty);
|
$vis struct $ident($ty);
|
||||||
@@ -98,9 +126,15 @@ macro_rules! define_wrapper_type {
|
|||||||
value.0
|
value.0
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
$(
|
||||||
|
$(
|
||||||
|
$crate::macros::impl_for_wrapper!($trait_ident, $ident);
|
||||||
|
)*
|
||||||
|
)?
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Technically not needed but this allows for the macro to be found in the `macros` module of the
|
/// Technically not needed but this allows for the macro to be found in the `macros` module of the
|
||||||
/// crate in addition to being found in the root of the crate.
|
/// crate in addition to being found in the root of the crate.
|
||||||
pub use define_wrapper_type;
|
pub use {define_wrapper_type, impl_for_wrapper};
|
||||||
|
|||||||
@@ -0,0 +1,5 @@
|
|||||||
|
mod mode;
|
||||||
|
mod version_or_requirement;
|
||||||
|
|
||||||
|
pub use mode::*;
|
||||||
|
pub use version_or_requirement::*;
|
||||||
@@ -0,0 +1,173 @@
|
|||||||
|
use crate::types::VersionOrRequirement;
|
||||||
|
use semver::Version;
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
use std::fmt::Display;
|
||||||
|
use std::str::FromStr;
|
||||||
|
use std::sync::LazyLock;
|
||||||
|
|
||||||
|
/// This represents a mode that a given test should be run with, if possible.
|
||||||
|
///
|
||||||
|
/// We obtain this by taking a [`ParsedMode`], which may be looser or more strict
|
||||||
|
/// in its requirements, and then expanding it out into a list of [`Mode`]s.
|
||||||
|
///
|
||||||
|
/// Use [`ParsedMode::to_test_modes()`] to do this.
|
||||||
|
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
|
||||||
|
pub struct Mode {
|
||||||
|
pub pipeline: ModePipeline,
|
||||||
|
pub optimize_setting: ModeOptimizerSetting,
|
||||||
|
pub version: Option<semver::VersionReq>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Display for Mode {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
self.pipeline.fmt(f)?;
|
||||||
|
f.write_str(" ")?;
|
||||||
|
self.optimize_setting.fmt(f)?;
|
||||||
|
|
||||||
|
if let Some(version) = &self.version {
|
||||||
|
f.write_str(" ")?;
|
||||||
|
version.fmt(f)?;
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Mode {
|
||||||
|
/// Return all of the available mode combinations.
|
||||||
|
pub fn all() -> impl Iterator<Item = &'static Mode> {
|
||||||
|
static ALL_MODES: LazyLock<Vec<Mode>> = LazyLock::new(|| {
|
||||||
|
ModePipeline::test_cases()
|
||||||
|
.flat_map(|pipeline| {
|
||||||
|
ModeOptimizerSetting::test_cases().map(move |optimize_setting| Mode {
|
||||||
|
pipeline,
|
||||||
|
optimize_setting,
|
||||||
|
version: None,
|
||||||
|
})
|
||||||
|
})
|
||||||
|
.collect::<Vec<_>>()
|
||||||
|
});
|
||||||
|
ALL_MODES.iter()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Resolves the [`Mode`]'s solidity version requirement into a [`VersionOrRequirement`] if
|
||||||
|
/// the requirement is present on the object. Otherwise, the passed default version is used.
|
||||||
|
pub fn compiler_version_to_use(&self, default: Version) -> VersionOrRequirement {
|
||||||
|
match self.version {
|
||||||
|
Some(ref requirement) => requirement.clone().into(),
|
||||||
|
None => default.into(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// What do we want the compiler to do?
|
||||||
|
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
|
||||||
|
pub enum ModePipeline {
|
||||||
|
/// Compile Solidity code via Yul IR
|
||||||
|
ViaYulIR,
|
||||||
|
/// Compile Solidity direct to assembly
|
||||||
|
ViaEVMAssembly,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl FromStr for ModePipeline {
|
||||||
|
type Err = anyhow::Error;
|
||||||
|
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
||||||
|
match s {
|
||||||
|
// via Yul IR
|
||||||
|
"Y" => Ok(ModePipeline::ViaYulIR),
|
||||||
|
// Don't go via Yul IR
|
||||||
|
"E" => Ok(ModePipeline::ViaEVMAssembly),
|
||||||
|
// Anything else that we see isn't a mode at all
|
||||||
|
_ => Err(anyhow::anyhow!(
|
||||||
|
"Unsupported pipeline '{s}': expected 'Y' or 'E'"
|
||||||
|
)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Display for ModePipeline {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
match self {
|
||||||
|
ModePipeline::ViaYulIR => f.write_str("Y"),
|
||||||
|
ModePipeline::ViaEVMAssembly => f.write_str("E"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ModePipeline {
|
||||||
|
/// Should we go via Yul IR?
|
||||||
|
pub fn via_yul_ir(&self) -> bool {
|
||||||
|
matches!(self, ModePipeline::ViaYulIR)
|
||||||
|
}
|
||||||
|
|
||||||
|
/// An iterator over the available pipelines that we'd like to test,
|
||||||
|
/// when an explicit pipeline was not specified.
|
||||||
|
pub fn test_cases() -> impl Iterator<Item = ModePipeline> + Clone {
|
||||||
|
[ModePipeline::ViaYulIR, ModePipeline::ViaEVMAssembly].into_iter()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Copy, Debug, Eq, PartialEq, Ord, PartialOrd, Hash, Serialize, Deserialize)]
|
||||||
|
pub enum ModeOptimizerSetting {
|
||||||
|
/// 0 / -: Don't apply any optimizations
|
||||||
|
M0,
|
||||||
|
/// 1: Apply less than default optimizations
|
||||||
|
M1,
|
||||||
|
/// 2: Apply the default optimizations
|
||||||
|
M2,
|
||||||
|
/// 3 / +: Apply aggressive optimizations
|
||||||
|
M3,
|
||||||
|
/// s: Optimize for size
|
||||||
|
Ms,
|
||||||
|
/// z: Aggressively optimize for size
|
||||||
|
Mz,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl FromStr for ModeOptimizerSetting {
|
||||||
|
type Err = anyhow::Error;
|
||||||
|
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
||||||
|
match s {
|
||||||
|
"M0" => Ok(ModeOptimizerSetting::M0),
|
||||||
|
"M1" => Ok(ModeOptimizerSetting::M1),
|
||||||
|
"M2" => Ok(ModeOptimizerSetting::M2),
|
||||||
|
"M3" => Ok(ModeOptimizerSetting::M3),
|
||||||
|
"Ms" => Ok(ModeOptimizerSetting::Ms),
|
||||||
|
"Mz" => Ok(ModeOptimizerSetting::Mz),
|
||||||
|
_ => Err(anyhow::anyhow!(
|
||||||
|
"Unsupported optimizer setting '{s}': expected 'M0', 'M1', 'M2', 'M3', 'Ms' or 'Mz'"
|
||||||
|
)),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Display for ModeOptimizerSetting {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
match self {
|
||||||
|
ModeOptimizerSetting::M0 => f.write_str("M0"),
|
||||||
|
ModeOptimizerSetting::M1 => f.write_str("M1"),
|
||||||
|
ModeOptimizerSetting::M2 => f.write_str("M2"),
|
||||||
|
ModeOptimizerSetting::M3 => f.write_str("M3"),
|
||||||
|
ModeOptimizerSetting::Ms => f.write_str("Ms"),
|
||||||
|
ModeOptimizerSetting::Mz => f.write_str("Mz"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ModeOptimizerSetting {
|
||||||
|
/// An iterator over the available optimizer settings that we'd like to test,
|
||||||
|
/// when an explicit optimizer setting was not specified.
|
||||||
|
pub fn test_cases() -> impl Iterator<Item = ModeOptimizerSetting> + Clone {
|
||||||
|
[
|
||||||
|
// No optimizations:
|
||||||
|
ModeOptimizerSetting::M0,
|
||||||
|
// Aggressive optimizations:
|
||||||
|
ModeOptimizerSetting::M3,
|
||||||
|
]
|
||||||
|
.into_iter()
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Are any optimizations enabled?
|
||||||
|
pub fn optimizations_enabled(&self) -> bool {
|
||||||
|
!matches!(self, ModeOptimizerSetting::M0)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
use semver::{Version, VersionReq};
|
||||||
|
|
||||||
|
#[derive(Clone, Debug)]
|
||||||
|
pub enum VersionOrRequirement {
|
||||||
|
Version(Version),
|
||||||
|
Requirement(VersionReq),
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<Version> for VersionOrRequirement {
|
||||||
|
fn from(value: Version) -> Self {
|
||||||
|
Self::Version(value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<VersionReq> for VersionOrRequirement {
|
||||||
|
fn from(value: VersionReq) -> Self {
|
||||||
|
Self::Requirement(value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl TryFrom<VersionOrRequirement> for Version {
|
||||||
|
type Error = anyhow::Error;
|
||||||
|
|
||||||
|
fn try_from(value: VersionOrRequirement) -> Result<Self, Self::Error> {
|
||||||
|
let VersionOrRequirement::Version(version) = value else {
|
||||||
|
anyhow::bail!("Version or requirement was not a version");
|
||||||
|
};
|
||||||
|
Ok(version)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl TryFrom<VersionOrRequirement> for VersionReq {
|
||||||
|
type Error = anyhow::Error;
|
||||||
|
|
||||||
|
fn try_from(value: VersionOrRequirement) -> Result<Self, Self::Error> {
|
||||||
|
let VersionOrRequirement::Requirement(requirement) = value else {
|
||||||
|
anyhow::bail!("Version or requirement was not a requirement");
|
||||||
|
};
|
||||||
|
Ok(requirement)
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -9,11 +9,22 @@ repository.workspace = true
|
|||||||
rust-version.workspace = true
|
rust-version.workspace = true
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
anyhow = { workspace = true }
|
|
||||||
revive-solc-json-interface = { workspace = true }
|
revive-solc-json-interface = { workspace = true }
|
||||||
|
revive-dt-common = { workspace = true }
|
||||||
revive-dt-config = { workspace = true }
|
revive-dt-config = { workspace = true }
|
||||||
revive-dt-solc-binaries = { workspace = true }
|
revive-dt-solc-binaries = { workspace = true }
|
||||||
revive-common = { workspace = true }
|
revive-common = { workspace = true }
|
||||||
|
|
||||||
|
alloy = { workspace = true }
|
||||||
|
alloy-primitives = { workspace = true }
|
||||||
|
anyhow = { workspace = true }
|
||||||
|
dashmap = { workspace = true }
|
||||||
|
foundry-compilers-artifacts = { workspace = true }
|
||||||
semver = { workspace = true }
|
semver = { workspace = true }
|
||||||
|
serde = { workspace = true }
|
||||||
serde_json = { workspace = true }
|
serde_json = { workspace = true }
|
||||||
tracing = { workspace = true }
|
tracing = { workspace = true }
|
||||||
|
tokio = { workspace = true }
|
||||||
|
|
||||||
|
[lints]
|
||||||
|
workspace = true
|
||||||
|
|||||||
+124
-114
@@ -4,171 +4,181 @@
|
|||||||
//! - Polkadot revive Wasm compiler
|
//! - Polkadot revive Wasm compiler
|
||||||
|
|
||||||
use std::{
|
use std::{
|
||||||
fs::read_to_string,
|
collections::HashMap,
|
||||||
hash::Hash,
|
hash::Hash,
|
||||||
path::{Path, PathBuf},
|
path::{Path, PathBuf},
|
||||||
};
|
};
|
||||||
|
|
||||||
use revive_dt_config::Arguments;
|
use alloy::json_abi::JsonAbi;
|
||||||
|
use alloy_primitives::Address;
|
||||||
|
use anyhow::{Context, Result};
|
||||||
|
use semver::Version;
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
use revive_common::EVMVersion;
|
use revive_common::EVMVersion;
|
||||||
use revive_solc_json_interface::{
|
use revive_dt_common::cached_fs::read_to_string;
|
||||||
SolcStandardJsonInput, SolcStandardJsonInputLanguage, SolcStandardJsonInputSettings,
|
use revive_dt_common::types::VersionOrRequirement;
|
||||||
SolcStandardJsonInputSettingsOptimizer, SolcStandardJsonInputSettingsSelection,
|
use revive_dt_config::Arguments;
|
||||||
SolcStandardJsonOutput,
|
|
||||||
};
|
// Re-export this as it's a part of the compiler interface.
|
||||||
use semver::Version;
|
pub use revive_dt_common::types::{Mode, ModeOptimizerSetting, ModePipeline};
|
||||||
|
|
||||||
pub mod revive_js;
|
pub mod revive_js;
|
||||||
pub mod revive_resolc;
|
pub mod revive_resolc;
|
||||||
pub mod solc;
|
pub mod solc;
|
||||||
|
|
||||||
/// A common interface for all supported Solidity compilers.
|
/// A common interface for all supported Solidity compilers.
|
||||||
pub trait SolidityCompiler {
|
pub trait SolidityCompiler: Sized {
|
||||||
/// Extra options specific to the compiler.
|
/// Instantiates a new compiler object.
|
||||||
type Options: Default + PartialEq + Eq + Hash;
|
///
|
||||||
|
/// Based on the given [`Arguments`] and [`VersionOrRequirement`] this function instantiates a
|
||||||
|
/// new compiler object. Certain implementations of this trait might choose to cache cache the
|
||||||
|
/// compiler objects and return the same ones over and over again.
|
||||||
|
fn new(
|
||||||
|
config: &Arguments,
|
||||||
|
version: impl Into<Option<VersionOrRequirement>>,
|
||||||
|
) -> impl Future<Output = Result<Self>>;
|
||||||
|
|
||||||
|
/// Returns the version of the compiler.
|
||||||
|
fn version(&self) -> &Version;
|
||||||
|
|
||||||
|
/// Returns the path of the compiler executable.
|
||||||
|
fn path(&self) -> &Path;
|
||||||
|
|
||||||
/// The low-level compiler interface.
|
/// The low-level compiler interface.
|
||||||
fn build(
|
fn build(&self, input: CompilerInput) -> impl Future<Output = Result<CompilerOutput>>;
|
||||||
|
|
||||||
|
/// Does the compiler support the provided mode and version settings.
|
||||||
|
fn supports_mode(
|
||||||
&self,
|
&self,
|
||||||
input: CompilerInput<Self::Options>,
|
optimizer_setting: ModeOptimizerSetting,
|
||||||
) -> anyhow::Result<CompilerOutput<Self::Options>>;
|
pipeline: ModePipeline,
|
||||||
|
) -> bool;
|
||||||
fn new(solc_executable: PathBuf) -> Self;
|
|
||||||
|
|
||||||
fn get_compiler_executable(config: &Arguments, version: Version) -> anyhow::Result<PathBuf>;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The generic compilation input configuration.
|
/// The generic compilation input configuration.
|
||||||
#[derive(Debug)]
|
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
|
||||||
pub struct CompilerInput<T: PartialEq + Eq + Hash> {
|
pub struct CompilerInput {
|
||||||
pub extra_options: T,
|
pub pipeline: Option<ModePipeline>,
|
||||||
pub input: SolcStandardJsonInput,
|
pub optimization: Option<ModeOptimizerSetting>,
|
||||||
|
pub evm_version: Option<EVMVersion>,
|
||||||
pub allow_paths: Vec<PathBuf>,
|
pub allow_paths: Vec<PathBuf>,
|
||||||
pub base_path: Option<PathBuf>,
|
pub base_path: Option<PathBuf>,
|
||||||
|
pub sources: HashMap<PathBuf, String>,
|
||||||
|
pub libraries: HashMap<PathBuf, HashMap<String, Address>>,
|
||||||
|
pub revert_string_handling: Option<RevertString>,
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The generic compilation output configuration.
|
/// The generic compilation output configuration.
|
||||||
#[derive(Debug)]
|
#[derive(Debug, Clone, Default, Serialize, Deserialize)]
|
||||||
pub struct CompilerOutput<T: PartialEq + Eq + Hash> {
|
pub struct CompilerOutput {
|
||||||
/// The solc standard JSON input.
|
/// The compiled contracts. The bytecode of the contract is kept as a string incase linking is
|
||||||
pub input: CompilerInput<T>,
|
/// required and the compiled source has placeholders.
|
||||||
/// The produced solc standard JSON output.
|
pub contracts: HashMap<PathBuf, HashMap<String, (String, JsonAbi)>>,
|
||||||
pub output: SolcStandardJsonOutput,
|
|
||||||
/// The error message in case the compiler returns abnormally.
|
|
||||||
pub error: Option<String>,
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<T> PartialEq for CompilerInput<T>
|
/// A generic builder style interface for configuring the supported compiler options.
|
||||||
where
|
#[derive(Default)]
|
||||||
T: PartialEq + Eq + Hash,
|
pub struct Compiler {
|
||||||
{
|
input: CompilerInput,
|
||||||
fn eq(&self, other: &Self) -> bool {
|
|
||||||
let self_input = serde_json::to_vec(&self.input).unwrap_or_default();
|
|
||||||
let other_input = serde_json::to_vec(&self.input).unwrap_or_default();
|
|
||||||
self.extra_options.eq(&other.extra_options) && self_input == other_input
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<T> Eq for CompilerInput<T> where T: PartialEq + Eq + Hash {}
|
impl Compiler {
|
||||||
|
|
||||||
impl<T> Hash for CompilerInput<T>
|
|
||||||
where
|
|
||||||
T: PartialEq + Eq + Hash,
|
|
||||||
{
|
|
||||||
fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
|
|
||||||
self.extra_options.hash(state);
|
|
||||||
state.write(&serde_json::to_vec(&self.input).unwrap_or_default());
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// A generic builder style interface for configuring all compiler options.
|
|
||||||
pub struct Compiler<T: SolidityCompiler> {
|
|
||||||
input: SolcStandardJsonInput,
|
|
||||||
extra_options: T::Options,
|
|
||||||
allow_paths: Vec<PathBuf>,
|
|
||||||
base_path: Option<PathBuf>,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Default for Compiler<solc::Solc> {
|
|
||||||
fn default() -> Self {
|
|
||||||
Self::new()
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl<T> Compiler<T>
|
|
||||||
where
|
|
||||||
T: SolidityCompiler,
|
|
||||||
{
|
|
||||||
pub fn new() -> Self {
|
pub fn new() -> Self {
|
||||||
Self {
|
Self {
|
||||||
input: SolcStandardJsonInput {
|
input: CompilerInput {
|
||||||
language: SolcStandardJsonInputLanguage::Solidity,
|
pipeline: Default::default(),
|
||||||
|
optimization: Default::default(),
|
||||||
|
evm_version: Default::default(),
|
||||||
|
allow_paths: Default::default(),
|
||||||
|
base_path: Default::default(),
|
||||||
sources: Default::default(),
|
sources: Default::default(),
|
||||||
settings: SolcStandardJsonInputSettings::new(
|
libraries: Default::default(),
|
||||||
None,
|
revert_string_handling: Default::default(),
|
||||||
Default::default(),
|
|
||||||
None,
|
|
||||||
SolcStandardJsonInputSettingsSelection::new_required(),
|
|
||||||
SolcStandardJsonInputSettingsOptimizer::new(
|
|
||||||
false,
|
|
||||||
None,
|
|
||||||
&Version::new(0, 0, 0),
|
|
||||||
false,
|
|
||||||
),
|
|
||||||
None,
|
|
||||||
None,
|
|
||||||
),
|
|
||||||
},
|
},
|
||||||
extra_options: Default::default(),
|
|
||||||
allow_paths: Default::default(),
|
|
||||||
base_path: None,
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn solc_optimizer(mut self, enabled: bool) -> Self {
|
pub fn with_optimization(mut self, value: impl Into<Option<ModeOptimizerSetting>>) -> Self {
|
||||||
self.input.settings.optimizer.enabled = enabled;
|
self.input.optimization = value.into();
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn with_source(mut self, path: &Path) -> anyhow::Result<Self> {
|
pub fn with_pipeline(mut self, value: impl Into<Option<ModePipeline>>) -> Self {
|
||||||
self.input
|
self.input.pipeline = value.into();
|
||||||
.sources
|
self
|
||||||
.insert(path.display().to_string(), read_to_string(path)?.into());
|
}
|
||||||
|
|
||||||
|
pub fn with_evm_version(mut self, version: impl Into<Option<EVMVersion>>) -> Self {
|
||||||
|
self.input.evm_version = version.into();
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_allow_path(mut self, path: impl AsRef<Path>) -> Self {
|
||||||
|
self.input.allow_paths.push(path.as_ref().into());
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_base_path(mut self, path: impl Into<Option<PathBuf>>) -> Self {
|
||||||
|
self.input.base_path = path.into();
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_source(mut self, path: impl AsRef<Path>) -> Result<Self> {
|
||||||
|
self.input.sources.insert(
|
||||||
|
path.as_ref().to_path_buf(),
|
||||||
|
read_to_string(path.as_ref()).context("Failed to read the contract source")?,
|
||||||
|
);
|
||||||
Ok(self)
|
Ok(self)
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn evm_version(mut self, evm_version: EVMVersion) -> Self {
|
pub fn with_library(
|
||||||
self.input.settings.evm_version = Some(evm_version);
|
mut self,
|
||||||
|
path: impl AsRef<Path>,
|
||||||
|
name: impl AsRef<str>,
|
||||||
|
address: Address,
|
||||||
|
) -> Self {
|
||||||
|
self.input
|
||||||
|
.libraries
|
||||||
|
.entry(path.as_ref().to_path_buf())
|
||||||
|
.or_default()
|
||||||
|
.insert(name.as_ref().into(), address);
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn extra_options(mut self, extra_options: T::Options) -> Self {
|
pub fn with_revert_string_handling(
|
||||||
self.extra_options = extra_options;
|
mut self,
|
||||||
|
revert_string_handling: impl Into<Option<RevertString>>,
|
||||||
|
) -> Self {
|
||||||
|
self.input.revert_string_handling = revert_string_handling.into();
|
||||||
self
|
self
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn allow_path(mut self, path: PathBuf) -> Self {
|
pub fn then(self, callback: impl FnOnce(Self) -> Self) -> Self {
|
||||||
self.allow_paths.push(path);
|
callback(self)
|
||||||
self
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn base_path(mut self, base_path: PathBuf) -> Self {
|
pub fn try_then<E>(self, callback: impl FnOnce(Self) -> Result<Self, E>) -> Result<Self, E> {
|
||||||
self.base_path = Some(base_path);
|
callback(self)
|
||||||
self
|
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn try_build(self, solc_path: PathBuf) -> anyhow::Result<CompilerOutput<T::Options>> {
|
pub async fn try_build(self, compiler: &impl SolidityCompiler) -> Result<CompilerOutput> {
|
||||||
T::new(solc_path).build(CompilerInput {
|
compiler.build(self.input).await
|
||||||
extra_options: self.extra_options,
|
|
||||||
input: self.input,
|
|
||||||
allow_paths: self.allow_paths,
|
|
||||||
base_path: self.base_path,
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns the compiler JSON input.
|
pub fn input(&self) -> &CompilerInput {
|
||||||
pub fn input(&self) -> SolcStandardJsonInput {
|
&self.input
|
||||||
self.input.clone()
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Defines how the compiler should handle revert strings.
|
||||||
|
#[derive(
|
||||||
|
Clone, Debug, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default, Serialize, Deserialize,
|
||||||
|
)]
|
||||||
|
pub enum RevertString {
|
||||||
|
#[default]
|
||||||
|
Default,
|
||||||
|
Debug,
|
||||||
|
Strip,
|
||||||
|
VerboseDebug,
|
||||||
|
}
|
||||||
|
|||||||
@@ -3,152 +3,280 @@
|
|||||||
|
|
||||||
use std::{
|
use std::{
|
||||||
path::PathBuf,
|
path::PathBuf,
|
||||||
process::{Command, Stdio},
|
process::Stdio,
|
||||||
|
sync::{Arc, LazyLock},
|
||||||
};
|
};
|
||||||
|
|
||||||
use crate::{CompilerInput, CompilerOutput, SolidityCompiler};
|
use dashmap::DashMap;
|
||||||
|
use revive_dt_common::types::VersionOrRequirement;
|
||||||
use revive_dt_config::Arguments;
|
use revive_dt_config::Arguments;
|
||||||
use revive_solc_json_interface::SolcStandardJsonOutput;
|
use revive_solc_json_interface::{
|
||||||
|
SolcStandardJsonInput, SolcStandardJsonInputLanguage, SolcStandardJsonInputSettings,
|
||||||
|
SolcStandardJsonInputSettingsOptimizer, SolcStandardJsonInputSettingsSelection,
|
||||||
|
SolcStandardJsonOutput,
|
||||||
|
};
|
||||||
|
|
||||||
|
use crate::{
|
||||||
|
CompilerInput, CompilerOutput, ModeOptimizerSetting, ModePipeline, SolidityCompiler, solc::Solc,
|
||||||
|
};
|
||||||
|
|
||||||
|
use alloy::json_abi::JsonAbi;
|
||||||
|
use anyhow::{Context, Result};
|
||||||
|
use semver::Version;
|
||||||
|
use tokio::{io::AsyncWriteExt, process::Command as AsyncCommand};
|
||||||
|
|
||||||
/// A wrapper around the `resolc` binary, emitting PVM-compatible bytecode.
|
/// A wrapper around the `resolc` binary, emitting PVM-compatible bytecode.
|
||||||
#[derive(Debug)]
|
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||||||
pub struct Resolc {
|
pub struct Resolc(Arc<ResolcInner>);
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||||||
|
struct ResolcInner {
|
||||||
|
/// The internal solc compiler that the resolc compiler uses as a compiler frontend.
|
||||||
|
solc: Solc,
|
||||||
/// Path to the `resolc` executable
|
/// Path to the `resolc` executable
|
||||||
resolc_path: PathBuf,
|
resolc_path: PathBuf,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl SolidityCompiler for Resolc {
|
impl SolidityCompiler for Resolc {
|
||||||
type Options = Vec<String>;
|
async fn new(
|
||||||
|
config: &Arguments,
|
||||||
|
version: impl Into<Option<VersionOrRequirement>>,
|
||||||
|
) -> Result<Self> {
|
||||||
|
/// This is a cache of all of the resolc compiler objects. Since we do not currently support
|
||||||
|
/// multiple resolc compiler versions, so our cache is just keyed by the solc compiler and
|
||||||
|
/// its version to the resolc compiler.
|
||||||
|
static COMPILERS_CACHE: LazyLock<DashMap<Solc, Resolc>> = LazyLock::new(Default::default);
|
||||||
|
|
||||||
|
let solc = Solc::new(config, version)
|
||||||
|
.await
|
||||||
|
.context("Failed to create the solc compiler frontend for resolc")?;
|
||||||
|
|
||||||
|
Ok(COMPILERS_CACHE
|
||||||
|
.entry(solc.clone())
|
||||||
|
.or_insert_with(|| {
|
||||||
|
Self(Arc::new(ResolcInner {
|
||||||
|
solc,
|
||||||
|
resolc_path: config.resolc.clone(),
|
||||||
|
}))
|
||||||
|
})
|
||||||
|
.clone())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn version(&self) -> &Version {
|
||||||
|
// We currently return the solc compiler version since we do not support multiple resolc
|
||||||
|
// compiler versions.
|
||||||
|
self.0.solc.version()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn path(&self) -> &std::path::Path {
|
||||||
|
&self.0.resolc_path
|
||||||
|
}
|
||||||
|
|
||||||
#[tracing::instrument(level = "debug", ret)]
|
#[tracing::instrument(level = "debug", ret)]
|
||||||
fn build(
|
async fn build(
|
||||||
&self,
|
&self,
|
||||||
input: CompilerInput<Self::Options>,
|
CompilerInput {
|
||||||
) -> anyhow::Result<CompilerOutput<Self::Options>> {
|
pipeline,
|
||||||
let mut command = Command::new(&self.resolc_path);
|
optimization,
|
||||||
|
evm_version,
|
||||||
|
allow_paths,
|
||||||
|
base_path,
|
||||||
|
sources,
|
||||||
|
libraries,
|
||||||
|
// TODO: this is currently not being handled since there is no way to pass it into
|
||||||
|
// resolc. So, we need to go back to this later once it's supported.
|
||||||
|
revert_string_handling: _,
|
||||||
|
}: CompilerInput,
|
||||||
|
) -> Result<CompilerOutput> {
|
||||||
|
if !matches!(pipeline, None | Some(ModePipeline::ViaYulIR)) {
|
||||||
|
anyhow::bail!(
|
||||||
|
"Resolc only supports the Y (via Yul IR) pipeline, but the provided pipeline is {pipeline:?}"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
let input = SolcStandardJsonInput {
|
||||||
|
language: SolcStandardJsonInputLanguage::Solidity,
|
||||||
|
sources: sources
|
||||||
|
.into_iter()
|
||||||
|
.map(|(path, source)| (path.display().to_string(), source.into()))
|
||||||
|
.collect(),
|
||||||
|
settings: SolcStandardJsonInputSettings {
|
||||||
|
evm_version,
|
||||||
|
libraries: Some(
|
||||||
|
libraries
|
||||||
|
.into_iter()
|
||||||
|
.map(|(source_code, libraries_map)| {
|
||||||
|
(
|
||||||
|
source_code.display().to_string(),
|
||||||
|
libraries_map
|
||||||
|
.into_iter()
|
||||||
|
.map(|(library_ident, library_address)| {
|
||||||
|
(library_ident, library_address.to_string())
|
||||||
|
})
|
||||||
|
.collect(),
|
||||||
|
)
|
||||||
|
})
|
||||||
|
.collect(),
|
||||||
|
),
|
||||||
|
remappings: None,
|
||||||
|
output_selection: Some(SolcStandardJsonInputSettingsSelection::new_required()),
|
||||||
|
via_ir: Some(true),
|
||||||
|
optimizer: SolcStandardJsonInputSettingsOptimizer::new(
|
||||||
|
optimization
|
||||||
|
.unwrap_or(ModeOptimizerSetting::M0)
|
||||||
|
.optimizations_enabled(),
|
||||||
|
None,
|
||||||
|
&Version::new(0, 0, 0),
|
||||||
|
false,
|
||||||
|
),
|
||||||
|
metadata: None,
|
||||||
|
polkavm: None,
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut command = AsyncCommand::new(self.path());
|
||||||
command
|
command
|
||||||
.stdin(Stdio::piped())
|
.stdin(Stdio::piped())
|
||||||
.stdout(Stdio::piped())
|
.stdout(Stdio::piped())
|
||||||
.stderr(Stdio::piped())
|
.stderr(Stdio::piped())
|
||||||
.arg("--standard-json");
|
.arg("--standard-json");
|
||||||
|
|
||||||
if let Some(ref base_path) = input.base_path {
|
if let Some(ref base_path) = base_path {
|
||||||
command.arg("--base-path").arg(base_path);
|
command.arg("--base-path").arg(base_path);
|
||||||
}
|
}
|
||||||
if !input.allow_paths.is_empty() {
|
if !allow_paths.is_empty() {
|
||||||
command.arg("--allow-paths").arg(
|
command.arg("--allow-paths").arg(
|
||||||
input
|
allow_paths
|
||||||
.allow_paths
|
|
||||||
.iter()
|
.iter()
|
||||||
.map(|path| path.display().to_string())
|
.map(|path| path.display().to_string())
|
||||||
.collect::<Vec<_>>()
|
.collect::<Vec<_>>()
|
||||||
.join(","),
|
.join(","),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
let mut child = command.spawn()?;
|
let mut child = command
|
||||||
|
.spawn()
|
||||||
|
.with_context(|| format!("Failed to spawn resolc at {}", self.path().display()))?;
|
||||||
|
|
||||||
let stdin_pipe = child.stdin.as_mut().expect("stdin must be piped");
|
let stdin_pipe = child.stdin.as_mut().expect("stdin must be piped");
|
||||||
serde_json::to_writer(stdin_pipe, &input.input)?;
|
let serialized_input = serde_json::to_vec(&input)
|
||||||
|
.context("Failed to serialize Standard JSON input for resolc")?;
|
||||||
|
stdin_pipe
|
||||||
|
.write_all(&serialized_input)
|
||||||
|
.await
|
||||||
|
.context("Failed to write Standard JSON to resolc stdin")?;
|
||||||
|
|
||||||
let json_in = serde_json::to_string_pretty(&input.input)?;
|
let output = child
|
||||||
|
.wait_with_output()
|
||||||
let output = child.wait_with_output()?;
|
.await
|
||||||
|
.context("Failed while waiting for resolc process to finish")?;
|
||||||
let stdout = output.stdout;
|
let stdout = output.stdout;
|
||||||
let stderr = output.stderr;
|
let stderr = output.stderr;
|
||||||
|
|
||||||
if !output.status.success() {
|
if !output.status.success() {
|
||||||
|
let json_in = serde_json::to_string_pretty(&input)
|
||||||
|
.context("Failed to pretty-print Standard JSON input for logging")?;
|
||||||
let message = String::from_utf8_lossy(&stderr);
|
let message = String::from_utf8_lossy(&stderr);
|
||||||
tracing::error!(
|
tracing::error!(
|
||||||
"resolc failed exit={} stderr={} JSON-in={} ",
|
status = %output.status,
|
||||||
output.status,
|
message = %message,
|
||||||
&message,
|
json_input = json_in,
|
||||||
json_in,
|
"Compilation using resolc failed"
|
||||||
);
|
);
|
||||||
return Ok(CompilerOutput {
|
anyhow::bail!("Compilation failed with an error: {message}");
|
||||||
input,
|
|
||||||
output: Default::default(),
|
|
||||||
error: Some(message.into()),
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
let mut parsed =
|
let parsed = serde_json::from_slice::<SolcStandardJsonOutput>(&stdout)
|
||||||
serde_json::from_slice::<SolcStandardJsonOutput>(&stdout).map_err(|e| {
|
.map_err(|e| {
|
||||||
anyhow::anyhow!(
|
anyhow::anyhow!(
|
||||||
"failed to parse resolc JSON output: {e}\nstderr: {}",
|
"failed to parse resolc JSON output: {e}\nstderr: {}",
|
||||||
String::from_utf8_lossy(&stderr)
|
String::from_utf8_lossy(&stderr)
|
||||||
)
|
)
|
||||||
})?;
|
})
|
||||||
|
.context("Failed to parse resolc standard JSON output")?;
|
||||||
// Detecting if the compiler output contained errors and reporting them through logs and
|
|
||||||
// errors instead of returning the compiler output that might contain errors.
|
|
||||||
for error in parsed.errors.iter().flatten() {
|
|
||||||
if error.severity == "error" {
|
|
||||||
tracing::error!(?error, ?input, "Encountered an error in the compilation");
|
|
||||||
anyhow::bail!("Encountered an error in the compilation: {error}")
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
// We need to do some post processing on the output to make it in the same format that solc
|
|
||||||
// outputs. More specifically, for each contract, the `.metadata` field should be replaced
|
|
||||||
// with the `.metadata.solc_metadata` field which contains the ABI and other information
|
|
||||||
// about the compiled contracts. We do this because we do not want any downstream logic to
|
|
||||||
// need to differentiate between which compiler is being used when extracting the ABI of the
|
|
||||||
// contracts.
|
|
||||||
if let Some(ref mut contracts) = parsed.contracts {
|
|
||||||
for (contract_path, contracts_map) in contracts.iter_mut() {
|
|
||||||
for (contract_name, contract_info) in contracts_map.iter_mut() {
|
|
||||||
let Some(metadata) = contract_info.metadata.take() else {
|
|
||||||
continue;
|
|
||||||
};
|
|
||||||
|
|
||||||
// Get the `solc_metadata` in the metadata of the contract.
|
|
||||||
let Some(solc_metadata) = metadata
|
|
||||||
.get("solc_metadata")
|
|
||||||
.and_then(|metadata| metadata.as_str())
|
|
||||||
else {
|
|
||||||
tracing::error!(
|
|
||||||
contract_path,
|
|
||||||
contract_name,
|
|
||||||
metadata = serde_json::to_string(&metadata).unwrap(),
|
|
||||||
"Encountered a contract compiled with resolc that has no solc_metadata"
|
|
||||||
);
|
|
||||||
anyhow::bail!(
|
|
||||||
"Contract {} compiled with resolc that has no solc_metadata",
|
|
||||||
contract_name
|
|
||||||
);
|
|
||||||
};
|
|
||||||
|
|
||||||
// Replace the original metadata with the new solc_metadata.
|
|
||||||
contract_info.metadata =
|
|
||||||
Some(serde_json::Value::String(solc_metadata.to_string()));
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
tracing::debug!(
|
tracing::debug!(
|
||||||
output = %serde_json::to_string(&parsed).unwrap(),
|
output = %serde_json::to_string(&parsed).unwrap(),
|
||||||
"Compiled successfully"
|
"Compiled successfully"
|
||||||
);
|
);
|
||||||
|
|
||||||
Ok(CompilerOutput {
|
// Detecting if the compiler output contained errors and reporting them through logs and
|
||||||
input,
|
// errors instead of returning the compiler output that might contain errors.
|
||||||
output: parsed,
|
for error in parsed.errors.iter().flatten() {
|
||||||
error: None,
|
if error.severity == "error" {
|
||||||
})
|
tracing::error!(
|
||||||
}
|
?error,
|
||||||
|
?input,
|
||||||
fn new(resolc_path: PathBuf) -> Self {
|
output = %serde_json::to_string(&parsed).unwrap(),
|
||||||
Resolc { resolc_path }
|
"Encountered an error in the compilation"
|
||||||
}
|
);
|
||||||
|
anyhow::bail!("Encountered an error in the compilation: {error}")
|
||||||
fn get_compiler_executable(
|
}
|
||||||
config: &Arguments,
|
|
||||||
_version: semver::Version,
|
|
||||||
) -> anyhow::Result<PathBuf> {
|
|
||||||
if !config.resolc.as_os_str().is_empty() {
|
|
||||||
return Ok(config.resolc.clone());
|
|
||||||
}
|
}
|
||||||
|
|
||||||
Ok(PathBuf::from("resolc"))
|
let Some(contracts) = parsed.contracts else {
|
||||||
|
anyhow::bail!("Unexpected error - resolc output doesn't have a contracts section");
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut compiler_output = CompilerOutput::default();
|
||||||
|
for (source_path, contracts) in contracts.into_iter() {
|
||||||
|
let src_for_msg = source_path.clone();
|
||||||
|
let source_path = PathBuf::from(source_path)
|
||||||
|
.canonicalize()
|
||||||
|
.with_context(|| format!("Failed to canonicalize path {src_for_msg}"))?;
|
||||||
|
|
||||||
|
let map = compiler_output.contracts.entry(source_path).or_default();
|
||||||
|
for (contract_name, contract_information) in contracts.into_iter() {
|
||||||
|
let bytecode = contract_information
|
||||||
|
.evm
|
||||||
|
.and_then(|evm| evm.bytecode.clone())
|
||||||
|
.context("Unexpected - Contract compiled with resolc has no bytecode")?;
|
||||||
|
let abi = {
|
||||||
|
let metadata = contract_information
|
||||||
|
.metadata
|
||||||
|
.as_ref()
|
||||||
|
.context("No metadata found for the contract")?;
|
||||||
|
let solc_metadata_str = match metadata {
|
||||||
|
serde_json::Value::String(solc_metadata_str) => solc_metadata_str.as_str(),
|
||||||
|
serde_json::Value::Object(metadata_object) => {
|
||||||
|
let solc_metadata_value = metadata_object
|
||||||
|
.get("solc_metadata")
|
||||||
|
.context("Contract doesn't have a 'solc_metadata' field")?;
|
||||||
|
solc_metadata_value
|
||||||
|
.as_str()
|
||||||
|
.context("The 'solc_metadata' field is not a string")?
|
||||||
|
}
|
||||||
|
serde_json::Value::Null
|
||||||
|
| serde_json::Value::Bool(_)
|
||||||
|
| serde_json::Value::Number(_)
|
||||||
|
| serde_json::Value::Array(_) => {
|
||||||
|
anyhow::bail!("Unsupported type of metadata {metadata:?}")
|
||||||
|
}
|
||||||
|
};
|
||||||
|
let solc_metadata =
|
||||||
|
serde_json::from_str::<serde_json::Value>(solc_metadata_str).context(
|
||||||
|
"Failed to deserialize the solc_metadata as a serde_json generic value",
|
||||||
|
)?;
|
||||||
|
let output_value = solc_metadata
|
||||||
|
.get("output")
|
||||||
|
.context("solc_metadata doesn't have an output field")?;
|
||||||
|
let abi_value = output_value
|
||||||
|
.get("abi")
|
||||||
|
.context("solc_metadata output doesn't contain an abi field")?;
|
||||||
|
serde_json::from_value::<JsonAbi>(abi_value.clone())
|
||||||
|
.context("ABI found in solc_metadata output is not valid ABI")?
|
||||||
|
};
|
||||||
|
map.insert(contract_name, (bytecode.object, abi));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(compiler_output)
|
||||||
|
}
|
||||||
|
|
||||||
|
fn supports_mode(
|
||||||
|
&self,
|
||||||
|
optimize_setting: ModeOptimizerSetting,
|
||||||
|
pipeline: ModePipeline,
|
||||||
|
) -> bool {
|
||||||
|
pipeline == ModePipeline::ViaYulIR && self.0.solc.supports_mode(optimize_setting, pipeline)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+213
-43
@@ -3,75 +3,216 @@
|
|||||||
|
|
||||||
use std::{
|
use std::{
|
||||||
path::PathBuf,
|
path::PathBuf,
|
||||||
process::{Command, Stdio},
|
process::Stdio,
|
||||||
|
sync::{Arc, LazyLock},
|
||||||
};
|
};
|
||||||
|
|
||||||
use crate::{CompilerInput, CompilerOutput, SolidityCompiler};
|
use dashmap::DashMap;
|
||||||
|
use revive_dt_common::types::VersionOrRequirement;
|
||||||
use revive_dt_config::Arguments;
|
use revive_dt_config::Arguments;
|
||||||
use revive_dt_solc_binaries::download_solc;
|
use revive_dt_solc_binaries::download_solc;
|
||||||
use revive_solc_json_interface::SolcStandardJsonOutput;
|
|
||||||
|
|
||||||
#[derive(Debug)]
|
use crate::{CompilerInput, CompilerOutput, ModeOptimizerSetting, ModePipeline, SolidityCompiler};
|
||||||
pub struct Solc {
|
|
||||||
|
use anyhow::{Context, Result};
|
||||||
|
use foundry_compilers_artifacts::{
|
||||||
|
output_selection::{
|
||||||
|
BytecodeOutputSelection, ContractOutputSelection, EvmOutputSelection, OutputSelection,
|
||||||
|
},
|
||||||
|
solc::CompilerOutput as SolcOutput,
|
||||||
|
solc::*,
|
||||||
|
};
|
||||||
|
use semver::Version;
|
||||||
|
use tokio::{io::AsyncWriteExt, process::Command as AsyncCommand};
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||||||
|
pub struct Solc(Arc<SolcInner>);
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||||||
|
struct SolcInner {
|
||||||
|
/// The path of the solidity compiler executable that this object uses.
|
||||||
solc_path: PathBuf,
|
solc_path: PathBuf,
|
||||||
|
/// The version of the solidity compiler executable that this object uses.
|
||||||
|
solc_version: Version,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl SolidityCompiler for Solc {
|
impl SolidityCompiler for Solc {
|
||||||
type Options = ();
|
async fn new(
|
||||||
|
config: &Arguments,
|
||||||
|
version: impl Into<Option<VersionOrRequirement>>,
|
||||||
|
) -> Result<Self> {
|
||||||
|
// This is a cache for the compiler objects so that whenever the same compiler version is
|
||||||
|
// requested the same object is returned. We do this as we do not want to keep cloning the
|
||||||
|
// compiler around.
|
||||||
|
static COMPILERS_CACHE: LazyLock<DashMap<Version, Solc>> = LazyLock::new(Default::default);
|
||||||
|
|
||||||
|
// We attempt to download the solc binary. Note the following: this call does the version
|
||||||
|
// resolution for us. Therefore, even if the download didn't proceed, this function will
|
||||||
|
// resolve the version requirement into a canonical version of the compiler. It's then up
|
||||||
|
// to us to either use the provided path or not.
|
||||||
|
let version = version.into().unwrap_or_else(|| config.solc.clone().into());
|
||||||
|
let (version, path) = download_solc(config.directory(), version, false)
|
||||||
|
.await
|
||||||
|
.context("Failed to download/get path to solc binary")?;
|
||||||
|
|
||||||
|
Ok(COMPILERS_CACHE
|
||||||
|
.entry(version.clone())
|
||||||
|
.or_insert_with(|| {
|
||||||
|
Self(Arc::new(SolcInner {
|
||||||
|
solc_path: path,
|
||||||
|
solc_version: version,
|
||||||
|
}))
|
||||||
|
})
|
||||||
|
.clone())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn version(&self) -> &Version {
|
||||||
|
&self.0.solc_version
|
||||||
|
}
|
||||||
|
|
||||||
|
fn path(&self) -> &std::path::Path {
|
||||||
|
&self.0.solc_path
|
||||||
|
}
|
||||||
|
|
||||||
#[tracing::instrument(level = "debug", ret)]
|
#[tracing::instrument(level = "debug", ret)]
|
||||||
fn build(
|
async fn build(
|
||||||
&self,
|
&self,
|
||||||
input: CompilerInput<Self::Options>,
|
CompilerInput {
|
||||||
) -> anyhow::Result<CompilerOutput<Self::Options>> {
|
pipeline,
|
||||||
let mut command = Command::new(&self.solc_path);
|
optimization,
|
||||||
|
evm_version,
|
||||||
|
allow_paths,
|
||||||
|
base_path,
|
||||||
|
sources,
|
||||||
|
libraries,
|
||||||
|
revert_string_handling,
|
||||||
|
}: CompilerInput,
|
||||||
|
) -> Result<CompilerOutput> {
|
||||||
|
// Be careful to entirely omit the viaIR field if the compiler does not support it,
|
||||||
|
// as it will error if you provide fields it does not know about. Because
|
||||||
|
// `supports_mode` is called prior to instantiating a compiler, we should never
|
||||||
|
// ask for something which is invalid.
|
||||||
|
let via_ir = match (pipeline, self.compiler_supports_yul()) {
|
||||||
|
(pipeline, true) => pipeline.map(|p| p.via_yul_ir()),
|
||||||
|
(_pipeline, false) => None,
|
||||||
|
};
|
||||||
|
|
||||||
|
let input = SolcInput {
|
||||||
|
language: SolcLanguage::Solidity,
|
||||||
|
sources: Sources(
|
||||||
|
sources
|
||||||
|
.into_iter()
|
||||||
|
.map(|(source_path, source_code)| (source_path, Source::new(source_code)))
|
||||||
|
.collect(),
|
||||||
|
),
|
||||||
|
settings: Settings {
|
||||||
|
optimizer: Optimizer {
|
||||||
|
enabled: optimization.map(|o| o.optimizations_enabled()),
|
||||||
|
details: Some(Default::default()),
|
||||||
|
..Default::default()
|
||||||
|
},
|
||||||
|
output_selection: OutputSelection::common_output_selection(
|
||||||
|
[
|
||||||
|
ContractOutputSelection::Abi,
|
||||||
|
ContractOutputSelection::Evm(EvmOutputSelection::ByteCode(
|
||||||
|
BytecodeOutputSelection::Object,
|
||||||
|
)),
|
||||||
|
]
|
||||||
|
.into_iter()
|
||||||
|
.map(|item| item.to_string()),
|
||||||
|
),
|
||||||
|
evm_version: evm_version.map(|version| version.to_string().parse().unwrap()),
|
||||||
|
via_ir,
|
||||||
|
libraries: Libraries {
|
||||||
|
libs: libraries
|
||||||
|
.into_iter()
|
||||||
|
.map(|(file_path, libraries)| {
|
||||||
|
(
|
||||||
|
file_path,
|
||||||
|
libraries
|
||||||
|
.into_iter()
|
||||||
|
.map(|(library_name, library_address)| {
|
||||||
|
(library_name, library_address.to_string())
|
||||||
|
})
|
||||||
|
.collect(),
|
||||||
|
)
|
||||||
|
})
|
||||||
|
.collect(),
|
||||||
|
},
|
||||||
|
debug: revert_string_handling.map(|revert_string_handling| DebuggingSettings {
|
||||||
|
revert_strings: match revert_string_handling {
|
||||||
|
crate::RevertString::Default => Some(RevertStrings::Default),
|
||||||
|
crate::RevertString::Debug => Some(RevertStrings::Debug),
|
||||||
|
crate::RevertString::Strip => Some(RevertStrings::Strip),
|
||||||
|
crate::RevertString::VerboseDebug => Some(RevertStrings::VerboseDebug),
|
||||||
|
},
|
||||||
|
debug_info: Default::default(),
|
||||||
|
}),
|
||||||
|
..Default::default()
|
||||||
|
},
|
||||||
|
};
|
||||||
|
|
||||||
|
let mut command = AsyncCommand::new(self.path());
|
||||||
command
|
command
|
||||||
.stdin(Stdio::piped())
|
.stdin(Stdio::piped())
|
||||||
.stdout(Stdio::piped())
|
.stdout(Stdio::piped())
|
||||||
.stderr(Stdio::piped())
|
.stderr(Stdio::piped())
|
||||||
.arg("--standard-json");
|
.arg("--standard-json");
|
||||||
|
|
||||||
if let Some(ref base_path) = input.base_path {
|
if let Some(ref base_path) = base_path {
|
||||||
command.arg("--base-path").arg(base_path);
|
command.arg("--base-path").arg(base_path);
|
||||||
}
|
}
|
||||||
if !input.allow_paths.is_empty() {
|
if !allow_paths.is_empty() {
|
||||||
command.arg("--allow-paths").arg(
|
command.arg("--allow-paths").arg(
|
||||||
input
|
allow_paths
|
||||||
.allow_paths
|
|
||||||
.iter()
|
.iter()
|
||||||
.map(|path| path.display().to_string())
|
.map(|path| path.display().to_string())
|
||||||
.collect::<Vec<_>>()
|
.collect::<Vec<_>>()
|
||||||
.join(","),
|
.join(","),
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
let mut child = command.spawn()?;
|
let mut child = command
|
||||||
|
.spawn()
|
||||||
|
.with_context(|| format!("Failed to spawn solc at {}", self.path().display()))?;
|
||||||
|
|
||||||
let stdin = child.stdin.as_mut().expect("should be piped");
|
let stdin = child.stdin.as_mut().expect("should be piped");
|
||||||
serde_json::to_writer(stdin, &input.input)?;
|
let serialized_input = serde_json::to_vec(&input)
|
||||||
let output = child.wait_with_output()?;
|
.context("Failed to serialize Standard JSON input for solc")?;
|
||||||
|
stdin
|
||||||
|
.write_all(&serialized_input)
|
||||||
|
.await
|
||||||
|
.context("Failed to write Standard JSON to solc stdin")?;
|
||||||
|
let output = child
|
||||||
|
.wait_with_output()
|
||||||
|
.await
|
||||||
|
.context("Failed while waiting for solc process to finish")?;
|
||||||
|
|
||||||
if !output.status.success() {
|
if !output.status.success() {
|
||||||
|
let json_in = serde_json::to_string_pretty(&input)
|
||||||
|
.context("Failed to pretty-print Standard JSON input for logging")?;
|
||||||
let message = String::from_utf8_lossy(&output.stderr);
|
let message = String::from_utf8_lossy(&output.stderr);
|
||||||
tracing::error!("solc failed exit={} stderr={}", output.status, &message);
|
tracing::error!(
|
||||||
return Ok(CompilerOutput {
|
status = %output.status,
|
||||||
input,
|
message = %message,
|
||||||
output: Default::default(),
|
json_input = json_in,
|
||||||
error: Some(message.into()),
|
"Compilation using solc failed"
|
||||||
});
|
);
|
||||||
|
anyhow::bail!("Compilation failed with an error: {message}");
|
||||||
}
|
}
|
||||||
|
|
||||||
let parsed =
|
let parsed = serde_json::from_slice::<SolcOutput>(&output.stdout)
|
||||||
serde_json::from_slice::<SolcStandardJsonOutput>(&output.stdout).map_err(|e| {
|
.map_err(|e| {
|
||||||
anyhow::anyhow!(
|
anyhow::anyhow!(
|
||||||
"failed to parse resolc JSON output: {e}\nstderr: {}",
|
"failed to parse resolc JSON output: {e}\nstderr: {}",
|
||||||
String::from_utf8_lossy(&output.stdout)
|
String::from_utf8_lossy(&output.stdout)
|
||||||
)
|
)
|
||||||
})?;
|
})
|
||||||
|
.context("Failed to parse solc standard JSON output")?;
|
||||||
|
|
||||||
// Detecting if the compiler output contained errors and reporting them through logs and
|
// Detecting if the compiler output contained errors and reporting them through logs and
|
||||||
// errors instead of returning the compiler output that might contain errors.
|
// errors instead of returning the compiler output that might contain errors.
|
||||||
for error in parsed.errors.iter().flatten() {
|
for error in parsed.errors.iter() {
|
||||||
if error.severity == "error" {
|
if error.severity == Severity::Error {
|
||||||
tracing::error!(?error, ?input, "Encountered an error in the compilation");
|
tracing::error!(?error, ?input, "Encountered an error in the compilation");
|
||||||
anyhow::bail!("Encountered an error in the compilation: {error}")
|
anyhow::bail!("Encountered an error in the compilation: {error}")
|
||||||
}
|
}
|
||||||
@@ -82,22 +223,51 @@ impl SolidityCompiler for Solc {
|
|||||||
"Compiled successfully"
|
"Compiled successfully"
|
||||||
);
|
);
|
||||||
|
|
||||||
Ok(CompilerOutput {
|
let mut compiler_output = CompilerOutput::default();
|
||||||
input,
|
for (contract_path, contracts) in parsed.contracts {
|
||||||
output: parsed,
|
let map = compiler_output
|
||||||
error: None,
|
.contracts
|
||||||
})
|
.entry(contract_path.canonicalize().with_context(|| {
|
||||||
|
format!(
|
||||||
|
"Failed to canonicalize contract path {}",
|
||||||
|
contract_path.display()
|
||||||
|
)
|
||||||
|
})?)
|
||||||
|
.or_default();
|
||||||
|
for (contract_name, contract_info) in contracts.into_iter() {
|
||||||
|
let source_code = contract_info
|
||||||
|
.evm
|
||||||
|
.and_then(|evm| evm.bytecode)
|
||||||
|
.map(|bytecode| match bytecode.object {
|
||||||
|
BytecodeObject::Bytecode(bytecode) => bytecode.to_string(),
|
||||||
|
BytecodeObject::Unlinked(unlinked) => unlinked,
|
||||||
|
})
|
||||||
|
.context("Unexpected - contract compiled with solc has no source code")?;
|
||||||
|
let abi = contract_info
|
||||||
|
.abi
|
||||||
|
.context("Unexpected - contract compiled with solc as no ABI")?;
|
||||||
|
map.insert(contract_name, (source_code, abi));
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(compiler_output)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn new(solc_path: PathBuf) -> Self {
|
fn supports_mode(
|
||||||
Self { solc_path }
|
&self,
|
||||||
}
|
_optimize_setting: ModeOptimizerSetting,
|
||||||
|
pipeline: ModePipeline,
|
||||||
fn get_compiler_executable(
|
) -> bool {
|
||||||
config: &Arguments,
|
// solc 0.8.13 and above supports --via-ir, and less than that does not. Thus, we support mode E
|
||||||
version: semver::Version,
|
// (ie no Yul IR) in either case, but only support Y (via Yul IR) if the compiler is new enough.
|
||||||
) -> anyhow::Result<PathBuf> {
|
pipeline == ModePipeline::ViaEVMAssembly
|
||||||
let path = download_solc(config.directory(), version, config.wasm)?;
|
|| (pipeline == ModePipeline::ViaYulIR && self.compiler_supports_yul())
|
||||||
Ok(path)
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Solc {
|
||||||
|
fn compiler_supports_yul(&self) -> bool {
|
||||||
|
const SOLC_VERSION_SUPPORTING_VIA_YUL_IR: Version = Version::new(0, 8, 13);
|
||||||
|
self.version() >= &SOLC_VERSION_SUPPORTING_VIA_YUL_IR
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,9 @@
|
|||||||
|
// SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
pragma solidity >=0.6.9;
|
||||||
|
|
||||||
|
contract Callable {
|
||||||
|
function f(uint[1] memory p1) public pure returns(uint) {
|
||||||
|
return p1[0];
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,13 @@
|
|||||||
|
// SPDX-License-Identifier: MIT
|
||||||
|
|
||||||
|
// Report https://linear.app/matterlabs/issue/CPR-269/call-with-calldata-variable-bug
|
||||||
|
|
||||||
|
pragma solidity >=0.6.9;
|
||||||
|
|
||||||
|
import "./callable.sol";
|
||||||
|
|
||||||
|
contract Main {
|
||||||
|
function main(uint[1] calldata p1, Callable callable) public returns(uint) {
|
||||||
|
return callable.f(p1);
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
{ "cases": [ {
|
||||||
|
"name": "first",
|
||||||
|
"inputs": [
|
||||||
|
{
|
||||||
|
"instance": "Main",
|
||||||
|
"method": "main",
|
||||||
|
"calldata": [
|
||||||
|
"1",
|
||||||
|
"Callable.address"
|
||||||
|
]
|
||||||
|
}
|
||||||
|
],
|
||||||
|
"expected": [
|
||||||
|
"1"
|
||||||
|
]
|
||||||
|
} ],
|
||||||
|
"contracts": {
|
||||||
|
"Main": "main.sol:Main",
|
||||||
|
"Callable": "callable.sol:Callable"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,88 @@
|
|||||||
|
use std::path::PathBuf;
|
||||||
|
|
||||||
|
use revive_dt_common::types::VersionOrRequirement;
|
||||||
|
use revive_dt_compiler::{Compiler, SolidityCompiler, revive_resolc::Resolc, solc::Solc};
|
||||||
|
use revive_dt_config::Arguments;
|
||||||
|
use semver::Version;
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn contracts_can_be_compiled_with_solc() {
|
||||||
|
// Arrange
|
||||||
|
let args = Arguments::default();
|
||||||
|
let solc = Solc::new(&args, VersionOrRequirement::Version(Version::new(0, 8, 30)))
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let output = Compiler::new()
|
||||||
|
.with_source("./tests/assets/array_one_element/callable.sol")
|
||||||
|
.unwrap()
|
||||||
|
.with_source("./tests/assets/array_one_element/main.sol")
|
||||||
|
.unwrap()
|
||||||
|
.try_build(&solc)
|
||||||
|
.await;
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
let output = output.expect("Failed to compile");
|
||||||
|
assert_eq!(output.contracts.len(), 2);
|
||||||
|
|
||||||
|
let main_file_contracts = output
|
||||||
|
.contracts
|
||||||
|
.get(
|
||||||
|
&PathBuf::from("./tests/assets/array_one_element/main.sol")
|
||||||
|
.canonicalize()
|
||||||
|
.unwrap(),
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
let callable_file_contracts = output
|
||||||
|
.contracts
|
||||||
|
.get(
|
||||||
|
&PathBuf::from("./tests/assets/array_one_element/callable.sol")
|
||||||
|
.canonicalize()
|
||||||
|
.unwrap(),
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
assert!(main_file_contracts.contains_key("Main"));
|
||||||
|
assert!(callable_file_contracts.contains_key("Callable"));
|
||||||
|
}
|
||||||
|
|
||||||
|
#[tokio::test]
|
||||||
|
async fn contracts_can_be_compiled_with_resolc() {
|
||||||
|
// Arrange
|
||||||
|
let args = Arguments::default();
|
||||||
|
let resolc = Resolc::new(&args, VersionOrRequirement::Version(Version::new(0, 8, 30)))
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
|
|
||||||
|
// Act
|
||||||
|
let output = Compiler::new()
|
||||||
|
.with_source("./tests/assets/array_one_element/callable.sol")
|
||||||
|
.unwrap()
|
||||||
|
.with_source("./tests/assets/array_one_element/main.sol")
|
||||||
|
.unwrap()
|
||||||
|
.try_build(&resolc)
|
||||||
|
.await;
|
||||||
|
|
||||||
|
// Assert
|
||||||
|
let output = output.expect("Failed to compile");
|
||||||
|
assert_eq!(output.contracts.len(), 2);
|
||||||
|
|
||||||
|
let main_file_contracts = output
|
||||||
|
.contracts
|
||||||
|
.get(
|
||||||
|
&PathBuf::from("./tests/assets/array_one_element/main.sol")
|
||||||
|
.canonicalize()
|
||||||
|
.unwrap(),
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
let callable_file_contracts = output
|
||||||
|
.contracts
|
||||||
|
.get(
|
||||||
|
&PathBuf::from("./tests/assets/array_one_element/callable.sol")
|
||||||
|
.canonicalize()
|
||||||
|
.unwrap(),
|
||||||
|
)
|
||||||
|
.unwrap();
|
||||||
|
assert!(main_file_contracts.contains_key("Main"));
|
||||||
|
assert!(callable_file_contracts.contains_key("Callable"));
|
||||||
|
}
|
||||||
@@ -15,3 +15,5 @@ semver = { workspace = true }
|
|||||||
temp-dir = { workspace = true }
|
temp-dir = { workspace = true }
|
||||||
serde = { workspace = true }
|
serde = { workspace = true }
|
||||||
|
|
||||||
|
[lints]
|
||||||
|
workspace = true
|
||||||
|
|||||||
+60
-14
@@ -3,6 +3,7 @@
|
|||||||
use std::{
|
use std::{
|
||||||
fmt::Display,
|
fmt::Display,
|
||||||
path::{Path, PathBuf},
|
path::{Path, PathBuf},
|
||||||
|
sync::LazyLock,
|
||||||
};
|
};
|
||||||
|
|
||||||
use alloy::{network::EthereumWallet, signers::local::PrivateKeySigner};
|
use alloy::{network::EthereumWallet, signers::local::PrivateKeySigner};
|
||||||
@@ -54,13 +55,9 @@ pub struct Arguments {
|
|||||||
pub geth: PathBuf,
|
pub geth: PathBuf,
|
||||||
|
|
||||||
/// The maximum time in milliseconds to wait for geth to start.
|
/// The maximum time in milliseconds to wait for geth to start.
|
||||||
#[arg(long = "geth-start-timeout", default_value = "2000")]
|
#[arg(long = "geth-start-timeout", default_value = "5000")]
|
||||||
pub geth_start_timeout: u64,
|
pub geth_start_timeout: u64,
|
||||||
|
|
||||||
/// The test network chain ID.
|
|
||||||
#[arg(short, long = "network-id", default_value = "420420420")]
|
|
||||||
pub network_id: u64,
|
|
||||||
|
|
||||||
/// Configure nodes according to this genesis.json file.
|
/// Configure nodes according to this genesis.json file.
|
||||||
#[arg(long = "genesis", default_value = "genesis.json")]
|
#[arg(long = "genesis", default_value = "genesis.json")]
|
||||||
pub genesis_file: PathBuf,
|
pub genesis_file: PathBuf,
|
||||||
@@ -76,7 +73,7 @@ pub struct Arguments {
|
|||||||
/// This argument controls which private keys the nodes should have access to and be added to
|
/// This argument controls which private keys the nodes should have access to and be added to
|
||||||
/// its wallet signers. With a value of N, private keys (0, N] will be added to the signer set
|
/// its wallet signers. With a value of N, private keys (0, N] will be added to the signer set
|
||||||
/// of the node.
|
/// of the node.
|
||||||
#[arg(long = "private-keys-count", default_value_t = 30)]
|
#[arg(long = "private-keys-count", default_value_t = 100_000)]
|
||||||
pub private_keys_to_add: usize,
|
pub private_keys_to_add: usize,
|
||||||
|
|
||||||
/// The differential testing leader node implementation.
|
/// The differential testing leader node implementation.
|
||||||
@@ -87,13 +84,22 @@ pub struct Arguments {
|
|||||||
#[arg(short, long = "follower", default_value = "kitchensink")]
|
#[arg(short, long = "follower", default_value = "kitchensink")]
|
||||||
pub follower: TestingPlatform,
|
pub follower: TestingPlatform,
|
||||||
|
|
||||||
/// Only compile against this testing platform (doesn't execute the tests).
|
/// Determines the amount of nodes that will be spawned for each chain.
|
||||||
#[arg(long = "compile-only")]
|
#[arg(long, default_value = "1")]
|
||||||
pub compile_only: Option<TestingPlatform>,
|
pub number_of_nodes: usize,
|
||||||
|
|
||||||
/// Determines the amount of tests that are executed in parallel.
|
/// Determines the amount of tokio worker threads that will will be used.
|
||||||
#[arg(long = "workers", default_value = "12")]
|
#[arg(
|
||||||
pub workers: usize,
|
long,
|
||||||
|
default_value_t = std::thread::available_parallelism()
|
||||||
|
.map(|n| n.get())
|
||||||
|
.unwrap_or(1)
|
||||||
|
)]
|
||||||
|
pub number_of_threads: usize,
|
||||||
|
|
||||||
|
/// Determines the amount of concurrent tasks that will be spawned to run tests. Defaults to 10 x the number of nodes.
|
||||||
|
#[arg(long)]
|
||||||
|
pub number_concurrent_tasks: Option<usize>,
|
||||||
|
|
||||||
/// Extract problems back to the test corpus.
|
/// Extract problems back to the test corpus.
|
||||||
#[arg(short, long = "extract-problems")]
|
#[arg(short, long = "extract-problems")]
|
||||||
@@ -105,11 +111,35 @@ pub struct Arguments {
|
|||||||
#[arg(short, long = "kitchensink", default_value = "substrate-node")]
|
#[arg(short, long = "kitchensink", default_value = "substrate-node")]
|
||||||
pub kitchensink: PathBuf,
|
pub kitchensink: PathBuf,
|
||||||
|
|
||||||
|
/// The path to the `revive-dev-node` executable.
|
||||||
|
///
|
||||||
|
/// By default it uses `revive-dev-node` binary found in `$PATH`.
|
||||||
|
#[arg(long = "revive-dev-node", default_value = "revive-dev-node")]
|
||||||
|
pub revive_dev_node: PathBuf,
|
||||||
|
|
||||||
|
/// By default the tool uses the revive-dev-node when it's running differential tests against
|
||||||
|
/// PolkaVM since the dev-node is much faster than kitchensink. This flag allows the caller to
|
||||||
|
/// configure the tool to use kitchensink rather than the dev-node.
|
||||||
|
#[arg(long)]
|
||||||
|
pub use_kitchensink_not_dev_node: bool,
|
||||||
|
|
||||||
/// The path to the `eth_proxy` executable.
|
/// The path to the `eth_proxy` executable.
|
||||||
///
|
///
|
||||||
/// By default it uses `eth-rpc` binary found in `$PATH`.
|
/// By default it uses `eth-rpc` binary found in `$PATH`.
|
||||||
#[arg(short = 'p', long = "eth_proxy", default_value = "eth-rpc")]
|
#[arg(short = 'p', long = "eth_proxy", default_value = "eth-rpc")]
|
||||||
pub eth_proxy: PathBuf,
|
pub eth_proxy: PathBuf,
|
||||||
|
|
||||||
|
/// Controls if the compilation cache should be invalidated or not.
|
||||||
|
#[arg(short, long)]
|
||||||
|
pub invalidate_compilation_cache: bool,
|
||||||
|
|
||||||
|
/// Controls if the compiler input is included in the final report.
|
||||||
|
#[clap(long = "report.include-compiler-input")]
|
||||||
|
pub report_include_compiler_input: bool,
|
||||||
|
|
||||||
|
/// Controls if the compiler output is included in the final report.
|
||||||
|
#[clap(long = "report.include-compiler-output")]
|
||||||
|
pub report_include_compiler_output: bool,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Arguments {
|
impl Arguments {
|
||||||
@@ -129,6 +159,13 @@ impl Arguments {
|
|||||||
panic!("should have a workdir configured")
|
panic!("should have a workdir configured")
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Return the number of concurrent tasks to run. This is provided via the
|
||||||
|
/// `--number-concurrent-tasks` argument, and otherwise defaults to --number-of-nodes * 20.
|
||||||
|
pub fn number_of_concurrent_tasks(&self) -> usize {
|
||||||
|
self.number_concurrent_tasks
|
||||||
|
.unwrap_or(20 * self.number_of_nodes)
|
||||||
|
}
|
||||||
|
|
||||||
/// Try to parse `self.account` into a [PrivateKeySigner],
|
/// Try to parse `self.account` into a [PrivateKeySigner],
|
||||||
/// panicing on error.
|
/// panicing on error.
|
||||||
pub fn wallet(&self) -> EthereumWallet {
|
pub fn wallet(&self) -> EthereumWallet {
|
||||||
@@ -144,14 +181,23 @@ impl Arguments {
|
|||||||
|
|
||||||
impl Default for Arguments {
|
impl Default for Arguments {
|
||||||
fn default() -> Self {
|
fn default() -> Self {
|
||||||
Arguments::parse_from(["retester"])
|
static TEMP_DIR: LazyLock<TempDir> = LazyLock::new(|| TempDir::new().unwrap());
|
||||||
|
|
||||||
|
let default = Arguments::parse_from(["retester"]);
|
||||||
|
|
||||||
|
Arguments {
|
||||||
|
temp_dir: Some(&TEMP_DIR),
|
||||||
|
..default
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// The Solidity compatible node implementation.
|
/// The Solidity compatible node implementation.
|
||||||
///
|
///
|
||||||
/// This describes the solutions to be tested against on a high level.
|
/// This describes the solutions to be tested against on a high level.
|
||||||
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, ValueEnum, Serialize, Deserialize)]
|
#[derive(
|
||||||
|
Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, ValueEnum, Serialize, Deserialize,
|
||||||
|
)]
|
||||||
#[clap(rename_all = "lower")]
|
#[clap(rename_all = "lower")]
|
||||||
pub enum TestingPlatform {
|
pub enum TestingPlatform {
|
||||||
/// The go-ethereum reference full node EVM implementation.
|
/// The go-ethereum reference full node EVM implementation.
|
||||||
|
|||||||
+10
-2
@@ -23,11 +23,19 @@ revive-dt-report = { workspace = true }
|
|||||||
|
|
||||||
alloy = { workspace = true }
|
alloy = { workspace = true }
|
||||||
anyhow = { workspace = true }
|
anyhow = { workspace = true }
|
||||||
|
bson = { workspace = true }
|
||||||
|
cacache = { workspace = true }
|
||||||
clap = { workspace = true }
|
clap = { workspace = true }
|
||||||
|
futures = { workspace = true }
|
||||||
indexmap = { workspace = true }
|
indexmap = { workspace = true }
|
||||||
|
tokio = { workspace = true }
|
||||||
tracing = { workspace = true }
|
tracing = { workspace = true }
|
||||||
|
tracing-appender = { workspace = true }
|
||||||
tracing-subscriber = { workspace = true }
|
tracing-subscriber = { workspace = true }
|
||||||
rayon = { workspace = true }
|
semver = { workspace = true }
|
||||||
revive-solc-json-interface = { workspace = true }
|
serde = { workspace = true }
|
||||||
serde_json = { workspace = true }
|
serde_json = { workspace = true }
|
||||||
temp-dir = { workspace = true }
|
temp-dir = { workspace = true }
|
||||||
|
|
||||||
|
[lints]
|
||||||
|
workspace = true
|
||||||
|
|||||||
@@ -0,0 +1,359 @@
|
|||||||
|
//! A wrapper around the compiler which allows for caching of compilation artifacts so that they can
|
||||||
|
//! be reused between runs.
|
||||||
|
|
||||||
|
use std::{
|
||||||
|
borrow::Cow,
|
||||||
|
collections::HashMap,
|
||||||
|
path::{Path, PathBuf},
|
||||||
|
sync::Arc,
|
||||||
|
};
|
||||||
|
|
||||||
|
use futures::FutureExt;
|
||||||
|
use revive_dt_common::iterators::FilesWithExtensionIterator;
|
||||||
|
use revive_dt_compiler::{Compiler, CompilerOutput, Mode, SolidityCompiler};
|
||||||
|
use revive_dt_config::TestingPlatform;
|
||||||
|
use revive_dt_format::metadata::{ContractIdent, ContractInstance, Metadata};
|
||||||
|
|
||||||
|
use alloy::{hex::ToHexExt, json_abi::JsonAbi, primitives::Address};
|
||||||
|
use anyhow::{Context as _, Error, Result};
|
||||||
|
use revive_dt_report::ExecutionSpecificReporter;
|
||||||
|
use semver::Version;
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
use tokio::sync::{Mutex, RwLock};
|
||||||
|
use tracing::{Instrument, debug, debug_span, instrument};
|
||||||
|
|
||||||
|
use crate::Platform;
|
||||||
|
|
||||||
|
pub struct CachedCompiler<'a> {
|
||||||
|
/// The cache that stores the compiled contracts.
|
||||||
|
artifacts_cache: ArtifactsCache,
|
||||||
|
|
||||||
|
/// This is a mechanism that the cached compiler uses so that if multiple compilation requests
|
||||||
|
/// come in for the same contract we never compile all of them and only compile it once and all
|
||||||
|
/// other tasks that request this same compilation concurrently get the cached version.
|
||||||
|
cache_key_lock: RwLock<HashMap<CacheKey<'a>, Arc<Mutex<()>>>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<'a> CachedCompiler<'a> {
|
||||||
|
pub async fn new(path: impl AsRef<Path>, invalidate_cache: bool) -> Result<Self> {
|
||||||
|
let mut cache = ArtifactsCache::new(path);
|
||||||
|
if invalidate_cache {
|
||||||
|
cache = cache
|
||||||
|
.with_invalidated_cache()
|
||||||
|
.await
|
||||||
|
.context("Failed to invalidate compilation cache directory")?;
|
||||||
|
}
|
||||||
|
Ok(Self {
|
||||||
|
artifacts_cache: cache,
|
||||||
|
cache_key_lock: Default::default(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Compiles or gets the compilation artifacts from the cache.
|
||||||
|
#[allow(clippy::too_many_arguments)]
|
||||||
|
#[instrument(
|
||||||
|
level = "debug",
|
||||||
|
skip_all,
|
||||||
|
fields(
|
||||||
|
metadata_file_path = %metadata_file_path.display(),
|
||||||
|
%mode,
|
||||||
|
platform = P::config_id().to_string()
|
||||||
|
),
|
||||||
|
err
|
||||||
|
)]
|
||||||
|
pub async fn compile_contracts<P: Platform>(
|
||||||
|
&self,
|
||||||
|
metadata: &'a Metadata,
|
||||||
|
metadata_file_path: &'a Path,
|
||||||
|
mode: Cow<'a, Mode>,
|
||||||
|
deployed_libraries: Option<&HashMap<ContractInstance, (ContractIdent, Address, JsonAbi)>>,
|
||||||
|
compiler: &P::Compiler,
|
||||||
|
reporter: &ExecutionSpecificReporter,
|
||||||
|
) -> Result<CompilerOutput> {
|
||||||
|
let cache_key = CacheKey {
|
||||||
|
platform_key: P::config_id(),
|
||||||
|
compiler_version: compiler.version().clone(),
|
||||||
|
metadata_file_path,
|
||||||
|
solc_mode: mode.clone(),
|
||||||
|
};
|
||||||
|
|
||||||
|
let compilation_callback = || {
|
||||||
|
async move {
|
||||||
|
compile_contracts::<P>(
|
||||||
|
metadata
|
||||||
|
.directory()
|
||||||
|
.context("Failed to get metadata directory while preparing compilation")?,
|
||||||
|
metadata
|
||||||
|
.files_to_compile()
|
||||||
|
.context("Failed to enumerate files to compile from metadata")?,
|
||||||
|
&mode,
|
||||||
|
deployed_libraries,
|
||||||
|
compiler,
|
||||||
|
reporter,
|
||||||
|
)
|
||||||
|
.map(|compilation_result| compilation_result.map(CacheValue::new))
|
||||||
|
.await
|
||||||
|
}
|
||||||
|
.instrument(debug_span!(
|
||||||
|
"Running compilation for the cache key",
|
||||||
|
cache_key.platform_key = %cache_key.platform_key,
|
||||||
|
cache_key.compiler_version = %cache_key.compiler_version,
|
||||||
|
cache_key.metadata_file_path = %cache_key.metadata_file_path.display(),
|
||||||
|
cache_key.solc_mode = %cache_key.solc_mode,
|
||||||
|
))
|
||||||
|
};
|
||||||
|
|
||||||
|
let compiled_contracts = match deployed_libraries {
|
||||||
|
// If deployed libraries have been specified then we will re-compile the contract as it
|
||||||
|
// means that linking is required in this case.
|
||||||
|
Some(_) => {
|
||||||
|
debug!("Deployed libraries defined, recompilation must take place");
|
||||||
|
debug!("Cache miss");
|
||||||
|
compilation_callback()
|
||||||
|
.await
|
||||||
|
.context("Compilation callback for deployed libraries failed")?
|
||||||
|
.compiler_output
|
||||||
|
}
|
||||||
|
// If no deployed libraries are specified then we can follow the cached flow and attempt
|
||||||
|
// to lookup the compilation artifacts in the cache.
|
||||||
|
None => {
|
||||||
|
debug!("Deployed libraries undefined, attempting to make use of cache");
|
||||||
|
|
||||||
|
// Lock this specific cache key such that we do not get inconsistent state. We want
|
||||||
|
// that when multiple cases come in asking for the compilation artifacts then they
|
||||||
|
// don't all trigger a compilation if there's a cache miss. Hence, the lock here.
|
||||||
|
let read_guard = self.cache_key_lock.read().await;
|
||||||
|
let mutex = match read_guard.get(&cache_key).cloned() {
|
||||||
|
Some(value) => {
|
||||||
|
drop(read_guard);
|
||||||
|
value
|
||||||
|
}
|
||||||
|
None => {
|
||||||
|
drop(read_guard);
|
||||||
|
self.cache_key_lock
|
||||||
|
.write()
|
||||||
|
.await
|
||||||
|
.entry(cache_key.clone())
|
||||||
|
.or_default()
|
||||||
|
.clone()
|
||||||
|
}
|
||||||
|
};
|
||||||
|
let _guard = mutex.lock().await;
|
||||||
|
|
||||||
|
match self.artifacts_cache.get(&cache_key).await {
|
||||||
|
Some(cache_value) => {
|
||||||
|
if deployed_libraries.is_some() {
|
||||||
|
reporter
|
||||||
|
.report_post_link_contracts_compilation_succeeded_event(
|
||||||
|
compiler.version().clone(),
|
||||||
|
compiler.path(),
|
||||||
|
true,
|
||||||
|
None,
|
||||||
|
cache_value.compiler_output.clone(),
|
||||||
|
)
|
||||||
|
.expect("Can't happen");
|
||||||
|
} else {
|
||||||
|
reporter
|
||||||
|
.report_pre_link_contracts_compilation_succeeded_event(
|
||||||
|
compiler.version().clone(),
|
||||||
|
compiler.path(),
|
||||||
|
true,
|
||||||
|
None,
|
||||||
|
cache_value.compiler_output.clone(),
|
||||||
|
)
|
||||||
|
.expect("Can't happen");
|
||||||
|
}
|
||||||
|
cache_value.compiler_output
|
||||||
|
}
|
||||||
|
None => {
|
||||||
|
compilation_callback()
|
||||||
|
.await
|
||||||
|
.context("Compilation callback failed (cache miss path)")?
|
||||||
|
.compiler_output
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
Ok(compiled_contracts)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn compile_contracts<P: Platform>(
|
||||||
|
metadata_directory: impl AsRef<Path>,
|
||||||
|
mut files_to_compile: impl Iterator<Item = PathBuf>,
|
||||||
|
mode: &Mode,
|
||||||
|
deployed_libraries: Option<&HashMap<ContractInstance, (ContractIdent, Address, JsonAbi)>>,
|
||||||
|
compiler: &P::Compiler,
|
||||||
|
reporter: &ExecutionSpecificReporter,
|
||||||
|
) -> Result<CompilerOutput> {
|
||||||
|
let all_sources_in_dir = FilesWithExtensionIterator::new(metadata_directory.as_ref())
|
||||||
|
.with_allowed_extension("sol")
|
||||||
|
.with_use_cached_fs(true)
|
||||||
|
.collect::<Vec<_>>();
|
||||||
|
|
||||||
|
let compilation = Compiler::new()
|
||||||
|
.with_allow_path(metadata_directory)
|
||||||
|
// Handling the modes
|
||||||
|
.with_optimization(mode.optimize_setting)
|
||||||
|
.with_pipeline(mode.pipeline)
|
||||||
|
// Adding the contract sources to the compiler.
|
||||||
|
.try_then(|compiler| {
|
||||||
|
files_to_compile.try_fold(compiler, |compiler, path| compiler.with_source(path))
|
||||||
|
})?
|
||||||
|
// Adding the deployed libraries to the compiler.
|
||||||
|
.then(|compiler| {
|
||||||
|
deployed_libraries
|
||||||
|
.iter()
|
||||||
|
.flat_map(|value| value.iter())
|
||||||
|
.map(|(instance, (ident, address, abi))| (instance, ident, address, abi))
|
||||||
|
.flat_map(|(_, ident, address, _)| {
|
||||||
|
all_sources_in_dir
|
||||||
|
.iter()
|
||||||
|
.map(move |path| (ident, address, path))
|
||||||
|
})
|
||||||
|
.fold(compiler, |compiler, (ident, address, path)| {
|
||||||
|
compiler.with_library(path, ident.as_str(), *address)
|
||||||
|
})
|
||||||
|
});
|
||||||
|
|
||||||
|
let input = compilation.input().clone();
|
||||||
|
let output = compilation.try_build(compiler).await;
|
||||||
|
|
||||||
|
match (output.as_ref(), deployed_libraries.is_some()) {
|
||||||
|
(Ok(output), true) => {
|
||||||
|
reporter
|
||||||
|
.report_post_link_contracts_compilation_succeeded_event(
|
||||||
|
compiler.version().clone(),
|
||||||
|
compiler.path(),
|
||||||
|
false,
|
||||||
|
input,
|
||||||
|
output.clone(),
|
||||||
|
)
|
||||||
|
.expect("Can't happen");
|
||||||
|
}
|
||||||
|
(Ok(output), false) => {
|
||||||
|
reporter
|
||||||
|
.report_pre_link_contracts_compilation_succeeded_event(
|
||||||
|
compiler.version().clone(),
|
||||||
|
compiler.path(),
|
||||||
|
false,
|
||||||
|
input,
|
||||||
|
output.clone(),
|
||||||
|
)
|
||||||
|
.expect("Can't happen");
|
||||||
|
}
|
||||||
|
(Err(err), true) => {
|
||||||
|
reporter
|
||||||
|
.report_post_link_contracts_compilation_failed_event(
|
||||||
|
compiler.version().clone(),
|
||||||
|
compiler.path().to_path_buf(),
|
||||||
|
input,
|
||||||
|
format!("{err:#}"),
|
||||||
|
)
|
||||||
|
.expect("Can't happen");
|
||||||
|
}
|
||||||
|
(Err(err), false) => {
|
||||||
|
reporter
|
||||||
|
.report_pre_link_contracts_compilation_failed_event(
|
||||||
|
compiler.version().clone(),
|
||||||
|
compiler.path().to_path_buf(),
|
||||||
|
input,
|
||||||
|
format!("{err:#}"),
|
||||||
|
)
|
||||||
|
.expect("Can't happen");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
output
|
||||||
|
}
|
||||||
|
|
||||||
|
struct ArtifactsCache {
|
||||||
|
path: PathBuf,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ArtifactsCache {
|
||||||
|
pub fn new(path: impl AsRef<Path>) -> Self {
|
||||||
|
Self {
|
||||||
|
path: path.as_ref().to_path_buf(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[instrument(level = "debug", skip_all, err)]
|
||||||
|
pub async fn with_invalidated_cache(self) -> Result<Self> {
|
||||||
|
cacache::clear(self.path.as_path())
|
||||||
|
.await
|
||||||
|
.map_err(Into::<Error>::into)
|
||||||
|
.with_context(|| format!("Failed to clear cache at {}", self.path.display()))?;
|
||||||
|
Ok(self)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[instrument(level = "debug", skip_all, err)]
|
||||||
|
pub async fn insert(&self, key: &CacheKey<'_>, value: &CacheValue) -> Result<()> {
|
||||||
|
let key = bson::to_vec(key).context("Failed to serialize cache key (bson)")?;
|
||||||
|
let value = bson::to_vec(value).context("Failed to serialize cache value (bson)")?;
|
||||||
|
cacache::write(self.path.as_path(), key.encode_hex(), value)
|
||||||
|
.await
|
||||||
|
.with_context(|| {
|
||||||
|
format!("Failed to write cache entry under {}", self.path.display())
|
||||||
|
})?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
pub async fn get(&self, key: &CacheKey<'_>) -> Option<CacheValue> {
|
||||||
|
let key = bson::to_vec(key).ok()?;
|
||||||
|
let value = cacache::read(self.path.as_path(), key.encode_hex())
|
||||||
|
.await
|
||||||
|
.ok()?;
|
||||||
|
let value = bson::from_slice::<CacheValue>(&value).ok()?;
|
||||||
|
Some(value)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[instrument(level = "debug", skip_all, err)]
|
||||||
|
pub async fn get_or_insert_with(
|
||||||
|
&self,
|
||||||
|
key: &CacheKey<'_>,
|
||||||
|
callback: impl AsyncFnOnce() -> Result<CacheValue>,
|
||||||
|
) -> Result<CacheValue> {
|
||||||
|
match self.get(key).await {
|
||||||
|
Some(value) => {
|
||||||
|
debug!("Cache hit");
|
||||||
|
Ok(value)
|
||||||
|
}
|
||||||
|
None => {
|
||||||
|
debug!("Cache miss");
|
||||||
|
let value = callback().await?;
|
||||||
|
self.insert(key, &value).await?;
|
||||||
|
Ok(value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize)]
|
||||||
|
struct CacheKey<'a> {
|
||||||
|
/// The platform name that this artifact was compiled for. For example, this could be EVM or
|
||||||
|
/// PVM.
|
||||||
|
platform_key: &'a TestingPlatform,
|
||||||
|
|
||||||
|
/// The version of the compiler that was used to compile the artifacts.
|
||||||
|
compiler_version: Version,
|
||||||
|
|
||||||
|
/// The path of the metadata file that the compilation artifacts are for.
|
||||||
|
metadata_file_path: &'a Path,
|
||||||
|
|
||||||
|
/// The mode that the compilation artifacts where compiled with.
|
||||||
|
solc_mode: Cow<'a, Mode>,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, Serialize, Deserialize)]
|
||||||
|
struct CacheValue {
|
||||||
|
/// The compiler output from the compilation run.
|
||||||
|
compiler_output: CompilerOutput,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl CacheValue {
|
||||||
|
pub fn new(compiler_output: CompilerOutput) -> Self {
|
||||||
|
Self { compiler_output }
|
||||||
|
}
|
||||||
|
}
|
||||||
+595
-782
File diff suppressed because it is too large
Load Diff
@@ -19,18 +19,18 @@ pub trait Platform {
|
|||||||
type Compiler: SolidityCompiler;
|
type Compiler: SolidityCompiler;
|
||||||
|
|
||||||
/// Returns the matching [TestingPlatform] of the [revive_dt_config::Arguments].
|
/// Returns the matching [TestingPlatform] of the [revive_dt_config::Arguments].
|
||||||
fn config_id() -> TestingPlatform;
|
fn config_id() -> &'static TestingPlatform;
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Default)]
|
#[derive(Default)]
|
||||||
pub struct Geth;
|
pub struct Geth;
|
||||||
|
|
||||||
impl Platform for Geth {
|
impl Platform for Geth {
|
||||||
type Blockchain = geth::Instance;
|
type Blockchain = geth::GethNode;
|
||||||
type Compiler = solc::Solc;
|
type Compiler = solc::Solc;
|
||||||
|
|
||||||
fn config_id() -> TestingPlatform {
|
fn config_id() -> &'static TestingPlatform {
|
||||||
TestingPlatform::Geth
|
&TestingPlatform::Geth
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -41,7 +41,7 @@ impl Platform for Kitchensink {
|
|||||||
type Blockchain = KitchensinkNode;
|
type Blockchain = KitchensinkNode;
|
||||||
type Compiler = revive_resolc::Resolc;
|
type Compiler = revive_resolc::Resolc;
|
||||||
|
|
||||||
fn config_id() -> TestingPlatform {
|
fn config_id() -> &'static TestingPlatform {
|
||||||
TestingPlatform::Kitchensink
|
&TestingPlatform::Kitchensink
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+769
-99
@@ -1,48 +1,122 @@
|
|||||||
use std::{collections::HashMap, sync::LazyLock};
|
mod cached_compiler;
|
||||||
|
|
||||||
|
use std::{
|
||||||
|
borrow::Cow,
|
||||||
|
collections::{BTreeMap, HashMap},
|
||||||
|
io::{BufWriter, Write, stderr},
|
||||||
|
path::Path,
|
||||||
|
sync::{Arc, LazyLock},
|
||||||
|
time::Instant,
|
||||||
|
};
|
||||||
|
|
||||||
|
use alloy::{
|
||||||
|
network::{Ethereum, TransactionBuilder},
|
||||||
|
rpc::types::TransactionRequest,
|
||||||
|
};
|
||||||
|
use anyhow::Context;
|
||||||
use clap::Parser;
|
use clap::Parser;
|
||||||
use rayon::{ThreadPoolBuilder, prelude::*};
|
use futures::stream;
|
||||||
|
use futures::{Stream, StreamExt};
|
||||||
|
use indexmap::{IndexMap, indexmap};
|
||||||
|
use revive_dt_node_interaction::EthereumNode;
|
||||||
|
use revive_dt_report::{
|
||||||
|
NodeDesignation, ReportAggregator, Reporter, ReporterEvent, TestCaseStatus,
|
||||||
|
TestSpecificReporter, TestSpecifier,
|
||||||
|
};
|
||||||
|
use serde_json::{Value, json};
|
||||||
|
use temp_dir::TempDir;
|
||||||
|
use tokio::try_join;
|
||||||
|
use tracing::{debug, error, info, info_span, instrument};
|
||||||
|
use tracing_appender::non_blocking::WorkerGuard;
|
||||||
|
use tracing_subscriber::{EnvFilter, FmtSubscriber};
|
||||||
|
|
||||||
|
use revive_dt_common::{iterators::EitherIter, types::Mode};
|
||||||
|
use revive_dt_compiler::{CompilerOutput, SolidityCompiler};
|
||||||
use revive_dt_config::*;
|
use revive_dt_config::*;
|
||||||
use revive_dt_core::{
|
use revive_dt_core::{
|
||||||
Geth, Kitchensink, Platform,
|
Geth, Kitchensink, Platform,
|
||||||
driver::{Driver, State},
|
driver::{CaseDriver, CaseState},
|
||||||
};
|
};
|
||||||
use revive_dt_format::{corpus::Corpus, metadata::MetadataFile};
|
use revive_dt_format::{
|
||||||
use revive_dt_node::pool::NodePool;
|
case::{Case, CaseIdx},
|
||||||
use revive_dt_report::reporter::{Report, Span};
|
corpus::Corpus,
|
||||||
use temp_dir::TempDir;
|
input::{Input, Step},
|
||||||
use tracing::Level;
|
metadata::{ContractPathAndIdent, MetadataFile},
|
||||||
use tracing_subscriber::{EnvFilter, FmtSubscriber};
|
mode::ParsedMode,
|
||||||
|
};
|
||||||
|
use revive_dt_node::{Node, pool::NodePool};
|
||||||
|
|
||||||
|
use crate::cached_compiler::CachedCompiler;
|
||||||
|
|
||||||
static TEMP_DIR: LazyLock<TempDir> = LazyLock::new(|| TempDir::new().unwrap());
|
static TEMP_DIR: LazyLock<TempDir> = LazyLock::new(|| TempDir::new().unwrap());
|
||||||
|
|
||||||
fn main() -> anyhow::Result<()> {
|
fn main() -> anyhow::Result<()> {
|
||||||
let args = init_cli()?;
|
let (args, _guard) = init_cli().context("Failed to initialize CLI and tracing subscriber")?;
|
||||||
|
info!(
|
||||||
|
leader = args.leader.to_string(),
|
||||||
|
follower = args.follower.to_string(),
|
||||||
|
working_directory = %args.directory().display(),
|
||||||
|
number_of_nodes = args.number_of_nodes,
|
||||||
|
invalidate_compilation_cache = args.invalidate_compilation_cache,
|
||||||
|
"Differential testing tool has been initialized"
|
||||||
|
);
|
||||||
|
|
||||||
for (corpus, tests) in collect_corpora(&args)? {
|
let (reporter, report_aggregator_task) = ReportAggregator::new(args.clone()).into_task();
|
||||||
let span = Span::new(corpus, args.clone())?;
|
|
||||||
|
|
||||||
match &args.compile_only {
|
let number_of_threads = args.number_of_threads;
|
||||||
Some(platform) => compile_corpus(&args, &tests, platform, span),
|
let body = async move {
|
||||||
None => execute_corpus(&args, &tests, span)?,
|
let tests = collect_corpora(&args)
|
||||||
}
|
.context("Failed to collect corpus files from provided arguments")?
|
||||||
|
.into_iter()
|
||||||
|
.inspect(|(corpus, _)| {
|
||||||
|
reporter
|
||||||
|
.report_corpus_file_discovery_event(corpus.clone())
|
||||||
|
.expect("Can't fail")
|
||||||
|
})
|
||||||
|
.flat_map(|(_, files)| files.into_iter())
|
||||||
|
.inspect(|metadata_file| {
|
||||||
|
reporter
|
||||||
|
.report_metadata_file_discovery_event(
|
||||||
|
metadata_file.metadata_file_path.clone(),
|
||||||
|
metadata_file.content.clone(),
|
||||||
|
)
|
||||||
|
.expect("Can't fail")
|
||||||
|
})
|
||||||
|
.collect::<Vec<_>>();
|
||||||
|
|
||||||
Report::save()?;
|
execute_corpus(&args, &tests, reporter, report_aggregator_task)
|
||||||
}
|
.await
|
||||||
|
.context("Failed to execute corpus")?;
|
||||||
|
Ok(())
|
||||||
|
};
|
||||||
|
|
||||||
Ok(())
|
tokio::runtime::Builder::new_multi_thread()
|
||||||
|
.worker_threads(number_of_threads)
|
||||||
|
.enable_all()
|
||||||
|
.build()
|
||||||
|
.expect("Failed building the Runtime")
|
||||||
|
.block_on(body)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn init_cli() -> anyhow::Result<Arguments> {
|
fn init_cli() -> anyhow::Result<(Arguments, WorkerGuard)> {
|
||||||
|
let (writer, guard) = tracing_appender::non_blocking::NonBlockingBuilder::default()
|
||||||
|
.lossy(false)
|
||||||
|
// Assuming that each line contains 255 characters and that each character is one byte, then
|
||||||
|
// this means that our buffer is about 4GBs large.
|
||||||
|
.buffered_lines_limit(0x1000000)
|
||||||
|
.thread_name("buffered writer")
|
||||||
|
.finish(std::io::stdout());
|
||||||
|
|
||||||
let subscriber = FmtSubscriber::builder()
|
let subscriber = FmtSubscriber::builder()
|
||||||
.with_thread_ids(true)
|
.with_writer(writer)
|
||||||
.with_thread_names(true)
|
.with_thread_ids(false)
|
||||||
|
.with_thread_names(false)
|
||||||
.with_env_filter(EnvFilter::from_default_env())
|
.with_env_filter(EnvFilter::from_default_env())
|
||||||
.with_ansi(false)
|
.with_ansi(false)
|
||||||
.pretty()
|
.pretty()
|
||||||
.finish();
|
.finish();
|
||||||
tracing::subscriber::set_global_default(subscriber)?;
|
tracing::subscriber::set_global_default(subscriber)?;
|
||||||
|
info!("Differential testing tool is starting");
|
||||||
|
|
||||||
let mut args = Arguments::parse();
|
let mut args = Arguments::parse();
|
||||||
|
|
||||||
@@ -60,94 +134,593 @@ fn init_cli() -> anyhow::Result<Arguments> {
|
|||||||
args.temp_dir = Some(&TEMP_DIR);
|
args.temp_dir = Some(&TEMP_DIR);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
tracing::info!("workdir: {}", args.directory().display());
|
|
||||||
|
|
||||||
ThreadPoolBuilder::new()
|
Ok((args, guard))
|
||||||
.num_threads(args.workers)
|
|
||||||
.build_global()?;
|
|
||||||
|
|
||||||
Ok(args)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
#[instrument(level = "debug", name = "Collecting Corpora", skip_all)]
|
||||||
fn collect_corpora(args: &Arguments) -> anyhow::Result<HashMap<Corpus, Vec<MetadataFile>>> {
|
fn collect_corpora(args: &Arguments) -> anyhow::Result<HashMap<Corpus, Vec<MetadataFile>>> {
|
||||||
let mut corpora = HashMap::new();
|
let mut corpora = HashMap::new();
|
||||||
|
|
||||||
for path in &args.corpus {
|
for path in &args.corpus {
|
||||||
|
let span = info_span!("Processing corpus file", path = %path.display());
|
||||||
|
let _guard = span.enter();
|
||||||
|
|
||||||
let corpus = Corpus::try_from_path(path)?;
|
let corpus = Corpus::try_from_path(path)?;
|
||||||
tracing::info!("found corpus: {}", path.display());
|
info!(
|
||||||
|
name = corpus.name(),
|
||||||
|
number_of_contained_paths = corpus.path_count(),
|
||||||
|
"Deserialized corpus file"
|
||||||
|
);
|
||||||
let tests = corpus.enumerate_tests();
|
let tests = corpus.enumerate_tests();
|
||||||
tracing::info!("corpus '{}' contains {} tests", &corpus.name, tests.len());
|
|
||||||
corpora.insert(corpus, tests);
|
corpora.insert(corpus, tests);
|
||||||
}
|
}
|
||||||
|
|
||||||
Ok(corpora)
|
Ok(corpora)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn run_driver<L, F>(args: &Arguments, tests: &[MetadataFile], span: Span) -> anyhow::Result<()>
|
async fn run_driver<L, F>(
|
||||||
|
args: &Arguments,
|
||||||
|
metadata_files: &[MetadataFile],
|
||||||
|
reporter: Reporter,
|
||||||
|
report_aggregator_task: impl Future<Output = anyhow::Result<()>>,
|
||||||
|
) -> anyhow::Result<()>
|
||||||
where
|
where
|
||||||
L: Platform,
|
L: Platform,
|
||||||
F: Platform,
|
F: Platform,
|
||||||
L::Blockchain: revive_dt_node::Node + Send + Sync + 'static,
|
L::Blockchain: revive_dt_node::Node + Send + Sync + 'static,
|
||||||
F::Blockchain: revive_dt_node::Node + Send + Sync + 'static,
|
F::Blockchain: revive_dt_node::Node + Send + Sync + 'static,
|
||||||
{
|
{
|
||||||
let leader_nodes = NodePool::<L::Blockchain>::new(args)?;
|
let leader_nodes =
|
||||||
let follower_nodes = NodePool::<F::Blockchain>::new(args)?;
|
NodePool::<L::Blockchain>::new(args).context("Failed to initialize leader node pool")?;
|
||||||
|
let follower_nodes =
|
||||||
|
NodePool::<F::Blockchain>::new(args).context("Failed to initialize follower node pool")?;
|
||||||
|
|
||||||
tests.par_iter().for_each(
|
let tests_stream = tests_stream(
|
||||||
|MetadataFile {
|
args,
|
||||||
content: metadata,
|
metadata_files.iter(),
|
||||||
path: metadata_file_path,
|
&leader_nodes,
|
||||||
}| {
|
&follower_nodes,
|
||||||
// Starting a new tracing span for this metadata file. This allows our logs to be clear
|
reporter.clone(),
|
||||||
// about which metadata file the logs belong to. We can add other information into this
|
)
|
||||||
// as well to be able to associate the logs with the correct metadata file and case
|
.await;
|
||||||
// that's being executed.
|
let driver_task = start_driver_task::<L, F>(args, tests_stream)
|
||||||
let tracing_span = tracing::span!(
|
.await
|
||||||
Level::INFO,
|
.context("Failed to start driver task")?;
|
||||||
"Running driver",
|
let cli_reporting_task = start_cli_reporting_task(reporter);
|
||||||
metadata_file_path = metadata_file_path.display().to_string(),
|
|
||||||
);
|
|
||||||
let _guard = tracing_span.enter();
|
|
||||||
|
|
||||||
let mut driver = Driver::<L, F>::new(
|
let (_, _, rtn) = tokio::join!(cli_reporting_task, driver_task, report_aggregator_task);
|
||||||
metadata,
|
rtn?;
|
||||||
args,
|
|
||||||
leader_nodes.round_robbin(),
|
|
||||||
follower_nodes.round_robbin(),
|
|
||||||
);
|
|
||||||
|
|
||||||
let execution_result = driver.execute(span);
|
|
||||||
tracing::info!(
|
|
||||||
case_success_count = execution_result.successful_cases_count,
|
|
||||||
case_failure_count = execution_result.failed_cases_count,
|
|
||||||
"Execution completed"
|
|
||||||
);
|
|
||||||
|
|
||||||
let mut error_count = 0;
|
|
||||||
for result in execution_result.results.iter() {
|
|
||||||
if !result.is_success() {
|
|
||||||
tracing::error!(execution_error = ?result, "Encountered an error");
|
|
||||||
error_count += 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
if error_count == 0 {
|
|
||||||
tracing::info!("Execution succeeded");
|
|
||||||
} else {
|
|
||||||
tracing::info!("Execution failed");
|
|
||||||
}
|
|
||||||
},
|
|
||||||
);
|
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
fn execute_corpus(args: &Arguments, tests: &[MetadataFile], span: Span) -> anyhow::Result<()> {
|
async fn tests_stream<'a, L, F>(
|
||||||
|
args: &Arguments,
|
||||||
|
metadata_files: impl IntoIterator<Item = &'a MetadataFile> + Clone,
|
||||||
|
leader_node_pool: &'a NodePool<L::Blockchain>,
|
||||||
|
follower_node_pool: &'a NodePool<F::Blockchain>,
|
||||||
|
reporter: Reporter,
|
||||||
|
) -> impl Stream<Item = Test<'a, L, F>>
|
||||||
|
where
|
||||||
|
L: Platform,
|
||||||
|
F: Platform,
|
||||||
|
L::Blockchain: revive_dt_node::Node + Send + Sync + 'static,
|
||||||
|
F::Blockchain: revive_dt_node::Node + Send + Sync + 'static,
|
||||||
|
{
|
||||||
|
let tests = metadata_files
|
||||||
|
.into_iter()
|
||||||
|
.flat_map(|metadata_file| {
|
||||||
|
metadata_file
|
||||||
|
.cases
|
||||||
|
.iter()
|
||||||
|
.enumerate()
|
||||||
|
.map(move |(case_idx, case)| (metadata_file, case_idx, case))
|
||||||
|
})
|
||||||
|
// Flatten over the modes, prefer the case modes over the metadata file modes.
|
||||||
|
.flat_map(|(metadata_file, case_idx, case)| {
|
||||||
|
let reporter = reporter.clone();
|
||||||
|
|
||||||
|
let modes = case.modes.as_ref().or(metadata_file.modes.as_ref());
|
||||||
|
let modes = match modes {
|
||||||
|
Some(modes) => EitherIter::A(
|
||||||
|
ParsedMode::many_to_modes(modes.iter()).map(Cow::<'static, _>::Owned),
|
||||||
|
),
|
||||||
|
None => EitherIter::B(Mode::all().map(Cow::<'static, _>::Borrowed)),
|
||||||
|
};
|
||||||
|
|
||||||
|
modes.into_iter().map(move |mode| {
|
||||||
|
(
|
||||||
|
metadata_file,
|
||||||
|
case_idx,
|
||||||
|
case,
|
||||||
|
mode.clone(),
|
||||||
|
reporter.test_specific_reporter(Arc::new(TestSpecifier {
|
||||||
|
solc_mode: mode.as_ref().clone(),
|
||||||
|
metadata_file_path: metadata_file.metadata_file_path.clone(),
|
||||||
|
case_idx: CaseIdx::new(case_idx),
|
||||||
|
})),
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
.collect::<Vec<_>>();
|
||||||
|
|
||||||
|
// Note: before we do any kind of filtering or process the iterator in any way, we need to
|
||||||
|
// inform the report aggregator of all of the cases that were found as it keeps a state of the
|
||||||
|
// test cases for its internal use.
|
||||||
|
for (_, _, _, _, reporter) in tests.iter() {
|
||||||
|
reporter
|
||||||
|
.report_test_case_discovery_event()
|
||||||
|
.expect("Can't fail")
|
||||||
|
}
|
||||||
|
|
||||||
|
stream::iter(tests.into_iter())
|
||||||
|
.filter_map(
|
||||||
|
move |(metadata_file, case_idx, case, mode, reporter)| async move {
|
||||||
|
let leader_compiler = <L::Compiler as SolidityCompiler>::new(
|
||||||
|
args,
|
||||||
|
mode.version.clone().map(Into::into),
|
||||||
|
)
|
||||||
|
.await
|
||||||
|
.inspect_err(|err| error!(?err, "Failed to instantiate the leader compiler"))
|
||||||
|
.ok()?;
|
||||||
|
|
||||||
|
let follower_compiler = <F::Compiler as SolidityCompiler>::new(
|
||||||
|
args,
|
||||||
|
mode.version.clone().map(Into::into),
|
||||||
|
)
|
||||||
|
.await
|
||||||
|
.inspect_err(|err| error!(?err, "Failed to instantiate the follower compiler"))
|
||||||
|
.ok()?;
|
||||||
|
|
||||||
|
let leader_node = leader_node_pool.round_robbin();
|
||||||
|
let follower_node = follower_node_pool.round_robbin();
|
||||||
|
|
||||||
|
Some(Test::<L, F> {
|
||||||
|
metadata: metadata_file,
|
||||||
|
metadata_file_path: metadata_file.metadata_file_path.as_path(),
|
||||||
|
mode: mode.clone(),
|
||||||
|
case_idx: CaseIdx::new(case_idx),
|
||||||
|
case,
|
||||||
|
leader_node,
|
||||||
|
follower_node,
|
||||||
|
leader_compiler,
|
||||||
|
follower_compiler,
|
||||||
|
reporter,
|
||||||
|
})
|
||||||
|
},
|
||||||
|
)
|
||||||
|
.filter_map(move |test| async move {
|
||||||
|
match test.check_compatibility() {
|
||||||
|
Ok(()) => Some(test),
|
||||||
|
Err((reason, additional_information)) => {
|
||||||
|
debug!(
|
||||||
|
metadata_file_path = %test.metadata.metadata_file_path.display(),
|
||||||
|
case_idx = %test.case_idx,
|
||||||
|
mode = %test.mode,
|
||||||
|
reason,
|
||||||
|
additional_information =
|
||||||
|
serde_json::to_string(&additional_information).unwrap(),
|
||||||
|
|
||||||
|
"Ignoring Test Case"
|
||||||
|
);
|
||||||
|
test.reporter
|
||||||
|
.report_test_ignored_event(
|
||||||
|
reason.to_string(),
|
||||||
|
additional_information
|
||||||
|
.into_iter()
|
||||||
|
.map(|(k, v)| (k.into(), v))
|
||||||
|
.collect::<IndexMap<_, _>>(),
|
||||||
|
)
|
||||||
|
.expect("Can't fail");
|
||||||
|
None
|
||||||
|
}
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn start_driver_task<'a, L, F>(
|
||||||
|
args: &Arguments,
|
||||||
|
tests: impl Stream<Item = Test<'a, L, F>>,
|
||||||
|
) -> anyhow::Result<impl Future<Output = ()>>
|
||||||
|
where
|
||||||
|
L: Platform,
|
||||||
|
F: Platform,
|
||||||
|
L::Blockchain: revive_dt_node::Node + Send + Sync + 'static,
|
||||||
|
F::Blockchain: revive_dt_node::Node + Send + Sync + 'static,
|
||||||
|
L::Compiler: 'a,
|
||||||
|
F::Compiler: 'a,
|
||||||
|
{
|
||||||
|
info!("Starting driver task");
|
||||||
|
|
||||||
|
let number_concurrent_tasks = args.number_of_concurrent_tasks();
|
||||||
|
let cached_compiler = Arc::new(
|
||||||
|
CachedCompiler::new(
|
||||||
|
args.directory().join("compilation_cache"),
|
||||||
|
args.invalidate_compilation_cache,
|
||||||
|
)
|
||||||
|
.await
|
||||||
|
.context("Failed to initialize cached compiler")?,
|
||||||
|
);
|
||||||
|
|
||||||
|
Ok(tests.for_each_concurrent(
|
||||||
|
// We want to limit the concurrent tasks here because:
|
||||||
|
//
|
||||||
|
// 1. We don't want to overwhelm the nodes with too many requests, leading to responses timing out.
|
||||||
|
// 2. We don't want to open too many files at once, leading to the OS running out of file descriptors.
|
||||||
|
//
|
||||||
|
// By default, we allow maximum of 10 ongoing requests per node in order to limit (1), and assume that
|
||||||
|
// this number will automatically be low enough to address (2). The user can override this.
|
||||||
|
Some(number_concurrent_tasks),
|
||||||
|
move |test| {
|
||||||
|
let cached_compiler = cached_compiler.clone();
|
||||||
|
|
||||||
|
async move {
|
||||||
|
test.reporter
|
||||||
|
.report_leader_node_assigned_event(
|
||||||
|
test.leader_node.id(),
|
||||||
|
*L::config_id(),
|
||||||
|
test.leader_node.connection_string(),
|
||||||
|
)
|
||||||
|
.expect("Can't fail");
|
||||||
|
test.reporter
|
||||||
|
.report_follower_node_assigned_event(
|
||||||
|
test.follower_node.id(),
|
||||||
|
*F::config_id(),
|
||||||
|
test.follower_node.connection_string(),
|
||||||
|
)
|
||||||
|
.expect("Can't fail");
|
||||||
|
|
||||||
|
let reporter = test.reporter.clone();
|
||||||
|
let result = handle_case_driver::<L, F>(test, cached_compiler).await;
|
||||||
|
|
||||||
|
match result {
|
||||||
|
Ok(steps_executed) => reporter
|
||||||
|
.report_test_succeeded_event(steps_executed)
|
||||||
|
.expect("Can't fail"),
|
||||||
|
Err(error) => reporter
|
||||||
|
.report_test_failed_event(format!("{error:#}"))
|
||||||
|
.expect("Can't fail"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
))
|
||||||
|
}
|
||||||
|
|
||||||
|
#[allow(clippy::uninlined_format_args)]
|
||||||
|
#[allow(irrefutable_let_patterns)]
|
||||||
|
async fn start_cli_reporting_task(reporter: Reporter) {
|
||||||
|
let mut aggregator_events_rx = reporter.subscribe().await.expect("Can't fail");
|
||||||
|
drop(reporter);
|
||||||
|
|
||||||
|
let start = Instant::now();
|
||||||
|
|
||||||
|
const GREEN: &str = "\x1B[32m";
|
||||||
|
const RED: &str = "\x1B[31m";
|
||||||
|
const GREY: &str = "\x1B[90m";
|
||||||
|
const COLOR_RESET: &str = "\x1B[0m";
|
||||||
|
const BOLD: &str = "\x1B[1m";
|
||||||
|
const BOLD_RESET: &str = "\x1B[22m";
|
||||||
|
|
||||||
|
let mut number_of_successes = 0;
|
||||||
|
let mut number_of_failures = 0;
|
||||||
|
|
||||||
|
let mut buf = BufWriter::new(stderr());
|
||||||
|
while let Ok(event) = aggregator_events_rx.recv().await {
|
||||||
|
let ReporterEvent::MetadataFileSolcModeCombinationExecutionCompleted {
|
||||||
|
metadata_file_path,
|
||||||
|
mode,
|
||||||
|
case_status,
|
||||||
|
} = event
|
||||||
|
else {
|
||||||
|
continue;
|
||||||
|
};
|
||||||
|
|
||||||
|
let _ = writeln!(buf, "{} - {}", mode, metadata_file_path.display());
|
||||||
|
for (case_idx, case_status) in case_status.into_iter() {
|
||||||
|
let _ = write!(buf, "\tCase Index {case_idx:>3}: ");
|
||||||
|
let _ = match case_status {
|
||||||
|
TestCaseStatus::Succeeded { steps_executed } => {
|
||||||
|
number_of_successes += 1;
|
||||||
|
writeln!(
|
||||||
|
buf,
|
||||||
|
"{}{}Case Succeeded{} - Steps Executed: {}{}",
|
||||||
|
GREEN, BOLD, BOLD_RESET, steps_executed, COLOR_RESET
|
||||||
|
)
|
||||||
|
}
|
||||||
|
TestCaseStatus::Failed { reason } => {
|
||||||
|
number_of_failures += 1;
|
||||||
|
writeln!(
|
||||||
|
buf,
|
||||||
|
"{}{}Case Failed{} - Reason: {}{}",
|
||||||
|
RED,
|
||||||
|
BOLD,
|
||||||
|
BOLD_RESET,
|
||||||
|
reason.trim(),
|
||||||
|
COLOR_RESET,
|
||||||
|
)
|
||||||
|
}
|
||||||
|
TestCaseStatus::Ignored { reason, .. } => writeln!(
|
||||||
|
buf,
|
||||||
|
"{}{}Case Ignored{} - Reason: {}{}",
|
||||||
|
GREY,
|
||||||
|
BOLD,
|
||||||
|
BOLD_RESET,
|
||||||
|
reason.trim(),
|
||||||
|
COLOR_RESET,
|
||||||
|
),
|
||||||
|
};
|
||||||
|
}
|
||||||
|
let _ = writeln!(buf);
|
||||||
|
}
|
||||||
|
|
||||||
|
// Summary at the end.
|
||||||
|
let _ = writeln!(
|
||||||
|
buf,
|
||||||
|
"{} cases: {}{}{} cases succeeded, {}{}{} cases failed in {} seconds",
|
||||||
|
number_of_successes + number_of_failures,
|
||||||
|
GREEN,
|
||||||
|
number_of_successes,
|
||||||
|
COLOR_RESET,
|
||||||
|
RED,
|
||||||
|
number_of_failures,
|
||||||
|
COLOR_RESET,
|
||||||
|
start.elapsed().as_secs()
|
||||||
|
);
|
||||||
|
}
|
||||||
|
|
||||||
|
#[allow(clippy::too_many_arguments)]
|
||||||
|
#[instrument(
|
||||||
|
level = "info",
|
||||||
|
name = "Handling Case"
|
||||||
|
skip_all,
|
||||||
|
fields(
|
||||||
|
metadata_file_path = %test.metadata.relative_path().display(),
|
||||||
|
mode = %test.mode,
|
||||||
|
case_idx = %test.case_idx,
|
||||||
|
case_name = test.case.name.as_deref().unwrap_or("Unnamed Case"),
|
||||||
|
leader_node = test.leader_node.id(),
|
||||||
|
follower_node = test.follower_node.id(),
|
||||||
|
)
|
||||||
|
)]
|
||||||
|
async fn handle_case_driver<'a, L, F>(
|
||||||
|
test: Test<'a, L, F>,
|
||||||
|
cached_compiler: Arc<CachedCompiler<'a>>,
|
||||||
|
) -> anyhow::Result<usize>
|
||||||
|
where
|
||||||
|
L: Platform,
|
||||||
|
F: Platform,
|
||||||
|
L::Blockchain: revive_dt_node::Node + Send + Sync + 'static,
|
||||||
|
F::Blockchain: revive_dt_node::Node + Send + Sync + 'static,
|
||||||
|
L::Compiler: 'a,
|
||||||
|
F::Compiler: 'a,
|
||||||
|
{
|
||||||
|
let leader_reporter = test
|
||||||
|
.reporter
|
||||||
|
.execution_specific_reporter(test.leader_node.id(), NodeDesignation::Leader);
|
||||||
|
let follower_reporter = test
|
||||||
|
.reporter
|
||||||
|
.execution_specific_reporter(test.follower_node.id(), NodeDesignation::Follower);
|
||||||
|
|
||||||
|
let (
|
||||||
|
CompilerOutput {
|
||||||
|
contracts: leader_pre_link_contracts,
|
||||||
|
},
|
||||||
|
CompilerOutput {
|
||||||
|
contracts: follower_pre_link_contracts,
|
||||||
|
},
|
||||||
|
) = try_join!(
|
||||||
|
cached_compiler.compile_contracts::<L>(
|
||||||
|
test.metadata,
|
||||||
|
test.metadata_file_path,
|
||||||
|
test.mode.clone(),
|
||||||
|
None,
|
||||||
|
&test.leader_compiler,
|
||||||
|
&leader_reporter,
|
||||||
|
),
|
||||||
|
cached_compiler.compile_contracts::<F>(
|
||||||
|
test.metadata,
|
||||||
|
test.metadata_file_path,
|
||||||
|
test.mode.clone(),
|
||||||
|
None,
|
||||||
|
&test.follower_compiler,
|
||||||
|
&follower_reporter
|
||||||
|
)
|
||||||
|
)
|
||||||
|
.context("Failed to compile pre-link contracts for leader/follower in parallel")?;
|
||||||
|
|
||||||
|
let mut leader_deployed_libraries = None::<HashMap<_, _>>;
|
||||||
|
let mut follower_deployed_libraries = None::<HashMap<_, _>>;
|
||||||
|
let mut contract_sources = test
|
||||||
|
.metadata
|
||||||
|
.contract_sources()
|
||||||
|
.context("Failed to retrieve contract sources from metadata")?;
|
||||||
|
for library_instance in test
|
||||||
|
.metadata
|
||||||
|
.libraries
|
||||||
|
.iter()
|
||||||
|
.flatten()
|
||||||
|
.flat_map(|(_, map)| map.values())
|
||||||
|
{
|
||||||
|
debug!(%library_instance, "Deploying Library Instance");
|
||||||
|
|
||||||
|
let ContractPathAndIdent {
|
||||||
|
contract_source_path: library_source_path,
|
||||||
|
contract_ident: library_ident,
|
||||||
|
} = contract_sources
|
||||||
|
.remove(library_instance)
|
||||||
|
.context("Failed to find the contract source")?;
|
||||||
|
|
||||||
|
let (leader_code, leader_abi) = leader_pre_link_contracts
|
||||||
|
.get(&library_source_path)
|
||||||
|
.and_then(|contracts| contracts.get(library_ident.as_str()))
|
||||||
|
.context("Declared library was not compiled")?;
|
||||||
|
let (follower_code, follower_abi) = follower_pre_link_contracts
|
||||||
|
.get(&library_source_path)
|
||||||
|
.and_then(|contracts| contracts.get(library_ident.as_str()))
|
||||||
|
.context("Declared library was not compiled")?;
|
||||||
|
|
||||||
|
let leader_code = match alloy::hex::decode(leader_code) {
|
||||||
|
Ok(code) => code,
|
||||||
|
Err(error) => {
|
||||||
|
anyhow::bail!("Failed to hex-decode the byte code {}", error)
|
||||||
|
}
|
||||||
|
};
|
||||||
|
let follower_code = match alloy::hex::decode(follower_code) {
|
||||||
|
Ok(code) => code,
|
||||||
|
Err(error) => {
|
||||||
|
anyhow::bail!("Failed to hex-decode the byte code {}", error)
|
||||||
|
}
|
||||||
|
};
|
||||||
|
|
||||||
|
// Getting the deployer address from the cases themselves. This is to ensure that we're
|
||||||
|
// doing the deployments from different accounts and therefore we're not slowed down by
|
||||||
|
// the nonce.
|
||||||
|
let deployer_address = test
|
||||||
|
.case
|
||||||
|
.steps
|
||||||
|
.iter()
|
||||||
|
.filter_map(|step| match step {
|
||||||
|
Step::FunctionCall(input) => Some(input.caller),
|
||||||
|
Step::BalanceAssertion(..) => None,
|
||||||
|
Step::StorageEmptyAssertion(..) => None,
|
||||||
|
})
|
||||||
|
.next()
|
||||||
|
.unwrap_or(Input::default_caller());
|
||||||
|
let leader_tx = TransactionBuilder::<Ethereum>::with_deploy_code(
|
||||||
|
TransactionRequest::default().from(deployer_address),
|
||||||
|
leader_code,
|
||||||
|
);
|
||||||
|
let follower_tx = TransactionBuilder::<Ethereum>::with_deploy_code(
|
||||||
|
TransactionRequest::default().from(deployer_address),
|
||||||
|
follower_code,
|
||||||
|
);
|
||||||
|
|
||||||
|
let (leader_receipt, follower_receipt) = try_join!(
|
||||||
|
test.leader_node.execute_transaction(leader_tx),
|
||||||
|
test.follower_node.execute_transaction(follower_tx)
|
||||||
|
)?;
|
||||||
|
|
||||||
|
debug!(
|
||||||
|
?library_instance,
|
||||||
|
library_address = ?leader_receipt.contract_address,
|
||||||
|
"Deployed library to leader"
|
||||||
|
);
|
||||||
|
debug!(
|
||||||
|
?library_instance,
|
||||||
|
library_address = ?follower_receipt.contract_address,
|
||||||
|
"Deployed library to follower"
|
||||||
|
);
|
||||||
|
|
||||||
|
let leader_library_address = leader_receipt
|
||||||
|
.contract_address
|
||||||
|
.context("Contract deployment didn't return an address")?;
|
||||||
|
let follower_library_address = follower_receipt
|
||||||
|
.contract_address
|
||||||
|
.context("Contract deployment didn't return an address")?;
|
||||||
|
|
||||||
|
leader_deployed_libraries.get_or_insert_default().insert(
|
||||||
|
library_instance.clone(),
|
||||||
|
(
|
||||||
|
library_ident.clone(),
|
||||||
|
leader_library_address,
|
||||||
|
leader_abi.clone(),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
follower_deployed_libraries.get_or_insert_default().insert(
|
||||||
|
library_instance.clone(),
|
||||||
|
(
|
||||||
|
library_ident,
|
||||||
|
follower_library_address,
|
||||||
|
follower_abi.clone(),
|
||||||
|
),
|
||||||
|
);
|
||||||
|
}
|
||||||
|
if let Some(ref leader_deployed_libraries) = leader_deployed_libraries {
|
||||||
|
leader_reporter.report_libraries_deployed_event(
|
||||||
|
leader_deployed_libraries
|
||||||
|
.clone()
|
||||||
|
.into_iter()
|
||||||
|
.map(|(key, (_, address, _))| (key, address))
|
||||||
|
.collect::<BTreeMap<_, _>>(),
|
||||||
|
)?;
|
||||||
|
}
|
||||||
|
if let Some(ref follower_deployed_libraries) = follower_deployed_libraries {
|
||||||
|
follower_reporter.report_libraries_deployed_event(
|
||||||
|
follower_deployed_libraries
|
||||||
|
.clone()
|
||||||
|
.into_iter()
|
||||||
|
.map(|(key, (_, address, _))| (key, address))
|
||||||
|
.collect::<BTreeMap<_, _>>(),
|
||||||
|
)?;
|
||||||
|
}
|
||||||
|
|
||||||
|
let (
|
||||||
|
CompilerOutput {
|
||||||
|
contracts: leader_post_link_contracts,
|
||||||
|
},
|
||||||
|
CompilerOutput {
|
||||||
|
contracts: follower_post_link_contracts,
|
||||||
|
},
|
||||||
|
) = try_join!(
|
||||||
|
cached_compiler.compile_contracts::<L>(
|
||||||
|
test.metadata,
|
||||||
|
test.metadata_file_path,
|
||||||
|
test.mode.clone(),
|
||||||
|
leader_deployed_libraries.as_ref(),
|
||||||
|
&test.leader_compiler,
|
||||||
|
&leader_reporter,
|
||||||
|
),
|
||||||
|
cached_compiler.compile_contracts::<F>(
|
||||||
|
test.metadata,
|
||||||
|
test.metadata_file_path,
|
||||||
|
test.mode.clone(),
|
||||||
|
follower_deployed_libraries.as_ref(),
|
||||||
|
&test.follower_compiler,
|
||||||
|
&follower_reporter
|
||||||
|
)
|
||||||
|
)
|
||||||
|
.context("Failed to compile post-link contracts for leader/follower in parallel")?;
|
||||||
|
|
||||||
|
let leader_state = CaseState::<L>::new(
|
||||||
|
test.leader_compiler.version().clone(),
|
||||||
|
leader_post_link_contracts,
|
||||||
|
leader_deployed_libraries.unwrap_or_default(),
|
||||||
|
leader_reporter,
|
||||||
|
);
|
||||||
|
let follower_state = CaseState::<F>::new(
|
||||||
|
test.follower_compiler.version().clone(),
|
||||||
|
follower_post_link_contracts,
|
||||||
|
follower_deployed_libraries.unwrap_or_default(),
|
||||||
|
follower_reporter,
|
||||||
|
);
|
||||||
|
|
||||||
|
let mut driver = CaseDriver::<L, F>::new(
|
||||||
|
test.metadata,
|
||||||
|
test.case,
|
||||||
|
test.leader_node,
|
||||||
|
test.follower_node,
|
||||||
|
leader_state,
|
||||||
|
follower_state,
|
||||||
|
);
|
||||||
|
driver
|
||||||
|
.execute()
|
||||||
|
.await
|
||||||
|
.inspect(|steps_executed| info!(steps_executed, "Case succeeded"))
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn execute_corpus(
|
||||||
|
args: &Arguments,
|
||||||
|
tests: &[MetadataFile],
|
||||||
|
reporter: Reporter,
|
||||||
|
report_aggregator_task: impl Future<Output = anyhow::Result<()>>,
|
||||||
|
) -> anyhow::Result<()> {
|
||||||
match (&args.leader, &args.follower) {
|
match (&args.leader, &args.follower) {
|
||||||
(TestingPlatform::Geth, TestingPlatform::Kitchensink) => {
|
(TestingPlatform::Geth, TestingPlatform::Kitchensink) => {
|
||||||
run_driver::<Geth, Kitchensink>(args, tests, span)?
|
run_driver::<Geth, Kitchensink>(args, tests, reporter, report_aggregator_task).await?
|
||||||
}
|
}
|
||||||
(TestingPlatform::Geth, TestingPlatform::Geth) => {
|
(TestingPlatform::Geth, TestingPlatform::Geth) => {
|
||||||
run_driver::<Geth, Geth>(args, tests, span)?
|
run_driver::<Geth, Geth>(args, tests, reporter, report_aggregator_task).await?
|
||||||
}
|
}
|
||||||
_ => unimplemented!(),
|
_ => unimplemented!(),
|
||||||
}
|
}
|
||||||
@@ -155,24 +728,121 @@ fn execute_corpus(args: &Arguments, tests: &[MetadataFile], span: Span) -> anyho
|
|||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
fn compile_corpus(
|
/// this represents a single "test"; a mode, path and collection of cases.
|
||||||
config: &Arguments,
|
#[derive(Clone)]
|
||||||
tests: &[MetadataFile],
|
struct Test<'a, L: Platform, F: Platform> {
|
||||||
platform: &TestingPlatform,
|
metadata: &'a MetadataFile,
|
||||||
span: Span,
|
metadata_file_path: &'a Path,
|
||||||
) {
|
mode: Cow<'a, Mode>,
|
||||||
tests.par_iter().for_each(|metadata| {
|
case_idx: CaseIdx,
|
||||||
for mode in &metadata.solc_modes() {
|
case: &'a Case,
|
||||||
match platform {
|
leader_node: &'a <L as Platform>::Blockchain,
|
||||||
TestingPlatform::Geth => {
|
follower_node: &'a <F as Platform>::Blockchain,
|
||||||
let mut state = State::<Geth>::new(config, span);
|
leader_compiler: L::Compiler,
|
||||||
let _ = state.build_contracts(mode, metadata);
|
follower_compiler: F::Compiler,
|
||||||
}
|
reporter: TestSpecificReporter,
|
||||||
TestingPlatform::Kitchensink => {
|
|
||||||
let mut state = State::<Kitchensink>::new(config, span);
|
|
||||||
let _ = state.build_contracts(mode, metadata);
|
|
||||||
}
|
|
||||||
};
|
|
||||||
}
|
|
||||||
});
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
impl<'a, L: Platform, F: Platform> Test<'a, L, F> {
|
||||||
|
/// Checks if this test can be ran with the current configuration.
|
||||||
|
pub fn check_compatibility(&self) -> TestCheckFunctionResult {
|
||||||
|
self.check_metadata_file_ignored()?;
|
||||||
|
self.check_case_file_ignored()?;
|
||||||
|
self.check_target_compatibility()?;
|
||||||
|
self.check_evm_version_compatibility()?;
|
||||||
|
self.check_compiler_compatibility()?;
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Checks if the metadata file is ignored or not.
|
||||||
|
fn check_metadata_file_ignored(&self) -> TestCheckFunctionResult {
|
||||||
|
if self.metadata.ignore.is_some_and(|ignore| ignore) {
|
||||||
|
Err(("Metadata file is ignored.", indexmap! {}))
|
||||||
|
} else {
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Checks if the case file is ignored or not.
|
||||||
|
fn check_case_file_ignored(&self) -> TestCheckFunctionResult {
|
||||||
|
if self.case.ignore.is_some_and(|ignore| ignore) {
|
||||||
|
Err(("Case is ignored.", indexmap! {}))
|
||||||
|
} else {
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Checks if the leader and the follower both support the desired targets in the metadata file.
|
||||||
|
fn check_target_compatibility(&self) -> TestCheckFunctionResult {
|
||||||
|
let leader_support =
|
||||||
|
<L::Blockchain as Node>::matches_target(self.metadata.targets.as_deref());
|
||||||
|
let follower_support =
|
||||||
|
<F::Blockchain as Node>::matches_target(self.metadata.targets.as_deref());
|
||||||
|
let is_allowed = leader_support && follower_support;
|
||||||
|
|
||||||
|
if is_allowed {
|
||||||
|
Ok(())
|
||||||
|
} else {
|
||||||
|
Err((
|
||||||
|
"Either the leader or the follower do not support the target desired by the test.",
|
||||||
|
indexmap! {
|
||||||
|
"test_desired_targets" => json!(self.metadata.targets.as_ref()),
|
||||||
|
"leader_support" => json!(leader_support),
|
||||||
|
"follower_support" => json!(follower_support),
|
||||||
|
},
|
||||||
|
))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// Checks for the compatibility of the EVM version with the leader and follower nodes.
|
||||||
|
fn check_evm_version_compatibility(&self) -> TestCheckFunctionResult {
|
||||||
|
let Some(evm_version_requirement) = self.metadata.required_evm_version else {
|
||||||
|
return Ok(());
|
||||||
|
};
|
||||||
|
|
||||||
|
let leader_support = evm_version_requirement
|
||||||
|
.matches(&<L::Blockchain as revive_dt_node::Node>::evm_version());
|
||||||
|
let follower_support = evm_version_requirement
|
||||||
|
.matches(&<F::Blockchain as revive_dt_node::Node>::evm_version());
|
||||||
|
let is_allowed = leader_support && follower_support;
|
||||||
|
|
||||||
|
if is_allowed {
|
||||||
|
Ok(())
|
||||||
|
} else {
|
||||||
|
Err((
|
||||||
|
"EVM version is incompatible with either the leader or the follower.",
|
||||||
|
indexmap! {
|
||||||
|
"test_desired_evm_version" => json!(self.metadata.required_evm_version),
|
||||||
|
"leader_support" => json!(leader_support),
|
||||||
|
"follower_support" => json!(follower_support),
|
||||||
|
},
|
||||||
|
))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Checks if the leader and follower compilers support the mode that the test is for.
|
||||||
|
fn check_compiler_compatibility(&self) -> TestCheckFunctionResult {
|
||||||
|
let leader_support = self
|
||||||
|
.leader_compiler
|
||||||
|
.supports_mode(self.mode.optimize_setting, self.mode.pipeline);
|
||||||
|
let follower_support = self
|
||||||
|
.follower_compiler
|
||||||
|
.supports_mode(self.mode.optimize_setting, self.mode.pipeline);
|
||||||
|
let is_allowed = leader_support && follower_support;
|
||||||
|
|
||||||
|
if is_allowed {
|
||||||
|
Ok(())
|
||||||
|
} else {
|
||||||
|
Err((
|
||||||
|
"Compilers do not support this mode either for the leader or for the follower.",
|
||||||
|
indexmap! {
|
||||||
|
"mode" => json!(self.mode),
|
||||||
|
"leader_support" => json!(leader_support),
|
||||||
|
"follower_support" => json!(follower_support),
|
||||||
|
},
|
||||||
|
))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
type TestCheckFunctionResult = Result<(), (&'static str, IndexMap<&'static str, Value>)>;
|
||||||
|
|||||||
@@ -11,11 +11,21 @@ rust-version.workspace = true
|
|||||||
[dependencies]
|
[dependencies]
|
||||||
revive-dt-common = { workspace = true }
|
revive-dt-common = { workspace = true }
|
||||||
|
|
||||||
|
revive-common = { workspace = true }
|
||||||
|
|
||||||
alloy = { workspace = true }
|
alloy = { workspace = true }
|
||||||
alloy-primitives = { workspace = true }
|
alloy-primitives = { workspace = true }
|
||||||
alloy-sol-types = { workspace = true }
|
alloy-sol-types = { workspace = true }
|
||||||
anyhow = { workspace = true }
|
anyhow = { workspace = true }
|
||||||
|
futures = { workspace = true }
|
||||||
|
regex = { workspace = true }
|
||||||
tracing = { workspace = true }
|
tracing = { workspace = true }
|
||||||
semver = { workspace = true }
|
semver = { workspace = true }
|
||||||
serde = { workspace = true, features = ["derive"] }
|
serde = { workspace = true, features = ["derive"] }
|
||||||
serde_json = { workspace = true }
|
serde_json = { workspace = true }
|
||||||
|
|
||||||
|
[dev-dependencies]
|
||||||
|
tokio = { workspace = true }
|
||||||
|
|
||||||
|
[lints]
|
||||||
|
workspace = true
|
||||||
|
|||||||
+43
-16
@@ -1,31 +1,50 @@
|
|||||||
use serde::Deserialize;
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
use revive_dt_common::macros::define_wrapper_type;
|
use revive_dt_common::{macros::define_wrapper_type, types::Mode};
|
||||||
|
|
||||||
use crate::{
|
use crate::{
|
||||||
input::{Expected, Input},
|
input::{Expected, Step},
|
||||||
mode::Mode,
|
mode::ParsedMode,
|
||||||
};
|
};
|
||||||
|
|
||||||
#[derive(Debug, Default, Deserialize, Clone, Eq, PartialEq)]
|
#[derive(Debug, Default, Serialize, Deserialize, Clone, Eq, PartialEq)]
|
||||||
pub struct Case {
|
pub struct Case {
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
pub name: Option<String>,
|
pub name: Option<String>,
|
||||||
|
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
pub comment: Option<String>,
|
pub comment: Option<String>,
|
||||||
pub modes: Option<Vec<Mode>>,
|
|
||||||
pub inputs: Vec<Input>,
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub modes: Option<Vec<ParsedMode>>,
|
||||||
|
|
||||||
|
#[serde(rename = "inputs")]
|
||||||
|
pub steps: Vec<Step>,
|
||||||
|
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
pub group: Option<String>,
|
pub group: Option<String>,
|
||||||
|
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
pub expected: Option<Expected>,
|
pub expected: Option<Expected>,
|
||||||
|
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub ignore: Option<bool>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Case {
|
impl Case {
|
||||||
pub fn inputs_iterator(&self) -> impl Iterator<Item = Input> {
|
#[allow(irrefutable_let_patterns)]
|
||||||
let inputs_len = self.inputs.len();
|
pub fn steps_iterator(&self) -> impl Iterator<Item = Step> {
|
||||||
self.inputs
|
let steps_len = self.steps.len();
|
||||||
|
self.steps
|
||||||
.clone()
|
.clone()
|
||||||
.into_iter()
|
.into_iter()
|
||||||
.enumerate()
|
.enumerate()
|
||||||
.map(move |(idx, mut input)| {
|
.map(move |(idx, mut step)| {
|
||||||
if idx + 1 == inputs_len {
|
let Step::FunctionCall(ref mut input) = step else {
|
||||||
|
return step;
|
||||||
|
};
|
||||||
|
|
||||||
|
if idx + 1 == steps_len {
|
||||||
if input.expected.is_none() {
|
if input.expected.is_none() {
|
||||||
input.expected = self.expected.clone();
|
input.expected = self.expected.clone();
|
||||||
}
|
}
|
||||||
@@ -35,16 +54,24 @@ impl Case {
|
|||||||
// the case? What are we supposed to do with that final expected field on the
|
// the case? What are we supposed to do with that final expected field on the
|
||||||
// case?
|
// case?
|
||||||
|
|
||||||
input
|
step
|
||||||
} else {
|
} else {
|
||||||
input
|
step
|
||||||
}
|
}
|
||||||
})
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn solc_modes(&self) -> Vec<Mode> {
|
||||||
|
match &self.modes {
|
||||||
|
Some(modes) => ParsedMode::many_to_modes(modes.iter()).collect(),
|
||||||
|
None => Mode::all().cloned().collect(),
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
define_wrapper_type!(
|
define_wrapper_type!(
|
||||||
/// A wrapper type for the index of test cases found in metadata file.
|
/// A wrapper type for the index of test cases found in metadata file.
|
||||||
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
|
||||||
pub struct CaseIdx(usize);
|
#[serde(transparent)]
|
||||||
|
pub struct CaseIdx(usize) impl Display, FromStr;
|
||||||
);
|
);
|
||||||
|
|||||||
+107
-43
@@ -3,65 +3,129 @@ use std::{
|
|||||||
path::{Path, PathBuf},
|
path::{Path, PathBuf},
|
||||||
};
|
};
|
||||||
|
|
||||||
|
use revive_dt_common::iterators::FilesWithExtensionIterator;
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
|
use tracing::{debug, info};
|
||||||
|
|
||||||
use crate::metadata::MetadataFile;
|
use crate::metadata::{Metadata, MetadataFile};
|
||||||
|
use anyhow::Context as _;
|
||||||
|
|
||||||
#[derive(Clone, Debug, Default, Serialize, Deserialize, Eq, PartialEq, Hash)]
|
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
|
||||||
pub struct Corpus {
|
#[serde(untagged)]
|
||||||
pub name: String,
|
pub enum Corpus {
|
||||||
pub path: PathBuf,
|
SinglePath { name: String, path: PathBuf },
|
||||||
|
MultiplePaths { name: String, paths: Vec<PathBuf> },
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Corpus {
|
impl Corpus {
|
||||||
/// Try to read and parse the corpus definition file at given `path`.
|
pub fn try_from_path(file_path: impl AsRef<Path>) -> anyhow::Result<Self> {
|
||||||
pub fn try_from_path(path: &Path) -> anyhow::Result<Self> {
|
let mut corpus = File::open(file_path.as_ref())
|
||||||
let file = File::open(path)?;
|
.map_err(anyhow::Error::from)
|
||||||
Ok(serde_json::from_reader(file)?)
|
.and_then(|file| serde_json::from_reader::<_, Corpus>(file).map_err(Into::into))
|
||||||
|
.with_context(|| {
|
||||||
|
format!(
|
||||||
|
"Failed to open and deserialize corpus file at {}",
|
||||||
|
file_path.as_ref().display()
|
||||||
|
)
|
||||||
|
})?;
|
||||||
|
|
||||||
|
let corpus_directory = file_path
|
||||||
|
.as_ref()
|
||||||
|
.canonicalize()
|
||||||
|
.context("Failed to canonicalize the path to the corpus file")?
|
||||||
|
.parent()
|
||||||
|
.context("Corpus file has no parent")?
|
||||||
|
.to_path_buf();
|
||||||
|
|
||||||
|
for path in corpus.paths_iter_mut() {
|
||||||
|
*path = corpus_directory.join(path.as_path())
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(corpus)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Scan the corpus base directory and return all tests found.
|
|
||||||
pub fn enumerate_tests(&self) -> Vec<MetadataFile> {
|
pub fn enumerate_tests(&self) -> Vec<MetadataFile> {
|
||||||
let mut tests = Vec::new();
|
let mut tests = self
|
||||||
collect_metadata(&self.path, &mut tests);
|
.paths_iter()
|
||||||
|
.flat_map(|root_path| {
|
||||||
|
if !root_path.is_dir() {
|
||||||
|
Box::new(std::iter::once(root_path.to_path_buf()))
|
||||||
|
as Box<dyn Iterator<Item = _>>
|
||||||
|
} else {
|
||||||
|
Box::new(
|
||||||
|
FilesWithExtensionIterator::new(root_path)
|
||||||
|
.with_use_cached_fs(true)
|
||||||
|
.with_allowed_extension("sol")
|
||||||
|
.with_allowed_extension("json"),
|
||||||
|
)
|
||||||
|
}
|
||||||
|
.map(move |metadata_file_path| (root_path, metadata_file_path))
|
||||||
|
})
|
||||||
|
.filter_map(|(root_path, metadata_file_path)| {
|
||||||
|
Metadata::try_from_file(&metadata_file_path)
|
||||||
|
.or_else(|| {
|
||||||
|
debug!(
|
||||||
|
discovered_from = %root_path.display(),
|
||||||
|
metadata_file_path = %metadata_file_path.display(),
|
||||||
|
"Skipping file since it doesn't contain valid metadata"
|
||||||
|
);
|
||||||
|
None
|
||||||
|
})
|
||||||
|
.map(|metadata| MetadataFile {
|
||||||
|
metadata_file_path,
|
||||||
|
corpus_file_path: root_path.to_path_buf(),
|
||||||
|
content: metadata,
|
||||||
|
})
|
||||||
|
.inspect(|metadata_file| {
|
||||||
|
debug!(
|
||||||
|
metadata_file_path = %metadata_file.relative_path().display(),
|
||||||
|
"Loaded metadata file"
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
.collect::<Vec<_>>();
|
||||||
|
tests.sort_by(|a, b| a.metadata_file_path.cmp(&b.metadata_file_path));
|
||||||
|
tests.dedup_by(|a, b| a.metadata_file_path == b.metadata_file_path);
|
||||||
|
info!(
|
||||||
|
len = tests.len(),
|
||||||
|
corpus_name = self.name(),
|
||||||
|
"Found tests in Corpus"
|
||||||
|
);
|
||||||
tests
|
tests
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
/// Recursively walks `path` and parses any JSON or Solidity file into a test
|
pub fn name(&self) -> &str {
|
||||||
/// definition [Metadata].
|
match self {
|
||||||
///
|
Corpus::SinglePath { name, .. } | Corpus::MultiplePaths { name, .. } => name.as_str(),
|
||||||
/// Found tests are inserted into `tests`.
|
|
||||||
///
|
|
||||||
/// `path` is expected to be a directory.
|
|
||||||
pub fn collect_metadata(path: &Path, tests: &mut Vec<MetadataFile>) {
|
|
||||||
let dir_entry = match std::fs::read_dir(path) {
|
|
||||||
Ok(dir_entry) => dir_entry,
|
|
||||||
Err(error) => {
|
|
||||||
tracing::error!("failed to read dir '{}': {error}", path.display());
|
|
||||||
return;
|
|
||||||
}
|
}
|
||||||
};
|
}
|
||||||
|
|
||||||
for entry in dir_entry {
|
pub fn paths_iter(&self) -> impl Iterator<Item = &Path> {
|
||||||
let entry = match entry {
|
match self {
|
||||||
Ok(entry) => entry,
|
Corpus::SinglePath { path, .. } => {
|
||||||
Err(error) => {
|
Box::new(std::iter::once(path.as_path())) as Box<dyn Iterator<Item = _>>
|
||||||
tracing::error!("error reading dir entry: {error}");
|
|
||||||
continue;
|
|
||||||
}
|
}
|
||||||
};
|
Corpus::MultiplePaths { paths, .. } => {
|
||||||
|
Box::new(paths.iter().map(|path| path.as_path())) as Box<dyn Iterator<Item = _>>
|
||||||
let path = entry.path();
|
|
||||||
if path.is_dir() {
|
|
||||||
collect_metadata(&path, tests);
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
if path.is_file() {
|
|
||||||
if let Some(metadata) = MetadataFile::try_from_file(&path) {
|
|
||||||
tests.push(metadata)
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
pub fn paths_iter_mut(&mut self) -> impl Iterator<Item = &mut PathBuf> {
|
||||||
|
match self {
|
||||||
|
Corpus::SinglePath { path, .. } => {
|
||||||
|
Box::new(std::iter::once(path)) as Box<dyn Iterator<Item = _>>
|
||||||
|
}
|
||||||
|
Corpus::MultiplePaths { paths, .. } => {
|
||||||
|
Box::new(paths.iter_mut()) as Box<dyn Iterator<Item = _>>
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn path_count(&self) -> usize {
|
||||||
|
match self {
|
||||||
|
Corpus::SinglePath { .. } => 1,
|
||||||
|
Corpus::MultiplePaths { paths, .. } => paths.len(),
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+453
-227
File diff suppressed because it is too large
Load Diff
+285
-86
@@ -1,7 +1,8 @@
|
|||||||
use std::{
|
use std::{
|
||||||
|
cmp::Ordering,
|
||||||
collections::BTreeMap,
|
collections::BTreeMap,
|
||||||
fmt::Display,
|
fmt::Display,
|
||||||
fs::{File, read_to_string},
|
fs::File,
|
||||||
ops::Deref,
|
ops::Deref,
|
||||||
path::{Path, PathBuf},
|
path::{Path, PathBuf},
|
||||||
str::FromStr,
|
str::FromStr,
|
||||||
@@ -9,12 +10,14 @@ use std::{
|
|||||||
|
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
use revive_dt_common::macros::define_wrapper_type;
|
use revive_common::EVMVersion;
|
||||||
|
use revive_dt_common::{
|
||||||
use crate::{
|
cached_fs::read_to_string, iterators::FilesWithExtensionIterator, macros::define_wrapper_type,
|
||||||
case::Case,
|
types::Mode,
|
||||||
mode::{Mode, SolcMode},
|
|
||||||
};
|
};
|
||||||
|
use tracing::error;
|
||||||
|
|
||||||
|
use crate::{case::Case, mode::ParsedMode};
|
||||||
|
|
||||||
pub const METADATA_FILE_EXTENSION: &str = "json";
|
pub const METADATA_FILE_EXTENSION: &str = "json";
|
||||||
pub const SOLIDITY_CASE_FILE_EXTENSION: &str = "sol";
|
pub const SOLIDITY_CASE_FILE_EXTENSION: &str = "sol";
|
||||||
@@ -22,16 +25,26 @@ pub const SOLIDITY_CASE_COMMENT_MARKER: &str = "//!";
|
|||||||
|
|
||||||
#[derive(Debug, Default, Deserialize, Clone, Eq, PartialEq)]
|
#[derive(Debug, Default, Deserialize, Clone, Eq, PartialEq)]
|
||||||
pub struct MetadataFile {
|
pub struct MetadataFile {
|
||||||
pub path: PathBuf,
|
/// The path of the metadata file. This will either be a JSON or solidity file.
|
||||||
|
pub metadata_file_path: PathBuf,
|
||||||
|
|
||||||
|
/// This is the path contained within the corpus file. This could either be the path of some dir
|
||||||
|
/// or could be the actual metadata file path.
|
||||||
|
pub corpus_file_path: PathBuf,
|
||||||
|
|
||||||
|
/// The metadata contained within the file.
|
||||||
pub content: Metadata,
|
pub content: Metadata,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl MetadataFile {
|
impl MetadataFile {
|
||||||
pub fn try_from_file(path: &Path) -> Option<Self> {
|
pub fn relative_path(&self) -> &Path {
|
||||||
Metadata::try_from_file(path).map(|metadata| Self {
|
if self.corpus_file_path.is_file() {
|
||||||
path: path.to_owned(),
|
&self.corpus_file_path
|
||||||
content: metadata,
|
} else {
|
||||||
})
|
self.metadata_file_path
|
||||||
|
.strip_prefix(&self.corpus_file_path)
|
||||||
|
.unwrap()
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -43,34 +56,51 @@ impl Deref for MetadataFile {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[derive(Debug, Default, Deserialize, Clone, Eq, PartialEq)]
|
#[derive(Debug, Default, Serialize, Deserialize, Clone, Eq, PartialEq)]
|
||||||
pub struct Metadata {
|
pub struct Metadata {
|
||||||
pub targets: Option<Vec<String>>,
|
/// A comment on the test case that's added for human-readability.
|
||||||
pub cases: Vec<Case>,
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
pub contracts: Option<BTreeMap<ContractInstance, ContractPathAndIdentifier>>,
|
pub comment: Option<String>,
|
||||||
// TODO: Convert into wrapper types for clarity.
|
|
||||||
pub libraries: Option<BTreeMap<String, BTreeMap<String, String>>>,
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
pub ignore: Option<bool>,
|
pub ignore: Option<bool>,
|
||||||
pub modes: Option<Vec<Mode>>,
|
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub targets: Option<Vec<String>>,
|
||||||
|
|
||||||
|
pub cases: Vec<Case>,
|
||||||
|
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub contracts: Option<BTreeMap<ContractInstance, ContractPathAndIdent>>,
|
||||||
|
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub libraries: Option<BTreeMap<PathBuf, BTreeMap<ContractIdent, ContractInstance>>>,
|
||||||
|
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub modes: Option<Vec<ParsedMode>>,
|
||||||
|
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
pub file_path: Option<PathBuf>,
|
pub file_path: Option<PathBuf>,
|
||||||
|
|
||||||
|
/// This field specifies an EVM version requirement that the test case has where the test might
|
||||||
|
/// be run of the evm version of the nodes match the evm version specified here.
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub required_evm_version: Option<EvmVersionRequirement>,
|
||||||
|
|
||||||
|
/// A set of compilation directives that will be passed to the compiler whenever the contracts for
|
||||||
|
/// the test are being compiled. Note that this differs from the [`Mode`]s in that a [`Mode`] is
|
||||||
|
/// just a filter for when a test can run whereas this is an instruction to the compiler.
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub compiler_directives: Option<CompilationDirectives>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Metadata {
|
impl Metadata {
|
||||||
/// Returns the solc modes of this metadata, inserting a default mode if not present.
|
/// Returns the modes that we should test from this metadata.
|
||||||
pub fn solc_modes(&self) -> Vec<SolcMode> {
|
pub fn solc_modes(&self) -> Vec<Mode> {
|
||||||
self.modes
|
match &self.modes {
|
||||||
.to_owned()
|
Some(modes) => ParsedMode::many_to_modes(modes.iter()).collect(),
|
||||||
.unwrap_or_else(|| vec![Mode::Solidity(Default::default())])
|
None => Mode::all().cloned().collect(),
|
||||||
.iter()
|
}
|
||||||
.filter_map(|mode| match mode {
|
|
||||||
Mode::Solidity(solc_mode) => Some(solc_mode),
|
|
||||||
Mode::Unknown(mode) => {
|
|
||||||
tracing::debug!("compiler: ignoring unknown mode '{mode}'");
|
|
||||||
None
|
|
||||||
}
|
|
||||||
})
|
|
||||||
.cloned()
|
|
||||||
.collect()
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Returns the base directory of this metadata.
|
/// Returns the base directory of this metadata.
|
||||||
@@ -86,7 +116,7 @@ impl Metadata {
|
|||||||
/// Returns the contract sources with canonicalized paths for the files
|
/// Returns the contract sources with canonicalized paths for the files
|
||||||
pub fn contract_sources(
|
pub fn contract_sources(
|
||||||
&self,
|
&self,
|
||||||
) -> anyhow::Result<BTreeMap<ContractInstance, ContractPathAndIdentifier>> {
|
) -> anyhow::Result<BTreeMap<ContractInstance, ContractPathAndIdent>> {
|
||||||
let directory = self.directory()?;
|
let directory = self.directory()?;
|
||||||
let mut sources = BTreeMap::new();
|
let mut sources = BTreeMap::new();
|
||||||
let Some(contracts) = &self.contracts else {
|
let Some(contracts) = &self.contracts else {
|
||||||
@@ -95,19 +125,27 @@ impl Metadata {
|
|||||||
|
|
||||||
for (
|
for (
|
||||||
alias,
|
alias,
|
||||||
ContractPathAndIdentifier {
|
ContractPathAndIdent {
|
||||||
contract_source_path,
|
contract_source_path,
|
||||||
contract_ident,
|
contract_ident,
|
||||||
},
|
},
|
||||||
) in contracts
|
) in contracts
|
||||||
{
|
{
|
||||||
let alias = alias.clone();
|
let alias = alias.clone();
|
||||||
let absolute_path = directory.join(contract_source_path).canonicalize()?;
|
let absolute_path = directory
|
||||||
|
.join(contract_source_path)
|
||||||
|
.canonicalize()
|
||||||
|
.map_err(|error| {
|
||||||
|
anyhow::anyhow!(
|
||||||
|
"Failed to canonicalize contract source path '{}': {error}",
|
||||||
|
directory.join(contract_source_path).display()
|
||||||
|
)
|
||||||
|
})?;
|
||||||
let contract_ident = contract_ident.clone();
|
let contract_ident = contract_ident.clone();
|
||||||
|
|
||||||
sources.insert(
|
sources.insert(
|
||||||
alias,
|
alias,
|
||||||
ContractPathAndIdentifier {
|
ContractPathAndIdent {
|
||||||
contract_source_path: absolute_path,
|
contract_source_path: absolute_path,
|
||||||
contract_ident,
|
contract_ident,
|
||||||
},
|
},
|
||||||
@@ -126,10 +164,7 @@ impl Metadata {
|
|||||||
pub fn try_from_file(path: &Path) -> Option<Self> {
|
pub fn try_from_file(path: &Path) -> Option<Self> {
|
||||||
assert!(path.is_file(), "not a file: {}", path.display());
|
assert!(path.is_file(), "not a file: {}", path.display());
|
||||||
|
|
||||||
let Some(file_extension) = path.extension() else {
|
let file_extension = path.extension()?;
|
||||||
tracing::debug!("skipping corpus file: {}", path.display());
|
|
||||||
return None;
|
|
||||||
};
|
|
||||||
|
|
||||||
if file_extension == METADATA_FILE_EXTENSION {
|
if file_extension == METADATA_FILE_EXTENSION {
|
||||||
return Self::try_from_json(path);
|
return Self::try_from_json(path);
|
||||||
@@ -139,18 +174,12 @@ impl Metadata {
|
|||||||
return Self::try_from_solidity(path);
|
return Self::try_from_solidity(path);
|
||||||
}
|
}
|
||||||
|
|
||||||
tracing::debug!("ignoring invalid corpus file: {}", path.display());
|
|
||||||
None
|
None
|
||||||
}
|
}
|
||||||
|
|
||||||
fn try_from_json(path: &Path) -> Option<Self> {
|
fn try_from_json(path: &Path) -> Option<Self> {
|
||||||
let file = File::open(path)
|
let file = File::open(path)
|
||||||
.inspect_err(|error| {
|
.inspect_err(|err| error!(path = %path.display(), %err, "Failed to open file"))
|
||||||
tracing::error!(
|
|
||||||
"opening JSON test metadata file '{}' error: {error}",
|
|
||||||
path.display()
|
|
||||||
);
|
|
||||||
})
|
|
||||||
.ok()?;
|
.ok()?;
|
||||||
|
|
||||||
match serde_json::from_reader::<_, Metadata>(file) {
|
match serde_json::from_reader::<_, Metadata>(file) {
|
||||||
@@ -158,11 +187,8 @@ impl Metadata {
|
|||||||
metadata.file_path = Some(path.to_path_buf());
|
metadata.file_path = Some(path.to_path_buf());
|
||||||
Some(metadata)
|
Some(metadata)
|
||||||
}
|
}
|
||||||
Err(error) => {
|
Err(err) => {
|
||||||
tracing::error!(
|
error!(path = %path.display(), %err, "Deserialization of metadata failed");
|
||||||
"parsing JSON test metadata file '{}' error: {error}",
|
|
||||||
path.display()
|
|
||||||
);
|
|
||||||
None
|
None
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -170,12 +196,7 @@ impl Metadata {
|
|||||||
|
|
||||||
fn try_from_solidity(path: &Path) -> Option<Self> {
|
fn try_from_solidity(path: &Path) -> Option<Self> {
|
||||||
let spec = read_to_string(path)
|
let spec = read_to_string(path)
|
||||||
.inspect_err(|error| {
|
.inspect_err(|err| error!(path = %path.display(), %err, "Failed to read file content"))
|
||||||
tracing::error!(
|
|
||||||
"opening JSON test metadata file '{}' error: {error}",
|
|
||||||
path.display()
|
|
||||||
);
|
|
||||||
})
|
|
||||||
.ok()?
|
.ok()?
|
||||||
.lines()
|
.lines()
|
||||||
.filter_map(|line| line.strip_prefix(SOLIDITY_CASE_COMMENT_MARKER))
|
.filter_map(|line| line.strip_prefix(SOLIDITY_CASE_COMMENT_MARKER))
|
||||||
@@ -193,8 +214,8 @@ impl Metadata {
|
|||||||
metadata.file_path = Some(path.to_path_buf());
|
metadata.file_path = Some(path.to_path_buf());
|
||||||
metadata.contracts = Some(
|
metadata.contracts = Some(
|
||||||
[(
|
[(
|
||||||
ContractInstance::new("test"),
|
ContractInstance::new("Test"),
|
||||||
ContractPathAndIdentifier {
|
ContractPathAndIdent {
|
||||||
contract_source_path: path.to_path_buf(),
|
contract_source_path: path.to_path_buf(),
|
||||||
contract_ident: ContractIdent::new("Test"),
|
contract_ident: ContractIdent::new("Test"),
|
||||||
},
|
},
|
||||||
@@ -203,15 +224,37 @@ impl Metadata {
|
|||||||
);
|
);
|
||||||
Some(metadata)
|
Some(metadata)
|
||||||
}
|
}
|
||||||
Err(error) => {
|
Err(err) => {
|
||||||
tracing::error!(
|
error!(path = %path.display(), %err, "Failed to deserialize metadata");
|
||||||
"parsing Solidity test metadata file '{}' error: '{error}' from data: {spec}",
|
|
||||||
path.display()
|
|
||||||
);
|
|
||||||
None
|
None
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// Returns an iterator over all of the solidity files that needs to be compiled for this
|
||||||
|
/// [`Metadata`] object
|
||||||
|
///
|
||||||
|
/// Note: if the metadata is contained within a solidity file then this is the only file that
|
||||||
|
/// we wish to compile since this is a self-contained test. Otherwise, if it's a JSON file
|
||||||
|
/// then we need to compile all of the contracts that are in the directory since imports are
|
||||||
|
/// allowed in there.
|
||||||
|
pub fn files_to_compile(&self) -> anyhow::Result<Box<dyn Iterator<Item = PathBuf>>> {
|
||||||
|
let Some(ref metadata_file_path) = self.file_path else {
|
||||||
|
anyhow::bail!("The metadata file path is not defined");
|
||||||
|
};
|
||||||
|
if metadata_file_path
|
||||||
|
.extension()
|
||||||
|
.is_some_and(|extension| extension.eq_ignore_ascii_case("sol"))
|
||||||
|
{
|
||||||
|
Ok(Box::new(std::iter::once(metadata_file_path.clone())))
|
||||||
|
} else {
|
||||||
|
Ok(Box::new(
|
||||||
|
FilesWithExtensionIterator::new(self.directory()?)
|
||||||
|
.with_allowed_extension("sol")
|
||||||
|
.with_use_cached_fs(true),
|
||||||
|
))
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
define_wrapper_type!(
|
define_wrapper_type!(
|
||||||
@@ -222,7 +265,7 @@ define_wrapper_type!(
|
|||||||
Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize,
|
Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize,
|
||||||
)]
|
)]
|
||||||
#[serde(transparent)]
|
#[serde(transparent)]
|
||||||
pub struct ContractInstance(String);
|
pub struct ContractInstance(String) impl Display;
|
||||||
);
|
);
|
||||||
|
|
||||||
define_wrapper_type!(
|
define_wrapper_type!(
|
||||||
@@ -233,7 +276,7 @@ define_wrapper_type!(
|
|||||||
Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize,
|
Clone, Debug, Default, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize,
|
||||||
)]
|
)]
|
||||||
#[serde(transparent)]
|
#[serde(transparent)]
|
||||||
pub struct ContractIdent(String);
|
pub struct ContractIdent(String) impl Display;
|
||||||
);
|
);
|
||||||
|
|
||||||
/// Represents an identifier used for contracts.
|
/// Represents an identifier used for contracts.
|
||||||
@@ -245,7 +288,7 @@ define_wrapper_type!(
|
|||||||
/// ```
|
/// ```
|
||||||
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
|
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
|
||||||
#[serde(try_from = "String", into = "String")]
|
#[serde(try_from = "String", into = "String")]
|
||||||
pub struct ContractPathAndIdentifier {
|
pub struct ContractPathAndIdent {
|
||||||
/// The path of the contract source code relative to the directory containing the metadata file.
|
/// The path of the contract source code relative to the directory containing the metadata file.
|
||||||
pub contract_source_path: PathBuf,
|
pub contract_source_path: PathBuf,
|
||||||
|
|
||||||
@@ -253,7 +296,7 @@ pub struct ContractPathAndIdentifier {
|
|||||||
pub contract_ident: ContractIdent,
|
pub contract_ident: ContractIdent,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Display for ContractPathAndIdentifier {
|
impl Display for ContractPathAndIdent {
|
||||||
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
write!(
|
write!(
|
||||||
f,
|
f,
|
||||||
@@ -264,7 +307,7 @@ impl Display for ContractPathAndIdentifier {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl FromStr for ContractPathAndIdentifier {
|
impl FromStr for ContractPathAndIdent {
|
||||||
type Err = anyhow::Error;
|
type Err = anyhow::Error;
|
||||||
|
|
||||||
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
||||||
@@ -287,20 +330,26 @@ impl FromStr for ContractPathAndIdentifier {
|
|||||||
identifier = Some(next_item.to_owned())
|
identifier = Some(next_item.to_owned())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
let Some(path) = path else {
|
match (path, identifier) {
|
||||||
anyhow::bail!("Path is not defined");
|
(Some(path), Some(identifier)) => Ok(Self {
|
||||||
};
|
contract_source_path: PathBuf::from(path),
|
||||||
let Some(identifier) = identifier else {
|
contract_ident: ContractIdent::new(identifier),
|
||||||
anyhow::bail!("Contract identifier is not defined")
|
}),
|
||||||
};
|
(None, Some(path)) | (Some(path), None) => {
|
||||||
Ok(Self {
|
let Some(identifier) = path.split(".").next().map(ToOwned::to_owned) else {
|
||||||
contract_source_path: PathBuf::from(path),
|
anyhow::bail!("Failed to find identifier");
|
||||||
contract_ident: ContractIdent::new(identifier),
|
};
|
||||||
})
|
Ok(Self {
|
||||||
|
contract_source_path: PathBuf::from(path),
|
||||||
|
contract_ident: ContractIdent::new(identifier),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
(None, None) => anyhow::bail!("Failed to find the path and identifier"),
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl TryFrom<String> for ContractPathAndIdentifier {
|
impl TryFrom<String> for ContractPathAndIdent {
|
||||||
type Error = anyhow::Error;
|
type Error = anyhow::Error;
|
||||||
|
|
||||||
fn try_from(value: String) -> Result<Self, Self::Error> {
|
fn try_from(value: String) -> Result<Self, Self::Error> {
|
||||||
@@ -308,12 +357,162 @@ impl TryFrom<String> for ContractPathAndIdentifier {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl From<ContractPathAndIdentifier> for String {
|
impl From<ContractPathAndIdent> for String {
|
||||||
fn from(value: ContractPathAndIdentifier) -> Self {
|
fn from(value: ContractPathAndIdent) -> Self {
|
||||||
value.to_string()
|
value.to_string()
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/// An EVM version requirement that the test case has. This gets serialized and
|
||||||
|
/// deserialized from and into [`String`].
|
||||||
|
#[derive(Clone, Copy, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
|
||||||
|
#[serde(try_from = "String", into = "String")]
|
||||||
|
pub struct EvmVersionRequirement {
|
||||||
|
ordering: Ordering,
|
||||||
|
or_equal: bool,
|
||||||
|
evm_version: EVMVersion,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl EvmVersionRequirement {
|
||||||
|
pub fn new_greater_than_or_equals(version: EVMVersion) -> Self {
|
||||||
|
Self {
|
||||||
|
ordering: Ordering::Greater,
|
||||||
|
or_equal: true,
|
||||||
|
evm_version: version,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn new_greater_than(version: EVMVersion) -> Self {
|
||||||
|
Self {
|
||||||
|
ordering: Ordering::Greater,
|
||||||
|
or_equal: false,
|
||||||
|
evm_version: version,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn new_equals(version: EVMVersion) -> Self {
|
||||||
|
Self {
|
||||||
|
ordering: Ordering::Equal,
|
||||||
|
or_equal: false,
|
||||||
|
evm_version: version,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn new_less_than(version: EVMVersion) -> Self {
|
||||||
|
Self {
|
||||||
|
ordering: Ordering::Less,
|
||||||
|
or_equal: false,
|
||||||
|
evm_version: version,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn new_less_than_or_equals(version: EVMVersion) -> Self {
|
||||||
|
Self {
|
||||||
|
ordering: Ordering::Less,
|
||||||
|
or_equal: true,
|
||||||
|
evm_version: version,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn matches(&self, other: &EVMVersion) -> bool {
|
||||||
|
let ordering = other.cmp(&self.evm_version);
|
||||||
|
ordering == self.ordering || (self.or_equal && matches!(ordering, Ordering::Equal))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Display for EvmVersionRequirement {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
let Self {
|
||||||
|
ordering,
|
||||||
|
or_equal,
|
||||||
|
evm_version,
|
||||||
|
} = self;
|
||||||
|
match ordering {
|
||||||
|
Ordering::Less => write!(f, "<")?,
|
||||||
|
Ordering::Equal => write!(f, "=")?,
|
||||||
|
Ordering::Greater => write!(f, ">")?,
|
||||||
|
}
|
||||||
|
if *or_equal && !matches!(ordering, Ordering::Equal) {
|
||||||
|
write!(f, "=")?;
|
||||||
|
}
|
||||||
|
write!(f, "{evm_version}")
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl FromStr for EvmVersionRequirement {
|
||||||
|
type Err = anyhow::Error;
|
||||||
|
|
||||||
|
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
||||||
|
match s.as_bytes() {
|
||||||
|
[b'>', b'=', remaining @ ..] => Ok(Self {
|
||||||
|
ordering: Ordering::Greater,
|
||||||
|
or_equal: true,
|
||||||
|
evm_version: str::from_utf8(remaining)?.try_into()?,
|
||||||
|
}),
|
||||||
|
[b'>', remaining @ ..] => Ok(Self {
|
||||||
|
ordering: Ordering::Greater,
|
||||||
|
or_equal: false,
|
||||||
|
evm_version: str::from_utf8(remaining)?.try_into()?,
|
||||||
|
}),
|
||||||
|
[b'<', b'=', remaining @ ..] => Ok(Self {
|
||||||
|
ordering: Ordering::Less,
|
||||||
|
or_equal: true,
|
||||||
|
evm_version: str::from_utf8(remaining)?.try_into()?,
|
||||||
|
}),
|
||||||
|
[b'<', remaining @ ..] => Ok(Self {
|
||||||
|
ordering: Ordering::Less,
|
||||||
|
or_equal: false,
|
||||||
|
evm_version: str::from_utf8(remaining)?.try_into()?,
|
||||||
|
}),
|
||||||
|
[b'=', remaining @ ..] => Ok(Self {
|
||||||
|
ordering: Ordering::Equal,
|
||||||
|
or_equal: false,
|
||||||
|
evm_version: str::from_utf8(remaining)?.try_into()?,
|
||||||
|
}),
|
||||||
|
_ => anyhow::bail!("Invalid EVM version requirement {s}"),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl TryFrom<String> for EvmVersionRequirement {
|
||||||
|
type Error = anyhow::Error;
|
||||||
|
|
||||||
|
fn try_from(value: String) -> Result<Self, Self::Error> {
|
||||||
|
value.parse()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl From<EvmVersionRequirement> for String {
|
||||||
|
fn from(value: EvmVersionRequirement) -> Self {
|
||||||
|
value.to_string()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A set of compilation directives that will be passed to the compiler whenever the contracts for
|
||||||
|
/// the test are being compiled. Note that this differs from the [`Mode`]s in that a [`Mode`] is
|
||||||
|
/// just a filter for when a test can run whereas this is an instruction to the compiler.
|
||||||
|
/// Defines how the compiler should handle revert strings.
|
||||||
|
#[derive(
|
||||||
|
Clone, Debug, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default, Serialize, Deserialize,
|
||||||
|
)]
|
||||||
|
pub struct CompilationDirectives {
|
||||||
|
/// Defines how the revert strings should be handled.
|
||||||
|
pub revert_string_handling: Option<RevertString>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Defines how the compiler should handle revert strings.
|
||||||
|
#[derive(
|
||||||
|
Clone, Debug, Copy, PartialEq, Eq, PartialOrd, Ord, Hash, Default, Serialize, Deserialize,
|
||||||
|
)]
|
||||||
|
#[serde(rename_all = "camelCase")]
|
||||||
|
pub enum RevertString {
|
||||||
|
#[default]
|
||||||
|
Default,
|
||||||
|
Debug,
|
||||||
|
Strip,
|
||||||
|
VerboseDebug,
|
||||||
|
}
|
||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod test {
|
mod test {
|
||||||
use super::*;
|
use super::*;
|
||||||
@@ -324,7 +523,7 @@ mod test {
|
|||||||
let string = "ERC20/ERC20.sol:ERC20";
|
let string = "ERC20/ERC20.sol:ERC20";
|
||||||
|
|
||||||
// Act
|
// Act
|
||||||
let identifier = ContractPathAndIdentifier::from_str(string);
|
let identifier = ContractPathAndIdent::from_str(string);
|
||||||
|
|
||||||
// Assert
|
// Assert
|
||||||
let identifier = identifier.expect("Failed to parse");
|
let identifier = identifier.expect("Failed to parse");
|
||||||
|
|||||||
+241
-81
@@ -1,96 +1,256 @@
|
|||||||
use semver::Version;
|
use anyhow::Context;
|
||||||
use serde::de::Deserializer;
|
use regex::Regex;
|
||||||
|
use revive_dt_common::iterators::EitherIter;
|
||||||
|
use revive_dt_common::types::{Mode, ModeOptimizerSetting, ModePipeline};
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
|
use std::collections::HashSet;
|
||||||
|
use std::fmt::Display;
|
||||||
|
use std::str::FromStr;
|
||||||
|
use std::sync::LazyLock;
|
||||||
|
|
||||||
/// Specifies the compilation mode of the test artifact.
|
/// This represents a mode that has been parsed from test metadata.
|
||||||
#[derive(Hash, Debug, Clone, Eq, PartialEq)]
|
///
|
||||||
pub enum Mode {
|
/// Mode strings can take the following form (in pseudo-regex):
|
||||||
Solidity(SolcMode),
|
///
|
||||||
Unknown(String),
|
/// ```text
|
||||||
|
/// [YEILV][+-]? (M[0123sz])? <semver>?
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// We can parse valid mode strings into [`ParsedMode`] using [`ParsedMode::from_str`].
|
||||||
|
#[derive(Clone, Debug, PartialEq, Eq, Hash, Deserialize, Serialize)]
|
||||||
|
#[serde(try_from = "String", into = "String")]
|
||||||
|
pub struct ParsedMode {
|
||||||
|
pub pipeline: Option<ModePipeline>,
|
||||||
|
pub optimize_flag: Option<bool>,
|
||||||
|
pub optimize_setting: Option<ModeOptimizerSetting>,
|
||||||
|
pub version: Option<semver::VersionReq>,
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Specify Solidity specific compiler options.
|
impl FromStr for ParsedMode {
|
||||||
#[derive(Hash, Debug, Default, Clone, Eq, PartialEq, Serialize, Deserialize)]
|
type Err = anyhow::Error;
|
||||||
pub struct SolcMode {
|
fn from_str(s: &str) -> Result<Self, Self::Err> {
|
||||||
pub solc_version: Option<semver::VersionReq>,
|
static REGEX: LazyLock<Regex> = LazyLock::new(|| {
|
||||||
solc_optimize: Option<bool>,
|
Regex::new(r"(?x)
|
||||||
pub llvm_optimizer_settings: Vec<String>,
|
^
|
||||||
}
|
(?:(?P<pipeline>[YEILV])(?P<optimize_flag>[+-])?)? # Pipeline to use eg Y, E+, E-
|
||||||
|
\s*
|
||||||
|
(?P<optimize_setting>M[a-zA-Z0-9])? # Optimize setting eg M0, Ms, Mz
|
||||||
|
\s*
|
||||||
|
(?P<version>[>=<]*\d+(?:\.\d+)*)? # Optional semver version eg >=0.8.0, 0.7, <0.8
|
||||||
|
$
|
||||||
|
").unwrap()
|
||||||
|
});
|
||||||
|
|
||||||
impl SolcMode {
|
let Some(caps) = REGEX.captures(s) else {
|
||||||
/// Try to parse a mode string into a solc mode.
|
anyhow::bail!("Cannot parse mode '{s}' from string");
|
||||||
/// Returns `None` if the string wasn't a solc YUL mode string.
|
|
||||||
///
|
|
||||||
/// The mode string is expected to start with the `Y` ID (YUL ID),
|
|
||||||
/// optionally followed by `+` or `-` for the solc optimizer settings.
|
|
||||||
///
|
|
||||||
/// Options can be separated by a whitespace contain the following
|
|
||||||
/// - A solc `SemVer version requirement` string
|
|
||||||
/// - One or more `-OX` where X is a supposed to be an LLVM opt mode
|
|
||||||
pub fn parse_from_mode_string(mode_string: &str) -> Option<Self> {
|
|
||||||
let mut result = Self::default();
|
|
||||||
|
|
||||||
let mut parts = mode_string.trim().split(" ");
|
|
||||||
|
|
||||||
match parts.next()? {
|
|
||||||
"Y" => {}
|
|
||||||
"Y+" => result.solc_optimize = Some(true),
|
|
||||||
"Y-" => result.solc_optimize = Some(false),
|
|
||||||
_ => return None,
|
|
||||||
}
|
|
||||||
|
|
||||||
for part in parts {
|
|
||||||
if let Ok(solc_version) = semver::VersionReq::parse(part) {
|
|
||||||
result.solc_version = Some(solc_version);
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
if let Some(level) = part.strip_prefix("-O") {
|
|
||||||
result.llvm_optimizer_settings.push(level.to_string());
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
panic!("the YUL mode string {mode_string} failed to parse, invalid part: {part}")
|
|
||||||
}
|
|
||||||
|
|
||||||
Some(result)
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Returns whether to enable the solc optimizer.
|
|
||||||
pub fn solc_optimize(&self) -> bool {
|
|
||||||
self.solc_optimize.unwrap_or(true)
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Calculate the latest matching solc patch version. Returns:
|
|
||||||
/// - `latest_supported` if no version request was specified.
|
|
||||||
/// - A matching version with the same minor version as `latest_supported`, if any.
|
|
||||||
/// - `None` if no minor version of the `latest_supported` version matches.
|
|
||||||
pub fn last_patch_version(&self, latest_supported: &Version) -> Option<Version> {
|
|
||||||
let Some(version_req) = self.solc_version.as_ref() else {
|
|
||||||
return Some(latest_supported.to_owned());
|
|
||||||
};
|
};
|
||||||
|
|
||||||
// lgtm
|
let pipeline = match caps.name("pipeline") {
|
||||||
for patch in (0..latest_supported.patch + 1).rev() {
|
Some(m) => Some(
|
||||||
let version = Version::new(0, latest_supported.minor, patch);
|
ModePipeline::from_str(m.as_str())
|
||||||
if version_req.matches(&version) {
|
.context("Failed to parse mode pipeline from string")?,
|
||||||
return Some(version);
|
),
|
||||||
|
None => None,
|
||||||
|
};
|
||||||
|
|
||||||
|
let optimize_flag = caps.name("optimize_flag").map(|m| m.as_str() == "+");
|
||||||
|
|
||||||
|
let optimize_setting = match caps.name("optimize_setting") {
|
||||||
|
Some(m) => Some(
|
||||||
|
ModeOptimizerSetting::from_str(m.as_str())
|
||||||
|
.context("Failed to parse optimizer setting from string")?,
|
||||||
|
),
|
||||||
|
None => None,
|
||||||
|
};
|
||||||
|
|
||||||
|
let version = match caps.name("version") {
|
||||||
|
Some(m) => Some(
|
||||||
|
semver::VersionReq::parse(m.as_str())
|
||||||
|
.map_err(|e| {
|
||||||
|
anyhow::anyhow!(
|
||||||
|
"Cannot parse the version requirement '{}': {e}",
|
||||||
|
m.as_str()
|
||||||
|
)
|
||||||
|
})
|
||||||
|
.context("Failed to parse semver requirement from mode string")?,
|
||||||
|
),
|
||||||
|
None => None,
|
||||||
|
};
|
||||||
|
|
||||||
|
Ok(ParsedMode {
|
||||||
|
pipeline,
|
||||||
|
optimize_flag,
|
||||||
|
optimize_setting,
|
||||||
|
version,
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Display for ParsedMode {
|
||||||
|
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
|
||||||
|
let mut has_written = false;
|
||||||
|
|
||||||
|
if let Some(pipeline) = self.pipeline {
|
||||||
|
pipeline.fmt(f)?;
|
||||||
|
if let Some(optimize_flag) = self.optimize_flag {
|
||||||
|
f.write_str(if optimize_flag { "+" } else { "-" })?;
|
||||||
}
|
}
|
||||||
|
has_written = true;
|
||||||
}
|
}
|
||||||
|
|
||||||
None
|
if let Some(optimize_setting) = self.optimize_setting {
|
||||||
|
if has_written {
|
||||||
|
f.write_str(" ")?;
|
||||||
|
}
|
||||||
|
optimize_setting.fmt(f)?;
|
||||||
|
has_written = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
if let Some(version) = &self.version {
|
||||||
|
if has_written {
|
||||||
|
f.write_str(" ")?;
|
||||||
|
}
|
||||||
|
version.fmt(f)?;
|
||||||
|
}
|
||||||
|
|
||||||
|
Ok(())
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl<'de> Deserialize<'de> for Mode {
|
impl From<ParsedMode> for String {
|
||||||
fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>
|
fn from(parsed_mode: ParsedMode) -> Self {
|
||||||
where
|
parsed_mode.to_string()
|
||||||
D: Deserializer<'de>,
|
}
|
||||||
{
|
}
|
||||||
let mode_string = String::deserialize(deserializer)?;
|
|
||||||
|
impl TryFrom<String> for ParsedMode {
|
||||||
if let Some(solc_mode) = SolcMode::parse_from_mode_string(&mode_string) {
|
type Error = anyhow::Error;
|
||||||
return Ok(Self::Solidity(solc_mode));
|
fn try_from(value: String) -> Result<Self, Self::Error> {
|
||||||
}
|
ParsedMode::from_str(&value)
|
||||||
|
}
|
||||||
Ok(Self::Unknown(mode_string))
|
}
|
||||||
|
|
||||||
|
impl ParsedMode {
|
||||||
|
/// This takes a [`ParsedMode`] and expands it into a list of [`Mode`]s that we should try.
|
||||||
|
pub fn to_modes(&self) -> impl Iterator<Item = Mode> {
|
||||||
|
let pipeline_iter = self.pipeline.as_ref().map_or_else(
|
||||||
|
|| EitherIter::A(ModePipeline::test_cases()),
|
||||||
|
|p| EitherIter::B(std::iter::once(*p)),
|
||||||
|
);
|
||||||
|
|
||||||
|
let optimize_flag_setting = self.optimize_flag.map(|flag| {
|
||||||
|
if flag {
|
||||||
|
ModeOptimizerSetting::M3
|
||||||
|
} else {
|
||||||
|
ModeOptimizerSetting::M0
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
let optimize_flag_iter = match optimize_flag_setting {
|
||||||
|
Some(setting) => EitherIter::A(std::iter::once(setting)),
|
||||||
|
None => EitherIter::B(ModeOptimizerSetting::test_cases()),
|
||||||
|
};
|
||||||
|
|
||||||
|
let optimize_settings_iter = self.optimize_setting.as_ref().map_or_else(
|
||||||
|
|| EitherIter::A(optimize_flag_iter),
|
||||||
|
|s| EitherIter::B(std::iter::once(*s)),
|
||||||
|
);
|
||||||
|
|
||||||
|
pipeline_iter.flat_map(move |pipeline| {
|
||||||
|
optimize_settings_iter
|
||||||
|
.clone()
|
||||||
|
.map(move |optimize_setting| Mode {
|
||||||
|
pipeline,
|
||||||
|
optimize_setting,
|
||||||
|
version: self.version.clone(),
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Return a set of [`Mode`]s that correspond to the given [`ParsedMode`]s.
|
||||||
|
/// This avoids any duplicate entries.
|
||||||
|
pub fn many_to_modes<'a>(
|
||||||
|
parsed: impl Iterator<Item = &'a ParsedMode>,
|
||||||
|
) -> impl Iterator<Item = Mode> {
|
||||||
|
let modes: HashSet<_> = parsed.flat_map(|p| p.to_modes()).collect();
|
||||||
|
modes.into_iter()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[cfg(test)]
|
||||||
|
mod tests {
|
||||||
|
use super::*;
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_parsed_mode_from_str() {
|
||||||
|
let strings = vec![
|
||||||
|
("Mz", "Mz"),
|
||||||
|
("Y", "Y"),
|
||||||
|
("Y+", "Y+"),
|
||||||
|
("Y-", "Y-"),
|
||||||
|
("E", "E"),
|
||||||
|
("E+", "E+"),
|
||||||
|
("E-", "E-"),
|
||||||
|
("Y M0", "Y M0"),
|
||||||
|
("Y M1", "Y M1"),
|
||||||
|
("Y M2", "Y M2"),
|
||||||
|
("Y M3", "Y M3"),
|
||||||
|
("Y Ms", "Y Ms"),
|
||||||
|
("Y Mz", "Y Mz"),
|
||||||
|
("E M0", "E M0"),
|
||||||
|
("E M1", "E M1"),
|
||||||
|
("E M2", "E M2"),
|
||||||
|
("E M3", "E M3"),
|
||||||
|
("E Ms", "E Ms"),
|
||||||
|
("E Mz", "E Mz"),
|
||||||
|
// When stringifying semver again, 0.8.0 becomes ^0.8.0 (same meaning)
|
||||||
|
("Y 0.8.0", "Y ^0.8.0"),
|
||||||
|
("E+ 0.8.0", "E+ ^0.8.0"),
|
||||||
|
("Y M3 >=0.8.0", "Y M3 >=0.8.0"),
|
||||||
|
("E Mz <0.7.0", "E Mz <0.7.0"),
|
||||||
|
// We can parse +- _and_ M1/M2 but the latter takes priority.
|
||||||
|
("Y+ M1 0.8.0", "Y+ M1 ^0.8.0"),
|
||||||
|
("E- M2 0.7.0", "E- M2 ^0.7.0"),
|
||||||
|
// We don't see this in the wild but it is parsed.
|
||||||
|
("<=0.8", "<=0.8"),
|
||||||
|
];
|
||||||
|
|
||||||
|
for (actual, expected) in strings {
|
||||||
|
let parsed = ParsedMode::from_str(actual)
|
||||||
|
.unwrap_or_else(|_| panic!("Failed to parse mode string '{actual}'"));
|
||||||
|
assert_eq!(
|
||||||
|
expected,
|
||||||
|
parsed.to_string(),
|
||||||
|
"Mode string '{actual}' did not parse to '{expected}': got '{parsed}'"
|
||||||
|
);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[test]
|
||||||
|
fn test_parsed_mode_to_test_modes() {
|
||||||
|
let strings = vec![
|
||||||
|
("Mz", vec!["Y Mz", "E Mz"]),
|
||||||
|
("Y", vec!["Y M0", "Y M3"]),
|
||||||
|
("E", vec!["E M0", "E M3"]),
|
||||||
|
("Y+", vec!["Y M3"]),
|
||||||
|
("Y-", vec!["Y M0"]),
|
||||||
|
("Y <=0.8", vec!["Y M0 <=0.8", "Y M3 <=0.8"]),
|
||||||
|
(
|
||||||
|
"<=0.8",
|
||||||
|
vec!["Y M0 <=0.8", "Y M3 <=0.8", "E M0 <=0.8", "E M3 <=0.8"],
|
||||||
|
),
|
||||||
|
];
|
||||||
|
|
||||||
|
for (actual, expected) in strings {
|
||||||
|
let parsed = ParsedMode::from_str(actual)
|
||||||
|
.unwrap_or_else(|_| panic!("Failed to parse mode string '{actual}'"));
|
||||||
|
let expected_set: HashSet<_> = expected.into_iter().map(|s| s.to_owned()).collect();
|
||||||
|
let actual_set: HashSet<_> = parsed.to_modes().map(|m| m.to_string()).collect();
|
||||||
|
|
||||||
|
assert_eq!(
|
||||||
|
expected_set, actual_set,
|
||||||
|
"Mode string '{actual}' did not expand to '{expected_set:?}': got '{actual_set:?}'"
|
||||||
|
);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
+134
-7
@@ -1,30 +1,157 @@
|
|||||||
|
use std::collections::HashMap;
|
||||||
|
|
||||||
use alloy::eips::BlockNumberOrTag;
|
use alloy::eips::BlockNumberOrTag;
|
||||||
|
use alloy::json_abi::JsonAbi;
|
||||||
use alloy::primitives::{Address, BlockHash, BlockNumber, BlockTimestamp, ChainId, U256};
|
use alloy::primitives::{Address, BlockHash, BlockNumber, BlockTimestamp, ChainId, U256};
|
||||||
|
use alloy_primitives::TxHash;
|
||||||
use anyhow::Result;
|
use anyhow::Result;
|
||||||
|
|
||||||
|
use crate::metadata::{ContractIdent, ContractInstance};
|
||||||
|
|
||||||
/// A trait of the interface are required to implement to be used by the resolution logic that this
|
/// A trait of the interface are required to implement to be used by the resolution logic that this
|
||||||
/// crate implements to go from string calldata and into the bytes calldata.
|
/// crate implements to go from string calldata and into the bytes calldata.
|
||||||
pub trait ResolverApi {
|
pub trait ResolverApi {
|
||||||
/// Returns the ID of the chain that the node is on.
|
/// Returns the ID of the chain that the node is on.
|
||||||
fn chain_id(&self) -> Result<ChainId>;
|
fn chain_id(&self) -> impl Future<Output = Result<ChainId>>;
|
||||||
|
|
||||||
|
/// Returns the gas price for the specified transaction.
|
||||||
|
fn transaction_gas_price(&self, tx_hash: &TxHash) -> impl Future<Output = Result<u128>>;
|
||||||
|
|
||||||
// TODO: This is currently a u128 due to Kitchensink needing more than 64 bits for its gas limit
|
// TODO: This is currently a u128 due to Kitchensink needing more than 64 bits for its gas limit
|
||||||
// when we implement the changes to the gas we need to adjust this to be a u64.
|
// when we implement the changes to the gas we need to adjust this to be a u64.
|
||||||
/// Returns the gas limit of the specified block.
|
/// Returns the gas limit of the specified block.
|
||||||
fn block_gas_limit(&self, number: BlockNumberOrTag) -> Result<u128>;
|
fn block_gas_limit(&self, number: BlockNumberOrTag) -> impl Future<Output = Result<u128>>;
|
||||||
|
|
||||||
/// Returns the coinbase of the specified block.
|
/// Returns the coinbase of the specified block.
|
||||||
fn block_coinbase(&self, number: BlockNumberOrTag) -> Result<Address>;
|
fn block_coinbase(&self, number: BlockNumberOrTag) -> impl Future<Output = Result<Address>>;
|
||||||
|
|
||||||
/// Returns the difficulty of the specified block.
|
/// Returns the difficulty of the specified block.
|
||||||
fn block_difficulty(&self, number: BlockNumberOrTag) -> Result<U256>;
|
fn block_difficulty(&self, number: BlockNumberOrTag) -> impl Future<Output = Result<U256>>;
|
||||||
|
|
||||||
|
/// Returns the base fee of the specified block.
|
||||||
|
fn block_base_fee(&self, number: BlockNumberOrTag) -> impl Future<Output = Result<u64>>;
|
||||||
|
|
||||||
/// Returns the hash of the specified block.
|
/// Returns the hash of the specified block.
|
||||||
fn block_hash(&self, number: BlockNumberOrTag) -> Result<BlockHash>;
|
fn block_hash(&self, number: BlockNumberOrTag) -> impl Future<Output = Result<BlockHash>>;
|
||||||
|
|
||||||
/// Returns the timestamp of the specified block,
|
/// Returns the timestamp of the specified block,
|
||||||
fn block_timestamp(&self, number: BlockNumberOrTag) -> Result<BlockTimestamp>;
|
fn block_timestamp(
|
||||||
|
&self,
|
||||||
|
number: BlockNumberOrTag,
|
||||||
|
) -> impl Future<Output = Result<BlockTimestamp>>;
|
||||||
|
|
||||||
/// Returns the number of the last block.
|
/// Returns the number of the last block.
|
||||||
fn last_block_number(&self) -> Result<BlockNumber>;
|
fn last_block_number(&self) -> impl Future<Output = Result<BlockNumber>>;
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Copy, Debug, Default)]
|
||||||
|
/// Contextual information required by the code that's performing the resolution.
|
||||||
|
pub struct ResolutionContext<'a> {
|
||||||
|
/// When provided the contracts provided here will be used for resolutions.
|
||||||
|
deployed_contracts: Option<&'a HashMap<ContractInstance, (ContractIdent, Address, JsonAbi)>>,
|
||||||
|
|
||||||
|
/// When provided the variables in here will be used for performing resolutions.
|
||||||
|
variables: Option<&'a HashMap<String, U256>>,
|
||||||
|
|
||||||
|
/// When provided this block number will be treated as the tip of the chain.
|
||||||
|
block_number: Option<&'a BlockNumber>,
|
||||||
|
|
||||||
|
/// When provided the resolver will use this transaction hash for all of its resolutions.
|
||||||
|
transaction_hash: Option<&'a TxHash>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl<'a> ResolutionContext<'a> {
|
||||||
|
pub fn new() -> Self {
|
||||||
|
Default::default()
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn new_from_parts(
|
||||||
|
deployed_contracts: impl Into<
|
||||||
|
Option<&'a HashMap<ContractInstance, (ContractIdent, Address, JsonAbi)>>,
|
||||||
|
>,
|
||||||
|
variables: impl Into<Option<&'a HashMap<String, U256>>>,
|
||||||
|
block_number: impl Into<Option<&'a BlockNumber>>,
|
||||||
|
transaction_hash: impl Into<Option<&'a TxHash>>,
|
||||||
|
) -> Self {
|
||||||
|
Self {
|
||||||
|
deployed_contracts: deployed_contracts.into(),
|
||||||
|
variables: variables.into(),
|
||||||
|
block_number: block_number.into(),
|
||||||
|
transaction_hash: transaction_hash.into(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_deployed_contracts(
|
||||||
|
mut self,
|
||||||
|
deployed_contracts: impl Into<
|
||||||
|
Option<&'a HashMap<ContractInstance, (ContractIdent, Address, JsonAbi)>>,
|
||||||
|
>,
|
||||||
|
) -> Self {
|
||||||
|
self.deployed_contracts = deployed_contracts.into();
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_variables(
|
||||||
|
mut self,
|
||||||
|
variables: impl Into<Option<&'a HashMap<String, U256>>>,
|
||||||
|
) -> Self {
|
||||||
|
self.variables = variables.into();
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_block_number(mut self, block_number: impl Into<Option<&'a BlockNumber>>) -> Self {
|
||||||
|
self.block_number = block_number.into();
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn with_transaction_hash(
|
||||||
|
mut self,
|
||||||
|
transaction_hash: impl Into<Option<&'a TxHash>>,
|
||||||
|
) -> Self {
|
||||||
|
self.transaction_hash = transaction_hash.into();
|
||||||
|
self
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn resolve_block_number(&self, number: BlockNumberOrTag) -> BlockNumberOrTag {
|
||||||
|
match self.block_number {
|
||||||
|
Some(block_number) => match number {
|
||||||
|
BlockNumberOrTag::Latest => BlockNumberOrTag::Number(*block_number),
|
||||||
|
n @ (BlockNumberOrTag::Finalized
|
||||||
|
| BlockNumberOrTag::Safe
|
||||||
|
| BlockNumberOrTag::Earliest
|
||||||
|
| BlockNumberOrTag::Pending
|
||||||
|
| BlockNumberOrTag::Number(_)) => n,
|
||||||
|
},
|
||||||
|
None => number,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn deployed_contract(
|
||||||
|
&self,
|
||||||
|
instance: &ContractInstance,
|
||||||
|
) -> Option<&(ContractIdent, Address, JsonAbi)> {
|
||||||
|
self.deployed_contracts
|
||||||
|
.and_then(|deployed_contracts| deployed_contracts.get(instance))
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn deployed_contract_address(&self, instance: &ContractInstance) -> Option<&Address> {
|
||||||
|
self.deployed_contract(instance).map(|(_, a, _)| a)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn deployed_contract_abi(&self, instance: &ContractInstance) -> Option<&JsonAbi> {
|
||||||
|
self.deployed_contract(instance).map(|(_, _, a)| a)
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn variable(&self, name: impl AsRef<str>) -> Option<&U256> {
|
||||||
|
self.variables
|
||||||
|
.and_then(|variables| variables.get(name.as_ref()))
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn tip_block_number(&self) -> Option<&'a BlockNumber> {
|
||||||
|
self.block_number
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn transaction_hash(&self) -> Option<&'a TxHash> {
|
||||||
|
self.transaction_hash
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -11,3 +11,6 @@ rust-version.workspace = true
|
|||||||
[dependencies]
|
[dependencies]
|
||||||
alloy = { workspace = true }
|
alloy = { workspace = true }
|
||||||
anyhow = { workspace = true }
|
anyhow = { workspace = true }
|
||||||
|
|
||||||
|
[lints]
|
||||||
|
workspace = true
|
||||||
|
|||||||
@@ -1,21 +1,35 @@
|
|||||||
//! This crate implements all node interactions.
|
//! This crate implements all node interactions.
|
||||||
|
|
||||||
|
use alloy::primitives::{Address, StorageKey, U256};
|
||||||
use alloy::rpc::types::trace::geth::{DiffMode, GethDebugTracingOptions, GethTrace};
|
use alloy::rpc::types::trace::geth::{DiffMode, GethDebugTracingOptions, GethTrace};
|
||||||
use alloy::rpc::types::{TransactionReceipt, TransactionRequest};
|
use alloy::rpc::types::{EIP1186AccountProofResponse, TransactionReceipt, TransactionRequest};
|
||||||
use anyhow::Result;
|
use anyhow::Result;
|
||||||
|
|
||||||
/// An interface for all interactions with Ethereum compatible nodes.
|
/// An interface for all interactions with Ethereum compatible nodes.
|
||||||
pub trait EthereumNode {
|
pub trait EthereumNode {
|
||||||
/// Execute the [TransactionRequest] and return a [TransactionReceipt].
|
/// Execute the [TransactionRequest] and return a [TransactionReceipt].
|
||||||
fn execute_transaction(&self, transaction: TransactionRequest) -> Result<TransactionReceipt>;
|
fn execute_transaction(
|
||||||
|
&self,
|
||||||
|
transaction: TransactionRequest,
|
||||||
|
) -> impl Future<Output = Result<TransactionReceipt>>;
|
||||||
|
|
||||||
/// Trace the transaction in the [TransactionReceipt] and return a [GethTrace].
|
/// Trace the transaction in the [TransactionReceipt] and return a [GethTrace].
|
||||||
fn trace_transaction(
|
fn trace_transaction(
|
||||||
&self,
|
&self,
|
||||||
receipt: &TransactionReceipt,
|
receipt: &TransactionReceipt,
|
||||||
trace_options: GethDebugTracingOptions,
|
trace_options: GethDebugTracingOptions,
|
||||||
) -> Result<GethTrace>;
|
) -> impl Future<Output = Result<GethTrace>>;
|
||||||
|
|
||||||
/// Returns the state diff of the transaction hash in the [TransactionReceipt].
|
/// Returns the state diff of the transaction hash in the [TransactionReceipt].
|
||||||
fn state_diff(&self, receipt: &TransactionReceipt) -> Result<DiffMode>;
|
fn state_diff(&self, receipt: &TransactionReceipt) -> impl Future<Output = Result<DiffMode>>;
|
||||||
|
|
||||||
|
/// Returns the balance of the provided [`Address`] back.
|
||||||
|
fn balance_of(&self, address: Address) -> impl Future<Output = Result<U256>>;
|
||||||
|
|
||||||
|
/// Returns the latest storage proof of the provided [`Address`]
|
||||||
|
fn latest_state_proof(
|
||||||
|
&self,
|
||||||
|
address: Address,
|
||||||
|
keys: Vec<StorageKey>,
|
||||||
|
) -> impl Future<Output = Result<EIP1186AccountProofResponse>>;
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -14,6 +14,7 @@ alloy = { workspace = true }
|
|||||||
tracing = { workspace = true }
|
tracing = { workspace = true }
|
||||||
tokio = { workspace = true }
|
tokio = { workspace = true }
|
||||||
|
|
||||||
|
revive-common = { workspace = true }
|
||||||
revive-dt-common = { workspace = true }
|
revive-dt-common = { workspace = true }
|
||||||
revive-dt-config = { workspace = true }
|
revive-dt-config = { workspace = true }
|
||||||
revive-dt-format = { workspace = true }
|
revive-dt-format = { workspace = true }
|
||||||
@@ -28,3 +29,6 @@ sp-runtime = { workspace = true }
|
|||||||
[dev-dependencies]
|
[dev-dependencies]
|
||||||
temp-dir = { workspace = true }
|
temp-dir = { workspace = true }
|
||||||
tokio = { workspace = true }
|
tokio = { workspace = true }
|
||||||
|
|
||||||
|
[lints]
|
||||||
|
workspace = true
|
||||||
|
|||||||
+390
-255
@@ -3,9 +3,13 @@
|
|||||||
use std::{
|
use std::{
|
||||||
fs::{File, OpenOptions, create_dir_all, remove_dir_all},
|
fs::{File, OpenOptions, create_dir_all, remove_dir_all},
|
||||||
io::{BufRead, BufReader, Read, Write},
|
io::{BufRead, BufReader, Read, Write},
|
||||||
|
ops::ControlFlow,
|
||||||
path::PathBuf,
|
path::PathBuf,
|
||||||
process::{Child, Command, Stdio},
|
process::{Child, Command, Stdio},
|
||||||
sync::atomic::{AtomicU32, Ordering},
|
sync::{
|
||||||
|
Arc,
|
||||||
|
atomic::{AtomicU32, Ordering},
|
||||||
|
},
|
||||||
time::{Duration, Instant},
|
time::{Duration, Instant},
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -13,23 +17,31 @@ use alloy::{
|
|||||||
eips::BlockNumberOrTag,
|
eips::BlockNumberOrTag,
|
||||||
genesis::{Genesis, GenesisAccount},
|
genesis::{Genesis, GenesisAccount},
|
||||||
network::{Ethereum, EthereumWallet, NetworkWallet},
|
network::{Ethereum, EthereumWallet, NetworkWallet},
|
||||||
primitives::{Address, BlockHash, BlockNumber, BlockTimestamp, FixedBytes, U256},
|
primitives::{
|
||||||
|
Address, BlockHash, BlockNumber, BlockTimestamp, FixedBytes, StorageKey, TxHash, U256,
|
||||||
|
},
|
||||||
providers::{
|
providers::{
|
||||||
Provider, ProviderBuilder,
|
Provider, ProviderBuilder,
|
||||||
ext::DebugApi,
|
ext::DebugApi,
|
||||||
fillers::{CachedNonceManager, ChainIdFiller, FillProvider, NonceFiller, TxFiller},
|
fillers::{CachedNonceManager, ChainIdFiller, FillProvider, NonceFiller, TxFiller},
|
||||||
},
|
},
|
||||||
rpc::types::{
|
rpc::types::{
|
||||||
TransactionReceipt, TransactionRequest,
|
EIP1186AccountProofResponse, TransactionReceipt, TransactionRequest,
|
||||||
trace::geth::{DiffMode, GethDebugTracingOptions, PreStateConfig, PreStateFrame},
|
trace::geth::{DiffMode, GethDebugTracingOptions, PreStateConfig, PreStateFrame},
|
||||||
},
|
},
|
||||||
signers::local::PrivateKeySigner,
|
signers::local::PrivateKeySigner,
|
||||||
};
|
};
|
||||||
use revive_dt_common::concepts::BlockingExecutor;
|
use anyhow::Context;
|
||||||
|
use revive_common::EVMVersion;
|
||||||
|
use tracing::{Instrument, instrument};
|
||||||
|
|
||||||
|
use revive_dt_common::{
|
||||||
|
fs::clear_directory,
|
||||||
|
futures::{PollingWaitBehavior, poll},
|
||||||
|
};
|
||||||
use revive_dt_config::Arguments;
|
use revive_dt_config::Arguments;
|
||||||
use revive_dt_format::traits::ResolverApi;
|
use revive_dt_format::traits::ResolverApi;
|
||||||
use revive_dt_node_interaction::EthereumNode;
|
use revive_dt_node_interaction::EthereumNode;
|
||||||
use tracing::Level;
|
|
||||||
|
|
||||||
use crate::{Node, common::FallbackGasFiller, constants::INITIAL_BALANCE};
|
use crate::{Node, common::FallbackGasFiller, constants::INITIAL_BALANCE};
|
||||||
|
|
||||||
@@ -43,7 +55,8 @@ static NODE_COUNT: AtomicU32 = AtomicU32::new(0);
|
|||||||
///
|
///
|
||||||
/// Prunes the child process and the base directory on drop.
|
/// Prunes the child process and the base directory on drop.
|
||||||
#[derive(Debug)]
|
#[derive(Debug)]
|
||||||
pub struct Instance {
|
#[allow(clippy::type_complexity)]
|
||||||
|
pub struct GethNode {
|
||||||
connection_string: String,
|
connection_string: String,
|
||||||
base_directory: PathBuf,
|
base_directory: PathBuf,
|
||||||
data_directory: PathBuf,
|
data_directory: PathBuf,
|
||||||
@@ -51,10 +64,10 @@ pub struct Instance {
|
|||||||
geth: PathBuf,
|
geth: PathBuf,
|
||||||
id: u32,
|
id: u32,
|
||||||
handle: Option<Child>,
|
handle: Option<Child>,
|
||||||
network_id: u64,
|
|
||||||
start_timeout: u64,
|
start_timeout: u64,
|
||||||
wallet: EthereumWallet,
|
wallet: Arc<EthereumWallet>,
|
||||||
nonce_manager: CachedNonceManager,
|
nonce_manager: CachedNonceManager,
|
||||||
|
chain_id_filler: ChainIdFiller,
|
||||||
/// This vector stores [`File`] objects that we use for logging which we want to flush when the
|
/// This vector stores [`File`] objects that we use for logging which we want to flush when the
|
||||||
/// node object is dropped. We do not store them in a structured fashion at the moment (in
|
/// node object is dropped. We do not store them in a structured fashion at the moment (in
|
||||||
/// separate fields) as the logic that we need to apply to them is all the same regardless of
|
/// separate fields) as the logic that we need to apply to them is all the same regardless of
|
||||||
@@ -62,7 +75,7 @@ pub struct Instance {
|
|||||||
logs_file_to_flush: Vec<File>,
|
logs_file_to_flush: Vec<File>,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Instance {
|
impl GethNode {
|
||||||
const BASE_DIRECTORY: &str = "geth";
|
const BASE_DIRECTORY: &str = "geth";
|
||||||
const DATA_DIRECTORY: &str = "data";
|
const DATA_DIRECTORY: &str = "data";
|
||||||
const LOGS_DIRECTORY: &str = "logs";
|
const LOGS_DIRECTORY: &str = "logs";
|
||||||
@@ -77,14 +90,24 @@ impl Instance {
|
|||||||
const GETH_STDERR_LOG_FILE_NAME: &str = "node_stderr.log";
|
const GETH_STDERR_LOG_FILE_NAME: &str = "node_stderr.log";
|
||||||
|
|
||||||
const TRANSACTION_INDEXING_ERROR: &str = "transaction indexing is in progress";
|
const TRANSACTION_INDEXING_ERROR: &str = "transaction indexing is in progress";
|
||||||
|
const TRANSACTION_TRACING_ERROR: &str = "historical state not available in path scheme yet";
|
||||||
|
|
||||||
|
const RECEIPT_POLLING_DURATION: Duration = Duration::from_secs(5 * 60);
|
||||||
|
const TRACE_POLLING_DURATION: Duration = Duration::from_secs(60);
|
||||||
|
|
||||||
/// Create the node directory and call `geth init` to configure the genesis.
|
/// Create the node directory and call `geth init` to configure the genesis.
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
fn init(&mut self, genesis: String) -> anyhow::Result<&mut Self> {
|
fn init(&mut self, genesis: String) -> anyhow::Result<&mut Self> {
|
||||||
create_dir_all(&self.base_directory)?;
|
let _ = clear_directory(&self.base_directory);
|
||||||
create_dir_all(&self.logs_directory)?;
|
let _ = clear_directory(&self.logs_directory);
|
||||||
|
|
||||||
let mut genesis = serde_json::from_str::<Genesis>(&genesis)?;
|
create_dir_all(&self.base_directory)
|
||||||
|
.context("Failed to create base directory for geth node")?;
|
||||||
|
create_dir_all(&self.logs_directory)
|
||||||
|
.context("Failed to create logs directory for geth node")?;
|
||||||
|
|
||||||
|
let mut genesis = serde_json::from_str::<Genesis>(&genesis)
|
||||||
|
.context("Failed to deserialize geth genesis JSON")?;
|
||||||
for signer_address in
|
for signer_address in
|
||||||
<EthereumWallet as NetworkWallet<Ethereum>>::signer_addresses(&self.wallet)
|
<EthereumWallet as NetworkWallet<Ethereum>>::signer_addresses(&self.wallet)
|
||||||
{
|
{
|
||||||
@@ -96,25 +119,37 @@ impl Instance {
|
|||||||
.or_insert(GenesisAccount::default().with_balance(U256::from(INITIAL_BALANCE)));
|
.or_insert(GenesisAccount::default().with_balance(U256::from(INITIAL_BALANCE)));
|
||||||
}
|
}
|
||||||
let genesis_path = self.base_directory.join(Self::GENESIS_JSON_FILE);
|
let genesis_path = self.base_directory.join(Self::GENESIS_JSON_FILE);
|
||||||
serde_json::to_writer(File::create(&genesis_path)?, &genesis)?;
|
serde_json::to_writer(
|
||||||
|
File::create(&genesis_path).context("Failed to create geth genesis file")?,
|
||||||
|
&genesis,
|
||||||
|
)
|
||||||
|
.context("Failed to serialize geth genesis JSON to file")?;
|
||||||
|
|
||||||
let mut child = Command::new(&self.geth)
|
let mut child = Command::new(&self.geth)
|
||||||
|
.arg("--state.scheme")
|
||||||
|
.arg("hash")
|
||||||
.arg("init")
|
.arg("init")
|
||||||
.arg("--datadir")
|
.arg("--datadir")
|
||||||
.arg(&self.data_directory)
|
.arg(&self.data_directory)
|
||||||
.arg(genesis_path)
|
.arg(genesis_path)
|
||||||
.stderr(Stdio::piped())
|
.stderr(Stdio::piped())
|
||||||
.stdout(Stdio::null())
|
.stdout(Stdio::null())
|
||||||
.spawn()?;
|
.spawn()
|
||||||
|
.context("Failed to spawn geth --init process")?;
|
||||||
|
|
||||||
let mut stderr = String::new();
|
let mut stderr = String::new();
|
||||||
child
|
child
|
||||||
.stderr
|
.stderr
|
||||||
.take()
|
.take()
|
||||||
.expect("should be piped")
|
.expect("should be piped")
|
||||||
.read_to_string(&mut stderr)?;
|
.read_to_string(&mut stderr)
|
||||||
|
.context("Failed to read geth --init stderr")?;
|
||||||
|
|
||||||
if !child.wait()?.success() {
|
if !child
|
||||||
|
.wait()
|
||||||
|
.context("Failed waiting for geth --init process to finish")?
|
||||||
|
.success()
|
||||||
|
{
|
||||||
anyhow::bail!("failed to initialize geth node #{:?}: {stderr}", &self.id);
|
anyhow::bail!("failed to initialize geth node #{:?}: {stderr}", &self.id);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -124,7 +159,7 @@ impl Instance {
|
|||||||
/// Spawn the go-ethereum node child process.
|
/// Spawn the go-ethereum node child process.
|
||||||
///
|
///
|
||||||
/// [Instance::init] must be called prior.
|
/// [Instance::init] must be called prior.
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
fn spawn_process(&mut self) -> anyhow::Result<&mut Self> {
|
fn spawn_process(&mut self) -> anyhow::Result<&mut Self> {
|
||||||
// This is the `OpenOptions` that we wish to use for all of the log files that we will be
|
// This is the `OpenOptions` that we wish to use for all of the log files that we will be
|
||||||
// opening in this method. We need to construct it in this way to:
|
// opening in this method. We need to construct it in this way to:
|
||||||
@@ -139,27 +174,48 @@ impl Instance {
|
|||||||
|
|
||||||
let stdout_logs_file = open_options
|
let stdout_logs_file = open_options
|
||||||
.clone()
|
.clone()
|
||||||
.open(self.geth_stdout_log_file_path())?;
|
.open(self.geth_stdout_log_file_path())
|
||||||
let stderr_logs_file = open_options.open(self.geth_stderr_log_file_path())?;
|
.context("Failed to open geth stdout logs file")?;
|
||||||
|
let stderr_logs_file = open_options
|
||||||
|
.open(self.geth_stderr_log_file_path())
|
||||||
|
.context("Failed to open geth stderr logs file")?;
|
||||||
self.handle = Command::new(&self.geth)
|
self.handle = Command::new(&self.geth)
|
||||||
.arg("--dev")
|
.arg("--dev")
|
||||||
.arg("--datadir")
|
.arg("--datadir")
|
||||||
.arg(&self.data_directory)
|
.arg(&self.data_directory)
|
||||||
.arg("--ipcpath")
|
.arg("--ipcpath")
|
||||||
.arg(&self.connection_string)
|
.arg(&self.connection_string)
|
||||||
.arg("--networkid")
|
|
||||||
.arg(self.network_id.to_string())
|
|
||||||
.arg("--nodiscover")
|
.arg("--nodiscover")
|
||||||
.arg("--maxpeers")
|
.arg("--maxpeers")
|
||||||
.arg("0")
|
.arg("0")
|
||||||
.stderr(stderr_logs_file.try_clone()?)
|
.arg("--txlookuplimit")
|
||||||
.stdout(stdout_logs_file.try_clone()?)
|
.arg("0")
|
||||||
.spawn()?
|
.arg("--cache.blocklogs")
|
||||||
|
.arg("512")
|
||||||
|
.arg("--state.scheme")
|
||||||
|
.arg("hash")
|
||||||
|
.arg("--syncmode")
|
||||||
|
.arg("full")
|
||||||
|
.arg("--gcmode")
|
||||||
|
.arg("archive")
|
||||||
|
.stderr(
|
||||||
|
stderr_logs_file
|
||||||
|
.try_clone()
|
||||||
|
.context("Failed to clone geth stderr log file handle")?,
|
||||||
|
)
|
||||||
|
.stdout(
|
||||||
|
stdout_logs_file
|
||||||
|
.try_clone()
|
||||||
|
.context("Failed to clone geth stdout log file handle")?,
|
||||||
|
)
|
||||||
|
.spawn()
|
||||||
|
.context("Failed to spawn geth node process")?
|
||||||
.into();
|
.into();
|
||||||
|
|
||||||
if let Err(error) = self.wait_ready() {
|
if let Err(error) = self.wait_ready() {
|
||||||
tracing::error!(?error, "Failed to start geth, shutting down gracefully");
|
tracing::error!(?error, "Failed to start geth, shutting down gracefully");
|
||||||
self.shutdown()?;
|
self.shutdown()
|
||||||
|
.context("Failed to gracefully shutdown after geth start error")?;
|
||||||
return Err(error);
|
return Err(error);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -172,7 +228,7 @@ impl Instance {
|
|||||||
/// Wait for the g-ethereum node child process getting ready.
|
/// Wait for the g-ethereum node child process getting ready.
|
||||||
///
|
///
|
||||||
/// [Instance::spawn_process] must be called priorly.
|
/// [Instance::spawn_process] must be called priorly.
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
fn wait_ready(&mut self) -> anyhow::Result<&mut Self> {
|
fn wait_ready(&mut self) -> anyhow::Result<&mut Self> {
|
||||||
let start_time = Instant::now();
|
let start_time = Instant::now();
|
||||||
|
|
||||||
@@ -181,10 +237,12 @@ impl Instance {
|
|||||||
.write(false)
|
.write(false)
|
||||||
.append(false)
|
.append(false)
|
||||||
.truncate(false)
|
.truncate(false)
|
||||||
.open(self.geth_stderr_log_file_path())?;
|
.open(self.geth_stderr_log_file_path())
|
||||||
|
.context("Failed to open geth stderr logs file for readiness check")?;
|
||||||
|
|
||||||
let maximum_wait_time = Duration::from_millis(self.start_timeout);
|
let maximum_wait_time = Duration::from_millis(self.start_timeout);
|
||||||
let mut stderr = BufReader::new(logs_file).lines();
|
let mut stderr = BufReader::new(logs_file).lines();
|
||||||
|
let mut lines = vec![];
|
||||||
loop {
|
loop {
|
||||||
if let Some(Ok(line)) = stderr.next() {
|
if let Some(Ok(line)) = stderr.next() {
|
||||||
if line.contains(Self::ERROR_MARKER) {
|
if line.contains(Self::ERROR_MARKER) {
|
||||||
@@ -193,244 +251,311 @@ impl Instance {
|
|||||||
if line.contains(Self::READY_MARKER) {
|
if line.contains(Self::READY_MARKER) {
|
||||||
return Ok(self);
|
return Ok(self);
|
||||||
}
|
}
|
||||||
|
lines.push(line);
|
||||||
}
|
}
|
||||||
if Instant::now().duration_since(start_time) > maximum_wait_time {
|
if Instant::now().duration_since(start_time) > maximum_wait_time {
|
||||||
anyhow::bail!("Timeout in starting geth");
|
anyhow::bail!(
|
||||||
|
"Timeout in starting geth: took longer than {}ms. stdout:\n\n{}\n",
|
||||||
|
self.start_timeout,
|
||||||
|
lines.join("\n")
|
||||||
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id), level = Level::TRACE)]
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
fn geth_stdout_log_file_path(&self) -> PathBuf {
|
fn geth_stdout_log_file_path(&self) -> PathBuf {
|
||||||
self.logs_directory.join(Self::GETH_STDOUT_LOG_FILE_NAME)
|
self.logs_directory.join(Self::GETH_STDOUT_LOG_FILE_NAME)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id), level = Level::TRACE)]
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
fn geth_stderr_log_file_path(&self) -> PathBuf {
|
fn geth_stderr_log_file_path(&self) -> PathBuf {
|
||||||
self.logs_directory.join(Self::GETH_STDERR_LOG_FILE_NAME)
|
self.logs_directory.join(Self::GETH_STDERR_LOG_FILE_NAME)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn provider(
|
async fn provider(
|
||||||
&self,
|
&self,
|
||||||
) -> impl Future<
|
) -> anyhow::Result<FillProvider<impl TxFiller<Ethereum>, impl Provider<Ethereum>, Ethereum>>
|
||||||
Output = anyhow::Result<
|
{
|
||||||
FillProvider<impl TxFiller<Ethereum>, impl Provider<Ethereum>, Ethereum>,
|
ProviderBuilder::new()
|
||||||
>,
|
.disable_recommended_fillers()
|
||||||
> + 'static {
|
.filler(FallbackGasFiller::new(
|
||||||
let connection_string = self.connection_string();
|
25_000_000,
|
||||||
let wallet = self.wallet.clone();
|
1_000_000_000,
|
||||||
|
1_000_000_000,
|
||||||
// Note: We would like all providers to make use of the same nonce manager so that we have
|
))
|
||||||
// monotonically increasing nonces that are cached. The cached nonce manager uses Arc's in
|
.filler(self.chain_id_filler.clone())
|
||||||
// its implementation and therefore it means that when we clone it then it still references
|
.filler(NonceFiller::new(self.nonce_manager.clone()))
|
||||||
// the same state.
|
.wallet(self.wallet.clone())
|
||||||
let nonce_manager = self.nonce_manager.clone();
|
.connect(&self.connection_string)
|
||||||
|
.await
|
||||||
Box::pin(async move {
|
.map_err(Into::into)
|
||||||
ProviderBuilder::new()
|
|
||||||
.disable_recommended_fillers()
|
|
||||||
.filler(FallbackGasFiller::new(500_000_000, 500_000_000, 1))
|
|
||||||
.filler(ChainIdFiller::default())
|
|
||||||
.filler(NonceFiller::new(nonce_manager))
|
|
||||||
.wallet(wallet)
|
|
||||||
.connect(&connection_string)
|
|
||||||
.await
|
|
||||||
.map_err(Into::into)
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl EthereumNode for Instance {
|
impl EthereumNode for GethNode {
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
#[instrument(
|
||||||
fn execute_transaction(
|
level = "info",
|
||||||
|
skip_all,
|
||||||
|
fields(geth_node_id = self.id, connection_string = self.connection_string),
|
||||||
|
err,
|
||||||
|
)]
|
||||||
|
async fn execute_transaction(
|
||||||
&self,
|
&self,
|
||||||
transaction: TransactionRequest,
|
transaction: TransactionRequest,
|
||||||
) -> anyhow::Result<alloy::rpc::types::TransactionReceipt> {
|
) -> anyhow::Result<alloy::rpc::types::TransactionReceipt> {
|
||||||
let provider = self.provider();
|
let provider = self
|
||||||
BlockingExecutor::execute(async move {
|
.provider()
|
||||||
let outer_span = tracing::debug_span!("Submitting transaction", ?transaction);
|
.await
|
||||||
let _outer_guard = outer_span.enter();
|
.context("Failed to create provider for transaction submission")?;
|
||||||
|
|
||||||
let provider = provider.await?;
|
let pending_transaction = provider
|
||||||
|
.send_transaction(transaction)
|
||||||
|
.await
|
||||||
|
.inspect_err(
|
||||||
|
|err| tracing::error!(%err, "Encountered an error when submitting the transaction"),
|
||||||
|
)
|
||||||
|
.context("Failed to submit transaction to geth node")?;
|
||||||
|
let transaction_hash = *pending_transaction.tx_hash();
|
||||||
|
|
||||||
let pending_transaction = provider.send_transaction(transaction).await?;
|
// The following is a fix for the "transaction indexing is in progress" error that we used
|
||||||
let transaction_hash = pending_transaction.tx_hash();
|
// to get. You can find more information on this in the following GH issue in geth
|
||||||
|
// https://github.com/ethereum/go-ethereum/issues/28877. To summarize what's going on,
|
||||||
let span = tracing::info_span!("Awaiting transaction receipt", ?transaction_hash);
|
// before we can get the receipt of the transaction it needs to have been indexed by the
|
||||||
let _guard = span.enter();
|
// node's indexer. Just because the transaction has been confirmed it doesn't mean that it
|
||||||
|
// has been indexed. When we call alloy's `get_receipt` it checks if the transaction was
|
||||||
// The following is a fix for the "transaction indexing is in progress" error that we
|
// confirmed. If it has been, then it will call `eth_getTransactionReceipt` method which
|
||||||
// used to get. You can find more information on this in the following GH issue in geth
|
// _might_ return the above error if the tx has not yet been indexed yet. So, we need to
|
||||||
// https://github.com/ethereum/go-ethereum/issues/28877. To summarize what's going on,
|
// implement a retry mechanism for the receipt to keep retrying to get it until it
|
||||||
// before we can get the receipt of the transaction it needs to have been indexed by the
|
// eventually works, but we only do that if the error we get back is the "transaction
|
||||||
// node's indexer. Just because the transaction has been confirmed it doesn't mean that
|
// indexing is in progress" error or if the receipt is None.
|
||||||
// it has been indexed. When we call alloy's `get_receipt` it checks if the transaction
|
//
|
||||||
// was confirmed. If it has been, then it will call `eth_getTransactionReceipt` method
|
// Getting the transaction indexed and taking a receipt can take a long time especially when
|
||||||
// which _might_ return the above error if the tx has not yet been indexed yet. So, we
|
// a lot of transactions are being submitted to the node. Thus, while initially we only
|
||||||
// need to implement a retry mechanism for the receipt to keep retrying to get it until
|
// allowed for 60 seconds of waiting with a 1 second delay in polling, we need to allow for
|
||||||
// it eventually works, but we only do that if the error we get back is the "transaction
|
// a larger wait time. Therefore, in here we allow for 5 minutes of waiting with exponential
|
||||||
// indexing is in progress" error or if the receipt is None.
|
// backoff each time we attempt to get the receipt and find that it's not available.
|
||||||
//
|
let provider = Arc::new(provider);
|
||||||
// Getting the transaction indexed and taking a receipt can take a long time especially
|
poll(
|
||||||
// when a lot of transactions are being submitted to the node. Thus, while initially we
|
Self::RECEIPT_POLLING_DURATION,
|
||||||
// only allowed for 60 seconds of waiting with a 1 second delay in polling, we need to
|
PollingWaitBehavior::Constant(Duration::from_millis(200)),
|
||||||
// allow for a larger wait time. Therefore, in here we allow for 5 minutes of waiting
|
move || {
|
||||||
// with exponential backoff each time we attempt to get the receipt and find that it's
|
let provider = provider.clone();
|
||||||
// not available.
|
async move {
|
||||||
let mut retries = 0;
|
match provider.get_transaction_receipt(transaction_hash).await {
|
||||||
let mut total_wait_duration = Duration::from_secs(0);
|
Ok(Some(receipt)) => Ok(ControlFlow::Break(receipt)),
|
||||||
let max_allowed_wait_duration = Duration::from_secs(5 * 60);
|
Ok(None) => Ok(ControlFlow::Continue(())),
|
||||||
loop {
|
Err(error) => {
|
||||||
if total_wait_duration >= max_allowed_wait_duration {
|
let error_string = error.to_string();
|
||||||
tracing::error!(
|
match error_string.contains(Self::TRANSACTION_INDEXING_ERROR) {
|
||||||
?total_wait_duration,
|
true => Ok(ControlFlow::Continue(())),
|
||||||
?max_allowed_wait_duration,
|
false => Err(error.into()),
|
||||||
retry_count = retries,
|
}
|
||||||
"Failed to get receipt after polling for it"
|
|
||||||
);
|
|
||||||
anyhow::bail!(
|
|
||||||
"Polled for receipt for {total_wait_duration:?} but failed to get it"
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
match provider.get_transaction_receipt(*transaction_hash).await {
|
|
||||||
Ok(Some(receipt)) => break Ok(receipt),
|
|
||||||
Ok(None) => {}
|
|
||||||
Err(error) => {
|
|
||||||
let error_string = error.to_string();
|
|
||||||
if !error_string.contains(Self::TRANSACTION_INDEXING_ERROR) {
|
|
||||||
break Err(error.into());
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
};
|
}
|
||||||
|
},
|
||||||
let next_wait_duration = Duration::from_secs(2u64.pow(retries))
|
)
|
||||||
.min(max_allowed_wait_duration - total_wait_duration);
|
.instrument(tracing::info_span!(
|
||||||
total_wait_duration += next_wait_duration;
|
"Awaiting transaction receipt",
|
||||||
retries += 1;
|
?transaction_hash
|
||||||
|
))
|
||||||
tokio::time::sleep(next_wait_duration).await;
|
.await
|
||||||
}
|
|
||||||
})?
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
fn trace_transaction(
|
async fn trace_transaction(
|
||||||
&self,
|
&self,
|
||||||
transaction: &TransactionReceipt,
|
transaction: &TransactionReceipt,
|
||||||
trace_options: GethDebugTracingOptions,
|
trace_options: GethDebugTracingOptions,
|
||||||
) -> anyhow::Result<alloy::rpc::types::trace::geth::GethTrace> {
|
) -> anyhow::Result<alloy::rpc::types::trace::geth::GethTrace> {
|
||||||
let tx_hash = transaction.transaction_hash;
|
let provider = Arc::new(
|
||||||
let provider = self.provider();
|
self.provider()
|
||||||
BlockingExecutor::execute(async move {
|
.await
|
||||||
Ok(provider
|
.context("Failed to create provider for tracing")?,
|
||||||
.await?
|
);
|
||||||
.debug_trace_transaction(tx_hash, trace_options)
|
poll(
|
||||||
.await?)
|
Self::TRACE_POLLING_DURATION,
|
||||||
})?
|
PollingWaitBehavior::Constant(Duration::from_millis(200)),
|
||||||
|
move || {
|
||||||
|
let provider = provider.clone();
|
||||||
|
let trace_options = trace_options.clone();
|
||||||
|
async move {
|
||||||
|
match provider
|
||||||
|
.debug_trace_transaction(transaction.transaction_hash, trace_options)
|
||||||
|
.await
|
||||||
|
{
|
||||||
|
Ok(trace) => Ok(ControlFlow::Break(trace)),
|
||||||
|
Err(error) => {
|
||||||
|
let error_string = error.to_string();
|
||||||
|
match error_string.contains(Self::TRANSACTION_TRACING_ERROR) {
|
||||||
|
true => Ok(ControlFlow::Continue(())),
|
||||||
|
false => Err(error.into()),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
)
|
||||||
|
.await
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
fn state_diff(&self, transaction: &TransactionReceipt) -> anyhow::Result<DiffMode> {
|
async fn state_diff(&self, transaction: &TransactionReceipt) -> anyhow::Result<DiffMode> {
|
||||||
let trace_options = GethDebugTracingOptions::prestate_tracer(PreStateConfig {
|
let trace_options = GethDebugTracingOptions::prestate_tracer(PreStateConfig {
|
||||||
diff_mode: Some(true),
|
diff_mode: Some(true),
|
||||||
disable_code: None,
|
disable_code: None,
|
||||||
disable_storage: None,
|
disable_storage: None,
|
||||||
});
|
});
|
||||||
match self
|
match self
|
||||||
.trace_transaction(transaction, trace_options)?
|
.trace_transaction(transaction, trace_options)
|
||||||
.try_into_pre_state_frame()?
|
.await
|
||||||
|
.context("Failed to trace transaction for prestate diff")?
|
||||||
|
.try_into_pre_state_frame()
|
||||||
|
.context("Failed to convert trace into pre-state frame")?
|
||||||
{
|
{
|
||||||
PreStateFrame::Diff(diff) => Ok(diff),
|
PreStateFrame::Diff(diff) => Ok(diff),
|
||||||
_ => anyhow::bail!("expected a diff mode trace"),
|
_ => anyhow::bail!("expected a diff mode trace"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
}
|
|
||||||
|
|
||||||
impl ResolverApi for Instance {
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
async fn balance_of(&self, address: Address) -> anyhow::Result<U256> {
|
||||||
fn chain_id(&self) -> anyhow::Result<alloy::primitives::ChainId> {
|
self.provider()
|
||||||
let provider = self.provider();
|
.await
|
||||||
BlockingExecutor::execute(async move {
|
.context("Failed to get the Geth provider")?
|
||||||
provider.await?.get_chain_id().await.map_err(Into::into)
|
.get_balance(address)
|
||||||
})?
|
.await
|
||||||
|
.map_err(Into::into)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
fn block_gas_limit(&self, number: BlockNumberOrTag) -> anyhow::Result<u128> {
|
async fn latest_state_proof(
|
||||||
let provider = self.provider();
|
&self,
|
||||||
BlockingExecutor::execute(async move {
|
address: Address,
|
||||||
provider
|
keys: Vec<StorageKey>,
|
||||||
.await?
|
) -> anyhow::Result<EIP1186AccountProofResponse> {
|
||||||
.get_block_by_number(number)
|
self.provider()
|
||||||
.await?
|
.await
|
||||||
.ok_or(anyhow::Error::msg("Blockchain has no blocks"))
|
.context("Failed to get the Geth provider")?
|
||||||
.map(|block| block.header.gas_limit as _)
|
.get_proof(address, keys)
|
||||||
})?
|
.latest()
|
||||||
}
|
.await
|
||||||
|
.map_err(Into::into)
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
|
||||||
fn block_coinbase(&self, number: BlockNumberOrTag) -> anyhow::Result<Address> {
|
|
||||||
let provider = self.provider();
|
|
||||||
BlockingExecutor::execute(async move {
|
|
||||||
provider
|
|
||||||
.await?
|
|
||||||
.get_block_by_number(number)
|
|
||||||
.await?
|
|
||||||
.ok_or(anyhow::Error::msg("Blockchain has no blocks"))
|
|
||||||
.map(|block| block.header.beneficiary)
|
|
||||||
})?
|
|
||||||
}
|
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
|
||||||
fn block_difficulty(&self, number: BlockNumberOrTag) -> anyhow::Result<U256> {
|
|
||||||
let provider = self.provider();
|
|
||||||
BlockingExecutor::execute(async move {
|
|
||||||
provider
|
|
||||||
.await?
|
|
||||||
.get_block_by_number(number)
|
|
||||||
.await?
|
|
||||||
.ok_or(anyhow::Error::msg("Blockchain has no blocks"))
|
|
||||||
.map(|block| block.header.difficulty)
|
|
||||||
})?
|
|
||||||
}
|
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
|
||||||
fn block_hash(&self, number: BlockNumberOrTag) -> anyhow::Result<BlockHash> {
|
|
||||||
let provider = self.provider();
|
|
||||||
BlockingExecutor::execute(async move {
|
|
||||||
provider
|
|
||||||
.await?
|
|
||||||
.get_block_by_number(number)
|
|
||||||
.await?
|
|
||||||
.ok_or(anyhow::Error::msg("Blockchain has no blocks"))
|
|
||||||
.map(|block| block.header.hash)
|
|
||||||
})?
|
|
||||||
}
|
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
|
||||||
fn block_timestamp(&self, number: BlockNumberOrTag) -> anyhow::Result<BlockTimestamp> {
|
|
||||||
let provider = self.provider();
|
|
||||||
BlockingExecutor::execute(async move {
|
|
||||||
provider
|
|
||||||
.await?
|
|
||||||
.get_block_by_number(number)
|
|
||||||
.await?
|
|
||||||
.ok_or(anyhow::Error::msg("Blockchain has no blocks"))
|
|
||||||
.map(|block| block.header.timestamp)
|
|
||||||
})?
|
|
||||||
}
|
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
|
||||||
fn last_block_number(&self) -> anyhow::Result<BlockNumber> {
|
|
||||||
let provider = self.provider();
|
|
||||||
BlockingExecutor::execute(async move {
|
|
||||||
provider.await?.get_block_number().await.map_err(Into::into)
|
|
||||||
})?
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Node for Instance {
|
impl ResolverApi for GethNode {
|
||||||
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
|
async fn chain_id(&self) -> anyhow::Result<alloy::primitives::ChainId> {
|
||||||
|
self.provider()
|
||||||
|
.await
|
||||||
|
.context("Failed to get the Geth provider")?
|
||||||
|
.get_chain_id()
|
||||||
|
.await
|
||||||
|
.map_err(Into::into)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
|
async fn transaction_gas_price(&self, tx_hash: &TxHash) -> anyhow::Result<u128> {
|
||||||
|
self.provider()
|
||||||
|
.await
|
||||||
|
.context("Failed to get the Geth provider")?
|
||||||
|
.get_transaction_receipt(*tx_hash)
|
||||||
|
.await?
|
||||||
|
.context("Failed to get the transaction receipt")
|
||||||
|
.map(|receipt| receipt.effective_gas_price)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
|
async fn block_gas_limit(&self, number: BlockNumberOrTag) -> anyhow::Result<u128> {
|
||||||
|
self.provider()
|
||||||
|
.await
|
||||||
|
.context("Failed to get the Geth provider")?
|
||||||
|
.get_block_by_number(number)
|
||||||
|
.await
|
||||||
|
.context("Failed to get the geth block")?
|
||||||
|
.context("Failed to get the Geth block, perhaps there are no blocks?")
|
||||||
|
.map(|block| block.header.gas_limit as _)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
|
async fn block_coinbase(&self, number: BlockNumberOrTag) -> anyhow::Result<Address> {
|
||||||
|
self.provider()
|
||||||
|
.await
|
||||||
|
.context("Failed to get the Geth provider")?
|
||||||
|
.get_block_by_number(number)
|
||||||
|
.await
|
||||||
|
.context("Failed to get the geth block")?
|
||||||
|
.context("Failed to get the Geth block, perhaps there are no blocks?")
|
||||||
|
.map(|block| block.header.beneficiary)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
|
async fn block_difficulty(&self, number: BlockNumberOrTag) -> anyhow::Result<U256> {
|
||||||
|
self.provider()
|
||||||
|
.await
|
||||||
|
.context("Failed to get the Geth provider")?
|
||||||
|
.get_block_by_number(number)
|
||||||
|
.await
|
||||||
|
.context("Failed to get the geth block")?
|
||||||
|
.context("Failed to get the Geth block, perhaps there are no blocks?")
|
||||||
|
.map(|block| U256::from_be_bytes(block.header.mix_hash.0))
|
||||||
|
}
|
||||||
|
|
||||||
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
|
async fn block_base_fee(&self, number: BlockNumberOrTag) -> anyhow::Result<u64> {
|
||||||
|
self.provider()
|
||||||
|
.await
|
||||||
|
.context("Failed to get the Geth provider")?
|
||||||
|
.get_block_by_number(number)
|
||||||
|
.await
|
||||||
|
.context("Failed to get the geth block")?
|
||||||
|
.context("Failed to get the Geth block, perhaps there are no blocks?")
|
||||||
|
.and_then(|block| {
|
||||||
|
block
|
||||||
|
.header
|
||||||
|
.base_fee_per_gas
|
||||||
|
.context("Failed to get the base fee per gas")
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
|
async fn block_hash(&self, number: BlockNumberOrTag) -> anyhow::Result<BlockHash> {
|
||||||
|
self.provider()
|
||||||
|
.await
|
||||||
|
.context("Failed to get the Geth provider")?
|
||||||
|
.get_block_by_number(number)
|
||||||
|
.await
|
||||||
|
.context("Failed to get the geth block")?
|
||||||
|
.context("Failed to get the Geth block, perhaps there are no blocks?")
|
||||||
|
.map(|block| block.header.hash)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
|
async fn block_timestamp(&self, number: BlockNumberOrTag) -> anyhow::Result<BlockTimestamp> {
|
||||||
|
self.provider()
|
||||||
|
.await
|
||||||
|
.context("Failed to get the Geth provider")?
|
||||||
|
.get_block_by_number(number)
|
||||||
|
.await
|
||||||
|
.context("Failed to get the geth block")?
|
||||||
|
.context("Failed to get the Geth block, perhaps there are no blocks?")
|
||||||
|
.map(|block| block.header.timestamp)
|
||||||
|
}
|
||||||
|
|
||||||
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
|
async fn last_block_number(&self) -> anyhow::Result<BlockNumber> {
|
||||||
|
self.provider()
|
||||||
|
.await
|
||||||
|
.context("Failed to get the Geth provider")?
|
||||||
|
.get_block_number()
|
||||||
|
.await
|
||||||
|
.map_err(Into::into)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Node for GethNode {
|
||||||
fn new(config: &Arguments) -> Self {
|
fn new(config: &Arguments) -> Self {
|
||||||
let geth_directory = config.directory().join(Self::BASE_DIRECTORY);
|
let geth_directory = config.directory().join(Self::BASE_DIRECTORY);
|
||||||
let id = NODE_COUNT.fetch_add(1, Ordering::SeqCst);
|
let id = NODE_COUNT.fetch_add(1, Ordering::SeqCst);
|
||||||
@@ -453,22 +578,27 @@ impl Node for Instance {
|
|||||||
geth: config.geth.clone(),
|
geth: config.geth.clone(),
|
||||||
id,
|
id,
|
||||||
handle: None,
|
handle: None,
|
||||||
network_id: config.network_id,
|
|
||||||
start_timeout: config.geth_start_timeout,
|
start_timeout: config.geth_start_timeout,
|
||||||
wallet,
|
wallet: Arc::new(wallet),
|
||||||
|
chain_id_filler: Default::default(),
|
||||||
|
nonce_manager: Default::default(),
|
||||||
// We know that we only need to be storing 2 files so we can specify that when creating
|
// We know that we only need to be storing 2 files so we can specify that when creating
|
||||||
// the vector. It's the stdout and stderr of the geth node.
|
// the vector. It's the stdout and stderr of the geth node.
|
||||||
logs_file_to_flush: Vec::with_capacity(2),
|
logs_file_to_flush: Vec::with_capacity(2),
|
||||||
nonce_manager: Default::default(),
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
|
fn id(&self) -> usize {
|
||||||
|
self.id as _
|
||||||
|
}
|
||||||
|
|
||||||
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
fn connection_string(&self) -> String {
|
fn connection_string(&self) -> String {
|
||||||
self.connection_string.clone()
|
self.connection_string.clone()
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
fn shutdown(&mut self) -> anyhow::Result<()> {
|
fn shutdown(&mut self) -> anyhow::Result<()> {
|
||||||
// Terminate the processes in a graceful manner to allow for the output to be flushed.
|
// Terminate the processes in a graceful manner to allow for the output to be flushed.
|
||||||
if let Some(mut child) = self.handle.take() {
|
if let Some(mut child) = self.handle.take() {
|
||||||
@@ -490,36 +620,41 @@ impl Node for Instance {
|
|||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
fn spawn(&mut self, genesis: String) -> anyhow::Result<()> {
|
fn spawn(&mut self, genesis: String) -> anyhow::Result<()> {
|
||||||
self.init(genesis)?.spawn_process()?;
|
self.init(genesis)?.spawn_process()?;
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
fn version(&self) -> anyhow::Result<String> {
|
fn version(&self) -> anyhow::Result<String> {
|
||||||
let output = Command::new(&self.geth)
|
let output = Command::new(&self.geth)
|
||||||
.arg("--version")
|
.arg("--version")
|
||||||
.stdin(Stdio::null())
|
.stdin(Stdio::null())
|
||||||
.stdout(Stdio::piped())
|
.stdout(Stdio::piped())
|
||||||
.stderr(Stdio::null())
|
.stderr(Stdio::null())
|
||||||
.spawn()?
|
.spawn()
|
||||||
.wait_with_output()?
|
.context("Failed to spawn geth --version process")?
|
||||||
|
.wait_with_output()
|
||||||
|
.context("Failed to wait for geth --version output")?
|
||||||
.stdout;
|
.stdout;
|
||||||
Ok(String::from_utf8_lossy(&output).into())
|
Ok(String::from_utf8_lossy(&output).into())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
fn matches_target(targets: Option<&[String]>) -> bool {
|
||||||
fn matches_target(&self, targets: Option<&[String]>) -> bool {
|
|
||||||
match targets {
|
match targets {
|
||||||
None => true,
|
None => true,
|
||||||
Some(targets) => targets.iter().any(|str| str.as_str() == "evm"),
|
Some(targets) => targets.iter().any(|str| str.as_str() == "evm"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn evm_version() -> EVMVersion {
|
||||||
|
EVMVersion::Cancun
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Drop for Instance {
|
impl Drop for GethNode {
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
#[instrument(level = "info", skip_all, fields(geth_node_id = self.id))]
|
||||||
fn drop(&mut self) {
|
fn drop(&mut self) {
|
||||||
self.shutdown().expect("Failed to shutdown")
|
self.shutdown().expect("Failed to shutdown")
|
||||||
}
|
}
|
||||||
@@ -543,9 +678,9 @@ mod tests {
|
|||||||
(config, temp_dir)
|
(config, temp_dir)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn new_node() -> (Instance, TempDir) {
|
fn new_node() -> (GethNode, TempDir) {
|
||||||
let (args, temp_dir) = test_config();
|
let (args, temp_dir) = test_config();
|
||||||
let mut node = Instance::new(&args);
|
let mut node = GethNode::new(&args);
|
||||||
node.init(GENESIS_JSON.to_owned())
|
node.init(GENESIS_JSON.to_owned())
|
||||||
.expect("Failed to initialize the node")
|
.expect("Failed to initialize the node")
|
||||||
.spawn_process()
|
.spawn_process()
|
||||||
@@ -555,110 +690,110 @@ mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn init_works() {
|
fn init_works() {
|
||||||
Instance::new(&test_config().0)
|
GethNode::new(&test_config().0)
|
||||||
.init(GENESIS_JSON.to_string())
|
.init(GENESIS_JSON.to_string())
|
||||||
.unwrap();
|
.unwrap();
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn spawn_works() {
|
fn spawn_works() {
|
||||||
Instance::new(&test_config().0)
|
GethNode::new(&test_config().0)
|
||||||
.spawn(GENESIS_JSON.to_string())
|
.spawn(GENESIS_JSON.to_string())
|
||||||
.unwrap();
|
.unwrap();
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn version_works() {
|
fn version_works() {
|
||||||
let version = Instance::new(&test_config().0).version().unwrap();
|
let version = GethNode::new(&test_config().0).version().unwrap();
|
||||||
assert!(
|
assert!(
|
||||||
version.starts_with("geth version"),
|
version.starts_with("geth version"),
|
||||||
"expected version string, got: '{version}'"
|
"expected version string, got: '{version}'"
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[tokio::test]
|
||||||
fn can_get_chain_id_from_node() {
|
async fn can_get_chain_id_from_node() {
|
||||||
// Arrange
|
// Arrange
|
||||||
let (node, _temp_dir) = new_node();
|
let (node, _temp_dir) = new_node();
|
||||||
|
|
||||||
// Act
|
// Act
|
||||||
let chain_id = node.chain_id();
|
let chain_id = node.chain_id().await;
|
||||||
|
|
||||||
// Assert
|
// Assert
|
||||||
let chain_id = chain_id.expect("Failed to get the chain id");
|
let chain_id = chain_id.expect("Failed to get the chain id");
|
||||||
assert_eq!(chain_id, 420_420_420);
|
assert_eq!(chain_id, 420_420_420);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[tokio::test]
|
||||||
fn can_get_gas_limit_from_node() {
|
async fn can_get_gas_limit_from_node() {
|
||||||
// Arrange
|
// Arrange
|
||||||
let (node, _temp_dir) = new_node();
|
let (node, _temp_dir) = new_node();
|
||||||
|
|
||||||
// Act
|
// Act
|
||||||
let gas_limit = node.block_gas_limit(BlockNumberOrTag::Latest);
|
let gas_limit = node.block_gas_limit(BlockNumberOrTag::Latest).await;
|
||||||
|
|
||||||
// Assert
|
// Assert
|
||||||
let gas_limit = gas_limit.expect("Failed to get the gas limit");
|
let gas_limit = gas_limit.expect("Failed to get the gas limit");
|
||||||
assert_eq!(gas_limit, u32::MAX as u128)
|
assert_eq!(gas_limit, u32::MAX as u128)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[tokio::test]
|
||||||
fn can_get_coinbase_from_node() {
|
async fn can_get_coinbase_from_node() {
|
||||||
// Arrange
|
// Arrange
|
||||||
let (node, _temp_dir) = new_node();
|
let (node, _temp_dir) = new_node();
|
||||||
|
|
||||||
// Act
|
// Act
|
||||||
let coinbase = node.block_coinbase(BlockNumberOrTag::Latest);
|
let coinbase = node.block_coinbase(BlockNumberOrTag::Latest).await;
|
||||||
|
|
||||||
// Assert
|
// Assert
|
||||||
let coinbase = coinbase.expect("Failed to get the coinbase");
|
let coinbase = coinbase.expect("Failed to get the coinbase");
|
||||||
assert_eq!(coinbase, Address::new([0xFF; 20]))
|
assert_eq!(coinbase, Address::new([0xFF; 20]))
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[tokio::test]
|
||||||
fn can_get_block_difficulty_from_node() {
|
async fn can_get_block_difficulty_from_node() {
|
||||||
// Arrange
|
// Arrange
|
||||||
let (node, _temp_dir) = new_node();
|
let (node, _temp_dir) = new_node();
|
||||||
|
|
||||||
// Act
|
// Act
|
||||||
let block_difficulty = node.block_difficulty(BlockNumberOrTag::Latest);
|
let block_difficulty = node.block_difficulty(BlockNumberOrTag::Latest).await;
|
||||||
|
|
||||||
// Assert
|
// Assert
|
||||||
let block_difficulty = block_difficulty.expect("Failed to get the block difficulty");
|
let block_difficulty = block_difficulty.expect("Failed to get the block difficulty");
|
||||||
assert_eq!(block_difficulty, U256::ZERO)
|
assert_eq!(block_difficulty, U256::ZERO)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[tokio::test]
|
||||||
fn can_get_block_hash_from_node() {
|
async fn can_get_block_hash_from_node() {
|
||||||
// Arrange
|
// Arrange
|
||||||
let (node, _temp_dir) = new_node();
|
let (node, _temp_dir) = new_node();
|
||||||
|
|
||||||
// Act
|
// Act
|
||||||
let block_hash = node.block_hash(BlockNumberOrTag::Latest);
|
let block_hash = node.block_hash(BlockNumberOrTag::Latest).await;
|
||||||
|
|
||||||
// Assert
|
// Assert
|
||||||
let _ = block_hash.expect("Failed to get the block hash");
|
let _ = block_hash.expect("Failed to get the block hash");
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[tokio::test]
|
||||||
fn can_get_block_timestamp_from_node() {
|
async fn can_get_block_timestamp_from_node() {
|
||||||
// Arrange
|
// Arrange
|
||||||
let (node, _temp_dir) = new_node();
|
let (node, _temp_dir) = new_node();
|
||||||
|
|
||||||
// Act
|
// Act
|
||||||
let block_timestamp = node.block_timestamp(BlockNumberOrTag::Latest);
|
let block_timestamp = node.block_timestamp(BlockNumberOrTag::Latest).await;
|
||||||
|
|
||||||
// Assert
|
// Assert
|
||||||
let _ = block_timestamp.expect("Failed to get the block timestamp");
|
let _ = block_timestamp.expect("Failed to get the block timestamp");
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[tokio::test]
|
||||||
fn can_get_block_number_from_node() {
|
async fn can_get_block_number_from_node() {
|
||||||
// Arrange
|
// Arrange
|
||||||
let (node, _temp_dir) = new_node();
|
let (node, _temp_dir) = new_node();
|
||||||
|
|
||||||
// Act
|
// Act
|
||||||
let block_number = node.last_block_number();
|
let block_number = node.last_block_number().await;
|
||||||
|
|
||||||
// Assert
|
// Assert
|
||||||
let block_number = block_number.expect("Failed to get the block number");
|
let block_number = block_number.expect("Failed to get the block number");
|
||||||
|
|||||||
+306
-228
@@ -3,7 +3,10 @@ use std::{
|
|||||||
io::{BufRead, Write},
|
io::{BufRead, Write},
|
||||||
path::{Path, PathBuf},
|
path::{Path, PathBuf},
|
||||||
process::{Child, Command, Stdio},
|
process::{Child, Command, Stdio},
|
||||||
sync::atomic::{AtomicU32, Ordering},
|
sync::{
|
||||||
|
Arc,
|
||||||
|
atomic::{AtomicU32, Ordering},
|
||||||
|
},
|
||||||
time::Duration,
|
time::Duration,
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -16,7 +19,8 @@ use alloy::{
|
|||||||
TransactionBuilderError, UnbuiltTransactionError,
|
TransactionBuilderError, UnbuiltTransactionError,
|
||||||
},
|
},
|
||||||
primitives::{
|
primitives::{
|
||||||
Address, B64, B256, BlockHash, BlockNumber, BlockTimestamp, Bloom, Bytes, FixedBytes, U256,
|
Address, B64, B256, BlockHash, BlockNumber, BlockTimestamp, Bloom, Bytes, FixedBytes,
|
||||||
|
StorageKey, TxHash, U256,
|
||||||
},
|
},
|
||||||
providers::{
|
providers::{
|
||||||
Provider, ProviderBuilder,
|
Provider, ProviderBuilder,
|
||||||
@@ -24,20 +28,21 @@ use alloy::{
|
|||||||
fillers::{CachedNonceManager, ChainIdFiller, FillProvider, NonceFiller, TxFiller},
|
fillers::{CachedNonceManager, ChainIdFiller, FillProvider, NonceFiller, TxFiller},
|
||||||
},
|
},
|
||||||
rpc::types::{
|
rpc::types::{
|
||||||
TransactionReceipt,
|
EIP1186AccountProofResponse, TransactionReceipt,
|
||||||
eth::{Block, Header, Transaction},
|
eth::{Block, Header, Transaction},
|
||||||
trace::geth::{DiffMode, GethDebugTracingOptions, PreStateConfig, PreStateFrame},
|
trace::geth::{DiffMode, GethDebugTracingOptions, PreStateConfig, PreStateFrame},
|
||||||
},
|
},
|
||||||
signers::local::PrivateKeySigner,
|
signers::local::PrivateKeySigner,
|
||||||
};
|
};
|
||||||
|
use anyhow::Context;
|
||||||
|
use revive_common::EVMVersion;
|
||||||
|
use revive_dt_common::fs::clear_directory;
|
||||||
use revive_dt_format::traits::ResolverApi;
|
use revive_dt_format::traits::ResolverApi;
|
||||||
use serde::{Deserialize, Serialize};
|
use serde::{Deserialize, Serialize};
|
||||||
use serde_json::{Value as JsonValue, json};
|
use serde_json::{Value as JsonValue, json};
|
||||||
use sp_core::crypto::Ss58Codec;
|
use sp_core::crypto::Ss58Codec;
|
||||||
use sp_runtime::AccountId32;
|
use sp_runtime::AccountId32;
|
||||||
use tracing::Level;
|
|
||||||
|
|
||||||
use revive_dt_common::concepts::BlockingExecutor;
|
|
||||||
use revive_dt_config::Arguments;
|
use revive_dt_config::Arguments;
|
||||||
use revive_dt_node_interaction::EthereumNode;
|
use revive_dt_node_interaction::EthereumNode;
|
||||||
|
|
||||||
@@ -49,14 +54,17 @@ static NODE_COUNT: AtomicU32 = AtomicU32::new(0);
|
|||||||
pub struct KitchensinkNode {
|
pub struct KitchensinkNode {
|
||||||
id: u32,
|
id: u32,
|
||||||
substrate_binary: PathBuf,
|
substrate_binary: PathBuf,
|
||||||
|
dev_node_binary: PathBuf,
|
||||||
eth_proxy_binary: PathBuf,
|
eth_proxy_binary: PathBuf,
|
||||||
rpc_url: String,
|
rpc_url: String,
|
||||||
wallet: EthereumWallet,
|
|
||||||
base_directory: PathBuf,
|
base_directory: PathBuf,
|
||||||
logs_directory: PathBuf,
|
logs_directory: PathBuf,
|
||||||
process_substrate: Option<Child>,
|
process_substrate: Option<Child>,
|
||||||
process_proxy: Option<Child>,
|
process_proxy: Option<Child>,
|
||||||
|
wallet: Arc<EthereumWallet>,
|
||||||
nonce_manager: CachedNonceManager,
|
nonce_manager: CachedNonceManager,
|
||||||
|
chain_id_filler: ChainIdFiller,
|
||||||
|
use_kitchensink_not_dev_node: bool,
|
||||||
/// This vector stores [`File`] objects that we use for logging which we want to flush when the
|
/// This vector stores [`File`] objects that we use for logging which we want to flush when the
|
||||||
/// node object is dropped. We do not store them in a structured fashion at the moment (in
|
/// node object is dropped. We do not store them in a structured fashion at the moment (in
|
||||||
/// separate fields) as the logic that we need to apply to them is all the same regardless of
|
/// separate fields) as the logic that we need to apply to them is all the same regardless of
|
||||||
@@ -84,20 +92,34 @@ impl KitchensinkNode {
|
|||||||
const PROXY_STDOUT_LOG_FILE_NAME: &str = "proxy_stdout.log";
|
const PROXY_STDOUT_LOG_FILE_NAME: &str = "proxy_stdout.log";
|
||||||
const PROXY_STDERR_LOG_FILE_NAME: &str = "proxy_stderr.log";
|
const PROXY_STDERR_LOG_FILE_NAME: &str = "proxy_stderr.log";
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
fn init(&mut self, genesis: &str) -> anyhow::Result<&mut Self> {
|
fn init(&mut self, genesis: &str) -> anyhow::Result<&mut Self> {
|
||||||
create_dir_all(&self.base_directory)?;
|
let _ = clear_directory(&self.base_directory);
|
||||||
create_dir_all(&self.logs_directory)?;
|
let _ = clear_directory(&self.logs_directory);
|
||||||
|
|
||||||
|
create_dir_all(&self.base_directory)
|
||||||
|
.context("Failed to create base directory for kitchensink node")?;
|
||||||
|
create_dir_all(&self.logs_directory)
|
||||||
|
.context("Failed to create logs directory for kitchensink node")?;
|
||||||
|
|
||||||
let template_chainspec_path = self.base_directory.join(Self::CHAIN_SPEC_JSON_FILE);
|
let template_chainspec_path = self.base_directory.join(Self::CHAIN_SPEC_JSON_FILE);
|
||||||
|
|
||||||
// Note: we do not pipe the logs of this process to a separate file since this is just a
|
// Note: we do not pipe the logs of this process to a separate file since this is just a
|
||||||
// once-off export of the default chain spec and not part of the long-running node process.
|
// once-off export of the default chain spec and not part of the long-running node process.
|
||||||
let output = Command::new(&self.substrate_binary)
|
let output = if self.use_kitchensink_not_dev_node {
|
||||||
.arg("export-chain-spec")
|
Command::new(&self.substrate_binary)
|
||||||
.arg("--chain")
|
.arg("export-chain-spec")
|
||||||
.arg("dev")
|
.arg("--chain")
|
||||||
.output()?;
|
.arg("dev")
|
||||||
|
.output()
|
||||||
|
.context("Failed to export the chain-spec")?
|
||||||
|
} else {
|
||||||
|
Command::new(&self.dev_node_binary)
|
||||||
|
.arg("build-spec")
|
||||||
|
.arg("--chain")
|
||||||
|
.arg("dev")
|
||||||
|
.output()
|
||||||
|
.context("Failed to export the chain-spec")?
|
||||||
|
};
|
||||||
|
|
||||||
if !output.status.success() {
|
if !output.status.success() {
|
||||||
anyhow::bail!(
|
anyhow::bail!(
|
||||||
@@ -106,8 +128,10 @@ impl KitchensinkNode {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
let content = String::from_utf8(output.stdout)?;
|
let content = String::from_utf8(output.stdout)
|
||||||
let mut chainspec_json: JsonValue = serde_json::from_str(&content)?;
|
.context("Failed to decode substrate export-chain-spec output as UTF-8")?;
|
||||||
|
let mut chainspec_json: JsonValue =
|
||||||
|
serde_json::from_str(&content).context("Failed to parse substrate chain spec JSON")?;
|
||||||
|
|
||||||
let existing_chainspec_balances =
|
let existing_chainspec_balances =
|
||||||
chainspec_json["genesis"]["runtimeGenesis"]["patch"]["balances"]["balances"]
|
chainspec_json["genesis"]["runtimeGenesis"]["patch"]["balances"]["balances"]
|
||||||
@@ -129,7 +153,8 @@ impl KitchensinkNode {
|
|||||||
})
|
})
|
||||||
.collect();
|
.collect();
|
||||||
let mut eth_balances = {
|
let mut eth_balances = {
|
||||||
let mut genesis = serde_json::from_str::<Genesis>(genesis)?;
|
let mut genesis = serde_json::from_str::<Genesis>(genesis)
|
||||||
|
.context("Failed to deserialize EVM genesis JSON for kitchensink")?;
|
||||||
for signer_address in
|
for signer_address in
|
||||||
<EthereumWallet as NetworkWallet<Ethereum>>::signer_addresses(&self.wallet)
|
<EthereumWallet as NetworkWallet<Ethereum>>::signer_addresses(&self.wallet)
|
||||||
{
|
{
|
||||||
@@ -140,7 +165,8 @@ impl KitchensinkNode {
|
|||||||
.entry(signer_address)
|
.entry(signer_address)
|
||||||
.or_insert(GenesisAccount::default().with_balance(U256::from(INITIAL_BALANCE)));
|
.or_insert(GenesisAccount::default().with_balance(U256::from(INITIAL_BALANCE)));
|
||||||
}
|
}
|
||||||
self.extract_balance_from_genesis_file(&genesis)?
|
self.extract_balance_from_genesis_file(&genesis)
|
||||||
|
.context("Failed to extract balances from EVM genesis JSON")?
|
||||||
};
|
};
|
||||||
merged_balances.append(&mut eth_balances);
|
merged_balances.append(&mut eth_balances);
|
||||||
|
|
||||||
@@ -148,13 +174,14 @@ impl KitchensinkNode {
|
|||||||
json!(merged_balances);
|
json!(merged_balances);
|
||||||
|
|
||||||
serde_json::to_writer_pretty(
|
serde_json::to_writer_pretty(
|
||||||
std::fs::File::create(&template_chainspec_path)?,
|
std::fs::File::create(&template_chainspec_path)
|
||||||
|
.context("Failed to create kitchensink template chainspec file")?,
|
||||||
&chainspec_json,
|
&chainspec_json,
|
||||||
)?;
|
)
|
||||||
|
.context("Failed to write kitchensink template chainspec JSON")?;
|
||||||
Ok(self)
|
Ok(self)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
fn spawn_process(&mut self) -> anyhow::Result<()> {
|
fn spawn_process(&mut self) -> anyhow::Result<()> {
|
||||||
let substrate_rpc_port = Self::BASE_SUBSTRATE_RPC_PORT + self.id as u16;
|
let substrate_rpc_port = Self::BASE_SUBSTRATE_RPC_PORT + self.id as u16;
|
||||||
let proxy_rpc_port = Self::BASE_PROXY_RPC_PORT + self.id as u16;
|
let proxy_rpc_port = Self::BASE_PROXY_RPC_PORT + self.id as u16;
|
||||||
@@ -177,11 +204,18 @@ impl KitchensinkNode {
|
|||||||
// Start Substrate node
|
// Start Substrate node
|
||||||
let kitchensink_stdout_logs_file = open_options
|
let kitchensink_stdout_logs_file = open_options
|
||||||
.clone()
|
.clone()
|
||||||
.open(self.kitchensink_stdout_log_file_path())?;
|
.open(self.kitchensink_stdout_log_file_path())
|
||||||
|
.context("Failed to open kitchensink stdout logs file")?;
|
||||||
let kitchensink_stderr_logs_file = open_options
|
let kitchensink_stderr_logs_file = open_options
|
||||||
.clone()
|
.clone()
|
||||||
.open(self.kitchensink_stderr_log_file_path())?;
|
.open(self.kitchensink_stderr_log_file_path())
|
||||||
self.process_substrate = Command::new(&self.substrate_binary)
|
.context("Failed to open kitchensink stderr logs file")?;
|
||||||
|
let node_binary_path = if self.use_kitchensink_not_dev_node {
|
||||||
|
self.substrate_binary.as_path()
|
||||||
|
} else {
|
||||||
|
self.dev_node_binary.as_path()
|
||||||
|
};
|
||||||
|
self.process_substrate = Command::new(node_binary_path)
|
||||||
.arg("--dev")
|
.arg("--dev")
|
||||||
.arg("--chain")
|
.arg("--chain")
|
||||||
.arg(chainspec_path)
|
.arg(chainspec_path)
|
||||||
@@ -196,49 +230,71 @@ impl KitchensinkNode {
|
|||||||
.arg("Unsafe")
|
.arg("Unsafe")
|
||||||
.arg("--rpc-cors")
|
.arg("--rpc-cors")
|
||||||
.arg("all")
|
.arg("all")
|
||||||
|
.arg("--rpc-max-connections")
|
||||||
|
.arg(u32::MAX.to_string())
|
||||||
.env("RUST_LOG", Self::SUBSTRATE_LOG_ENV)
|
.env("RUST_LOG", Self::SUBSTRATE_LOG_ENV)
|
||||||
.stdout(kitchensink_stdout_logs_file.try_clone()?)
|
.stdout(
|
||||||
.stderr(kitchensink_stderr_logs_file.try_clone()?)
|
kitchensink_stdout_logs_file
|
||||||
.spawn()?
|
.try_clone()
|
||||||
|
.context("Failed to clone kitchensink stdout log file handle")?,
|
||||||
|
)
|
||||||
|
.stderr(
|
||||||
|
kitchensink_stderr_logs_file
|
||||||
|
.try_clone()
|
||||||
|
.context("Failed to clone kitchensink stderr log file handle")?,
|
||||||
|
)
|
||||||
|
.spawn()
|
||||||
|
.context("Failed to spawn substrate node process")?
|
||||||
.into();
|
.into();
|
||||||
|
|
||||||
// Give the node a moment to boot
|
// Give the node a moment to boot
|
||||||
if let Err(error) = Self::wait_ready(
|
if let Err(error) = Self::wait_ready(
|
||||||
self.kitchensink_stderr_log_file_path().as_path(),
|
self.kitchensink_stderr_log_file_path().as_path(),
|
||||||
Self::SUBSTRATE_READY_MARKER,
|
Self::SUBSTRATE_READY_MARKER,
|
||||||
Duration::from_secs(30),
|
Duration::from_secs(60),
|
||||||
) {
|
) {
|
||||||
tracing::error!(
|
self.shutdown()
|
||||||
?error,
|
.context("Failed to gracefully shutdown after substrate start error")?;
|
||||||
"Failed to start substrate, shutting down gracefully"
|
|
||||||
);
|
|
||||||
self.shutdown()?;
|
|
||||||
return Err(error);
|
return Err(error);
|
||||||
};
|
};
|
||||||
|
|
||||||
let eth_proxy_stdout_logs_file = open_options
|
let eth_proxy_stdout_logs_file = open_options
|
||||||
.clone()
|
.clone()
|
||||||
.open(self.proxy_stdout_log_file_path())?;
|
.open(self.proxy_stdout_log_file_path())
|
||||||
let eth_proxy_stderr_logs_file = open_options.open(self.proxy_stderr_log_file_path())?;
|
.context("Failed to open eth-proxy stdout logs file")?;
|
||||||
|
let eth_proxy_stderr_logs_file = open_options
|
||||||
|
.open(self.proxy_stderr_log_file_path())
|
||||||
|
.context("Failed to open eth-proxy stderr logs file")?;
|
||||||
self.process_proxy = Command::new(&self.eth_proxy_binary)
|
self.process_proxy = Command::new(&self.eth_proxy_binary)
|
||||||
.arg("--dev")
|
.arg("--dev")
|
||||||
.arg("--rpc-port")
|
.arg("--rpc-port")
|
||||||
.arg(proxy_rpc_port.to_string())
|
.arg(proxy_rpc_port.to_string())
|
||||||
.arg("--node-rpc-url")
|
.arg("--node-rpc-url")
|
||||||
.arg(format!("ws://127.0.0.1:{substrate_rpc_port}"))
|
.arg(format!("ws://127.0.0.1:{substrate_rpc_port}"))
|
||||||
|
.arg("--rpc-max-connections")
|
||||||
|
.arg(u32::MAX.to_string())
|
||||||
.env("RUST_LOG", Self::PROXY_LOG_ENV)
|
.env("RUST_LOG", Self::PROXY_LOG_ENV)
|
||||||
.stdout(eth_proxy_stdout_logs_file.try_clone()?)
|
.stdout(
|
||||||
.stderr(eth_proxy_stderr_logs_file.try_clone()?)
|
eth_proxy_stdout_logs_file
|
||||||
.spawn()?
|
.try_clone()
|
||||||
|
.context("Failed to clone eth-proxy stdout log file handle")?,
|
||||||
|
)
|
||||||
|
.stderr(
|
||||||
|
eth_proxy_stderr_logs_file
|
||||||
|
.try_clone()
|
||||||
|
.context("Failed to clone eth-proxy stderr log file handle")?,
|
||||||
|
)
|
||||||
|
.spawn()
|
||||||
|
.context("Failed to spawn eth-proxy process")?
|
||||||
.into();
|
.into();
|
||||||
|
|
||||||
if let Err(error) = Self::wait_ready(
|
if let Err(error) = Self::wait_ready(
|
||||||
self.proxy_stderr_log_file_path().as_path(),
|
self.proxy_stderr_log_file_path().as_path(),
|
||||||
Self::ETH_PROXY_READY_MARKER,
|
Self::ETH_PROXY_READY_MARKER,
|
||||||
Duration::from_secs(30),
|
Duration::from_secs(60),
|
||||||
) {
|
) {
|
||||||
tracing::error!(?error, "Failed to start proxy, shutting down gracefully");
|
self.shutdown()
|
||||||
self.shutdown()?;
|
.context("Failed to gracefully shutdown after eth-proxy start error")?;
|
||||||
return Err(error);
|
return Err(error);
|
||||||
};
|
};
|
||||||
|
|
||||||
@@ -252,7 +308,6 @@ impl KitchensinkNode {
|
|||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
fn extract_balance_from_genesis_file(
|
fn extract_balance_from_genesis_file(
|
||||||
&self,
|
&self,
|
||||||
genesis: &Genesis,
|
genesis: &Genesis,
|
||||||
@@ -301,7 +356,6 @@ impl KitchensinkNode {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
pub fn eth_rpc_version(&self) -> anyhow::Result<String> {
|
pub fn eth_rpc_version(&self) -> anyhow::Result<String> {
|
||||||
let output = Command::new(&self.eth_proxy_binary)
|
let output = Command::new(&self.eth_proxy_binary)
|
||||||
.arg("--version")
|
.arg("--version")
|
||||||
@@ -314,200 +368,220 @@ impl KitchensinkNode {
|
|||||||
Ok(String::from_utf8_lossy(&output).trim().to_string())
|
Ok(String::from_utf8_lossy(&output).trim().to_string())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id), level = Level::TRACE)]
|
|
||||||
fn kitchensink_stdout_log_file_path(&self) -> PathBuf {
|
fn kitchensink_stdout_log_file_path(&self) -> PathBuf {
|
||||||
self.logs_directory
|
self.logs_directory
|
||||||
.join(Self::KITCHENSINK_STDOUT_LOG_FILE_NAME)
|
.join(Self::KITCHENSINK_STDOUT_LOG_FILE_NAME)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id), level = Level::TRACE)]
|
|
||||||
fn kitchensink_stderr_log_file_path(&self) -> PathBuf {
|
fn kitchensink_stderr_log_file_path(&self) -> PathBuf {
|
||||||
self.logs_directory
|
self.logs_directory
|
||||||
.join(Self::KITCHENSINK_STDERR_LOG_FILE_NAME)
|
.join(Self::KITCHENSINK_STDERR_LOG_FILE_NAME)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id), level = Level::TRACE)]
|
|
||||||
fn proxy_stdout_log_file_path(&self) -> PathBuf {
|
fn proxy_stdout_log_file_path(&self) -> PathBuf {
|
||||||
self.logs_directory.join(Self::PROXY_STDOUT_LOG_FILE_NAME)
|
self.logs_directory.join(Self::PROXY_STDOUT_LOG_FILE_NAME)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id), level = Level::TRACE)]
|
|
||||||
fn proxy_stderr_log_file_path(&self) -> PathBuf {
|
fn proxy_stderr_log_file_path(&self) -> PathBuf {
|
||||||
self.logs_directory.join(Self::PROXY_STDERR_LOG_FILE_NAME)
|
self.logs_directory.join(Self::PROXY_STDERR_LOG_FILE_NAME)
|
||||||
}
|
}
|
||||||
|
|
||||||
fn provider(
|
async fn provider(
|
||||||
&self,
|
&self,
|
||||||
) -> impl Future<
|
) -> anyhow::Result<
|
||||||
Output = anyhow::Result<
|
FillProvider<
|
||||||
FillProvider<
|
impl TxFiller<KitchenSinkNetwork>,
|
||||||
impl TxFiller<KitchenSinkNetwork>,
|
impl Provider<KitchenSinkNetwork>,
|
||||||
impl Provider<KitchenSinkNetwork>,
|
KitchenSinkNetwork,
|
||||||
KitchenSinkNetwork,
|
|
||||||
>,
|
|
||||||
>,
|
>,
|
||||||
> + 'static {
|
> {
|
||||||
let connection_string = self.connection_string();
|
ProviderBuilder::new()
|
||||||
let wallet = self.wallet.clone();
|
.disable_recommended_fillers()
|
||||||
|
.network::<KitchenSinkNetwork>()
|
||||||
// Note: We would like all providers to make use of the same nonce manager so that we have
|
.filler(FallbackGasFiller::new(
|
||||||
// monotonically increasing nonces that are cached. The cached nonce manager uses Arc's in
|
25_000_000,
|
||||||
// its implementation and therefore it means that when we clone it then it still references
|
1_000_000_000,
|
||||||
// the same state.
|
1_000_000_000,
|
||||||
let nonce_manager = self.nonce_manager.clone();
|
))
|
||||||
|
.filler(self.chain_id_filler.clone())
|
||||||
Box::pin(async move {
|
.filler(NonceFiller::new(self.nonce_manager.clone()))
|
||||||
ProviderBuilder::new()
|
.wallet(self.wallet.clone())
|
||||||
.disable_recommended_fillers()
|
.connect(&self.rpc_url)
|
||||||
.network::<KitchenSinkNetwork>()
|
.await
|
||||||
.filler(FallbackGasFiller::new(
|
.map_err(Into::into)
|
||||||
30_000_000,
|
|
||||||
200_000_000_000,
|
|
||||||
3_000_000_000,
|
|
||||||
))
|
|
||||||
.filler(ChainIdFiller::default())
|
|
||||||
.filler(NonceFiller::new(nonce_manager))
|
|
||||||
.wallet(wallet)
|
|
||||||
.connect(&connection_string)
|
|
||||||
.await
|
|
||||||
.map_err(Into::into)
|
|
||||||
})
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl EthereumNode for KitchensinkNode {
|
impl EthereumNode for KitchensinkNode {
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
async fn execute_transaction(
|
||||||
fn execute_transaction(
|
|
||||||
&self,
|
&self,
|
||||||
transaction: alloy::rpc::types::TransactionRequest,
|
transaction: alloy::rpc::types::TransactionRequest,
|
||||||
) -> anyhow::Result<TransactionReceipt> {
|
) -> anyhow::Result<TransactionReceipt> {
|
||||||
tracing::debug!(?transaction, "Submitting transaction");
|
let receipt = self
|
||||||
let provider = self.provider();
|
.provider()
|
||||||
let receipt = BlockingExecutor::execute(async move {
|
.await
|
||||||
Ok(provider
|
.context("Failed to create provider for transaction submission")?
|
||||||
.await?
|
.send_transaction(transaction)
|
||||||
.send_transaction(transaction)
|
.await
|
||||||
.await?
|
.context("Failed to submit transaction to kitchensink proxy")?
|
||||||
.get_receipt()
|
.get_receipt()
|
||||||
.await?)
|
.await
|
||||||
})?;
|
.context("Failed to fetch transaction receipt from kitchensink proxy")?;
|
||||||
tracing::info!(?receipt, "Submitted tx to kitchensink");
|
Ok(receipt)
|
||||||
receipt
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
async fn trace_transaction(
|
||||||
fn trace_transaction(
|
|
||||||
&self,
|
&self,
|
||||||
transaction: &TransactionReceipt,
|
transaction: &TransactionReceipt,
|
||||||
trace_options: GethDebugTracingOptions,
|
trace_options: GethDebugTracingOptions,
|
||||||
) -> anyhow::Result<alloy::rpc::types::trace::geth::GethTrace> {
|
) -> anyhow::Result<alloy::rpc::types::trace::geth::GethTrace> {
|
||||||
let tx_hash = transaction.transaction_hash;
|
let tx_hash = transaction.transaction_hash;
|
||||||
let provider = self.provider();
|
self.provider()
|
||||||
BlockingExecutor::execute(async move {
|
.await
|
||||||
Ok(provider
|
.context("Failed to create provider for debug tracing")?
|
||||||
.await?
|
.debug_trace_transaction(tx_hash, trace_options)
|
||||||
.debug_trace_transaction(tx_hash, trace_options)
|
.await
|
||||||
.await?)
|
.context("Failed to obtain debug trace from kitchensink proxy")
|
||||||
})?
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
async fn state_diff(&self, transaction: &TransactionReceipt) -> anyhow::Result<DiffMode> {
|
||||||
fn state_diff(&self, transaction: &TransactionReceipt) -> anyhow::Result<DiffMode> {
|
|
||||||
let trace_options = GethDebugTracingOptions::prestate_tracer(PreStateConfig {
|
let trace_options = GethDebugTracingOptions::prestate_tracer(PreStateConfig {
|
||||||
diff_mode: Some(true),
|
diff_mode: Some(true),
|
||||||
disable_code: None,
|
disable_code: None,
|
||||||
disable_storage: None,
|
disable_storage: None,
|
||||||
});
|
});
|
||||||
match self
|
match self
|
||||||
.trace_transaction(transaction, trace_options)?
|
.trace_transaction(transaction, trace_options)
|
||||||
|
.await?
|
||||||
.try_into_pre_state_frame()?
|
.try_into_pre_state_frame()?
|
||||||
{
|
{
|
||||||
PreStateFrame::Diff(diff) => Ok(diff),
|
PreStateFrame::Diff(diff) => Ok(diff),
|
||||||
_ => anyhow::bail!("expected a diff mode trace"),
|
_ => anyhow::bail!("expected a diff mode trace"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
async fn balance_of(&self, address: Address) -> anyhow::Result<U256> {
|
||||||
|
self.provider()
|
||||||
|
.await
|
||||||
|
.context("Failed to get the Kitchensink provider")?
|
||||||
|
.get_balance(address)
|
||||||
|
.await
|
||||||
|
.map_err(Into::into)
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn latest_state_proof(
|
||||||
|
&self,
|
||||||
|
address: Address,
|
||||||
|
keys: Vec<StorageKey>,
|
||||||
|
) -> anyhow::Result<EIP1186AccountProofResponse> {
|
||||||
|
self.provider()
|
||||||
|
.await
|
||||||
|
.context("Failed to get the Kitchensink provider")?
|
||||||
|
.get_proof(address, keys)
|
||||||
|
.latest()
|
||||||
|
.await
|
||||||
|
.map_err(Into::into)
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl ResolverApi for KitchensinkNode {
|
impl ResolverApi for KitchensinkNode {
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
async fn chain_id(&self) -> anyhow::Result<alloy::primitives::ChainId> {
|
||||||
fn chain_id(&self) -> anyhow::Result<alloy::primitives::ChainId> {
|
self.provider()
|
||||||
let provider = self.provider();
|
.await
|
||||||
BlockingExecutor::execute(async move {
|
.context("Failed to get the Kitchensink provider")?
|
||||||
provider.await?.get_chain_id().await.map_err(Into::into)
|
.get_chain_id()
|
||||||
})?
|
.await
|
||||||
|
.map_err(Into::into)
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
async fn transaction_gas_price(&self, tx_hash: &TxHash) -> anyhow::Result<u128> {
|
||||||
fn block_gas_limit(&self, number: BlockNumberOrTag) -> anyhow::Result<u128> {
|
self.provider()
|
||||||
let provider = self.provider();
|
.await
|
||||||
BlockingExecutor::execute(async move {
|
.context("Failed to get the Kitchensink provider")?
|
||||||
provider
|
.get_transaction_receipt(*tx_hash)
|
||||||
.await?
|
.await?
|
||||||
.get_block_by_number(number)
|
.context("Failed to get the transaction receipt")
|
||||||
.await?
|
.map(|receipt| receipt.effective_gas_price)
|
||||||
.ok_or(anyhow::Error::msg("Blockchain has no blocks"))
|
|
||||||
.map(|block| block.header.gas_limit)
|
|
||||||
})?
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
async fn block_gas_limit(&self, number: BlockNumberOrTag) -> anyhow::Result<u128> {
|
||||||
fn block_coinbase(&self, number: BlockNumberOrTag) -> anyhow::Result<Address> {
|
self.provider()
|
||||||
let provider = self.provider();
|
.await
|
||||||
BlockingExecutor::execute(async move {
|
.context("Failed to get the Kitchensink provider")?
|
||||||
provider
|
.get_block_by_number(number)
|
||||||
.await?
|
.await
|
||||||
.get_block_by_number(number)
|
.context("Failed to get the kitchensink block")?
|
||||||
.await?
|
.context("Failed to get the Kitchensink block, perhaps the chain has no blocks?")
|
||||||
.ok_or(anyhow::Error::msg("Blockchain has no blocks"))
|
.map(|block| block.header.gas_limit as _)
|
||||||
.map(|block| block.header.beneficiary)
|
|
||||||
})?
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
async fn block_coinbase(&self, number: BlockNumberOrTag) -> anyhow::Result<Address> {
|
||||||
fn block_difficulty(&self, number: BlockNumberOrTag) -> anyhow::Result<U256> {
|
self.provider()
|
||||||
let provider = self.provider();
|
.await
|
||||||
BlockingExecutor::execute(async move {
|
.context("Failed to get the Kitchensink provider")?
|
||||||
provider
|
.get_block_by_number(number)
|
||||||
.await?
|
.await
|
||||||
.get_block_by_number(number)
|
.context("Failed to get the kitchensink block")?
|
||||||
.await?
|
.context("Failed to get the Kitchensink block, perhaps the chain has no blocks?")
|
||||||
.ok_or(anyhow::Error::msg("Blockchain has no blocks"))
|
.map(|block| block.header.beneficiary)
|
||||||
.map(|block| block.header.difficulty)
|
|
||||||
})?
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
async fn block_difficulty(&self, number: BlockNumberOrTag) -> anyhow::Result<U256> {
|
||||||
fn block_hash(&self, number: BlockNumberOrTag) -> anyhow::Result<BlockHash> {
|
self.provider()
|
||||||
let provider = self.provider();
|
.await
|
||||||
BlockingExecutor::execute(async move {
|
.context("Failed to get the Kitchensink provider")?
|
||||||
provider
|
.get_block_by_number(number)
|
||||||
.await?
|
.await
|
||||||
.get_block_by_number(number)
|
.context("Failed to get the kitchensink block")?
|
||||||
.await?
|
.context("Failed to get the Kitchensink block, perhaps the chain has no blocks?")
|
||||||
.ok_or(anyhow::Error::msg("Blockchain has no blocks"))
|
.map(|block| U256::from_be_bytes(block.header.mix_hash.0))
|
||||||
.map(|block| block.header.hash)
|
|
||||||
})?
|
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
async fn block_base_fee(&self, number: BlockNumberOrTag) -> anyhow::Result<u64> {
|
||||||
fn block_timestamp(&self, number: BlockNumberOrTag) -> anyhow::Result<BlockTimestamp> {
|
self.provider()
|
||||||
let provider = self.provider();
|
.await
|
||||||
BlockingExecutor::execute(async move {
|
.context("Failed to get the Kitchensink provider")?
|
||||||
provider
|
.get_block_by_number(number)
|
||||||
.await?
|
.await
|
||||||
.get_block_by_number(number)
|
.context("Failed to get the kitchensink block")?
|
||||||
.await?
|
.context("Failed to get the Kitchensink block, perhaps the chain has no blocks?")
|
||||||
.ok_or(anyhow::Error::msg("Blockchain has no blocks"))
|
.and_then(|block| {
|
||||||
.map(|block| block.header.timestamp)
|
block
|
||||||
})?
|
.header
|
||||||
|
.base_fee_per_gas
|
||||||
|
.context("Failed to get the base fee per gas")
|
||||||
|
})
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(geth_node_id = self.id))]
|
async fn block_hash(&self, number: BlockNumberOrTag) -> anyhow::Result<BlockHash> {
|
||||||
fn last_block_number(&self) -> anyhow::Result<BlockNumber> {
|
self.provider()
|
||||||
let provider = self.provider();
|
.await
|
||||||
BlockingExecutor::execute(async move {
|
.context("Failed to get the Kitchensink provider")?
|
||||||
provider.await?.get_block_number().await.map_err(Into::into)
|
.get_block_by_number(number)
|
||||||
})?
|
.await
|
||||||
|
.context("Failed to get the kitchensink block")?
|
||||||
|
.context("Failed to get the Kitchensink block, perhaps the chain has no blocks?")
|
||||||
|
.map(|block| block.header.hash)
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn block_timestamp(&self, number: BlockNumberOrTag) -> anyhow::Result<BlockTimestamp> {
|
||||||
|
self.provider()
|
||||||
|
.await
|
||||||
|
.context("Failed to get the Kitchensink provider")?
|
||||||
|
.get_block_by_number(number)
|
||||||
|
.await
|
||||||
|
.context("Failed to get the kitchensink block")?
|
||||||
|
.context("Failed to get the Kitchensink block, perhaps the chain has no blocks?")
|
||||||
|
.map(|block| block.header.timestamp)
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn last_block_number(&self) -> anyhow::Result<BlockNumber> {
|
||||||
|
self.provider()
|
||||||
|
.await
|
||||||
|
.context("Failed to get the Kitchensink provider")?
|
||||||
|
.get_block_number()
|
||||||
|
.await
|
||||||
|
.map_err(Into::into)
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -530,26 +604,31 @@ impl Node for KitchensinkNode {
|
|||||||
Self {
|
Self {
|
||||||
id,
|
id,
|
||||||
substrate_binary: config.kitchensink.clone(),
|
substrate_binary: config.kitchensink.clone(),
|
||||||
|
dev_node_binary: config.revive_dev_node.clone(),
|
||||||
eth_proxy_binary: config.eth_proxy.clone(),
|
eth_proxy_binary: config.eth_proxy.clone(),
|
||||||
rpc_url: String::new(),
|
rpc_url: String::new(),
|
||||||
wallet,
|
|
||||||
base_directory,
|
base_directory,
|
||||||
logs_directory,
|
logs_directory,
|
||||||
process_substrate: None,
|
process_substrate: None,
|
||||||
process_proxy: None,
|
process_proxy: None,
|
||||||
|
wallet: Arc::new(wallet),
|
||||||
|
chain_id_filler: Default::default(),
|
||||||
nonce_manager: Default::default(),
|
nonce_manager: Default::default(),
|
||||||
|
use_kitchensink_not_dev_node: config.use_kitchensink_not_dev_node,
|
||||||
// We know that we only need to be storing 4 files so we can specify that when creating
|
// We know that we only need to be storing 4 files so we can specify that when creating
|
||||||
// the vector. It's the stdout and stderr of the substrate-node and the eth-rpc.
|
// the vector. It's the stdout and stderr of the substrate-node and the eth-rpc.
|
||||||
logs_file_to_flush: Vec::with_capacity(4),
|
logs_file_to_flush: Vec::with_capacity(4),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
fn id(&self) -> usize {
|
||||||
|
self.id as _
|
||||||
|
}
|
||||||
|
|
||||||
fn connection_string(&self) -> String {
|
fn connection_string(&self) -> String {
|
||||||
self.rpc_url.clone()
|
self.rpc_url.clone()
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
fn shutdown(&mut self) -> anyhow::Result<()> {
|
fn shutdown(&mut self) -> anyhow::Result<()> {
|
||||||
// Terminate the processes in a graceful manner to allow for the output to be flushed.
|
// Terminate the processes in a graceful manner to allow for the output to be flushed.
|
||||||
if let Some(mut child) = self.process_proxy.take() {
|
if let Some(mut child) = self.process_proxy.take() {
|
||||||
@@ -576,35 +655,37 @@ impl Node for KitchensinkNode {
|
|||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
fn spawn(&mut self, genesis: String) -> anyhow::Result<()> {
|
fn spawn(&mut self, genesis: String) -> anyhow::Result<()> {
|
||||||
self.init(&genesis)?.spawn_process()
|
self.init(&genesis)?.spawn_process()
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
fn version(&self) -> anyhow::Result<String> {
|
fn version(&self) -> anyhow::Result<String> {
|
||||||
let output = Command::new(&self.substrate_binary)
|
let output = Command::new(&self.substrate_binary)
|
||||||
.arg("--version")
|
.arg("--version")
|
||||||
.stdin(Stdio::null())
|
.stdin(Stdio::null())
|
||||||
.stdout(Stdio::piped())
|
.stdout(Stdio::piped())
|
||||||
.stderr(Stdio::null())
|
.stderr(Stdio::null())
|
||||||
.spawn()?
|
.spawn()
|
||||||
.wait_with_output()?
|
.context("Failed to spawn kitchensink --version")?
|
||||||
|
.wait_with_output()
|
||||||
|
.context("Failed to wait for kitchensink --version")?
|
||||||
.stdout;
|
.stdout;
|
||||||
Ok(String::from_utf8_lossy(&output).into())
|
Ok(String::from_utf8_lossy(&output).into())
|
||||||
}
|
}
|
||||||
|
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
fn matches_target(targets: Option<&[String]>) -> bool {
|
||||||
fn matches_target(&self, targets: Option<&[String]>) -> bool {
|
|
||||||
match targets {
|
match targets {
|
||||||
None => true,
|
None => true,
|
||||||
Some(targets) => targets.iter().any(|str| str.as_str() == "pvm"),
|
Some(targets) => targets.iter().any(|str| str.as_str() == "pvm"),
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
fn evm_version() -> EVMVersion {
|
||||||
|
EVMVersion::Cancun
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
impl Drop for KitchensinkNode {
|
impl Drop for KitchensinkNode {
|
||||||
#[tracing::instrument(skip_all, fields(kitchensink_node_id = self.id))]
|
|
||||||
fn drop(&mut self) {
|
fn drop(&mut self) {
|
||||||
self.shutdown().expect("Failed to shutdown")
|
self.shutdown().expect("Failed to shutdown")
|
||||||
}
|
}
|
||||||
@@ -1043,26 +1124,22 @@ mod tests {
|
|||||||
use revive_dt_config::Arguments;
|
use revive_dt_config::Arguments;
|
||||||
use std::path::PathBuf;
|
use std::path::PathBuf;
|
||||||
use std::sync::{LazyLock, Mutex};
|
use std::sync::{LazyLock, Mutex};
|
||||||
use temp_dir::TempDir;
|
|
||||||
|
|
||||||
use std::fs;
|
use std::fs;
|
||||||
|
|
||||||
use super::*;
|
use super::*;
|
||||||
use crate::{GENESIS_JSON, Node};
|
use crate::{GENESIS_JSON, Node};
|
||||||
|
|
||||||
fn test_config() -> (Arguments, TempDir) {
|
fn test_config() -> Arguments {
|
||||||
let mut config = Arguments::default();
|
Arguments {
|
||||||
let temp_dir = TempDir::new().unwrap();
|
kitchensink: PathBuf::from("substrate-node"),
|
||||||
|
eth_proxy: PathBuf::from("eth-rpc"),
|
||||||
config.working_directory = temp_dir.path().to_path_buf().into();
|
use_kitchensink_not_dev_node: true,
|
||||||
|
..Default::default()
|
||||||
config.kitchensink = PathBuf::from("substrate-node");
|
}
|
||||||
config.eth_proxy = PathBuf::from("eth-rpc");
|
|
||||||
|
|
||||||
(config, temp_dir)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
fn new_node() -> (KitchensinkNode, Arguments, TempDir) {
|
fn new_node() -> (KitchensinkNode, Arguments) {
|
||||||
// Note: When we run the tests in the CI we found that if they're all
|
// Note: When we run the tests in the CI we found that if they're all
|
||||||
// run in parallel then the CI is unable to start all of the nodes in
|
// run in parallel then the CI is unable to start all of the nodes in
|
||||||
// time and their start up times-out. Therefore, we want all of the
|
// time and their start up times-out. Therefore, we want all of the
|
||||||
@@ -1081,20 +1158,20 @@ mod tests {
|
|||||||
static NODE_START_MUTEX: Mutex<()> = Mutex::new(());
|
static NODE_START_MUTEX: Mutex<()> = Mutex::new(());
|
||||||
let _guard = NODE_START_MUTEX.lock().unwrap();
|
let _guard = NODE_START_MUTEX.lock().unwrap();
|
||||||
|
|
||||||
let (args, temp_dir) = test_config();
|
let args = test_config();
|
||||||
let mut node = KitchensinkNode::new(&args);
|
let mut node = KitchensinkNode::new(&args);
|
||||||
node.init(GENESIS_JSON)
|
node.init(GENESIS_JSON)
|
||||||
.expect("Failed to initialize the node")
|
.expect("Failed to initialize the node")
|
||||||
.spawn_process()
|
.spawn_process()
|
||||||
.expect("Failed to spawn the node process");
|
.expect("Failed to spawn the node process");
|
||||||
(node, args, temp_dir)
|
(node, args)
|
||||||
}
|
}
|
||||||
|
|
||||||
/// A shared node that multiple tests can use. It starts up once.
|
/// A shared node that multiple tests can use. It starts up once.
|
||||||
fn shared_node() -> &'static KitchensinkNode {
|
fn shared_node() -> &'static KitchensinkNode {
|
||||||
static NODE: LazyLock<(KitchensinkNode, TempDir)> = LazyLock::new(|| {
|
static NODE: LazyLock<(KitchensinkNode, Arguments)> = LazyLock::new(|| {
|
||||||
let (node, _, temp_dir) = new_node();
|
let (node, args) = new_node();
|
||||||
(node, temp_dir)
|
(node, args)
|
||||||
});
|
});
|
||||||
&NODE.0
|
&NODE.0
|
||||||
}
|
}
|
||||||
@@ -1102,7 +1179,7 @@ mod tests {
|
|||||||
#[tokio::test]
|
#[tokio::test]
|
||||||
async fn node_mines_simple_transfer_transaction_and_returns_receipt() {
|
async fn node_mines_simple_transfer_transaction_and_returns_receipt() {
|
||||||
// Arrange
|
// Arrange
|
||||||
let (node, args, _temp_dir) = new_node();
|
let (node, args) = new_node();
|
||||||
|
|
||||||
let provider = node.provider().await.expect("Failed to create provider");
|
let provider = node.provider().await.expect("Failed to create provider");
|
||||||
|
|
||||||
@@ -1137,7 +1214,7 @@ mod tests {
|
|||||||
}
|
}
|
||||||
"#;
|
"#;
|
||||||
|
|
||||||
let mut dummy_node = KitchensinkNode::new(&test_config().0);
|
let mut dummy_node = KitchensinkNode::new(&test_config());
|
||||||
|
|
||||||
// Call `init()`
|
// Call `init()`
|
||||||
dummy_node.init(genesis_content).expect("init failed");
|
dummy_node.init(genesis_content).expect("init failed");
|
||||||
@@ -1181,7 +1258,7 @@ mod tests {
|
|||||||
}
|
}
|
||||||
"#;
|
"#;
|
||||||
|
|
||||||
let node = KitchensinkNode::new(&test_config().0);
|
let node = KitchensinkNode::new(&test_config());
|
||||||
|
|
||||||
let result = node
|
let result = node
|
||||||
.extract_balance_from_genesis_file(&serde_json::from_str(genesis_json).unwrap())
|
.extract_balance_from_genesis_file(&serde_json::from_str(genesis_json).unwrap())
|
||||||
@@ -1252,15 +1329,16 @@ mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn spawn_works() {
|
fn spawn_works() {
|
||||||
let (config, _temp_dir) = test_config();
|
let config = test_config();
|
||||||
|
|
||||||
let mut node = KitchensinkNode::new(&config);
|
let mut node = KitchensinkNode::new(&config);
|
||||||
|
|
||||||
node.spawn(GENESIS_JSON.to_string()).unwrap();
|
node.spawn(GENESIS_JSON.to_string()).unwrap();
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn version_works() {
|
fn version_works() {
|
||||||
let (config, _temp_dir) = test_config();
|
let config = test_config();
|
||||||
|
|
||||||
let node = KitchensinkNode::new(&config);
|
let node = KitchensinkNode::new(&config);
|
||||||
let version = node.version().unwrap();
|
let version = node.version().unwrap();
|
||||||
@@ -1273,7 +1351,7 @@ mod tests {
|
|||||||
|
|
||||||
#[test]
|
#[test]
|
||||||
fn eth_rpc_version_works() {
|
fn eth_rpc_version_works() {
|
||||||
let (config, _temp_dir) = test_config();
|
let config = test_config();
|
||||||
|
|
||||||
let node = KitchensinkNode::new(&config);
|
let node = KitchensinkNode::new(&config);
|
||||||
let version = node.eth_rpc_version().unwrap();
|
let version = node.eth_rpc_version().unwrap();
|
||||||
@@ -1284,86 +1362,86 @@ mod tests {
|
|||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[tokio::test]
|
||||||
fn can_get_chain_id_from_node() {
|
async fn can_get_chain_id_from_node() {
|
||||||
// Arrange
|
// Arrange
|
||||||
let node = shared_node();
|
let node = shared_node();
|
||||||
|
|
||||||
// Act
|
// Act
|
||||||
let chain_id = node.chain_id();
|
let chain_id = node.chain_id().await;
|
||||||
|
|
||||||
// Assert
|
// Assert
|
||||||
let chain_id = chain_id.expect("Failed to get the chain id");
|
let chain_id = chain_id.expect("Failed to get the chain id");
|
||||||
assert_eq!(chain_id, 420_420_420);
|
assert_eq!(chain_id, 420_420_420);
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[tokio::test]
|
||||||
fn can_get_gas_limit_from_node() {
|
async fn can_get_gas_limit_from_node() {
|
||||||
// Arrange
|
// Arrange
|
||||||
let node = shared_node();
|
let node = shared_node();
|
||||||
|
|
||||||
// Act
|
// Act
|
||||||
let gas_limit = node.block_gas_limit(BlockNumberOrTag::Latest);
|
let gas_limit = node.block_gas_limit(BlockNumberOrTag::Latest).await;
|
||||||
|
|
||||||
// Assert
|
// Assert
|
||||||
let _ = gas_limit.expect("Failed to get the gas limit");
|
let _ = gas_limit.expect("Failed to get the gas limit");
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[tokio::test]
|
||||||
fn can_get_coinbase_from_node() {
|
async fn can_get_coinbase_from_node() {
|
||||||
// Arrange
|
// Arrange
|
||||||
let node = shared_node();
|
let node = shared_node();
|
||||||
|
|
||||||
// Act
|
// Act
|
||||||
let coinbase = node.block_coinbase(BlockNumberOrTag::Latest);
|
let coinbase = node.block_coinbase(BlockNumberOrTag::Latest).await;
|
||||||
|
|
||||||
// Assert
|
// Assert
|
||||||
let _ = coinbase.expect("Failed to get the coinbase");
|
let _ = coinbase.expect("Failed to get the coinbase");
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[tokio::test]
|
||||||
fn can_get_block_difficulty_from_node() {
|
async fn can_get_block_difficulty_from_node() {
|
||||||
// Arrange
|
// Arrange
|
||||||
let node = shared_node();
|
let node = shared_node();
|
||||||
|
|
||||||
// Act
|
// Act
|
||||||
let block_difficulty = node.block_difficulty(BlockNumberOrTag::Latest);
|
let block_difficulty = node.block_difficulty(BlockNumberOrTag::Latest).await;
|
||||||
|
|
||||||
// Assert
|
// Assert
|
||||||
let _ = block_difficulty.expect("Failed to get the block difficulty");
|
let _ = block_difficulty.expect("Failed to get the block difficulty");
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[tokio::test]
|
||||||
fn can_get_block_hash_from_node() {
|
async fn can_get_block_hash_from_node() {
|
||||||
// Arrange
|
// Arrange
|
||||||
let node = shared_node();
|
let node = shared_node();
|
||||||
|
|
||||||
// Act
|
// Act
|
||||||
let block_hash = node.block_hash(BlockNumberOrTag::Latest);
|
let block_hash = node.block_hash(BlockNumberOrTag::Latest).await;
|
||||||
|
|
||||||
// Assert
|
// Assert
|
||||||
let _ = block_hash.expect("Failed to get the block hash");
|
let _ = block_hash.expect("Failed to get the block hash");
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[tokio::test]
|
||||||
fn can_get_block_timestamp_from_node() {
|
async fn can_get_block_timestamp_from_node() {
|
||||||
// Arrange
|
// Arrange
|
||||||
let node = shared_node();
|
let node = shared_node();
|
||||||
|
|
||||||
// Act
|
// Act
|
||||||
let block_timestamp = node.block_timestamp(BlockNumberOrTag::Latest);
|
let block_timestamp = node.block_timestamp(BlockNumberOrTag::Latest).await;
|
||||||
|
|
||||||
// Assert
|
// Assert
|
||||||
let _ = block_timestamp.expect("Failed to get the block timestamp");
|
let _ = block_timestamp.expect("Failed to get the block timestamp");
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[tokio::test]
|
||||||
fn can_get_block_number_from_node() {
|
async fn can_get_block_number_from_node() {
|
||||||
// Arrange
|
// Arrange
|
||||||
let node = shared_node();
|
let node = shared_node();
|
||||||
|
|
||||||
// Act
|
// Act
|
||||||
let block_number = node.last_block_number();
|
let block_number = node.last_block_number().await;
|
||||||
|
|
||||||
// Assert
|
// Assert
|
||||||
let _ = block_number.expect("Failed to get the block number");
|
let _ = block_number.expect("Failed to get the block number");
|
||||||
|
|||||||
@@ -1,5 +1,6 @@
|
|||||||
//! This crate implements the testing nodes.
|
//! This crate implements the testing nodes.
|
||||||
|
|
||||||
|
use revive_common::EVMVersion;
|
||||||
use revive_dt_config::Arguments;
|
use revive_dt_config::Arguments;
|
||||||
use revive_dt_node_interaction::EthereumNode;
|
use revive_dt_node_interaction::EthereumNode;
|
||||||
|
|
||||||
@@ -17,6 +18,9 @@ pub trait Node: EthereumNode {
|
|||||||
/// Create a new uninitialized instance.
|
/// Create a new uninitialized instance.
|
||||||
fn new(config: &Arguments) -> Self;
|
fn new(config: &Arguments) -> Self;
|
||||||
|
|
||||||
|
/// Returns the identifier of the node.
|
||||||
|
fn id(&self) -> usize;
|
||||||
|
|
||||||
/// Spawns a node configured according to the genesis json.
|
/// Spawns a node configured according to the genesis json.
|
||||||
///
|
///
|
||||||
/// Blocking until it's ready to accept transactions.
|
/// Blocking until it's ready to accept transactions.
|
||||||
@@ -35,5 +39,8 @@ pub trait Node: EthereumNode {
|
|||||||
|
|
||||||
/// Given a list of targets from the metadata file, this function determines if the metadata
|
/// Given a list of targets from the metadata file, this function determines if the metadata
|
||||||
/// file can be ran on this node or not.
|
/// file can be ran on this node or not.
|
||||||
fn matches_target(&self, targets: Option<&[String]>) -> bool;
|
fn matches_target(targets: Option<&[String]>) -> bool;
|
||||||
|
|
||||||
|
/// Returns the EVM version of the node.
|
||||||
|
fn evm_version() -> EVMVersion;
|
||||||
}
|
}
|
||||||
|
|||||||
+20
-6
@@ -1,13 +1,15 @@
|
|||||||
//! This crate implements concurrent handling of testing node.
|
//! This crate implements concurrent handling of testing node.
|
||||||
|
|
||||||
use std::{
|
use std::{
|
||||||
fs::read_to_string,
|
|
||||||
sync::atomic::{AtomicUsize, Ordering},
|
sync::atomic::{AtomicUsize, Ordering},
|
||||||
thread,
|
thread,
|
||||||
};
|
};
|
||||||
|
|
||||||
|
use revive_dt_common::cached_fs::read_to_string;
|
||||||
|
|
||||||
use anyhow::Context;
|
use anyhow::Context;
|
||||||
use revive_dt_config::Arguments;
|
use revive_dt_config::Arguments;
|
||||||
|
use tracing::info;
|
||||||
|
|
||||||
use crate::Node;
|
use crate::Node;
|
||||||
|
|
||||||
@@ -24,7 +26,7 @@ where
|
|||||||
{
|
{
|
||||||
/// Create a new Pool. This will start as many nodes as there are workers in `config`.
|
/// Create a new Pool. This will start as many nodes as there are workers in `config`.
|
||||||
pub fn new(config: &Arguments) -> anyhow::Result<Self> {
|
pub fn new(config: &Arguments) -> anyhow::Result<Self> {
|
||||||
let nodes = config.workers;
|
let nodes = config.number_of_nodes;
|
||||||
let genesis = read_to_string(&config.genesis_file).context(format!(
|
let genesis = read_to_string(&config.genesis_file).context(format!(
|
||||||
"can not read genesis file: {}",
|
"can not read genesis file: {}",
|
||||||
config.genesis_file.display()
|
config.genesis_file.display()
|
||||||
@@ -42,8 +44,10 @@ where
|
|||||||
nodes.push(
|
nodes.push(
|
||||||
handle
|
handle
|
||||||
.join()
|
.join()
|
||||||
.map_err(|error| anyhow::anyhow!("failed to spawn node: {:?}", error))?
|
.map_err(|error| anyhow::anyhow!("failed to spawn node: {:?}", error))
|
||||||
.map_err(|error| anyhow::anyhow!("node failed to spawn: {error}"))?,
|
.context("Failed to join node spawn thread")?
|
||||||
|
.map_err(|error| anyhow::anyhow!("node failed to spawn: {error}"))
|
||||||
|
.context("Node failed to spawn")?,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -62,7 +66,17 @@ where
|
|||||||
|
|
||||||
fn spawn_node<T: Node + Send>(args: &Arguments, genesis: String) -> anyhow::Result<T> {
|
fn spawn_node<T: Node + Send>(args: &Arguments, genesis: String) -> anyhow::Result<T> {
|
||||||
let mut node = T::new(args);
|
let mut node = T::new(args);
|
||||||
tracing::info!("starting node: {}", node.connection_string());
|
info!(
|
||||||
node.spawn(genesis)?;
|
id = node.id(),
|
||||||
|
connection_string = node.connection_string(),
|
||||||
|
"Spawning node"
|
||||||
|
);
|
||||||
|
node.spawn(genesis)
|
||||||
|
.context("Failed to spawn node process")?;
|
||||||
|
info!(
|
||||||
|
id = node.id(),
|
||||||
|
connection_string = node.connection_string(),
|
||||||
|
"Spawned node"
|
||||||
|
);
|
||||||
Ok(node)
|
Ok(node)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -8,11 +8,21 @@ repository.workspace = true
|
|||||||
rust-version.workspace = true
|
rust-version.workspace = true
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
revive-dt-common = { workspace = true }
|
||||||
revive-dt-config = { workspace = true }
|
revive-dt-config = { workspace = true }
|
||||||
revive-dt-format = { workspace = true }
|
revive-dt-format = { workspace = true }
|
||||||
|
revive-dt-compiler = { workspace = true }
|
||||||
|
|
||||||
|
alloy-primitives = { workspace = true }
|
||||||
anyhow = { workspace = true }
|
anyhow = { workspace = true }
|
||||||
tracing = { workspace = true }
|
paste = { workspace = true }
|
||||||
|
indexmap = { workspace = true, features = ["serde"] }
|
||||||
|
semver = { workspace = true }
|
||||||
serde = { workspace = true }
|
serde = { workspace = true }
|
||||||
serde_json = { workspace = true }
|
serde_json = { workspace = true }
|
||||||
revive-solc-json-interface = { workspace = true }
|
serde_with = { workspace = true }
|
||||||
|
tokio = { workspace = true }
|
||||||
|
tracing = { workspace = true }
|
||||||
|
|
||||||
|
[lints]
|
||||||
|
workspace = true
|
||||||
|
|||||||
@@ -0,0 +1,545 @@
|
|||||||
|
//! Implementation of the report aggregator task which consumes the events sent by the various
|
||||||
|
//! reporters and combines them into a single unified report.
|
||||||
|
|
||||||
|
use std::{
|
||||||
|
collections::{BTreeMap, BTreeSet, HashMap, HashSet},
|
||||||
|
fs::OpenOptions,
|
||||||
|
path::PathBuf,
|
||||||
|
time::{SystemTime, UNIX_EPOCH},
|
||||||
|
};
|
||||||
|
|
||||||
|
use alloy_primitives::Address;
|
||||||
|
use anyhow::{Context as _, Result};
|
||||||
|
use indexmap::IndexMap;
|
||||||
|
use revive_dt_compiler::{CompilerInput, CompilerOutput, Mode};
|
||||||
|
use revive_dt_config::{Arguments, TestingPlatform};
|
||||||
|
use revive_dt_format::{case::CaseIdx, corpus::Corpus, metadata::ContractInstance};
|
||||||
|
use semver::Version;
|
||||||
|
use serde::Serialize;
|
||||||
|
use serde_with::{DisplayFromStr, serde_as};
|
||||||
|
use tokio::sync::{
|
||||||
|
broadcast::{Sender, channel},
|
||||||
|
mpsc::{UnboundedReceiver, UnboundedSender, unbounded_channel},
|
||||||
|
};
|
||||||
|
use tracing::debug;
|
||||||
|
|
||||||
|
use crate::*;
|
||||||
|
|
||||||
|
pub struct ReportAggregator {
|
||||||
|
/* Internal Report State */
|
||||||
|
report: Report,
|
||||||
|
remaining_cases: HashMap<MetadataFilePath, HashMap<Mode, HashSet<CaseIdx>>>,
|
||||||
|
/* Channels */
|
||||||
|
runner_tx: Option<UnboundedSender<RunnerEvent>>,
|
||||||
|
runner_rx: UnboundedReceiver<RunnerEvent>,
|
||||||
|
listener_tx: Sender<ReporterEvent>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl ReportAggregator {
|
||||||
|
pub fn new(config: Arguments) -> Self {
|
||||||
|
let (runner_tx, runner_rx) = unbounded_channel::<RunnerEvent>();
|
||||||
|
let (listener_tx, _) = channel::<ReporterEvent>(1024);
|
||||||
|
Self {
|
||||||
|
report: Report::new(config),
|
||||||
|
remaining_cases: Default::default(),
|
||||||
|
runner_tx: Some(runner_tx),
|
||||||
|
runner_rx,
|
||||||
|
listener_tx,
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub fn into_task(mut self) -> (Reporter, impl Future<Output = Result<()>>) {
|
||||||
|
let reporter = self
|
||||||
|
.runner_tx
|
||||||
|
.take()
|
||||||
|
.map(Into::into)
|
||||||
|
.expect("Can't fail since this can only be called once");
|
||||||
|
(reporter, async move { self.aggregate().await })
|
||||||
|
}
|
||||||
|
|
||||||
|
async fn aggregate(mut self) -> Result<()> {
|
||||||
|
debug!("Starting to aggregate report");
|
||||||
|
|
||||||
|
while let Some(event) = self.runner_rx.recv().await {
|
||||||
|
debug!(?event, "Received Event");
|
||||||
|
match event {
|
||||||
|
RunnerEvent::SubscribeToEvents(event) => {
|
||||||
|
self.handle_subscribe_to_events_event(*event);
|
||||||
|
}
|
||||||
|
RunnerEvent::CorpusFileDiscovery(event) => {
|
||||||
|
self.handle_corpus_file_discovered_event(*event)
|
||||||
|
}
|
||||||
|
RunnerEvent::MetadataFileDiscovery(event) => {
|
||||||
|
self.handle_metadata_file_discovery_event(*event);
|
||||||
|
}
|
||||||
|
RunnerEvent::TestCaseDiscovery(event) => {
|
||||||
|
self.handle_test_case_discovery(*event);
|
||||||
|
}
|
||||||
|
RunnerEvent::TestSucceeded(event) => {
|
||||||
|
self.handle_test_succeeded_event(*event);
|
||||||
|
}
|
||||||
|
RunnerEvent::TestFailed(event) => {
|
||||||
|
self.handle_test_failed_event(*event);
|
||||||
|
}
|
||||||
|
RunnerEvent::TestIgnored(event) => {
|
||||||
|
self.handle_test_ignored_event(*event);
|
||||||
|
}
|
||||||
|
RunnerEvent::LeaderNodeAssigned(event) => {
|
||||||
|
self.handle_leader_node_assigned_event(*event);
|
||||||
|
}
|
||||||
|
RunnerEvent::FollowerNodeAssigned(event) => {
|
||||||
|
self.handle_follower_node_assigned_event(*event);
|
||||||
|
}
|
||||||
|
RunnerEvent::PreLinkContractsCompilationSucceeded(event) => {
|
||||||
|
self.handle_pre_link_contracts_compilation_succeeded_event(*event)
|
||||||
|
}
|
||||||
|
RunnerEvent::PostLinkContractsCompilationSucceeded(event) => {
|
||||||
|
self.handle_post_link_contracts_compilation_succeeded_event(*event)
|
||||||
|
}
|
||||||
|
RunnerEvent::PreLinkContractsCompilationFailed(event) => {
|
||||||
|
self.handle_pre_link_contracts_compilation_failed_event(*event)
|
||||||
|
}
|
||||||
|
RunnerEvent::PostLinkContractsCompilationFailed(event) => {
|
||||||
|
self.handle_post_link_contracts_compilation_failed_event(*event)
|
||||||
|
}
|
||||||
|
RunnerEvent::LibrariesDeployed(event) => {
|
||||||
|
self.handle_libraries_deployed_event(*event);
|
||||||
|
}
|
||||||
|
RunnerEvent::ContractDeployed(event) => {
|
||||||
|
self.handle_contract_deployed_event(*event);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
debug!("Report aggregation completed");
|
||||||
|
|
||||||
|
let file_name = {
|
||||||
|
let current_timestamp = SystemTime::now()
|
||||||
|
.duration_since(UNIX_EPOCH)
|
||||||
|
.context("System clock is before UNIX_EPOCH; cannot compute report timestamp")?
|
||||||
|
.as_secs();
|
||||||
|
let mut file_name = current_timestamp.to_string();
|
||||||
|
file_name.push_str(".json");
|
||||||
|
file_name
|
||||||
|
};
|
||||||
|
let file_path = self.report.config.directory().join(file_name);
|
||||||
|
let file = OpenOptions::new()
|
||||||
|
.create(true)
|
||||||
|
.write(true)
|
||||||
|
.truncate(true)
|
||||||
|
.read(false)
|
||||||
|
.open(&file_path)
|
||||||
|
.with_context(|| {
|
||||||
|
format!(
|
||||||
|
"Failed to open report file for writing: {}",
|
||||||
|
file_path.display()
|
||||||
|
)
|
||||||
|
})?;
|
||||||
|
serde_json::to_writer_pretty(&file, &self.report).with_context(|| {
|
||||||
|
format!("Failed to serialize report JSON to {}", file_path.display())
|
||||||
|
})?;
|
||||||
|
|
||||||
|
Ok(())
|
||||||
|
}
|
||||||
|
|
||||||
|
fn handle_subscribe_to_events_event(&self, event: SubscribeToEventsEvent) {
|
||||||
|
let _ = event.tx.send(self.listener_tx.subscribe());
|
||||||
|
}
|
||||||
|
|
||||||
|
fn handle_corpus_file_discovered_event(&mut self, event: CorpusFileDiscoveryEvent) {
|
||||||
|
self.report.corpora.push(event.corpus);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn handle_metadata_file_discovery_event(&mut self, event: MetadataFileDiscoveryEvent) {
|
||||||
|
self.report.metadata_files.insert(event.path.clone());
|
||||||
|
}
|
||||||
|
|
||||||
|
fn handle_test_case_discovery(&mut self, event: TestCaseDiscoveryEvent) {
|
||||||
|
self.remaining_cases
|
||||||
|
.entry(event.test_specifier.metadata_file_path.clone().into())
|
||||||
|
.or_default()
|
||||||
|
.entry(event.test_specifier.solc_mode.clone())
|
||||||
|
.or_default()
|
||||||
|
.insert(event.test_specifier.case_idx);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn handle_test_succeeded_event(&mut self, event: TestSucceededEvent) {
|
||||||
|
// Remove this from the set of cases we're tracking since it has completed.
|
||||||
|
self.remaining_cases
|
||||||
|
.entry(event.test_specifier.metadata_file_path.clone().into())
|
||||||
|
.or_default()
|
||||||
|
.entry(event.test_specifier.solc_mode.clone())
|
||||||
|
.or_default()
|
||||||
|
.remove(&event.test_specifier.case_idx);
|
||||||
|
|
||||||
|
// Add information on the fact that the case was ignored to the report.
|
||||||
|
let test_case_report = self.test_case_report(&event.test_specifier);
|
||||||
|
test_case_report.status = Some(TestCaseStatus::Succeeded {
|
||||||
|
steps_executed: event.steps_executed,
|
||||||
|
});
|
||||||
|
self.handle_post_test_case_status_update(&event.test_specifier);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn handle_test_failed_event(&mut self, event: TestFailedEvent) {
|
||||||
|
// Remove this from the set of cases we're tracking since it has completed.
|
||||||
|
self.remaining_cases
|
||||||
|
.entry(event.test_specifier.metadata_file_path.clone().into())
|
||||||
|
.or_default()
|
||||||
|
.entry(event.test_specifier.solc_mode.clone())
|
||||||
|
.or_default()
|
||||||
|
.remove(&event.test_specifier.case_idx);
|
||||||
|
|
||||||
|
// Add information on the fact that the case was ignored to the report.
|
||||||
|
let test_case_report = self.test_case_report(&event.test_specifier);
|
||||||
|
test_case_report.status = Some(TestCaseStatus::Failed {
|
||||||
|
reason: event.reason,
|
||||||
|
});
|
||||||
|
self.handle_post_test_case_status_update(&event.test_specifier);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn handle_test_ignored_event(&mut self, event: TestIgnoredEvent) {
|
||||||
|
// Remove this from the set of cases we're tracking since it has completed.
|
||||||
|
self.remaining_cases
|
||||||
|
.entry(event.test_specifier.metadata_file_path.clone().into())
|
||||||
|
.or_default()
|
||||||
|
.entry(event.test_specifier.solc_mode.clone())
|
||||||
|
.or_default()
|
||||||
|
.remove(&event.test_specifier.case_idx);
|
||||||
|
|
||||||
|
// Add information on the fact that the case was ignored to the report.
|
||||||
|
let test_case_report = self.test_case_report(&event.test_specifier);
|
||||||
|
test_case_report.status = Some(TestCaseStatus::Ignored {
|
||||||
|
reason: event.reason,
|
||||||
|
additional_fields: event.additional_fields,
|
||||||
|
});
|
||||||
|
self.handle_post_test_case_status_update(&event.test_specifier);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn handle_post_test_case_status_update(&mut self, specifier: &TestSpecifier) {
|
||||||
|
let remaining_cases = self
|
||||||
|
.remaining_cases
|
||||||
|
.entry(specifier.metadata_file_path.clone().into())
|
||||||
|
.or_default()
|
||||||
|
.entry(specifier.solc_mode.clone())
|
||||||
|
.or_default();
|
||||||
|
if !remaining_cases.is_empty() {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
let case_status = self
|
||||||
|
.report
|
||||||
|
.test_case_information
|
||||||
|
.entry(specifier.metadata_file_path.clone().into())
|
||||||
|
.or_default()
|
||||||
|
.entry(specifier.solc_mode.clone())
|
||||||
|
.or_default()
|
||||||
|
.iter()
|
||||||
|
.map(|(case_idx, case_report)| {
|
||||||
|
(
|
||||||
|
*case_idx,
|
||||||
|
case_report.status.clone().expect("Can't be uninitialized"),
|
||||||
|
)
|
||||||
|
})
|
||||||
|
.collect::<BTreeMap<_, _>>();
|
||||||
|
let event = ReporterEvent::MetadataFileSolcModeCombinationExecutionCompleted {
|
||||||
|
metadata_file_path: specifier.metadata_file_path.clone().into(),
|
||||||
|
mode: specifier.solc_mode.clone(),
|
||||||
|
case_status,
|
||||||
|
};
|
||||||
|
|
||||||
|
// According to the documentation on send, the sending fails if there are no more receiver
|
||||||
|
// handles. Therefore, this isn't an error that we want to bubble up or anything. If we fail
|
||||||
|
// to send then we ignore the error.
|
||||||
|
let _ = self.listener_tx.send(event);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn handle_leader_node_assigned_event(&mut self, event: LeaderNodeAssignedEvent) {
|
||||||
|
let execution_information = self.execution_information(&ExecutionSpecifier {
|
||||||
|
test_specifier: event.test_specifier,
|
||||||
|
node_id: event.id,
|
||||||
|
node_designation: NodeDesignation::Leader,
|
||||||
|
});
|
||||||
|
execution_information.node = Some(TestCaseNodeInformation {
|
||||||
|
id: event.id,
|
||||||
|
platform: event.platform,
|
||||||
|
connection_string: event.connection_string,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
fn handle_follower_node_assigned_event(&mut self, event: FollowerNodeAssignedEvent) {
|
||||||
|
let execution_information = self.execution_information(&ExecutionSpecifier {
|
||||||
|
test_specifier: event.test_specifier,
|
||||||
|
node_id: event.id,
|
||||||
|
node_designation: NodeDesignation::Follower,
|
||||||
|
});
|
||||||
|
execution_information.node = Some(TestCaseNodeInformation {
|
||||||
|
id: event.id,
|
||||||
|
platform: event.platform,
|
||||||
|
connection_string: event.connection_string,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
fn handle_pre_link_contracts_compilation_succeeded_event(
|
||||||
|
&mut self,
|
||||||
|
event: PreLinkContractsCompilationSucceededEvent,
|
||||||
|
) {
|
||||||
|
let include_input = self.report.config.report_include_compiler_input;
|
||||||
|
let include_output = self.report.config.report_include_compiler_output;
|
||||||
|
|
||||||
|
let execution_information = self.execution_information(&event.execution_specifier);
|
||||||
|
|
||||||
|
let compiler_input = if include_input {
|
||||||
|
event.compiler_input
|
||||||
|
} else {
|
||||||
|
None
|
||||||
|
};
|
||||||
|
let compiler_output = if include_output {
|
||||||
|
Some(event.compiler_output)
|
||||||
|
} else {
|
||||||
|
None
|
||||||
|
};
|
||||||
|
|
||||||
|
execution_information.pre_link_compilation_status = Some(CompilationStatus::Success {
|
||||||
|
is_cached: event.is_cached,
|
||||||
|
compiler_version: event.compiler_version,
|
||||||
|
compiler_path: event.compiler_path,
|
||||||
|
compiler_input,
|
||||||
|
compiler_output,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
fn handle_post_link_contracts_compilation_succeeded_event(
|
||||||
|
&mut self,
|
||||||
|
event: PostLinkContractsCompilationSucceededEvent,
|
||||||
|
) {
|
||||||
|
let include_input = self.report.config.report_include_compiler_input;
|
||||||
|
let include_output = self.report.config.report_include_compiler_output;
|
||||||
|
|
||||||
|
let execution_information = self.execution_information(&event.execution_specifier);
|
||||||
|
|
||||||
|
let compiler_input = if include_input {
|
||||||
|
event.compiler_input
|
||||||
|
} else {
|
||||||
|
None
|
||||||
|
};
|
||||||
|
let compiler_output = if include_output {
|
||||||
|
Some(event.compiler_output)
|
||||||
|
} else {
|
||||||
|
None
|
||||||
|
};
|
||||||
|
|
||||||
|
execution_information.post_link_compilation_status = Some(CompilationStatus::Success {
|
||||||
|
is_cached: event.is_cached,
|
||||||
|
compiler_version: event.compiler_version,
|
||||||
|
compiler_path: event.compiler_path,
|
||||||
|
compiler_input,
|
||||||
|
compiler_output,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
fn handle_pre_link_contracts_compilation_failed_event(
|
||||||
|
&mut self,
|
||||||
|
event: PreLinkContractsCompilationFailedEvent,
|
||||||
|
) {
|
||||||
|
let execution_information = self.execution_information(&event.execution_specifier);
|
||||||
|
|
||||||
|
execution_information.pre_link_compilation_status = Some(CompilationStatus::Failure {
|
||||||
|
reason: event.reason,
|
||||||
|
compiler_version: event.compiler_version,
|
||||||
|
compiler_path: event.compiler_path,
|
||||||
|
compiler_input: event.compiler_input,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
fn handle_post_link_contracts_compilation_failed_event(
|
||||||
|
&mut self,
|
||||||
|
event: PostLinkContractsCompilationFailedEvent,
|
||||||
|
) {
|
||||||
|
let execution_information = self.execution_information(&event.execution_specifier);
|
||||||
|
|
||||||
|
execution_information.post_link_compilation_status = Some(CompilationStatus::Failure {
|
||||||
|
reason: event.reason,
|
||||||
|
compiler_version: event.compiler_version,
|
||||||
|
compiler_path: event.compiler_path,
|
||||||
|
compiler_input: event.compiler_input,
|
||||||
|
});
|
||||||
|
}
|
||||||
|
|
||||||
|
fn handle_libraries_deployed_event(&mut self, event: LibrariesDeployedEvent) {
|
||||||
|
self.execution_information(&event.execution_specifier)
|
||||||
|
.deployed_libraries = Some(event.libraries);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn handle_contract_deployed_event(&mut self, event: ContractDeployedEvent) {
|
||||||
|
self.execution_information(&event.execution_specifier)
|
||||||
|
.deployed_contracts
|
||||||
|
.get_or_insert_default()
|
||||||
|
.insert(event.contract_instance, event.address);
|
||||||
|
}
|
||||||
|
|
||||||
|
fn test_case_report(&mut self, specifier: &TestSpecifier) -> &mut TestCaseReport {
|
||||||
|
self.report
|
||||||
|
.test_case_information
|
||||||
|
.entry(specifier.metadata_file_path.clone().into())
|
||||||
|
.or_default()
|
||||||
|
.entry(specifier.solc_mode.clone())
|
||||||
|
.or_default()
|
||||||
|
.entry(specifier.case_idx)
|
||||||
|
.or_default()
|
||||||
|
}
|
||||||
|
|
||||||
|
fn execution_information(
|
||||||
|
&mut self,
|
||||||
|
specifier: &ExecutionSpecifier,
|
||||||
|
) -> &mut ExecutionInformation {
|
||||||
|
let test_case_report = self.test_case_report(&specifier.test_specifier);
|
||||||
|
match specifier.node_designation {
|
||||||
|
NodeDesignation::Leader => test_case_report
|
||||||
|
.leader_execution_information
|
||||||
|
.get_or_insert_default(),
|
||||||
|
NodeDesignation::Follower => test_case_report
|
||||||
|
.follower_execution_information
|
||||||
|
.get_or_insert_default(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[serde_as]
|
||||||
|
#[derive(Clone, Debug, Serialize)]
|
||||||
|
pub struct Report {
|
||||||
|
/// The configuration that the tool was started up with.
|
||||||
|
pub config: Arguments,
|
||||||
|
/// The platform of the leader chain.
|
||||||
|
pub leader_platform: TestingPlatform,
|
||||||
|
/// The platform of the follower chain.
|
||||||
|
pub follower_platform: TestingPlatform,
|
||||||
|
/// The list of corpus files that the tool found.
|
||||||
|
pub corpora: Vec<Corpus>,
|
||||||
|
/// The list of metadata files that were found by the tool.
|
||||||
|
pub metadata_files: BTreeSet<MetadataFilePath>,
|
||||||
|
/// Information relating to each test case.
|
||||||
|
#[serde_as(as = "BTreeMap<_, HashMap<DisplayFromStr, BTreeMap<DisplayFromStr, _>>>")]
|
||||||
|
pub test_case_information:
|
||||||
|
BTreeMap<MetadataFilePath, HashMap<Mode, BTreeMap<CaseIdx, TestCaseReport>>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl Report {
|
||||||
|
pub fn new(config: Arguments) -> Self {
|
||||||
|
Self {
|
||||||
|
leader_platform: config.leader,
|
||||||
|
follower_platform: config.follower,
|
||||||
|
config,
|
||||||
|
corpora: Default::default(),
|
||||||
|
metadata_files: Default::default(),
|
||||||
|
test_case_information: Default::default(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, Serialize, Default)]
|
||||||
|
pub struct TestCaseReport {
|
||||||
|
/// Information on the status of the test case and whether it succeeded, failed, or was ignored.
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub status: Option<TestCaseStatus>,
|
||||||
|
/// Information related to the execution on the leader.
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub leader_execution_information: Option<ExecutionInformation>,
|
||||||
|
/// Information related to the execution on the follower.
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub follower_execution_information: Option<ExecutionInformation>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Information related to the status of the test. Could be that the test succeeded, failed, or that
|
||||||
|
/// it was ignored.
|
||||||
|
#[derive(Clone, Debug, Serialize)]
|
||||||
|
#[serde(tag = "status")]
|
||||||
|
pub enum TestCaseStatus {
|
||||||
|
/// The test case succeeded.
|
||||||
|
Succeeded {
|
||||||
|
/// The number of steps of the case that were executed.
|
||||||
|
steps_executed: usize,
|
||||||
|
},
|
||||||
|
/// The test case failed.
|
||||||
|
Failed {
|
||||||
|
/// The reason for the failure of the test case.
|
||||||
|
reason: String,
|
||||||
|
},
|
||||||
|
/// The test case was ignored. This variant carries information related to why it was ignored.
|
||||||
|
Ignored {
|
||||||
|
/// The reason behind the test case being ignored.
|
||||||
|
reason: String,
|
||||||
|
/// Additional fields that describe more information on why the test case is ignored.
|
||||||
|
#[serde(flatten)]
|
||||||
|
additional_fields: IndexMap<String, serde_json::Value>,
|
||||||
|
},
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Information related to the leader or follower node that's being used to execute the step.
|
||||||
|
#[derive(Clone, Debug, Serialize)]
|
||||||
|
pub struct TestCaseNodeInformation {
|
||||||
|
/// The ID of the node that this case is being executed on.
|
||||||
|
pub id: usize,
|
||||||
|
/// The platform of the node.
|
||||||
|
pub platform: TestingPlatform,
|
||||||
|
/// The connection string of the node.
|
||||||
|
pub connection_string: String,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Execution information tied to the leader or the follower.
|
||||||
|
#[derive(Clone, Debug, Default, Serialize)]
|
||||||
|
pub struct ExecutionInformation {
|
||||||
|
/// Information related to the node assigned to this test case.
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub node: Option<TestCaseNodeInformation>,
|
||||||
|
/// Information on the pre-link compiled contracts.
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub pre_link_compilation_status: Option<CompilationStatus>,
|
||||||
|
/// Information on the post-link compiled contracts.
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub post_link_compilation_status: Option<CompilationStatus>,
|
||||||
|
/// Information on the deployed libraries.
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub deployed_libraries: Option<BTreeMap<ContractInstance, Address>>,
|
||||||
|
/// Information on the deployed contracts.
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
pub deployed_contracts: Option<BTreeMap<ContractInstance, Address>>,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Information related to compilation
|
||||||
|
#[derive(Clone, Debug, Serialize)]
|
||||||
|
#[serde(tag = "status")]
|
||||||
|
pub enum CompilationStatus {
|
||||||
|
/// The compilation was successful.
|
||||||
|
Success {
|
||||||
|
/// A flag with information on whether the compilation artifacts were cached or not.
|
||||||
|
is_cached: bool,
|
||||||
|
/// The version of the compiler used to compile the contracts.
|
||||||
|
compiler_version: Version,
|
||||||
|
/// The path of the compiler used to compile the contracts.
|
||||||
|
compiler_path: PathBuf,
|
||||||
|
/// The input provided to the compiler to compile the contracts. This is only included if
|
||||||
|
/// the appropriate flag is set in the CLI configuration and if the contracts were not
|
||||||
|
/// cached and the compiler was invoked.
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
compiler_input: Option<CompilerInput>,
|
||||||
|
/// The output of the compiler. This is only included if the appropriate flag is set in the
|
||||||
|
/// CLI configurations.
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
compiler_output: Option<CompilerOutput>,
|
||||||
|
},
|
||||||
|
/// The compilation failed.
|
||||||
|
Failure {
|
||||||
|
/// The failure reason.
|
||||||
|
reason: String,
|
||||||
|
/// The version of the compiler used to compile the contracts.
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
compiler_version: Option<Version>,
|
||||||
|
/// The path of the compiler used to compile the contracts.
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
compiler_path: Option<PathBuf>,
|
||||||
|
/// The input provided to the compiler to compile the contracts. This is only included if
|
||||||
|
/// the appropriate flag is set in the CLI configuration and if the contracts were not
|
||||||
|
/// cached and the compiler was invoked.
|
||||||
|
#[serde(skip_serializing_if = "Option::is_none")]
|
||||||
|
compiler_input: Option<CompilerInput>,
|
||||||
|
},
|
||||||
|
}
|
||||||
@@ -1,94 +0,0 @@
|
|||||||
//! The report analyzer enriches the raw report data.
|
|
||||||
|
|
||||||
use serde::{Deserialize, Serialize};
|
|
||||||
|
|
||||||
use crate::reporter::CompilationTask;
|
|
||||||
|
|
||||||
/// Provides insights into how well the compilers perform.
|
|
||||||
#[derive(Clone, Default, Debug, Serialize, Deserialize, PartialEq, PartialOrd)]
|
|
||||||
pub struct CompilerStatistics {
|
|
||||||
/// The sum of contracts observed.
|
|
||||||
pub n_contracts: usize,
|
|
||||||
/// The mean size of compiled contracts.
|
|
||||||
pub mean_code_size: usize,
|
|
||||||
/// The mean size of the optimized YUL IR.
|
|
||||||
pub mean_yul_size: usize,
|
|
||||||
/// Is a proxy because the YUL also containes a lot of comments.
|
|
||||||
pub yul_to_bytecode_size_ratio: f32,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl CompilerStatistics {
|
|
||||||
/// Cumulatively update the statistics with the next compiler task.
|
|
||||||
pub fn sample(&mut self, compilation_task: &CompilationTask) {
|
|
||||||
let Some(output) = &compilation_task.json_output else {
|
|
||||||
return;
|
|
||||||
};
|
|
||||||
|
|
||||||
let Some(contracts) = &output.contracts else {
|
|
||||||
return;
|
|
||||||
};
|
|
||||||
|
|
||||||
for (_solidity, contracts) in contracts.iter() {
|
|
||||||
for (_name, contract) in contracts.iter() {
|
|
||||||
let Some(evm) = &contract.evm else {
|
|
||||||
continue;
|
|
||||||
};
|
|
||||||
let Some(deploy_code) = &evm.deployed_bytecode else {
|
|
||||||
continue;
|
|
||||||
};
|
|
||||||
|
|
||||||
// The EVM bytecode can be unlinked and thus is not necessarily a decodable hex
|
|
||||||
// string; for our statistics this is a good enough approximation.
|
|
||||||
let bytecode_size = deploy_code.object.len() / 2;
|
|
||||||
|
|
||||||
let yul_size = contract
|
|
||||||
.ir_optimized
|
|
||||||
.as_ref()
|
|
||||||
.expect("if the contract has a deploy code it should also have the opimized IR")
|
|
||||||
.len();
|
|
||||||
|
|
||||||
self.update_sizes(bytecode_size, yul_size);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Updates the size statistics cumulatively.
|
|
||||||
fn update_sizes(&mut self, bytecode_size: usize, yul_size: usize) {
|
|
||||||
let n_previous = self.n_contracts;
|
|
||||||
let n_current = self.n_contracts + 1;
|
|
||||||
|
|
||||||
self.n_contracts = n_current;
|
|
||||||
|
|
||||||
self.mean_code_size = (n_previous * self.mean_code_size + bytecode_size) / n_current;
|
|
||||||
self.mean_yul_size = (n_previous * self.mean_yul_size + yul_size) / n_current;
|
|
||||||
|
|
||||||
if self.mean_code_size > 0 {
|
|
||||||
self.yul_to_bytecode_size_ratio =
|
|
||||||
self.mean_yul_size as f32 / self.mean_code_size as f32;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
#[cfg(test)]
|
|
||||||
mod tests {
|
|
||||||
use super::CompilerStatistics;
|
|
||||||
|
|
||||||
#[test]
|
|
||||||
fn compiler_statistics() {
|
|
||||||
let mut received = CompilerStatistics::default();
|
|
||||||
received.update_sizes(0, 0);
|
|
||||||
received.update_sizes(3, 37);
|
|
||||||
received.update_sizes(123, 456);
|
|
||||||
|
|
||||||
let mean_code_size = 41; // rounding error from integer truncation
|
|
||||||
let mean_yul_size = 164;
|
|
||||||
let expected = CompilerStatistics {
|
|
||||||
n_contracts: 3,
|
|
||||||
mean_code_size,
|
|
||||||
mean_yul_size,
|
|
||||||
yul_to_bytecode_size_ratio: mean_yul_size as f32 / mean_code_size as f32,
|
|
||||||
};
|
|
||||||
|
|
||||||
assert_eq!(received, expected);
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,43 @@
|
|||||||
|
//! Common types and functions used throughout the crate.
|
||||||
|
|
||||||
|
use std::{path::PathBuf, sync::Arc};
|
||||||
|
|
||||||
|
use revive_dt_common::define_wrapper_type;
|
||||||
|
use revive_dt_compiler::Mode;
|
||||||
|
use revive_dt_format::{case::CaseIdx, input::StepIdx};
|
||||||
|
use serde::{Deserialize, Serialize};
|
||||||
|
|
||||||
|
define_wrapper_type!(
|
||||||
|
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash, Serialize, Deserialize)]
|
||||||
|
#[serde(transparent)]
|
||||||
|
pub struct MetadataFilePath(PathBuf);
|
||||||
|
);
|
||||||
|
|
||||||
|
/// An absolute specifier for a test.
|
||||||
|
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
|
||||||
|
pub struct TestSpecifier {
|
||||||
|
pub solc_mode: Mode,
|
||||||
|
pub metadata_file_path: PathBuf,
|
||||||
|
pub case_idx: CaseIdx,
|
||||||
|
}
|
||||||
|
|
||||||
|
/// An absolute path for a test that also includes information about the node that it's assigned to
|
||||||
|
/// and whether it's the leader or follower.
|
||||||
|
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
|
||||||
|
pub struct ExecutionSpecifier {
|
||||||
|
pub test_specifier: Arc<TestSpecifier>,
|
||||||
|
pub node_id: usize,
|
||||||
|
pub node_designation: NodeDesignation,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord, Hash)]
|
||||||
|
pub enum NodeDesignation {
|
||||||
|
Leader,
|
||||||
|
Follower,
|
||||||
|
}
|
||||||
|
|
||||||
|
#[derive(Clone, Debug, PartialEq, Eq, Hash)]
|
||||||
|
pub struct StepExecutionSpecifier {
|
||||||
|
pub execution_specifier: Arc<ExecutionSpecifier>,
|
||||||
|
pub step_idx: StepIdx,
|
||||||
|
}
|
||||||
@@ -1,4 +1,11 @@
|
|||||||
//! The revive differential tests reporting facility.
|
//! This crate implements the reporting infrastructure for the differential testing tool.
|
||||||
|
|
||||||
pub mod analyzer;
|
mod aggregator;
|
||||||
pub mod reporter;
|
mod common;
|
||||||
|
mod reporter_event;
|
||||||
|
mod runner_event;
|
||||||
|
|
||||||
|
pub use aggregator::*;
|
||||||
|
pub use common::*;
|
||||||
|
pub use reporter_event::*;
|
||||||
|
pub use runner_event::*;
|
||||||
|
|||||||
@@ -1,243 +0,0 @@
|
|||||||
//! The reporter is the central place observing test execution by collecting data.
|
|
||||||
//!
|
|
||||||
//! The data collected gives useful insights into the outcome of the test run
|
|
||||||
//! and helps identifying and reproducing failing cases.
|
|
||||||
|
|
||||||
use std::{
|
|
||||||
collections::HashMap,
|
|
||||||
fs::{self, File, create_dir_all},
|
|
||||||
path::PathBuf,
|
|
||||||
sync::{Mutex, OnceLock},
|
|
||||||
time::{SystemTime, UNIX_EPOCH},
|
|
||||||
};
|
|
||||||
|
|
||||||
use anyhow::Context;
|
|
||||||
use serde::{Deserialize, Serialize};
|
|
||||||
|
|
||||||
use revive_dt_config::{Arguments, TestingPlatform};
|
|
||||||
use revive_dt_format::{corpus::Corpus, mode::SolcMode};
|
|
||||||
use revive_solc_json_interface::{SolcStandardJsonInput, SolcStandardJsonOutput};
|
|
||||||
|
|
||||||
use crate::analyzer::CompilerStatistics;
|
|
||||||
|
|
||||||
pub(crate) static REPORTER: OnceLock<Mutex<Report>> = OnceLock::new();
|
|
||||||
|
|
||||||
/// The `Report` datastructure stores all relevant inforamtion required for generating reports.
|
|
||||||
#[derive(Clone, Debug, Default, Serialize, Deserialize)]
|
|
||||||
pub struct Report {
|
|
||||||
/// The configuration used during the test.
|
|
||||||
pub config: Arguments,
|
|
||||||
/// The observed test corpora.
|
|
||||||
pub corpora: Vec<Corpus>,
|
|
||||||
/// The observed test definitions.
|
|
||||||
pub metadata_files: Vec<PathBuf>,
|
|
||||||
/// The observed compilation results.
|
|
||||||
pub compiler_results: HashMap<TestingPlatform, Vec<CompilationResult>>,
|
|
||||||
/// The observed compilation statistics.
|
|
||||||
pub compiler_statistics: HashMap<TestingPlatform, CompilerStatistics>,
|
|
||||||
/// The file name this is serialized to.
|
|
||||||
#[serde(skip)]
|
|
||||||
directory: PathBuf,
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Contains a compiled contract.
|
|
||||||
#[derive(Clone, Debug, Serialize, Deserialize)]
|
|
||||||
pub struct CompilationTask {
|
|
||||||
/// The observed compiler input.
|
|
||||||
pub json_input: SolcStandardJsonInput,
|
|
||||||
/// The observed compiler output.
|
|
||||||
pub json_output: Option<SolcStandardJsonOutput>,
|
|
||||||
/// The observed compiler mode.
|
|
||||||
pub mode: SolcMode,
|
|
||||||
/// The observed compiler version.
|
|
||||||
pub compiler_version: String,
|
|
||||||
/// The observed error, if any.
|
|
||||||
pub error: Option<String>,
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Represents a report about a compilation task.
|
|
||||||
#[derive(Clone, Debug, Serialize, Deserialize)]
|
|
||||||
pub struct CompilationResult {
|
|
||||||
/// The observed compilation task.
|
|
||||||
pub compilation_task: CompilationTask,
|
|
||||||
/// The linked span.
|
|
||||||
pub span: Span,
|
|
||||||
}
|
|
||||||
|
|
||||||
/// The [Span] struct indicates the context of what is being reported.
|
|
||||||
#[derive(Clone, Copy, Debug, Serialize, Deserialize)]
|
|
||||||
pub struct Span {
|
|
||||||
/// The corpus index this belongs to.
|
|
||||||
corpus: usize,
|
|
||||||
/// The metadata file this belongs to.
|
|
||||||
metadata_file: usize,
|
|
||||||
/// The index of the case definition this belongs to.
|
|
||||||
case: usize,
|
|
||||||
/// The index of the case input this belongs to.
|
|
||||||
input: usize,
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Report {
|
|
||||||
/// The file name where this report will be written to.
|
|
||||||
pub const FILE_NAME: &str = "report.json";
|
|
||||||
|
|
||||||
/// The [Span] is expected to initialize the reporter by providing the config.
|
|
||||||
const INITIALIZED_VIA_SPAN: &str = "requires a Span which initializes the reporter";
|
|
||||||
|
|
||||||
/// Create a new [Report].
|
|
||||||
fn new(config: Arguments) -> anyhow::Result<Self> {
|
|
||||||
let now = SystemTime::now()
|
|
||||||
.duration_since(UNIX_EPOCH)
|
|
||||||
.unwrap()
|
|
||||||
.as_millis();
|
|
||||||
|
|
||||||
let directory = config.directory().join("report").join(format!("{now}"));
|
|
||||||
if !directory.exists() {
|
|
||||||
create_dir_all(&directory)?;
|
|
||||||
}
|
|
||||||
|
|
||||||
Ok(Self {
|
|
||||||
config,
|
|
||||||
directory,
|
|
||||||
..Default::default()
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Add a compilation task to the report.
|
|
||||||
pub fn compilation(span: Span, platform: TestingPlatform, compilation_task: CompilationTask) {
|
|
||||||
let mut report = REPORTER
|
|
||||||
.get()
|
|
||||||
.expect(Report::INITIALIZED_VIA_SPAN)
|
|
||||||
.lock()
|
|
||||||
.unwrap();
|
|
||||||
|
|
||||||
report
|
|
||||||
.compiler_statistics
|
|
||||||
.entry(platform)
|
|
||||||
.or_default()
|
|
||||||
.sample(&compilation_task);
|
|
||||||
|
|
||||||
report
|
|
||||||
.compiler_results
|
|
||||||
.entry(platform)
|
|
||||||
.or_default()
|
|
||||||
.push(CompilationResult {
|
|
||||||
compilation_task,
|
|
||||||
span,
|
|
||||||
});
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Write the report to disk.
|
|
||||||
pub fn save() -> anyhow::Result<()> {
|
|
||||||
let Some(reporter) = REPORTER.get() else {
|
|
||||||
return Ok(());
|
|
||||||
};
|
|
||||||
let report = reporter.lock().unwrap();
|
|
||||||
|
|
||||||
if let Err(error) = report.write_to_file() {
|
|
||||||
anyhow::bail!("can not write report: {error}");
|
|
||||||
}
|
|
||||||
|
|
||||||
if report.config.extract_problems {
|
|
||||||
if let Err(error) = report.save_compiler_problems() {
|
|
||||||
anyhow::bail!("can not write compiler problems: {error}");
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Write compiler problems to disk for later debugging.
|
|
||||||
pub fn save_compiler_problems(&self) -> anyhow::Result<()> {
|
|
||||||
for (platform, results) in self.compiler_results.iter() {
|
|
||||||
for result in results {
|
|
||||||
// ignore if there were no errors
|
|
||||||
if result.compilation_task.error.is_none()
|
|
||||||
&& result
|
|
||||||
.compilation_task
|
|
||||||
.json_output
|
|
||||||
.as_ref()
|
|
||||||
.and_then(|output| output.errors.as_ref())
|
|
||||||
.map(|errors| errors.is_empty())
|
|
||||||
.unwrap_or(true)
|
|
||||||
{
|
|
||||||
continue;
|
|
||||||
}
|
|
||||||
|
|
||||||
let path = &self.metadata_files[result.span.metadata_file]
|
|
||||||
.parent()
|
|
||||||
.unwrap()
|
|
||||||
.join(format!("{platform}_errors"));
|
|
||||||
if !path.exists() {
|
|
||||||
create_dir_all(path)?;
|
|
||||||
}
|
|
||||||
|
|
||||||
if let Some(error) = result.compilation_task.error.as_ref() {
|
|
||||||
fs::write(path.join("compiler_error.txt"), error)?;
|
|
||||||
}
|
|
||||||
|
|
||||||
if let Some(errors) = result.compilation_task.json_output.as_ref() {
|
|
||||||
let file = File::create(path.join("compiler_output.txt"))?;
|
|
||||||
serde_json::to_writer_pretty(file, &errors)?;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
|
|
||||||
fn write_to_file(&self) -> anyhow::Result<()> {
|
|
||||||
let path = self.directory.join(Self::FILE_NAME);
|
|
||||||
|
|
||||||
let file = File::create(&path).context(path.display().to_string())?;
|
|
||||||
serde_json::to_writer_pretty(file, &self)?;
|
|
||||||
|
|
||||||
tracing::info!("report written to: {}", path.display());
|
|
||||||
|
|
||||||
Ok(())
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
impl Span {
|
|
||||||
/// Create a new [Span] with case and input index at 0.
|
|
||||||
///
|
|
||||||
/// Initializes the reporting facility on the first call.
|
|
||||||
pub fn new(corpus: Corpus, config: Arguments) -> anyhow::Result<Self> {
|
|
||||||
let report = Mutex::new(Report::new(config)?);
|
|
||||||
let mut reporter = REPORTER.get_or_init(|| report).lock().unwrap();
|
|
||||||
reporter.corpora.push(corpus);
|
|
||||||
|
|
||||||
Ok(Self {
|
|
||||||
corpus: reporter.corpora.len() - 1,
|
|
||||||
metadata_file: 0,
|
|
||||||
case: 0,
|
|
||||||
input: 0,
|
|
||||||
})
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Advance to the next metadata file: Resets the case input index to 0.
|
|
||||||
pub fn next_metadata(&mut self, metadata_file: PathBuf) {
|
|
||||||
let mut reporter = REPORTER
|
|
||||||
.get()
|
|
||||||
.expect(Report::INITIALIZED_VIA_SPAN)
|
|
||||||
.lock()
|
|
||||||
.unwrap();
|
|
||||||
|
|
||||||
reporter.metadata_files.push(metadata_file);
|
|
||||||
|
|
||||||
self.metadata_file = reporter.metadata_files.len() - 1;
|
|
||||||
self.case = 0;
|
|
||||||
self.input = 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Advance to the next case: Increas the case index by one and resets the input index to 0.
|
|
||||||
pub fn next_case(&mut self) {
|
|
||||||
self.case += 1;
|
|
||||||
self.input = 0;
|
|
||||||
}
|
|
||||||
|
|
||||||
/// Advance to the next input.
|
|
||||||
pub fn next_input(&mut self) {
|
|
||||||
self.input += 1;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,22 @@
|
|||||||
|
//! A reporter event sent by the report aggregator to the various listeners.
|
||||||
|
|
||||||
|
use std::collections::BTreeMap;
|
||||||
|
|
||||||
|
use revive_dt_compiler::Mode;
|
||||||
|
use revive_dt_format::case::CaseIdx;
|
||||||
|
|
||||||
|
use crate::{MetadataFilePath, TestCaseStatus};
|
||||||
|
|
||||||
|
#[derive(Clone, Debug)]
|
||||||
|
pub enum ReporterEvent {
|
||||||
|
/// An event sent by the reporter once an entire metadata file and solc mode combination has
|
||||||
|
/// finished execution.
|
||||||
|
MetadataFileSolcModeCombinationExecutionCompleted {
|
||||||
|
/// The path of the metadata file.
|
||||||
|
metadata_file_path: MetadataFilePath,
|
||||||
|
/// The Solc mode that this metadata file was executed in.
|
||||||
|
mode: Mode,
|
||||||
|
/// The status of each one of the cases.
|
||||||
|
case_status: BTreeMap<CaseIdx, TestCaseStatus>,
|
||||||
|
},
|
||||||
|
}
|
||||||
@@ -0,0 +1,642 @@
|
|||||||
|
//! The types associated with the events sent by the runner to the reporter.
|
||||||
|
#![allow(dead_code)]
|
||||||
|
|
||||||
|
use std::{collections::BTreeMap, path::PathBuf, sync::Arc};
|
||||||
|
|
||||||
|
use alloy_primitives::Address;
|
||||||
|
use anyhow::Context as _;
|
||||||
|
use indexmap::IndexMap;
|
||||||
|
use revive_dt_compiler::{CompilerInput, CompilerOutput};
|
||||||
|
use revive_dt_config::TestingPlatform;
|
||||||
|
use revive_dt_format::metadata::Metadata;
|
||||||
|
use revive_dt_format::{corpus::Corpus, metadata::ContractInstance};
|
||||||
|
use semver::Version;
|
||||||
|
use tokio::sync::{broadcast, oneshot};
|
||||||
|
|
||||||
|
use crate::{ExecutionSpecifier, ReporterEvent, TestSpecifier, common::MetadataFilePath};
|
||||||
|
|
||||||
|
macro_rules! __report_gen_emit_test_specific {
|
||||||
|
(
|
||||||
|
$ident:ident,
|
||||||
|
$variant_ident:ident,
|
||||||
|
$skip_field:ident;
|
||||||
|
$( $bname:ident : $bty:ty, )*
|
||||||
|
;
|
||||||
|
$( $aname:ident : $aty:ty, )*
|
||||||
|
) => {
|
||||||
|
paste::paste! {
|
||||||
|
pub fn [< report_ $variant_ident:snake _event >](
|
||||||
|
&self
|
||||||
|
$(, $bname: impl Into<$bty> )*
|
||||||
|
$(, $aname: impl Into<$aty> )*
|
||||||
|
) -> anyhow::Result<()> {
|
||||||
|
self.report([< $variant_ident Event >] {
|
||||||
|
$skip_field: self.test_specifier.clone()
|
||||||
|
$(, $bname: $bname.into() )*
|
||||||
|
$(, $aname: $aname.into() )*
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
macro_rules! __report_gen_emit_test_specific_by_parse {
|
||||||
|
(
|
||||||
|
$ident:ident,
|
||||||
|
$variant_ident:ident,
|
||||||
|
$skip_field:ident;
|
||||||
|
$( $bname:ident : $bty:ty, )* ; $( $aname:ident : $aty:ty, )*
|
||||||
|
) => {
|
||||||
|
__report_gen_emit_test_specific!(
|
||||||
|
$ident, $variant_ident, $skip_field;
|
||||||
|
$( $bname : $bty, )* ; $( $aname : $aty, )*
|
||||||
|
);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
macro_rules! __report_gen_scan_before {
|
||||||
|
(
|
||||||
|
$ident:ident, $variant_ident:ident;
|
||||||
|
$( $before:ident : $bty:ty, )*
|
||||||
|
;
|
||||||
|
test_specifier : $skip_ty:ty,
|
||||||
|
$( $after:ident : $aty:ty, )*
|
||||||
|
;
|
||||||
|
) => {
|
||||||
|
__report_gen_emit_test_specific_by_parse!(
|
||||||
|
$ident, $variant_ident, test_specifier;
|
||||||
|
$( $before : $bty, )* ; $( $after : $aty, )*
|
||||||
|
);
|
||||||
|
};
|
||||||
|
(
|
||||||
|
$ident:ident, $variant_ident:ident;
|
||||||
|
$( $before:ident : $bty:ty, )*
|
||||||
|
;
|
||||||
|
$name:ident : $ty:ty, $( $after:ident : $aty:ty, )*
|
||||||
|
;
|
||||||
|
) => {
|
||||||
|
__report_gen_scan_before!(
|
||||||
|
$ident, $variant_ident;
|
||||||
|
$( $before : $bty, )* $name : $ty,
|
||||||
|
;
|
||||||
|
$( $after : $aty, )*
|
||||||
|
;
|
||||||
|
);
|
||||||
|
};
|
||||||
|
(
|
||||||
|
$ident:ident, $variant_ident:ident;
|
||||||
|
$( $before:ident : $bty:ty, )*
|
||||||
|
;
|
||||||
|
;
|
||||||
|
) => {};
|
||||||
|
}
|
||||||
|
|
||||||
|
macro_rules! __report_gen_for_variant {
|
||||||
|
(
|
||||||
|
$ident:ident,
|
||||||
|
$variant_ident:ident;
|
||||||
|
) => {};
|
||||||
|
(
|
||||||
|
$ident:ident,
|
||||||
|
$variant_ident:ident;
|
||||||
|
$( $field_ident:ident : $field_ty:ty ),+ $(,)?
|
||||||
|
) => {
|
||||||
|
__report_gen_scan_before!(
|
||||||
|
$ident, $variant_ident;
|
||||||
|
;
|
||||||
|
$( $field_ident : $field_ty, )*
|
||||||
|
;
|
||||||
|
);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
macro_rules! __report_gen_emit_execution_specific {
|
||||||
|
(
|
||||||
|
$ident:ident,
|
||||||
|
$variant_ident:ident,
|
||||||
|
$skip_field:ident;
|
||||||
|
$( $bname:ident : $bty:ty, )*
|
||||||
|
;
|
||||||
|
$( $aname:ident : $aty:ty, )*
|
||||||
|
) => {
|
||||||
|
paste::paste! {
|
||||||
|
pub fn [< report_ $variant_ident:snake _event >](
|
||||||
|
&self
|
||||||
|
$(, $bname: impl Into<$bty> )*
|
||||||
|
$(, $aname: impl Into<$aty> )*
|
||||||
|
) -> anyhow::Result<()> {
|
||||||
|
self.report([< $variant_ident Event >] {
|
||||||
|
$skip_field: self.execution_specifier.clone()
|
||||||
|
$(, $bname: $bname.into() )*
|
||||||
|
$(, $aname: $aname.into() )*
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
macro_rules! __report_gen_emit_execution_specific_by_parse {
|
||||||
|
(
|
||||||
|
$ident:ident,
|
||||||
|
$variant_ident:ident,
|
||||||
|
$skip_field:ident;
|
||||||
|
$( $bname:ident : $bty:ty, )* ; $( $aname:ident : $aty:ty, )*
|
||||||
|
) => {
|
||||||
|
__report_gen_emit_execution_specific!(
|
||||||
|
$ident, $variant_ident, $skip_field;
|
||||||
|
$( $bname : $bty, )* ; $( $aname : $aty, )*
|
||||||
|
);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
macro_rules! __report_gen_scan_before_exec {
|
||||||
|
(
|
||||||
|
$ident:ident, $variant_ident:ident;
|
||||||
|
$( $before:ident : $bty:ty, )*
|
||||||
|
;
|
||||||
|
execution_specifier : $skip_ty:ty,
|
||||||
|
$( $after:ident : $aty:ty, )*
|
||||||
|
;
|
||||||
|
) => {
|
||||||
|
__report_gen_emit_execution_specific_by_parse!(
|
||||||
|
$ident, $variant_ident, execution_specifier;
|
||||||
|
$( $before : $bty, )* ; $( $after : $aty, )*
|
||||||
|
);
|
||||||
|
};
|
||||||
|
(
|
||||||
|
$ident:ident, $variant_ident:ident;
|
||||||
|
$( $before:ident : $bty:ty, )*
|
||||||
|
;
|
||||||
|
$name:ident : $ty:ty, $( $after:ident : $aty:ty, )*
|
||||||
|
;
|
||||||
|
) => {
|
||||||
|
__report_gen_scan_before_exec!(
|
||||||
|
$ident, $variant_ident;
|
||||||
|
$( $before : $bty, )* $name : $ty,
|
||||||
|
;
|
||||||
|
$( $after : $aty, )*
|
||||||
|
;
|
||||||
|
);
|
||||||
|
};
|
||||||
|
(
|
||||||
|
$ident:ident, $variant_ident:ident;
|
||||||
|
$( $before:ident : $bty:ty, )*
|
||||||
|
;
|
||||||
|
;
|
||||||
|
) => {};
|
||||||
|
}
|
||||||
|
|
||||||
|
macro_rules! __report_gen_for_variant_exec {
|
||||||
|
(
|
||||||
|
$ident:ident,
|
||||||
|
$variant_ident:ident;
|
||||||
|
) => {};
|
||||||
|
(
|
||||||
|
$ident:ident,
|
||||||
|
$variant_ident:ident;
|
||||||
|
$( $field_ident:ident : $field_ty:ty ),+ $(,)?
|
||||||
|
) => {
|
||||||
|
__report_gen_scan_before_exec!(
|
||||||
|
$ident, $variant_ident;
|
||||||
|
;
|
||||||
|
$( $field_ident : $field_ty, )*
|
||||||
|
;
|
||||||
|
);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
macro_rules! __report_gen_emit_step_execution_specific {
|
||||||
|
(
|
||||||
|
$ident:ident,
|
||||||
|
$variant_ident:ident,
|
||||||
|
$skip_field:ident;
|
||||||
|
$( $bname:ident : $bty:ty, )*
|
||||||
|
;
|
||||||
|
$( $aname:ident : $aty:ty, )*
|
||||||
|
) => {
|
||||||
|
paste::paste! {
|
||||||
|
pub fn [< report_ $variant_ident:snake _event >](
|
||||||
|
&self
|
||||||
|
$(, $bname: impl Into<$bty> )*
|
||||||
|
$(, $aname: impl Into<$aty> )*
|
||||||
|
) -> anyhow::Result<()> {
|
||||||
|
self.report([< $variant_ident Event >] {
|
||||||
|
$skip_field: self.step_specifier.clone()
|
||||||
|
$(, $bname: $bname.into() )*
|
||||||
|
$(, $aname: $aname.into() )*
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
macro_rules! __report_gen_emit_step_execution_specific_by_parse {
|
||||||
|
(
|
||||||
|
$ident:ident,
|
||||||
|
$variant_ident:ident,
|
||||||
|
$skip_field:ident;
|
||||||
|
$( $bname:ident : $bty:ty, )* ; $( $aname:ident : $aty:ty, )*
|
||||||
|
) => {
|
||||||
|
__report_gen_emit_step_execution_specific!(
|
||||||
|
$ident, $variant_ident, $skip_field;
|
||||||
|
$( $bname : $bty, )* ; $( $aname : $aty, )*
|
||||||
|
);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
macro_rules! __report_gen_scan_before_step {
|
||||||
|
(
|
||||||
|
$ident:ident, $variant_ident:ident;
|
||||||
|
$( $before:ident : $bty:ty, )*
|
||||||
|
;
|
||||||
|
step_specifier : $skip_ty:ty,
|
||||||
|
$( $after:ident : $aty:ty, )*
|
||||||
|
;
|
||||||
|
) => {
|
||||||
|
__report_gen_emit_step_execution_specific_by_parse!(
|
||||||
|
$ident, $variant_ident, step_specifier;
|
||||||
|
$( $before : $bty, )* ; $( $after : $aty, )*
|
||||||
|
);
|
||||||
|
};
|
||||||
|
(
|
||||||
|
$ident:ident, $variant_ident:ident;
|
||||||
|
$( $before:ident : $bty:ty, )*
|
||||||
|
;
|
||||||
|
$name:ident : $ty:ty, $( $after:ident : $aty:ty, )*
|
||||||
|
;
|
||||||
|
) => {
|
||||||
|
__report_gen_scan_before_step!(
|
||||||
|
$ident, $variant_ident;
|
||||||
|
$( $before : $bty, )* $name : $ty,
|
||||||
|
;
|
||||||
|
$( $after : $aty, )*
|
||||||
|
;
|
||||||
|
);
|
||||||
|
};
|
||||||
|
(
|
||||||
|
$ident:ident, $variant_ident:ident;
|
||||||
|
$( $before:ident : $bty:ty, )*
|
||||||
|
;
|
||||||
|
;
|
||||||
|
) => {};
|
||||||
|
}
|
||||||
|
|
||||||
|
macro_rules! __report_gen_for_variant_step {
|
||||||
|
(
|
||||||
|
$ident:ident,
|
||||||
|
$variant_ident:ident;
|
||||||
|
) => {};
|
||||||
|
(
|
||||||
|
$ident:ident,
|
||||||
|
$variant_ident:ident;
|
||||||
|
$( $field_ident:ident : $field_ty:ty ),+ $(,)?
|
||||||
|
) => {
|
||||||
|
__report_gen_scan_before_step!(
|
||||||
|
$ident, $variant_ident;
|
||||||
|
;
|
||||||
|
$( $field_ident : $field_ty, )*
|
||||||
|
;
|
||||||
|
);
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
/// Defines the runner-event which is sent from the test runners to the report aggregator.
|
||||||
|
///
|
||||||
|
/// This macro defines a number of things related to the reporting infrastructure and the interface
|
||||||
|
/// used. First of all, it defines the enum of all of the possible events that the runners can send
|
||||||
|
/// to the aggregator. For each one of the variants it defines a separate struct for it to allow the
|
||||||
|
/// variant field in the enum to be put in a [`Box`].
|
||||||
|
///
|
||||||
|
/// In addition to the above, it defines [`From`] implementations for the various event types for
|
||||||
|
/// the [`RunnerEvent`] enum essentially allowing for events such as [`CorpusFileDiscoveryEvent`] to
|
||||||
|
/// be converted into a [`RunnerEvent`].
|
||||||
|
///
|
||||||
|
/// In addition to the above, it also defines the [`RunnerEventReporter`] which is a wrapper around
|
||||||
|
/// an [`UnboundedSender`] allowing for events to be sent to the report aggregator.
|
||||||
|
///
|
||||||
|
/// With the above description, we can see that this macro defines almost all of the interface of
|
||||||
|
/// the reporting infrastructure, from the enum itself, to its associated types, and also to the
|
||||||
|
/// reporter that's used to report events to the aggregator.
|
||||||
|
///
|
||||||
|
/// [`UnboundedSender`]: tokio::sync::mpsc::UnboundedSender
|
||||||
|
macro_rules! define_event {
|
||||||
|
(
|
||||||
|
$(#[$enum_meta: meta])*
|
||||||
|
$vis: vis enum $ident: ident {
|
||||||
|
$(
|
||||||
|
$(#[$variant_meta: meta])*
|
||||||
|
$variant_ident: ident {
|
||||||
|
$(
|
||||||
|
$(#[$field_meta: meta])*
|
||||||
|
$field_ident: ident: $field_ty: ty
|
||||||
|
),* $(,)?
|
||||||
|
}
|
||||||
|
),* $(,)?
|
||||||
|
}
|
||||||
|
) => {
|
||||||
|
paste::paste! {
|
||||||
|
$(#[$enum_meta])*
|
||||||
|
#[derive(Debug)]
|
||||||
|
$vis enum $ident {
|
||||||
|
$(
|
||||||
|
$(#[$variant_meta])*
|
||||||
|
$variant_ident(Box<[<$variant_ident Event>]>)
|
||||||
|
),*
|
||||||
|
}
|
||||||
|
|
||||||
|
$(
|
||||||
|
#[derive(Debug)]
|
||||||
|
$(#[$variant_meta])*
|
||||||
|
$vis struct [<$variant_ident Event>] {
|
||||||
|
$(
|
||||||
|
$(#[$field_meta])*
|
||||||
|
$vis $field_ident: $field_ty
|
||||||
|
),*
|
||||||
|
}
|
||||||
|
)*
|
||||||
|
|
||||||
|
$(
|
||||||
|
impl From<[<$variant_ident Event>]> for $ident {
|
||||||
|
fn from(value: [<$variant_ident Event>]) -> Self {
|
||||||
|
Self::$variant_ident(Box::new(value))
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)*
|
||||||
|
|
||||||
|
/// Provides a way to report events to the aggregator.
|
||||||
|
///
|
||||||
|
/// Under the hood, this is a wrapper around an [`UnboundedSender`] which abstracts away
|
||||||
|
/// the fact that channels are used and that implements high-level methods for reporting
|
||||||
|
/// various events to the aggregator.
|
||||||
|
#[derive(Clone, Debug)]
|
||||||
|
pub struct [< $ident Reporter >]($vis tokio::sync::mpsc::UnboundedSender<$ident>);
|
||||||
|
|
||||||
|
impl From<tokio::sync::mpsc::UnboundedSender<$ident>> for [< $ident Reporter >] {
|
||||||
|
fn from(value: tokio::sync::mpsc::UnboundedSender<$ident>) -> Self {
|
||||||
|
Self(value)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
impl [< $ident Reporter >] {
|
||||||
|
pub fn test_specific_reporter(
|
||||||
|
&self,
|
||||||
|
test_specifier: impl Into<std::sync::Arc<crate::common::TestSpecifier>>
|
||||||
|
) -> [< $ident TestSpecificReporter >] {
|
||||||
|
[< $ident TestSpecificReporter >] {
|
||||||
|
reporter: self.clone(),
|
||||||
|
test_specifier: test_specifier.into(),
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn report(&self, event: impl Into<$ident>) -> anyhow::Result<()> {
|
||||||
|
self.0.send(event.into()).map_err(Into::into)
|
||||||
|
}
|
||||||
|
|
||||||
|
$(
|
||||||
|
pub fn [< report_ $variant_ident:snake _event >](&self, $($field_ident: impl Into<$field_ty>),*) -> anyhow::Result<()> {
|
||||||
|
self.report([< $variant_ident Event >] {
|
||||||
|
$($field_ident: $field_ident.into()),*
|
||||||
|
})
|
||||||
|
}
|
||||||
|
)*
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A reporter that's tied to a specific test case.
|
||||||
|
#[derive(Clone, Debug)]
|
||||||
|
pub struct [< $ident TestSpecificReporter >] {
|
||||||
|
$vis reporter: [< $ident Reporter >],
|
||||||
|
$vis test_specifier: std::sync::Arc<crate::common::TestSpecifier>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl [< $ident TestSpecificReporter >] {
|
||||||
|
pub fn execution_specific_reporter(
|
||||||
|
&self,
|
||||||
|
node_id: impl Into<usize>,
|
||||||
|
node_designation: impl Into<$crate::common::NodeDesignation>
|
||||||
|
) -> [< $ident ExecutionSpecificReporter >] {
|
||||||
|
[< $ident ExecutionSpecificReporter >] {
|
||||||
|
reporter: self.reporter.clone(),
|
||||||
|
execution_specifier: Arc::new($crate::common::ExecutionSpecifier {
|
||||||
|
test_specifier: self.test_specifier.clone(),
|
||||||
|
node_id: node_id.into(),
|
||||||
|
node_designation: node_designation.into(),
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
fn report(&self, event: impl Into<$ident>) -> anyhow::Result<()> {
|
||||||
|
self.reporter.report(event)
|
||||||
|
}
|
||||||
|
|
||||||
|
$(
|
||||||
|
__report_gen_for_variant! { $ident, $variant_ident; $( $field_ident : $field_ty ),* }
|
||||||
|
)*
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A reporter that's tied to a specific execution of the test case such as execution on
|
||||||
|
/// a specific node like the leader or follower.
|
||||||
|
#[derive(Clone, Debug)]
|
||||||
|
pub struct [< $ident ExecutionSpecificReporter >] {
|
||||||
|
$vis reporter: [< $ident Reporter >],
|
||||||
|
$vis execution_specifier: std::sync::Arc<$crate::common::ExecutionSpecifier>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl [< $ident ExecutionSpecificReporter >] {
|
||||||
|
fn report(&self, event: impl Into<$ident>) -> anyhow::Result<()> {
|
||||||
|
self.reporter.report(event)
|
||||||
|
}
|
||||||
|
|
||||||
|
$(
|
||||||
|
__report_gen_for_variant_exec! { $ident, $variant_ident; $( $field_ident : $field_ty ),* }
|
||||||
|
)*
|
||||||
|
}
|
||||||
|
|
||||||
|
/// A reporter that's tied to a specific step execution
|
||||||
|
#[derive(Clone, Debug)]
|
||||||
|
pub struct [< $ident StepExecutionSpecificReporter >] {
|
||||||
|
$vis reporter: [< $ident Reporter >],
|
||||||
|
$vis step_specifier: std::sync::Arc<$crate::common::StepExecutionSpecifier>,
|
||||||
|
}
|
||||||
|
|
||||||
|
impl [< $ident StepExecutionSpecificReporter >] {
|
||||||
|
fn report(&self, event: impl Into<$ident>) -> anyhow::Result<()> {
|
||||||
|
self.reporter.report(event)
|
||||||
|
}
|
||||||
|
|
||||||
|
$(
|
||||||
|
__report_gen_for_variant_step! { $ident, $variant_ident; $( $field_ident : $field_ty ),* }
|
||||||
|
)*
|
||||||
|
}
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
|
|
||||||
|
define_event! {
|
||||||
|
/// An event type that's sent by the test runners/drivers to the report aggregator.
|
||||||
|
pub(crate) enum RunnerEvent {
|
||||||
|
/// An event emitted by the reporter when it wishes to listen to events emitted by the
|
||||||
|
/// aggregator.
|
||||||
|
SubscribeToEvents {
|
||||||
|
/// The channel that the aggregator is to send the receive side of the channel on.
|
||||||
|
tx: oneshot::Sender<broadcast::Receiver<ReporterEvent>>
|
||||||
|
},
|
||||||
|
/// An event emitted by runners when they've discovered a corpus file.
|
||||||
|
CorpusFileDiscovery {
|
||||||
|
/// The contents of the corpus file.
|
||||||
|
corpus: Corpus
|
||||||
|
},
|
||||||
|
/// An event emitted by runners when they've discovered a metadata file.
|
||||||
|
MetadataFileDiscovery {
|
||||||
|
/// The path of the metadata file discovered.
|
||||||
|
path: MetadataFilePath,
|
||||||
|
/// The content of the metadata file.
|
||||||
|
metadata: Metadata
|
||||||
|
},
|
||||||
|
/// An event emitted by the runners when they discover a test case.
|
||||||
|
TestCaseDiscovery {
|
||||||
|
/// A specifier for the test that was discovered.
|
||||||
|
test_specifier: Arc<TestSpecifier>,
|
||||||
|
},
|
||||||
|
/// An event emitted by the runners when a test case is ignored.
|
||||||
|
TestIgnored {
|
||||||
|
/// A specifier for the test that's been ignored.
|
||||||
|
test_specifier: Arc<TestSpecifier>,
|
||||||
|
/// A reason for the test to be ignored.
|
||||||
|
reason: String,
|
||||||
|
/// Additional fields that describe more information on why the test was ignored.
|
||||||
|
additional_fields: IndexMap<String, serde_json::Value>
|
||||||
|
},
|
||||||
|
/// An event emitted by the runners when a test case has succeeded.
|
||||||
|
TestSucceeded {
|
||||||
|
/// A specifier for the test that succeeded.
|
||||||
|
test_specifier: Arc<TestSpecifier>,
|
||||||
|
/// The number of steps of the case that were executed by the driver.
|
||||||
|
steps_executed: usize,
|
||||||
|
},
|
||||||
|
/// An event emitted by the runners when a test case has failed.
|
||||||
|
TestFailed {
|
||||||
|
/// A specifier for the test that succeeded.
|
||||||
|
test_specifier: Arc<TestSpecifier>,
|
||||||
|
/// A reason for the failure of the test.
|
||||||
|
reason: String,
|
||||||
|
},
|
||||||
|
/// An event emitted when the test case is assigned a leader node.
|
||||||
|
LeaderNodeAssigned {
|
||||||
|
/// A specifier for the test that the assignment is for.
|
||||||
|
test_specifier: Arc<TestSpecifier>,
|
||||||
|
/// The ID of the node that this case is being executed on.
|
||||||
|
id: usize,
|
||||||
|
/// The platform of the node.
|
||||||
|
platform: TestingPlatform,
|
||||||
|
/// The connection string of the node.
|
||||||
|
connection_string: String,
|
||||||
|
},
|
||||||
|
/// An event emitted when the test case is assigned a follower node.
|
||||||
|
FollowerNodeAssigned {
|
||||||
|
/// A specifier for the test that the assignment is for.
|
||||||
|
test_specifier: Arc<TestSpecifier>,
|
||||||
|
/// The ID of the node that this case is being executed on.
|
||||||
|
id: usize,
|
||||||
|
/// The platform of the node.
|
||||||
|
platform: TestingPlatform,
|
||||||
|
/// The connection string of the node.
|
||||||
|
connection_string: String,
|
||||||
|
},
|
||||||
|
/// An event emitted by the runners when the compilation of the contracts has succeeded
|
||||||
|
/// on the pre-link contracts.
|
||||||
|
PreLinkContractsCompilationSucceeded {
|
||||||
|
/// A specifier for the execution that's taking place.
|
||||||
|
execution_specifier: Arc<ExecutionSpecifier>,
|
||||||
|
/// The version of the compiler used to compile the contracts.
|
||||||
|
compiler_version: Version,
|
||||||
|
/// The path of the compiler used to compile the contracts.
|
||||||
|
compiler_path: PathBuf,
|
||||||
|
/// A flag of whether the contract bytecode and ABI were cached or if they were compiled
|
||||||
|
/// anew.
|
||||||
|
is_cached: bool,
|
||||||
|
/// The input provided to the compiler - this is optional and not provided if the
|
||||||
|
/// contracts were obtained from the cache.
|
||||||
|
compiler_input: Option<CompilerInput>,
|
||||||
|
/// The output of the compiler.
|
||||||
|
compiler_output: CompilerOutput
|
||||||
|
},
|
||||||
|
/// An event emitted by the runners when the compilation of the contracts has succeeded
|
||||||
|
/// on the post-link contracts.
|
||||||
|
PostLinkContractsCompilationSucceeded {
|
||||||
|
/// A specifier for the execution that's taking place.
|
||||||
|
execution_specifier: Arc<ExecutionSpecifier>,
|
||||||
|
/// The version of the compiler used to compile the contracts.
|
||||||
|
compiler_version: Version,
|
||||||
|
/// The path of the compiler used to compile the contracts.
|
||||||
|
compiler_path: PathBuf,
|
||||||
|
/// A flag of whether the contract bytecode and ABI were cached or if they were compiled
|
||||||
|
/// anew.
|
||||||
|
is_cached: bool,
|
||||||
|
/// The input provided to the compiler - this is optional and not provided if the
|
||||||
|
/// contracts were obtained from the cache.
|
||||||
|
compiler_input: Option<CompilerInput>,
|
||||||
|
/// The output of the compiler.
|
||||||
|
compiler_output: CompilerOutput
|
||||||
|
},
|
||||||
|
/// An event emitted by the runners when the compilation of the pre-link contract has
|
||||||
|
/// failed.
|
||||||
|
PreLinkContractsCompilationFailed {
|
||||||
|
/// A specifier for the execution that's taking place.
|
||||||
|
execution_specifier: Arc<ExecutionSpecifier>,
|
||||||
|
/// The version of the compiler used to compile the contracts.
|
||||||
|
compiler_version: Option<Version>,
|
||||||
|
/// The path of the compiler used to compile the contracts.
|
||||||
|
compiler_path: Option<PathBuf>,
|
||||||
|
/// The input provided to the compiler - this is optional and not provided if the
|
||||||
|
/// contracts were obtained from the cache.
|
||||||
|
compiler_input: Option<CompilerInput>,
|
||||||
|
/// The failure reason.
|
||||||
|
reason: String,
|
||||||
|
},
|
||||||
|
/// An event emitted by the runners when the compilation of the post-link contract has
|
||||||
|
/// failed.
|
||||||
|
PostLinkContractsCompilationFailed {
|
||||||
|
/// A specifier for the execution that's taking place.
|
||||||
|
execution_specifier: Arc<ExecutionSpecifier>,
|
||||||
|
/// The version of the compiler used to compile the contracts.
|
||||||
|
compiler_version: Option<Version>,
|
||||||
|
/// The path of the compiler used to compile the contracts.
|
||||||
|
compiler_path: Option<PathBuf>,
|
||||||
|
/// The input provided to the compiler - this is optional and not provided if the
|
||||||
|
/// contracts were obtained from the cache.
|
||||||
|
compiler_input: Option<CompilerInput>,
|
||||||
|
/// The failure reason.
|
||||||
|
reason: String,
|
||||||
|
},
|
||||||
|
/// An event emitted by the runners when a library has been deployed.
|
||||||
|
LibrariesDeployed {
|
||||||
|
/// A specifier for the execution that's taking place.
|
||||||
|
execution_specifier: Arc<ExecutionSpecifier>,
|
||||||
|
/// The addresses of the libraries that were deployed.
|
||||||
|
libraries: BTreeMap<ContractInstance, Address>
|
||||||
|
},
|
||||||
|
/// An event emitted by the runners when they've deployed a new contract.
|
||||||
|
ContractDeployed {
|
||||||
|
/// A specifier for the execution that's taking place.
|
||||||
|
execution_specifier: Arc<ExecutionSpecifier>,
|
||||||
|
/// The instance name of the contract.
|
||||||
|
contract_instance: ContractInstance,
|
||||||
|
/// The address of the contract.
|
||||||
|
address: Address
|
||||||
|
},
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/// An extension to the [`Reporter`] implemented by the macro.
|
||||||
|
impl RunnerEventReporter {
|
||||||
|
pub async fn subscribe(&self) -> anyhow::Result<broadcast::Receiver<ReporterEvent>> {
|
||||||
|
let (tx, rx) = oneshot::channel::<broadcast::Receiver<ReporterEvent>>();
|
||||||
|
self.report_subscribe_to_events_event(tx)
|
||||||
|
.context("Failed to send subscribe request to reporter task")?;
|
||||||
|
rx.await.map_err(Into::into)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
pub type Reporter = RunnerEventReporter;
|
||||||
|
pub type TestSpecificReporter = RunnerEventTestSpecificReporter;
|
||||||
|
pub type ExecutionSpecificReporter = RunnerEventExecutionSpecificReporter;
|
||||||
@@ -9,10 +9,16 @@ repository.workspace = true
|
|||||||
rust-version.workspace = true
|
rust-version.workspace = true
|
||||||
|
|
||||||
[dependencies]
|
[dependencies]
|
||||||
|
revive-dt-common = { workspace = true }
|
||||||
|
|
||||||
anyhow = { workspace = true }
|
anyhow = { workspace = true }
|
||||||
hex = { workspace = true }
|
hex = { workspace = true }
|
||||||
tracing = { workspace = true }
|
tracing = { workspace = true }
|
||||||
|
tokio = { workspace = true }
|
||||||
reqwest = { workspace = true }
|
reqwest = { workspace = true }
|
||||||
semver = { workspace = true }
|
semver = { workspace = true }
|
||||||
serde = { workspace = true }
|
serde = { workspace = true }
|
||||||
sha2 = { workspace = true }
|
sha2 = { workspace = true }
|
||||||
|
|
||||||
|
[lints]
|
||||||
|
workspace = true
|
||||||
|
|||||||
@@ -6,54 +6,79 @@ use std::{
|
|||||||
io::{BufWriter, Write},
|
io::{BufWriter, Write},
|
||||||
os::unix::fs::PermissionsExt,
|
os::unix::fs::PermissionsExt,
|
||||||
path::{Path, PathBuf},
|
path::{Path, PathBuf},
|
||||||
sync::{LazyLock, Mutex},
|
sync::LazyLock,
|
||||||
};
|
};
|
||||||
|
|
||||||
use crate::download::GHDownloader;
|
use semver::Version;
|
||||||
|
use tokio::sync::Mutex;
|
||||||
|
|
||||||
|
use crate::download::SolcDownloader;
|
||||||
|
use anyhow::Context;
|
||||||
|
|
||||||
pub const SOLC_CACHE_DIRECTORY: &str = "solc";
|
pub const SOLC_CACHE_DIRECTORY: &str = "solc";
|
||||||
pub(crate) static SOLC_CACHER: LazyLock<Mutex<HashSet<PathBuf>>> = LazyLock::new(Default::default);
|
pub(crate) static SOLC_CACHER: LazyLock<Mutex<HashSet<PathBuf>>> = LazyLock::new(Default::default);
|
||||||
|
|
||||||
pub(crate) fn get_or_download(
|
pub(crate) async fn get_or_download(
|
||||||
working_directory: &Path,
|
working_directory: &Path,
|
||||||
downloader: &GHDownloader,
|
downloader: &SolcDownloader,
|
||||||
) -> anyhow::Result<PathBuf> {
|
) -> anyhow::Result<(Version, PathBuf)> {
|
||||||
let target_directory = working_directory
|
let target_directory = working_directory
|
||||||
.join(SOLC_CACHE_DIRECTORY)
|
.join(SOLC_CACHE_DIRECTORY)
|
||||||
.join(downloader.version.to_string());
|
.join(downloader.version.to_string());
|
||||||
let target_file = target_directory.join(downloader.target);
|
let target_file = target_directory.join(downloader.target);
|
||||||
|
|
||||||
let mut cache = SOLC_CACHER.lock().unwrap();
|
let mut cache = SOLC_CACHER.lock().await;
|
||||||
if cache.contains(&target_file) {
|
if cache.contains(&target_file) {
|
||||||
tracing::debug!("using cached solc: {}", target_file.display());
|
tracing::debug!("using cached solc: {}", target_file.display());
|
||||||
return Ok(target_file);
|
return Ok((downloader.version.clone(), target_file));
|
||||||
}
|
}
|
||||||
|
|
||||||
create_dir_all(target_directory)?;
|
create_dir_all(&target_directory).with_context(|| {
|
||||||
download_to_file(&target_file, downloader)?;
|
format!(
|
||||||
|
"Failed to create solc cache directory: {}",
|
||||||
|
target_directory.display()
|
||||||
|
)
|
||||||
|
})?;
|
||||||
|
download_to_file(&target_file, downloader)
|
||||||
|
.await
|
||||||
|
.with_context(|| {
|
||||||
|
format!(
|
||||||
|
"Failed to write downloaded solc to {}",
|
||||||
|
target_file.display()
|
||||||
|
)
|
||||||
|
})?;
|
||||||
cache.insert(target_file.clone());
|
cache.insert(target_file.clone());
|
||||||
|
|
||||||
Ok(target_file)
|
Ok((downloader.version.clone(), target_file))
|
||||||
}
|
}
|
||||||
|
|
||||||
fn download_to_file(path: &Path, downloader: &GHDownloader) -> anyhow::Result<()> {
|
async fn download_to_file(path: &Path, downloader: &SolcDownloader) -> anyhow::Result<()> {
|
||||||
tracing::info!("caching file: {}", path.display());
|
|
||||||
|
|
||||||
let Ok(file) = File::create_new(path) else {
|
let Ok(file) = File::create_new(path) else {
|
||||||
tracing::debug!("cache file already exists: {}", path.display());
|
|
||||||
return Ok(());
|
return Ok(());
|
||||||
};
|
};
|
||||||
|
|
||||||
#[cfg(unix)]
|
#[cfg(unix)]
|
||||||
{
|
{
|
||||||
let mut permissions = file.metadata()?.permissions();
|
let mut permissions = file
|
||||||
|
.metadata()
|
||||||
|
.with_context(|| format!("Failed to read metadata for {}", path.display()))?
|
||||||
|
.permissions();
|
||||||
permissions.set_mode(permissions.mode() | 0o111);
|
permissions.set_mode(permissions.mode() | 0o111);
|
||||||
file.set_permissions(permissions)?;
|
file.set_permissions(permissions).with_context(|| {
|
||||||
|
format!("Failed to set executable permissions on {}", path.display())
|
||||||
|
})?;
|
||||||
}
|
}
|
||||||
|
|
||||||
let mut file = BufWriter::new(file);
|
let mut file = BufWriter::new(file);
|
||||||
file.write_all(&downloader.download()?)?;
|
file.write_all(
|
||||||
file.flush()?;
|
&downloader
|
||||||
|
.download()
|
||||||
|
.await
|
||||||
|
.context("Failed to download solc binary bytes")?,
|
||||||
|
)
|
||||||
|
.with_context(|| format!("Failed to write solc binary to {}", path.display()))?;
|
||||||
|
file.flush()
|
||||||
|
.with_context(|| format!("Failed to flush file {}", path.display()))?;
|
||||||
drop(file);
|
drop(file);
|
||||||
|
|
||||||
#[cfg(target_os = "macos")]
|
#[cfg(target_os = "macos")]
|
||||||
@@ -64,8 +89,20 @@ fn download_to_file(path: &Path, downloader: &GHDownloader) -> anyhow::Result<()
|
|||||||
.stderr(std::process::Stdio::null())
|
.stderr(std::process::Stdio::null())
|
||||||
.stdout(std::process::Stdio::null())
|
.stdout(std::process::Stdio::null())
|
||||||
.stdout(std::process::Stdio::null())
|
.stdout(std::process::Stdio::null())
|
||||||
.spawn()?
|
.spawn()
|
||||||
.wait()?;
|
.with_context(|| {
|
||||||
|
format!(
|
||||||
|
"Failed to spawn xattr to remove quarantine attribute on {}",
|
||||||
|
path.display()
|
||||||
|
)
|
||||||
|
})?
|
||||||
|
.wait()
|
||||||
|
.with_context(|| {
|
||||||
|
format!(
|
||||||
|
"Failed waiting for xattr operation to complete on {}",
|
||||||
|
path.display()
|
||||||
|
)
|
||||||
|
})?;
|
||||||
|
|
||||||
Ok(())
|
Ok(())
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,10 +5,13 @@ use std::{
|
|||||||
sync::{LazyLock, Mutex},
|
sync::{LazyLock, Mutex},
|
||||||
};
|
};
|
||||||
|
|
||||||
|
use revive_dt_common::types::VersionOrRequirement;
|
||||||
|
|
||||||
use semver::Version;
|
use semver::Version;
|
||||||
use sha2::{Digest, Sha256};
|
use sha2::{Digest, Sha256};
|
||||||
|
|
||||||
use crate::list::List;
|
use crate::list::List;
|
||||||
|
use anyhow::Context;
|
||||||
|
|
||||||
pub static LIST_CACHE: LazyLock<Mutex<HashMap<&'static str, List>>> =
|
pub static LIST_CACHE: LazyLock<Mutex<HashMap<&'static str, List>>> =
|
||||||
LazyLock::new(Default::default);
|
LazyLock::new(Default::default);
|
||||||
@@ -23,12 +26,17 @@ impl List {
|
|||||||
///
|
///
|
||||||
/// Caches the list retrieved from the `url` into [LIST_CACHE],
|
/// Caches the list retrieved from the `url` into [LIST_CACHE],
|
||||||
/// subsequent calls with the same `url` will return the cached list.
|
/// subsequent calls with the same `url` will return the cached list.
|
||||||
pub fn download(url: &'static str) -> anyhow::Result<Self> {
|
pub async fn download(url: &'static str) -> anyhow::Result<Self> {
|
||||||
if let Some(list) = LIST_CACHE.lock().unwrap().get(url) {
|
if let Some(list) = LIST_CACHE.lock().unwrap().get(url) {
|
||||||
return Ok(list.clone());
|
return Ok(list.clone());
|
||||||
}
|
}
|
||||||
|
|
||||||
let body: List = reqwest::blocking::get(url)?.json()?;
|
let body: List = reqwest::get(url)
|
||||||
|
.await
|
||||||
|
.with_context(|| format!("Failed to GET solc list from {url}"))?
|
||||||
|
.json()
|
||||||
|
.await
|
||||||
|
.with_context(|| format!("Failed to deserialize solc list JSON from {url}"))?;
|
||||||
|
|
||||||
LIST_CACHE.lock().unwrap().insert(url, body.clone());
|
LIST_CACHE.lock().unwrap().insert(url, body.clone());
|
||||||
|
|
||||||
@@ -36,65 +44,106 @@ impl List {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Download solc binaries from GitHub releases (IPFS links aren't reliable).
|
/// Download solc binaries from the official SolidityLang site
|
||||||
#[derive(Clone, Debug)]
|
#[derive(Clone, Debug)]
|
||||||
pub struct GHDownloader {
|
pub struct SolcDownloader {
|
||||||
pub version: Version,
|
pub version: Version,
|
||||||
pub target: &'static str,
|
pub target: &'static str,
|
||||||
pub list: &'static str,
|
pub list: &'static str,
|
||||||
}
|
}
|
||||||
|
|
||||||
impl GHDownloader {
|
impl SolcDownloader {
|
||||||
pub const BASE_URL: &str = "https://github.com/ethereum/solidity/releases/download";
|
pub const BASE_URL: &str = "https://binaries.soliditylang.org";
|
||||||
|
|
||||||
pub const LINUX_NAME: &str = "solc-static-linux";
|
pub const LINUX_NAME: &str = "linux-amd64";
|
||||||
pub const MACOSX_NAME: &str = "solc-macos";
|
pub const MACOSX_NAME: &str = "macosx-amd64";
|
||||||
pub const WINDOWS_NAME: &str = "solc-windows.exe";
|
pub const WINDOWS_NAME: &str = "windows-amd64";
|
||||||
pub const WASM_NAME: &str = "soljson.js";
|
pub const WASM_NAME: &str = "wasm";
|
||||||
|
|
||||||
fn new(version: Version, target: &'static str, list: &'static str) -> Self {
|
async fn new(
|
||||||
Self {
|
version: impl Into<VersionOrRequirement>,
|
||||||
version,
|
target: &'static str,
|
||||||
target,
|
list: &'static str,
|
||||||
list,
|
) -> anyhow::Result<Self> {
|
||||||
|
let version_or_requirement = version.into();
|
||||||
|
match version_or_requirement {
|
||||||
|
VersionOrRequirement::Version(version) => Ok(Self {
|
||||||
|
version,
|
||||||
|
target,
|
||||||
|
list,
|
||||||
|
}),
|
||||||
|
VersionOrRequirement::Requirement(requirement) => {
|
||||||
|
let Some(version) = List::download(list)
|
||||||
|
.await
|
||||||
|
.with_context(|| format!("Failed to download solc builds list from {list}"))?
|
||||||
|
.builds
|
||||||
|
.into_iter()
|
||||||
|
.map(|build| build.version)
|
||||||
|
.filter(|version| requirement.matches(version))
|
||||||
|
.max()
|
||||||
|
else {
|
||||||
|
anyhow::bail!("Failed to find a version that satisfies {requirement:?}");
|
||||||
|
};
|
||||||
|
Ok(Self {
|
||||||
|
version,
|
||||||
|
target,
|
||||||
|
list,
|
||||||
|
})
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn linux(version: Version) -> Self {
|
pub async fn linux(version: impl Into<VersionOrRequirement>) -> anyhow::Result<Self> {
|
||||||
Self::new(version, Self::LINUX_NAME, List::LINUX_URL)
|
Self::new(version, Self::LINUX_NAME, List::LINUX_URL).await
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn macosx(version: Version) -> Self {
|
pub async fn macosx(version: impl Into<VersionOrRequirement>) -> anyhow::Result<Self> {
|
||||||
Self::new(version, Self::MACOSX_NAME, List::MACOSX_URL)
|
Self::new(version, Self::MACOSX_NAME, List::MACOSX_URL).await
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn windows(version: Version) -> Self {
|
pub async fn windows(version: impl Into<VersionOrRequirement>) -> anyhow::Result<Self> {
|
||||||
Self::new(version, Self::WINDOWS_NAME, List::WINDOWS_URL)
|
Self::new(version, Self::WINDOWS_NAME, List::WINDOWS_URL).await
|
||||||
}
|
}
|
||||||
|
|
||||||
pub fn wasm(version: Version) -> Self {
|
pub async fn wasm(version: impl Into<VersionOrRequirement>) -> anyhow::Result<Self> {
|
||||||
Self::new(version, Self::WASM_NAME, List::WASM_URL)
|
Self::new(version, Self::WASM_NAME, List::WASM_URL).await
|
||||||
}
|
|
||||||
|
|
||||||
/// Returns the download link.
|
|
||||||
pub fn url(&self) -> String {
|
|
||||||
format!("{}/v{}/{}", Self::BASE_URL, &self.version, &self.target)
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/// Download the solc binary.
|
/// Download the solc binary.
|
||||||
///
|
///
|
||||||
/// Errors out if the download fails or the digest of the downloaded file
|
/// Errors out if the download fails or the digest of the downloaded file
|
||||||
/// mismatches the expected digest from the release [List].
|
/// mismatches the expected digest from the release [List].
|
||||||
pub fn download(&self) -> anyhow::Result<Vec<u8>> {
|
pub async fn download(&self) -> anyhow::Result<Vec<u8>> {
|
||||||
tracing::info!("downloading solc: {self:?}");
|
let builds = List::download(self.list)
|
||||||
let expected_digest = List::download(self.list)?
|
.await
|
||||||
.builds
|
.with_context(|| format!("Failed to download solc builds list from {}", self.list))?
|
||||||
|
.builds;
|
||||||
|
let build = builds
|
||||||
.iter()
|
.iter()
|
||||||
.find(|build| build.version == self.version)
|
.find(|build| build.version == self.version)
|
||||||
.ok_or_else(|| anyhow::anyhow!("solc v{} not found builds", self.version))
|
.ok_or_else(|| anyhow::anyhow!("solc v{} not found builds", self.version))
|
||||||
.map(|b| b.sha256.strip_prefix("0x").unwrap_or(&b.sha256).to_string())?;
|
.with_context(|| {
|
||||||
|
format!(
|
||||||
|
"Requested solc version {} was not found in builds list fetched from {}",
|
||||||
|
self.version, self.list
|
||||||
|
)
|
||||||
|
})?;
|
||||||
|
|
||||||
let file = reqwest::blocking::get(self.url())?.bytes()?.to_vec();
|
let path = build.path.clone();
|
||||||
|
let expected_digest = build
|
||||||
|
.sha256
|
||||||
|
.strip_prefix("0x")
|
||||||
|
.unwrap_or(&build.sha256)
|
||||||
|
.to_string();
|
||||||
|
let url = format!("{}/{}/{}", Self::BASE_URL, self.target, path.display());
|
||||||
|
|
||||||
|
let file = reqwest::get(&url)
|
||||||
|
.await
|
||||||
|
.with_context(|| format!("Failed to GET solc binary from {url}"))?
|
||||||
|
.bytes()
|
||||||
|
.await
|
||||||
|
.with_context(|| format!("Failed to read solc binary bytes from {url}"))?
|
||||||
|
.to_vec();
|
||||||
|
|
||||||
if hex::encode(Sha256::digest(&file)) != expected_digest {
|
if hex::encode(Sha256::digest(&file)) != expected_digest {
|
||||||
anyhow::bail!("sha256 mismatch for solc version {}", self.version);
|
anyhow::bail!("sha256 mismatch for solc version {}", self.version);
|
||||||
@@ -106,29 +155,58 @@ impl GHDownloader {
|
|||||||
|
|
||||||
#[cfg(test)]
|
#[cfg(test)]
|
||||||
mod tests {
|
mod tests {
|
||||||
use crate::{download::GHDownloader, list::List};
|
use crate::{download::SolcDownloader, list::List};
|
||||||
|
|
||||||
#[test]
|
#[tokio::test]
|
||||||
fn try_get_windows() {
|
async fn try_get_windows() {
|
||||||
let version = List::download(List::WINDOWS_URL).unwrap().latest_release;
|
let version = List::download(List::WINDOWS_URL)
|
||||||
GHDownloader::windows(version).download().unwrap();
|
.await
|
||||||
|
.unwrap()
|
||||||
|
.latest_release;
|
||||||
|
SolcDownloader::windows(version)
|
||||||
|
.await
|
||||||
|
.unwrap()
|
||||||
|
.download()
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[tokio::test]
|
||||||
fn try_get_macosx() {
|
async fn try_get_macosx() {
|
||||||
let version = List::download(List::MACOSX_URL).unwrap().latest_release;
|
let version = List::download(List::MACOSX_URL)
|
||||||
GHDownloader::macosx(version).download().unwrap();
|
.await
|
||||||
|
.unwrap()
|
||||||
|
.latest_release;
|
||||||
|
SolcDownloader::macosx(version)
|
||||||
|
.await
|
||||||
|
.unwrap()
|
||||||
|
.download()
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[tokio::test]
|
||||||
fn try_get_linux() {
|
async fn try_get_linux() {
|
||||||
let version = List::download(List::LINUX_URL).unwrap().latest_release;
|
let version = List::download(List::LINUX_URL)
|
||||||
GHDownloader::linux(version).download().unwrap();
|
.await
|
||||||
|
.unwrap()
|
||||||
|
.latest_release;
|
||||||
|
SolcDownloader::linux(version)
|
||||||
|
.await
|
||||||
|
.unwrap()
|
||||||
|
.download()
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
}
|
}
|
||||||
|
|
||||||
#[test]
|
#[tokio::test]
|
||||||
fn try_get_wasm() {
|
async fn try_get_wasm() {
|
||||||
let version = List::download(List::WASM_URL).unwrap().latest_release;
|
let version = List::download(List::WASM_URL).await.unwrap().latest_release;
|
||||||
GHDownloader::wasm(version).download().unwrap();
|
SolcDownloader::wasm(version)
|
||||||
|
.await
|
||||||
|
.unwrap()
|
||||||
|
.download()
|
||||||
|
.await
|
||||||
|
.unwrap();
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -5,8 +5,11 @@
|
|||||||
|
|
||||||
use std::path::{Path, PathBuf};
|
use std::path::{Path, PathBuf};
|
||||||
|
|
||||||
|
use anyhow::Context;
|
||||||
use cache::get_or_download;
|
use cache::get_or_download;
|
||||||
use download::GHDownloader;
|
use download::SolcDownloader;
|
||||||
|
|
||||||
|
use revive_dt_common::types::VersionOrRequirement;
|
||||||
use semver::Version;
|
use semver::Version;
|
||||||
|
|
||||||
pub mod cache;
|
pub mod cache;
|
||||||
@@ -18,22 +21,23 @@ pub mod list;
|
|||||||
///
|
///
|
||||||
/// Subsequent calls for the same version will use a cached artifact
|
/// Subsequent calls for the same version will use a cached artifact
|
||||||
/// and not download it again.
|
/// and not download it again.
|
||||||
pub fn download_solc(
|
pub async fn download_solc(
|
||||||
cache_directory: &Path,
|
cache_directory: &Path,
|
||||||
version: Version,
|
version: impl Into<VersionOrRequirement>,
|
||||||
wasm: bool,
|
wasm: bool,
|
||||||
) -> anyhow::Result<PathBuf> {
|
) -> anyhow::Result<(Version, PathBuf)> {
|
||||||
let downloader = if wasm {
|
let downloader = if wasm {
|
||||||
GHDownloader::wasm(version)
|
SolcDownloader::wasm(version).await
|
||||||
} else if cfg!(target_os = "linux") {
|
} else if cfg!(target_os = "linux") {
|
||||||
GHDownloader::linux(version)
|
SolcDownloader::linux(version).await
|
||||||
} else if cfg!(target_os = "macos") {
|
} else if cfg!(target_os = "macos") {
|
||||||
GHDownloader::macosx(version)
|
SolcDownloader::macosx(version).await
|
||||||
} else if cfg!(target_os = "windows") {
|
} else if cfg!(target_os = "windows") {
|
||||||
GHDownloader::windows(version)
|
SolcDownloader::windows(version).await
|
||||||
} else {
|
} else {
|
||||||
unimplemented!()
|
unimplemented!()
|
||||||
};
|
}
|
||||||
|
.context("Failed to initialize the Solc Downloader")?;
|
||||||
|
|
||||||
get_or_download(cache_directory, &downloader)
|
get_or_download(cache_directory, &downloader).await
|
||||||
}
|
}
|
||||||
|
|||||||
Executable
+102
@@ -0,0 +1,102 @@
|
|||||||
|
#!/bin/bash
|
||||||
|
|
||||||
|
# Revive Differential Tests - Quick Start Script
|
||||||
|
# This script clones the test repository, sets up the corpus file, and runs the tool
|
||||||
|
|
||||||
|
set -e # Exit on any error
|
||||||
|
|
||||||
|
# Colors for output
|
||||||
|
RED='\033[0;31m'
|
||||||
|
GREEN='\033[0;32m'
|
||||||
|
YELLOW='\033[1;33m'
|
||||||
|
NC='\033[0m' # No Color
|
||||||
|
|
||||||
|
# Configuration
|
||||||
|
TEST_REPO_URL="https://github.com/paritytech/resolc-compiler-tests"
|
||||||
|
TEST_REPO_DIR="resolc-compiler-tests"
|
||||||
|
CORPUS_FILE="./corpus.json"
|
||||||
|
WORKDIR="workdir"
|
||||||
|
|
||||||
|
# Optional positional argument: path to polkadot-sdk directory
|
||||||
|
POLKADOT_SDK_DIR="${1:-}"
|
||||||
|
|
||||||
|
# Binary paths (default to names in $PATH)
|
||||||
|
REVIVE_DEV_NODE_BIN="revive-dev-node"
|
||||||
|
ETH_RPC_BIN="eth-rpc"
|
||||||
|
SUBSTRATE_NODE_BIN="substrate-node"
|
||||||
|
|
||||||
|
echo -e "${GREEN}=== Revive Differential Tests Quick Start ===${NC}"
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Check if test repo already exists
|
||||||
|
if [ -d "$TEST_REPO_DIR" ]; then
|
||||||
|
echo -e "${YELLOW}Test repository already exists. Pulling latest changes...${NC}"
|
||||||
|
cd "$TEST_REPO_DIR"
|
||||||
|
git pull
|
||||||
|
cd ..
|
||||||
|
else
|
||||||
|
echo -e "${GREEN}Cloning test repository...${NC}"
|
||||||
|
git clone "$TEST_REPO_URL"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# If polkadot-sdk path is provided, verify and use binaries from there; build if needed
|
||||||
|
if [ -n "$POLKADOT_SDK_DIR" ]; then
|
||||||
|
if [ ! -d "$POLKADOT_SDK_DIR" ]; then
|
||||||
|
echo -e "${RED}Provided polkadot-sdk directory does not exist: $POLKADOT_SDK_DIR${NC}"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
POLKADOT_SDK_DIR=$(realpath "$POLKADOT_SDK_DIR")
|
||||||
|
echo -e "${GREEN}Using polkadot-sdk at: $POLKADOT_SDK_DIR${NC}"
|
||||||
|
|
||||||
|
REVIVE_DEV_NODE_BIN="$POLKADOT_SDK_DIR/target/release/revive-dev-node"
|
||||||
|
ETH_RPC_BIN="$POLKADOT_SDK_DIR/target/release/eth-rpc"
|
||||||
|
SUBSTRATE_NODE_BIN="$POLKADOT_SDK_DIR/target/release/substrate-node"
|
||||||
|
|
||||||
|
if [ ! -x "$REVIVE_DEV_NODE_BIN" ] || [ ! -x "$ETH_RPC_BIN" ] || [ ! -x "$SUBSTRATE_NODE_BIN" ]; then
|
||||||
|
echo -e "${YELLOW}Required binaries not found in release target. Building...${NC}"
|
||||||
|
(cd "$POLKADOT_SDK_DIR" && cargo build --release --package staging-node-cli --package pallet-revive-eth-rpc --package revive-dev-node)
|
||||||
|
fi
|
||||||
|
|
||||||
|
for bin in "$REVIVE_DEV_NODE_BIN" "$ETH_RPC_BIN" "$SUBSTRATE_NODE_BIN"; do
|
||||||
|
if [ ! -x "$bin" ]; then
|
||||||
|
echo -e "${RED}Expected binary not found after build: $bin${NC}"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
done
|
||||||
|
else
|
||||||
|
echo -e "${YELLOW}No polkadot-sdk path provided. Using binaries from $PATH.${NC}"
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Create corpus file with absolute path resolved at runtime
|
||||||
|
echo -e "${GREEN}Creating corpus file...${NC}"
|
||||||
|
ABSOLUTE_PATH=$(realpath "$TEST_REPO_DIR/fixtures/solidity/")
|
||||||
|
|
||||||
|
cat > "$CORPUS_FILE" << EOF
|
||||||
|
{
|
||||||
|
"name": "MatterLabs Solidity Simple, Complex, and Semantic Tests",
|
||||||
|
"path": "$ABSOLUTE_PATH"
|
||||||
|
}
|
||||||
|
EOF
|
||||||
|
|
||||||
|
echo -e "${GREEN}Corpus file created: $CORPUS_FILE${NC}"
|
||||||
|
|
||||||
|
# Create workdir if it doesn't exist
|
||||||
|
mkdir -p "$WORKDIR"
|
||||||
|
|
||||||
|
echo -e "${GREEN}Starting differential tests...${NC}"
|
||||||
|
echo "This may take a while..."
|
||||||
|
echo ""
|
||||||
|
|
||||||
|
# Run the tool
|
||||||
|
RUST_LOG="error" cargo run --release -- \
|
||||||
|
--corpus "$CORPUS_FILE" \
|
||||||
|
--workdir "$WORKDIR" \
|
||||||
|
--number-of-nodes 5 \
|
||||||
|
--kitchensink "$SUBSTRATE_NODE_BIN" \
|
||||||
|
--revive-dev-node "$REVIVE_DEV_NODE_BIN" \
|
||||||
|
--eth_proxy "$ETH_RPC_BIN" \
|
||||||
|
> logs.log \
|
||||||
|
2> output.log
|
||||||
|
|
||||||
|
echo -e "${GREEN}=== Test run completed! ===${NC}"
|
||||||
Reference in New Issue
Block a user