Add databricks auth switch command for setting the default profile

acceptance/cmd/auth/describe/default-profile/output.txt

@@ -0,0 +1,15 @@
+
+=== Describe without --profile (should use default)
+
+>>> [CLI] auth describe
+Host: [DATABRICKS_URL]
+User: [USERNAME]
+Authenticated with: pat
+-----
+Current configuration:
+  ✓ host: [DATABRICKS_URL] (from DATABRICKS_HOST environment variable)
+  ✓ token: ******** (from DATABRICKS_TOKEN environment variable)
+  ✓ profile: my-workspace
+  ✓ databricks_cli_path: [CLI]
+  ✓ auth_type: pat
+  ✓ rate_limit: [NUMID] (from DATABRICKS_RATE_LIMIT environment variable)

acceptance/cmd/auth/describe/default-profile/script

@@ -0,0 +1,20 @@
+sethome "./home"
+
+# Create a config with two profiles and an explicit default.
+cat > "./home/.databrickscfg" <<EOF
+[DEFAULT]
+
+[my-workspace]
+host  = $DATABRICKS_HOST
+token = $DATABRICKS_TOKEN
+
+[other-workspace]
+host  = https://other.cloud.databricks.com
+token = other-token
+
+[__settings__]
+default_profile = my-workspace
+EOF
+
+title "Describe without --profile (should use default)\n"
+trace $CLI auth describe

acceptance/cmd/auth/describe/default-profile/test.toml

@@ -0,0 +1,3 @@
+Ignore = [
+    "home"
+]

acceptance/cmd/auth/login/nominal/out.databrickscfg

@@ -4,3 +4,6 @@
 [test]
 host      = [DATABRICKS_URL]
 auth_type = databricks-cli
+
+[__settings__]
+default_profile = test

acceptance/cmd/auth/login/nominal/output.txt

@@ -3,5 +3,5 @@
 Profile test was successfully saved
 
 >>> [CLI] auth profiles
-Name  Host                    Valid
-test  [DATABRICKS_URL]  YES
+Name            Host                    Valid
+test (Default)  [DATABRICKS_URL]  YES

acceptance/cmd/auth/login/with-scopes/out.databrickscfg

@@ -5,3 +5,6 @@
 host      = [DATABRICKS_URL]
 scopes    = jobs,pipelines,clusters
 auth_type = databricks-cli
+
+[__settings__]
+default_profile = scoped-test

acceptance/cmd/auth/switch/nominal/out.databrickscfg

@@ -0,0 +1,15 @@
+; The profile defined in the DEFAULT section is to be used as a fallback when no profile is explicitly specified.
+[DEFAULT]
+
+[profile-a]
+host      = https://profile-a.cloud.databricks.com
+token     = token-a
+auth_type = pat
+
+[profile-b]
+host      = https://profile-b.cloud.databricks.com
+token     = token-b
+auth_type = pat
+
+[__settings__]
+default_profile = profile-b

acceptance/cmd/auth/switch/nominal/output.txt

@@ -0,0 +1,46 @@
+
+=== Initial config
+; The profile defined in the DEFAULT section is to be used as a fallback when no profile is explicitly specified.
+[DEFAULT]
+
+[profile-a]
+host      = https://profile-a.cloud.databricks.com
+token     = token-a
+auth_type = pat
+
+[profile-b]
+host      = https://profile-b.cloud.databricks.com
+token     = token-b
+auth_type = pat
+
+=== Switch to profile-a
+
+>>> [CLI] auth switch --profile profile-a
+Default profile set to "profile-a".
+
+=== Settings after first switch
+[__settings__]
+default_profile = profile-a
+
+=== Profiles after first switch
+
+>>> [CLI] auth profiles --skip-validate
+Name                 Host                                    Valid
+profile-a (Default)  https://profile-a.cloud.databricks.com  NO
+profile-b            https://profile-b.cloud.databricks.com  NO
+
+=== Switch to profile-b
+
+>>> [CLI] auth switch --profile profile-b
+Default profile set to "profile-b".
+
+=== Settings after second switch
+[__settings__]
+default_profile = profile-b
+
+=== Profiles after second switch
+
+>>> [CLI] auth profiles --skip-validate
+Name                 Host                                    Valid
+profile-a            https://profile-a.cloud.databricks.com  NO
+profile-b (Default)  https://profile-b.cloud.databricks.com  NO

