Plugins Admin: Avoid disabling auto-enabled apps (#97800)

This commit is contained in:
Andres Martinez Gotor
2024-12-16 14:51:04 +01:00
committed by GitHub
parent 7601bcbb5d
commit 95dea152b6
10 changed files with 196 additions and 4 deletions
@@ -19,6 +19,7 @@ func Provision(ctx context.Context, configDirectory string, pluginStore pluginst
cfgProvider: newConfigReader(logger, pluginStore),
pluginSettings: pluginSettings,
orgService: orgService,
pluginStore: pluginStore,
}
return ap.applyChanges(ctx, configDirectory)
}
@@ -30,6 +31,7 @@ type PluginProvisioner struct {
cfgProvider configReader
pluginSettings pluginsettings.Service
orgService org.Service
pluginStore pluginstore.Store
}
func (ap *PluginProvisioner) apply(ctx context.Context, cfg *pluginsAsConfig) error {
@@ -45,6 +47,14 @@ func (ap *PluginProvisioner) apply(ctx context.Context, cfg *pluginsAsConfig) er
app.OrgID = 1
}
p, found := ap.pluginStore.Plugin(ctx, app.PluginID)
if !found {
return errors.New("plugin not found")
}
if p.AutoEnabled && !app.Enabled {
return errors.New("plugin is auto enabled and cannot be disabled")
}
ps, err := ap.pluginSettings.GetPluginSettingByPluginID(ctx, &pluginsettings.GetByPluginIDArgs{
OrgID: app.OrgID,
PluginID: app.PluginID,
@@ -8,9 +8,11 @@ import (
"github.com/stretchr/testify/require"
"github.com/grafana/grafana/pkg/infra/log"
"github.com/grafana/grafana/pkg/plugins"
"github.com/grafana/grafana/pkg/services/org"
"github.com/grafana/grafana/pkg/services/org/orgtest"
"github.com/grafana/grafana/pkg/services/pluginsintegration/pluginsettings"
"github.com/grafana/grafana/pkg/services/pluginsintegration/pluginstore"
)
func TestPluginProvisioner(t *testing.T) {
@@ -37,7 +39,16 @@ func TestPluginProvisioner(t *testing.T) {
store := &mockStore{}
orgMock := orgtest.NewOrgServiceFake()
orgMock.ExpectedOrg = &org.Org{ID: 4}
ap := PluginProvisioner{log: log.New("test"), cfgProvider: reader, pluginSettings: store, orgService: orgMock}
ap := PluginProvisioner{
log: log.New("test"),
cfgProvider: reader,
pluginSettings: store,
orgService: orgMock,
pluginStore: pluginstore.NewFakePluginStore(
pluginstore.Plugin{JSONData: plugins.JSONData{ID: "test-plugin"}},
pluginstore.Plugin{JSONData: plugins.JSONData{ID: "test-plugin-2"}},
),
}
err := ap.applyChanges(context.Background(), "")
require.NoError(t, err)
@@ -68,6 +79,30 @@ func TestPluginProvisioner(t *testing.T) {
require.Equal(t, tc.ExpectedSecureJSONData, cmd.SecureJSONData)
}
})
t.Run("Should return error trying to disable an auto-enabled plugin", func(t *testing.T) {
cfg := []*pluginsAsConfig{
{
Apps: []*appFromConfig{
{PluginID: "test-plugin", OrgID: 2, Enabled: false},
},
},
}
reader := &testConfigReader{result: cfg}
store := &mockStore{}
ap := PluginProvisioner{
log: log.New("test"),
cfgProvider: reader,
pluginSettings: store,
pluginStore: pluginstore.NewFakePluginStore(
pluginstore.Plugin{JSONData: plugins.JSONData{ID: "test-plugin", AutoEnabled: true}},
),
}
err := ap.applyChanges(context.Background(), "")
require.Error(t, err)
require.Contains(t, err.Error(), "plugin is auto enabled and cannot be disabled")
})
}
type testConfigReader struct {