feat: add scheduler calls, mocks and unit tests on solana worker

Author: ecPablo

.mockery.yaml

@@ -1,23 +1,16 @@
-# Mockery configuration file
-
-# All interfaces in a package are generated by default. You can set this to false in the config of
-# of each package to disable this behavior.
 all: false
-with-expecter: true
-# The name of the mock file to be generated is the snake cased interface name.
-filename: "{{.InterfaceName | snakecase | lower}}.go"
-# Creates the mocks in a `mocks` dir inside the package containing the interfaces.
-dir: "{{.InterfaceDir}}/mocks"
-# The name of the mock struct is the interface name.
-mockname: "{{.InterfaceName}}"
-# Places the mock package in the same package as the interface.
-outpkg: "mocks"
+
 packages:
+  github.com/smartcontractkit/timelock-worker/pkg/timelock:
+    interfaces:
+      Scheduler:
+        config:
+          dir: "./pkg/timelock"
+          filename: "scheduler_mock.go"
+
   github.com/ethereum/go-ethereum/accounts/abi/bind:
     interfaces:
       ContractBackend:
         config:
-          # inpackage: false
-          filename: "{{.InterfaceName | snakecase}}.go"
-          # mockname: "{{.InterfaceName}}"
           dir: "./pkg/timelock/mocks"
+          filename: "contract_backend.go"

.tool-versions

@@ -1,4 +1,4 @@
 golang 1.24.3
 golangci-lint 1.64.8
 task 3.40.0
-mockery 2.50.0
+mockery 3.3.2

go.mod

