Skip to content
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

BitMath tests #607

Merged
merged 4 commits into from
Apr 26, 2024
Merged

BitMath tests #607

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
48b8ce3
naming conventions
dianakocsis Apr 23, 2024
7a3c236
Merge branch 'main' into bitmath-test
dianakocsis Apr 24, 2024
f74b708
use relative path
dianakocsis Apr 24, 2024
76b6b95
add invariant test and remove echidna test
dianakocsis Apr 25, 2024
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
22 changes: 0 additions & 22 deletions src/test/BitMathEchidnaTest.sol
View file
Open in desktop

This file was deleted.

44 changes: 29 additions & 15 deletions test/libraries/BitMath.t.sol
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,39 +3,46 @@ pragma solidity ^0.8.20;

import {GasSnapshot} from "forge-gas-snapshot/GasSnapshot.sol";
import {Test} from "forge-std/Test.sol";
import {BitMath} from "src/libraries/BitMath.sol";
import {BitMath} from "../../src/libraries/BitMath.sol";

contract TestBitMath is Test, GasSnapshot {
function testMostSignificantBitZero() public {
function test_mostSignificantBit_revertsWhenZero() public {
vm.expectRevert();
BitMath.mostSignificantBit(0);
}

function testMostSignificantBitOne() public {
function test_mostSignificantBit_one() public {
assertEq(BitMath.mostSignificantBit(1), 0);
}

function testMostSignificantBitTwo() public {
function test_mostSignificantBit_two() public {
assertEq(BitMath.mostSignificantBit(2), 1);
}

function testMostSignificantBitPowersOfTwo() public {
function test_mostSignificantBit_powersOfTwo() public {
for (uint256 i = 0; i < 255; i++) {
uint256 x = 1 << i;
assertEq(BitMath.mostSignificantBit(x), i);
}
}

function testMostSignificantBitMaxUint256() public {
function test_mostSignificantBit_maxUint256() public {
assertEq(BitMath.mostSignificantBit(type(uint256).max), 255);
}

function testMostSignificantBit(uint256 x) public {
function test_fuzz_mostSignificantBit(uint256 x) public {
vm.assume(x != 0);
assertEq(BitMath.mostSignificantBit(x), mostSignificantBitReference(x));
}

function testMsbGas() public {
function test_invariant_mostSignificantBit(uint256 x) public {
vm.assume(x != 0);
uint8 msb = BitMath.mostSignificantBit(x);
assertGe(x, uint256(2) ** msb);
assertTrue(msb == 255 || x < uint256(2) ** (msb + 1));
}

function test_mostSignificantBit_gas() public {
snapStart("BitMathMostSignificantBitSmallNumber");
BitMath.mostSignificantBit(3568);
snapEnd();
Expand All @@ -49,36 +56,43 @@ contract TestBitMath is Test, GasSnapshot {
snapEnd();
}

function testLeastSignificantBitZero() public {
function test_leastSignificantBit_revertsWhenZero() public {
vm.expectRevert();
BitMath.leastSignificantBit(0);
}

function testLeastSignificantBitOne() public {
function test_leastSignificantBit_one() public {
assertEq(BitMath.leastSignificantBit(1), 0);
}

function testLeastSignificantBitTwo() public {
function test_leastSignificantBit_two() public {
assertEq(BitMath.leastSignificantBit(2), 1);
}

function testLeastSignificantBitPowersOfTwo() public {
function test_leastSignificantBit_powersOfTwo() public {
for (uint256 i = 0; i < 255; i++) {
uint256 x = 1 << i;
assertEq(BitMath.leastSignificantBit(x), i);
}
}

function testLeastSignificantBitMaxUint256() public {
function test_leastSignificantBit_maxUint256() public {
assertEq(BitMath.leastSignificantBit(type(uint256).max), 0);
}

function testLeastSignificantBit(uint256 x) public {
function test_fuzz_leastSignificantBit(uint256 x) public {
vm.assume(x != 0);
assertEq(BitMath.leastSignificantBit(x), leastSignificantBitReference(x));
}

function testLsbGas() public {
function test_invariant_leastSignificantBit(uint256 x) public {
vm.assume(x != 0);
uint8 lsb = BitMath.leastSignificantBit(x);
assertNotEq(x & (uint256(2) ** lsb), 0);
assertEq(x & (uint256(2) ** lsb - 1), 0);
}

function test_leastSignificantBit_gas() public {
snapStart("BitMathLeastSignificantBitSmallNumber");
BitMath.leastSignificantBit(3568);
snapEnd();
Expand Down
Loading