Files
onix/pkg/plugin/implementation/cache/cmd/plugin_test.go
2025-05-13 16:47:34 +05:30

288 lines
7.2 KiB
Go

package main
import (
"context"
"os"
"testing"
"time"
"github.com/beckn/beckn-onix/pkg/plugin/implementation/cache"
"github.com/redis/go-redis/v9"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/mock"
)
// TestParseConfig tests the configuration parsing logic of the plugin
func TestParseConfig(t *testing.T) {
tests := []struct {
name string
config map[string]string
want *Config
wantErr bool
}{
{
name: "missing addr",
config: map[string]string{},
want: nil,
wantErr: true,
},
{
name: "empty addr",
config: map[string]string{"addr": ""},
want: nil,
wantErr: true,
},
{
name: "basic config",
config: map[string]string{"addr": "localhost:6379"},
want: &Config{Addr: "localhost:6379", DB: 0, Password: ""},
wantErr: false,
},
{
name: "with db",
config: map[string]string{"addr": "localhost:6379", "db": "1"},
want: &Config{Addr: "localhost:6379", DB: 1, Password: ""},
wantErr: false,
},
{
name: "with password",
config: map[string]string{"addr": "localhost:6379", "password": "secret"},
want: &Config{Addr: "localhost:6379", DB: 0, Password: "secret"},
wantErr: false,
},
{
name: "invalid db",
config: map[string]string{"addr": "localhost:6379", "db": "invalid"},
want: &Config{Addr: "localhost:6379", DB: 0, Password: ""},
wantErr: false, // Not an error, just defaults to 0
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
got, err := parseConfig(tt.config)
if tt.wantErr {
assert.Error(t, err)
} else {
assert.NoError(t, err)
assert.Equal(t, tt.want, got)
}
})
}
}
// TestConvertToRedisConfig tests the configuration conversion logic
func TestConvertToRedisConfig(t *testing.T) {
cfg := &Config{
Addr: "localhost:6379",
DB: 1,
Password: "secret",
}
redisConfig := convertToRedisConfig(cfg)
assert.NotNil(t, redisConfig)
assert.Equal(t, cfg.Addr, redisConfig.Addr)
}
// TestProviderNew tests the New method of the cacheProvider
func TestProviderNew(t *testing.T) {
provider := cacheProvider{}
// Save original environment variable and restore it after test
origPassword := os.Getenv("REDIS_PASSWORD")
defer func() {
if err := os.Setenv("REDIS_PASSWORD", origPassword); err != nil {
t.Fatalf("Failed to restore REDIS_PASSWORD: %v", err)
}
}()
// Set an empty password for testing
if err := os.Setenv("REDIS_PASSWORD", ""); err != nil {
t.Fatalf("Failed to set REDIS_PASSWORD: %v", err)
}
tests := []struct {
name string
ctx context.Context
config map[string]string
expectErr bool
}{
{
name: "nil context",
ctx: nil,
config: map[string]string{"addr": "localhost:6379"},
expectErr: true,
},
{
name: "invalid config",
ctx: context.Background(),
config: map[string]string{}, // Missing addr
expectErr: true,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
cache, cleanup, err := provider.New(tt.ctx, tt.config)
if tt.expectErr {
assert.Error(t, err)
assert.Nil(t, cache)
assert.Nil(t, cleanup)
} else {
assert.NoError(t, err)
assert.NotNil(t, cache)
assert.NotNil(t, cleanup)
}
})
}
}
// TestProviderIntegration tests the provider with a real Redis server
// func TestProviderIntegration(t *testing.T) {
// // Skip this test if requested
// if os.Getenv("SKIP_REDIS_INTEGRATION_TEST") == "true" {
// t.Skip("Integration test skipped - SKIP_REDIS_INTEGRATION_TEST=true")
// }
// // Set an empty password for testing
// if err := os.Setenv("REDIS_PASSWORD", ""); err != nil {
// t.Fatalf("Failed to set REDIS_PASSWORD: %v", err)
// }
// // Ensure we clean up the environment variable at the end
// defer func() {
// if err := os.Unsetenv("REDIS_PASSWORD"); err != nil {
// t.Fatalf("Failed to unset REDIS_PASSWORD: %v", err)
// }
// }()
// // Create provider and test with real Redis
// provider := cacheProvider{}
// ctx := context.Background()
// config := map[string]string{
// "addr": "localhost:6379",
// "db": "0",
// }
// cache, cleanup, err := provider.New(ctx, config)
// if err != nil {
// t.Fatalf("Failed to create cache: %v", err)
// }
// defer func() {
// if err := cleanup(); err != nil {
// t.Fatalf("Failed to clean up Redis client: %v", err)
// }
// }()
// // Verify it works by setting and getting a value
// testKey := "provider_test_key"
// testValue := "provider_test_value"
// // Set a value
// err = cache.Set(ctx, testKey, testValue, 0)
// assert.NoError(t, err, "Set operation should not fail")
// // Get the value
// got, err := cache.Get(ctx, testKey)
// assert.NoError(t, err, "Get operation should not fail")
// assert.Equal(t, testValue, got, "Should get the value that was set")
// // Clean up
// err = cache.Delete(ctx, testKey)
// assert.NoError(t, err, "Delete operation should not fail")
// }
// TestProviderVariable tests that the Provider variable is correctly initialized
func TestProviderVariable(t *testing.T) {
assert.NotNil(t, Provider, "Provider should not be nil")
}
// mockRedisClient mocks the RedisClient interface from the cache package
type mockRedisClient struct {
mock.Mock
}
func (m *mockRedisClient) Get(ctx context.Context, key string) *redis.StringCmd {
args := m.Called(ctx, key)
cmd := redis.NewStringCmd(ctx)
cmd.SetVal(args.String(0))
return cmd
}
func (m *mockRedisClient) Set(ctx context.Context, key string, value interface{}, ttl time.Duration) *redis.StatusCmd {
args := m.Called(ctx, key, value, ttl)
cmd := redis.NewStatusCmd(ctx)
cmd.SetVal(args.String(0))
return cmd
}
func (m *mockRedisClient) Del(ctx context.Context, keys ...string) *redis.IntCmd {
args := m.Called(ctx, keys)
cmd := redis.NewIntCmd(ctx)
cmd.SetVal(int64(args.Int(0)))
return cmd
}
func (m *mockRedisClient) FlushDB(ctx context.Context) *redis.StatusCmd {
args := m.Called(ctx)
cmd := redis.NewStatusCmd(ctx)
cmd.SetVal(args.String(0))
return cmd
}
func (m *mockRedisClient) Ping(ctx context.Context) *redis.StatusCmd {
args := m.Called(ctx)
cmd := redis.NewStatusCmd(ctx)
cmd.SetVal(args.String(0))
return cmd
}
func (m *mockRedisClient) Close() error {
args := m.Called()
return args.Error(0)
}
func TestProviderIntegration(t *testing.T) {
// Save original RedisClientFunc and restore after test
original := cache.RedisClientFunc
defer func() { cache.RedisClientFunc = original }()
// Create and assign mock
mockClient := new(mockRedisClient)
cache.RedisClientFunc = func(cfg *cache.Config) cache.RedisClient {
return mockClient
}
ctx := context.Background()
// Expectations for the mock
mockClient.On("Ping", ctx).Return("PONG")
mockClient.On("Close").Return(nil)
// Create the config and convert it into a map[string]string
config := &cache.Config{
Addr: "localhost:35",
}
// Convert the *cache.Config to map[string]string
configMap := map[string]string{
"addr": config.Addr,
}
// Call the plugin provider
provider := Provider
c, cleanup, err := provider.New(ctx, configMap)
// Assertions
assert.NoError(t, err)
assert.NotNil(t, c)
assert.NotNil(t, cleanup)
// Call cleanup and assert
err = cleanup()
assert.NoError(t, err)
// Verify expectations
mockClient.AssertExpectations(t)
}