Skip to content

Add unit-test to GetProjectDomain in BaseClient #1094

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
+48 −1
Open

Add unit-test to GetProjectDomain in BaseClient #1094

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
eb50eca
Add unit-test to GetProjectDomain in BaseClient
edw-defang Mar 31, 2025
f27b88c
Add stack even when the project name is the same as the tenant name
edw-defang Apr 1, 2025
aa1bf30
Merge branch 'main' into edw/add-get-project-domain-test
lionello May 9, 2025
bd9ccd2
Merge branch 'main' into edw/add-get-project-domain-test
lionello Jun 3, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/pkg/cli/client/byoc/baseclient.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,12 +121,14 @@ func (b *ByocBaseClient) GetProjectDomain(projectName, zone string) string {
return "" // no project name => no custom domain
}
projectLabel := DnsSafeLabel(projectName)
var domain string
if projectLabel == DnsSafeLabel(b.TenantName) {
return DnsSafe(zone) // the zone will already have the tenant ID
domain = DnsSafe(zone) // the zone will already have the tenant ID
} else {
domain = projectLabel + "." + DnsSafe(zone)
}
domain := projectLabel + "." + DnsSafe(zone)
if hasStack, ok := b.projectBackend.(HasStackSupport); ok {
domain = hasStack.GetStackName() + "." + domain
domain = DnsSafeLabel(hasStack.GetStackName()) + "." + domain
}
return domain
}
Expand Down
47 changes: 47 additions & 0 deletions src/pkg/cli/client/byoc/baseclient_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -171,3 +171,50 @@ func TestGetServiceInfosWithTestData(t *testing.T) {
})
}
}

type TestProjectBackendWithStack struct {
ProjectBackend
stack string
}

func (t TestProjectBackendWithStack) GetStackName() string {
return t.stack
}

type TestProjectBackendWithoutStack struct {
ProjectBackend
}

func TestGetProjectDomain(t *testing.T) {
tests := []struct {
projectName string
zone string
tenantName string
projectBackend ProjectBackend
expected string
}{
{"", "test-zone", "test-tenant", TestProjectBackendWithoutStack{}, ""},
{"", "test-zone", "test-tenant", TestProjectBackendWithStack{stack: "test-stack"}, ""},
Comment on lines +197 to +198
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess this is unlikely (or impossible) based on validation further up the stack, but should we generate a project prefix in this case (or panic)?

{"test-project", "test-zone", "test-tenant", TestProjectBackendWithoutStack{}, "test-project.test-zone"},
{"test-project", "test-zone", "test-tenant", TestProjectBackendWithStack{stack: "test-stack"}, "test-stack.test-project.test-zone"},
{"project-is-tenant-name", "test-zone", "project-is-tenant-name", TestProjectBackendWithoutStack{}, "test-zone"},
{"project-is-tenant-name", "test-zone", "project-is-tenant-name", TestProjectBackendWithStack{stack: "test-stack"}, "test-stack.test-zone"},
{"Test.Project", "tesT.zonE", "test-tenant", TestProjectBackendWithoutStack{}, "test-project.test.zone"},
{"Test.Project", "tesT.zonE", "test-tenant", TestProjectBackendWithStack{stack: "test-stack"}, "test-stack.test-project.test.zone"},
{"test-project", "test-zone", "test-tenant", TestProjectBackendWithStack{stack: "tEst.sTack"}, "test-stack.test-project.test-zone"},
}

for _, tt := range tests {
stack := "no-stack"
if hasStack, ok := tt.projectBackend.(HasStackSupport); ok {
stack = hasStack.GetStackName()
}
t.Run(fmt.Sprintf("%s-%s-%s-%s", tt.projectName, tt.zone, tt.tenantName, stack), func(t *testing.T) {
b := &ByocBaseClient{TenantName: tt.tenantName, projectBackend: tt.projectBackend}
actual := b.GetProjectDomain(tt.projectName, tt.zone)
if actual != tt.expected {
t.Errorf("expected %q, got %q", tt.expected, actual)
}
})
}
}
Loading