feat(manifest): loader.Load(...) includes unselected environments as not enabled environments with Enabled: false

In order to be able to check environment and group overrides in `project.LoadProject(...)` they need not to be removed in `loader.Load(...)`. Instead, this function marks them as not enabled, with `Enabled: false`.

Author: arthurpitman

cmd/monaco/delete/delete.go

@@ -38,6 +38,9 @@ import (
 func Delete(ctx context.Context, environments manifest.Environments, entriesToDelete delete.DeleteEntries) error {
 	var envsWithDeleteErrs []string
 	for _, env := range environments {
+		if !env.Enabled {
+			continue
+		}
 		ctx := context.WithValue(ctx, log.CtxKeyEnv{}, log.CtxValEnv{Name: env.Name, Group: env.Group})
 		if containsPlatformTypes(entriesToDelete) && env.Auth.OAuth == nil {
 			log.WithCtxFields(ctx).Warn("Delete file contains Dynatrace Platform specific types, but no oAuth credentials are defined for environment %q - Dynatrace Platform configurations won't be deleted.", env.Name)

cmd/monaco/dynatrace/dynatrace.go

@@ -51,6 +51,9 @@ func VerifyEnvironmentGeneration(ctx context.Context, envs manifest.Environments
 		return true
 	}
 	for _, env := range envs {
+		if !env.Enabled {
+			continue
+		}
 		if !isValidEnvironment(ctx, env) {
 			return false
 		}
@@ -189,6 +192,9 @@ func (e EnvironmentClients) Names() []string {
 func CreateEnvironmentClients(ctx context.Context, environments manifest.Environments, dryRun bool) (EnvironmentClients, error) {
 	clients := make(EnvironmentClients, len(environments))
 	for _, env := range environments {
+		if !env.Enabled {
+			continue
+		}
 		if dryRun {
 			clients[EnvironmentInfo{
 				Name:  env.Name,

cmd/monaco/dynatrace/dynatrace_test.go

@@ -81,15 +81,17 @@ func TestVerifyEnvironmentGeneration_OneOfManyFails(t *testing.T) {
 
 	ok := VerifyEnvironmentGeneration(t.Context(), manifest.Environments{
 		"env": manifest.EnvironmentDefinition{
-			Name: "env",
+			Enabled: true,
+			Name:    "env",
 			URL: manifest.URLDefinition{
 				Type:  manifest.ValueURLType,
 				Name:  "URL",
 				Value: server.URL,
 			},
 		},
 		"env2": manifest.EnvironmentDefinition{
-			Name: "env2",
+			Enabled: true,
+			Name:    "env2",
 			URL: manifest.URLDefinition{
 				Type:  manifest.ValueURLType,
 				Name:  "URL",
@@ -144,7 +146,8 @@ func TestVerifyEnvironmentGen(t *testing.T) {
 
 		ok := VerifyEnvironmentGeneration(t.Context(), manifest.Environments{
 			"env": manifest.EnvironmentDefinition{
-				Name: "env",
+				Enabled: true,
+				Name:    "env",
 				URL: manifest.URLDefinition{
 					Type:  manifest.ValueURLType,
 					Name:  "URL",
@@ -177,7 +180,8 @@ func TestVerifyEnvironmentGen(t *testing.T) {
 
 		ok := VerifyEnvironmentGeneration(t.Context(), manifest.Environments{
 			"env": manifest.EnvironmentDefinition{
-				Name: "env",
+				Enabled: true,
+				Name:    "env",
 				URL: manifest.URLDefinition{
 					Type:  manifest.ValueURLType,
 					Name:  "URL",
@@ -216,7 +220,8 @@ func TestVerifyEnvironmentGen(t *testing.T) {
 
 		ok := VerifyEnvironmentGeneration(t.Context(), manifest.Environments{
 			"env1": manifest.EnvironmentDefinition{
-				Name: "env1",
+				Enabled: true,
+				Name:    "env1",
 				URL: manifest.URLDefinition{
 					Type:  manifest.ValueURLType,
 					Name:  "URL",
@@ -228,7 +233,8 @@ func TestVerifyEnvironmentGen(t *testing.T) {
 
 		ok = VerifyEnvironmentGeneration(t.Context(), manifest.Environments{
 			"env2": manifest.EnvironmentDefinition{
-				Name: "env2",
+				Enabled: true,
+				Name:    "env2",
 				URL: manifest.URLDefinition{
 					Type:  manifest.ValueURLType,
 					Name:  "URL",

cmd/monaco/integrationtest/assert.go

@@ -74,6 +74,9 @@ func AssertAllConfigsAvailability(t *testing.T, fs afero.Fs, manifestPath string
 	envNames := make([]string, 0, len(loadedManifest.Environments))
 
 	for _, env := range loadedManifest.Environments {
+		if !env.Enabled {
+			continue
+		}
 		envNames = append(envNames, env.Name)
 	}
 

cmd/monaco/integrationtest/v2/skip_e2e_test.go

@@ -104,6 +104,9 @@ func TestSkip(t *testing.T) {
 	clients := make(map[string]client.SettingsClient)
 
 	for name, def := range loadedManifest.Environments {
+		if !def.Enabled {
+			continue
+		}
 		set := integrationtest.CreateDynatraceClients(t, def)
 		clients[name] = set.SettingsClient
 	}

cmd/monaco/purge/purge.go

@@ -63,6 +63,9 @@ func purge(ctx context.Context, fs afero.Fs, deploymentManifestPath string, envi
 func purgeConfigs(ctx context.Context, environments []manifest.EnvironmentDefinition, apis api.APIs) error {
 
 	for _, env := range environments {
+		if !env.Enabled {
+			continue
+		}
 		err := purgeForEnvironment(ctx, env, apis)
 		if err != nil {
 			return err

pkg/config/loader/config_entry_loader.go

@@ -61,6 +61,9 @@ func parseConfigEntry(
 	var results []config.Config
 	var errs []error
 	for _, env := range loaderContext.Environments {
+		if !env.Enabled {
+			continue
+		}
 
 		result, definitionErrors := parseDefinitionForEnvironment(fs, singleConfigContext, configId, env, definition, groupOverrideMap, environmentOverrideMap)
 

pkg/config/loader/config_loader_test.go

@@ -53,9 +53,10 @@ func Test_parseConfigs(t *testing.T) {
 		KnownApis: map[string]struct{}{"some-api": {}, api.DashboardShareSettings: {}},
 		Environments: []manifest.EnvironmentDefinition{
 			{
-				Name:  "env name",
-				URL:   manifest.URLDefinition{Type: manifest.ValueURLType, Value: "env url"},
-				Group: "default",
+				Enabled: true,
+				Name:    "env name",
+				URL:     manifest.URLDefinition{Type: manifest.ValueURLType, Value: "env url"},
+				Group:   "default",
 				Auth: manifest.Auth{
 					Token: &manifest.AuthSecret{Name: "token var"},
 				},

pkg/config/loader/parameter_integration_test.go

@@ -39,7 +39,7 @@ func TestParametersAreLoadedAsExpected(t *testing.T) {
 
 	loaderContext := LoaderContext{
 		Environments: []manifest.EnvironmentDefinition{
-			{Name: "testEnv"},
+			{Enabled: true, Name: "testEnv"},
 		},
 		KnownApis:       map[string]struct{}{"some-api": {}},
 		ParametersSerDe: config.DefaultParameterParsers,

pkg/config/loader/template_integration_test.go

@@ -39,7 +39,7 @@ func TestConfigurationTemplatingFromFilesProducesValidJson(t *testing.T) {
 
 	loaderContext := LoaderContext{
 		Environments: []manifest.EnvironmentDefinition{
-			{Name: "testEnv"},
+			{Enabled: true, Name: "testEnv"},
 		},
 		KnownApis:       map[string]struct{}{"some-api": {}},
 		ParametersSerDe: config.DefaultParameterParsers,

pkg/manifest/loader/manifest_loader.go

@@ -377,9 +377,10 @@ func parseEnvironments(context *Context, groups []persistence.Group) (map[string
 			}
 			envNames[env.Name] = true
 
-			// skip loading if environments is not empty, the environments does not contain the env name, or the group should not be included
+			// skip actually loading if environments is not empty, the environments does not contain the env name, or the group should not be included
 			if shouldSkipEnv(context, group, env) {
 				log.WithFields(field.F("manifestPath", context.ManifestPath)).Debug("skipping loading of environment %q", env.Name)
+				environments[env.Name] = manifest.EnvironmentDefinition{Enabled: false, Name: env.Name, Group: group.Name}
 				continue
 			}
 
@@ -449,10 +450,11 @@ func parseSingleEnvironment(context *Context, config persistence.Environment, gr
 	}
 
 	return manifest.EnvironmentDefinition{
-		Name:  config.Name,
-		URL:   urlDef,
-		Auth:  a,
-		Group: group,
+		Enabled: true,
+		Name:    config.Name,
+		URL:     urlDef,
+		Auth:    a,
+		Group:   group,
 	}, nil
 }