GitLabgitlab-org
cli
main
1//go:build !integration
3package semantic
5import (
6 "encoding/json"
7 "errors"
8 "net/http"
9 "net/http/httptest"
10 "testing"
12 "github.com/stretchr/testify/assert"
13 "github.com/stretchr/testify/require"
15 gitlab "gitlab.com/gitlab-org/api/client-go/v3"
17 "gitlab.com/gitlab-org/cli/internal/testing/cmdtest"
18)
20func TestSemanticSearch_MissingQuery(t *testing.T) {
21 t.Parallel()
23 exec := cmdtest.SetupCmdForTest(t, NewCmd, false)
25 _, err := exec("")
27 require.Error(t, err)
28 assert.Contains(t, err.Error(), "required flag(s) \"query\" not set")
29}
31func TestSemanticSearch_TextOutput(t *testing.T) {
32 t.Parallel()
34 response := semanticSearchResponse{
35 Confidence: "high",
36 Results: []searchResult{
37 {
38 Path: "app/services/auth.rb",
39 FileURL: "https://gitlab.com/owner/repo/-/blob/main/app/services/auth.rb",
40 Score: 0.94,
41 SnippetRanges: []codeChunk{
42 {StartLine: 10, EndLine: 20, Content: "def authenticate\n ...\nend"},
43 },
44 },
45 },
46 }
48 testServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
49 assert.Equal(t, "authentication middleware", r.URL.Query().Get("q"))
50 assert.Equal(t, http.MethodGet, r.Method)
51 assert.Contains(t, r.URL.Path, "search/semantic")
53 w.Header().Set("Content-Type", "application/json")
54 w.WriteHeader(http.StatusOK)
55 _ = json.NewEncoder(w).Encode(response)
56 }))
57 defer testServer.Close()
59 gitlabClient, err := gitlab.NewClient("test-token", gitlab.WithBaseURL(testServer.URL+"/api/v4"))
60 require.NoError(t, err)
62 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
63 cmdtest.WithGitLabClient(gitlabClient),
64 cmdtest.WithBaseRepo("OWNER", "REPO", ""),
65 )
67 output, err := exec(`-q "authentication middleware"`)
68 require.NoError(t, err)
70 out := output.String()
71 assert.Contains(t, out, "authentication middleware")
72 assert.Contains(t, out, "OWNER/REPO")
73 assert.Contains(t, out, "Confidence: high")
74 assert.Contains(t, out, "app/services/auth.rb")
75 assert.Contains(t, out, "0.94")
76 assert.Contains(t, out, "def authenticate")
77}
79func TestSemanticSearch_JSONOutput(t *testing.T) {
80 t.Parallel()
82 response := semanticSearchResponse{
83 Confidence: "medium",
84 Results: []searchResult{
85 {
86 Path: "lib/foo.rb",
87 FileURL: "https://gitlab.com/owner/repo/-/blob/main/lib/foo.rb",
88 Score: 0.75,
89 SnippetRanges: []codeChunk{{StartLine: 1, EndLine: 5, Content: "# foo"}},
90 },
91 },
92 }
94 testServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
95 w.Header().Set("Content-Type", "application/json")
96 w.WriteHeader(http.StatusOK)
97 _ = json.NewEncoder(w).Encode(response)
98 }))
99 defer testServer.Close()
101 gitlabClient, err := gitlab.NewClient("test-token", gitlab.WithBaseURL(testServer.URL+"/api/v4"))
102 require.NoError(t, err)
104 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
105 cmdtest.WithGitLabClient(gitlabClient),
106 cmdtest.WithBaseRepo("OWNER", "REPO", ""),
107 )
109 output, err := exec(`-q foo --output json`)
110 require.NoError(t, err)
112 var got semanticSearchResponse
113 err = json.Unmarshal([]byte(output.String()), &got)
114 require.NoError(t, err)
115 assert.Equal(t, "medium", got.Confidence)
116 assert.Len(t, got.Results, 1)
117 assert.Equal(t, "lib/foo.rb", got.Results[0].Path)
118}
120func TestSemanticSearch_WithDirectoryPath(t *testing.T) {
121 t.Parallel()
123 testServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
124 assert.Equal(t, "app/services/", r.URL.Query().Get("directory_path"))
126 w.Header().Set("Content-Type", "application/json")
127 w.WriteHeader(http.StatusOK)
128 _ = json.NewEncoder(w).Encode(semanticSearchResponse{Confidence: "low", Results: nil})
129 }))
130 defer testServer.Close()
132 gitlabClient, err := gitlab.NewClient("test-token", gitlab.WithBaseURL(testServer.URL+"/api/v4"))
133 require.NoError(t, err)
135 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
136 cmdtest.WithGitLabClient(gitlabClient),
137 cmdtest.WithBaseRepo("OWNER", "REPO", ""),
138 )
140 _, err = exec(`-q "rate limiting" -d app/services/`)
141 require.NoError(t, err)
142}
144func TestSemanticSearch_NoResults(t *testing.T) {
145 t.Parallel()
147 testServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
148 w.Header().Set("Content-Type", "application/json")
149 w.WriteHeader(http.StatusOK)
150 _ = json.NewEncoder(w).Encode(semanticSearchResponse{Confidence: "high", Results: nil})
151 }))
152 defer testServer.Close()
154 gitlabClient, err := gitlab.NewClient("test-token", gitlab.WithBaseURL(testServer.URL+"/api/v4"))
155 require.NoError(t, err)
157 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
158 cmdtest.WithGitLabClient(gitlabClient),
159 cmdtest.WithBaseRepo("OWNER", "REPO", ""),
160 )
162 output, err := exec(`-q "nonexistent code"`)
163 require.NoError(t, err)
165 assert.Contains(t, output.String(), "No results found.")
166}
168func TestSemanticSearch_KnnOutOfRange(t *testing.T) {
169 t.Parallel()
171 for _, cli := range []string{`-q foo --knn=-1`, `-q foo --knn=101`} {
172 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
173 cmdtest.WithBaseRepo("OWNER", "REPO", ""),
174 )
175 _, err := exec(cli)
176 require.Error(t, err, "expected error for %q", cli)
177 assert.Contains(t, err.Error(), "--knn must be between 1 and 100")
178 }
179}
181func TestSemanticSearch_LimitOutOfRange(t *testing.T) {
182 t.Parallel()
184 for _, cli := range []string{`-q foo --limit=-1`, `-q foo --limit=101`} {
185 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
186 cmdtest.WithBaseRepo("OWNER", "REPO", ""),
187 )
188 _, err := exec(cli)
189 require.Error(t, err, "expected error for %q", cli)
190 assert.Contains(t, err.Error(), "--limit must be between 1 and 100")
191 }
192}
194func TestSemanticSearch_BaseRepoError(t *testing.T) {
195 t.Parallel()
197 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
198 cmdtest.WithBaseRepoError(errors.New("not a git repository")),
199 )
201 _, err := exec(`-q foo`)
202 require.Error(t, err)
203 assert.Contains(t, err.Error(), "not a git repository")
204}
206func TestSemanticSearch_APIError(t *testing.T) {
207 t.Parallel()
209 testServer := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
210 w.Header().Set("Content-Type", "application/json")
211 w.WriteHeader(http.StatusUnprocessableEntity)
212 _, _ = w.Write([]byte(`{"message":"No embeddings indexed for this project"}`))
213 }))
214 defer testServer.Close()
216 gitlabClient, err := gitlab.NewClient("test-token", gitlab.WithBaseURL(testServer.URL+"/api/v4"))
217 require.NoError(t, err)
219 exec := cmdtest.SetupCmdForTest(t, NewCmd, false,
220 cmdtest.WithGitLabClient(gitlabClient),
221 cmdtest.WithBaseRepo("OWNER", "REPO", ""),
222 )
224 _, err = exec(`-q foo`)
225 require.Error(t, err)
226 assert.Contains(t, err.Error(), "semantic search request failed")
227}
Diagnostics8 git calls · 289 ms
CallStatusSizeTime0289 ms
discover200185 B3 ms
git.upload-pack discover http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=3 git.response.bytes=185 git.server.agent=git/2.56.g1891de4-Linux git.server.object_format=sha1 git.server.caps=agent ls-refs fetch server-option object-format git.server.fetch=shallow wait-for-done filter git.protocol.version=2 git.pkt.frames=9 git.pkt.data=7 git.pkt.flush=2 git.pkt.delim=0 git.pkt.bytes=185 git.pkt.payload.max=35
ls-refs20058 KiB · hit3 ms
git.upload-pack ls-refs http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=ls-refs git.upstream.dur_ms=3 git.response.bytes=59849 git.response.cache=HIT git.response.duration_ms=3 git.protocol.version=2 git.pkt.frames=731 git.pkt.data=730 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=59849 git.pkt.payload.max=143 git.ls_refs.count=730 git.ls_refs.head=refs/heads/main
fetchtree:0 · deepen 1020032 KiB · hit2 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=2 git.response.bytes=32926 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9 git.fetch.haves.count=0 git.fetch.deepen=10 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=22 git.pkt.data=20 git.pkt.flush=1 git.pkt.delim=1 git.pkt.bytes=32926 git.pkt.payload.max=32046 git.sideband.band1.bytes=32046 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=80 git.pack.bytes=32046 git.pack.ofs_delta=36 git.pack.ref_delta=0 git.pack.chain.max=2 git.pack.trailer=cb0bad5d7ffc514895d8b21c4dd470327f90bc91 git.pack.full=44Open pack map
fetchcombine:blob:none+tree:2 · deepen 12004.2 KiB · hit4 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=4 git.response.bytes=4273 git.response.cache=HIT git.response.duration_ms=4 git.fetch.filter=combine:blob:none+tree:2 git.fetch.wants=0dd7574dce9e385c5c30540e6c15657adc6bdce9 git.fetch.haves.count=0 git.fetch.deepen=1 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=7 git.pkt.data=5 git.pkt.flush=1 git.pkt.delim=1 git.pkt.bytes=4273 git.pkt.payload.max=4173 git.sideband.band1.bytes=4173 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=11 git.pack.bytes=4173 git.fetch.wide.objects=11 git.fetch.wide.extra_bytes=3930 git.fetch.wide.blobs=0
fetchtree:02001.8 KiB · hit3 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=3 git.response.bytes=1857 git.response.cache=HIT git.response.duration_ms=3 git.fetch.filter=tree:0 git.fetch.wants=dce174ff8c632a19d17eea99c8a9b7c37fb2b592 git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=1857 git.pkt.payload.max=1830 git.sideband.band1.bytes=1830 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=1830 git.pack.trailer=fb03183b7909876778f740d196d7516811003517Open pack map
fetchtree:0200144 B · hit2 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=2 git.response.bytes=144 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=1884ac3ced38987dfbc036c31558ff615a88ec05 git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=144 git.pkt.payload.max=117 git.sideband.band1.bytes=117 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=117 git.pack.trailer=b2a0477ed58eb03d308b0682ea31444d887c3f4fOpen pack map
fetchtree:0200140 B · hit2 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=2 git.response.bytes=140 git.response.cache=HIT git.response.duration_ms=2 git.fetch.filter=tree:0 git.fetch.wants=fd5b978a9df3e535b3cb674347bc718a7d5f1dfd git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=140 git.pkt.payload.max=113 git.sideband.band1.bytes=113 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0 git.pack.objects=1 git.pack.bytes=113 git.pack.trailer=1bd24f5093bc9133b8023c8b1c003692fdbf56bbOpen pack map
fetch2001.5 KiB275 ms
git.upload-pack fetch http.response.status_code=200 git.upstream.cf_ray=- git.upstream.phase=fetch git.upstream.dur_ms=275 git.response.bytes=1533 git.response.cache=MISS git.response.duration_ms=275 git.fetch.wants=eb8f53a6ea7d2ec3dd095627dd814712657109e6 git.fetch.haves.count=0 git.fetch.deepen=0 git.fetch.thin_pack=false git.fetch.ofs_delta=true git.protocol.version=2 git.pkt.frames=4 git.pkt.data=3 git.pkt.flush=1 git.pkt.delim=0 git.pkt.bytes=1533 git.pkt.payload.max=1506 git.sideband.band1.bytes=1506 git.sideband.band2.bytes=0 git.sideband.band3.bytes=0
Each row is one HTTP round trip ply made to the git server for this page, on one timeline. discover asks what the server speaks, ls-refs lists branch tips, fetch brings objects by id. A hit was served by Workers Cache. Tap a row for its wire details.
- Remote
- https://gitlab.com/gitlab-org/cli
- Ref
- refs/heads/main
- Commit
- 0dd7574dce9e385c5c30540e6c15657adc6bdce9
- cf-ray
- a5e2e1a4fc8f4af4
- Request
- 5f21aabd…
- Protocol
- v2 · sha1
- Agent
- git/2.56.g1891de4-Linux
- Filter
- advertised
- Fetch
- shallow wait-for-done filter
- Capabilities
- agent ls-refs fetch server-option object-format