search: add tests for search_streaming.go #486
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,198 @@ | ||
| package main | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "testing" | ||
|
|
||
| "github.com/hexops/autogold" | ||
|
|
||
| "github.com/sourcegraph/src-cli/internal/streaming" | ||
| ) | ||
|
|
||
| func TestRepoTemplate(t *testing.T) { | ||
| v, err := parseTemplate(streamingTemplate) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| repo := &streaming.EventRepoMatch{ | ||
| Type: streaming.RepoMatchType, | ||
| Repository: "sourcegraph/sourcegraph", | ||
| Branches: []string{}, | ||
| } | ||
|
|
||
| got := new(bytes.Buffer) | ||
| err = v.ExecuteTemplate(got, "repo", struct { | ||
| SourcegraphEndpoint string | ||
| *streaming.EventRepoMatch | ||
| }{ | ||
| SourcegraphEndpoint: "https://sourcegraph.com", | ||
| EventRepoMatch: repo, | ||
| }) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| autogold.Equal(t, string(got.Bytes())) | ||
| } | ||
|
|
||
| func TestFileTemplate(t *testing.T) { | ||
| v, err := parseTemplate(streamingTemplate) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| file := &streaming.EventFileMatch{ | ||
| Type: streaming.FileMatchType, | ||
| Path: "path/to/file", | ||
| Repository: "org/repo", | ||
| Branches: nil, | ||
| Version: "", | ||
| LineMatches: []streaming.EventLineMatch{ | ||
| { | ||
| Line: "foo bar", | ||
| LineNumber: 4, | ||
| OffsetAndLengths: [][2]int32{{4, 3}}, | ||
| }, | ||
| }, | ||
| } | ||
|
|
||
| got := new(bytes.Buffer) | ||
| err = v.ExecuteTemplate(got, "file", struct { | ||
| Query string | ||
| *streaming.EventFileMatch | ||
| }{ | ||
| Query: "bar", | ||
| EventFileMatch: file, | ||
| }) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| autogold.Equal(t, string(got.Bytes())) | ||
| } | ||
|
|
||
| func TestSymbolTemplate(t *testing.T) { | ||
| v, err := parseTemplate(streamingTemplate) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| symbol := &streaming.EventSymbolMatch{ | ||
| Type: streaming.FileMatchType, | ||
| Path: "path/to/file", | ||
| Repository: "org/repo", | ||
| Branches: nil, | ||
| Version: "", | ||
| Symbols: []streaming.Symbol{{ | ||
| URL: "github.com/sourcegraph/sourcegraph/-/blob/cmd/frontend/graphqlbackend/search_results.go#L1591:26-1591:35", | ||
| Name: "doResults", | ||
| ContainerName: "", | ||
| Kind: "FUNCTION", | ||
| }}, | ||
| } | ||
|
|
||
| got := new(bytes.Buffer) | ||
| err = v.ExecuteTemplate(got, "symbol", struct { | ||
| SourcegraphEndpoint string | ||
| *streaming.EventSymbolMatch | ||
| }{ | ||
| SourcegraphEndpoint: "https://sourcegraph.com", | ||
| EventSymbolMatch: symbol, | ||
| }) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| autogold.Equal(t, string(got.Bytes())) | ||
| } | ||
|
|
||
| func TestCommitTemplate(t *testing.T) { | ||
| v, err := parseTemplate(streamingTemplate) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| commit := &streaming.EventCommitMatch{ | ||
| Type: streaming.CommitMatchType, | ||
| Icon: "", | ||
| Label: "[sourcegraph/sourcegraph-atom](/github.com/sourcegraph/sourcegraph-atom) › [Stephen Gutekanst](/github.com/sourcegraph/sourcegraph-atom/-/commit/5b098d7fed963d88e23057ed99d73d3c7a33ad89): [all: release v1.0.5](/github.com/sourcegraph/sourcegraph-atom/-/commit/5b098d7fed963d88e23057ed99d73d3c7a33ad89)^", | ||
| URL: "", | ||
| Detail: "", | ||
| Content: "```COMMIT_EDITMSG\nfoo bar\n```", | ||
| Ranges: [][3]int32{ | ||
| {1, 3, 3}, | ||
| }, | ||
| } | ||
|
|
||
| got := new(bytes.Buffer) | ||
| err = v.ExecuteTemplate(got, "commit", struct { | ||
| SourcegraphEndpoint string | ||
| *streaming.EventCommitMatch | ||
| }{ | ||
| SourcegraphEndpoint: "https://sourcegraph.com", | ||
| EventCommitMatch: commit, | ||
| }) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| autogold.Equal(t, string(got.Bytes())) | ||
| } | ||
|
|
||
| func TestProgressTemplate(t *testing.T) { | ||
| v, err := parseTemplate(streamingTemplate) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| repoCount := 42 | ||
| progress := streaming.Progress{ | ||
| Done: true, | ||
| RepositoriesCount: &repoCount, | ||
| MatchCount: 17, | ||
| DurationMs: 421, | ||
| Skipped: nil, | ||
| } | ||
|
|
||
| got := new(bytes.Buffer) | ||
| err = v.ExecuteTemplate(got, "progress", progress) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| autogold.Equal(t, string(got.Bytes())) | ||
| } | ||
|
|
||
| func TestDiffTemplate(t *testing.T) { | ||
| v, err := parseTemplate(streamingTemplate) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| commit := &streaming.EventCommitMatch{ | ||
| Type: streaming.CommitMatchType, | ||
| Icon: "", | ||
| Label: "[sourcegraph/sourcegraph-atom](/github.com/sourcegraph/sourcegraph-atom) › [Stephen Gutekanst](/github.com/sourcegraph/sourcegraph-atom/-/commit/5b098d7fed963d88e23057ed99d73d3c7a33ad89): [all: release v1.0.5](/github.com/sourcegraph/sourcegraph-atom/-/commit/5b098d7fed963d88e23057ed99d73d3c7a33ad89)^", | ||
| URL: "", | ||
| Detail: "", | ||
| Content: "```diff\nsrc/data.ts src/data.ts\n@@ -0,0 +11,4 @@\n+ return of<Data>({\n+ title: 'Acme Corp open-source code search',\n+ summary: 'Instant code search across all Acme Corp open-source code.',\n+ githubOrgs: ['sourcegraph'],\n```", | ||
| Ranges: [][3]int32{ | ||
| {4, 44, 6}, | ||
| }, | ||
| } | ||
|
|
||
| got := new(bytes.Buffer) | ||
| err = v.ExecuteTemplate(got, "commit", struct { | ||
| SourcegraphEndpoint string | ||
| *streaming.EventCommitMatch | ||
| }{ | ||
| SourcegraphEndpoint: "https://sourcegraph.com", | ||
| EventCommitMatch: commit, | ||
| }) | ||
| if err != nil { | ||
| t.Fatal(err) | ||
| } | ||
|
|
||
| autogold.Equal(t, string(got.Bytes())) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| `[38;5;239m([0m[38;5;237mhttps://sourcegraph.com[0m[38;5;239m) | ||
| [0m[0m[38;5;68msourcegraph/sourcegraph-atom > Stephen Gutekanst : all: release v1.0.5[0m[38;5;2m (1 match)[0m | ||
| [38;5;239m-------------------------------------------------------------------------------- | ||
| [0m[38;5;239m[0m oo [38;5;0m[48;5;11mbar[0m | ||
|
|
||
| ` | ||
|
There was a problem hiding this comment. Using a gostring looks a bit ugly here. Can we rather use |
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| `[38;5;239m([0m[38;5;237mhttps://sourcegraph.com[0m[38;5;239m) | ||
| [0m[0m[38;5;68msourcegraph/sourcegraph-atom > Stephen Gutekanst : all: release v1.0.5[0m[38;5;2m (1 match)[0m | ||
| [38;5;239m-------------------------------------------------------------------------------- | ||
| [0m[38;5;239m[0m src/data.ts src/data.ts | ||
| @@ -0,0 +11,4 @@ | ||
| + return of<Data>({ | ||
| + title: 'Acme Corp open-source code [38;5;0m[48;5;11msearch[0m', | ||
| + summary: 'Instant code search across all Acme Corp open-source code.', | ||
| + githubOrgs: ['sourcegraph'], | ||
|
|
||
| ` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| `[38;5;23morg/repo[0m › [38;5;69mpath/to/file[0m[38;5;2m (1 match)[0m | ||
| [38;5;239m-------------------------------------------------------------------------------- | ||
| [0m [38;5;69m 5[0m[38;5;239m | [0mfoo [38;5;0m[48;5;11mbar[0m | ||
|
|
||
| ` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| `[38;5;57m✱[0m [38;5;2m17 results[0m in [38;5;2m421ms[0m from [38;5;2m42 Repositories[0m | ||
| ` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| `[38;5;2msourcegraph/sourcegraph[0m[38;5;239m ([0m[38;5;23mhttps://sourcegraph.com/sourcegraph/sourcegraph[0m[38;5;239m)[0m[38;5;2m (1 match)[0m | ||
| ` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| `[38;5;23morg/repo[0m › [38;5;69mpath/to/file[0m[38;5;2m (1 match)[0m | ||
| [38;5;239m-------------------------------------------------------------------------------- | ||
| [0m[38;5;2mdoResults[0m(FUNCTION)[38;5;239m ([0m[38;5;23mhttps://sourcegraph.com/github.com/sourcegraph/sourcegraph/-/blob/cmd/frontend/graphqlbackend/search_results.go#L1591:26-1591:35[0m[38;5;239m) | ||
| [0m | ||
| ` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
A different way to test this would be to start a streaming server and return your mocked events, then you can just diff against the total output of src-cli search -stream. That should cover a lot more code paths and be a test that is less likely to change as you change internal details.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sure. Let's remove autogold then. Doing both, spinning up a stream server and using autogold is an overkill.