Skip to content

chore: update CounterTemplate.t.sol to adhere to best practices #5619

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

Merged
merged 4 commits into from
Aug 13, 2023
Merged

chore: update CounterTemplate.t.sol to adhere to best practices #5619

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
0fde610
chore: update test template to adhere to best practices
Sabnock01 Aug 13, 2023
9cb35f5
fix: update fixtures
Sabnock01 Aug 13, 2023
80d5091
fix: update fixture gas
Evalir Aug 13, 2023
73e58ea
reorder
Evalir Aug 13, 2023
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
4 changes: 2 additions & 2 deletions crates/cli/assets/CounterTemplate.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ contract CounterTest is Test {
counter.setNumber(0);
}

function testIncrement() public {
function test_Increment() public {
counter.increment();
assertEq(counter.number(), 1);
}

function testSetNumber(uint256 x) public {
function testFuzz_SetNumber(uint256 x) public {
counter.setNumber(x);
assertEq(counter.number(), x);
}
Expand Down
4 changes: 2 additions & 2 deletions crates/cli/tests/fixtures/can_test_repeatedly.stdout
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
No files changed, compilation skipped

Running 2 tests for test/Counter.t.sol:CounterTest
[PASS] testIncrement() (gas: 28334)
[PASS] testSetNumber(uint256) (runs: 256, μ: 26521, ~: 28387)
[PASS] testFuzz_SetNumber(uint256) (runs: 256, μ: 26521, ~: 28387)
[PASS] test_Increment() (gas: 28357)
Test result: ok. 2 passed; 0 failed; 0 skipped; finished in 9.42ms
Ran 1 test suites: 2 tests passed, 0 failed, 0 skipped (2 total tests)
2 changes: 1 addition & 1 deletion crates/config/src/inline/natspec.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ impl NatSpec {

/// Returns a string describing the natspec
/// context, for debugging purposes 🐞
/// i.e. `test/Counter.t.sol:CounterTest:testSetNumber`
/// i.e. `test/Counter.t.sol:CounterTest:testFuzz_SetNumber`
pub fn debug_context(&self) -> String {
format!("{}:{}", self.contract, self.function)
}
Expand Down