Merge pull request #1887 from tisnik/refactoring-ocp-recommendations

Refactoring: OCPRecommendationsStorage

aggregator.go

@@ -112,7 +112,7 @@ func fillInInfoParams(params map[string]string) {
 // createStorage function initializes connection to preconfigured storage,
 // usually SQLite, PostgreSQL, or AWS RDS.
 func createStorage() (storage.OCPRecommendationsStorage, error) {
-	storageCfg := conf.GetStorageConfiguration()
+	storageCfg := conf.GetOCPRecommendationsStorageConfiguration()
 	redisCfg := conf.GetRedisConfiguration()
 	// fill-in the missing sub-structure to have the whole Storage
 	// configuration represented as one data structure
@@ -144,7 +144,7 @@ func closeStorage(storage storage.OCPRecommendationsStorage) {
 // autoMigrate is set performs migration to the latest schema version
 // available.
 func prepareDBMigrations(dbStorage storage.OCPRecommendationsStorage) int {
-	if conf.GetStorageConfiguration().Type != types.SQLStorage {
+	if conf.GetOCPRecommendationsStorageConfiguration().Type != types.SQLStorage {
 		log.Info().Msg("Skipping migration for non-SQL database type")
 		return ExitStatusOK
 	}

conf/configuration.go

@@ -75,13 +75,13 @@ type ConfigStruct struct {
 	Processing struct {
 		OrgAllowlistFile string `mapstructure:"org_allowlist_file" toml:"org_allowlist_file"`
 	} `mapstructure:"processing"`
-	Storage           storage.Configuration             `mapstructure:"storage" toml:"storage"`
-	Logging           logger.LoggingConfiguration       `mapstructure:"logging" toml:"logging"`
-	CloudWatch        logger.CloudWatchConfiguration    `mapstructure:"cloudwatch" toml:"cloudwatch"`
-	Redis             storage.RedisConfiguration        `mapstructure:"redis" toml:"redis"`
-	Metrics           MetricsConfiguration              `mapstructure:"metrics" toml:"metrics"`
-	SentryLoggingConf logger.SentryLoggingConfiguration `mapstructure:"sentry" toml:"sentry"`
-	KafkaZerologConf  logger.KafkaZerologConfiguration  `mapstructure:"kafka_zerolog" toml:"kafka_zerolog"`
+	OCPRecommendationsStorage storage.Configuration             `mapstructure:"storage" toml:"storage"`
+	Logging                   logger.LoggingConfiguration       `mapstructure:"logging" toml:"logging"`
+	CloudWatch                logger.CloudWatchConfiguration    `mapstructure:"cloudwatch" toml:"cloudwatch"`
+	Redis                     storage.RedisConfiguration        `mapstructure:"redis" toml:"redis"`
+	Metrics                   MetricsConfiguration              `mapstructure:"metrics" toml:"metrics"`
+	SentryLoggingConf         logger.SentryLoggingConfiguration `mapstructure:"sentry" toml:"sentry"`
+	KafkaZerologConf          logger.KafkaZerologConfiguration  `mapstructure:"kafka_zerolog" toml:"kafka_zerolog"`
 }
 
 // Config has exactly the same structure as *.toml file
@@ -179,9 +179,9 @@ func getOrganizationAllowlist() mapset.Set {
 	return allowlist
 }
 
-// GetStorageConfiguration returns storage configuration
-func GetStorageConfiguration() storage.Configuration {
-	return Config.Storage
+// GetOCPRecommendationsStorageConfiguration returns storage configuration
+func GetOCPRecommendationsStorageConfiguration() storage.Configuration {
+	return Config.OCPRecommendationsStorage
 }
 
 // GetRedisConfiguration returns Redis storage configuration
@@ -317,11 +317,11 @@ func updateConfigFromClowder(c *ConfigStruct) error {
 
 	if clowder.LoadedConfig.Database != nil {
 		// get DB configuration from clowder
-		c.Storage.PGDBName = clowder.LoadedConfig.Database.Name
-		c.Storage.PGHost = clowder.LoadedConfig.Database.Hostname
-		c.Storage.PGPort = clowder.LoadedConfig.Database.Port
-		c.Storage.PGUsername = clowder.LoadedConfig.Database.Username
-		c.Storage.PGPassword = clowder.LoadedConfig.Database.Password
+		c.OCPRecommendationsStorage.PGDBName = clowder.LoadedConfig.Database.Name
+		c.OCPRecommendationsStorage.PGHost = clowder.LoadedConfig.Database.Hostname
+		c.OCPRecommendationsStorage.PGPort = clowder.LoadedConfig.Database.Port
+		c.OCPRecommendationsStorage.PGUsername = clowder.LoadedConfig.Database.Username
+		c.OCPRecommendationsStorage.PGPassword = clowder.LoadedConfig.Database.Password
 	} else {
 		fmt.Println(noStorage)
 	}

conf/configuration_test.go

@@ -162,7 +162,7 @@ func TestLoadServerConfiguration(t *testing.T) {
 func TestLoadStorageConfiguration(t *testing.T) {
 	TestLoadConfiguration(t)
 
-	storageCfg := conf.GetStorageConfiguration()
+	storageCfg := conf.GetOCPRecommendationsStorageConfiguration()
 
 	assert.Equal(t, "sqlite3", storageCfg.Driver)
 	assert.Equal(t, ":memory:", storageCfg.SQLiteDataSource)
@@ -189,7 +189,7 @@ func TestLoadConfigurationOverrideFromEnv(t *testing.T) {
 
 	mustLoadConfiguration(configPath)
 
-	storageCfg := conf.GetStorageConfiguration()
+	storageCfg := conf.GetOCPRecommendationsStorageConfiguration()
 	assert.Equal(t, storage.Configuration{
 		Driver:           "sqlite3",
 		SQLiteDataSource: ":memory:",
@@ -207,7 +207,7 @@ func TestLoadConfigurationOverrideFromEnv(t *testing.T) {
 
 	mustLoadConfiguration(configPath)
 
-	storageCfg = conf.GetStorageConfiguration()
+	storageCfg = conf.GetOCPRecommendationsStorageConfiguration()
 	assert.Equal(t, storage.Configuration{
 		Driver:           "postgres",
 		SQLiteDataSource: ":memory:",
@@ -353,7 +353,7 @@ func TestLoadConfigurationFromFile(t *testing.T) {
 		PGDBName:         "aggregator",
 		PGParams:         "params",
 		Type:             "sql",
-	}, conf.GetStorageConfiguration())
+	}, conf.GetOCPRecommendationsStorageConfiguration())
 
 	assert.Equal(t, storage.RedisConfiguration{
 		RedisEndpoint:       "localhost:6379",
@@ -411,7 +411,7 @@ func TestLoadConfigurationFromEnv(t *testing.T) {
 		PGDBName:         "aggregator",
 		PGParams:         "params",
 		Type:             "sql",
-	}, conf.GetStorageConfiguration())
+	}, conf.GetOCPRecommendationsStorageConfiguration())
 
 	assert.Equal(t, storage.RedisConfiguration{
 		RedisEndpoint:       "default-redis-endpoint",
@@ -498,7 +498,7 @@ func TestLoadConfigurationFromEnvVariableClowderEnabled(t *testing.T) {
 
 	// retrieve broker config
 	brokerCfg := conf.GetBrokerConfiguration()
-	storageCfg := conf.GetStorageConfiguration()
+	storageCfg := conf.GetOCPRecommendationsStorageConfiguration()
 
 	// check
 	assert.Equal(t, "localhost:29092", brokerCfg.Address, "Broker doesn't match")

server.go

@@ -51,7 +51,7 @@ func startServer() error {
 	// try to retrieve the actual DB migration version
 	// and add it into the `params` map
 	log.Info().Msg("Setting DB version for /info endpoint")
-	if conf.GetStorageConfiguration().Type == types.SQLStorage {
+	if conf.GetOCPRecommendationsStorageConfiguration().Type == types.SQLStorage {
 		// migration and DB versioning is now supported for SQL
 		// databases only
 		currentVersion, err := migration.GetDBVersion(dbStorage.GetConnection())

tests/helpers/mock_storage.go

@@ -144,7 +144,7 @@ func MustGetPostgresStorage(tb testing.TB, init bool) (storage.OCPRecommendation
 	helpers.FailOnError(tb, err)
 
 	// force postgres and replace db name with test one
-	storageConf := &conf.Config.Storage
+	storageConf := &conf.Config.OCPRecommendationsStorage
 	storageConf.Driver = postgres
 	storageConf.PGDBName += "_test_db_" + strings.ReplaceAll(uuid.New().String(), "-", "_")
 	storageConf.PGPassword = dbAdminPassword
@@ -175,7 +175,7 @@ func MustGetPostgresStorage(tb testing.TB, init bool) (storage.OCPRecommendation
 	return postgresStorage, func() {
 		MustCloseStorage(tb, postgresStorage)
 
-		_, err := adminConn.Exec("DROP DATABASE " + conf.Config.Storage.PGDBName)
+		_, err := adminConn.Exec("DROP DATABASE " + conf.Config.OCPRecommendationsStorage.PGDBName)
 		helpers.FailOnError(tb, err)
 
 		helpers.FailOnError(tb, adminConn.Close())