IntenseWebs/grafana
3
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-02-25 18:55:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Auth: Fix flaky tests that are mocking time.Now() from SSO Settings (#79581)

Browse Source 
test time values using require.WithinDuration() instead of mocking time.Now()
This commit is contained in:
Mihai Doarna 2023-12-18 11:10:46 +02:00 committed by GitHub
parent 57ca8fa368
commit 53d209e6f1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 13 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
pkg/services/ssosettings/database/database.go
View File

@ -17,11 +17,6 @@ type SSOSettingsStore struct {
log log.Logger
}
var (
// timeNow makes it possible to test usage of time
timeNow = time.Now
)
func ProvideStore(sqlStore db.DB) *SSOSettingsStore {
return &SSOSettingsStore{
sqlStore: sqlStore,
@ -87,7 +82,7 @@ func (s *SSOSettingsStore) Upsert(ctx context.Context, settings models.SSOSettin
return err
}
now := timeNow().UTC()
now := time.Now().UTC()
if found {
updated := &models.SSOSettings{
@ -130,7 +125,7 @@ func (s *SSOSettingsStore) Delete(ctx context.Context, provider string) error {
return ssosettings.ErrNotFound
}
existing.Updated = timeNow().UTC()
existing.Updated = time.Now().UTC()
existing.IsDeleted = true
_, err = sess.ID(existing.ID).MustCols("updated", "is_deleted").Update(existing)

44
pkg/services/ssosettings/database/database_test.go
View File

@ -14,6 +14,10 @@ import (
"github.com/grafana/grafana/pkg/services/ssosettings/models"
)
const (
withinDuration = 5 * time.Minute
)
func TestIntegrationGetSSOSettings(t *testing.T) {
if testing.Short() {
t.Skip("skipping integration test")
@ -80,9 +84,6 @@ func TestIntegrationUpsertSSOSettings(t *testing.T) {
t.Run("insert a new SSO setting successfully", func(t *testing.T) {
setup()
mockTimeNow(time.Now())
defer resetTimeNow()
settings := models.SSOSettings{
Provider: "azuread",
Settings: map[string]any{
@ -98,8 +99,8 @@ func TestIntegrationUpsertSSOSettings(t *testing.T) {
require.NoError(t, err)
require.EqualValues(t, settings.Settings, actual.Settings)
require.NotEmpty(t, actual.ID)
require.Equal(t, formatTime(timeNow().UTC()), formatTime(actual.Created))
require.Equal(t, formatTime(timeNow().UTC()), formatTime(actual.Updated))
require.WithinDuration(t, time.Now().UTC(), actual.Created, withinDuration)
require.WithinDuration(t, time.Now().UTC(), actual.Updated, withinDuration)
deleted, notDeleted, err := getSSOSettingsCountByDeleted(sqlStore)
require.NoError(t, err)
@ -110,9 +111,6 @@ func TestIntegrationUpsertSSOSettings(t *testing.T) {
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{
Settings: map[string]any{
@ -138,7 +136,7 @@ func TestIntegrationUpsertSSOSettings(t *testing.T) {
actual, err := getSSOSettingsByProvider(sqlStore, provider, false)
require.NoError(t, err)
require.EqualValues(t, newSettings.Settings, actual.Settings)
require.Equal(t, formatTime(timeNow().UTC()), formatTime(actual.Updated))
require.WithinDuration(t, time.Now().UTC(), actual.Updated, withinDuration)
deleted, notDeleted, err := getSSOSettingsCountByDeleted(sqlStore)
require.NoError(t, err)
@ -149,9 +147,6 @@ func TestIntegrationUpsertSSOSettings(t *testing.T) {
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{
Settings: map[string]any{
@ -179,8 +174,8 @@ func TestIntegrationUpsertSSOSettings(t *testing.T) {
actual, err := getSSOSettingsByProvider(sqlStore, provider, false)
require.NoError(t, err)
require.EqualValues(t, newSettings.Settings, actual.Settings)
require.Equal(t, formatTime(timeNow().UTC()), formatTime(actual.Created))
require.Equal(t, formatTime(timeNow().UTC()), formatTime(actual.Updated))
require.WithinDuration(t, time.Now().UTC(), actual.Created, withinDuration)
require.WithinDuration(t, time.Now().UTC(), actual.Updated, withinDuration)
old, err := getSSOSettingsByProvider(sqlStore, provider, true)
require.NoError(t, err)
@ -190,9 +185,6 @@ func TestIntegrationUpsertSSOSettings(t *testing.T) {
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{
Settings: map[string]any{
@ -218,7 +210,7 @@ func TestIntegrationUpsertSSOSettings(t *testing.T) {
actual, err := getSSOSettingsByProvider(sqlStore, providers[0], false)
require.NoError(t, err)
require.EqualValues(t, newSettings.Settings, actual.Settings)
require.Equal(t, formatTime(timeNow().UTC()), formatTime(actual.Updated))
require.WithinDuration(t, time.Now().UTC(), actual.Updated, withinDuration)
for index := 1; index < len(providers); index++ {
existing, err := getSSOSettingsByProvider(sqlStore, providers[index], false)
@ -379,7 +371,7 @@ func populateSSOSettings(sqlStore *sqlstore.SQLStore, template models.SSOSetting
ID: uuid.New().String(),
Provider: provider,
Settings: template.Settings,
Created: timeNow().UTC(),
Created: time.Now().UTC(),
IsDeleted: template.IsDeleted,
}
@ -420,17 +412,3 @@ func getSSOSettingsByProvider(sqlStore *sqlstore.SQLStore, provider string, dele
return &model, 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)
}