2e2b1cd9e4
* refactor SSOSettings to use types * test struct * refactor SSOSettings struct to use types * fix database tests * fix populateSSOSettings() to accept an SSOSettings param * fix all tests from the database layer * handle errors for converting to/from SSOSettings * add json tag on OAuthInfo fields * use continue instead of if/else * add the source field to SSOSettingsDTO conversion * remove omitempty from json tags in OAuthInfo struct
446 lines
12 KiB
Go
446 lines
12 KiB
Go
package database
|
|
|
|
import (
|
|
"context"
|
|
"testing"
|
|
"time"
|
|
|
|
"github.com/google/uuid"
|
|
"github.com/stretchr/testify/require"
|
|
|
|
"github.com/grafana/grafana/pkg/infra/db"
|
|
"github.com/grafana/grafana/pkg/login/social"
|
|
"github.com/grafana/grafana/pkg/services/sqlstore"
|
|
"github.com/grafana/grafana/pkg/services/ssosettings"
|
|
"github.com/grafana/grafana/pkg/services/ssosettings/models"
|
|
)
|
|
|
|
func TestIntegrationGetSSOSettings(t *testing.T) {
|
|
if testing.Short() {
|
|
t.Skip("skipping integration test")
|
|
}
|
|
|
|
var sqlStore *sqlstore.SQLStore
|
|
var ssoSettingsStore *SSOSettingsStore
|
|
|
|
setup := func() {
|
|
sqlStore = db.InitTestDB(t)
|
|
ssoSettingsStore = ProvideStore(sqlStore)
|
|
|
|
template := models.SSOSettings{
|
|
OAuthSettings: &social.OAuthInfo{
|
|
Enabled: true,
|
|
},
|
|
}
|
|
err := populateSSOSettings(sqlStore, template, "azuread")
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
t.Run("returns existing SSO settings", func(t *testing.T) {
|
|
setup()
|
|
|
|
expected := &models.SSOSettings{
|
|
Provider: "azuread",
|
|
OAuthSettings: &social.OAuthInfo{Enabled: true},
|
|
}
|
|
|
|
actual, err := ssoSettingsStore.Get(context.Background(), "azuread")
|
|
require.NoError(t, err)
|
|
|
|
require.Equal(t, expected.OAuthSettings, actual.OAuthSettings)
|
|
})
|
|
|
|
t.Run("returns not found if the SSO setting is missing for the specified provider", func(t *testing.T) {
|
|
setup()
|
|
|
|
_, err := ssoSettingsStore.Get(context.Background(), "okta")
|
|
require.ErrorAs(t, err, &ssosettings.ErrNotFound)
|
|
})
|
|
|
|
t.Run("returns not found if the SSO setting is soft deleted for the specified provider", func(t *testing.T) {
|
|
setup()
|
|
err := ssoSettingsStore.Delete(context.Background(), "azuread")
|
|
require.NoError(t, err)
|
|
|
|
_, err = ssoSettingsStore.Get(context.Background(), "azuread")
|
|
require.ErrorAs(t, err, &ssosettings.ErrNotFound)
|
|
})
|
|
}
|
|
|
|
func TestIntegrationUpsertSSOSettings(t *testing.T) {
|
|
if testing.Short() {
|
|
t.Skip("skipping integration test")
|
|
}
|
|
|
|
var sqlStore *sqlstore.SQLStore
|
|
var ssoSettingsStore *SSOSettingsStore
|
|
|
|
setup := func() {
|
|
sqlStore = db.InitTestDB(t)
|
|
ssoSettingsStore = ProvideStore(sqlStore)
|
|
}
|
|
|
|
t.Run("insert a new SSO setting successfully", func(t *testing.T) {
|
|
setup()
|
|
|
|
mockTimeNow(time.Now())
|
|
defer resetTimeNow()
|
|
|
|
settings := models.SSOSettings{
|
|
Provider: "azuread",
|
|
OAuthSettings: &social.OAuthInfo{
|
|
Enabled: true,
|
|
ClientId: "azuread-client",
|
|
},
|
|
}
|
|
|
|
err := ssoSettingsStore.Upsert(context.Background(), settings)
|
|
require.NoError(t, err)
|
|
|
|
actual, err := getSSOSettingsByProvider(sqlStore, settings.Provider, false)
|
|
require.NoError(t, err)
|
|
require.EqualValues(t, settings.OAuthSettings, actual.OAuthSettings)
|
|
require.NotEmpty(t, actual.ID)
|
|
require.Equal(t, formatTime(timeNow().UTC()), formatTime(actual.Created))
|
|
require.Equal(t, formatTime(timeNow().UTC()), formatTime(actual.Updated))
|
|
|
|
deleted, notDeleted, err := getSSOSettingsCountByDeleted(sqlStore)
|
|
require.NoError(t, err)
|
|
require.EqualValues(t, 0, deleted)
|
|
require.EqualValues(t, 1, notDeleted)
|
|
})
|
|
|
|
t.Run("replaces an existing SSO setting for the specified provider", func(t *testing.T) {
|
|
setup()
|
|
|
|
mockTimeNow(time.Now())
|
|
defer resetTimeNow()
|
|
|
|
provider := "github"
|
|
template := models.SSOSettings{
|
|
OAuthSettings: &social.OAuthInfo{
|
|
Enabled: true,
|
|
ClientId: "github-client",
|
|
ClientSecret: "this-is-a-secret",
|
|
},
|
|
}
|
|
err := populateSSOSettings(sqlStore, template, provider)
|
|
require.NoError(t, err)
|
|
|
|
newSettings := models.SSOSettings{
|
|
Provider: provider,
|
|
OAuthSettings: &social.OAuthInfo{
|
|
Enabled: true,
|
|
ClientId: "new-github-client",
|
|
ClientSecret: "this-is-a-new-secret",
|
|
},
|
|
}
|
|
err = ssoSettingsStore.Upsert(context.Background(), newSettings)
|
|
require.NoError(t, err)
|
|
|
|
actual, err := getSSOSettingsByProvider(sqlStore, provider, false)
|
|
require.NoError(t, err)
|
|
require.Equal(t, newSettings.OAuthSettings, actual.OAuthSettings)
|
|
require.Equal(t, formatTime(timeNow().UTC()), formatTime(actual.Updated))
|
|
|
|
deleted, notDeleted, err := getSSOSettingsCountByDeleted(sqlStore)
|
|
require.NoError(t, err)
|
|
require.EqualValues(t, 0, deleted)
|
|
require.EqualValues(t, 1, notDeleted)
|
|
})
|
|
|
|
t.Run("trying to update a deleted SSO Settings will insert a new record", func(t *testing.T) {
|
|
setup()
|
|
|
|
mockTimeNow(time.Now())
|
|
defer resetTimeNow()
|
|
|
|
provider := "azuread"
|
|
template := models.SSOSettings{
|
|
OAuthSettings: &social.OAuthInfo{
|
|
Enabled: true,
|
|
ClientId: "azuread-client",
|
|
ClientSecret: "this-is-a-secret",
|
|
},
|
|
IsDeleted: true,
|
|
}
|
|
err := populateSSOSettings(sqlStore, template, provider)
|
|
require.NoError(t, err)
|
|
|
|
newSettings := models.SSOSettings{
|
|
Provider: provider,
|
|
OAuthSettings: &social.OAuthInfo{
|
|
Enabled: true,
|
|
ClientId: "new-azuread-client",
|
|
ClientSecret: "this-is-a-new-secret",
|
|
},
|
|
}
|
|
|
|
err = ssoSettingsStore.Upsert(context.Background(), newSettings)
|
|
require.NoError(t, err)
|
|
|
|
actual, err := getSSOSettingsByProvider(sqlStore, provider, false)
|
|
require.NoError(t, err)
|
|
require.Equal(t, newSettings.OAuthSettings, actual.OAuthSettings)
|
|
require.Equal(t, formatTime(timeNow().UTC()), formatTime(actual.Created))
|
|
require.Equal(t, formatTime(timeNow().UTC()), formatTime(actual.Updated))
|
|
|
|
old, err := getSSOSettingsByProvider(sqlStore, provider, true)
|
|
require.NoError(t, err)
|
|
require.Equal(t, template.OAuthSettings, old.OAuthSettings)
|
|
})
|
|
|
|
t.Run("replaces the settings only for the specified provider leaving the other provider's settings unchanged", func(t *testing.T) {
|
|
setup()
|
|
|
|
mockTimeNow(time.Now())
|
|
defer resetTimeNow()
|
|
|
|
providers := []string{"github", "gitlab", "google"}
|
|
template := models.SSOSettings{
|
|
OAuthSettings: &social.OAuthInfo{
|
|
Enabled: true,
|
|
ClientId: "my-client",
|
|
ClientSecret: "this-is-a-secret",
|
|
},
|
|
}
|
|
err := populateSSOSettings(sqlStore, template, providers...)
|
|
require.NoError(t, err)
|
|
|
|
newSettings := models.SSOSettings{
|
|
Provider: providers[0],
|
|
OAuthSettings: &social.OAuthInfo{
|
|
Enabled: true,
|
|
ClientId: "my-new-client",
|
|
ClientSecret: "this-is-my-new-secret",
|
|
},
|
|
}
|
|
err = ssoSettingsStore.Upsert(context.Background(), newSettings)
|
|
require.NoError(t, err)
|
|
|
|
actual, err := getSSOSettingsByProvider(sqlStore, providers[0], false)
|
|
require.NoError(t, err)
|
|
require.Equal(t, newSettings.OAuthSettings, actual.OAuthSettings)
|
|
require.Equal(t, formatTime(timeNow().UTC()), formatTime(actual.Updated))
|
|
|
|
for index := 1; index < len(providers); index++ {
|
|
existing, err := getSSOSettingsByProvider(sqlStore, providers[index], false)
|
|
require.NoError(t, err)
|
|
require.EqualValues(t, template.OAuthSettings, existing.OAuthSettings)
|
|
}
|
|
})
|
|
}
|
|
|
|
func TestIntegrationListSSOSettings(t *testing.T) {
|
|
if testing.Short() {
|
|
t.Skip("skipping integration test")
|
|
}
|
|
|
|
var sqlStore *sqlstore.SQLStore
|
|
var ssoSettingsStore *SSOSettingsStore
|
|
|
|
setup := func() {
|
|
sqlStore = db.InitTestDB(t)
|
|
ssoSettingsStore = ProvideStore(sqlStore)
|
|
|
|
template := models.SSOSettings{
|
|
OAuthSettings: &social.OAuthInfo{
|
|
Enabled: true,
|
|
},
|
|
}
|
|
err := populateSSOSettings(sqlStore, template, "azuread")
|
|
require.NoError(t, err)
|
|
|
|
template = models.SSOSettings{
|
|
OAuthSettings: &social.OAuthInfo{
|
|
Enabled: false,
|
|
},
|
|
}
|
|
err = populateSSOSettings(sqlStore, template, "okta")
|
|
require.NoError(t, err)
|
|
}
|
|
|
|
t.Run("returns every SSO settings successfully", func(t *testing.T) {
|
|
setup()
|
|
|
|
list, err := ssoSettingsStore.List(context.Background())
|
|
|
|
require.NoError(t, err)
|
|
require.Equal(t, 2, len(list))
|
|
})
|
|
}
|
|
|
|
func TestIntegrationDeleteSSOSettings(t *testing.T) {
|
|
if testing.Short() {
|
|
t.Skip("skipping integration test")
|
|
}
|
|
|
|
var sqlStore *sqlstore.SQLStore
|
|
var ssoSettingsStore *SSOSettingsStore
|
|
|
|
setup := func() {
|
|
sqlStore = db.InitTestDB(t)
|
|
ssoSettingsStore = ProvideStore(sqlStore)
|
|
}
|
|
|
|
t.Run("soft deletes the settings successfully", func(t *testing.T) {
|
|
setup()
|
|
|
|
providers := []string{"azuread", "github", "google"}
|
|
template := models.SSOSettings{
|
|
OAuthSettings: &social.OAuthInfo{
|
|
Enabled: true,
|
|
},
|
|
}
|
|
err := populateSSOSettings(sqlStore, template, providers...)
|
|
require.NoError(t, err)
|
|
|
|
err = ssoSettingsStore.Delete(context.Background(), providers[0])
|
|
require.NoError(t, err)
|
|
|
|
deleted, notDeleted, err := getSSOSettingsCountByDeleted(sqlStore)
|
|
require.NoError(t, err)
|
|
require.EqualValues(t, 1, deleted)
|
|
require.EqualValues(t, len(providers)-1, notDeleted)
|
|
})
|
|
|
|
t.Run("return not found if the provider doesn't exist in db", func(t *testing.T) {
|
|
setup()
|
|
|
|
providers := []string{"github", "google", "okta"}
|
|
invalidProvider := "azuread"
|
|
template := models.SSOSettings{
|
|
OAuthSettings: &social.OAuthInfo{
|
|
Enabled: true,
|
|
},
|
|
}
|
|
err := populateSSOSettings(sqlStore, template, providers...)
|
|
require.NoError(t, err)
|
|
|
|
err = ssoSettingsStore.Delete(context.Background(), invalidProvider)
|
|
require.Error(t, err)
|
|
require.ErrorIs(t, err, ssosettings.ErrNotFound)
|
|
|
|
deleted, notDeleted, err := getSSOSettingsCountByDeleted(sqlStore)
|
|
require.NoError(t, err)
|
|
require.EqualValues(t, 0, deleted)
|
|
require.EqualValues(t, len(providers), notDeleted)
|
|
})
|
|
|
|
t.Run("return not found if the provider sso settings are already deleted", func(t *testing.T) {
|
|
setup()
|
|
|
|
providers := []string{"azuread", "github", "google"}
|
|
template := models.SSOSettings{
|
|
OAuthSettings: &social.OAuthInfo{
|
|
Enabled: true,
|
|
},
|
|
IsDeleted: true,
|
|
}
|
|
err := populateSSOSettings(sqlStore, template, providers...)
|
|
require.NoError(t, err)
|
|
|
|
err = ssoSettingsStore.Delete(context.Background(), providers[0])
|
|
require.Error(t, err)
|
|
require.ErrorIs(t, err, ssosettings.ErrNotFound)
|
|
|
|
deleted, notDeleted, err := getSSOSettingsCountByDeleted(sqlStore)
|
|
require.NoError(t, err)
|
|
require.EqualValues(t, len(providers), deleted)
|
|
require.EqualValues(t, 0, notDeleted)
|
|
})
|
|
|
|
t.Run("delete one record if more valid sso settings are available for a provider", func(t *testing.T) {
|
|
setup()
|
|
|
|
provider := "azuread"
|
|
template := models.SSOSettings{
|
|
OAuthSettings: &social.OAuthInfo{
|
|
Enabled: true,
|
|
},
|
|
}
|
|
// insert sso for the same provider 2 times in the database
|
|
err := populateSSOSettings(sqlStore, template, provider)
|
|
require.NoError(t, err)
|
|
err = populateSSOSettings(sqlStore, template, provider)
|
|
require.NoError(t, err)
|
|
|
|
err = ssoSettingsStore.Delete(context.Background(), provider)
|
|
require.NoError(t, err)
|
|
|
|
deleted, notDeleted, err := getSSOSettingsCountByDeleted(sqlStore)
|
|
require.NoError(t, err)
|
|
require.EqualValues(t, 1, deleted)
|
|
require.EqualValues(t, 1, notDeleted)
|
|
})
|
|
}
|
|
|
|
func populateSSOSettings(sqlStore *sqlstore.SQLStore, template models.SSOSettings, providers ...string) error {
|
|
return sqlStore.WithDbSession(context.Background(), func(sess *db.Session) error {
|
|
for _, provider := range providers {
|
|
template.Provider = provider
|
|
template.ID = uuid.New().String()
|
|
template.Created = timeNow().UTC()
|
|
|
|
dto, err := template.ToSSOSettingsDTO()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
_, err = sess.Insert(dto)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return nil
|
|
})
|
|
}
|
|
|
|
func getSSOSettingsCountByDeleted(sqlStore *sqlstore.SQLStore) (deleted, notDeleted int64, err error) {
|
|
err = sqlStore.WithDbSession(context.Background(), func(sess *db.Session) error {
|
|
deleted, err = sess.Table("sso_setting").Where("is_deleted = ?", sqlStore.GetDialect().BooleanStr(true)).Count()
|
|
if err != nil {
|
|
return err
|
|
}
|
|
notDeleted, err = sess.Table("sso_setting").Where("is_deleted = ?", sqlStore.GetDialect().BooleanStr(false)).Count()
|
|
return err
|
|
})
|
|
|
|
return
|
|
}
|
|
|
|
func getSSOSettingsByProvider(sqlStore *sqlstore.SQLStore, provider string, deleted bool) (*models.SSOSettings, error) {
|
|
var model models.SSOSettingsDTO
|
|
var err error
|
|
|
|
err = sqlStore.WithDbSession(context.Background(), func(sess *db.Session) error {
|
|
_, err = sess.Table("sso_setting").Where("provider = ? AND is_deleted = ?", provider, sqlStore.GetDialect().BooleanStr(deleted)).Get(&model)
|
|
return err
|
|
})
|
|
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
settings, err := model.ToSSOSettings()
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
return settings, err
|
|
}
|
|
|
|
func mockTimeNow(timeSeed time.Time) {
|
|
timeNow = func() time.Time {
|
|
return timeSeed
|
|
}
|
|
}
|
|
|
|
func resetTimeNow() {
|
|
timeNow = time.Now
|
|
}
|
|
|
|
func formatTime(timestamp time.Time) string {
|
|
return timestamp.Format(time.RFC3339)
|
|
}
|