@godzillaba/mutest 1.0.0

package/lib/forge-std/test/StdError.t.sol

@@ -0,0 +1,119 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.13 <0.9.0;
+
+import {stdError} from "../src/StdError.sol";
+import {Test} from "../src/Test.sol";
+
+contract StdErrorsTest is Test {
+    ErrorsTest test;
+
+    function setUp() public {
+        test = new ErrorsTest();
+    }
+
+    function test_RevertIf_AssertionError() public {
+        vm.expectRevert(stdError.assertionError);
+        test.assertionError();
+    }
+
+    function test_RevertIf_ArithmeticError() public {
+        vm.expectRevert(stdError.arithmeticError);
+        test.arithmeticError(10);
+    }
+
+    function test_RevertIf_DivisionError() public {
+        vm.expectRevert(stdError.divisionError);
+        test.divError(0);
+    }
+
+    function test_RevertIf_ModError() public {
+        vm.expectRevert(stdError.divisionError);
+        test.modError(0);
+    }
+
+    function test_RevertIf_EnumConversionError() public {
+        vm.expectRevert(stdError.enumConversionError);
+        test.enumConversion(1);
+    }
+
+    function test_RevertIf_EncodeStgError() public {
+        vm.expectRevert(stdError.encodeStorageError);
+        test.encodeStgError();
+    }
+
+    function test_RevertIf_PopError() public {
+        vm.expectRevert(stdError.popError);
+        test.pop();
+    }
+
+    function test_RevertIf_IndexOOBError() public {
+        vm.expectRevert(stdError.indexOOBError);
+        test.indexOOBError(1);
+    }
+
+    function test_RevertIf_MemOverflowError() public {
+        vm.expectRevert(stdError.memOverflowError);
+        test.mem();
+    }
+
+    function test_RevertIf_InternError() public {
+        vm.expectRevert(stdError.zeroVarError);
+        test.intern();
+    }
+}
+
+contract ErrorsTest {
+    enum T {
+        T1
+    }
+
+    uint256[] public someArr;
+    bytes someBytes;
+
+    function assertionError() public pure {
+        assert(false);
+    }
+
+    function arithmeticError(uint256 a) public pure {
+        a -= 100;
+    }
+
+    function divError(uint256 a) public pure {
+        100 / a;
+    }
+
+    function modError(uint256 a) public pure {
+        100 % a;
+    }
+
+    function enumConversion(uint256 a) public pure {
+        T(a);
+    }
+
+    function encodeStgError() public {
+        assembly ("memory-safe") {
+            sstore(someBytes.slot, 1)
+        }
+        keccak256(someBytes);
+    }
+
+    function pop() public {
+        someArr.pop();
+    }
+
+    function indexOOBError(uint256 a) public pure {
+        uint256[] memory t = new uint256[](0);
+        t[a];
+    }
+
+    function mem() public pure {
+        uint256 l = 2 ** 256 / 32;
+        new uint256[](l);
+    }
+
+    function intern() public returns (uint256) {
+        function(uint256) internal returns (uint256) x;
+        x(2);
+        return 7;
+    }
+}

package/lib/forge-std/test/StdJson.t.sol

@@ -0,0 +1,49 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.13 <0.9.0;
+
+import {Test, stdJson} from "../src/Test.sol";
+
+contract StdJsonTest is Test {
+    using stdJson for string;
+
+    string root;
+    string path;
+
+    function setUp() public {
+        root = vm.projectRoot();
+        path = string.concat(root, "/test/fixtures/test.json");
+    }
+
+    struct SimpleJson {
+        uint256 a;
+        string b;
+    }
+
+    struct NestedJson {
+        uint256 a;
+        string b;
+        SimpleJson c;
+    }
+
+    function test_readJson() public view {
+        string memory json = vm.readFile(path);
+        assertEq(json.readUint(".a"), 123);
+    }
+
+    function test_writeJson() public {
+        string memory json = "json";
+        json.serialize("a", uint256(123));
+        string memory semiFinal = json.serialize("b", string("test"));
+        string memory finalJson = json.serialize("c", semiFinal);
+        finalJson.write(path);
+
+        string memory json_ = vm.readFile(path);
+        bytes memory data = json_.parseRaw("$");
+        NestedJson memory decodedData = abi.decode(data, (NestedJson));
+
+        assertEq(decodedData.a, 123);
+        assertEq(decodedData.b, "test");
+        assertEq(decodedData.c.a, 123);
+        assertEq(decodedData.c.b, "test");
+    }
+}

package/lib/forge-std/test/StdMath.t.sol

