fixed dynamic/static test interference

cmd/solana_exporter/dynamic_test.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"context"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/testutil"
 	"github.com/stretchr/testify/assert"
@@ -148,12 +149,9 @@ func getSlotMetricValues() slotMetricValues {
 }
 
 func TestSolanaCollector_WatchSlots_Dynamic(t *testing.T) {
-	// this test passes, however, it seems to cause the static tests to fail (after this test runs,
-	// the static tests fail to set their correct values to the prometheus metrics). So, putting this
-	// here while I debug
-	if testing.Short() {
-		t.Skip()
-	}
+	// reset metrics before running tests:
+	leaderSlotsTotal.Reset()
+	leaderSlotsByEpoch.Reset()
 
 	// create clients:
 	client := newDynamicRPCClient()
@@ -165,9 +163,10 @@ func TestSolanaCollector_WatchSlots_Dynamic(t *testing.T) {
 
 	// start client/collector and wait a bit:
 	go client.Run()
-	time.Sleep(1 * time.Second)
-	go collector.WatchSlots()
-	time.Sleep(1 * time.Second)
+	time.Sleep(time.Second)
+	ctx, cancel := context.WithCancel(context.Background())
+	go collector.WatchSlots(ctx)
+	time.Sleep(time.Second)
 
 	initial := getSlotMetricValues()
 
@@ -175,7 +174,7 @@ func TestSolanaCollector_WatchSlots_Dynamic(t *testing.T) {
 	var epochChanged bool
 	for i := 0; i < 5; i++ {
 		// wait a bit then get new metrics
-		time.Sleep(1 * time.Second)
+		time.Sleep(time.Second)
 		final := getSlotMetricValues()
 
 		// make sure that things have increased
@@ -203,10 +202,16 @@ func TestSolanaCollector_WatchSlots_Dynamic(t *testing.T) {
 			initial.EpochNumber,
 			final.EpochNumber,
 		)
+		if final.EpochNumber > initial.EpochNumber {
+			epochChanged = true
+		}
 
 		// make current final the new initial (for next iteration)
 		initial = final
 	}
 
-	assert.True(t, epochChanged)
+	assert.Truef(t, epochChanged, "Epoch has not changed!")
+	// cancel and wait for cancellation:
+	cancel()
+	time.Sleep(time.Second)
 }

cmd/solana_exporter/exporter.go

@@ -144,7 +144,7 @@ func main() {
 
 	collector := NewSolanaCollector(*rpcAddr)
 
-	go collector.WatchSlots()
+	go collector.WatchSlots(context.Background())
 
 	prometheus.MustRegister(collector)
 	http.Handle("/metrics", promhttp.Handler())

cmd/solana_exporter/slots.go

@@ -65,10 +65,10 @@ func init() {
 	prometheus.MustRegister(leaderSlotsByEpoch)
 }
 
-func (c *solanaCollector) WatchSlots() {
+func (c *solanaCollector) WatchSlots(ctx context.Context) {
 	// Get current slot height and epoch info
-	ctx, cancel := context.WithTimeout(context.Background(), httpTimeout)
-	info, err := c.rpcClient.GetEpochInfo(ctx, rpc.CommitmentMax)
+	ctx_, cancel := context.WithTimeout(context.Background(), httpTimeout)
+	info, err := c.rpcClient.GetEpochInfo(ctx_, rpc.CommitmentMax)
 	if err != nil {
 		klog.Fatalf("failed to fetch epoch info, bailing out: %v", err)
 	}
@@ -92,41 +92,75 @@ func (c *solanaCollector) WatchSlots() {
 	ticker := time.NewTicker(c.slotPace)
 
 	for {
-		<-ticker.C
+		select {
+		case <-ctx.Done():
+			klog.Infof("Stopping WatchSlots() at slot %v", watermark)
+			return
 
-		// Get current slot height and epoch info
-		ctx, cancel := context.WithTimeout(context.Background(), httpTimeout)
-		info, err := c.rpcClient.GetEpochInfo(ctx, rpc.CommitmentMax)
-		if err != nil {
-			klog.Infof("failed to fetch epoch info, retrying: %v", err)
-			cancel()
-			continue
-		}
-		cancel()
+		default:
+			<-ticker.C
 
-		if watermark == info.AbsoluteSlot {
-			klog.Infof("slot has not advanced at %d, skipping", info.AbsoluteSlot)
-			continue
-		}
-
-		if currentEpoch != info.Epoch {
-			klog.Infof(
-				"changing epoch from %d to %d. Watermark: %d, lastSlot: %d",
-				currentEpoch,
-				info.Epoch,
-				watermark,
-				lastSlot,
-			)
-
-			last, err := updateCounters(c.rpcClient, currentEpoch, watermark, &lastSlot)
+			// Get current slot height and epoch info
+			ctx_, cancel := context.WithTimeout(context.Background(), httpTimeout)
+			info, err := c.rpcClient.GetEpochInfo(ctx_, rpc.CommitmentMax)
 			if err != nil {
-				klog.Error(err)
+				klog.Infof("failed to fetch epoch info, retrying: %v", err)
+				cancel()
+				continue
+			}
+			cancel()
+
+			if watermark == info.AbsoluteSlot {
+				klog.Infof("slot has not advanced at %d, skipping", info.AbsoluteSlot)
+				continue
+			}
+
+			if currentEpoch != info.Epoch {
+				klog.Infof(
+					"changing epoch from %d to %d. Watermark: %d, lastSlot: %d",
+					currentEpoch,
+					info.Epoch,
+					watermark,
+					lastSlot,
+				)
+
+				last, err := updateCounters(c.rpcClient, currentEpoch, watermark, &lastSlot)
+				if err != nil {
+					klog.Error(err)
+					continue
+				}
+
+				klog.Infof(
+					"counters updated to slot %d (+%d), epoch %d (slots %d-%d, %d remaining)",
+					last,
+					last-watermark,
+					currentEpoch,
+					firstSlot,
+					lastSlot,
+					lastSlot-last,
+				)
+
+				watermark = last
+				currentEpoch, firstSlot, lastSlot = getEpochBounds(info)
+
+				currentEpochNumber.Set(float64(currentEpoch))
+				epochFirstSlot.Set(float64(firstSlot))
+				epochLastSlot.Set(float64(lastSlot))
+			}
+
+			totalTransactionsTotal.Set(float64(info.TransactionCount))
+			confirmedSlotHeight.Set(float64(info.AbsoluteSlot))
+
+			last, err := updateCounters(c.rpcClient, currentEpoch, watermark, nil)
+			if err != nil {
+				klog.Info(err)
 				continue
 			}
 
 			klog.Infof(
-				"counters updated to slot %d (+%d), epoch %d (slots %d-%d, %d remaining)",
+				"counters updated to slot %d (offset %d, +%d), epoch %d (slots %d-%d, %d remaining)",
 				last,
+				info.SlotIndex,
 				last-watermark,
 				currentEpoch,
 				firstSlot,
@@ -135,34 +169,7 @@ func (c *solanaCollector) WatchSlots() {
 			)
 
 			watermark = last
-			currentEpoch, firstSlot, lastSlot = getEpochBounds(info)
-
-			currentEpochNumber.Set(float64(currentEpoch))
-			epochFirstSlot.Set(float64(firstSlot))
-			epochLastSlot.Set(float64(lastSlot))
 		}
-
-		totalTransactionsTotal.Set(float64(info.TransactionCount))
-		confirmedSlotHeight.Set(float64(info.AbsoluteSlot))
-
-		last, err := updateCounters(c.rpcClient, currentEpoch, watermark, nil)
-		if err != nil {
-			klog.Info(err)
-			continue
-		}
-
-		klog.Infof(
-			"counters updated to slot %d (offset %d, +%d), epoch %d (slots %d-%d, %d remaining)",
-			last,
-			info.SlotIndex,
-			last-watermark,
-			currentEpoch,
-			firstSlot,
-			lastSlot,
-			lastSlot-last,
-		)
-
-		watermark = last
 	}
 }
 

cmd/solana_exporter/static_test.go

@@ -1,6 +1,7 @@
 package main
 
 import (
+	"context"
 	"fmt"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/testutil"
@@ -80,12 +81,17 @@ solana_node_version{version="1.16.7"} 1
 }
 
 func TestSolanaCollector_WatchSlots_Static(t *testing.T) {
+	// reset metrics before running tests:
+	leaderSlotsTotal.Reset()
+	leaderSlotsByEpoch.Reset()
+
 	collector := createSolanaCollector(
 		&staticRPCClient{},
 		100*time.Millisecond,
 	)
 	prometheus.NewPedanticRegistry().MustRegister(collector)
-	go collector.WatchSlots()
+	ctx, cancel := context.WithCancel(context.Background())
+	go collector.WatchSlots(ctx)
 	time.Sleep(1 * time.Second)
 
 	tests := []struct {
@@ -142,6 +148,9 @@ func TestSolanaCollector_WatchSlots_Static(t *testing.T) {
 			}
 		})
 	}
+	// cancel and wait for cancellation:
+	cancel()
+	time.Sleep(time.Second)
 }
 
 func testBlockProductionMetric(

cmd/solana_exporter/utils_test.go

@@ -59,20 +59,20 @@ var (
 		TransactionCount: 22661093,
 	}
 	staticBlockProduction = rpc.BlockProduction{
-		FirstSlot: 1000,
-		LastSlot:  2000,
+		FirstSlot: 100000000,
+		LastSlot:  200000000,
 		Hosts: map[string]rpc.BlockProductionPerHost{
 			"bbb": {
-				LeaderSlots:    400,
-				BlocksProduced: 360,
+				LeaderSlots:    40000000,
+				BlocksProduced: 36000000,
 			},
 			"ccc": {
-				LeaderSlots:    300,
-				BlocksProduced: 296,
+				LeaderSlots:    30000000,
+				BlocksProduced: 29600000,
 			},
 			"aaa": {
-				LeaderSlots:    300,
-				BlocksProduced: 0,
+				LeaderSlots:    30000000,
+				BlocksProduced: 10000000,
 			},
 		},
 	}