Add support for environment type

Author: JeffreyCA

cli/azd/cmd/container.go

@@ -177,10 +177,19 @@ func registerCommonDependencies(container *ioc.NestedContainer) {
 		// semantics to follow.
 		envValue, err := cmd.Flags().GetString(internal.EnvironmentNameFlagName)
 		if err != nil {
-			log.Printf("'%s'command asked for envFlag, but envFlag was not included in cmd.Flags().", cmd.CommandPath())
+			log.Printf("'%s' command asked for envFlag, but envFlag was not included in cmd.Flags().", cmd.CommandPath())
 			envValue = ""
 		}
 
+		envTypeValue, err := cmd.Flags().GetString(internal.EnvironmentTypeFlagName)
+		if err != nil {
+			log.Printf(
+				"'%s' command asked for envTypeFlag, but envTypeFlag was not included in cmd.Flags().",
+				cmd.CommandPath(),
+			)
+			envTypeValue = ""
+		}
+
 		if envValue == "" {
 			// If no explicit environment flag was set, but one was provided
 			// in the context, use that instead.
@@ -190,7 +199,10 @@ func registerCommonDependencies(container *ioc.NestedContainer) {
 			}
 		}
 
-		return internal.EnvFlag{EnvironmentName: envValue}
+		return internal.EnvFlag{
+			EnvironmentName: envValue,
+			EnvironmentType: envTypeValue,
+		}
 	})
 
 	container.MustRegisterSingleton(func(cmd *cobra.Command) CmdAnnotations {
@@ -229,9 +241,10 @@ func registerCommonDependencies(container *ioc.NestedContainer) {
 			}
 
 			environmentName := envFlags.EnvironmentName
+			environmentType := envFlags.EnvironmentType
 			var err error
 
-			env, err := envManager.LoadOrInitInteractive(ctx, environmentName)
+			env, err := envManager.LoadOrInitInteractiveWithType(ctx, environmentName, environmentType)
 			if err != nil {
 				return nil, fmt.Errorf("loading environment: %w", err)
 			}
@@ -382,14 +395,23 @@ func registerCommonDependencies(container *ioc.NestedContainer) {
 		func(
 			ctx context.Context,
 			lazyAzdContext *lazy.Lazy[*azdcontext.AzdContext],
+			envFlags internal.EnvFlag,
 		) *lazy.Lazy[*project.ProjectConfig] {
 			return lazy.NewLazy(func() (*project.ProjectConfig, error) {
 				azdCtx, err := lazyAzdContext.GetValue()
 				if err != nil {
 					return nil, err
 				}
 
-				projectConfig, err := project.Load(ctx, azdCtx.ProjectPath())
+				// Use environment-specific project path when an environment is specified
+				var projectPath string
+				if envFlags.EnvironmentName != "" {
+					projectPath = azdCtx.ProjectPathForEnvironment(envFlags.EnvironmentName)
+				} else {
+					projectPath = azdCtx.ProjectPath()
+				}
+
+				projectConfig, err := project.Load(ctx, projectPath)
 				if err != nil {
 					return nil, err
 				}
@@ -405,6 +427,7 @@ func registerCommonDependencies(container *ioc.NestedContainer) {
 		lazyProjectConfig *lazy.Lazy[*project.ProjectConfig],
 		lazyAzdContext *lazy.Lazy[*azdcontext.AzdContext],
 		lazyLocalEnvStore *lazy.Lazy[environment.LocalDataStore],
+		envFlags internal.EnvFlag,
 	) (*cloud.Cloud, error) {
 
 		// Precedence for cloud configuration:
@@ -424,8 +447,15 @@ func registerCommonDependencies(container *ioc.NestedContainer) {
 		localEnvStore, _ := lazyLocalEnvStore.GetValue()
 		if azdCtx, err := lazyAzdContext.GetValue(); err == nil {
 			if azdCtx != nil && localEnvStore != nil {
-				if defaultEnvName, err := azdCtx.GetDefaultEnvironmentName(); err == nil {
-					if env, err := localEnvStore.Get(ctx, defaultEnvName); err == nil {
+				var envName string
+				if envFlags.EnvironmentName != "" {
+					envName = envFlags.EnvironmentName
+				} else if defaultEnvName, err := azdCtx.GetDefaultEnvironmentName(); err == nil {
+					envName = defaultEnvName
+				}
+
+				if envName != "" {
+					if env, err := localEnvStore.Get(ctx, envName); err == nil {
 						if cloudConfigurationNode, exists := env.Config.Get(cloud.ConfigPath); exists {
 							if value, err := cloud.ParseCloudConfig(cloudConfigurationNode); err == nil {
 								cloudConfig, err := cloud.NewCloud(value)
@@ -438,7 +468,7 @@ func registerCommonDependencies(container *ioc.NestedContainer) {
 									Suggestion: fmt.Sprintf(
 										"Set the cloud configuration by editing the 'cloud' node in the config.json "+
 											"file for the %s environment\n%s",
-										defaultEnvName,
+										envName,
 										validClouds,
 									),
 								}

cli/azd/cmd/container_test.go

@@ -11,6 +11,7 @@ import (
 	"github.com/azure/azure-dev/cli/azd/pkg/ioc"
 	"github.com/azure/azure-dev/cli/azd/pkg/lazy"
 	"github.com/azure/azure-dev/cli/azd/pkg/project"
+	"github.com/spf13/cobra"
 	"github.com/stretchr/testify/require"
 )
 
@@ -19,6 +20,13 @@ func Test_Lazy_Project_Config_Resolution(t *testing.T) {
 	container := ioc.NewNestedContainer(nil)
 	ioc.RegisterInstance(container, ctx)
 
+	// Register a mock cobra command for testing
+	mockCmd := &cobra.Command{}
+	mockCmd.SetContext(ctx)
+	// Add the environment flag to avoid the "envFlag was not included in cmd.Flags()" error
+	mockCmd.Flags().StringP("environment", "e", "", "Environment name")
+	ioc.RegisterInstance(container, mockCmd)
+
 	registerCommonDependencies(container)
 
 	// Register the testing lazy component
@@ -88,6 +96,13 @@ func Test_Lazy_AzdContext_Resolution(t *testing.T) {
 	container := ioc.NewNestedContainer(nil)
 	ioc.RegisterInstance(container, ctx)
 
+	// Register a mock cobra command for testing
+	mockCmd := &cobra.Command{}
+	mockCmd.SetContext(ctx)
+	// Add the environment flag to avoid the "envFlag was not included in cmd.Flags()" error
+	mockCmd.Flags().StringP("environment", "e", "", "Environment name")
+	ioc.RegisterInstance(container, mockCmd)
+
 	registerCommonDependencies(container)
 
 	// Register the testing lazy component

cli/azd/cmd/env.go

@@ -9,6 +9,7 @@ import (
 	"fmt"
 	"io"
 	"os"
+	"path/filepath"
 	"slices"
 	"strings"
 	"time"
@@ -27,6 +28,7 @@ import (
 	"github.com/azure/azure-dev/cli/azd/pkg/infra/provisioning/bicep"
 	"github.com/azure/azure-dev/cli/azd/pkg/input"
 	"github.com/azure/azure-dev/cli/azd/pkg/keyvault"
+	"github.com/azure/azure-dev/cli/azd/pkg/osutil"
 	"github.com/azure/azure-dev/cli/azd/pkg/output"
 	"github.com/azure/azure-dev/cli/azd/pkg/output/ux"
 	"github.com/azure/azure-dev/cli/azd/pkg/project"
@@ -808,6 +810,7 @@ func (e *envListAction) Run(ctx context.Context) (*actions.ActionResult, error)
 type envNewFlags struct {
 	subscription string
 	location     string
+	envType      string
 	global       *internal.GlobalCommandOptions
 }
 
@@ -819,6 +822,7 @@ func (f *envNewFlags) Bind(local *pflag.FlagSet, global *internal.GlobalCommandO
 		"Name or ID of an Azure subscription to use for the new environment",
 	)
 	local.StringVarP(&f.location, "location", "l", "", "Azure location for the new environment")
+	local.StringVarP(&f.envType, "type", "t", "", "The type of the environment (e.g., dev, test, prod). (Experimental)")
 
 	f.global = global
 }
@@ -870,17 +874,69 @@ func (en *envNewAction) Run(ctx context.Context) (*actions.ActionResult, error)
 		environmentName = en.args[0]
 	}
 
+	envType := en.flags.envType
 	envSpec := environment.Spec{
 		Name:         environmentName,
 		Subscription: en.flags.subscription,
 		Location:     en.flags.location,
+		Type:         envType,
 	}
 
 	env, err := en.envManager.Create(ctx, envSpec)
 	if err != nil {
 		return nil, fmt.Errorf("creating new environment: %w", err)
 	}
 
+	// Create environment-specific project file if environment type is specified
+	if envType != "" {
+		envProjectFileName := azdcontext.ProjectFileNameForEnvironmentType(envType)
+		envProjectPath := filepath.Join(en.azdCtx.ProjectDirectory(), envProjectFileName)
+
+		if _, err := os.Stat(envProjectPath); os.IsNotExist(err) {
+			// Check for current project file to copy from
+			currentProjectFileName := en.azdCtx.ProjectFileName()
+			currentProjectPath := en.azdCtx.ProjectPath()
+			shouldCopy := false
+
+			if _, err := os.Stat(currentProjectPath); err == nil {
+				// Prompt user if they want to copy content from azure.yaml
+				shouldCopy, err = en.console.Confirm(ctx, input.ConsoleOptions{
+					Message:      fmt.Sprintf("Copy contents of %s to %s?", currentProjectFileName, envProjectFileName),
+					DefaultValue: true,
+				})
+				if err != nil {
+					return nil, fmt.Errorf("prompting to copy azure.yaml content: %w", err)
+				}
+			} else if !os.IsNotExist(err) {
+				return nil, fmt.Errorf("checking for %s: %w", currentProjectFileName, err)
+			}
+
+			if shouldCopy {
+				content, err := os.ReadFile(currentProjectPath)
+				if err != nil {
+					return nil, fmt.Errorf("reading main project file: %w", err)
+				}
+
+				if err := os.WriteFile(envProjectPath, content, osutil.PermissionFile); err != nil {
+					return nil, fmt.Errorf("creating environment project file: %w", err)
+				}
+
+				en.console.MessageUxItem(ctx, &ux.DoneMessage{
+					Message: fmt.Sprintf("Created %s", envProjectFileName),
+				})
+			} else {
+				_, err = project.New(ctx, envProjectPath, azdcontext.ProjectName(en.azdCtx.ProjectDirectory()))
+				if err != nil {
+					return nil, fmt.Errorf("creating empty project file: %w", err)
+				}
+
+				en.console.MessageUxItem(ctx, &ux.DoneMessage{
+					Message: fmt.Sprintf("Created empty %s", envProjectFileName),
+				})
+			}
+		}
+	}
+
 	envs, err := en.envManager.List(ctx)
 	if err != nil {
 		return nil, fmt.Errorf("listing environments: %w", err)

cli/azd/cmd/testdata/TestUsage-azd-deploy.snap

@@ -10,6 +10,7 @@ Usage
 
 Flags
         --all                 	: Deploys all services that are listed in azure.yaml
+        --env-type string     	: The type of the environment (e.g., dev, test, prod). (Experimental)
     -e, --environment string  	: The name of the environment to use.
         --from-package string 	: Deploys the packaged service located at the provided path. Supports zipped file packages (file path) or container images (image tag).
 

cli/azd/cmd/testdata/TestUsage-azd-down.snap

@@ -5,6 +5,7 @@ Usage
   azd down [flags]
 
 Flags
+        --env-type string    	: The type of the environment (e.g., dev, test, prod). (Experimental)
     -e, --environment string 	: The name of the environment to use.
         --force              	: Does not require confirmation before it deletes resources.
         --purge              	: Does not require confirmation before it permanently deletes resources that are soft-deleted by default (for example, key vaults).

cli/azd/cmd/testdata/TestUsage-azd-env-get-value.snap

@@ -5,6 +5,7 @@ Usage
   azd env get-value <keyName> [flags]
 
 Flags
+        --env-type string    	: The type of the environment (e.g., dev, test, prod). (Experimental)
     -e, --environment string 	: The name of the environment to use.
 
 Global Flags

cli/azd/cmd/testdata/TestUsage-azd-env-get-values.snap

@@ -5,6 +5,7 @@ Usage
   azd env get-values [flags]
 
 Flags
+        --env-type string    	: The type of the environment (e.g., dev, test, prod). (Experimental)
     -e, --environment string 	: The name of the environment to use.
 
 Global Flags

cli/azd/cmd/testdata/TestUsage-azd-env-new.snap

@@ -7,6 +7,7 @@ Usage
 Flags
     -l, --location string     	: Azure location for the new environment
         --subscription string 	: Name or ID of an Azure subscription to use for the new environment
+    -t, --type string         	: The type of the environment (e.g., dev, test, prod). (Experimental)
 
 Global Flags
     -C, --cwd string 	: Sets the current working directory.

cli/azd/cmd/testdata/TestUsage-azd-env-refresh.snap

@@ -5,6 +5,7 @@ Usage
   azd env refresh <environment> [flags]
 
 Flags
+        --env-type string    	: The type of the environment (e.g., dev, test, prod). (Experimental)
     -e, --environment string 	: The name of the environment to use.
         --hint string        	: Hint to help identify the environment to refresh
 

cli/azd/cmd/testdata/TestUsage-azd-env-set-secret.snap

@@ -5,6 +5,7 @@ Usage
   azd env set-secret <name> [flags]
 
 Flags
+        --env-type string    	: The type of the environment (e.g., dev, test, prod). (Experimental)
     -e, --environment string 	: The name of the environment to use.
 
 Global Flags