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.

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

Fix tdbg getCategory to be case insensitive #6579

Merged
merged 1 commit into from
Oct 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
3 changes: 1 addition & 2 deletions tools/tdbg/commands.go
Original file line number Diff line number Diff line change
Expand Up @@ -394,9 +394,8 @@ func AdminGetShardID(c *cli.Context) error {

// getCategory first searches the registry for the category by the [tasks.Category.Name].
func getCategory(registry tasks.TaskCategoryRegistry, key string) (tasks.Category, error) {
key = strings.ToLower(key)
for _, category := range registry.GetCategories() {
if category.Name() == key {
if strings.EqualFold(category.Name(), key) {
return category, nil
}
}
Expand Down
73 changes: 73 additions & 0 deletions tools/tdbg/commands_test.go
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
// The MIT License
//
// Copyright (c) 2024 Temporal Technologies Inc. All rights reserved.
//
// 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 tdbg

import (
"testing"

"github.com/stretchr/testify/require"
"go.temporal.io/server/service/history/tasks"
)

func TestGetCategory(t *testing.T) {
cat101 := tasks.NewCategory(101, tasks.CategoryTypeImmediate, "CategoryName")

registry := tasks.NewDefaultTaskCategoryRegistry()
registry.AddCategory(cat101)

testCases := []struct {
name string
input string
expectedCat tasks.Category
expectedErr string
}{
{
name: "same case",
input: "CategoryName",
expectedCat: cat101,
},
{
name: "different case",
input: "cAtEgOrYnAmE",
expectedCat: cat101,
},
{
name: "not found",
input: "random",
expectedErr: "unknown task category \"random\"",
},
}

for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
s := require.New(t)
cat, err := getCategory(registry, tc.input)
if tc.expectedErr == "" {
s.NoError(err)
s.Equal(tc.expectedCat, cat)
} else {
s.ErrorContains(err, tc.expectedErr)
}
})
}
}
Loading