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/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(false)
18 defer repository.CleanupTestRepos(repo)
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, remote := repository.SetupGoGitReposAndRemote()
116 defer repository.CleanupTestRepos(repoA, repoB, remote)
117
118 cacheA, err := NewRepoCache(repoA)
119 require.NoError(t, err)
120
121 cacheB, err := NewRepoCache(repoB)
122 require.NoError(t, err)
123
124 // Create, set and get user identity
125 reneA, err := cacheA.NewIdentity("René Descartes", "rene@descartes.fr")
126 require.NoError(t, err)
127 err = cacheA.SetUserIdentity(reneA)
128 require.NoError(t, err)
129 isaacB, err := cacheB.NewIdentity("Isaac Newton", "isaac@newton.uk")
130 require.NoError(t, err)
131 err = cacheB.SetUserIdentity(isaacB)
132 require.NoError(t, err)
133
134 // distribute the identity
135 _, err = cacheA.Push("origin")
136 require.NoError(t, err)
137 err = cacheB.Pull("origin")
138 require.NoError(t, err)
139
140 // Create a bug in A
141 _, _, err = cacheA.NewBug("bug1", "message")
142 require.NoError(t, err)
143
144 // A --> remote --> B
145 _, err = cacheA.Push("origin")
146 require.NoError(t, err)
147
148 err = cacheB.Pull("origin")
149 require.NoError(t, err)
150
151 require.Len(t, cacheB.AllBugsIds(), 1)
152
153 // retrieve and set identity
154 reneB, err := cacheB.ResolveIdentity(reneA.Id())
155 require.NoError(t, err)
156
157 err = cacheB.SetUserIdentity(reneB)
158 require.NoError(t, err)
159
160 // B --> remote --> A
161 _, _, err = cacheB.NewBug("bug2", "message")
162 require.NoError(t, err)
163
164 _, err = cacheB.Push("origin")
165 require.NoError(t, err)
166
167 err = cacheA.Pull("origin")
168 require.NoError(t, err)
169
170 require.Len(t, cacheA.AllBugsIds(), 2)
171}
172
173func TestRemove(t *testing.T) {
174 repo := repository.CreateGoGitTestRepo(false)
175 remoteA := repository.CreateGoGitTestRepo(true)
176 remoteB := repository.CreateGoGitTestRepo(true)
177 defer repository.CleanupTestRepos(repo, remoteA, remoteB)
178
179 err := repo.AddRemote("remoteA", remoteA.GetLocalRemote())
180 require.NoError(t, err)
181
182 err = repo.AddRemote("remoteB", remoteB.GetLocalRemote())
183 require.NoError(t, err)
184
185 repoCache, err := NewRepoCache(repo)
186 require.NoError(t, err)
187
188 rene, err := repoCache.NewIdentity("René Descartes", "rene@descartes.fr")
189 require.NoError(t, err)
190
191 err = repoCache.SetUserIdentity(rene)
192 require.NoError(t, err)
193
194 _, _, err = repoCache.NewBug("title", "message")
195 require.NoError(t, err)
196
197 // and one more for testing
198 b1, _, err := repoCache.NewBug("title", "message")
199 require.NoError(t, err)
200
201 _, err = repoCache.Push("remoteA")
202 require.NoError(t, err)
203
204 _, err = repoCache.Push("remoteB")
205 require.NoError(t, err)
206
207 _, err = repoCache.Fetch("remoteA")
208 require.NoError(t, err)
209
210 _, err = repoCache.Fetch("remoteB")
211 require.NoError(t, err)
212
213 err = repoCache.RemoveBug(b1.Id().String())
214 require.NoError(t, err)
215 assert.Equal(t, 1, len(repoCache.bugs))
216 assert.Equal(t, 1, len(repoCache.bugExcerpts))
217
218 _, err = repoCache.ResolveBug(b1.Id())
219 assert.Error(t, bug.ErrBugNotExist, err)
220}
221
222func TestCacheEviction(t *testing.T) {
223 repo := repository.CreateGoGitTestRepo(false)
224 repoCache, err := NewRepoCache(repo)
225 require.NoError(t, err)
226 repoCache.setCacheSize(2)
227
228 require.Equal(t, 2, repoCache.maxLoadedBugs)
229 require.Equal(t, 0, repoCache.loadedBugs.Len())
230 require.Equal(t, 0, len(repoCache.bugs))
231
232 // Generating some bugs
233 rene, err := repoCache.NewIdentity("René Descartes", "rene@descartes.fr")
234 require.NoError(t, err)
235 err = repoCache.SetUserIdentity(rene)
236 require.NoError(t, err)
237
238 bug1, _, err := repoCache.NewBug("title", "message")
239 require.NoError(t, err)
240
241 checkBugPresence(t, repoCache, bug1, true)
242 require.Equal(t, 1, repoCache.loadedBugs.Len())
243 require.Equal(t, 1, len(repoCache.bugs))
244
245 bug2, _, err := repoCache.NewBug("title", "message")
246 require.NoError(t, err)
247
248 checkBugPresence(t, repoCache, bug1, true)
249 checkBugPresence(t, repoCache, bug2, true)
250 require.Equal(t, 2, repoCache.loadedBugs.Len())
251 require.Equal(t, 2, len(repoCache.bugs))
252
253 // Number of bugs should not exceed max size of lruCache, oldest one should be evicted
254 bug3, _, err := repoCache.NewBug("title", "message")
255 require.NoError(t, err)
256
257 require.Equal(t, 2, repoCache.loadedBugs.Len())
258 require.Equal(t, 2, len(repoCache.bugs))
259 checkBugPresence(t, repoCache, bug1, false)
260 checkBugPresence(t, repoCache, bug2, true)
261 checkBugPresence(t, repoCache, bug3, true)
262
263 // Accessing bug should update position in lruCache and therefore it should not be evicted
264 repoCache.loadedBugs.Get(bug2.Id())
265 oldestId, _ := repoCache.loadedBugs.GetOldest()
266 require.Equal(t, bug3.Id(), oldestId)
267
268 checkBugPresence(t, repoCache, bug1, false)
269 checkBugPresence(t, repoCache, bug2, true)
270 checkBugPresence(t, repoCache, bug3, true)
271 require.Equal(t, 2, repoCache.loadedBugs.Len())
272 require.Equal(t, 2, len(repoCache.bugs))
273}
274
275func checkBugPresence(t *testing.T, cache *RepoCache, bug *BugCache, presence bool) {
276 id := bug.Id()
277 require.Equal(t, presence, cache.loadedBugs.Contains(id))
278 b, ok := cache.bugs[id]
279 require.Equal(t, presence, ok)
280 if ok {
281 require.Equal(t, bug, b)
282 }
283}
284
285func TestLongDescription(t *testing.T) {
286 // See https://github.com/MichaelMure/git-bug/issues/606
287
288 text := strings.Repeat("x", 65536)
289
290 repo := repository.CreateGoGitTestRepo(false)
291 defer repository.CleanupTestRepos(repo)
292
293 backend, err := NewRepoCache(repo)
294 require.NoError(t, err)
295
296 i, err := backend.NewIdentity("René Descartes", "rene@descartes.fr")
297 require.NoError(t, err)
298
299 _, _, err = backend.NewBugRaw(i, time.Now().Unix(), text, text, nil, nil)
300 require.NoError(t, err)
301}