Skip to content
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

More unit tests for frontend domain handlers #6457

Merged
merged 1 commit into from
Nov 1, 2024
Merged

More unit tests for frontend domain handlers #6457

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
280 changes: 280 additions & 0 deletions service/frontend/api/domain_handers_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,280 @@
// The MIT License (MIT)

// Copyright (c) 2017-2020 Uber Technologies Inc.

// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in all
// copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

package api

import (
"context"
"errors"
"testing"

"github.com/golang/mock/gomock"
"github.com/stretchr/testify/assert"

"github.com/uber/cadence/common/types"
)

func TestDeprecateDomain(t *testing.T) {
testCases := []struct {
name string
req *types.DeprecateDomainRequest
setupMocks func(*mockDeps)
expectError bool
expectedError string
}{
{
name: "success",
req: &types.DeprecateDomainRequest{
Name: "domain-name",
},
setupMocks: func(deps *mockDeps) {
deps.mockRequestValidator.EXPECT().ValidateDeprecateDomainRequest(gomock.Any(), gomock.Any()).Return(nil)
deps.mockDomainHandler.EXPECT().DeprecateDomain(gomock.Any(), gomock.Any()).Return(nil)
},
expectError: false,
},
{
name: "validation error",
req: &types.DeprecateDomainRequest{
Name: "domain-name",
},
setupMocks: func(deps *mockDeps) {
deps.mockRequestValidator.EXPECT().ValidateDeprecateDomainRequest(gomock.Any(), gomock.Any()).Return(errors.New("validation error"))
},
expectError: true,
expectedError: "validation error",
},
{
name: "deprecate domain handler error",
req: &types.DeprecateDomainRequest{
Name: "domain-name",
},
setupMocks: func(deps *mockDeps) {
deps.mockRequestValidator.EXPECT().ValidateDeprecateDomainRequest(gomock.Any(), gomock.Any()).Return(nil)
deps.mockDomainHandler.EXPECT().DeprecateDomain(gomock.Any(), gomock.Any()).Return(errors.New("handler error"))
},
expectError: true,
expectedError: "handler error",
},
}

for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
wh, deps := setupMocksForWorkflowHandler(t)
tc.setupMocks(deps)

err := wh.DeprecateDomain(context.Background(), tc.req)
if tc.expectError {
assert.ErrorContains(t, err, tc.expectedError)
} else {
assert.NoError(t, err)
}
})
}
}

func TestRegisterDomain(t *testing.T) {
testCases := []struct {
name string
req *types.RegisterDomainRequest
setupMocks func(*mockDeps)
expectError bool
expectedError string
}{
{
name: "success",
req: &types.RegisterDomainRequest{
Name: "domain-name",
},
setupMocks: func(deps *mockDeps) {
deps.mockRequestValidator.EXPECT().ValidateRegisterDomainRequest(gomock.Any(), gomock.Any()).Return(nil)
deps.mockDomainHandler.EXPECT().RegisterDomain(gomock.Any(), gomock.Any()).Return(nil)
},
expectError: false,
},
{
name: "validation error",
req: &types.RegisterDomainRequest{
Name: "domain-name",
},
setupMocks: func(deps *mockDeps) {
deps.mockRequestValidator.EXPECT().ValidateRegisterDomainRequest(gomock.Any(), gomock.Any()).Return(errors.New("validation error"))
},
expectError: true,
expectedError: "validation error",
},
{
name: "register domain handler error",
req: &types.RegisterDomainRequest{
Name: "domain-name",
},
setupMocks: func(deps *mockDeps) {
deps.mockRequestValidator.EXPECT().ValidateRegisterDomainRequest(gomock.Any(), gomock.Any()).Return(nil)
deps.mockDomainHandler.EXPECT().RegisterDomain(gomock.Any(), gomock.Any()).Return(errors.New("handler error"))
},
expectError: true,
expectedError: "handler error",
},
}

for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
wh, deps := setupMocksForWorkflowHandler(t)
tc.setupMocks(deps)
err := wh.RegisterDomain(context.Background(), tc.req)
if tc.expectError {
assert.ErrorContains(t, err, tc.expectedError)
} else {
assert.NoError(t, err)
}
})
}
}