acceptance/cmd/auth/switch/nominal/script

@@ -0,0 +1,41 @@
+sethome "./home"
+
+# Create two profiles without a [__settings__] section.
+cat > "./home/.databrickscfg" <<'EOF'
+; The profile defined in the DEFAULT section is to be used as a fallback when no profile is explicitly specified.
+[DEFAULT]
+
+[profile-a]
+host      = https://profile-a.cloud.databricks.com
+token     = token-a
+auth_type = pat
+
+[profile-b]
+host      = https://profile-b.cloud.databricks.com
+token     = token-b
+auth_type = pat
+EOF
+
+title "Initial config\n"
+cat "./home/.databrickscfg"
+
+title "Switch to profile-a\n"
+trace $CLI auth switch --profile profile-a
+
+title "Settings after first switch\n"
+cat "./home/.databrickscfg" | grep -A1 __settings__
+
+title "Profiles after first switch\n"
+trace $CLI auth profiles --skip-validate
+
+title "Switch to profile-b\n"
+trace $CLI auth switch --profile profile-b
+
+title "Settings after second switch\n"
+cat "./home/.databrickscfg" | grep -A1 __settings__
+
+title "Profiles after second switch\n"
+trace $CLI auth profiles --skip-validate
+
+# Track the final .databrickscfg to surface changes.
+cp "./home/.databrickscfg" "./out.databrickscfg"

acceptance/cmd/auth/switch/nominal/test.toml

@@ -0,0 +1,3 @@
+Ignore = [
+    "home"
+]

cmd/auth/auth.go

@@ -33,6 +33,7 @@ GCP: https://docs.gcp.databricks.com/dev-tools/auth/index.html`,
 	cmd.AddCommand(newProfilesCommand())
 	cmd.AddCommand(newTokenCommand(&authArguments))
 	cmd.AddCommand(newDescribeCommand())
+	cmd.AddCommand(newSwitchCommand())
 	return cmd
 }
 

cmd/auth/describe.go

@@ -177,13 +177,15 @@ func getAuthDetails(cmd *cobra.Command, cfg *config.Config, showSensitive bool)
 		}
 	}
 
-	// If profile is not set explicitly, default to "default"
+	// If profile is not set explicitly, show which profile is being used.
+	// When a default_profile is configured, MustWorkspaceClient/MustAccountClient
+	// resolves it before we get here, so cfg.Profile is already set.
 	if _, ok := details.Configuration["profile"]; !ok {
-		profile := cfg.Profile
-		if profile == "" {
-			profile = "default"
+		displayProfile := cfg.Profile
+		if displayProfile == "" {
+			displayProfile = "default"
 		}
-		details.Configuration["profile"] = &config.AttrConfig{Value: profile, Source: config.Source{Type: config.SourceDynamicConfig}}
+		details.Configuration["profile"] = &config.AttrConfig{Value: displayProfile, Source: config.Source{Type: config.SourceDynamicConfig}}
 	}
 
 	// Unset source for databricks_cli_path because it can't be overridden anyway

cmd/auth/login.go

@@ -240,6 +240,9 @@ depends on the existing profiles you have set in your configuration file
 		}
 
 		if profileName != "" {
+			configFile := env.Get(ctx, "DATABRICKS_CONFIG_FILE")
+			isFirst := databrickscfg.IsFirstProfile(ctx, configFile)
+
 			err := databrickscfg.SaveToProfile(ctx, &config.Config{
 				Profile:                    profileName,
 				Host:                       authArguments.Host,
@@ -248,14 +251,17 @@ depends on the existing profiles you have set in your configuration file
 				WorkspaceID:                authArguments.WorkspaceID,
 				Experimental_IsUnifiedHost: authArguments.IsUnifiedHost,
 				ClusterID:                  clusterID,
-				ConfigFile:                 env.Get(ctx, "DATABRICKS_CONFIG_FILE"),
+				ConfigFile:                 configFile,
 				ServerlessComputeID:        serverlessComputeID,
 				Scopes:                     scopesList,
 			}, clearKeys...)
 			if err != nil {
 				return err
 			}
 
+			if isFirst {
+				databrickscfg.SetDefaultProfileQuietly(ctx, profileName, configFile)
+			}
 			cmdio.LogString(ctx, fmt.Sprintf("Profile %s was successfully saved", profileName))
 		}
 

