1package cache
2
3import (
4 "strings"
5 "testing"
6 "time"
7
8 "github.com/stretchr/testify/assert"
9 "github.com/stretchr/testify/require"
10
11 "github.com/MichaelMure/git-bug/entities/bug"
12 "github.com/MichaelMure/git-bug/entity"
13 "github.com/MichaelMure/git-bug/query"
14 "github.com/MichaelMure/git-bug/repository"
15)
16
17func TestCache(t *testing.T) {
18 repo := repository.CreateGoGitTestRepo(t, false)
19
20 cache, err := NewRepoCache(repo)
21 require.NoError(t, err)
22
23 // Create, set and get user identity
24 iden1, err := cache.NewIdentity("René Descartes", "rene@descartes.fr")
25 require.NoError(t, err)
26 err = cache.SetUserIdentity(iden1)
27 require.NoError(t, err)
28 userIden, err := cache.GetUserIdentity()
29 require.NoError(t, err)
30 require.Equal(t, iden1.Id(), userIden.Id())
31
32 // it's possible to create two identical identities
33 iden2, err := cache.NewIdentity("René Descartes", "rene@descartes.fr")
34 require.NoError(t, err)
35
36 // Two identical identities yield a different id
37 require.NotEqual(t, iden1.Id(), iden2.Id())
38
39 // There is now two identities in the cache
40 require.Len(t, cache.AllIdentityIds(), 2)
41 require.Len(t, cache.identitiesExcerpts, 2)
42 require.Len(t, cache.identities, 2)
43
44 // Create a bug
45 bug1, _, err := cache.NewBug("title", "message")
46 require.NoError(t, err)
47
48 // It's possible to create two identical bugs
49 bug2, _, err := cache.NewBug("title", "message")
50 require.NoError(t, err)
51
52 // two identical bugs yield a different id
53 require.NotEqual(t, bug1.Id(), bug2.Id())
54
55 // There is now two bugs in the cache
56 require.Len(t, cache.AllBugsIds(), 2)
57 require.Len(t, cache.bugExcerpts, 2)
58 require.Len(t, cache.bugs, 2)
59
60 // Resolving
61 _, err = cache.ResolveIdentity(iden1.Id())
62 require.NoError(t, err)
63 _, err = cache.ResolveIdentityExcerpt(iden1.Id())
64 require.NoError(t, err)
65 _, err = cache.ResolveIdentityPrefix(iden1.Id().String()[:10])
66 require.NoError(t, err)
67
68 _, err = cache.ResolveBug(bug1.Id())
69 require.NoError(t, err)
70 _, err = cache.ResolveBugExcerpt(bug1.Id())
71 require.NoError(t, err)
72 _, err = cache.ResolveBugPrefix(bug1.Id().String()[:10])
73 require.NoError(t, err)
74
75 // Querying
76 q, err := query.Parse("status:open author:descartes sort:edit-asc")
77 require.NoError(t, err)
78 res, err := cache.QueryBugs(q)
79 require.NoError(t, err)
80 require.Len(t, res, 2)
81
82 // Close
83 require.NoError(t, cache.Close())
84 require.Empty(t, cache.bugs)
85 require.Empty(t, cache.bugExcerpts)
86 require.Empty(t, cache.identities)
87 require.Empty(t, cache.identitiesExcerpts)
88
89 // Reload, only excerpt are loaded, but as we need to load the identities used in the bugs
90 // to check the signatures, we also load the identity used above
91 cache, err = NewRepoCache(repo)
92 require.NoError(t, err)
93 require.Empty(t, cache.bugs)
94 require.Len(t, cache.identities, 1)
95 require.Len(t, cache.bugExcerpts, 2)
96 require.Len(t, cache.identitiesExcerpts, 2)
97
98 // Resolving load from the disk
99 _, err = cache.ResolveIdentity(iden1.Id())
100 require.NoError(t, err)
101 _, err = cache.ResolveIdentityExcerpt(iden1.Id())
102 require.NoError(t, err)
103 _, err = cache.ResolveIdentityPrefix(iden1.Id().String()[:10])
104 require.NoError(t, err)
105
106 _, err = cache.ResolveBug(bug1.Id())
107 require.NoError(t, err)
108 _, err = cache.ResolveBugExcerpt(bug1.Id())
109 require.NoError(t, err)
110 _, err = cache.ResolveBugPrefix(bug1.Id().String()[:10])
111 require.NoError(t, err)
112}
113
114func TestCachePushPull(t *testing.T) {
115 repoA, repoB, _ := repository.SetupGoGitReposAndRemote(t)
116
117 cacheA, err := NewRepoCache(repoA)
118 require.NoError(t, err)
119
120 cacheB, err := NewRepoCache(repoB)
121 require.NoError(t, err)
122
123 // Create, set and get user identity
124 reneA, err := cacheA.NewIdentity("René Descartes", "rene@descartes.fr")
125 require.NoError(t, err)
126 err = cacheA.SetUserIdentity(reneA)
127 require.NoError(t, err)
128 isaacB, err := cacheB.NewIdentity("Isaac Newton", "isaac@newton.uk")
129 require.NoError(t, err)
130 err = cacheB.SetUserIdentity(isaacB)
131 require.NoError(t, err)
132
133 // distribute the identity
134 _, err = cacheA.Push("origin")
135 require.NoError(t, err)
136 err = cacheB.Pull("origin")
137 require.NoError(t, err)
138
139 // Create a bug in A
140 _, _, err = cacheA.NewBug("bug1", "message")
141 require.NoError(t, err)
142
143 // A --> remote --> B
144 _, err = cacheA.Push("origin")
145 require.NoError(t, err)
146
147 err = cacheB.Pull("origin")
148 require.NoError(t, err)
149
150 require.Len(t, cacheB.AllBugsIds(), 1)
151
152 // retrieve and set identity
153 reneB, err := cacheB.ResolveIdentity(reneA.Id())
154 require.NoError(t, err)
155
156 err = cacheB.SetUserIdentity(reneB)
157 require.NoError(t, err)
158
159 // B --> remote --> A
160 _, _, err = cacheB.NewBug("bug2", "message")
161 require.NoError(t, err)
162
163 _, err = cacheB.Push("origin")
164 require.NoError(t, err)
165
166 err = cacheA.Pull("origin")
167 require.NoError(t, err)
168
169 require.Len(t, cacheA.AllBugsIds(), 2)
170}
171
172func TestRemove(t *testing.T) {
173 repo := repository.CreateGoGitTestRepo(t, false)
174 remoteA := repository.CreateGoGitTestRepo(t, true)
175 remoteB := repository.CreateGoGitTestRepo(t, true)
176
177 err := repo.AddRemote("remoteA", remoteA.GetLocalRemote())
178 require.NoError(t, err)
179
180 err = repo.AddRemote("remoteB", remoteB.GetLocalRemote())
181 require.NoError(t, err)
182
183 repoCache, err := NewRepoCache(repo)
184 require.NoError(t, err)
185
186 rene, err := repoCache.NewIdentity("René Descartes", "rene@descartes.fr")
187 require.NoError(t, err)
188
189 err = repoCache.SetUserIdentity(rene)
190 require.NoError(t, err)
191
192 _, _, err = repoCache.NewBug("title", "message")
193 require.NoError(t, err)
194
195 // and one more for testing
196 b1, _, err := repoCache.NewBug("title", "message")
197 require.NoError(t, err)
198
199 _, err = repoCache.Push("remoteA")
200 require.NoError(t, err)
201
202 _, err = repoCache.Push("remoteB")
203 require.NoError(t, err)
204
205 _, err = repoCache.Fetch("remoteA")
206 require.NoError(t, err)
207
208 _, err = repoCache.Fetch("remoteB")
209 require.NoError(t, err)
210
211 err = repoCache.RemoveBug(b1.Id().String())
212 require.NoError(t, err)
213 assert.Equal(t, 1, len(repoCache.bugs))
214 assert.Equal(t, 1, len(repoCache.bugExcerpts))
215
216 _, err = repoCache.ResolveBug(b1.Id())
217 assert.ErrorIs(t, entity.ErrNotFound{}, err)
218}
219
220func TestCacheEviction(t *testing.T) {
221 repo := repository.CreateGoGitTestRepo(t, false)
222 repoCache, err := NewRepoCache(repo)
223 require.NoError(t, err)
224 repoCache.setCacheSize(2)
225
226 require.Equal(t, 2, repoCache.maxLoadedBugs)
227 require.Equal(t, 0, repoCache.loadedBugs.Len())
228 require.Equal(t, 0, len(repoCache.bugs))
229
230 // Generating some bugs
231 rene, err := repoCache.NewIdentity("René Descartes", "rene@descartes.fr")
232 require.NoError(t, err)
233 err = repoCache.SetUserIdentity(rene)
234 require.NoError(t, err)
235
236 bug1, _, err := repoCache.NewBug("title", "message")
237 require.NoError(t, err)
238
239 checkBugPresence(t, repoCache, bug1, true)
240 require.Equal(t, 1, repoCache.loadedBugs.Len())
241 require.Equal(t, 1, len(repoCache.bugs))
242
243 bug2, _, err := repoCache.NewBug("title", "message")
244 require.NoError(t, err)
245
246 checkBugPresence(t, repoCache, bug1, true)
247 checkBugPresence(t, repoCache, bug2, true)
248 require.Equal(t, 2, repoCache.loadedBugs.Len())
249 require.Equal(t, 2, len(repoCache.bugs))
250
251 // Number of bugs should not exceed max size of lruCache, oldest one should be evicted
252 bug3, _, err := repoCache.NewBug("title", "message")
253 require.NoError(t, err)
254
255 require.Equal(t, 2, repoCache.loadedBugs.Len())
256 require.Equal(t, 2, len(repoCache.bugs))
257 checkBugPresence(t, repoCache, bug1, false)
258 checkBugPresence(t, repoCache, bug2, true)
259 checkBugPresence(t, repoCache, bug3, true)
260
261 // Accessing bug should update position in lruCache and therefore it should not be evicted
262 repoCache.loadedBugs.Get(bug2.Id())
263 oldestId, _ := repoCache.loadedBugs.GetOldest()
264 require.Equal(t, bug3.Id(), oldestId)
265
266 checkBugPresence(t, repoCache, bug1, false)
267 checkBugPresence(t, repoCache, bug2, true)
268 checkBugPresence(t, repoCache, bug3, true)
269 require.Equal(t, 2, repoCache.loadedBugs.Len())
270 require.Equal(t, 2, len(repoCache.bugs))
271}
272
273func checkBugPresence(t *testing.T, cache *RepoCache, bug *BugCache, presence bool) {
274 id := bug.Id()
275 require.Equal(t, presence, cache.loadedBugs.Contains(id))
276 b, ok := cache.bugs[id]
277 require.Equal(t, presence, ok)
278 if ok {
279 require.Equal(t, bug, b)
280 }
281}
282
283func TestLongDescription(t *testing.T) {
284 // See https://github.com/MichaelMure/git-bug/issues/606
285
286 text := strings.Repeat("x", 65536)
287
288 repo := repository.CreateGoGitTestRepo(t, false)
289
290 backend, err := NewRepoCache(repo)
291 require.NoError(t, err)
292
293 i, err := backend.NewIdentity("René Descartes", "rene@descartes.fr")
294 require.NoError(t, err)
295
296 _, _, err = backend.NewBugRaw(i, time.Now().Unix(), text, text, nil, nil)
297 require.NoError(t, err)
298}