Improve error message for host mismatch between bundle and profile used (#3100)

## Changes
Improve error message for host mismatch between bundle and profile used

## Why
Now we make the wording a bit more explicit and include suggestion which
config profile can be used.

## Tests
Covered by existing acceptance tests

<!-- If your PR needs to be included in the release notes for next
release,
add a separate entry in NEXT_CHANGELOG.md as part of your PR. -->

Author: andrewnester

NEXT_CHANGELOG.md

@@ -9,6 +9,7 @@
 ### CLI
 
 ### Bundles
+* Improve error message for host mismatch between bundle and profile used ([#3100](https://github.com/databricks/cli/pull/3100))
 * Remove support for deprecated `experimental/pydabs` config, use `experimental/python` instead. See [Configuration in Python
 ](https://docs.databricks.com/dev-tools/bundles/python). ([#3102](https://github.com/databricks/cli/pull/3102))
 

acceptance/auth/bundle_and_profile/output.txt

@@ -19,7 +19,7 @@ Exit code: 1
 
 === Inside the bundle, target and not matching profile
 >>> errcode [CLI] current-user me -t dev -p profile_name
-Error: cannot resolve bundle auth configuration: config host mismatch: profile uses host https://non-existing-subdomain.databricks.com, but CLI configured to use [DATABRICKS_TARGET]
+Error: cannot resolve bundle auth configuration: the host in the profile (https://non-existing-subdomain.databricks.com) doesn’t match the host configured in the bundle ([DATABRICKS_TARGET]). The profile "DEFAULT" has host="[DATABRICKS_TARGET]" that matches host in the bundle. To select it, pass "-p DEFAULT"
 
 Exit code: 1
 
@@ -47,7 +47,7 @@ Validation OK!
 
 === Bundle commands load bundle configuration with -p flag, validation not OK (profile host don't match bundle host)
 >>> errcode [CLI] bundle validate -p profile_name
-Error: cannot resolve bundle auth configuration: config host mismatch: profile uses host https://non-existing-subdomain.databricks.com, but CLI configured to use [DATABRICKS_TARGET]
+Error: cannot resolve bundle auth configuration: the host in the profile (https://non-existing-subdomain.databricks.com) doesn’t match the host configured in the bundle ([DATABRICKS_TARGET]). The profile "DEFAULT" has host="[DATABRICKS_TARGET]" that matches host in the bundle. To select it, pass "-p DEFAULT"
 
 Name: test-auth
 Target: dev
@@ -71,7 +71,7 @@ Validation OK!
 
 === Bundle commands load bundle configuration with -t and -p flag, validation not OK (profile host don't match bundle host)
 >>> errcode [CLI] bundle validate -t prod -p DEFAULT
-Error: cannot resolve bundle auth configuration: config host mismatch: profile uses host [DATABRICKS_TARGET], but CLI configured to use https://bar.com
+Error: cannot resolve bundle auth configuration: the host in the profile ([DATABRICKS_TARGET]) doesn’t match the host configured in the bundle (https://bar.com)
 
 Name: test-auth
 Target: prod

bundle/config/workspace_test.go

@@ -114,7 +114,7 @@ func TestWorkspaceVerifyProfileForHost(t *testing.T) {
 		require.NoError(t, err)
 
 		_, err = w.Client()
-		assert.ErrorContains(t, err, "config host mismatch")
+		assert.ErrorContains(t, err, "doesn’t match the host configured in the bundle")
 	})
 
 	t.Run("custom config file with match", func(t *testing.T) {
@@ -146,6 +146,6 @@ func TestWorkspaceVerifyProfileForHost(t *testing.T) {
 
 		t.Setenv("DATABRICKS_CONFIG_FILE", filepath.Join(home, "customcfg"))
 		_, err = w.Client()
-		assert.ErrorContains(t, err, "config host mismatch")
+		assert.ErrorContains(t, err, "doesn’t match the host configured in the bundle")
 	})
 }

cmd/root/bundle_test.go

@@ -109,7 +109,7 @@ func TestBundleConfigureWithMismatchedProfile(t *testing.T) {
 	require.NoError(t, err)
 
 	err = setupWithHost(t, cmd, "https://x.com")
-	assert.ErrorContains(t, err, "config host mismatch: profile uses host https://a.com, but CLI configured to use https://x.com")
+	assert.ErrorContains(t, err, "the host in the profile (https://a.com) doesn’t match the host configured in the bundle (https://x.com)")
 }
 
 func TestBundleConfigureWithCorrectProfile(t *testing.T) {
@@ -132,7 +132,7 @@ func TestBundleConfigureWithMismatchedProfileEnvVariable(t *testing.T) {
 	cmd := emptyCommand(t)
 
 	err := setupWithHost(t, cmd, "https://x.com")
-	assert.ErrorContains(t, err, "config host mismatch: profile uses host https://a.com, but CLI configured to use https://x.com")
+	assert.ErrorContains(t, err, "the host in the profile (https://a.com) doesn’t match the host configured in the bundle (https://x.com)")
 }
 
 func TestBundleConfigureWithProfileFlagAndEnvVariable(t *testing.T) {

libs/databrickscfg/ops.go

@@ -148,7 +148,16 @@ func ValidateConfigAndProfileHost(cfg *config.Config, profile string) error {
 
 	hostFromProfile := normalizeHost(match.Key("host").Value())
 	if hostFromProfile != "" && host != "" && hostFromProfile != host {
-		return fmt.Errorf("config host mismatch: profile uses host %s, but CLI configured to use %s", hostFromProfile, host)
+		// Try to find if there's a profile which uses the same host as the bundle and suggest in error message
+		match, err = findMatchingProfile(configFile, func(s *ini.Section) bool {
+			return normalizeHost(s.Key("host").Value()) == host
+		})
+		if err == nil && match != nil {
+			profileName := match.Name()
+			return fmt.Errorf("the host in the profile (%s) doesn’t match the host configured in the bundle (%s). The profile \"%s\" has host=\"%s\" that matches host in the bundle. To select it, pass \"-p %s\"", hostFromProfile, host, profileName, host, profileName)
+		}
+
+		return fmt.Errorf("the host in the profile (%s) doesn’t match the host configured in the bundle (%s)", hostFromProfile, host)
 	}
 
 	return nil