Preserve custom profile fields during 'databricks auth login' (#1897) by alyssa-db · Pull Request #2988 · databricks/cli

alyssa-db · 2025-06-04T22:42:44Z

Changes

Fixed an issue where running databricks auth login would remove the cluster_id field from profiles in .databrickscfg. The login process now preserves the cluster_id field.
Added a test to ensure cluster_id is retained after login.

Tests

Added TestLoginPreservesClusterID, which tests a new example profile named cluster-profile in .databrickscfg to see if the cluster_id is properly fetched from the config file path.

Reproduction Steps

Create a profile with extra fields (e.g., cluster_id) in .databrickscfg.
Run databricks auth login.
Previously, cluster_id would be deleted. Now, it is preserved.

…icks#1897)

…ck, added test cases

andrewnester · 2025-06-06T10:30:23Z

@alyssa-db Could you add an entry to CLI section in NEXT_CHANGELOG.md as part of this PR following the format there with a link to your PR?

shreyas-goenka · 2025-06-17T08:43:26Z

 host = https://accounts.cloud.databricks.com
 account_id = id-from-profile
+
+


nit: unnecessary extra new line

shreyas-goenka · 2025-06-17T08:59:06Z

 	assert.EqualError(t, err, "the command is being run in a non-interactive environment, please specify an account ID using --account-id")
 }
+
+func TestLoginPreservesClusterID(t *testing.T) {


Suggested change
funcTestLoginPreservesClusterID(t*testing.T) {
funcTestLoginGetClusterID(t*testing.T) {

shreyas-goenka · 2025-06-17T09:00:13Z

 	assert.EqualError(t, err, "the command is being run in a non-interactive environment, please specify an account ID using --account-id")
 }
+
+func TestLoginPreservesClusterID(t *testing.T) {


The three tests have similar assertions, can be converted to a single table test. See TestPrependWorkspacePrefix for an example.

shreyas-goenka · 2025-06-17T09:02:51Z

 }
 cfg.ClusterID = clusterID
+ } else {
+ cfg.ClusterID, err = getClusterID(ctx, profileName, defaultConfigPath)


style nit: This can be moved above configureCluster instead of having it in the else block. That way you reduce a level of indentation.

shreyas-goenka · 2025-06-17T09:03:33Z

 }
 cfg.ClusterID = clusterID
+ } else {
+ cfg.ClusterID, err = getClusterID(ctx, profileName, defaultConfigPath)


Please also add a comment here explaining we read the existing cluster-id to preserve it when overwriting the profile.

shreyas-goenka

Thank you!

shreyas-goenka

Since we do not have test coverage for this command, could you please manually verify that the auth login command works correctly for these cases?

Both profile and the ~/.databrickscfg file exist.
Both profile and a config file pointed to by DATABRICKS_CONFIG_FILE exist.
The profile does not exist.
Multiple profiles exist with the same name.
~/.databrickscfg does not exist.
DATABRICKS_CONFIG_FILE is set, but no file exists at that path.

Sorry, this is not ideal but this is a pretty important command that we want to ensure does not break. Meanwhile, we are working on patching the Go SDK so that we can make changes with more confidence in the future: databricks/databricks-sdk-go#1233

shreyas-goenka · 2025-06-19T09:30:26Z

 	return split[0]
 }