cmd/auth/profiles.go

@@ -9,6 +9,7 @@ import (
 	"time"
 
 	"github.com/databricks/cli/libs/cmdio"
+	"github.com/databricks/cli/libs/databrickscfg"
 	"github.com/databricks/cli/libs/databrickscfg/profile"
 	"github.com/databricks/cli/libs/env"
 	"github.com/databricks/cli/libs/log"
@@ -26,6 +27,7 @@ type profileMetadata struct {
 	Cloud       string `json:"cloud"`
 	AuthType    string `json:"auth_type"`
 	Valid       bool   `json:"valid"`
+	Default     bool   `json:"default,omitempty"`
 }
 
 func (c *profileMetadata) IsEmpty() bool {
@@ -92,7 +94,7 @@ func newProfilesCommand() *cobra.Command {
 		Annotations: map[string]string{
 			"template": cmdio.Heredoc(`
 			{{header "Name"}}	{{header "Host"}}	{{header "Valid"}}
-			{{range .Profiles}}{{.Name | green}}	{{.Host|cyan}}	{{bool .Valid}}
+			{{range .Profiles}}{{.Name | green}}{{if .Default}} (Default){{end}}	{{.Host|cyan}}	{{bool .Valid}}
 			{{end}}`),
 		},
 	}
@@ -111,6 +113,9 @@ func newProfilesCommand() *cobra.Command {
 		} else if err != nil {
 			return fmt.Errorf("cannot parse config file: %w", err)
 		}
+
+		defaultProfile := databrickscfg.GetConfiguredDefaultProfileFrom(iniFile)
+
 		var wg sync.WaitGroup
 		for _, v := range iniFile.Sections() {
 			hash := v.KeysHash()
@@ -119,6 +124,7 @@ func newProfilesCommand() *cobra.Command {
 				Host:        hash["host"],
 				AccountID:   hash["account_id"],
 				WorkspaceID: hash["workspace_id"],
+				Default:     v.Name() == defaultProfile,
 			}
 			if profile.IsEmpty() {
 				continue

cmd/auth/profiles_test.go

@@ -43,3 +43,34 @@ func TestProfiles(t *testing.T) {
 	assert.Equal(t, "aws", profile.Cloud)
 	assert.Equal(t, "pat", profile.AuthType)
 }
+
+func TestProfilesDefaultMarker(t *testing.T) {
+	ctx := t.Context()
+	dir := t.TempDir()
+	configFile := filepath.Join(dir, ".databrickscfg")
+
+	// Create two profiles.
+	for _, name := range []string{"profile-a", "profile-b"} {
+		err := databrickscfg.SaveToProfile(ctx, &config.Config{
+			ConfigFile: configFile,
+			Profile:    name,
+			Host:       "https://" + name + ".cloud.databricks.com",
+			Token:      "token",
+		})
+		require.NoError(t, err)
+	}
+
+	// Set profile-a as the default.
+	err := databrickscfg.SetDefaultProfile(ctx, "profile-a", configFile)
+	require.NoError(t, err)
+
+	t.Setenv("HOME", dir)
+	if runtime.GOOS == "windows" {
+		t.Setenv("USERPROFILE", dir)
+	}
+
+	// Read back the default profile and verify.
+	defaultProfile, err := databrickscfg.GetDefaultProfile(ctx, configFile)
+	require.NoError(t, err)
+	assert.Equal(t, "profile-a", defaultProfile)
+}