chore: improve env, stage and cluster gathering

leonsteinhaeuser · leonsteinhaeuser · commit e862614084b9 · 2025-03-16T20:10:39.000+01:00
diff --git a/cmd/main.go b/cmd/main.go
@@ -117,7 +117,7 @@ func main() {
 				}
 
 				if event.Environment != "" && event.Stage == "" && event.Cluster == "" {
-					env := projectConfig.Environments[event.Environment]
+					env := projectConfig.GetEnvironment(event.Environment)
 					err := executeHook(os.Stdout, os.Stderr, event.Type, event.Runtime, env.Actions)
 					if err != nil {
 						fmt.Println(err)
@@ -126,7 +126,7 @@ func main() {
 				}
 
 				if event.Environment != "" && event.Stage != "" && event.Cluster == "" {
-					stage := projectConfig.Environments[event.Environment].Stages[event.Stage]
+					stage := projectConfig.GetStage(event.Environment, event.Stage)
 					err := executeHook(os.Stdout, os.Stderr, event.Type, event.Runtime, stage.Actions)
 					if err != nil {
 						fmt.Println(err)
@@ -135,7 +135,7 @@ func main() {
 				}
 
 				if event.Environment != "" && event.Stage != "" && event.Cluster != "" {
-					cluster := projectConfig.Cluster(event.Environment, event.Stage, event.Cluster)
+					cluster := projectConfig.GetCluster(event.Environment, event.Stage, event.Cluster)
 					if event.Type == menu.EventTypeCreate || event.Type == menu.EventTypeUpdate {
 						err := cluster.Render(projectConfig, event.Environment, event.Stage)
 						if err != nil {
diff --git a/internal/menu/cluster.go b/internal/menu/cluster.go
@@ -87,7 +87,7 @@ func (c *clusterMenu) menuSettings(env, stage string, cluster *project.Cluster)
 
 // menuUpdateCluster creates a context menu to update an existing cluster
 func (c *clusterMenu) menuUpdateCluster(envName, stageName, clusterName string) (*project.Cluster, error) {
-	cluster := c.config.Cluster(envName, stageName, clusterName)
+	cluster := c.config.GetCluster(envName, stageName, clusterName)
 	if cluster.Name == "" {
 		cluster.Name = clusterName
 	}
@@ -108,7 +108,7 @@ func (c *clusterMenu) menuDeleteCluster(env, stage, cluster string) (*project.Cl
 	if !confirmation {
 		return nil, fmt.Errorf("confirmation denied")
 	}
-	return c.config.Cluster(env, stage, cluster), nil
+	return c.config.GetCluster(env, stage, cluster), nil
 }
 
 func (c *clusterMenu) menuClusterSettingsProperties(env, stage string, cluster *project.Cluster) (map[string]string, error) {
diff --git a/internal/menu/environment.go b/internal/menu/environment.go
@@ -23,7 +23,7 @@ func (e *environmentMenu) menuCreateEnvironment() (*project.Environment, error)
 		if s == "" {
 			return fmt.Errorf("environment name cannot be empty")
 		}
-		if _, ok := e.config.Environments[s]; ok {
+		if e.config.HasEnvironment(s) {
 			return fmt.Errorf("environment already exists")
 		}
 		return nil
@@ -48,8 +48,7 @@ func (e *environmentMenu) menuCreateEnvironment() (*project.Environment, error)
 }
 
 func (e *environmentMenu) menuUpdateEnvironment(envName string) (*project.Environment, error) {
-	environment := e.config.Environments[envName]
-	environment.Name = envName
+	environment := e.config.GetEnvironment(envName)
 	if environment.Addons == nil {
 		environment.Addons = map[string]*project.ClusterAddon{}
 	}
@@ -105,9 +104,9 @@ func (e *environmentMenu) menuDeleteEnvironment(envName string) (*project.Enviro
 	if !confirmation {
 		return nil, fmt.Errorf("confirmation denied")
 	}
-	environment := *e.config.Environments[envName]
+	environment := e.config.GetEnvironment(envName)
 	environment.Name = envName
-	return &environment, errors.New("menuDeleteEnvironment not implemented")
+	return environment, errors.New("menuDeleteEnvironment not implemented")
 }
 
 func (e *environmentMenu) menuEnvironmentProperties(env *project.Environment) (map[string]string, error) {
diff --git a/internal/menu/root.go b/internal/menu/root.go
@@ -67,7 +67,7 @@ func RootMenu(config *project.ProjectConfig, eventCh chan<- Event) error {
 				}
 
 				eventCh <- newPreUpdateEvent(EventOriginEnvironment, environment.Name, "", "")
-				config.Environments[*env].Properties = environment.Properties
+				config.GetEnvironment(environment.Name).Properties = environment.Properties
 				eventCh <- newPostUpdateEvent(EventOriginEnvironment, environment.Name, "", "")
 				return nil
 			}
@@ -110,7 +110,7 @@ func RootMenu(config *project.ProjectConfig, eventCh chan<- Event) error {
 
 				eventCh <- newPreCreateEvent(EventOriginStage, *envName, stage.Name, "")
 				// add stage to config
-				config.Environments[*envName].Stages[stage.Name] = stage
+				config.GetEnvironment(*envName).Stages[stage.Name] = stage
 				eventCh <- newPostCreateEvent(EventOriginStage, *envName, stage.Name, "")
 				return nil
 			}
@@ -128,7 +128,7 @@ func RootMenu(config *project.ProjectConfig, eventCh chan<- Event) error {
 
 				eventCh <- newPreUpdateEvent(EventOriginStage, *envName, *stageName, "")
 				// update stage in config
-				config.Environments[*envName].Stages[stage.Name] = stage
+				config.GetEnvironment(*envName).Stages[stage.Name] = stage
 				eventCh <- newPostUpdateEvent(EventOriginStage, *envName, stage.Name, "")
 				return nil
 			}
@@ -295,7 +295,7 @@ func menuSelectEnvironment(config *project.ProjectConfig) (*string, error) {
 func menuSelectStage(config *project.ProjectConfig, environment string) (*string, error) {
 	prompt := promptui.Select{
 		Label: "Select Stage",
-		Items: append(utils.MapKeysToList(config.Environments[environment].Stages), rootOptionDone),
+		Items: append(utils.MapKeysToList(config.GetEnvironment(environment).Stages), rootOptionDone),
 	}
 	_, result, err := prompt.Run()
 	if err != nil {
@@ -329,7 +329,7 @@ func menuHierarchySelectEnvironmentStage(config *project.ProjectConfig) (*string
 func menuSelectCluster(config *project.ProjectConfig, environment, stage string) (*string, error) {
 	prompt := promptui.Select{
 		Label: "Select Cluster",
-		Items: append(utils.MapKeysToList(config.Environments[environment].Stages[stage].Clusters), rootOptionDone),
+		Items: append(utils.MapKeysToList(config.GetStage(environment, stage).Clusters), rootOptionDone),
 	}
 	_, result, err := prompt.Run()
 	if err != nil {
diff --git a/internal/menu/stage.go b/internal/menu/stage.go
@@ -23,7 +23,7 @@ func (s *stageMenu) menuCreateStage(env string) (*project.Stage, error) {
 		if str == "" {
 			return fmt.Errorf("stage name cannot be empty")
 		}
-		if _, ok := s.config.Environments[env].Stages[str]; ok {
+		if s.config.GetEnvironment(env).HasStage(str) {
 			return fmt.Errorf("stage already exists")
 		}
 		return nil
@@ -49,8 +49,7 @@ func (s *stageMenu) menuCreateStage(env string) (*project.Stage, error) {
 }
 
 func (s *stageMenu) menuUpdateStage(envName, stageName string) (*project.Stage, error) {
-	stage := s.config.Environments[envName].Stages[stageName]
-	stage.Name = stageName
+	stage := s.config.GetStage(envName, stageName)
 	if stage.Addons == nil {
 		stage.Addons = map[string]*project.ClusterAddon{}
 	}
diff --git a/internal/project/environment.go b/internal/project/environment.go
@@ -50,3 +50,14 @@ func (e *Environment) GetAddons() ClusterAddons {
 func (e *Environment) GetAddon(name string) *ClusterAddon {
 	return e.Addons[name]
 }
+
+// HasStage checks if a stage exists in the environment
+func (e *Environment) HasStage(name string) bool {
+	_, ok := e.Stages[name]
+	return ok
+}
+
+// GetStage returns the stage by name
+func (e *Environment) GetStage(name string) *Stage {
+	return e.Stages[name]
+}
diff --git a/internal/project/stage.go b/internal/project/stage.go
@@ -50,3 +50,8 @@ func (s *Stage) GetAddons() ClusterAddons {
 func (s *Stage) GetAddon(name string) *ClusterAddon {
 	return s.Addons[name]
 }
+
+// GetCluster returns the cluster by name
+func (s *Stage) GetCluster(name string) *Cluster {
+	return s.Clusters[name]
+}
diff --git a/internal/project/type.go b/internal/project/type.go
@@ -22,29 +22,25 @@ type ProjectConfig struct {
 
 // HasCluster checks if a cluster exists in the given environment and stage
 func (p ProjectConfig) HasCluster(env, stage, cluster string) bool {
-	_, ok := p.Environments[env].Stages[stage].Clusters[cluster]
+	_, ok := p.GetStage(env, stage).Clusters[cluster]
 	return ok
 }
 
-func (p ProjectConfig) Cluster(env, stage, cluster string) *Cluster {
-	return p.Environments[env].Stages[stage].Clusters[cluster]
-}
-
 // SetCluster sets the cluster for the given environment and stage
 func (p *ProjectConfig) SetCluster(env, stage string, cluster *Cluster) {
-	if p.Environments[env].Stages[stage].Clusters == nil {
-		p.Environments[env].Stages[stage].Clusters = map[string]*Cluster{}
+	if p.GetStage(env, stage).Clusters == nil {
+		p.GetStage(env, stage).Clusters = map[string]*Cluster{}
 	}
-	p.Environments[env].Stages[stage].Clusters[cluster.Name] = cluster
+	p.GetStage(env, stage).Clusters[cluster.Name] = cluster
 }
 
 func (p *ProjectConfig) DeleteCluster(env, stage, cluster string) {
-	delete(p.Environments[env].Stages[stage].Clusters, cluster)
+	delete(p.GetStage(env, stage).Clusters, cluster)
 }
 
 // EnvStageProperty merges the properties of the environment and stage and returns them as a map
 func (pc *ProjectConfig) EnvStageProperty(environment, stage string) map[string]string {
-	return utils.MergeMaps(pc.Environments[environment].Properties, pc.Environments[environment].Stages[stage].Properties)
+	return utils.MergeMaps(pc.GetEnvironment(environment).Properties, pc.GetStage(environment, stage).Properties)
 }
 
 // AddonGroups returns a list of addon groups that have been defined in the addons
@@ -58,3 +54,23 @@ func (p ProjectConfig) AddonGroups() []string {
 	}
 	return utils.MapKeysToList(groups)
 }
+
+// HasEnvironment checks if an environment exists in the project
+func (p ProjectConfig) HasEnvironment(name string) bool {
+	_, ok := p.Environments[name]
+	return ok
+}
+
+func (p *ProjectConfig) GetEnvironment(name string) *Environment {
+	p.Environments[name].Name = name
+	return p.Environments[name]
+}
+
+func (p *ProjectConfig) GetStage(env, stage string) *Stage {
+	p.GetEnvironment(env).GetStage(stage).Name = stage
+	return p.GetEnvironment(env).GetStage(stage)
+}
+
+func (p *ProjectConfig) GetCluster(env, stage, cluster string) *Cluster {
+	return p.GetStage(env, stage).GetCluster(cluster)
+}
diff --git a/internal/project/type_test.go b/internal/project/type_test.go
@@ -88,7 +88,7 @@ func TestProjectConfig_HasCluster(t *testing.T) {
 	}
 }
 
-func TestProjectConfig_Cluster(t *testing.T) {
+func TestProjectConfig_GetCluster(t *testing.T) {
 	type fields struct {
 		BasePath         string
 		TemplateBasePath string
@@ -172,10 +172,10 @@ func TestProjectConfig_Cluster(t *testing.T) {
 				Environments:     tt.fields.Environments,
 			}
 
-			got := p.Cluster(tt.args.env, tt.args.stage, tt.args.cluster)
+			got := p.GetCluster(tt.args.env, tt.args.stage, tt.args.cluster)
 			diff := cmp.Diff(got, tt.want)
 			if diff != "" {
-				t.Errorf("ProjectConfig.Cluster() mismatch (-got +want):\n%s", diff)
+				t.Errorf("ProjectConfig.GetCluster() mismatch (-got +want):\n%s", diff)
 				return
 			}
 		})
@@ -241,7 +241,7 @@ func TestProjectConfig_SetCluster(t *testing.T) {
 			}
 			p.SetCluster(tt.args.env, tt.args.stage, tt.args.cluster)
 
-			diff := cmp.Diff(p.Environments[tt.args.env].Stages[tt.args.stage].Clusters[tt.args.cluster.Name], tt.want)
+			diff := cmp.Diff(p.GetCluster(tt.args.env, tt.args.stage, tt.args.cluster.Name), tt.want)
 			if diff != "" {
 				t.Errorf("ProjectConfig.SetCluster() mismatch (-got +want):\n%s", diff)
 				return
@@ -327,7 +327,7 @@ func TestProjectConfig_DeleteCluster(t *testing.T) {
 			}
 			p.DeleteCluster(tt.args.env, tt.args.stage, tt.args.cluster)
 
-			diff := cmp.Diff(p.Environments[tt.args.env].Stages[tt.args.stage].Clusters, tt.want)
+			diff := cmp.Diff(p.GetStage(tt.args.env, tt.args.stage).Clusters, tt.want)
 			if diff != "" {
 				t.Errorf("ProjectConfig.DeleteCluster() mismatch (-got +want):\n%s", diff)
 				return

Original file line number	Diff line number	Diff line change
`@@ -87,7 +87,7 @@ func (c clusterMenu) menuSettings(env, stage string, cluster project.Cluster)`
`87`	`87`
`88`	`88`	`// menuUpdateCluster creates a context menu to update an existing cluster`
`89`	`89`	`func (c clusterMenu) menuUpdateCluster(envName, stageName, clusterName string) (project.Cluster, error) {`
`90`		`- cluster := c.config.Cluster(envName, stageName, clusterName)`
	`90`	`+ cluster := c.config.GetCluster(envName, stageName, clusterName)`
`91`	`91`	`if cluster.Name == "" {`
`92`	`92`	`cluster.Name = clusterName`
`93`	`93`	`}`
`@@ -108,7 +108,7 @@ func (c clusterMenu) menuDeleteCluster(env, stage, cluster string) (project.Cl`
`108`	`108`	`if !confirmation {`
`109`	`109`	`return nil, fmt.Errorf("confirmation denied")`
`110`	`110`	`}`
`111`		`- return c.config.Cluster(env, stage, cluster), nil`
	`111`	`+ return c.config.GetCluster(env, stage, cluster), nil`
`112`	`112`	`}`
`113`	`113`
`114`	`114`	`func (c clusterMenu) menuClusterSettingsProperties(env, stage string, cluster project.Cluster) (map[string]string, error) {`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ func (e environmentMenu) menuCreateEnvironment() (project.Environment, error)`
`23`	`23`	`if s == "" {`
`24`	`24`	`return fmt.Errorf("environment name cannot be empty")`
`25`	`25`	`}`
`26`		`- if _, ok := e.config.Environments[s]; ok {`
	`26`	`+ if e.config.HasEnvironment(s) {`
`27`	`27`	`return fmt.Errorf("environment already exists")`
`28`	`28`	`}`
`29`	`29`	`return nil`
`@@ -48,8 +48,7 @@ func (e environmentMenu) menuCreateEnvironment() (project.Environment, error)`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`func (e environmentMenu) menuUpdateEnvironment(envName string) (project.Environment, error) {`
`51`		`- environment := e.config.Environments[envName]`
`52`		`- environment.Name = envName`
	`51`	`+ environment := e.config.GetEnvironment(envName)`
`53`	`52`	`if environment.Addons == nil {`
`54`	`53`	`environment.Addons = map[string]*project.ClusterAddon{}`
`55`	`54`	`}`
`@@ -105,9 +104,9 @@ func (e environmentMenu) menuDeleteEnvironment(envName string) (project.Enviro`
`105`	`104`	`if !confirmation {`
`106`	`105`	`return nil, fmt.Errorf("confirmation denied")`
`107`	`106`	`}`
`108`		`- environment := *e.config.Environments[envName]`
	`107`	`+ environment := e.config.GetEnvironment(envName)`
`109`	`108`	`environment.Name = envName`
`110`		`- return &environment, errors.New("menuDeleteEnvironment not implemented")`
	`109`	`+ return environment, errors.New("menuDeleteEnvironment not implemented")`
`111`	`110`	`}`
`112`	`111`
`113`	`112`	`func (e environmentMenu) menuEnvironmentProperties(env project.Environment) (map[string]string, error) {`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ func (s stageMenu) menuCreateStage(env string) (project.Stage, error) {`
`23`	`23`	`if str == "" {`
`24`	`24`	`return fmt.Errorf("stage name cannot be empty")`
`25`	`25`	`}`
`26`		`- if _, ok := s.config.Environments[env].Stages[str]; ok {`
	`26`	`+ if s.config.GetEnvironment(env).HasStage(str) {`
`27`	`27`	`return fmt.Errorf("stage already exists")`
`28`	`28`	`}`
`29`	`29`	`return nil`
`@@ -49,8 +49,7 @@ func (s stageMenu) menuCreateStage(env string) (project.Stage, error) {`
`49`	`49`	`}`
`50`	`50`
`51`	`51`	`func (s stageMenu) menuUpdateStage(envName, stageName string) (project.Stage, error) {`
`52`		`- stage := s.config.Environments[envName].Stages[stageName]`
`53`		`- stage.Name = stageName`
	`52`	`+ stage := s.config.GetStage(envName, stageName)`
`54`	`53`	`if stage.Addons == nil {`
`55`	`54`	`stage.Addons = map[string]*project.ClusterAddon{}`
`56`	`55`	`}`
Original file line number	Diff line number	Diff line change
`@@ -50,3 +50,8 @@ func (s *Stage) GetAddons() ClusterAddons {`
`50`	`50`	`func (s Stage) GetAddon(name string) ClusterAddon {`
`51`	`51`	`return s.Addons[name]`
`52`	`52`	`}`
	`53`	`+`
	`54`	`+// GetCluster returns the cluster by name`
	`55`	`+func (s Stage) GetCluster(name string) Cluster {`
	`56`	`+ return s.Clusters[name]`
	`57`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ func TestProjectConfig_HasCluster(t *testing.T) {`
`88`	`88`	`}`
`89`	`89`	`}`
`90`	`90`
`91`		`-func TestProjectConfig_Cluster(t *testing.T) {`
	`91`	`+func TestProjectConfig_GetCluster(t *testing.T) {`
`92`	`92`	`type fields struct {`
`93`	`93`	`BasePath string`
`94`	`94`	`TemplateBasePath string`
`@@ -172,10 +172,10 @@ func TestProjectConfig_Cluster(t *testing.T) {`
`172`	`172`	`Environments: tt.fields.Environments,`
`173`	`173`	`}`
`174`	`174`
`175`		`- got := p.Cluster(tt.args.env, tt.args.stage, tt.args.cluster)`
	`175`	`+ got := p.GetCluster(tt.args.env, tt.args.stage, tt.args.cluster)`
`176`	`176`	`diff := cmp.Diff(got, tt.want)`
`177`	`177`	`if diff != "" {`
`178`		`- t.Errorf("ProjectConfig.Cluster() mismatch (-got +want):\n%s", diff)`
	`178`	`+ t.Errorf("ProjectConfig.GetCluster() mismatch (-got +want):\n%s", diff)`
`179`	`179`	`return`
`180`	`180`	`}`
`181`	`181`	`})`
`@@ -241,7 +241,7 @@ func TestProjectConfig_SetCluster(t *testing.T) {`
`241`	`241`	`}`
`242`	`242`	`p.SetCluster(tt.args.env, tt.args.stage, tt.args.cluster)`
`243`	`243`
`244`		`- diff := cmp.Diff(p.Environments[tt.args.env].Stages[tt.args.stage].Clusters[tt.args.cluster.Name], tt.want)`
	`244`	`+ diff := cmp.Diff(p.GetCluster(tt.args.env, tt.args.stage, tt.args.cluster.Name), tt.want)`
`245`	`245`	`if diff != "" {`
`246`	`246`	`t.Errorf("ProjectConfig.SetCluster() mismatch (-got +want):\n%s", diff)`
`247`	`247`	`return`
`@@ -327,7 +327,7 @@ func TestProjectConfig_DeleteCluster(t *testing.T) {`
`327`	`327`	`}`
`328`	`328`	`p.DeleteCluster(tt.args.env, tt.args.stage, tt.args.cluster)`
`329`	`329`
`330`		`- diff := cmp.Diff(p.Environments[tt.args.env].Stages[tt.args.stage].Clusters, tt.want)`
	`330`	`+ diff := cmp.Diff(p.GetStage(tt.args.env, tt.args.stage).Clusters, tt.want)`
`331`	`331`	`if diff != "" {`
`332`	`332`	`t.Errorf("ProjectConfig.DeleteCluster() mismatch (-got +want):\n%s", diff)`
`333`	`333`	`return`