From 0e565a2e6cf524605d40f3bdfd92cc1b99b1f1e8 Mon Sep 17 00:00:00 2001
From: Jo <joao.guerreiro@grafana.com>
Date: Thu, 16 Mar 2023 15:36:31 +0000
Subject: [PATCH] ServiceAccounts: Collect usage stat for service account
 forced expiry (#64833)

collect usage stat for service account forced expiry
---
 pkg/services/serviceaccounts/database/stats.go  |  2 ++
 .../serviceaccounts/database/stats_test.go      |  9 ++++++---
 pkg/services/serviceaccounts/manager/stats.go   | 17 ++++++++++++-----
 .../serviceaccounts/manager/stats_test.go       |  7 +++++--
 pkg/services/serviceaccounts/models.go          |  5 +++--
 5 files changed, 28 insertions(+), 12 deletions(-)

diff --git a/pkg/services/serviceaccounts/database/stats.go b/pkg/services/serviceaccounts/database/stats.go
index 1310501aea2..7ade76f29ac 100644
--- a/pkg/services/serviceaccounts/database/stats.go
+++ b/pkg/services/serviceaccounts/database/stats.go
@@ -25,5 +25,7 @@ func (s *ServiceAccountsStoreImpl) GetUsageMetrics(ctx context.Context) (*servic
 		return nil, err
 	}
 
+	sqlStats.ForcedExpiryEnabled = s.cfg.SATokenExpirationDayLimit != 0
+
 	return &sqlStats, nil
 }
diff --git a/pkg/services/serviceaccounts/database/stats_test.go b/pkg/services/serviceaccounts/database/stats_test.go
index 558bb7cf246..584b7edfca3 100644
--- a/pkg/services/serviceaccounts/database/stats_test.go
+++ b/pkg/services/serviceaccounts/database/stats_test.go
@@ -7,18 +7,20 @@ import (
 	"github.com/stretchr/testify/assert"
 	"github.com/stretchr/testify/require"
 
-	"github.com/grafana/grafana/pkg/components/apikeygen"
+	apikeygenprefix "github.com/grafana/grafana/pkg/components/apikeygenprefixed"
 	"github.com/grafana/grafana/pkg/services/serviceaccounts"
 	"github.com/grafana/grafana/pkg/services/serviceaccounts/tests"
 )
 
-func TestStore_UsageStats(t *testing.T) {
+func TestIntegrationStore_UsageStats(t *testing.T) {
 	saToCreate := tests.TestUser{Login: "servicetestwithTeam@admin", IsServiceAccount: true}
 	db, store := setupTestDatabase(t)
 	sa := tests.SetupUserServiceAccount(t, db, saToCreate)
 
+	db.Cfg.SATokenExpirationDayLimit = 4
+
 	keyName := t.Name()
-	key, err := apikeygen.New(sa.OrgID, keyName)
+	key, err := apikeygenprefix.New(keyName)
 	require.NoError(t, err)
 
 	cmd := serviceaccounts.AddServiceAccountTokenCommand{
@@ -36,4 +38,5 @@ func TestStore_UsageStats(t *testing.T) {
 
 	assert.Equal(t, int64(1), stats.ServiceAccounts)
 	assert.Equal(t, int64(1), stats.Tokens)
+	assert.Equal(t, true, stats.ForcedExpiryEnabled)
 }
diff --git a/pkg/services/serviceaccounts/manager/stats.go b/pkg/services/serviceaccounts/manager/stats.go
index 77a3498bf7c..3d5adc779e7 100644
--- a/pkg/services/serviceaccounts/manager/stats.go
+++ b/pkg/services/serviceaccounts/manager/stats.go
@@ -42,13 +42,20 @@ func init() {
 func (sa *ServiceAccountsService) getUsageMetrics(ctx context.Context) (map[string]interface{}, error) {
 	stats := map[string]interface{}{}
 
-	sqlStats, err := sa.store.GetUsageMetrics(ctx)
+	storeStats, err := sa.store.GetUsageMetrics(ctx)
 	if err != nil {
 		return nil, err
 	}
 
-	stats["stats.serviceaccounts.count"] = sqlStats.ServiceAccounts
-	stats["stats.serviceaccounts.tokens.count"] = sqlStats.Tokens
+	stats["stats.serviceaccounts.count"] = storeStats.ServiceAccounts
+	stats["stats.serviceaccounts.tokens.count"] = storeStats.Tokens
+
+	var forcedExpiryEnabled int64 = 0
+	if storeStats.ForcedExpiryEnabled {
+		forcedExpiryEnabled = 1
+	}
+
+	stats["stats.serviceaccounts.forced_expiry_enabled.count"] = forcedExpiryEnabled
 
 	var secretScanEnabled int64 = 0
 	if sa.secretScanEnabled {
@@ -57,8 +64,8 @@ func (sa *ServiceAccountsService) getUsageMetrics(ctx context.Context) (map[stri
 
 	stats["stats.serviceaccounts.secret_scan.enabled.count"] = secretScanEnabled
 
-	MStatTotalServiceAccountTokens.Set(float64(sqlStats.Tokens))
-	MStatTotalServiceAccounts.Set(float64(sqlStats.ServiceAccounts))
+	MStatTotalServiceAccountTokens.Set(float64(storeStats.Tokens))
+	MStatTotalServiceAccounts.Set(float64(storeStats.ServiceAccounts))
 
 	return stats, nil
 }
diff --git a/pkg/services/serviceaccounts/manager/stats_test.go b/pkg/services/serviceaccounts/manager/stats_test.go
index a7b21041303..84e878d76ba 100644
--- a/pkg/services/serviceaccounts/manager/stats_test.go
+++ b/pkg/services/serviceaccounts/manager/stats_test.go
@@ -18,13 +18,16 @@ func Test_UsageStats(t *testing.T) {
 	require.NoError(t, err)
 
 	storeMock.ExpectedStats = &serviceaccounts.Stats{
-		ServiceAccounts: 1,
-		Tokens:          1,
+		ServiceAccounts:     1,
+		Tokens:              1,
+		ForcedExpiryEnabled: false,
 	}
 	stats, err := svc.getUsageMetrics(context.Background())
 	require.NoError(t, err)
 
+	assert.Len(t, stats, 4, stats)
 	assert.Equal(t, int64(1), stats["stats.serviceaccounts.count"].(int64))
 	assert.Equal(t, int64(1), stats["stats.serviceaccounts.tokens.count"].(int64))
 	assert.Equal(t, int64(1), stats["stats.serviceaccounts.secret_scan.enabled.count"].(int64))
+	assert.Equal(t, int64(0), stats["stats.serviceaccounts.forced_expiry_enabled.count"].(int64))
 }
diff --git a/pkg/services/serviceaccounts/models.go b/pkg/services/serviceaccounts/models.go
index 8797bea282b..83fa4f79ac9 100644
--- a/pkg/services/serviceaccounts/models.go
+++ b/pkg/services/serviceaccounts/models.go
@@ -152,8 +152,9 @@ const (
 )
 
 type Stats struct {
-	ServiceAccounts int64 `xorm:"serviceaccounts"`
-	Tokens          int64 `xorm:"serviceaccount_tokens"`
+	ServiceAccounts     int64 `xorm:"serviceaccounts"`
+	Tokens              int64 `xorm:"serviceaccount_tokens"`
+	ForcedExpiryEnabled bool  `xorm:"-"`
 }
 
 // AccessEvaluator is used to protect the "Configuration > Service accounts" page access