@@ -11,6 +11,7 @@ require (
 	github.com/gagliardetto/binary v0.8.0
 	github.com/gagliardetto/solana-go v1.12.0
 	github.com/google/go-cmp v0.7.0
+	github.com/mr-tron/base58 v1.2.0
 	github.com/prometheus/client_golang v1.21.1
 	github.com/samber/lo v1.47.0
 	github.com/smartcontractkit/ccip-owner-contracts v0.0.0-20240917103524-56f1a8d2cd4b
@@ -129,7 +130,6 @@ require (
 	github.com/modern-go/reflect2 v1.0.2 // indirect
 	github.com/morikuni/aec v1.0.0 // indirect
 	github.com/mostynb/zstdpool-freelist v0.0.0-20201229113212-927304c0c3b1 // indirect
-	github.com/mr-tron/base58 v1.2.0 // indirect
 	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
 	github.com/olekukonko/tablewriter v0.0.5 // indirect
 	github.com/opencontainers/go-digest v1.0.0 // indirect

pkg/timelock/scheduler_test.go

@@ -200,6 +200,16 @@ func newTestScheduler() *scheduler {
 	return newScheduler(10*time.Second, logger, execFn)
 }
 
+// newMockScheduler returns a mock Scheduler with assertion tracking setup
+func newMockScheduler(t *testing.T) *MockScheduler {
+	mockScheduler := NewMockScheduler(t)
+
+	// Example: you can preset mock behavior here if needed
+	// mockScheduler.On("runScheduler", mock.Anything).Return(make(chan struct{}))
+
+	return mockScheduler
+}
+
 // generateOpKeys generates a slice of operation keys from a slice of strings.
 func generateOpKeys(t *testing.T, in []string) [][32]byte {
 	t.Helper()

pkg/timelock/worker_solana.go

@@ -100,11 +100,10 @@ func NewTimelockWorkerSolana(
 	}
 
 	if dryRun {
-		tWorker.scheduler = nil // TODO: add solana nopScheduler implementation
+		tWorker.scheduler = newNopScheduler(logger)
 	} else {
-		tWorker.scheduler = nil // TODO: add solana Scheduler implementation
+		tWorker.scheduler = newScheduler(time.Duration(pollPeriod)*time.Second, logger, func(context.Context, []TimelockCallScheduled) {})
 	}
-
 	return tWorker, nil
 }
 
@@ -117,7 +116,7 @@ func (w *WorkerSolana) Listen(ctx context.Context) error {
 	w.startLog()
 
 	// Run the scheduler to add/del operations in a thread-safe way.
-	//schedulingDone = w.scheduler.runScheduler(ctxwc)
+	schedulingDone := w.scheduler.runScheduler(ctxwc)
 
 	//// Retrieve logs asynchronously.
 	pollDone, txCh := w.pollNewTransactions(ctxwc)
@@ -136,14 +135,14 @@ func (w *WorkerSolana) Listen(ctx context.Context) error {
 
 	w.logger.Info("shutting down timelock-worker")
 	w.logger.Info("dumping operation store")
-	// TODO: re-add when scheduler is implemented
-	//w.scheduler.dumpOperationStore(time.Now)
+
+	w.scheduler.dumpOperationStore(time.Now)
 
 	// Wait for all goroutines to finish.
 	shutdownCtx, cancel := context.WithTimeout(context.Background(), time.Second*5)
 	defer cancel()
 
-	<-isclosed.All(shutdownCtx, pollDone, procDone) //nolint:contextcheck
+	<-isclosed.All(shutdownCtx, schedulingDone, pollDone, procDone) //nolint:contextcheck
 
 	return nil
 }
@@ -341,8 +340,7 @@ func (w *WorkerSolana) handleEventCancelled(_ context.Context, event SolanaTimel
 	w.logger.With(operationID, fmt.Sprintf("%x", event.ID)).
 		Infow("event received, cancelling operation", "event type", eventCancelled)
 
-	// TODO: add scheduler call once scheduler is implemented
-	//w.scheduler.delFromScheduler(event.ID)
+	w.scheduler.delFromScheduler(event.ID)
 }
 
 // handleEventExecuted checks if the operation is done and deletes it from the scheduler if it is.
@@ -357,8 +355,8 @@ func (w *WorkerSolana) handleEventExecuted(ctx context.Context, event SolanaTime
 	}
 	if isDone {
 		logger.Infow("event received, deleting operation from scheduler", "event type ", eventCallExecuted)
-		// TODO: add scheduler call once scheduler is implemented
-		//w.scheduler.delFromScheduler(event.ID)
+
+		w.scheduler.delFromScheduler(event.ID)
 	} else {
 		logger.Warn("operation not done; skipping deletion from scheduler")
 	}
@@ -384,8 +382,7 @@ func (w *WorkerSolana) handleEventScheduled(ctx context.Context, event SolanaTim
 
 		if isOp {
 			logger.Infow("event received", "event type", eventCallScheduled)
-			// TODO: add scheduler call once scheduler is implemented
-			// w.scheduler.addToScheduler(cs)
+			w.scheduler.addToScheduler(&solanaTimelockCallScheduled{callScheduledEvent: event})
 		} else {
 			logger.Warn("invalid operation")
 		}

pkg/timelock/worker_solana_test.go

@@ -194,43 +194,46 @@ func TestPollNewSignatures(t *testing.T) {
 
 func TestHandleEventCancelled(t *testing.T) {
 	id := [32]byte{1, 2, 3}
-
+	s := newMockScheduler(t)
 	worker := &WorkerSolana{
-		logger: testLogger,
+		logger:    testLogger,
+		scheduler: s,
 	}
-
+	s.On("delFromScheduler", mock.Anything).Return(nil)
 	worker.handleEventCancelled(context.Background(), SolanaTimelockCallCancelledEvent{ID: id})
-	// TODO: once scheduler is added we can assert expectation from a mock scheduler here.
 }
 
 func TestHandleEventExecuted_Done(t *testing.T) {
 	id := [32]byte{4, 5, 6}
 	mockInsp := new(mocks.TimelockInspector)
 	mockInsp.On("IsOperationDone", mock.Anything, "some.addr", id).Return(true, nil)
-
+	s := newMockScheduler(t)
 	worker := &WorkerSolana{
 		timelockFullAddress: "some.addr",
 		inspector:           mockInsp,
+		scheduler:           s,
 		logger:              testLogger,
 	}
+	s.On("delFromScheduler", mock.Anything).Return(nil)
 	event := SolanaTimelockCallExecutedEvent{ID: id, Target: solana.PublicKey{}}
 	err := worker.handleEventExecuted(context.Background(), event)
 	require.NoError(t, err)
 	mockInsp.AssertExpectations(t)
-	// TODO: once scheduler is added we can assert expectation from a mock scheduler here.
 }
 
 func TestHandleEventScheduled_IsOp(t *testing.T) {
 	id := [32]byte{7, 8, 9}
 	mockInsp := new(mocks.TimelockInspector)
 	mockInsp.On("IsOperationDone", mock.Anything, "some.addr", id).Return(false, nil)
 	mockInsp.On("IsOperation", mock.Anything, "some.addr", id).Return(true, nil)
-
+	s := newMockScheduler(t)
 	worker := &WorkerSolana{
 		timelockFullAddress: "some.addr",
 		inspector:           mockInsp,
+		scheduler:           s,
 		logger:              testLogger,
 	}
+	s.On("addToScheduler", mock.Anything).Return(nil)
 	event := SolanaTimelockCallScheduledEvent{ID: id, Target: solana.PublicKey{}}
 	err := worker.handleEventScheduled(context.Background(), event)
 	require.NoError(t, err)
@@ -245,6 +248,7 @@ func TestHandleEventScheduled_OperationDone(t *testing.T) {
 	worker := &WorkerSolana{
 		timelockFullAddress: "some.addr",
 		inspector:           mockInsp,
+		scheduler:           newMockScheduler(t),
 		logger:              testLogger,
 	}
 	event := SolanaTimelockCallScheduledEvent{ID: id, Target: solana.PublicKey{}}
@@ -261,13 +265,13 @@ func TestHandleEventExecuted_NotDone(t *testing.T) {
 	worker := &WorkerSolana{
 		timelockFullAddress: "some.addr",
 		inspector:           mockInsp,
+		scheduler:           newMockScheduler(t),
 		logger:              testLogger,
 	}
 	event := SolanaTimelockCallExecutedEvent{ID: id, Target: solana.PublicKey{}}
 	err := worker.handleEventExecuted(context.Background(), event)
 	require.NoError(t, err)
 	mockInsp.AssertExpectations(t)
-	// TODO: once scheduler is added we can assert expectation from a mock scheduler here.
 }
 
 func TestHandleEventScheduled_IsOp_Error(t *testing.T) {
@@ -279,6 +283,7 @@ func TestHandleEventScheduled_IsOp_Error(t *testing.T) {
 	worker := &WorkerSolana{
 		timelockFullAddress: "some.addr",
 		inspector:           mockInsp,
+		scheduler:           newMockScheduler(t),
 		logger:              testLogger,
 	}
 	event := SolanaTimelockCallScheduledEvent{ID: id, Target: solana.PublicKey{}}
@@ -293,9 +298,9 @@ func TestHandleEventExecuted_Error(t *testing.T) {
 	worker := &WorkerSolana{
 		timelockFullAddress: "some.addr",
 		inspector:           mockInsp,
+		scheduler:           newMockScheduler(t),
 		logger:              testLogger,
 	}
 	event := SolanaTimelockCallExecutedEvent{ID: id, Target: solana.PublicKey{}}
 	require.ErrorContains(t, worker.handleEventExecuted(context.Background(), event), "timelock.isOperationDone call failed")
-	// TODO: once scheduler is added we can assert expectation from a mock scheduler here.
 }

tests/integration/solana/worker_test.go

@@ -54,12 +54,11 @@ func (s *solanaIntegrationTestSuite) TestTimelockWorkerListen() {
 		assert.Equal(collect, logEntries[3].Message, "\tPoll Period")
 		assert.Equal(collect, logEntries[4].Message, "\tEvent Listener Poll Period")
 		assert.Equal(collect, logEntries[5].Message, "\tEvent Listener Poll #Logs")
-		assert.Equal(collect, logEntries[6].Message, "starting pollNewTransactions")
-		assert.Contains(collect, logEntries[7].Message, "new pollNewTransactions")
-		assert.Equal(collect, logEntries[8].Message, "found new signatures")
-		assert.Contains(collect, logEntries[9].Message, "found event scheduled:")
-		assert.Contains(collect, logEntries[10].Message, "event received")
-		assert.Contains(collect, logEntries[10].Context[3].Key, "event type")
-		assert.Contains(collect, logEntries[10].Context[3].String, "CallScheduled")
+		assert.Equal(collect, logEntries[6].Message, "nop.runScheduler")
+		assert.Equal(collect, logEntries[7].Message, "starting pollNewTransactions")
+		assert.Contains(collect, logEntries[8].Message, "new pollNewTransactions")
+		assert.Equal(collect, logEntries[9].Message, "found new signatures")
+		assert.Contains(collect, logEntries[10].Message, "found event scheduled:")
+		assert.Contains(collect, logEntries[11].Message, "event received")
 	}, 20*time.Second, 200*time.Millisecond)
 }