+
+func getClusterID(ctx context.Context, profileName string) (string, error) {


Instead of directly reading from the config file, can you modify the LoadProfiles method directly for the DefaultProfiler?
You could add ClusterId to the Profile struct as well to make that work:
type Profile struct { Name string Host string AccountID string }
That way, this function can simply call LoadProfiles.

## What changes are proposed in this pull request? This PR relaxes the validation performed on the host URL to allow `http` URLs if the URL points to localhost. This is needed to add acceptance tests in the Databricks CLI for the `databricks auth login` command. For context: The acceptance test framework in the CLI has the ability to spawn a testserver on localhost and record API requests sent to it. We can use the testserver to validate that the correct API requests are being sent during `auth login`, and that the command does not fail. Prompted by databricks/cli#2988 (comment) where I almost let a big regression pass. NO_CHANGELOG=true ## How is this tested? Unit test

shreyas-goenka

Thank you, looks good to me. The comments are minor.

shreyas-goenka

Thanks!

Co-authored-by: shreyas-goenka <88374338+shreyas-goenka@users.noreply.github.com>

github-actions · 2025-06-26T09:33:58Z

An authorized user can trigger integration tests manually by following the instructions below:

Trigger:
go/deco-tests-run/cli

Inputs:

PR number: 2988
Commit SHA: a53376da126c56f9d4f3935f8428b56ea8b4ad1d

Checks will be approved automatically on success.

shreyas-goenka · 2025-06-26T10:37:06Z

Integration tests are green.

## Release v0.258.0 ### Notable Changes * Switch default-python template to use pyproject.toml + dynamic\_version in dev target. uv is now required. ([#3042](#3042)) ### Dependency updates * Upgraded TF provider to 1.84.0 ([#3151](#3151)) ### CLI * Fixed an issue where running `databricks auth login` would remove the `cluster_id` field from profiles in `.databrickscfg`. The login process now preserves the `cluster_id` field. ([#2988](#2988)) ### Bundles * Added support for pipeline environment field ([#3153](#3153)) * "bundle summary" now prints diagnostic warnings to stderr ([#3123](#3123)) * "bundle open" will print the URL before opening the browser ([#3168](#3168))

…#2988) ### Changes - Fixed an issue where running `databricks auth login` would remove the `cluster_id` field from profiles in `.databrickscfg`. The login process now preserves the `cluster_id` field. - Added a test to ensure `cluster_id` is retained after login. Fixes#1897 ## Tests Added `TestLoginPreservesClusterID`, which tests a new example profile named `cluster-profile` in `.databrickscfg` to see if the `cluster_id` is properly fetched from the config file path. ### Reproduction Steps 1. Create a profile with extra fields (e.g., `cluster_id`) in `.databrickscfg`. 2. Run `databricks auth login`. 3. Previously, `cluster_id` would be deleted. Now, it is preserved. --------- Co-authored-by: shreyas-goenka <88374338+shreyas-goenka@users.noreply.github.com> Co-authored-by: Andrew Nester <andrew.nester.dev@gmail.com>

## Release v0.258.0 ### Notable Changes * Switch default-python template to use pyproject.toml + dynamic\_version in dev target. uv is now required. ([#3042](#3042)) ### Dependency updates * Upgraded TF provider to 1.84.0 ([#3151](#3151)) ### CLI * Fixed an issue where running `databricks auth login` would remove the `cluster_id` field from profiles in `.databrickscfg`. The login process now preserves the `cluster_id` field. ([#2988](#2988)) ### Bundles * Added support for pipeline environment field ([#3153](#3153)) * "bundle summary" now prints diagnostic warnings to stderr ([#3123](#3123)) * "bundle open" will print the URL before opening the browser ([#3168](#3168))

Preserve custom profile fields during 'databricks auth login' (databr…
497dc02
…icks#1897)

alyssa-db requested review from andrewnester, anton-107, denik, pietern and shreyas-goenka as code owners June 4, 2025 22:42

refactoring cluster id function
1cca51a

andrewnester reviewed Jun 5, 2025
View reviewed changes

Comment threadcmd/auth/login.go Outdated
Comment threadcmd/auth/login.go Outdated

Address code review comments of missing profile section and error che…
ec4819a
…ck, added test cases

alyssa-db added 3 commits June 6, 2025 11:51

Add changelog entry for cluster_id preservation fix
9977de1

Merge branch 'main' into cluster-id-config-1897
8265d94

Merge branch 'main' into cluster-id-config-1897
7d4489f

alyssa-db requested a review from andrewnester June 10, 2025 23:37

denik reviewed Jun 11, 2025
View reviewed changes

Comment threadcmd/auth/login_test.go Outdated

denik reviewed Jun 11, 2025
View reviewed changes

Comment threadNEXT_CHANGELOG.md Outdated

denik reviewed Jun 11, 2025
View reviewed changes

Comment threadcmd/auth/login.go Outdated

refactored clusterID to only read config file
f183cf5

alyssa-db force-pushed the cluster-id-config-1897 branch from 089ab25 to f183cf5Compare June 13, 2025 01:49

Merge branch 'main' into cluster-id-config-1897
caf536f

alyssa-db requested a review from denik June 13, 2025 02:10

alyssa-db added 2 commits June 13, 2025 15:26

updated changelog
102b1c2

Merge branch 'main' into cluster-id-config-1897
6eb8f6f

shreyas-goenka reviewed Jun 17, 2025
View reviewed changes

alyssa-db added 2 commits June 17, 2025 15:31

Merge branch 'main' into cluster-id-config-1897
f8ce0f1

Refactoring of tests with comments
8ddc65e

alyssa-db force-pushed the cluster-id-config-1897 branch from 7a7a899 to 8ddc65eCompare June 17, 2025 23:33

alyssa-db requested a review from shreyas-goenka June 18, 2025 00:13

shreyas-goenka reviewed Jun 18, 2025
View reviewed changes

Comment threadcmd/auth/login.go Outdated

shreyas-goenka approved these changes Jun 18, 2025
View reviewed changes

alyssa-db force-pushed the cluster-id-config-1897 branch from e11545d to 36425b4Compare June 19, 2025 01:25

Merge branch 'main' into cluster-id-config-1897
f366434

alyssa-db force-pushed the cluster-id-config-1897 branch from 36425b4 to f366434Compare June 19, 2025 01:36

alyssa-db requested a review from shreyas-goenka June 19, 2025 01:37

shreyas-goenka reviewed Jun 19, 2025
View reviewed changes

Merge branch 'databricks:main' into cluster-id-config-1897
c9569f2

alyssa-db force-pushed the cluster-id-config-1897 branch from f86a9d4 to d906caeCompare June 21, 2025 00:30

alyssa-db requested a review from shreyas-goenka June 21, 2025 01:36

alyssa-db force-pushed the cluster-id-config-1897 branch from d906cae to 9b8f930Compare June 21, 2025 09:33

added clusterid to profile
b73cadd

alyssa-db force-pushed the cluster-id-config-1897 branch from 9b8f930 to b73caddCompare June 21, 2025 09:41

alyssa-db added 2 commits June 23, 2025 11:09

Merge branch 'databricks:main' into cluster-id-config-1897
95d2e75

.databrickscfg file
fe8af1c

shreyas-goenka reviewed Jun 24, 2025
View reviewed changes

Comment threadlibs/databrickscfg/profile/profile.go Outdated
Comment threadcmd/auth/login_test.go Outdated

reverted changes and consolidated tests
a8e5018

alyssa-db requested a review from shreyas-goenka June 24, 2025 15:27

shreyas-goenka approved these changes Jun 25, 2025
View reviewed changes

Comment threadcmd/auth/login_test.go Outdated

alyssa-db requested a review from shreyas-goenka June 25, 2025 17:40

alyssa-db enabled auto-merge June 25, 2025 17:41

Update cmd/auth/login_test.go
77e7d18
Co-authored-by: shreyas-goenka <88374338+shreyas-goenka@users.noreply.github.com>

shreyas-goenka disabled auto-merge June 25, 2025 21:07

andrewnester approved these changes Jun 26, 2025
View reviewed changes

Merge branch 'main' into cluster-id-config-1897
a53376d

shreyas-goenka merged commit 0113ee1 into databricks:mainJun 26, 2025

		host = https://accounts.cloud.databricks.com
		account_id = id-from-profile

	funcTestLoginPreservesClusterID(t*testing.T) {
	funcTestLoginGetClusterID(t*testing.T) {

Uh oh!

Conversation

alyssa-db commented Jun 4, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Changes

Tests

Reproduction Steps

Uh oh!

Uh oh!

Uh oh!

andrewnester commented Jun 6, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

shreyas-goenkaJun 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shreyas-goenkaJun 17, 2025

Choose a reason for hiding this comment

Uh oh!

shreyas-goenkaJun 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shreyas-goenkaJun 17, 2025

Choose a reason for hiding this comment

Uh oh!

shreyas-goenkaJun 17, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

shreyas-goenka left a comment

Choose a reason for hiding this comment

Uh oh!

shreyas-goenka left a comment

Choose a reason for hiding this comment

Uh oh!

shreyas-goenkaJun 19, 2025

Choose a reason for hiding this comment

Uh oh!

shreyas-goenka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

shreyas-goenka left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

github-actionsBot commented Jun 26, 2025

Uh oh!

shreyas-goenka commented Jun 26, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

alyssa-db commented Jun 4, 2025•
edited
Loading