(feat) start moving things to a factory to simplify the test

Author: ncode

pkg/tagit/tagit.go

@@ -11,6 +11,7 @@ import (
 
 	"github.com/google/shlex"
 	"github.com/hashicorp/consul/api"
+	"github.com/ncode/tagit/pkg/consul"
 )
 
 // TagIt is the main struct for the tagit flow.
@@ -19,36 +20,11 @@ type TagIt struct {
 	Script          string
 	Interval        time.Duration
 	TagPrefix       string
-	client          ConsulClient
+	client          consul.ConsulClient
 	commandExecutor CommandExecutor
 	logger          *slog.Logger
 }
 
-// ConsulClient is an interface for the Consul client.
-type ConsulClient interface {
-	Agent() ConsulAgent
-}
-
-// ConsulAgent is an interface for the Consul agent.
-type ConsulAgent interface {
-	Service(string, *api.QueryOptions) (*api.AgentService, *api.QueryMeta, error)
-	ServiceRegister(*api.AgentServiceRegistration) error
-}
-
-// ConsulAPIWrapper wraps the Consul API client to conform to the ConsulClient interface.
-type ConsulAPIWrapper struct {
-	client *api.Client
-}
-
-// NewConsulAPIWrapper creates a new instance of ConsulAPIWrapper.
-func NewConsulAPIWrapper(client *api.Client) *ConsulAPIWrapper {
-	return &ConsulAPIWrapper{client: client}
-}
-
-// Agent returns an object that conforms to the ConsulAgent interface.
-func (w *ConsulAPIWrapper) Agent() ConsulAgent {
-	return w.client.Agent()
-}
 
 // CommandExecutor is an interface for running commands.
 type CommandExecutor interface {
@@ -72,7 +48,7 @@ func (e *CmdExecutor) Execute(command string) ([]byte, error) {
 }
 
 // New creates a new TagIt struct.
-func New(consulClient ConsulClient, commandExecutor CommandExecutor, serviceID string, script string, interval time.Duration, tagPrefix string, logger *slog.Logger) *TagIt {
+func New(consulClient consul.ConsulClient, commandExecutor CommandExecutor, serviceID string, script string, interval time.Duration, tagPrefix string, logger *slog.Logger) *TagIt {
 	return &TagIt{
 		ServiceID:       serviceID,
 		Script:          script,

pkg/tagit/tagit_test.go

@@ -11,6 +11,7 @@ import (
 	"time"
 
 	"github.com/hashicorp/consul/api"
+	"github.com/ncode/tagit/pkg/consul"
 	"github.com/stretchr/testify/assert"
 )
 
@@ -19,7 +20,7 @@ type MockConsulClient struct {
 	MockAgent *MockAgent
 }
 
-func (m *MockConsulClient) Agent() ConsulAgent {
+func (m *MockConsulClient) Agent() consul.ConsulAgent {
 	return m.MockAgent
 }
 
@@ -596,19 +597,34 @@ func TestRun(t *testing.T) {
 	assert.LessOrEqual(t, updateServiceTagsCalled.Load(), int32(4), "Expected updateServiceTags to be called at most 4 times")
 }
 
-func TestNewConsulAPIWrapper(t *testing.T) {
-	consulClient, err := api.NewClient(api.DefaultConfig())
-	assert.NoError(t, err, "Failed to create Consul client")
-
-	wrapper := NewConsulAPIWrapper(consulClient)
-
-	assert.NotNil(t, wrapper, "NewConsulAPIWrapper returned nil")
-
-	_, isConsulClient := interface{}(wrapper).(ConsulClient)
-	assert.True(t, isConsulClient, "NewConsulAPIWrapper does not implement ConsulClient interface")
-
-	_, isConsulAgent := wrapper.Agent().(ConsulAgent)
-	assert.True(t, isConsulAgent, "Wrapper's Agent method does not return a ConsulAgent")
+func TestConsulInterfaceCompatibility(t *testing.T) {
+	// Test that our mocks implement the consul package interfaces correctly
+	mockAgent := &MockAgent{
+		ServiceFunc: func(serviceID string, q *api.QueryOptions) (*api.AgentService, *api.QueryMeta, error) {
+			return &api.AgentService{ID: serviceID}, nil, nil
+		},
+		ServiceRegisterFunc: func(reg *api.AgentServiceRegistration) error {
+			return nil
+		},
+	}
+	
+	mockClient := &MockConsulClient{
+		MockAgent: mockAgent,
+	}
+	
+	// Verify that MockConsulClient implements consul.ConsulClient
+	var _ consul.ConsulClient = mockClient
+	
+	// Verify that MockAgent implements consul.ConsulAgent
+	var _ consul.ConsulAgent = mockAgent
+	
+	// Test that the mock client works correctly
+	agent := mockClient.Agent()
+	assert.NotNil(t, agent, "Agent() should return non-nil")
+	
+	service, _, err := agent.Service("test-service", nil)
+	assert.NoError(t, err)
+	assert.Equal(t, "test-service", service.ID)
 }
 
 func TestCmdExecutor_Execute(t *testing.T) {