Plugins: API sync (#112452)
This commit is contained in:
Todd Treece
GitHub
@@ -0,0 +1,26 @@
|
||||
package installsyncfakes
|
||||
|
||||
import (
|
||||
"context"
|
||||
|
||||
"github.com/grafana/grafana/apps/plugins/pkg/app/install"
|
||||
"github.com/grafana/grafana/pkg/plugins"
|
||||
"github.com/grafana/grafana/pkg/services/pluginsintegration/installsync"
|
||||
)
|
||||
|
||||
var _ installsync.Syncer = &FakeSyncer{}
|
||||
|
||||
type FakeSyncer struct {
|
||||
SyncFunc func(ctx context.Context, source install.Source, installedPlugins []*plugins.Plugin) error
|
||||
}
|
||||
|
||||
func NewFakeSyncer() *FakeSyncer {
|
||||
return &FakeSyncer{}
|
||||
}
|
||||
|
||||
func (f *FakeSyncer) Sync(ctx context.Context, source install.Source, installedPlugins []*plugins.Plugin) error {
|
||||
if f.SyncFunc != nil {
|
||||
return f.SyncFunc(ctx, source, installedPlugins)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
@@ -0,0 +1,164 @@
|
||||
package installsync
|
||||
|
||||
import (
|
||||
"context"
|
||||
"time"
|
||||
|
||||
"github.com/grafana/grafana-app-sdk/resource"
|
||||
|
||||
"github.com/grafana/grafana/apps/plugins/pkg/app/install"
|
||||
"github.com/grafana/grafana/pkg/configprovider"
|
||||
"github.com/grafana/grafana/pkg/plugins"
|
||||
"github.com/grafana/grafana/pkg/services/apiserver/endpoints/request"
|
||||
"github.com/grafana/grafana/pkg/services/featuremgmt"
|
||||
"github.com/grafana/grafana/pkg/services/org"
|
||||
)
|
||||
|
||||
const (
|
||||
syncerLockActionName = "plugin-install-api-sync"
|
||||
)
|
||||
|
||||
var (
|
||||
lockTimeout = 10 * time.Minute
|
||||
)
|
||||
|
||||
// Syncer is the interface for syncing plugin installations to the Kubernetes-style API.
|
||||
type Syncer interface {
|
||||
Sync(ctx context.Context, source install.Source, installedPlugins []*plugins.Plugin) error
|
||||
}
|
||||
|
||||
// ServerLock is the interface for acquiring distributed locks.
|
||||
type ServerLock interface {
|
||||
LockExecuteAndRelease(ctx context.Context, actionName string, maxInterval time.Duration, fn func(ctx context.Context)) error
|
||||
}
|
||||
|
||||
type syncer struct {
|
||||
featureToggles featuremgmt.FeatureToggles
|
||||
clientGenerator resource.ClientGenerator
|
||||
installRegistrar *install.InstallRegistrar
|
||||
orgService org.Service
|
||||
namespaceMapper request.NamespaceMapper
|
||||
serverLock ServerLock
|
||||
}
|
||||
|
||||
// newSyncer creates a new syncer with the provided dependencies.
|
||||
func newSyncer(
|
||||
featureToggles featuremgmt.FeatureToggles,
|
||||
clientGenerator resource.ClientGenerator,
|
||||
installRegistrar *install.InstallRegistrar,
|
||||
orgService org.Service,
|
||||
namespaceMapper request.NamespaceMapper,
|
||||
serverLock ServerLock,
|
||||
) *syncer {
|
||||
return &syncer{
|
||||
clientGenerator: clientGenerator,
|
||||
featureToggles: featureToggles,
|
||||
installRegistrar: installRegistrar,
|
||||
orgService: orgService,
|
||||
namespaceMapper: namespaceMapper,
|
||||
serverLock: serverLock,
|
||||
}
|
||||
}
|
||||
|
||||
// ProvideSyncer creates a new Syncer for syncing plugin installations to the API.
|
||||
func ProvideSyncer(
|
||||
featureToggles featuremgmt.FeatureToggles,
|
||||
clientGenerator resource.ClientGenerator,
|
||||
orgService org.Service,
|
||||
cfgProvider configprovider.ConfigProvider,
|
||||
serverLock ServerLock,
|
||||
) (Syncer, error) {
|
||||
cfg, err := cfgProvider.Get(context.Background())
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
installRegistrar := install.NewInstallRegistrar(clientGenerator)
|
||||
namespaceMapper := request.GetNamespaceMapper(cfg)
|
||||
|
||||
return newSyncer(
|
||||
featureToggles,
|
||||
clientGenerator,
|
||||
installRegistrar,
|
||||
orgService,
|
||||
namespaceMapper,
|
||||
serverLock,
|
||||
), nil
|
||||
}
|
||||
|
||||
func (s *syncer) Sync(ctx context.Context, source install.Source, installedPlugins []*plugins.Plugin) error {
|
||||
if !s.featureToggles.IsEnabled(ctx, featuremgmt.FlagPluginInstallAPISync) {
|
||||
return nil
|
||||
}
|
||||
|
||||
if len(installedPlugins) == 0 {
|
||||
return nil
|
||||
}
|
||||
|
||||
var syncErr error
|
||||
lockErr := s.serverLock.LockExecuteAndRelease(ctx, syncerLockActionName, lockTimeout, func(ctx context.Context) {
|
||||
syncErr = s.syncAllNamespaces(ctx, source, installedPlugins)
|
||||
})
|
||||
|
||||
if lockErr != nil {
|
||||
return lockErr
|
||||
}
|
||||
return syncErr
|
||||
}
|
||||
|
||||
func (s *syncer) syncAllNamespaces(ctx context.Context, source install.Source, installedPlugins []*plugins.Plugin) error {
|
||||
orgs, err := s.orgService.Search(ctx, &org.SearchOrgsQuery{})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
for _, org := range orgs {
|
||||
err := s.syncNamespace(ctx, s.namespaceMapper(org.ID), source, installedPlugins)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
func (s *syncer) syncNamespace(ctx context.Context, namespace string, source install.Source, installedPlugins []*plugins.Plugin) error {
|
||||
client, err := s.installRegistrar.GetClient()
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
apiPlugins, err := client.ListAll(ctx, namespace, resource.ListOptions{})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
|
||||
installedMap := make(map[string]*plugins.Plugin)
|
||||
for _, p := range installedPlugins {
|
||||
installedMap[p.ID] = p
|
||||
}
|
||||
|
||||
// unregister plugins that are not installed
|
||||
for _, apiPlugin := range apiPlugins.Items {
|
||||
if _, exists := installedMap[apiPlugin.Spec.Id]; !exists {
|
||||
err := s.installRegistrar.Unregister(ctx, namespace, apiPlugin.Spec.Id, source)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
// register plugins that are installed
|
||||
for _, p := range installedPlugins {
|
||||
err := s.installRegistrar.Register(ctx, namespace, &install.PluginInstall{
|
||||
ID: p.ID,
|
||||
Version: p.Info.Version,
|
||||
Class: install.Class(p.Class),
|
||||
Source: source,
|
||||
})
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
}
|
||||
@@ -0,0 +1,650 @@
|
||||
package installsync
|
||||
|
||||
import (
|
||||
"context"
|
||||
"errors"
|
||||
"testing"
|
||||
"time"
|
||||
|
||||
"github.com/grafana/grafana-app-sdk/resource"
|
||||
"github.com/stretchr/testify/require"
|
||||
errorsK8s "k8s.io/apimachinery/pkg/api/errors"
|
||||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
|
||||
"k8s.io/apimachinery/pkg/runtime/schema"
|
||||
|
||||
pluginsv0alpha1 "github.com/grafana/grafana/apps/plugins/pkg/apis/plugins/v0alpha1"
|
||||
"github.com/grafana/grafana/apps/plugins/pkg/app/install"
|
||||
"github.com/grafana/grafana/pkg/plugins"
|
||||
"github.com/grafana/grafana/pkg/services/featuremgmt"
|
||||
"github.com/grafana/grafana/pkg/services/org"
|
||||
"github.com/grafana/grafana/pkg/services/org/orgtest"
|
||||
)
|
||||
|
||||
// Test helpers to avoid import cycles
|
||||
type fakeServerLock struct {
|
||||
lockFunc func(ctx context.Context, actionName string, maxInterval time.Duration, fn func(ctx context.Context)) error
|
||||
}
|
||||
|
||||
func (f *fakeServerLock) LockExecuteAndRelease(ctx context.Context, actionName string, maxInterval time.Duration, fn func(ctx context.Context)) error {
|
||||
if f.lockFunc != nil {
|
||||
return f.lockFunc(ctx, actionName, maxInterval, fn)
|
||||
}
|
||||
fn(ctx)
|
||||
return nil
|
||||
}
|
||||
|
||||
type fakePluginInstallClient struct {
|
||||
listAllFunc func(ctx context.Context, namespace string, opts resource.ListOptions) (*pluginsv0alpha1.PluginInstallList, error)
|
||||
getFunc func(ctx context.Context, identifier resource.Identifier) (*pluginsv0alpha1.PluginInstall, error)
|
||||
createFunc func(ctx context.Context, obj *pluginsv0alpha1.PluginInstall, opts resource.CreateOptions) (*pluginsv0alpha1.PluginInstall, error)
|
||||
updateFunc func(ctx context.Context, obj *pluginsv0alpha1.PluginInstall, opts resource.UpdateOptions) (*pluginsv0alpha1.PluginInstall, error)
|
||||
deleteFunc func(ctx context.Context, identifier resource.Identifier, opts resource.DeleteOptions) error
|
||||
}
|
||||
|
||||
func (f *fakePluginInstallClient) Get(ctx context.Context, identifier resource.Identifier) (*pluginsv0alpha1.PluginInstall, error) {
|
||||
if f.getFunc != nil {
|
||||
return f.getFunc(ctx, identifier)
|
||||
}
|
||||
// Return a proper k8s NotFound error
|
||||
return nil, errorsK8s.NewNotFound(schema.GroupResource{
|
||||
Group: pluginsv0alpha1.APIGroup,
|
||||
Resource: "plugininstalls",
|
||||
}, identifier.Name)
|
||||
}
|
||||
|
||||
func (f *fakePluginInstallClient) ListAll(ctx context.Context, namespace string, opts resource.ListOptions) (*pluginsv0alpha1.PluginInstallList, error) {
|
||||
if f.listAllFunc != nil {
|
||||
return f.listAllFunc(ctx, namespace, opts)
|
||||
}
|
||||
return &pluginsv0alpha1.PluginInstallList{}, nil
|
||||
}
|
||||
|
||||
func (f *fakePluginInstallClient) List(ctx context.Context, namespace string, opts resource.ListOptions) (*pluginsv0alpha1.PluginInstallList, error) {
|
||||
return f.ListAll(ctx, namespace, opts)
|
||||
}
|
||||
|
||||
func (f *fakePluginInstallClient) Create(ctx context.Context, obj *pluginsv0alpha1.PluginInstall, opts resource.CreateOptions) (*pluginsv0alpha1.PluginInstall, error) {
|
||||
if f.createFunc != nil {
|
||||
return f.createFunc(ctx, obj, opts)
|
||||
}
|
||||
return obj, nil
|
||||
}
|
||||
|
||||
func (f *fakePluginInstallClient) Update(ctx context.Context, obj *pluginsv0alpha1.PluginInstall, opts resource.UpdateOptions) (*pluginsv0alpha1.PluginInstall, error) {
|
||||
if f.updateFunc != nil {
|
||||
return f.updateFunc(ctx, obj, opts)
|
||||
}
|
||||
return obj, nil
|
||||
}
|
||||
|
||||
func (f *fakePluginInstallClient) UpdateStatus(ctx context.Context, identifier resource.Identifier, newStatus pluginsv0alpha1.PluginInstallStatus, opts resource.UpdateOptions) (*pluginsv0alpha1.PluginInstall, error) {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
func (f *fakePluginInstallClient) Patch(ctx context.Context, identifier resource.Identifier, req resource.PatchRequest, opts resource.PatchOptions) (*pluginsv0alpha1.PluginInstall, error) {
|
||||
return nil, nil
|
||||
}
|
||||
|
||||
func (f *fakePluginInstallClient) Delete(ctx context.Context, identifier resource.Identifier, opts resource.DeleteOptions) error {
|
||||
if f.deleteFunc != nil {
|
||||
return f.deleteFunc(ctx, identifier, opts)
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
type fakeClientGenerator struct {
|
||||
client *fakePluginInstallClient
|
||||
}
|
||||
|
||||
func (f *fakeClientGenerator) ClientFor(kind resource.Kind) (resource.Client, error) {
|
||||
return &fakeResourceClient{client: f.client}, nil
|
||||
}
|
||||
|
||||
type fakeResourceClient struct {
|
||||
client *fakePluginInstallClient
|
||||
}
|
||||
|
||||
func (f *fakeResourceClient) Get(ctx context.Context, identifier resource.Identifier) (resource.Object, error) {
|
||||
return f.client.Get(ctx, identifier)
|
||||
}
|
||||
|
||||
func (f *fakeResourceClient) GetInto(ctx context.Context, identifier resource.Identifier, into resource.Object) error {
|
||||
obj, err := f.client.Get(ctx, identifier)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// Copy the object data into the provided 'into' object
|
||||
if target, ok := into.(*pluginsv0alpha1.PluginInstall); ok {
|
||||
*target = *obj
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (f *fakeResourceClient) List(ctx context.Context, namespace string, options resource.ListOptions) (resource.ListObject, error) {
|
||||
return f.client.ListAll(ctx, namespace, options)
|
||||
}
|
||||
|
||||
func (f *fakeResourceClient) ListInto(ctx context.Context, namespace string, options resource.ListOptions, into resource.ListObject) error {
|
||||
list, err := f.client.ListAll(ctx, namespace, options)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// Copy the list data into the provided 'into' object
|
||||
if target, ok := into.(*pluginsv0alpha1.PluginInstallList); ok {
|
||||
*target = *list
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (f *fakeResourceClient) Create(ctx context.Context, identifier resource.Identifier, obj resource.Object, options resource.CreateOptions) (resource.Object, error) {
|
||||
plugin := obj.(*pluginsv0alpha1.PluginInstall)
|
||||
return f.client.Create(ctx, plugin, options)
|
||||
}
|
||||
|
||||
func (f *fakeResourceClient) CreateInto(ctx context.Context, identifier resource.Identifier, obj resource.Object, options resource.CreateOptions, into resource.Object) error {
|
||||
created, err := f.Create(ctx, identifier, obj, options)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// Copy the created object data into the provided 'into' object
|
||||
if plugin, ok := created.(*pluginsv0alpha1.PluginInstall); ok {
|
||||
if target, ok := into.(*pluginsv0alpha1.PluginInstall); ok {
|
||||
*target = *plugin
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (f *fakeResourceClient) Update(ctx context.Context, identifier resource.Identifier, obj resource.Object, options resource.UpdateOptions) (resource.Object, error) {
|
||||
plugin := obj.(*pluginsv0alpha1.PluginInstall)
|
||||
return f.client.Update(ctx, plugin, options)
|
||||
}
|
||||
|
||||
func (f *fakeResourceClient) UpdateInto(ctx context.Context, identifier resource.Identifier, obj resource.Object, options resource.UpdateOptions, into resource.Object) error {
|
||||
updated, err := f.Update(ctx, identifier, obj, options)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// Copy the updated object data into the provided 'into' object
|
||||
if plugin, ok := updated.(*pluginsv0alpha1.PluginInstall); ok {
|
||||
if target, ok := into.(*pluginsv0alpha1.PluginInstall); ok {
|
||||
*target = *plugin
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (f *fakeResourceClient) Patch(ctx context.Context, identifier resource.Identifier, patch resource.PatchRequest, options resource.PatchOptions) (resource.Object, error) {
|
||||
return f.client.Patch(ctx, identifier, patch, options)
|
||||
}
|
||||
|
||||
func (f *fakeResourceClient) PatchInto(ctx context.Context, identifier resource.Identifier, patch resource.PatchRequest, options resource.PatchOptions, into resource.Object) error {
|
||||
patched, err := f.Patch(ctx, identifier, patch, options)
|
||||
if err != nil {
|
||||
return err
|
||||
}
|
||||
// Copy the patched object data into the provided 'into' object
|
||||
if plugin, ok := patched.(*pluginsv0alpha1.PluginInstall); ok {
|
||||
if target, ok := into.(*pluginsv0alpha1.PluginInstall); ok {
|
||||
*target = *plugin
|
||||
}
|
||||
}
|
||||
return nil
|
||||
}
|
||||
|
||||
func (f *fakeResourceClient) Delete(ctx context.Context, identifier resource.Identifier, options resource.DeleteOptions) error {
|
||||
return f.client.Delete(ctx, identifier, options)
|
||||
}
|
||||
|
||||
func (f *fakeResourceClient) SubresourceRequest(ctx context.Context, identifier resource.Identifier, req resource.CustomRouteRequestOptions) ([]byte, error) {
|
||||
return []byte{}, nil
|
||||
}
|
||||
|
||||
func (f *fakeResourceClient) Watch(ctx context.Context, namespace string, options resource.WatchOptions) (resource.WatchResponse, error) {
|
||||
return &fakeWatchResponse{}, nil
|
||||
}
|
||||
|
||||
type fakeWatchResponse struct{}
|
||||
|
||||
func (f *fakeWatchResponse) Stop() {}
|
||||
|
||||
func (f *fakeWatchResponse) WatchEvents() <-chan resource.WatchEvent {
|
||||
ch := make(chan resource.WatchEvent)
|
||||
close(ch)
|
||||
return ch
|
||||
}
|
||||
|
||||
func TestSyncer_Sync(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
featureToggleEnabled bool
|
||||
orgs []*org.OrgDTO
|
||||
orgServiceError error
|
||||
serverLockError error
|
||||
expectedError error
|
||||
expectSyncCalls int
|
||||
}{
|
||||
{
|
||||
name: "feature toggle disabled",
|
||||
featureToggleEnabled: false,
|
||||
orgs: []*org.OrgDTO{{ID: 1, Name: "Org 1"}},
|
||||
expectedError: nil,
|
||||
expectSyncCalls: 0,
|
||||
},
|
||||
{
|
||||
name: "feature toggle enabled, no orgs",
|
||||
featureToggleEnabled: true,
|
||||
orgs: []*org.OrgDTO{},
|
||||
expectedError: nil,
|
||||
expectSyncCalls: 0,
|
||||
},
|
||||
{
|
||||
name: "feature toggle enabled, single org",
|
||||
featureToggleEnabled: true,
|
||||
orgs: []*org.OrgDTO{{ID: 1, Name: "Org 1"}},
|
||||
expectedError: nil,
|
||||
expectSyncCalls: 1,
|
||||
},
|
||||
{
|
||||
name: "feature toggle enabled, multiple orgs",
|
||||
featureToggleEnabled: true,
|
||||
orgs: []*org.OrgDTO{
|
||||
{ID: 1, Name: "Org 1"},
|
||||
{ID: 2, Name: "Org 2"},
|
||||
{ID: 3, Name: "Org 3"},
|
||||
},
|
||||
expectedError: nil,
|
||||
expectSyncCalls: 3,
|
||||
},
|
||||
{
|
||||
name: "org service error",
|
||||
featureToggleEnabled: true,
|
||||
orgs: nil,
|
||||
orgServiceError: errors.New("org service error"),
|
||||
expectedError: errors.New("org service error"),
|
||||
expectSyncCalls: 0,
|
||||
},
|
||||
{
|
||||
name: "server lock error",
|
||||
featureToggleEnabled: true,
|
||||
orgs: []*org.OrgDTO{{ID: 1, Name: "Org 1"}},
|
||||
serverLockError: errors.New("lock error"),
|
||||
expectedError: errors.New("lock error"),
|
||||
expectSyncCalls: 0,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
|
||||
// Setup feature toggles
|
||||
ft := featuremgmt.NewMockFeatureToggles(t)
|
||||
ft.EXPECT().IsEnabled(ctx, featuremgmt.FlagPluginInstallAPISync).Return(tt.featureToggleEnabled).Maybe()
|
||||
|
||||
// Setup org service
|
||||
orgService := orgtest.NewOrgServiceFake()
|
||||
orgService.ExpectedOrgs = tt.orgs
|
||||
orgService.ExpectedError = tt.orgServiceError
|
||||
|
||||
// Setup server lock
|
||||
serverLock := &fakeServerLock{}
|
||||
if tt.serverLockError != nil {
|
||||
serverLock.lockFunc = func(ctx context.Context, actionName string, maxInterval time.Duration, fn func(ctx context.Context)) error {
|
||||
return tt.serverLockError
|
||||
}
|
||||
}
|
||||
|
||||
// Setup fake client and registrar
|
||||
syncCalls := 0
|
||||
fakeClient := &fakePluginInstallClient{
|
||||
createFunc: func(ctx context.Context, obj *pluginsv0alpha1.PluginInstall, opts resource.CreateOptions) (*pluginsv0alpha1.PluginInstall, error) {
|
||||
syncCalls++
|
||||
return obj, nil
|
||||
},
|
||||
listAllFunc: func(ctx context.Context, namespace string, opts resource.ListOptions) (*pluginsv0alpha1.PluginInstallList, error) {
|
||||
return &pluginsv0alpha1.PluginInstallList{}, nil
|
||||
},
|
||||
}
|
||||
clientGen := &fakeClientGenerator{client: fakeClient}
|
||||
registrar := install.NewInstallRegistrar(clientGen)
|
||||
|
||||
// Create syncer
|
||||
s := newSyncer(
|
||||
ft,
|
||||
clientGen,
|
||||
registrar,
|
||||
orgService,
|
||||
func(orgID int64) string { return "org-1" },
|
||||
serverLock,
|
||||
)
|
||||
|
||||
// Execute
|
||||
installedPlugins := []*plugins.Plugin{
|
||||
{JSONData: plugins.JSONData{ID: "test-plugin", Info: plugins.Info{Version: "1.0.0"}}},
|
||||
}
|
||||
err := s.Sync(ctx, install.SourcePluginStore, installedPlugins)
|
||||
|
||||
// Verify
|
||||
if tt.expectedError != nil {
|
||||
require.Error(t, err)
|
||||
require.Equal(t, tt.expectedError.Error(), err.Error())
|
||||
} else {
|
||||
require.NoError(t, err)
|
||||
}
|
||||
|
||||
require.Equal(t, tt.expectSyncCalls, syncCalls)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestSyncer_syncNamespace(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
installedPlugins []*plugins.Plugin
|
||||
apiPlugins []pluginsv0alpha1.PluginInstall
|
||||
clientListError error
|
||||
expectedError error
|
||||
expectedRegCalls int
|
||||
expectedUnregCalls int
|
||||
registeredIDs []string
|
||||
unregisteredIDs []string
|
||||
}{
|
||||
{
|
||||
name: "no installed plugins, no API plugins",
|
||||
installedPlugins: []*plugins.Plugin{},
|
||||
apiPlugins: []pluginsv0alpha1.PluginInstall{},
|
||||
expectedError: nil,
|
||||
expectedRegCalls: 0,
|
||||
expectedUnregCalls: 0,
|
||||
},
|
||||
{
|
||||
name: "installed plugins only",
|
||||
installedPlugins: []*plugins.Plugin{
|
||||
{JSONData: plugins.JSONData{ID: "plugin-1", Info: plugins.Info{Version: "1.0.0"}}, Class: plugins.ClassCore},
|
||||
{JSONData: plugins.JSONData{ID: "plugin-2", Info: plugins.Info{Version: "2.0.0"}}, Class: plugins.ClassExternal},
|
||||
},
|
||||
apiPlugins: []pluginsv0alpha1.PluginInstall{},
|
||||
expectedError: nil,
|
||||
expectedRegCalls: 2,
|
||||
expectedUnregCalls: 0,
|
||||
registeredIDs: []string{"plugin-1", "plugin-2"},
|
||||
},
|
||||
{
|
||||
name: "API plugins only",
|
||||
installedPlugins: []*plugins.Plugin{},
|
||||
apiPlugins: []pluginsv0alpha1.PluginInstall{
|
||||
{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Name: "plugin-1",
|
||||
Annotations: map[string]string{
|
||||
install.PluginInstallSourceAnnotation: install.SourcePluginStore,
|
||||
},
|
||||
},
|
||||
Spec: pluginsv0alpha1.PluginInstallSpec{Id: "plugin-1"},
|
||||
},
|
||||
{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Name: "plugin-2",
|
||||
Annotations: map[string]string{
|
||||
install.PluginInstallSourceAnnotation: install.SourcePluginStore,
|
||||
},
|
||||
},
|
||||
Spec: pluginsv0alpha1.PluginInstallSpec{Id: "plugin-2"},
|
||||
},
|
||||
},
|
||||
expectedError: nil,
|
||||
expectedRegCalls: 0,
|
||||
expectedUnregCalls: 2,
|
||||
unregisteredIDs: []string{"plugin-1", "plugin-2"},
|
||||
},
|
||||
{
|
||||
name: "mixed - some match",
|
||||
installedPlugins: []*plugins.Plugin{
|
||||
{JSONData: plugins.JSONData{ID: "plugin-1", Info: plugins.Info{Version: "1.0.0"}}, Class: plugins.ClassCore},
|
||||
{JSONData: plugins.JSONData{ID: "plugin-2", Info: plugins.Info{Version: "2.0.0"}}, Class: plugins.ClassExternal},
|
||||
{JSONData: plugins.JSONData{ID: "plugin-3", Info: plugins.Info{Version: "3.0.0"}}, Class: plugins.ClassExternal},
|
||||
},
|
||||
apiPlugins: []pluginsv0alpha1.PluginInstall{
|
||||
{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Name: "plugin-2",
|
||||
Annotations: map[string]string{
|
||||
install.PluginInstallSourceAnnotation: install.SourcePluginStore,
|
||||
},
|
||||
},
|
||||
Spec: pluginsv0alpha1.PluginInstallSpec{Id: "plugin-2", Version: "2.0.0"},
|
||||
},
|
||||
{
|
||||
ObjectMeta: metav1.ObjectMeta{
|
||||
Name: "plugin-4",
|
||||
Annotations: map[string]string{
|
||||
install.PluginInstallSourceAnnotation: install.SourcePluginStore,
|
||||
},
|
||||
},
|
||||
Spec: pluginsv0alpha1.PluginInstallSpec{Id: "plugin-4"},
|
||||
},
|
||||
},
|
||||
expectedError: nil,
|
||||
expectedRegCalls: 2, // plugin-1 and plugin-3 are new, plugin-2 already exists
|
||||
expectedUnregCalls: 1, // plugin-4 removed
|
||||
registeredIDs: []string{"plugin-1", "plugin-3"},
|
||||
unregisteredIDs: []string{"plugin-4"},
|
||||
},
|
||||
{
|
||||
name: "list error",
|
||||
installedPlugins: []*plugins.Plugin{},
|
||||
apiPlugins: []pluginsv0alpha1.PluginInstall{},
|
||||
clientListError: errors.New("list error"),
|
||||
expectedError: errors.New("list error"),
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
|
||||
// Track calls
|
||||
var registeredIDs []string
|
||||
var unregisteredIDs []string
|
||||
|
||||
// Setup fake client
|
||||
fakeClient := &fakePluginInstallClient{
|
||||
listAllFunc: func(ctx context.Context, namespace string, opts resource.ListOptions) (*pluginsv0alpha1.PluginInstallList, error) {
|
||||
if tt.clientListError != nil {
|
||||
return nil, tt.clientListError
|
||||
}
|
||||
return &pluginsv0alpha1.PluginInstallList{
|
||||
Items: tt.apiPlugins,
|
||||
}, nil
|
||||
},
|
||||
createFunc: func(ctx context.Context, obj *pluginsv0alpha1.PluginInstall, opts resource.CreateOptions) (*pluginsv0alpha1.PluginInstall, error) {
|
||||
registeredIDs = append(registeredIDs, obj.Spec.Id)
|
||||
return obj, nil
|
||||
},
|
||||
deleteFunc: func(ctx context.Context, identifier resource.Identifier, opts resource.DeleteOptions) error {
|
||||
unregisteredIDs = append(unregisteredIDs, identifier.Name)
|
||||
return nil
|
||||
},
|
||||
getFunc: func(ctx context.Context, identifier resource.Identifier) (*pluginsv0alpha1.PluginInstall, error) {
|
||||
// Check if plugin exists in apiPlugins
|
||||
for i := range tt.apiPlugins {
|
||||
if tt.apiPlugins[i].Name == identifier.Name {
|
||||
return &tt.apiPlugins[i], nil
|
||||
}
|
||||
}
|
||||
return nil, errorsK8s.NewNotFound(schema.GroupResource{
|
||||
Group: pluginsv0alpha1.APIGroup,
|
||||
Resource: "plugininstalls",
|
||||
}, identifier.Name)
|
||||
},
|
||||
}
|
||||
|
||||
clientGen := &fakeClientGenerator{client: fakeClient}
|
||||
registrar := install.NewInstallRegistrar(clientGen)
|
||||
|
||||
// Create syncer
|
||||
s := newSyncer(
|
||||
featuremgmt.NewMockFeatureToggles(t),
|
||||
clientGen,
|
||||
registrar,
|
||||
orgtest.NewOrgServiceFake(),
|
||||
func(orgID int64) string { return "org-1" },
|
||||
&fakeServerLock{},
|
||||
)
|
||||
|
||||
// Execute
|
||||
err := s.syncNamespace(ctx, "org-1", install.SourcePluginStore, tt.installedPlugins)
|
||||
|
||||
// Verify
|
||||
if tt.expectedError != nil {
|
||||
require.Error(t, err)
|
||||
require.Contains(t, err.Error(), tt.expectedError.Error())
|
||||
} else {
|
||||
require.NoError(t, err)
|
||||
}
|
||||
|
||||
if tt.expectedRegCalls > 0 {
|
||||
require.Len(t, registeredIDs, tt.expectedRegCalls)
|
||||
if tt.registeredIDs != nil {
|
||||
require.ElementsMatch(t, tt.registeredIDs, registeredIDs)
|
||||
}
|
||||
}
|
||||
|
||||
if tt.expectedUnregCalls > 0 {
|
||||
require.Len(t, unregisteredIDs, tt.expectedUnregCalls)
|
||||
if tt.unregisteredIDs != nil {
|
||||
require.ElementsMatch(t, tt.unregisteredIDs, unregisteredIDs)
|
||||
}
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestSyncer_getClient(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
}{
|
||||
{
|
||||
name: "first call success and subsequent calls return cached client",
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
fakeClient := &fakePluginInstallClient{}
|
||||
clientGen := &fakeClientGenerator{client: fakeClient}
|
||||
|
||||
s := newSyncer(
|
||||
featuremgmt.NewMockFeatureToggles(t),
|
||||
clientGen,
|
||||
install.NewInstallRegistrar(clientGen),
|
||||
orgtest.NewOrgServiceFake(),
|
||||
func(orgID int64) string { return "org-1" },
|
||||
&fakeServerLock{},
|
||||
)
|
||||
|
||||
// First call
|
||||
client1, err1 := s.installRegistrar.GetClient()
|
||||
require.NoError(t, err1)
|
||||
require.NotNil(t, client1)
|
||||
|
||||
// Second call should return cached client
|
||||
client2, err2 := s.installRegistrar.GetClient()
|
||||
require.NoError(t, err2)
|
||||
require.NotNil(t, client2)
|
||||
// Both calls should return the same client instance
|
||||
require.Equal(t, client1, client2)
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
func TestSyncer_syncAllNamespaces(t *testing.T) {
|
||||
tests := []struct {
|
||||
name string
|
||||
orgs []*org.OrgDTO
|
||||
orgServiceError error
|
||||
expectedError error
|
||||
expectedCalls int
|
||||
}{
|
||||
{
|
||||
name: "no orgs",
|
||||
orgs: []*org.OrgDTO{},
|
||||
expectedError: nil,
|
||||
expectedCalls: 0,
|
||||
},
|
||||
{
|
||||
name: "single org",
|
||||
orgs: []*org.OrgDTO{
|
||||
{ID: 1, Name: "Org 1"},
|
||||
},
|
||||
expectedError: nil,
|
||||
expectedCalls: 1,
|
||||
},
|
||||
{
|
||||
name: "multiple orgs",
|
||||
orgs: []*org.OrgDTO{
|
||||
{ID: 1, Name: "Org 1"},
|
||||
{ID: 2, Name: "Org 2"},
|
||||
{ID: 3, Name: "Org 3"},
|
||||
},
|
||||
expectedError: nil,
|
||||
expectedCalls: 3,
|
||||
},
|
||||
{
|
||||
name: "org service error",
|
||||
orgs: nil,
|
||||
orgServiceError: errors.New("org service error"),
|
||||
expectedError: errors.New("org service error"),
|
||||
expectedCalls: 0,
|
||||
},
|
||||
}
|
||||
|
||||
for _, tt := range tests {
|
||||
t.Run(tt.name, func(t *testing.T) {
|
||||
ctx := context.Background()
|
||||
|
||||
orgService := orgtest.NewOrgServiceFake()
|
||||
orgService.ExpectedOrgs = tt.orgs
|
||||
orgService.ExpectedError = tt.orgServiceError
|
||||
|
||||
// Track namespace sync calls
|
||||
syncCalls := 0
|
||||
fakeClient := &fakePluginInstallClient{
|
||||
createFunc: func(ctx context.Context, obj *pluginsv0alpha1.PluginInstall, opts resource.CreateOptions) (*pluginsv0alpha1.PluginInstall, error) {
|
||||
syncCalls++
|
||||
return obj, nil
|
||||
},
|
||||
listAllFunc: func(ctx context.Context, namespace string, opts resource.ListOptions) (*pluginsv0alpha1.PluginInstallList, error) {
|
||||
return &pluginsv0alpha1.PluginInstallList{}, nil
|
||||
},
|
||||
}
|
||||
|
||||
clientGen := &fakeClientGenerator{client: fakeClient}
|
||||
|
||||
s := newSyncer(
|
||||
featuremgmt.NewMockFeatureToggles(t),
|
||||
clientGen,
|
||||
install.NewInstallRegistrar(clientGen),
|
||||
orgService,
|
||||
func(orgID int64) string { return "org-1" },
|
||||
&fakeServerLock{},
|
||||
)
|
||||
|
||||
installedPlugins := []*plugins.Plugin{
|
||||
{JSONData: plugins.JSONData{ID: "test-plugin", Info: plugins.Info{Version: "1.0.0"}}, Class: plugins.ClassCore},
|
||||
}
|
||||
|
||||
err := s.syncAllNamespaces(ctx, install.SourcePluginStore, installedPlugins)
|
||||
|
||||
if tt.expectedError != nil {
|
||||
require.Error(t, err)
|
||||
require.Equal(t, tt.expectedError.Error(), err.Error())
|
||||
} else {
|
||||
require.NoError(t, err)
|
||||
}
|
||||
|
||||
require.Equal(t, tt.expectedCalls, syncCalls)
|
||||
})
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user