func TestDescribeDomain(t *testing.T) {
domainName := "domain-name" // Define the domain name pointer to pass in requests
testCases := []struct {
name string
req *types.DescribeDomainRequest
setupMocks func(*mockDeps)
expectError bool
expectedError string
verifyResp func(t *testing.T, resp *types.DescribeDomainResponse)
}{
{
name: "success without failover info",
req: &types.DescribeDomainRequest{
Name: &domainName,
},
setupMocks: func(deps *mockDeps) {
deps.mockRequestValidator.EXPECT().ValidateDescribeDomainRequest(gomock.Any(), gomock.Any()).Return(nil)
deps.mockDomainHandler.EXPECT().DescribeDomain(gomock.Any(), gomock.Any()).Return(&types.DescribeDomainResponse{
DomainInfo: &types.DomainInfo{
Name: "domain-name",
},
FailoverInfo: nil,
}, nil)
},
expectError: false,
verifyResp: func(t *testing.T, resp *types.DescribeDomainResponse) {
assert.NotNil(t, resp)
assert.Equal(t, "domain-name", resp.DomainInfo.Name)
},
},
{
name: "success with failover info and no error from history client",
req: &types.DescribeDomainRequest{
Name: &domainName,
},
setupMocks: func(deps *mockDeps) {
deps.mockRequestValidator.EXPECT().ValidateDescribeDomainRequest(gomock.Any(), gomock.Any()).Return(nil)
deps.mockDomainHandler.EXPECT().DescribeDomain(gomock.Any(), gomock.Any()).Return(&types.DescribeDomainResponse{
DomainInfo: &types.DomainInfo{
Name: "domain-name",
UUID: "domain-id",
},
FailoverInfo: &types.FailoverInfo{
FailoverExpireTimestamp: 1000,
},
}, nil)
deps.mockHistoryClient.EXPECT().GetFailoverInfo(gomock.Any(), &types.GetFailoverInfoRequest{
DomainID: "domain-id",
}).Return(&types.GetFailoverInfoResponse{
CompletedShardCount: 5,
PendingShards: []int32{10},
}, nil)
},
expectError: false,
verifyResp: func(t *testing.T, resp *types.DescribeDomainResponse) {
assert.NotNil(t, resp)
assert.Equal(t, int32(5), resp.FailoverInfo.CompletedShardCount)
assert.Equal(t, []int32{10}, resp.FailoverInfo.PendingShards)
},
},
{
name: "error from validation",
req: &types.DescribeDomainRequest{
Name: &domainName,
},
setupMocks: func(deps *mockDeps) {
deps.mockRequestValidator.EXPECT().ValidateDescribeDomainRequest(gomock.Any(), gomock.Any()).Return(errors.New("validation error"))
},
expectError: true,
expectedError: "validation error",
},
{
name: "error from domain handler",
req: &types.DescribeDomainRequest{
Name: &domainName,
},
setupMocks: func(deps *mockDeps) {
deps.mockRequestValidator.EXPECT().ValidateDescribeDomainRequest(gomock.Any(), gomock.Any()).Return(nil)
deps.mockDomainHandler.EXPECT().DescribeDomain(gomock.Any(), gomock.Any()).Return(nil, errors.New("domain handler error"))
},
expectError: true,
expectedError: "domain handler error",
},
{
name: "error from history client",
req: &types.DescribeDomainRequest{
Name: &domainName,
},
setupMocks: func(deps *mockDeps) {
deps.mockRequestValidator.EXPECT().ValidateDescribeDomainRequest(gomock.Any(), gomock.Any()).Return(nil)
deps.mockDomainHandler.EXPECT().DescribeDomain(gomock.Any(), gomock.Any()).Return(&types.DescribeDomainResponse{
DomainInfo: &types.DomainInfo{
Name: "domain-name",
UUID: "domain-id",
},
FailoverInfo: &types.FailoverInfo{
FailoverExpireTimestamp: 1000,
},
}, nil)
deps.mockHistoryClient.EXPECT().GetFailoverInfo(gomock.Any(), &types.GetFailoverInfoRequest{
DomainID: "domain-id",
}).Return(nil, errors.New("history client error"))
},
expectError: false,
verifyResp: func(t *testing.T, resp *types.DescribeDomainResponse) {
assert.NotNil(t, resp)
assert.Equal(t, "domain-name", resp.DomainInfo.Name)
assert.Zero(t, resp.FailoverInfo.CompletedShardCount)
assert.Nil(t, resp.FailoverInfo.PendingShards)
},
},
}

for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
wh, deps := setupMocksForWorkflowHandler(t)
tc.setupMocks(deps)
resp, err := wh.DescribeDomain(context.Background(), tc.req)

if tc.expectError {
assert.ErrorContains(t, err, tc.expectedError)
} else {
assert.NoError(t, err)
tc.verifyResp(t, resp)
}
})
}
}
Loading
Loading