@@ -0,0 +1,202 @@
+// SPDX-License-Identifier: MIT OR Apache-2.0
+pragma solidity >=0.8.13 <0.9.0;
+
+import {stdMath} from "../src/StdMath.sol";
+import {Test, stdError} from "../src/Test.sol";
+
+contract StdMathMock is Test {
+    function exposedPercentDelta(uint256 a, uint256 b) public pure returns (uint256) {
+        return stdMath.percentDelta(a, b);
+    }
+
+    function exposedPercentDelta(int256 a, int256 b) public pure returns (uint256) {
+        return stdMath.percentDelta(a, b);
+    }
+}
+
+contract StdMathTest is Test {
+    function test_GetAbs() external pure {
+        assertEq(stdMath.abs(-50), 50);
+        assertEq(stdMath.abs(50), 50);
+        assertEq(stdMath.abs(-1337), 1337);
+        assertEq(stdMath.abs(0), 0);
+
+        assertEq(stdMath.abs(type(int256).min), (type(uint256).max >> 1) + 1);
+        assertEq(stdMath.abs(type(int256).max), (type(uint256).max >> 1));
+    }
+
+    function testFuzz_GetAbs(int256 a) external pure {
+        uint256 manualAbs = getAbs(a);
+
+        uint256 abs = stdMath.abs(a);
+
+        assertEq(abs, manualAbs);
+    }
+
+    function test_GetDelta_Uint() external pure {
+        assertEq(stdMath.delta(uint256(0), uint256(0)), 0);
+        assertEq(stdMath.delta(uint256(0), uint256(1337)), 1337);
+        assertEq(stdMath.delta(uint256(0), type(uint64).max), type(uint64).max);
+        assertEq(stdMath.delta(uint256(0), type(uint128).max), type(uint128).max);
+        assertEq(stdMath.delta(uint256(0), type(uint256).max), type(uint256).max);
+
+        assertEq(stdMath.delta(0, uint256(0)), 0);
+        assertEq(stdMath.delta(1337, uint256(0)), 1337);
+        assertEq(stdMath.delta(type(uint64).max, uint256(0)), type(uint64).max);
+        assertEq(stdMath.delta(type(uint128).max, uint256(0)), type(uint128).max);
+        assertEq(stdMath.delta(type(uint256).max, uint256(0)), type(uint256).max);
+
+        assertEq(stdMath.delta(1337, uint256(1337)), 0);
+        assertEq(stdMath.delta(type(uint256).max, type(uint256).max), 0);
+        assertEq(stdMath.delta(5000, uint256(1250)), 3750);
+    }
+
+    function testFuzz_GetDelta_Uint(uint256 a, uint256 b) external pure {
+        uint256 manualDelta = a > b ? a - b : b - a;
+
+        uint256 delta = stdMath.delta(a, b);
+
+        assertEq(delta, manualDelta);
+    }
+
+    function test_GetDelta_Int() external pure {
+        assertEq(stdMath.delta(int256(0), int256(0)), 0);
+        assertEq(stdMath.delta(int256(0), int256(1337)), 1337);
+        assertEq(stdMath.delta(int256(0), type(int64).max), type(uint64).max >> 1);
+        assertEq(stdMath.delta(int256(0), type(int128).max), type(uint128).max >> 1);
+        assertEq(stdMath.delta(int256(0), type(int256).max), type(uint256).max >> 1);
+
+        assertEq(stdMath.delta(0, int256(0)), 0);
+        assertEq(stdMath.delta(1337, int256(0)), 1337);
+        assertEq(stdMath.delta(type(int64).max, int256(0)), type(uint64).max >> 1);
+        assertEq(stdMath.delta(type(int128).max, int256(0)), type(uint128).max >> 1);
+        assertEq(stdMath.delta(type(int256).max, int256(0)), type(uint256).max >> 1);
+
+        assertEq(stdMath.delta(-0, int256(0)), 0);
+        assertEq(stdMath.delta(-1337, int256(0)), 1337);
+        assertEq(stdMath.delta(type(int64).min, int256(0)), (type(uint64).max >> 1) + 1);
+        assertEq(stdMath.delta(type(int128).min, int256(0)), (type(uint128).max >> 1) + 1);
+        assertEq(stdMath.delta(type(int256).min, int256(0)), (type(uint256).max >> 1) + 1);
+
+        assertEq(stdMath.delta(int256(0), -0), 0);
+        assertEq(stdMath.delta(int256(0), -1337), 1337);
+        assertEq(stdMath.delta(int256(0), type(int64).min), (type(uint64).max >> 1) + 1);
+        assertEq(stdMath.delta(int256(0), type(int128).min), (type(uint128).max >> 1) + 1);
+        assertEq(stdMath.delta(int256(0), type(int256).min), (type(uint256).max >> 1) + 1);
+
+        assertEq(stdMath.delta(1337, int256(1337)), 0);
+        assertEq(stdMath.delta(type(int256).max, type(int256).max), 0);
+        assertEq(stdMath.delta(type(int256).min, type(int256).min), 0);
+        assertEq(stdMath.delta(type(int256).min, type(int256).max), type(uint256).max);
+        assertEq(stdMath.delta(5000, int256(1250)), 3750);
+    }
+
+    function testFuzz_GetDelta_Int(int256 a, int256 b) external pure {
+        uint256 absA = getAbs(a);
+        uint256 absB = getAbs(b);
+        uint256 absDelta = absA > absB ? absA - absB : absB - absA;
+
+        uint256 manualDelta;
+        if ((a >= 0 && b >= 0) || (a < 0 && b < 0)) {
+            manualDelta = absDelta;
+        }
+        // (a < 0 && b >= 0) || (a >= 0 && b < 0)
+        else {
+            manualDelta = absA + absB;
+        }
+
+        uint256 delta = stdMath.delta(a, b);
+
+        assertEq(delta, manualDelta);
+    }
+
+    function test_GetPercentDelta_Uint() external {
+        StdMathMock stdMathMock = new StdMathMock();
+
+        assertEq(stdMath.percentDelta(uint256(0), uint256(1337)), 1e18);
+        assertEq(stdMath.percentDelta(uint256(0), type(uint64).max), 1e18);
+        assertEq(stdMath.percentDelta(uint256(0), type(uint128).max), 1e18);
+        assertEq(stdMath.percentDelta(uint256(0), type(uint192).max), 1e18);
+
+        assertEq(stdMath.percentDelta(1337, uint256(1337)), 0);
+        assertEq(stdMath.percentDelta(type(uint192).max, type(uint192).max), 0);
+        assertEq(stdMath.percentDelta(0, uint256(2500)), 1e18);
+        assertEq(stdMath.percentDelta(2500, uint256(2500)), 0);
+        assertEq(stdMath.percentDelta(5000, uint256(2500)), 1e18);
+        assertEq(stdMath.percentDelta(7500, uint256(2500)), 2e18);
+
+        vm.expectRevert("stdMath percentDelta(uint256,uint256): Divisor is zero");
+        stdMathMock.exposedPercentDelta(uint256(1), 0);
+    }
+
+    function testFuzz_GetPercentDelta_Uint(uint192 a, uint192 b) external pure {
+        vm.assume(b != 0);
+        uint256 manualDelta = a > b ? a - b : b - a;
+
+        uint256 manualPercentDelta = manualDelta * 1e18 / b;
+        uint256 percentDelta = stdMath.percentDelta(a, b);
+
+        assertEq(percentDelta, manualPercentDelta);
+    }
+
+    function test_GetPercentDelta_Int() external {
+        // We deploy a mock version so we can properly test the revert.
+        StdMathMock stdMathMock = new StdMathMock();
+
+        assertEq(stdMath.percentDelta(int256(0), int256(1337)), 1e18);
+        assertEq(stdMath.percentDelta(int256(0), -1337), 1e18);
+        assertEq(stdMath.percentDelta(int256(0), type(int64).min), 1e18);
+        assertEq(stdMath.percentDelta(int256(0), type(int128).min), 1e18);
+        assertEq(stdMath.percentDelta(int256(0), type(int192).min), 1e18);
+        assertEq(stdMath.percentDelta(int256(0), type(int64).max), 1e18);
+        assertEq(stdMath.percentDelta(int256(0), type(int128).max), 1e18);
+        assertEq(stdMath.percentDelta(int256(0), type(int192).max), 1e18);
+
+        assertEq(stdMath.percentDelta(1337, int256(1337)), 0);
+        assertEq(stdMath.percentDelta(type(int192).max, type(int192).max), 0);
+        assertEq(stdMath.percentDelta(type(int192).min, type(int192).min), 0);
+
+        assertEq(stdMath.percentDelta(type(int192).min, type(int192).max), 2e18); // rounds the 1 wei diff down
+        assertEq(stdMath.percentDelta(type(int192).max, type(int192).min), 2e18 - 1); // rounds the 1 wei diff down
+        assertEq(stdMath.percentDelta(0, int256(2500)), 1e18);
+        assertEq(stdMath.percentDelta(2500, int256(2500)), 0);
+        assertEq(stdMath.percentDelta(5000, int256(2500)), 1e18);
+        assertEq(stdMath.percentDelta(7500, int256(2500)), 2e18);
+
+        vm.expectRevert("stdMath percentDelta(int256,int256): Divisor is zero");
+        stdMathMock.exposedPercentDelta(int256(1), 0);
+    }
+
+    function testFuzz_GetPercentDelta_Int(int192 a, int192 b) external pure {
+        vm.assume(b != 0);
+        uint256 absA = getAbs(a);
+        uint256 absB = getAbs(b);
+        uint256 absDelta = absA > absB ? absA - absB : absB - absA;
+
+        uint256 manualDelta;
+        if ((a >= 0 && b >= 0) || (a < 0 && b < 0)) {
+            manualDelta = absDelta;
+        }
+        // (a < 0 && b >= 0) || (a >= 0 && b < 0)
+        else {
+            manualDelta = absA + absB;
+        }
+
+        uint256 manualPercentDelta = manualDelta * 1e18 / absB;
+        uint256 percentDelta = stdMath.percentDelta(a, b);
+
+        assertEq(percentDelta, manualPercentDelta);
+    }
+
+    /*//////////////////////////////////////////////////////////////////////////
+                                   HELPERS
+    //////////////////////////////////////////////////////////////////////////*/
+
+    function getAbs(int256 a) private pure returns (uint256) {
+        if (a < 0) {
+            return a == type(int256).min ? uint256(type(int256).max) + 1 : uint256(-a);
+        }
+
+        return uint256(a);
+    }
+}