Introduce new bundle variable: ${workspace.current_user.domain_friendly_name} (#3623)

## Why
<!-- Why are these changes needed? Provide the context that the reviewer
might be missing.
For example, were there any decisions behind the change that are not
reflected in the code itself? -->

`${workspace.current_user.dns_name}` will allow bundle authors to prefix
apps and database instances resources with caller's usernames (useful
for development targets). Currently `short_name` does not always fit
this purpose because it can contain characters that apps / database
instances do not allow in the names of resources.

## Tests
<!-- How have you tested the changes? -->
- Existing tests
- New unit test with transformation examples
- Manual check that `dns_name` can be used as a bundle variable

<!-- 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: anton-107

NEXT_CHANGELOG.md

@@ -10,5 +10,6 @@
 
 ### Bundles
 * Add new Lakeflow Pipelines support for bundle generate ([#3568](https://github.com/databricks/cli/pull/3568))
+* Introduce new bundle variable: `${workspace.current_user.domain_friendly_name}` ([#3623](https://github.com/databricks/cli/pull/3623))
 
 ### API Changes

acceptance/bundle/deployment/bind/alert/out.test.toml

@@ -57,6 +57,7 @@
   "workspace": {
     "artifact_path": "/Workspace/Users/[USERNAME]/.bundle/foobar/default/artifacts",
     "current_user": {
+      "domain_friendly_name": "[USERNAME]",
       "id": "[USERID]",
       "short_name": "[USERNAME]",
       "userName": "[USERNAME]"

acceptance/bundle/validate/job-references/output.txt

@@ -33,8 +33,9 @@ func (m *populateCurrentUser) Apply(ctx context.Context, b *bundle.Bundle) diag.
 	}
 
 	b.Config.Workspace.CurrentUser = &config.User{
-		ShortName: iamutil.GetShortUserName(me),
-		User:      me,
+		ShortName:          iamutil.GetShortUserName(me),
+		DomainFriendlyName: iamutil.GetShortUserDomainFriendlyName(me),
+		User:               me,
 	}
 
 	// Configure tagging object now that we know we have a valid client.

bundle/config/mutator/populate_current_user.go

@@ -72,6 +72,10 @@ type User struct {
 	// A short name for the user, based on the user's UserName.
 	ShortName string `json:"short_name,omitempty" bundle:"readonly"`
 
+	// A short name for the user that is stripped off of non-alphanumeric character
+	// Can be used as a prefix for resources that use their name as part of their URL (e.g. Apps, Database Instances)
+	DomainFriendlyName string `json:"domain_friendly_name,omitempty" bundle:"readonly"`
+
 	*iam.User
 }
 

bundle/config/workspace.go

@@ -18,3 +18,13 @@ func GetShortUserName(user *iam.User) string {
 	local, _, _ := strings.Cut(name, "@")
 	return textutil.NormalizeString(local)
 }
+
+// GetShortUserDomainFriendlyName returns a dns-friendly for of the user name based on short name
+// We replace all non-alphanumeric characters with a dash (following Databricks Apps' naming requirements)
+func GetShortUserDomainFriendlyName(user *iam.User) string {
+	name := GetShortUserName(user)
+	return strings.ToLower(textutil.Chain(
+		textutil.NormalizeMarks(),
+		textutil.ReplaceNotIn(textutil.Alphanumeric, '-'),
+	).TransformString(name))
+}

libs/iamutil/user.go

@@ -111,3 +111,126 @@ func TestGetShortUserName(t *testing.T) {
 		assert.Equal(t, tt.expected, GetShortUserName(tt.user))
 	}
 }
+
+func TestGetShortUserDomainFriendlyName(t *testing.T) {
+	tests := []struct {
+		name     string
+		user     *iam.User
+		expected string
+	}{
+		{
+			name: "basic email with dots",
+			user: &iam.User{
+				UserName: "test.user.1234@example.com",
+			},
+			expected: "test-user-1234",
+		},
+		{
+			name: "email with underscores",
+			user: &iam.User{
+				UserName: "test_user@example.com",
+			},
+			expected: "test-user",
+		},
+		{
+			name: "email with special characters",
+			user: &iam.User{
+				UserName: "test$#%user@example.com",
+			},
+			expected: "test-user",
+		},
+		{
+			name: "service principal with display name",
+			user: &iam.User{
+				UserName:    `1706906c-c0a2-4c25-9f57-3a7aa3cb8123`,
+				DisplayName: "my_service_principal",
+			},
+			expected: "my-service-principal",
+		},
+		{
+			name: "uppercase letters should be lowercased",
+			user: &iam.User{
+				UserName: "John.Doe@COMPANY.COM",
+			},
+			expected: "john-doe",
+		},
+		{
+			name: "mixed case with numbers",
+			user: &iam.User{
+				UserName: "User123.Test@example.com",
+			},
+			expected: "user123-test",
+		},
+		{
+			name: "unicode characters with normalization",
+			user: &iam.User{
+				UserName: "tést.üser@example.com",
+			},
+			expected: "test-user",
+		},
+		{
+			name: "complex special characters",
+			user: &iam.User{
+				UserName: "user+tag&more@example.com",
+			},
+			expected: "user-tag-more",
+		},
+		{
+			name: "service principal with mixed case display name",
+			user: &iam.User{
+				UserName:    `1706906c-c0a2-4c25-9f57-3a7aa3cb8123`,
+				DisplayName: "My_Service_Principal",
+			},
+			expected: "my-service-principal",
+		},
+		{
+			name: "email with multiple consecutive special chars",
+			user: &iam.User{
+				UserName: "test...user___name@example.com",
+			},
+			expected: "test-user-name",
+		},
+		{
+			name: "chinese characters in email",
+			user: &iam.User{
+				UserName: "用户.测试@example.com",
+			},
+			expected: "-----",
+		},
+		{
+			name: "japanese characters in email",
+			user: &iam.User{
+				UserName: "ユーザー.テスト@example.com",
+			},
+			expected: "--------",
+		},
+		{
+			name: "emoji in email",
+			user: &iam.User{
+				UserName: "user😀.test🚀@example.com",
+			},
+			expected: "user-test",
+		},
+		{
+			name: "mixed latin and chinese characters",
+			user: &iam.User{
+				UserName: "john.李明@company.com",
+			},
+			expected: "john---",
+		},
+		{
+			name: "service principal with emoji display name",
+			user: &iam.User{
+				UserName:    "1706906c-c0a2-4c25-9f57-3a7aa3cb8123",
+				DisplayName: "bot🤖_service",
+			},
+			expected: "bot-service",
+		},
+	}
+
+	for _, tt := range tests {
+		t.Run(tt.name, func(t *testing.T) {
+			assert.Equal(t, tt.expected, GetShortUserDomainFriendlyName(tt.user))
+		})
+	}
+}

libs/iamutil/user_test.go

@@ -9,3 +9,16 @@ var Latin1 = &unicode.RangeTable{
 	},
 	LatinOffset: 1,
 }
+
+// Range table for alphanumeric characters (ASCII letters and digits only).
+var Alphanumeric = &unicode.RangeTable{
+	R16: []unicode.Range16{
+		// ASCII digits 0-9
+		{0x0030, 0x0039, 1},
+		// ASCII uppercase letters A-Z
+		{0x0041, 0x005A, 1},
+		// ASCII lowercase letters a-z
+		{0x0061, 0x007A, 1},
+	},
+	LatinOffset: 3,
+}