feat: added description field for environment (#3020)

* Changes for cluster name instead of server url

* Further changes for use cluster name

* adding description field

* revert another branch change

* minor changes

* changes in description

* minor changes

* rename file

* sql file rename

* query changes for app/other-env api

* minor api changes

* update sql script file name

* minor api changes

* minor api changes for description

* api changes

Author: mayank-devtron

api/bean/AppView.go

@@ -115,6 +115,7 @@ type AppEnvironmentContainer struct {
 	Active                      bool                      `json:"-"`
 	TeamId                      int                       `json:"teamId"`
 	TeamName                    string                    `json:"teamName"`
+	Description                 string                    `json:"description" validate:"max=40"`
 	TotalCount                  int                       `json:"-"`
 }
 
@@ -151,6 +152,7 @@ type DeploymentDetailContainer struct {
 	DockerRegistryId              string          `json:"dockerRegistryId,omitempty"`
 	IpsAccessProvided             bool            `json:"ipsAccessProvided"`
 	DeploymentAppDeleteRequest    bool            `json:"deploymentAppDeleteRequest"`
+	Description                   string          `json:"description" validate:"max=40"`
 }
 
 type AppDetailContainer struct {
@@ -179,6 +181,7 @@ type Environment struct {
 	ChartRefId                 int    `json:"chartRefId"`
 	LastDeployed               string `json:"lastDeployed"`
 	DeploymentAppDeleteRequest bool   `json:"deploymentAppDeleteRequest"`
+	Description                string `json:"description" validate:"max=40"`
 }
 
 type InstanceDetail struct {

internal/sql/repository/AppListingRepository.go

@@ -634,7 +634,7 @@ func (impl AppListingRepositoryImpl) FetchOtherEnvironment(appId int) ([]*bean.E
 	var otherEnvironments []*bean.Environment
 	query := "select OE.*,B.status as app_status " +
 		"FROM " +
-		"(SELECT p.environment_id,env.environment_name, p.last_deployed,  env_app_m.app_metrics, env.default as prod, env_app_m.infra_metrics, p.deployment_app_delete_request from ( SELECT pl.id,pl.app_id,pl.environment_id,pl.deleted, pl.deployment_app_delete_request,MAX(pco.created_on) as last_deployed from pipeline pl LEFT JOIN pipeline_config_override pco on pco.pipeline_id = pl.id WHERE pl.app_id = ? and pl.deleted = FALSE GROUP BY pl.id) p INNER JOIN environment env on env.id=p.environment_id LEFT JOIN env_level_app_metrics env_app_m on env.id=env_app_m.env_id and p.app_id = env_app_m.app_id where p.app_id=? and p.deleted = FALSE AND env.active = TRUE GROUP BY 1,2,3,4,5,6,7) OE " +
+		"(SELECT p.environment_id,env.environment_name,env.description, p.last_deployed,  env_app_m.app_metrics, env.default as prod, env_app_m.infra_metrics, p.deployment_app_delete_request from ( SELECT pl.id,pl.app_id,pl.environment_id,pl.deleted, pl.deployment_app_delete_request,MAX(pco.created_on) as last_deployed from pipeline pl LEFT JOIN pipeline_config_override pco on pco.pipeline_id = pl.id WHERE pl.app_id = ? and pl.deleted = FALSE GROUP BY pl.id) p INNER JOIN environment env on env.id=p.environment_id LEFT JOIN env_level_app_metrics env_app_m on env.id=env_app_m.env_id and p.app_id = env_app_m.app_id where p.app_id=? and p.deleted = FALSE AND env.active = TRUE GROUP BY 1,2,3,4,5,6,7,8) OE " +
 		" LEFT JOIN app_status B ON OE.environment_id = B.env_id AND B.app_id = ? ;"
 	impl.Logger.Debugw("other env query:", query)
 	_, err := impl.dbConnection.Query(&otherEnvironments, query, appId, appId, appId)
@@ -647,7 +647,7 @@ func (impl AppListingRepositoryImpl) FetchOtherEnvironment(appId int) ([]*bean.E
 func (impl AppListingRepositoryImpl) FetchMinDetailOtherEnvironment(appId int) ([]*bean.Environment, error) {
 	impl.Logger.Debug("reached at FetchMinDetailOtherEnvironment:")
 	var otherEnvironments []*bean.Environment
-	query := `SELECT p.environment_id,env.environment_name, env.default as prod, p.deployment_app_delete_request,
+	query := `SELECT p.environment_id,env.environment_name,env.description, env.default as prod, p.deployment_app_delete_request,
        			env_app_m.app_metrics,env_app_m.infra_metrics from 
  				(SELECT pl.id,pl.app_id,pl.environment_id,pl.deleted, pl.deployment_app_delete_request from pipeline pl 
   					LEFT JOIN pipeline_config_override pco on pco.pipeline_id = pl.id where pl.app_id = ? and pl.deleted = FALSE 

pkg/bean/app.go

@@ -466,6 +466,7 @@ type CDPipelineConfigObject struct {
 	Id                            int                                    `json:"id,omitempty"  validate:"number" `
 	EnvironmentId                 int                                    `json:"environmentId,omitempty"  validate:"number,required" `
 	EnvironmentName               string                                 `json:"environmentName,omitempty" `
+	Description                   string                                 `json:"description" validate:"max=40"`
 	CiPipelineId                  int                                    `json:"ciPipelineId,omitempty" validate:"number"`
 	TriggerType                   pipelineConfig.TriggerType             `json:"triggerType,omitempty" validate:"oneof=AUTOMATIC MANUAL"`
 	Name                          string                                 `json:"name,omitempty" validate:"name-component,max=50"` //pipelineName

pkg/cluster/EnvironmentService.go

@@ -44,6 +44,7 @@ type EnvironmentBean struct {
 	Namespace             string `json:"namespace,omitempty" validate:"name-space-component,max=50"`
 	CdArgoSetup           bool   `json:"isClusterCdActive"`
 	EnvironmentIdentifier string `json:"environmentIdentifier"`
+	Description           string `json:"description" validate:"max=40"`
 	AppCount              int    `json:"appCount"`
 }
 
@@ -52,6 +53,7 @@ type EnvDto struct {
 	EnvironmentName       string `json:"environmentName,omitempty" validate:"max=50"`
 	Namespace             string `json:"namespace,omitempty" validate:"name-space-component,max=50"`
 	EnvironmentIdentifier string `json:"environmentIdentifier,omitempty"`
+	Description           string `json:"description" validate:"max=40"`
 }
 
 type ClusterEnvDto struct {
@@ -144,6 +146,7 @@ func (impl EnvironmentServiceImpl) Create(mappings *EnvironmentBean, userId int3
 		Active:                mappings.Active,
 		Namespace:             mappings.Namespace,
 		Default:               mappings.Default,
+		Description:           mappings.Description,
 		EnvironmentIdentifier: identifier,
 	}
 	model.CreatedBy = userId
@@ -192,6 +195,7 @@ func (impl EnvironmentServiceImpl) FindOne(environment string) (*EnvironmentBean
 		Namespace:             model.Namespace,
 		Default:               model.Default,
 		EnvironmentIdentifier: model.EnvironmentIdentifier,
+		Description:           model.Description,
 	}
 	return bean, nil
 }
@@ -214,6 +218,7 @@ func (impl EnvironmentServiceImpl) GetAll() ([]EnvironmentBean, error) {
 			Default:               model.Default,
 			CdArgoSetup:           model.Cluster.CdArgoSetup,
 			EnvironmentIdentifier: model.EnvironmentIdentifier,
+			Description:           model.Description,
 		})
 	}
 	return beans, nil
@@ -236,6 +241,7 @@ func (impl EnvironmentServiceImpl) GetAllActive() ([]EnvironmentBean, error) {
 			Namespace:             model.Namespace,
 			Default:               model.Default,
 			EnvironmentIdentifier: model.EnvironmentIdentifier,
+			Description:           model.Description,
 		})
 	}
 	return beans, nil
@@ -256,6 +262,7 @@ func (impl EnvironmentServiceImpl) FindById(id int) (*EnvironmentBean, error) {
 		Namespace:             model.Namespace,
 		Default:               model.Default,
 		EnvironmentIdentifier: model.EnvironmentIdentifier,
+		Description:           model.Description,
 	}
 
 	/*clusterBean := &ClusterBean{
@@ -288,6 +295,7 @@ func (impl EnvironmentServiceImpl) Update(mappings *EnvironmentBean, userId int3
 	model.Default = mappings.Default
 	model.UpdatedBy = userId
 	model.UpdatedOn = time.Now()
+	model.Description = mappings.Description
 
 	//namespace create if not exist
 	if len(model.Namespace) > 0 {
@@ -367,6 +375,7 @@ func (impl EnvironmentServiceImpl) GetEnvironmentListForAutocomplete() ([]Enviro
 			CdArgoSetup:           model.Cluster.CdArgoSetup,
 			EnvironmentIdentifier: model.EnvironmentIdentifier,
 			ClusterName:           model.Cluster.ClusterName,
+			Description:           model.Description,
 		})
 	}
 	return beans, nil
@@ -421,6 +430,7 @@ func (impl EnvironmentServiceImpl) FindByIds(ids []*int) ([]*EnvironmentBean, er
 			Default:               model.Default,
 			EnvironmentIdentifier: model.EnvironmentIdentifier,
 			ClusterId:             model.ClusterId,
+			Description:           model.Description,
 		})
 	}
 	return beans, nil
@@ -443,6 +453,7 @@ func (impl EnvironmentServiceImpl) GetByClusterId(id int) ([]*EnvironmentBean, e
 			Environment:           model.Name,
 			Namespace:             model.Namespace,
 			EnvironmentIdentifier: model.EnvironmentIdentifier,
+			Description:           model.Description,
 		})
 	}
 	return beans, nil
@@ -490,6 +501,7 @@ func (impl EnvironmentServiceImpl) GetCombinedEnvironmentListForDropDown(emailId
 			EnvironmentName:       model.Name,
 			Namespace:             model.Namespace,
 			EnvironmentIdentifier: model.EnvironmentIdentifier,
+			Description:           model.Description,
 		})
 	}
 
@@ -578,6 +590,7 @@ func (impl EnvironmentServiceImpl) GetCombinedEnvironmentListForDropDownByCluste
 			EnvironmentName:       model.Name,
 			Namespace:             model.Namespace,
 			EnvironmentIdentifier: model.EnvironmentIdentifier,
+			Description:           model.Description,
 		})
 	}
 

pkg/cluster/repository/EnvironmentRepository.go

@@ -36,6 +36,7 @@ type Environment struct {
 	GrafanaDatasourceId   int    `sql:"grafana_datasource_id"`
 	Namespace             string `sql:"namespace"`
 	EnvironmentIdentifier string `sql:"environment_identifier"`
+	Description           string `sql:"description"`
 	sql.AuditLog
 }
 

pkg/pipeline/CiCdPipelineOrchestrator.go

@@ -1342,6 +1342,7 @@ func (impl CiCdPipelineOrchestratorImpl) GetCdPipelinesForApp(appId int) (cdPipe
 			Name:                          dbPipeline.Name,
 			EnvironmentId:                 dbPipeline.EnvironmentId,
 			EnvironmentName:               dbPipeline.Environment.Name,
+			Description:                   dbPipeline.Environment.Description,
 			CiPipelineId:                  dbPipeline.CiPipelineId,
 			TriggerType:                   dbPipeline.TriggerType,
 			PreStage:                      preStage,

pkg/pipeline/PipelineBuilder.go

@@ -2895,6 +2895,7 @@ func (impl PipelineBuilderImpl) GetCdPipelinesForApp(appId int) (cdPipelines *be
 			Name:                          dbPipeline.Name,
 			EnvironmentId:                 dbPipeline.EnvironmentId,
 			EnvironmentName:               environment.Name,
+			Description:                   environment.Description,
 			CiPipelineId:                  dbPipeline.CiPipelineId,
 			DeploymentTemplate:            deploymentTemplate,
 			TriggerType:                   dbPipeline.TriggerType,

pkg/pipeline/PropertiesConfig.go

@@ -55,6 +55,7 @@ type EnvironmentProperties struct {
 	IsOverride        bool                        `sql:"isOverride"`
 	IsBasicViewLocked bool                        `json:"isBasicViewLocked"`
 	CurrentViewEditor models.ChartsViewEditorType `json:"currentViewEditor"` //default "UNDEFINED" in db
+	Description       string                      `json:"description" validate:"max=40"`
 }
 
 type EnvironmentPropertiesResponse struct {
@@ -159,6 +160,7 @@ func (impl PropertiesConfigServiceImpl) GetEnvironmentProperties(appId, environm
 			ManualReviewed:    envOverride.ManualReviewed,
 			Active:            envOverride.Active,
 			Namespace:         env.Namespace,
+			Description:       env.Description,
 			EnvironmentId:     environmentId,
 			EnvironmentName:   env.Name,
 			Latest:            envOverride.Latest,

scripts/sql/127_alter_environment_description.down.sql

@@ -0,0 +1 @@
+ALTER TABLE environment DROP COLUMN description;

scripts/sql/127_alter_environment_description.up.sql

@@ -0,0 +1,3 @@
+ALTER TABLE environment ADD COLUMN description VARCHAR(40);
+
+