Files
tasks/common/archiver/filestore/query_parser_test.go
Michael SnowdenandGitHub d5c62e926f Make all Go source file names snake case (#4558)
<!-- Describe what has changed in this PR -->
**What changed?**
I renamed all of our Go source code files so that they're snake case
instead of camel case.

<!-- Tell your future self why have you made these changes -->
**Why?**
This was an annoying inconsistency we carried over from much older code
in the repo.

<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
**How did you test it?**
The renaming process was part of an automated script
(https://gist.github.com/MichaelSnowden/47576fffe27aa1cae6b26eaccec7ab55),
so it should be consistent. Also, I don't see us doing anything in our
codebase that involves parsing our own source files by path:

<img width="687" alt="image"
src="https://github.com/temporalio/temporal/assets/5942963/c6b873b0-d841-40d1-8b0f-2fe9d8079a53">

*PS: here's a link to the GPT convo I had to generate this renaming
script:
https://chat.openai.com/share/7f2d011a-a8da-4fa4-9c6d-e09102fdd49f*

<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
**Potential risks**
Mainly merge conflicts, but I used `git mv` so that these are renames
instead of deletes/adds, so that shouldn't be a big issue.

<!-- Is this PR a hotfix candidate or require that a notification be
sent to the broader community? (Yes/No) -->
**Is hotfix candidate?**
No.
2023-07-03 14:23:56 -04:00

368 lines
9.9 KiB
Go

// The MIT License
//
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
//
// Copyright (c) 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 filestore
import (
"testing"
"time"
"github.com/stretchr/testify/require"
"github.com/stretchr/testify/suite"
enumspb "go.temporal.io/api/enums/v1"
"go.temporal.io/server/common/convert"
)
type queryParserSuite struct {
*require.Assertions
suite.Suite
parser QueryParser
}
func TestQueryParserSuite(t *testing.T) {
suite.Run(t, new(queryParserSuite))
}
func (s *queryParserSuite) SetupTest() {
s.Assertions = require.New(s.T())
s.parser = NewQueryParser()
}
func (s *queryParserSuite) TestParseWorkflowID_RunID_WorkflowType() {
testCases := []struct {
query string
expectErr bool
parsedQuery *parsedQuery
}{
{
query: "WorkflowId = \"random workflowID\"",
expectErr: false,
parsedQuery: &parsedQuery{
workflowID: convert.StringPtr("random workflowID"),
},
},
{
query: "WorkflowId = \"random workflowID\" and WorkflowId = \"random workflowID\"",
expectErr: false,
parsedQuery: &parsedQuery{
workflowID: convert.StringPtr("random workflowID"),
},
},
{
query: "RunId = \"random runID\"",
expectErr: false,
parsedQuery: &parsedQuery{
runID: convert.StringPtr("random runID"),
},
},
{
query: "WorkflowType = \"random typeName\"",
expectErr: false,
parsedQuery: &parsedQuery{
workflowTypeName: convert.StringPtr("random typeName"),
},
},
{
query: "WorkflowId = 'random workflowID'",
expectErr: false,
parsedQuery: &parsedQuery{
workflowID: convert.StringPtr("random workflowID"),
},
},
{
query: "WorkflowType = 'random typeName' and WorkflowType = \"another typeName\"",
expectErr: false,
parsedQuery: &parsedQuery{
emptyResult: true,
},
},
{
query: "WorkflowType = 'random typeName' and (WorkflowId = \"random workflowID\" and RunId='random runID')",
expectErr: false,
parsedQuery: &parsedQuery{
workflowID: convert.StringPtr("random workflowID"),
runID: convert.StringPtr("random runID"),
workflowTypeName: convert.StringPtr("random typeName"),
},
},
{
query: "runId = random workflowID",
expectErr: true,
},
{
query: "WorkflowId = \"random workflowID\" or WorkflowId = \"another workflowID\"",
expectErr: true,
},
{
query: "WorkflowId = \"random workflowID\" or runId = \"random runID\"",
expectErr: true,
},
{
query: "workflowid = \"random workflowID\"",
expectErr: true,
},
{
query: "runId > \"random workflowID\"",
expectErr: true,
},
}
for _, tc := range testCases {
parsedQuery, err := s.parser.Parse(tc.query)
if tc.expectErr {
s.Error(err)
continue
}
s.NoError(err)
s.Equal(tc.parsedQuery.emptyResult, parsedQuery.emptyResult)
if !tc.parsedQuery.emptyResult {
s.Equal(tc.parsedQuery.workflowID, parsedQuery.workflowID)
s.Equal(tc.parsedQuery.runID, parsedQuery.runID)
s.Equal(tc.parsedQuery.workflowTypeName, parsedQuery.workflowTypeName)
}
}
}
func (s *queryParserSuite) TestParseCloseStatus() {
testCases := []struct {
query string
expectErr bool
parsedQuery *parsedQuery
}{
{
query: "ExecutionStatus = \"Completed\"",
expectErr: false,
parsedQuery: &parsedQuery{
status: toWorkflowExecutionStatusPtr(enumspb.WORKFLOW_EXECUTION_STATUS_COMPLETED),
},
},
{
query: "ExecutionStatus = \"failed\"",
expectErr: false,
parsedQuery: &parsedQuery{
status: toWorkflowExecutionStatusPtr(enumspb.WORKFLOW_EXECUTION_STATUS_FAILED),
},
},
{
query: "ExecutionStatus = \"canceled\"",
expectErr: false,
parsedQuery: &parsedQuery{
status: toWorkflowExecutionStatusPtr(enumspb.WORKFLOW_EXECUTION_STATUS_CANCELED),
},
},
{
query: "ExecutionStatus = \"terminated\"",
expectErr: false,
parsedQuery: &parsedQuery{
status: toWorkflowExecutionStatusPtr(enumspb.WORKFLOW_EXECUTION_STATUS_TERMINATED),
},
},
{
query: "ExecutionStatus = 'continuedasnew'",
expectErr: false,
parsedQuery: &parsedQuery{
status: toWorkflowExecutionStatusPtr(enumspb.WORKFLOW_EXECUTION_STATUS_CONTINUED_AS_NEW),
},
},
{
query: "ExecutionStatus = 'TIMED_OUT'",
expectErr: false,
parsedQuery: &parsedQuery{
status: toWorkflowExecutionStatusPtr(enumspb.WORKFLOW_EXECUTION_STATUS_TIMED_OUT),
},
},
{
query: "ExecutionStatus = 'Failed' and ExecutionStatus = \"Failed\"",
expectErr: false,
parsedQuery: &parsedQuery{
status: toWorkflowExecutionStatusPtr(enumspb.WORKFLOW_EXECUTION_STATUS_FAILED),
},
},
{
query: "(ExecutionStatus = 'Timedout' and ExecutionStatus = \"canceled\")",
expectErr: false,
parsedQuery: &parsedQuery{
emptyResult: true,
},
},
{
query: "status = \"Failed\"",
expectErr: true,
},
{
query: "ExecutionStatus = \"Failed\" or ExecutionStatus = \"Failed\"",
expectErr: true,
},
{
query: "ExecutionStatus = \"unknown\"",
expectErr: true,
},
{
query: "ExecutionStatus > \"Failed\"",
expectErr: true,
},
{
query: "ExecutionStatus = 3",
expectErr: false,
parsedQuery: &parsedQuery{
status: toWorkflowExecutionStatusPtr(enumspb.WORKFLOW_EXECUTION_STATUS_FAILED),
},
},
{
query: "CloseStatus = 10",
expectErr: true,
},
}
for _, tc := range testCases {
parsedQuery, err := s.parser.Parse(tc.query)
if tc.expectErr {
s.Error(err)
continue
}
s.NoError(err)
s.Equal(tc.parsedQuery.emptyResult, parsedQuery.emptyResult)
if !tc.parsedQuery.emptyResult {
s.EqualValues(tc.parsedQuery.status, parsedQuery.status)
}
}
}
func (s *queryParserSuite) TestParseCloseTime() {
testCases := []struct {
query string
expectErr bool
parsedQuery *parsedQuery
}{
{
query: "CloseTime <= 1000",
expectErr: false,
parsedQuery: &parsedQuery{
earliestCloseTime: time.Time{},
latestCloseTime: time.Unix(0, 1000),
},
},
{
query: "CloseTime < 2000 and CloseTime <= 1000 and CloseTime > 300",
expectErr: false,
parsedQuery: &parsedQuery{
earliestCloseTime: time.Unix(0, 301),
latestCloseTime: time.Unix(0, 1000),
},
},
{
query: "CloseTime = 2000 and (CloseTime > 1000 and CloseTime <= 9999)",
expectErr: false,
parsedQuery: &parsedQuery{
earliestCloseTime: time.Unix(0, 2000),
latestCloseTime: time.Unix(0, 2000),
},
},
{
query: "CloseTime <= \"2019-01-01T11:11:11Z\" and CloseTime >= 1000000",
expectErr: false,
parsedQuery: &parsedQuery{
earliestCloseTime: time.Unix(0, 1000000),
latestCloseTime: time.Date(2019, 01, 01, 11, 11, 11, 0, time.UTC),
},
},
{
query: "closeTime = 2000",
expectErr: true,
},
{
query: "CloseTime > \"2019-01-01 00:00:00\"",
expectErr: true,
},
{
query: "ExecutionStatus > 2000 or ExecutionStatus < 1000",
expectErr: true,
},
}
for i, tc := range testCases {
parsedQuery, err := s.parser.Parse(tc.query)
if tc.expectErr {
s.Error(err)
continue
}
s.NoError(err, "case %d", i)
s.Equal(tc.parsedQuery.emptyResult, parsedQuery.emptyResult, "case %d", i)
if !tc.parsedQuery.emptyResult {
s.True(tc.parsedQuery.earliestCloseTime.Equal(parsedQuery.earliestCloseTime), "case %d", i)
s.True(tc.parsedQuery.latestCloseTime.Equal(parsedQuery.latestCloseTime), "case %d", i)
}
}
}
func (s *queryParserSuite) TestParse() {
testCases := []struct {
query string
expectErr bool
parsedQuery *parsedQuery
}{
{
query: "CloseTime <= \"2019-01-01T11:11:11Z\" and WorkflowId = 'random workflowID'",
expectErr: false,
parsedQuery: &parsedQuery{
earliestCloseTime: time.Time{},
latestCloseTime: time.Date(2019, 01, 01, 11, 11, 11, 0, time.UTC),
workflowID: convert.StringPtr("random workflowID"),
},
},
{
query: "CloseTime > 1999 and CloseTime < 10000 and RunId = 'random runID' and ExecutionStatus = 'Failed'",
expectErr: false,
parsedQuery: &parsedQuery{
earliestCloseTime: time.Unix(0, 2000).UTC(),
latestCloseTime: time.Unix(0, 9999).UTC(),
runID: convert.StringPtr("random runID"),
status: toWorkflowExecutionStatusPtr(enumspb.WORKFLOW_EXECUTION_STATUS_FAILED),
},
},
{
query: "CloseTime > 2001 and CloseTime < 10000 and (RunId = 'random runID') and ExecutionStatus = 'Failed' and (RunId = 'another ID')",
expectErr: false,
parsedQuery: &parsedQuery{
emptyResult: true,
},
},
}
for i, tc := range testCases {
parsedQuery, err := s.parser.Parse(tc.query)
if tc.expectErr {
s.Error(err)
continue
}
s.NoError(err, "case %d", i)
s.Equal(tc.parsedQuery.emptyResult, parsedQuery.emptyResult, "case %d", i)
if !tc.parsedQuery.emptyResult {
s.Equal(tc.parsedQuery, parsedQuery, "case %d", i)
}
}
}