chaincheck: Adds config flag to disable check, fix bug

Author: pmerkleplant

Diff for: script/IAuthChaincheck.sol

@@ -13,9 +13,11 @@ import {IAuth} from "src/auth/IAuth.sol";
  * @notice IAuth's `chaincheck` Integration Test
  *
  * @dev Config Definition:
+ *
  *      ```json
  *      {
  *          "IAuth": {
+ *              "disabled": bool,
  *              "legacy": bool,
  *              "authed": [
  *                  "<Ethereum address>",
@@ -31,23 +33,23 @@ contract IAuthChaincheck is Chaincheck {
     Vm internal constant vm =
         Vm(address(uint160(uint(keccak256("hevm cheat code")))));
 
-    IAuth private auth;
-    string private config;
+    IAuth self;
+    string config;
 
-    string[] private _logs;
+    string[] logs;
 
     modifier notLegacy() {
         if (!config.readBool(".IAuth.legacy")) {
             _;
         }
     }
 
-    function setUp(address self, string memory config_)
+    function setUp(address self_, string memory config_)
         external
         override(Chaincheck)
         returns (Chaincheck)
     {
-        auth = IAuth(self);
+        self = IAuth(self_);
         config = config_;
 
         return Chaincheck(address(this));
@@ -58,13 +60,18 @@ contract IAuthChaincheck is Chaincheck {
         override(Chaincheck)
         returns (bool, string[] memory)
     {
+        // Don't run if disabled.
+        if (config.readBool(".IAuth.disabled")) {
+            return (logs.length == 0, logs);
+        }
+
         check_authed_containsAllExpectedAddresses();
         check_authed_onlyExpectedAddressesAreAuthed();
         check_authed_zeroAddressNotAuthed();
         check_authed_ownAddressNotAuthed();
 
         // Fail run if non-zero number of logs.
-        return (_logs.length == 0, _logs);
+        return (logs.length == 0, logs);
     }
 
     /// @dev Checks that each address expected to be auth'ed is actually
@@ -75,8 +82,8 @@ contract IAuthChaincheck is Chaincheck {
         // Check that each expected address is auth'ed.
         for (uint i; i < expected.length; i++) {
             // Using `wards(address)(uint)` to support legacy instances.
-            if (auth.wards(expected[i]) != 1) {
-                _logs.push(
+            if (self.wards(expected[i]) != 1) {
+                logs.push(
                     string.concat(
                         StdStyle.red("Expected address not auth'ed: "),
                         vm.toString(expected[i])
@@ -91,40 +98,43 @@ contract IAuthChaincheck is Chaincheck {
     /// @dev Only non-legacy versions supported.
     function check_authed_onlyExpectedAddressesAreAuthed() internal notLegacy {
         address[] memory expected = config.readAddressArray(".IAuth.authed");
-        address[] memory actual = auth.authed();
+        address[] memory actual = self.authed();
 
         for (uint i; i < actual.length; i++) {
+            bool found = false;
+
             for (uint j; j < expected.length; j++) {
                 if (actual[i] == expected[j]) {
+                    found = true;
                     break; // Found address. Continue with outer loop.
                 }
+            }
 
+            if (!found) {
                 // Log if unknown address auth'ed.
-                if (j == expected.length - 1) {
-                    _logs.push(
-                        string.concat(
-                            StdStyle.red("Unknown address auth'ed: "),
-                            vm.toString(actual[i])
-                        )
-                    );
-                }
+                logs.push(
+                    string.concat(
+                        StdStyle.red("Unknown address auth'ed: "),
+                        vm.toString(actual[i])
+                    )
+                );
             }
         }
     }
 
     /// @dev Checks that the zero address is not auth'ed.
     function check_authed_zeroAddressNotAuthed() internal {
         // Using `wards(address)(uint)` to support legacy instances.
-        if (auth.wards(address(0)) != 0) {
-            _logs.push(StdStyle.red("Zero address auth'ed"));
+        if (self.wards(address(0)) != 0) {
+            logs.push(StdStyle.red("Zero address auth'ed"));
         }
     }
 
     /// @dev Checks that own address is not auth'ed.
     function check_authed_ownAddressNotAuthed() internal {
         // Using `wards(address)(uint)` to support legacy instances.
-        if (auth.wards(address(auth)) != 0) {
-            _logs.push(StdStyle.red("Own address auth'ed"));
+        if (self.wards(address(self)) != 0) {
+            logs.push(StdStyle.red("Own address auth'ed"));
         }
     }
 }

Diff for: script/ITollChaincheck.sol

@@ -14,9 +14,11 @@ import {IToll} from "src/toll/IToll.sol";
  * @notice IToll's `chaincheck` Integration Test
  *
  * @dev Config Definition:
+ *
  *      ```json
  *      {
  *          "IToll": {
+ *              "disabled": bool,
  *              "legacy": bool,
  *              "tolled": [
  *                  "<Ethereum address>",
@@ -32,23 +34,23 @@ contract ITollChaincheck is Chaincheck {
     Vm internal constant vm =
         Vm(address(uint160(uint(keccak256("hevm cheat code")))));
 
-    IToll private toll;
-    string private config;
+    IToll self;
+    string config;
 
-    string[] private _logs;
+    string[] logs;
 
     modifier notLegacy() {
         if (!config.readBool(".IToll.legacy")) {
             _;
         }
     }
 
-    function setUp(address self, string memory config_)
+    function setUp(address self_, string memory config_)
         external
         override(Chaincheck)
         returns (Chaincheck)
     {
-        toll = IToll(self);
+        self = IToll(self_);
         config = config_;
 
         return Chaincheck(address(this));
@@ -59,13 +61,18 @@ contract ITollChaincheck is Chaincheck {
         override(Chaincheck)
         returns (bool, string[] memory)
     {
+        // Don't run if disabled.
+        if (config.readBool(".IToll.disabled")) {
+            return (logs.length == 0, logs);
+        }
+
         check_tolled_containsAllExpectedAddresses();
         check_tolled_onlyExpectedAddressesAreTolled();
         check_tolled_zeroAddressNotTolled();
         check_tolled_ownAddressNotTolled();
 
         // Fail run if non-zero number of logs.
-        return (_logs.length == 0, _logs);
+        return (logs.length == 0, logs);
     }
 
     /// @dev Checks that each address expected to be tolled is actually tolled.
@@ -75,8 +82,8 @@ contract ITollChaincheck is Chaincheck {
         // Check that each expected address is tolled.
         for (uint i; i < expected.length; i++) {
             // Using `bud(address)(uint)` to support legacy instances.
-            if (toll.bud(expected[i]) != 1) {
-                _logs.push(
+            if (self.bud(expected[i]) != 1) {
+                logs.push(
                     string.concat(
                         StdStyle.red("Expected address not tolled: "),
                         vm.toString(expected[i])
@@ -91,40 +98,43 @@ contract ITollChaincheck is Chaincheck {
     /// @dev Only non-legacy versions supported.
     function check_tolled_onlyExpectedAddressesAreTolled() internal notLegacy {
         address[] memory expected = config.readAddressArray(".IToll.tolled");
-        address[] memory actual = toll.tolled();
+        address[] memory actual = self.tolled();
 
         for (uint i; i < actual.length; i++) {
+            bool found = false;
+
             for (uint j; j < expected.length; j++) {
                 if (actual[i] == expected[j]) {
+                    found = true;
                     break; // Found address. Continue with outer loop.
                 }
+            }
 
-                // Log if unknown address tolled.
-                if (j == expected.length - 1) {
-                    _logs.push(
-                        string.concat(
-                            StdStyle.red("Unknown address tolled: "),
-                            vm.toString(actual[i])
-                        )
-                    );
-                }
+            // Log if unknown address tolled.
+            if (!found) {
+                logs.push(
+                    string.concat(
+                        StdStyle.red("Unknown address tolled: "),
+                        vm.toString(actual[i])
+                    )
+                );
             }
         }
     }
 
     /// @dev Checks that the zero address is not tolled.
     function check_tolled_zeroAddressNotTolled() internal {
         // Using `bud(address)(uint)` to support legacy instances.
-        if (toll.bud(address(0)) != 0) {
-            _logs.push(StdStyle.red("Zero address tolled"));
+        if (self.bud(address(0)) != 0) {
+            logs.push(StdStyle.red("Zero address tolled"));
         }
     }
 
     /// @dev Checks that own address is not tolled.
     function check_tolled_ownAddressNotTolled() internal {
         // Using `bud(address)(uint)` to support legacy instances.
-        if (toll.bud(address(toll)) != 0) {
-            _logs.push(StdStyle.red("Own address tolled"));
+        if (self.bud(address(self)) != 0) {
+            logs.push(StdStyle.red("Own address tolled"));
         }
     }
 }