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