mirror of
https://github.com/grafana/grafana.git
synced 2024-12-01 21:19:28 -06:00
277ea836b6
* initial cut at migration from plugin * create new migration from plugin * only migrate to or from, not both * remove cfg check from plugin migration itself * update comments, clean up secret after migration * add better error handling * hook up REST API with migrations * Minor fixes * fix wire injection issue * modify migrator to access plugin calls directly. create unit tests * change pre-migration checks in admin api * stop plugin after migrating from it * fix compile issues after merge * add comment about migration * fix linting issue * bleh, fix unit test * fix another unit test * update plugin error fatal flag after a migration from the plugin * add extra logging to migration * make linter happy Co-authored-by: Leandro Deveikis <leandro.deveikis@gmail.com>
108 lines
3.6 KiB
Go
108 lines
3.6 KiB
Go
package kvstore
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
|
|
"github.com/grafana/grafana/pkg/infra/kvstore"
|
|
"github.com/grafana/grafana/pkg/infra/log"
|
|
"github.com/grafana/grafana/pkg/services/secrets/fakes"
|
|
secretsManager "github.com/grafana/grafana/pkg/services/secrets/manager"
|
|
"github.com/grafana/grafana/pkg/services/sqlstore"
|
|
"github.com/grafana/grafana/pkg/setting"
|
|
"github.com/stretchr/testify/require"
|
|
"gopkg.in/ini.v1"
|
|
)
|
|
|
|
// This tests will create a mock sql database and an inmemory
|
|
// implementation of the secret manager to simulate the plugin.
|
|
func TestPluginSecretMigrationService_MigrateToPlugin(t *testing.T) {
|
|
ctx := context.Background()
|
|
|
|
t.Run("migration run ok - 2 secrets migrated", func(t *testing.T) {
|
|
// --- SETUP
|
|
migratorService, secretsStore, sqlSecretStore := setupTestMigrateToPluginService(t)
|
|
var orgId int64 = 1
|
|
namespace1, namespace2 := "namespace-test", "namespace-test2"
|
|
typ := "type-test"
|
|
value := "SUPER_SECRET"
|
|
|
|
addSecretToSqlStore(t, sqlSecretStore, ctx, orgId, namespace1, typ, value)
|
|
addSecretToSqlStore(t, sqlSecretStore, ctx, orgId, namespace2, typ, value)
|
|
|
|
// --- EXECUTION
|
|
err := migratorService.Migrate(ctx)
|
|
require.NoError(t, err)
|
|
|
|
// --- VALIDATIONS
|
|
validateSqlSecretWasDeleted(t, sqlSecretStore, ctx, orgId, namespace1, typ)
|
|
validateSqlSecretWasDeleted(t, sqlSecretStore, ctx, orgId, namespace2, typ)
|
|
|
|
validateSecretWasStoredInPlugin(t, secretsStore, ctx, orgId, namespace1, typ)
|
|
validateSecretWasStoredInPlugin(t, secretsStore, ctx, orgId, namespace1, typ)
|
|
})
|
|
}
|
|
|
|
func addSecretToSqlStore(t *testing.T, sqlSecretStore *secretsKVStoreSQL, ctx context.Context, orgId int64, namespace1 string, typ string, value string) {
|
|
t.Helper()
|
|
err := sqlSecretStore.Set(ctx, orgId, namespace1, typ, value)
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
// validates that secrets on the sql store were deleted.
|
|
func validateSqlSecretWasDeleted(t *testing.T, sqlSecretStore *secretsKVStoreSQL, ctx context.Context, orgId int64, namespace1 string, typ string) {
|
|
t.Helper()
|
|
res, err := sqlSecretStore.Keys(ctx, orgId, namespace1, typ)
|
|
require.NoError(t, err)
|
|
require.Equal(t, 0, len(res))
|
|
}
|
|
|
|
// validates that secrets should be on the plugin
|
|
func validateSecretWasStoredInPlugin(t *testing.T, secretsStore SecretsKVStore, ctx context.Context, orgId int64, namespace1 string, typ string) {
|
|
t.Helper()
|
|
resPlugin, err := secretsStore.Keys(ctx, orgId, namespace1, typ)
|
|
require.NoError(t, err)
|
|
require.Equal(t, 1, len(resPlugin))
|
|
}
|
|
|
|
// Set up services used in migration
|
|
func setupTestMigrateToPluginService(t *testing.T) (*MigrateToPluginService, SecretsKVStore, *secretsKVStoreSQL) {
|
|
t.Helper()
|
|
|
|
rawCfg := `
|
|
[secrets]
|
|
use_plugin = true
|
|
`
|
|
raw, err := ini.Load([]byte(rawCfg))
|
|
require.NoError(t, err)
|
|
cfg := &setting.Cfg{Raw: raw}
|
|
// this would be the plugin - mocked at the moment
|
|
secretsStoreForPlugin := NewFakeSecretsKVStore()
|
|
|
|
// this is to init the sql secret store inside the migration
|
|
sqlStore := sqlstore.InitTestDB(t)
|
|
secretsService := secretsManager.SetupTestService(t, fakes.NewFakeSecretsStore())
|
|
manager := NewFakeSecretsPluginManager(t, false)
|
|
migratorService := ProvideMigrateToPluginService(
|
|
secretsStoreForPlugin,
|
|
cfg,
|
|
sqlStore,
|
|
secretsService,
|
|
kvstore.ProvideService(sqlStore),
|
|
manager,
|
|
)
|
|
|
|
secretsSql := &secretsKVStoreSQL{
|
|
sqlStore: sqlStore,
|
|
secretsService: secretsService,
|
|
log: log.New("test.logger"),
|
|
decryptionCache: decryptionCache{
|
|
cache: make(map[int64]cachedDecrypted),
|
|
},
|
|
}
|
|
|
|
err = secretsStoreForPlugin.SetFallback(secretsSql)
|
|
require.NoError(t, err)
|
|
return migratorService, secretsStoreForPlugin, secretsSql
|
|
}
|