STACKITGit/cli
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

test(pkg/search): assert verbatim keywords are respected

Browse source 
Signed-off-by: Babak K. Shandiz <babakks@github.com>
This commit is contained in:
Babak K. Shandiz 2025-11-20 13:08:27 +00:00
parent d8486ccf10
commit 76b2de8a18
No known key found for this signature in database
GPG key ID: 9472CAEFF56C742E
2 changed files with 65 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

68
pkg/search/query_test.go
View file

@ -14,6 +14,10 @@ func TestStandardSearchString(t *testing.T) {
query Query
out string
}{
{
name: "empty query",
out: "",
},
{
name: "converts query to string",
query: Query{
@ -70,6 +74,31 @@ func TestStandardSearchString(t *testing.T) {
},
out: `topic:"quote qualifier"`,
},
{
name: "respects verbatim keywords",
query: Query{
KeywordsVerbatim: "verbatim keyword that should be left as is",
},
out: `verbatim keyword that should be left as is`,
},
{
name: "respects verbatim keywords, with qualifiers",
query: Query{
KeywordsVerbatim: "verbatim keyword that should be left as is",
Qualifiers: Qualifiers{
Topic: []string{"quote qualifier"},
},
},
out: `verbatim keyword that should be left as is topic:"quote qualifier"`,
},
{
name: "prioritises verbatim keywords over keywords slice",
query: Query{
Keywords: []string{"foo", "bar"},
KeywordsVerbatim: "verbatim keyword",
},
out: `verbatim keyword`,
},
}
for _, tt := range tests {
t.Run(tt.name, func(t *testing.T) {
@ -84,6 +113,10 @@ func TestAdvancedIssueSearchString(t *testing.T) {
query Query
out string
}{
{
name: "empty query",
out: "",
},
{
name: "quotes keywords",
query: Query{
@ -107,6 +140,31 @@ func TestAdvancedIssueSearchString(t *testing.T) {
},
out: `label:"quote qualifier"`,
},
{
name: "respects verbatim keywords",
query: Query{
KeywordsVerbatim: "verbatim keyword that should be left as is",
},
out: `verbatim keyword that should be left as is`,
},
{
name: "respects verbatim keywords, with qualifiers",
query: Query{
KeywordsVerbatim: "verbatim keyword that should be left as is",
Qualifiers: Qualifiers{
Topic: []string{"quote qualifier"},
},
},
out: `( verbatim keyword that should be left as is ) topic:"quote qualifier"`,
},
{
name: "prioritises verbatim keywords over keywords slice",
query: Query{
Keywords: []string{"foo", "bar"},
KeywordsVerbatim: "verbatim keyword",
},
out: `verbatim keyword`,
},
{
name: "unused qualifiers should not appear in query",
query: Query{
@ -115,7 +173,7 @@ func TestAdvancedIssueSearchString(t *testing.T) {
Label: []string{"foo", "bar"},
},
},
out: `keyword label:bar label:foo`,
out: `( keyword ) label:bar label:foo`,
},
{
name: "special qualifiers when used once",
@ -128,7 +186,7 @@ func TestAdvancedIssueSearchString(t *testing.T) {
In: []string{"title"},
},
},
out: `keyword in:title is:private repo:foo/bar user:johndoe`,
out: `( keyword ) in:title is:private repo:foo/bar user:johndoe`,
},
{
name: "special qualifiers are OR-ed when used multiple times",
@ -141,7 +199,7 @@ func TestAdvancedIssueSearchString(t *testing.T) {
In: []string{"title", "body", "comments", "foo"}, // "foo" is to ensure only "title", "body", and "comments" are grouped
},
},
out: `keyword (in:body OR in:comments OR in:title) in:foo (is:blocked OR is:blocking) (is:closed OR is:open) (is:issue OR is:pr) (is:locked OR is:unlocked) (is:merged OR is:unmerged) (is:private OR is:public) is:foo (repo:foo/bar OR repo:foo/baz) (user:janedoe OR user:johndoe)`,
out: `( keyword ) (in:body OR in:comments OR in:title) in:foo (is:blocked OR is:blocking) (is:closed OR is:open) (is:issue OR is:pr) (is:locked OR is:unlocked) (is:merged OR is:unmerged) (is:private OR is:public) is:foo (repo:foo/bar OR repo:foo/baz) (user:janedoe OR user:johndoe)`,
},
{
// Since this is a general purpose package, we can't assume with know all
@ -155,7 +213,7 @@ func TestAdvancedIssueSearchString(t *testing.T) {
In: []string{"foo", "bar"},
},
},
out: `keyword in:bar in:foo is:bar is:foo`,
out: `( keyword ) in:bar in:foo is:bar is:foo`,
},
{
name: "non-special qualifiers used multiple times",
@ -170,7 +228,7 @@ func TestAdvancedIssueSearchString(t *testing.T) {
Topic: []string{"foo", "bar"},
},
},
out: `keyword in:bar in:foo is:bar is:foo label:bar label:foo license:bar license:foo no:bar no:foo topic:bar topic:foo`,
out: `( keyword ) in:bar in:foo is:bar is:foo label:bar label:foo license:bar license:foo no:bar no:foo topic:bar topic:foo`,
},
}
for _, tt := range tests {

4
pkg/search/searcher_test.go
View file

@ -1178,7 +1178,7 @@ func TestSearcherIssuesAdvancedSyntax(t *testing.T) {
detector: fd.AdvancedIssueSearchSupportedAsOptIn(),
query: query,
wantValues: url.Values{
"q": []string{"keyword author:johndoe (in:body OR in:comments OR in:title) (is:private OR is:public) label:bar label:foo (repo:foo/bar OR repo:foo/baz) (user:janedoe OR user:johndoe)"},
"q": []string{"( keyword ) author:johndoe (in:body OR in:comments OR in:title) (is:private OR is:public) label:bar label:foo (repo:foo/bar OR repo:foo/baz) (user:janedoe OR user:johndoe)"},
"advanced_search": []string{"true"}, // opt-in
},
},
@ -1189,7 +1189,7 @@ func TestSearcherIssuesAdvancedSyntax(t *testing.T) {
detector: fd.AdvancedIssueSearchSupportedAsOnlyBackend(),
query: query,
wantValues: url.Values{
"q": []string{"keyword author:johndoe (in:body OR in:comments OR in:title) (is:private OR is:public) label:bar label:foo (repo:foo/bar OR repo:foo/baz) (user:janedoe OR user:johndoe)"},
"q": []string{"( keyword ) author:johndoe (in:body OR in:comments OR in:title) (is:private OR is:public) label:bar label:foo (repo:foo/bar OR repo:foo/baz) (user:janedoe OR user:johndoe)"},
"advanced_search": nil, // assert absence
},
},