tests: don't panic when a staker query fails during a wait (#146)

waitForCompletedPeriods logged periodDetails.CompletedPeriods before
checking the query error, so a failed GetValidationPeriodDetails call
dereferenced a nil result and panicked. The panic skipped RunFlakyTest's
retries and hid the query error. It failed thor-private CI twice in
Test_Stargate_DelegatorFlow_Stake_And_Claim_Auto_Renew_On_And_Off while
the chain was producing blocks normally.

Check the error first. A failed query now counts as not done yet, is
logged, and polling continues within the existing one-minute bound. If
the wait still fails, return the underlying error instead of a generic
StakerStatusUnknownError, so the cause shows and the test is retried.

assertValidatorStatus and assertValidatorStatusUnknown in the
validations tests had the same nil dereference after assert.NoError:
stop with require.NoError, or return the error for a retry.

Author: otherview

tests/stargate/stargate_test.go

@@ -1,6 +1,7 @@
 package stargate
 
 import (
+	"fmt"
 	"log/slog"
 	"math/big"
 	"strconv"
@@ -37,14 +38,17 @@ func Test_Stargate_SingleDelegator(t *testing.T) {
 func waitForCompletedPeriods(ticker *utils.Ticker, staker *builtin.Staker, validationID thor.Address, expectedPeriods uint32) error {
 	err := ticker.WaitForCondition(time.Minute*1, func() (bool, error) {
 		periodDetails, err := staker.GetValidationPeriodDetails(validationID)
-		slog.Info("⚠️ - completed periods, waiting for greater or equal than expected", "completed", int(periodDetails.CompletedPeriods), "expected", expectedPeriods)
 		if err != nil {
-			return false, err
+			// keep polling: a failed query is not a result, and WaitForCondition
+			// still bounds the wait
+			slog.Warn("⚠️ - failed to get validation period details", "validationID", validationID, "err", err)
+			return false, nil
 		}
+		slog.Info("⚠️ - completed periods, waiting for greater or equal than expected", "completed", int(periodDetails.CompletedPeriods), "expected", expectedPeriods)
 		return periodDetails.CompletedPeriods >= expectedPeriods, nil
 	})
 	if err != nil {
-		return testutil.StakerStatusUnknownError{ValidationID: validationID.String()}
+		return fmt.Errorf("waiting for %d completed periods of %s: %w", expectedPeriods, validationID, err)
 	}
 	return nil
 }

tests/validations/validations_test.go

@@ -1,6 +1,7 @@
 package validations
 
 import (
+	"fmt"
 	"log/slog"
 	"math/big"
 	"testing"
@@ -772,14 +773,16 @@ func assertMatchingValidators(t *testing.T, staker *builtin.Staker, id1 thor.Add
 func assertValidatorStatus(t *testing.T, staker *builtin.Staker, validatorID thor.Address, expectedStatus builtin.StakerStatus, waitForBlock uint32) {
 	assert.NoError(t, utils.NewTicker(staker.Raw().Client()).WaitForBlock(waitForBlock))
 	validator, err := staker.GetValidation(validatorID)
-	assert.NoError(t, err)
+	require.NoError(t, err)
 	assert.Equal(t, expectedStatus, validator.Status)
 }
 
 func assertValidatorStatusUnknown(t *testing.T, staker *builtin.Staker, validatorID thor.Address, expectedStatus builtin.StakerStatus, waitForBlock uint32) error {
 	assert.NoError(t, utils.NewTicker(staker.Raw().Client()).WaitForBlock(waitForBlock))
 	validator, err := staker.GetValidation(validatorID)
-	assert.NoError(t, err)
+	if err != nil {
+		return fmt.Errorf("getting validation %s: %w", validatorID, err)
+	}
 	if validator.Status == builtin.StakerStatusUnknown {
 		return testutil.StakerStatusUnknownError{ValidationID: validatorID.String()}
 	}