test: add unit tests for TotalVotingPowerSafe (backport #5570) (#5581)

aljo242 · web-flow · commit 01d5ea5ceea4 · 2026-01-21T13:37:33.000-05:00
## Summary This PR adds comprehensive unit tests for the `TotalVotingPowerSafe` method in `types/validator_set.go`, addressing the request in issue #5522. ## Changes - Added `TestValidatorSet_TotalVotingPowerSafe` to `types/validator_set_test.go`. - Implemented a table-driven test structure using `testify/require` for strict assertions. - Added 11 test cases covering: - **Happy Path:** Standard validator sets with safe sums. - **Zero State:** Handling of nil and empty validator slices (expects 0, no error). - **Boundaries:** Sums exactly at `MaxTotalVotingPower`. - **Overflow:** Scenarios exceeding `MaxTotalVotingPower` (checking that it returns the expected error). ## Related Issues Closes #5522 #### PR checklist - [x] Tests written/updated - [ ] Changelog entry added in `.changelog` (N/A: `test` only change) - [ ] Updated relevant documentation (`docs/` or `spec/`) and code comments --- > [!NOTE] > Adds comprehensive unit tests for `TotalVotingPowerSafe` in `types/validator_set_test.go` to validate summation behavior and overflow handling. > > - Introduces `TestValidatorSet_TotalVotingPowerSafe` with 11 cases: normal sums, nil/empty sets, single validator, boundaries at `MaxTotalVotingPower`, and multiple overflow scenarios (ensuring error with "exceeds maximum") > - Verifies correct totals when within limits and zero result with error on overflow, without invoking `NewValidatorSet` to avoid panic > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit a1931b6. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup> <hr>This is an automatic backport of pull request #5570 done by [Mergify](https://mergify.com).  --- > [!NOTE] > Adds comprehensive coverage for `TotalVotingPowerSafe` behavior and overflow handling. > > - Introduces `TestValidatorSet_TotalVotingPowerSafe` in `types/validator_set_test.go` > - Covers normal sums, nil/empty sets, single validator, boundaries at `MaxTotalVotingPower`, and multiple overflow cases (asserting error contains "exceeds maximum") > - Bypasses `NewValidatorSet` to avoid panic during overflow scenarios; uses `require` for strict assertions > > <sup>Written by [Cursor Bugbot](https://cursor.com/dashboard?tab=bugbot) for commit bd517d2. This will update automatically on new commits. Configure [here](https://cursor.com/dashboard?tab=bugbot).</sup>
diff --git a/types/validator_set_test.go b/types/validator_set_test.go
@@ -1697,3 +1697,141 @@ func TestValidatorSet_AllKeysHaveSameType(t *testing.T) {
 		}
 	}
 }
+
+func TestValidatorSet_TotalVotingPowerSafe(t *testing.T) {
+	testCases := []struct {
+		name          string
+		validators    []*Validator
+		expectedPower int64
+		expectError   bool
+		errorContains string
+	}{
+		{
+			name: "happy path - normal validators",
+			validators: []*Validator{
+				NewValidator(ed25519.GenPrivKey().PubKey(), 100),
+				NewValidator(ed25519.GenPrivKey().PubKey(), 200),
+				NewValidator(ed25519.GenPrivKey().PubKey(), 300),
+			},
+			expectedPower: 600,
+			expectError:   false,
+		},
+		{
+			name:          "zero state - empty validator set",
+			validators:    []*Validator{},
+			expectedPower: 0,
+			expectError:   false,
+		},
+		{
+			name:          "zero state - nil validator set",
+			validators:    nil,
+			expectedPower: 0,
+			expectError:   false,
+		},
+		{
+			name: "single validator",
+			validators: []*Validator{
+				NewValidator(ed25519.GenPrivKey().PubKey(), 1000),
+			},
+			expectedPower: 1000,
+			expectError:   false,
+		},
+		{
+			name: "boundary - exactly at MaxTotalVotingPower",
+			validators: []*Validator{
+				NewValidator(ed25519.GenPrivKey().PubKey(), MaxTotalVotingPower),
+			},
+			expectedPower: MaxTotalVotingPower,
+			expectError:   false,
+		},
+		{
+			name: "boundary - sum equals MaxTotalVotingPower",
+			validators: []*Validator{
+				NewValidator(ed25519.GenPrivKey().PubKey(), MaxTotalVotingPower-100),
+				NewValidator(ed25519.GenPrivKey().PubKey(), 100),
+			},
+			expectedPower: MaxTotalVotingPower,
+			expectError:   false,
+		},
+		{
+			name: "overflow - exceeds MaxTotalVotingPower",
+			validators: []*Validator{
+				NewValidator(ed25519.GenPrivKey().PubKey(), MaxTotalVotingPower/2+1),
+				NewValidator(ed25519.GenPrivKey().PubKey(), MaxTotalVotingPower/2+1),
+			},
+			expectedPower: 0,
+			expectError:   true,
+			errorContains: "exceeds maximum",
+		},
+		{
+			name: "overflow - multiple validators exceeding MaxTotalVotingPower",
+			validators: []*Validator{
+				NewValidator(ed25519.GenPrivKey().PubKey(), MaxTotalVotingPower),
+				NewValidator(ed25519.GenPrivKey().PubKey(), 1),
+			},
+			expectedPower: 0,
+			expectError:   true,
+			errorContains: "exceeds maximum",
+		},
+		{
+			name: "overflow - three large validators",
+			validators: []*Validator{
+				NewValidator(ed25519.GenPrivKey().PubKey(), math.MaxInt64/2),
+				NewValidator(ed25519.GenPrivKey().PubKey(), math.MaxInt64/2),
+				NewValidator(ed25519.GenPrivKey().PubKey(), 100),
+			},
+			expectedPower: 0,
+			expectError:   true,
+			errorContains: "exceeds maximum",
+		},
+		{
+			name: "validators with zero voting power",
+			validators: []*Validator{
+				NewValidator(ed25519.GenPrivKey().PubKey(), 100),
+				NewValidator(ed25519.GenPrivKey().PubKey(), 0),
+				NewValidator(ed25519.GenPrivKey().PubKey(), 200),
+			},
+			expectedPower: 300,
+			expectError:   false,
+		},
+		{
+			name: "large number of validators - within limit",
+			validators: func() []*Validator {
+				vals := make([]*Validator, 100)
+				for i := 0; i < 100; i++ {
+					vals[i] = NewValidator(ed25519.GenPrivKey().PubKey(), 1000)
+				}
+				return vals
+			}(),
+			expectedPower: 100000,
+			expectError:   false,
+		},
+	}
+
+	for _, tc := range testCases {
+		t.Run(tc.name, func(t *testing.T) {
+			// Create validator set without using NewValidatorSet to avoid panic on overflow
+			valSet := &ValidatorSet{
+				Validators: tc.validators,
+			}
+
+			// Call TotalVotingPowerSafe
+			totalPower, err := valSet.TotalVotingPowerSafe()
+
+			// Assert expectations
+			if tc.expectError {
+				require.Error(t, err, "expected error but got none")
+				if tc.errorContains != "" {
+					require.Contains(t, err.Error(), tc.errorContains,
+						"error message should contain expected text")
+				}
+				require.Equal(t, tc.expectedPower, totalPower,
+					"power should be %d when error occurs", tc.expectedPower)
+			} else {
+				require.NoError(t, err, "unexpected error: %v", err)
+				require.Equal(t, tc.expectedPower, totalPower,
+					"total voting power should be %d", tc.expectedPower)
+			}
+		})
+	}
+}
