Skip to content

test(mbt): Add Model Based Test for Emerald #201

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
erickpintor wants to merge 2 commits into
base: main
Choose a base branch
from
Open

test(mbt): Add Model Based Test for Emerald #201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
805fcc9
test(mbt): Add Model Based Test for Emerald
erickpintor Jan 21, 2026
2f24a10
Merge branch 'main' into erick/introduce-mbt-suite
rnbguy Feb 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 57 additions & 3 deletions .github/workflows/test.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ on:

permissions:
contents: read
packages: read

# If new code is pushed to a PR branch, then cancel in progress workflows for that PR.
# Ensures that we don't waste CI time, and returns results quicker.
Expand All @@ -20,7 +21,7 @@ env:
CARGO_TERM_COLOR: always
CARGO_PROFILE_DEV_DEBUG: 1
CARGO_PROFILE_RELEASE_DEBUG: 1
RUST_BACKTRACE: short
RUST_BACKTRACE: full
CARGO_NET_RETRY: 10
RUSTUP_MAX_RETRIES: 10

Expand Down Expand Up @@ -57,11 +58,64 @@ jobs:
- name: Run Forge build
run: forge build
if: steps.filter.outputs.code == 'true'
- name: Run tests
- name: Run unit tests
run: |
cargo nextest run \
--workspace \
--all-features \
--no-fail-fast \
--failure-output final
--failure-output final \
--filterset 'not package(emerald-mbt)'
if: steps.filter.outputs.code == 'true'

mbt:
name: MBT Suite
runs-on: ubuntu-latest
# XXX: Do not block on MBT initially until we gain confidence CI is not
# flaky for any reason.
continue-on-error: true
Copy link
Member

@rnbguy rnbguy Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you also add a timeout here ?

steps:
- name: Checkout
uses: actions/checkout@v5
with:
submodules: recursive
- id: filter
uses: dorny/paths-filter@v3
with:
filters: |
code:
- '**/*.rs'
- '**/*.qnt'
- 'Makefile'
- '**/Cargo.toml'
- '**/Cargo.lock'
- '**/*.sh'
- '*/workflows/test.yml'
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: '22'
- name: Install Quint
run: npm install -g @informalsystems/quint
Comment on lines +94 to +99
Copy link
Member

@rnbguy rnbguy Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we use bun rather ?

- name: Login to GitHub Container Registry
uses: docker/login-action@v3
with:
registry: ghcr.io
username: ${{ github.actor }}
password: ${{ secrets.GITHUB_TOKEN }}
- name: Install Protoc
uses: arduino/setup-protoc@v3
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}
- name: Setup Rust toolchain
uses: actions-rust-lang/setup-rust-toolchain@v1
with:
toolchain: nightly
- name: Install Foundry
uses: foundry-rs/foundry-toolchain@v1
- name: Run Forge build
run: forge build
if: steps.filter.outputs.code == 'true'
Comment on lines +116 to +118
Copy link
Member

@rnbguy rnbguy Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make mbt-test is already calling forge build.

- name: Run MBT suite
run: make mbt-test
if: steps.filter.outputs.code == 'true'
131 changes: 131 additions & 0 deletions Cargo.lock
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ members = [
"engine",
"utils",
"types",
"tests/mbt",
Copy link
Member

@rnbguy rnbguy Feb 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you use default-members to have all the old crates and not include tests/mbt ?

]

[workspace.package]
Expand Down
16 changes: 14 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
.PHONY: all build release test docs docs-serve testnet-config testnet-reth-recreate testnet-reth-restart testnet-start sync testnet-node-stop testnet-node-restart testnet-stop testnet-clean clean-volumes clean-prometheus spam spam-contract
.PHONY: all build release test docs docs-serve testnet-config testnet-reth-recreate testnet-reth-restart testnet-start sync testnet-node-stop testnet-node-restart testnet-stop testnet-clean clean-volumes clean-prometheus spam spam-contract mbt-test mbt-clean

all: build

Expand All @@ -12,7 +12,7 @@ release:
cargo build --release

test:
cargo test
cargo test --workspace --exclude emerald-mbt
forge test -vvv

# Docs
Expand Down Expand Up @@ -107,3 +107,15 @@ spam-contract:
--time=60 \
--rate=1000 \
--rpc-url=127.0.0.1:8645

# Model-Based Testing (MBT)

TEST ?=

mbt-test: RETH_NODES=reth0 reth1 reth2
mbt-test: testnet-config
@echo "Running MBT tests..."
@echo "Note: RETH will be automatically started and stopped for each test"
cargo test --package emerald-mbt -- --nocapture --test-threads=1 $(TEST)

mbt-clean: testnet-clean
25 changes: 25 additions & 0 deletions tests/mbt/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
[package]
name = "emerald-mbt"
version = { workspace = true }
edition = { workspace = true }
publish = false

[lints]
workspace = true

[dependencies]
emerald = { workspace = true }
malachitebft-eth-types = { workspace = true }
malachitebft-eth-engine = { workspace = true }
malachitebft-eth-cli = { workspace = true }
malachitebft-app-channel = { workspace = true }
malachitebft-core-consensus = { workspace = true }

serde = { workspace = true }
itf = { workspace = true }
tokio = { workspace = true }

quint-connect = "0.1"
anyhow = "1.0"
bimap = "0.6.3"
tempfile = "3.23.0"
Loading
Loading