Refactor: Eliminate Global Variable to Enhance Testability

chaoscenter/authentication/go.sum

@@ -131,6 +131,8 @@ golang.org/x/crypto v0.31.0/go.mod h1:kDsLvtWBEx7MV9tJOj9bnXsPbxwJQ6csT/x4KIN4Ss
 golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
 golang.org/x/mod v0.17.0 h1:zY54UmvipHiNd+pm+m0x9KhZ9hl1/7QNMyxXbc6ICqA=
 golang.org/x/mod v0.17.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
+golang.org/x/mod v0.16.0 h1:QX4fJ0Rr5cPQCF7O9lh9Se4pmwfwskqZfq5moyldzic=
+golang.org/x/mod v0.16.0/go.mod h1:hTbmBsO62+eylJbnUtE2MGJUyE7QWk4xUqPFrRgJ+7c=
 golang.org/x/net v0.0.0-20180724234803-3673e40ba225/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20190108225652-1e06a53dbb7e/go.mod h1:mL1N/T3taQHkDXs73rZJwtUhF3w3ftmwwsq0BUmARs4=
 golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=

chaoscenter/graphql/server/pkg/authorization/authorization_fuzz_test.go

@@ -58,6 +58,7 @@ func generateJWTTokenFromClaims(claims jwt.MapClaims) (string, error) {
 }
 
 func FuzzUserValidateJWT(f *testing.F) {
+	operator := &Operator{}
 	f.Fuzz(func(t *testing.T, data []byte) {
 		fuzzConsumer := fuzz.NewConsumer(data)
 		inputClaims := &jwt.MapClaims{}
@@ -72,7 +73,7 @@ func FuzzUserValidateJWT(f *testing.F) {
 		}
 
 		// Run the test with the generated JWT token
-		claims, err := UserValidateJWT(tokenString, "")
+		claims, err := operator.UserValidateJWT(tokenString, "")
 		if err != nil {
 			t.Errorf("Error encountered: %v", err)
 		}

chaoscenter/graphql/server/pkg/authorization/user_jwt.go

@@ -12,8 +12,18 @@ import (
 	"github.com/golang-jwt/jwt"
 )
 
+type Operator struct {
+	authConfigOperator *authConfig.Operator
+}
+
+func NewAuthorizationOperator(mongodbOperator mongodb.MongoOperator) *Operator {
+	return &Operator{
+		authConfigOperator: authConfig.NewAuthConfigOperator(mongodbOperator),
+	}
+}
+
 // UserValidateJWT validates the cluster jwt
-func UserValidateJWT(token string, salt string) (jwt.MapClaims, error) {
+func (o *Operator) UserValidateJWT(token string, salt string) (jwt.MapClaims, error) {
 	tkn, err := jwt.Parse(token, func(token *jwt.Token) (interface{}, error) {
 		if _, isValid := token.Method.(*jwt.SigningMethodHMAC); !isValid {
 			return nil, fmt.Errorf("invalid token %s", token.Header["alg"])
@@ -39,8 +49,8 @@ func UserValidateJWT(token string, salt string) (jwt.MapClaims, error) {
 }
 
 // GetUsername returns the username from the jwt token
-func GetUsername(token string) (string, error) {
-	salt, err := authConfig.NewAuthConfigOperator(mongodb.Operator).GetAuthConfig(context.Background())
+func (o *Operator) GetUsername(token string) (string, error) {
+	salt, err := o.authConfigOperator.GetAuthConfig(context.Background())
 	if err != nil {
 		return "", err
 	}

chaoscenter/graphql/server/pkg/chaos_experiment/handler/handler.go

@@ -1350,7 +1350,7 @@ func (c *ChaosExperimentHandler) GetProbesInExperimentRun(ctx context.Context, p
 			}
 
 			for _, probeName := range _probe.ProbeNames {
-				singleProbe, err := dbSchemaProbe.NewChaosProbeOperator(c.mongodbOperator).GetProbeByName(ctx, probeName, projectID)
+				singleProbe, err := dbSchemaProbe.NewProbeOperator(c.mongodbOperator).GetProbeByName(ctx, probeName, projectID)
 				if err != nil {
 					return nil, err
 				}

chaoscenter/graphql/server/pkg/chaos_experiment/ops/service_test.go

@@ -10,6 +10,7 @@ import (
 	"reflect"
 	"testing"
 
+	"github.com/litmuschaos/litmus/chaoscenter/graphql/server/pkg/authorization"
 	dbSchemaProbe "github.com/litmuschaos/litmus/chaoscenter/graphql/server/pkg/database/mongodb/probe"
 
 	"github.com/gin-gonic/gin"
@@ -30,11 +31,12 @@ import (
 
 var (
 	mongodbMockOperator        = new(dbMocks.MongoOperator)
-	probeOperator              = dbSchemaProbe.NewChaosProbeOperator(mongodbMockOperator)
+	probeOperator              = dbSchemaProbe.NewProbeOperator(mongodbMockOperator)
 	infraOperator              = dbChaosInfra.NewInfrastructureOperator(mongodbMockOperator)
 	chaosExperimentOperator    = dbChaosExperiment.NewChaosExperimentOperator(mongodbMockOperator)
 	chaosExperimentRunOperator = dbChaosExperimentRun.NewChaosExperimentRunOperator(mongodbMockOperator)
-	probeService               = probe.NewProbeService(probeOperator)
+	authConfigOperator         = authorization.NewAuthorizationOperator(mongodbMockOperator)
+	probeService               = probe.NewProbeService(probeOperator, authConfigOperator)
 )
 
 var chaosExperimentRunTestService = NewChaosExperimentService(chaosExperimentOperator, infraOperator, chaosExperimentRunOperator, probeService)

chaoscenter/graphql/server/pkg/chaos_experiment_run/handler/handler.go

@@ -56,6 +56,7 @@ type ChaosExperimentRunHandler struct {
 	chaosExperimentRunOperator *dbChaosExperimentRun.Operator
 	probeService               probe.Service
 	mongodbOperator            mongodb.MongoOperator
+	authConfigOperator         *authorization.Operator
 }
 
 // NewChaosExperimentRunHandler returns a new instance of ChaosWorkflowHandler
@@ -67,6 +68,7 @@ func NewChaosExperimentRunHandler(
 	chaosExperimentRunOperator *dbChaosExperimentRun.Operator,
 	probeService probe.Service,
 	mongodbOperator mongodb.MongoOperator,
+	authConfigOperator *authorization.Operator,
 ) *ChaosExperimentRunHandler {
 	return &ChaosExperimentRunHandler{
 		chaosExperimentRunService:  chaosExperimentRunService,
@@ -76,6 +78,7 @@ func NewChaosExperimentRunHandler(
 		chaosExperimentRunOperator: chaosExperimentRunOperator,
 		probeService:               probeService,
 		mongodbOperator:            mongodbOperator,
+		authConfigOperator:         authConfigOperator,
 	}
 }
 
@@ -799,7 +802,7 @@ func (c *ChaosExperimentRunHandler) RunChaosWorkFlow(ctx context.Context, projec
 	)
 
 	tkn := ctx.Value(authorization.AuthKey).(string)
-	username, err := authorization.GetUsername(tkn)
+	username, err := c.authConfigOperator.GetUsername(tkn)
 	if err != nil {
 		return nil, err
 	}
@@ -1003,7 +1006,7 @@ func (c *ChaosExperimentRunHandler) RunCronExperiment(ctx context.Context, proje
 	}
 
 	tkn := ctx.Value(authorization.AuthKey).(string)
-	username, err := authorization.GetUsername(tkn)
+	username, err := c.authConfigOperator.GetUsername(tkn)
 	if err != nil {
 		return err
 	}

chaoscenter/graphql/server/pkg/chaos_infrastructure/cluster_jwt.go

@@ -11,12 +11,22 @@ import (
 	"github.com/golang-jwt/jwt"
 )
 
+type Operator struct {
+	authConfigOperator *authConfig.Operator
+}
+
+func NewChaosInfrastructureOperator(mongodbOperator mongodb.MongoOperator) *Operator {
+	return &Operator{
+		authConfigOperator: authConfig.NewAuthConfigOperator(mongodbOperator),
+	}
+}
+
 // InfraCreateJWT generates jwt used in chaos_infra registration
-func InfraCreateJWT(id string) (string, error) {
+func (o *Operator) InfraCreateJWT(id string) (string, error) {
 	claims := jwt.MapClaims{}
 	claims["chaos_infra_id"] = id
 	token := jwt.NewWithClaims(jwt.SigningMethodHS256, claims)
-	config, err := authConfig.NewAuthConfigOperator(mongodb.Operator).GetAuthConfig(context.Background())
+	config, err := o.authConfigOperator.GetAuthConfig(context.Background())
 	if err != nil {
 		return "", err
 	}
@@ -29,12 +39,12 @@ func InfraCreateJWT(id string) (string, error) {
 }
 
 // InfraValidateJWT validates the chaos_infra jwt
-func InfraValidateJWT(token string) (string, error) {
+func (o *Operator) InfraValidateJWT(token string) (string, error) {
 	tkn, err := jwt.Parse(token, func(token *jwt.Token) (interface{}, error) {
 		if _, ok := token.Method.(*jwt.SigningMethodHMAC); !ok {
 			return nil, fmt.Errorf("unexpected signing method: %v", token.Header["alg"])
 		}
-		config, err := authConfig.NewAuthConfigOperator(mongodb.Operator).GetAuthConfig(context.Background())
+		config, err := o.authConfigOperator.GetAuthConfig(context.Background())
 		if err != nil {
 			return "", err
 		}

chaoscenter/graphql/server/pkg/chaos_infrastructure/service.go

@@ -57,15 +57,17 @@ type Service interface {
 }
 
 type infraService struct {
-	infraOperator *dbChaosInfra.Operator
-	envOperator   *dbEnvironments.Operator
+	infraOperator      *dbChaosInfra.Operator
+	envOperator        *dbEnvironments.Operator
+	authConfigOperator *authorization.Operator
 }
 
 // NewChaosInfrastructureService returns a new instance of Service
-func NewChaosInfrastructureService(infraOperator *dbChaosInfra.Operator, envOperator *dbEnvironments.Operator) Service {
+func NewChaosInfrastructureService(infraOperator *dbChaosInfra.Operator, envOperator *dbEnvironments.Operator, authConfigOperator *authorization.Operator) Service {
 	return &infraService{
-		infraOperator: infraOperator,
-		envOperator:   envOperator,
+		infraOperator:      infraOperator,
+		envOperator:        envOperator,
+		authConfigOperator: authConfigOperator,
 	}
 }
 
@@ -100,12 +102,16 @@ func (in *infraService) RegisterInfra(c context.Context, projectID string, input
 	)
 
 	tkn := c.Value(authorization.AuthKey).(string)
-	username, err := authorization.GetUsername(tkn)
+	username, err := in.authConfigOperator.GetUsername(tkn)
 	if err != nil {
 		return nil, err
 	}
 
-	token, err := InfraCreateJWT(infraID)
+	var mongodbOperator mongodb.MongoOperator
+
+	operator := NewChaosInfrastructureOperator(mongodbOperator)
+
+	token, err := operator.InfraCreateJWT(infraID)
 	if err != nil {
 		return &model.RegisterInfraResponse{}, err
 	}
@@ -221,7 +227,7 @@ func (in *infraService) RegisterInfra(c context.Context, projectID string, input
 // DeleteInfra takes infraIDs and r parameters, deletes the infras from the database and sends a request to the subscriber for clean-up
 func (in *infraService) DeleteInfra(ctx context.Context, projectID string, infraId string, r store.StateData) (string, error) {
 	tkn := ctx.Value(authorization.AuthKey).(string)
-	username, err := authorization.GetUsername(tkn)
+	username, err := in.authConfigOperator.GetUsername(tkn)
 	if err != nil {
 		return "", err
 	}
@@ -306,7 +312,7 @@ func (in *infraService) DeleteInfra(ctx context.Context, projectID string, infra
 func (in *infraService) GetInfra(ctx context.Context, projectID string, infraID string) (*model.Infra, error) {
 
 	tkn := ctx.Value(authorization.AuthKey).(string)
-	username, err := authorization.GetUsername(tkn)
+	username, err := in.authConfigOperator.GetUsername(tkn)
 	if err != nil {
 		return nil, err
 	}
@@ -950,7 +956,11 @@ func updateVersionFormat(str string) (int, error) {
 
 // QueryServerVersion is used to fetch the version of the server
 func (in *infraService) QueryServerVersion(ctx context.Context) (*model.ServerVersionResponse, error) {
-	dbVersion, err := config.GetConfig(ctx, "version")
+	var mongodbOperator mongodb.MongoOperator
+
+	configOperator := config.NewConfigOperator(mongodbOperator)
+
+	dbVersion, err := configOperator.GetConfig(ctx, "version")
 	if err != nil {
 		return nil, err
 	}

chaoscenter/graphql/server/pkg/chaoshub/service.go

@@ -50,13 +50,15 @@ type Service interface {
 }
 
 type chaosHubService struct {
-	chaosHubOperator *dbSchemaChaosHub.Operator
+	chaosHubOperator   *dbSchemaChaosHub.Operator
+	authConfigOperator *authorization.Operator
 }
 
 // NewService returns a new instance of Service
-func NewService(chaosHubOperator *dbSchemaChaosHub.Operator) Service {
+func NewService(chaosHubOperator *dbSchemaChaosHub.Operator, authConfigOperator *authorization.Operator) Service {
 	return &chaosHubService{
-		chaosHubOperator: chaosHubOperator,
+		chaosHubOperator:   chaosHubOperator,
+		authConfigOperator: authConfigOperator,
 	}
 }
 
@@ -75,7 +77,7 @@ func (c *chaosHubService) AddChaosHub(ctx context.Context, chaosHub model.Create
 	}
 
 	tkn := ctx.Value(authorization.AuthKey).(string)
-	username, err := authorization.GetUsername(tkn)
+	username, err := c.authConfigOperator.GetUsername(tkn)
 	if err != nil {
 		log.Error("error getting username: ", err)
 		return nil, err
@@ -144,7 +146,7 @@ func (c *chaosHubService) AddRemoteChaosHub(ctx context.Context, chaosHub model.
 	currentTime := time.Now()
 
 	tkn := ctx.Value(authorization.AuthKey).(string)
-	username, err := authorization.GetUsername(tkn)
+	username, err := c.authConfigOperator.GetUsername(tkn)
 
 	if err != nil {
 		log.Error("error getting userID: ", err)
@@ -211,7 +213,7 @@ func (c *chaosHubService) SaveChaosHub(ctx context.Context, chaosHub model.Creat
 	// Initialize a UID for new Hub.
 	uuid := uuid.New()
 	tkn := ctx.Value(authorization.AuthKey).(string)
-	username, err := authorization.GetUsername(tkn)
+	username, err := c.authConfigOperator.GetUsername(tkn)
 
 	if err != nil {
 		log.Error("error getting userID: ", err)
@@ -367,7 +369,7 @@ func (c *chaosHubService) UpdateChaosHub(ctx context.Context, chaosHub model.Upd
 
 	time := time.Now().UnixMilli()
 	tkn := ctx.Value(authorization.AuthKey).(string)
-	username, err := authorization.GetUsername(tkn)
+	username, err := c.authConfigOperator.GetUsername(tkn)
 
 	query := bson.D{{"hub_id", chaosHub.ID}, {"is_removed", false}}
 	update := bson.D{
@@ -410,7 +412,7 @@ func (c *chaosHubService) UpdateChaosHub(ctx context.Context, chaosHub model.Upd
 
 func (c *chaosHubService) DeleteChaosHub(ctx context.Context, hubID string, projectID string) (bool, error) {
 	tkn := ctx.Value(authorization.AuthKey).(string)
-	username, err := authorization.GetUsername(tkn)
+	username, err := c.authConfigOperator.GetUsername(tkn)
 	if err != nil {
 		return false, err
 	}

chaoscenter/graphql/server/pkg/database/mongodb/chaos_hub/operations.go

@@ -92,7 +92,7 @@ func (c *Operator) UpdateChaosHub(ctx context.Context, query bson.D, update bson
 
 // GetAggregateChaosHubs takes a mongo pipeline to retrieve the project details from the database
 func (c *Operator) GetAggregateChaosHubs(ctx context.Context, pipeline mongo.Pipeline) (*mongo.Cursor, error) {
-	results, err := mongodb.Operator.Aggregate(ctx, mongodb.ChaosHubCollection, pipeline)
+	results, err := c.operator.Aggregate(ctx, mongodb.ChaosHubCollection, pipeline)
 	if err != nil {
 		return nil, fmt.Errorf("error on getting the chaos hubs : %v", err)
 	}