gitops validation in api (#5082)

Author: subhashish-devtron

api/bean/gitOps/GitOpsConfig.go

@@ -4,7 +4,7 @@ import "time"
 
 type GitOpsConfigDto struct {
 	Id                    int    `json:"id,omitempty"`
-	Provider              string `json:"provider"`
+	Provider              string `json:"provider" validate:"oneof=GITLAB GITHUB AZURE_DEVOPS BITBUCKET_CLOUD"`
 	Username              string `json:"username"`
 	Token                 string `json:"token"`
 	GitLabGroupId         string `json:"gitLabGroupId"`

api/restHandler/GitOpsConfigRestHandler.go

@@ -21,6 +21,7 @@ import (
 	"encoding/json"
 	"errors"
 	bean2 "github.com/devtron-labs/devtron/api/bean/gitOps"
+	"github.com/devtron-labs/devtron/api/util"
 	"net/http"
 	"strconv"
 
@@ -93,7 +94,7 @@ func (impl GitOpsConfigRestHandlerImpl) CreateGitOpsConfig(w http.ResponseWriter
 	err = impl.validator.Struct(bean)
 	if err != nil {
 		impl.logger.Errorw("validation err, createGitOpsConfig", "err", err, "payload", bean)
-		common.WriteJsonResp(w, err, nil, http.StatusBadRequest)
+		common.WriteJsonResp(w, util.CustomizeValidationError(err), nil, http.StatusBadRequest)
 		return
 	}
 	detailedErrorGitOpsConfigResponse, err := impl.gitOpsConfigService.ValidateAndCreateGitOpsConfig(&bean)
@@ -141,7 +142,7 @@ func (impl GitOpsConfigRestHandlerImpl) UpdateGitOpsConfig(w http.ResponseWriter
 	err = impl.validator.Struct(bean)
 	if err != nil {
 		impl.logger.Errorw("validation err, updateGitOpsConfig", "err", err, "payload", bean)
-		common.WriteJsonResp(w, err, nil, http.StatusBadRequest)
+		common.WriteJsonResp(w, util.CustomizeValidationError(err), nil, http.StatusBadRequest)
 		return
 	}
 	detailedErrorGitOpsConfigResponse, err := impl.gitOpsConfigService.ValidateAndUpdateGitOpsConfig(&bean)

api/util/errorUtils.go

@@ -0,0 +1,20 @@
+package util
+
+import (
+	"errors"
+	"fmt"
+	"gopkg.in/go-playground/validator.v9"
+)
+
+func CustomizeValidationError(err error) error {
+	if validatorErr := (validator.ValidationErrors{}); errors.As(err, &validatorErr) {
+		fieldErr := validatorErr[0]
+		switch fieldErr.Tag() {
+		case "required":
+			return fmt.Errorf("field %s is required %v", fieldErr.Field(), err)
+		case "oneof":
+			return fmt.Errorf("value %s is unsupported  %v", fieldErr.Value(), err)
+		}
+	}
+	return err
+}