Rework mock executor using gomock for call validation

pkg/etcd/etcd_linux_test.go

@@ -19,6 +19,7 @@ import (
 	"github.com/k3s-io/k3s/pkg/daemons/config"
 	"github.com/k3s-io/k3s/pkg/etcd/s3"
 	testutil "github.com/k3s-io/k3s/tests"
+	"github.com/k3s-io/k3s/tests/mock"
 	"github.com/robfig/cron/v3"
 	"github.com/sirupsen/logrus"
 	"go.etcd.io/etcd/api/v3/etcdserverpb"
@@ -137,7 +138,9 @@ func Test_UnitETCD_IsInitialized(t *testing.T) {
 
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
+			mock.NewExecutorWithEmbeddedETCD(t)
 			e := NewETCD()
+
 			defer tt.teardown(tt.args.config)
 			if err := tt.setup(tt.args.config); err != nil {
 				t.Errorf("Prep for ETCD.IsInitialized() failed = %v", err)
@@ -215,6 +218,7 @@ func Test_UnitETCD_Register(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
+			mock.NewExecutorWithEmbeddedETCD(t)
 			e := NewETCD()
 
 			defer tt.teardown(tt.args.config)
@@ -389,6 +393,7 @@ func Test_UnitETCD_Start(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
+			mock.NewExecutorWithEmbeddedETCD(t)
 			e := &ETCD{
 				client:  tt.fields.client,
 				config:  tt.fields.config,
@@ -628,6 +633,7 @@ func Test_UnitETCD_Test(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
+			mock.NewExecutorWithEmbeddedETCD(t)
 			e := &ETCD{
 				client:  tt.fields.client,
 				config:  tt.fields.config,

tests/mock/executor_helpers.go

+package mock
+
+import (
+	"testing"
+
+	"github.com/golang/mock/gomock"
+	executor "github.com/k3s-io/k3s/pkg/daemons/executor"
+)
+
+// NewExecutorWithEmbeddedETCD creates a new mock executor, and sets it as the current executor.
+// The executor exepects calls to ETCD(), and wraps the embedded executor method of the same name.
+// The various ready channels are also mocked with immediate channel closure.
+func NewExecutorWithEmbeddedETCD(t *testing.T) {
+	mockController := gomock.NewController(t)
+	mockExecutor := NewExecutor(mockController)
+
+	embed := &executor.Embedded{}
+	initialOptions := func() (executor.InitialOptions, error) {
+		return executor.InitialOptions{}, nil
+	}
+	closedChannel := func() <-chan struct{} {
+		c := make(chan struct{})
+		close(c)
+		return c
+	}
+
+	mockExecutor.EXPECT().ETCD(gomock.Any(), gomock.Any(), gomock.Any(), gomock.Any()).AnyTimes().DoAndReturn(embed.ETCD)
+	mockExecutor.EXPECT().CurrentETCDOptions().AnyTimes().DoAndReturn(initialOptions)
+	mockExecutor.EXPECT().CRIReadyChan().AnyTimes().DoAndReturn(closedChannel)
+	mockExecutor.EXPECT().ETCDReadyChan().AnyTimes().DoAndReturn(closedChannel)
+
+	executor.Set(mockExecutor)
+}

tests/unit.go

@@ -7,8 +7,6 @@ import (
 
 	"github.com/k3s-io/k3s/pkg/daemons/config"
 	"github.com/k3s-io/k3s/pkg/daemons/control/deps"
-	"github.com/k3s-io/k3s/pkg/daemons/executor"
-	"github.com/k3s-io/k3s/tests/mock"
 )
 
 // GenerateDataDir creates a temporary directory at "/tmp/k3s/<RANDOM_STRING>/".
@@ -45,9 +43,6 @@ func CleanupDataDir(cnf *config.Control) {
 // GenerateRuntime creates a temporary data dir and configures
 // config.ControlRuntime with all the appropriate certificate keys.
 func GenerateRuntime(cnf *config.Control) error {
-	// use mock executor that does not actually start things
-	executor.Set(&mock.Executor{})
-
 	// reuse ready channel from existing runtime if set
 	cnf.Runtime = config.NewRuntime()
 	if err := GenerateDataDir(cnf); err != nil {