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
90 cache, err = NewRepoCache(repo)
91 require.NoError(t, err)
92 require.Empty(t, cache.bugs)
93 require.Empty(t, cache.identities)
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, remote := repository.SetupGoGitReposAndRemote()
115 defer repository.CleanupTestRepos(repoA, repoB, remote)
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(false)
174 remoteA := repository.CreateGoGitTestRepo(true)
175 remoteB := repository.CreateGoGitTestRepo(true)
176 defer repository.CleanupTestRepos(repo, remoteA, remoteB)
177
178 err := repo.AddRemote("remoteA", remoteA.GetLocalRemote())
179 require.NoError(t, err)
180
181 err = repo.AddRemote("remoteB", remoteB.GetLocalRemote())
182 require.NoError(t, err)
183
184 repoCache, err := NewRepoCache(repo)
185 require.NoError(t, err)
186
187 rene, err := repoCache.NewIdentity("René Descartes", "rene@descartes.fr")
188 require.NoError(t, err)
189
190 err = repoCache.SetUserIdentity(rene)
191 require.NoError(t, err)
192
193 _, _, err = repoCache.NewBug("title", "message")
194 require.NoError(t, err)
195
196 // and one more for testing
197 b1, _, err := repoCache.NewBug("title", "message")
198 require.NoError(t, err)
199
200 _, err = repoCache.Push("remoteA")
201 require.NoError(t, err)
202
203 _, err = repoCache.Push("remoteB")
204 require.NoError(t, err)
205
206 _, err = repoCache.Fetch("remoteA")
207 require.NoError(t, err)
208
209 _, err = repoCache.Fetch("remoteB")
210 require.NoError(t, err)
211
212 err = repoCache.RemoveBug(b1.Id().String())
213 require.NoError(t, err)
214 assert.Equal(t, 1, len(repoCache.bugs))
215 assert.Equal(t, 1, len(repoCache.bugExcerpts))
216
217 _, err = repoCache.ResolveBug(b1.Id())
218 assert.Error(t, bug.ErrBugNotExist, err)
219}
220
221func TestCacheEviction(t *testing.T) {
222 repo := repository.CreateGoGitTestRepo(false)
223 repoCache, err := NewRepoCache(repo)
224 require.NoError(t, err)
225 repoCache.setCacheSize(2)
226
227 require.Equal(t, 2, repoCache.maxLoadedBugs)
228 require.Equal(t, 0, repoCache.loadedBugs.Len())
229 require.Equal(t, 0, len(repoCache.bugs))
230
231 // Generating some bugs
232 rene, err := repoCache.NewIdentity("René Descartes", "rene@descartes.fr")
233 require.NoError(t, err)
234 err = repoCache.SetUserIdentity(rene)
235 require.NoError(t, err)
236
237 bug1, _, err := repoCache.NewBug("title", "message")
238 require.NoError(t, err)
239
240 checkBugPresence(t, repoCache, bug1, true)
241 require.Equal(t, 1, repoCache.loadedBugs.Len())
242 require.Equal(t, 1, len(repoCache.bugs))
243
244 bug2, _, err := repoCache.NewBug("title", "message")
245 require.NoError(t, err)
246
247 checkBugPresence(t, repoCache, bug1, true)
248 checkBugPresence(t, repoCache, bug2, true)
249 require.Equal(t, 2, repoCache.loadedBugs.Len())
250 require.Equal(t, 2, len(repoCache.bugs))
251
252 // Number of bugs should not exceed max size of lruCache, oldest one should be evicted
253 bug3, _, err := repoCache.NewBug("title", "message")
254 require.NoError(t, err)
255
256 require.Equal(t, 2, repoCache.loadedBugs.Len())
257 require.Equal(t, 2, len(repoCache.bugs))
258 checkBugPresence(t, repoCache, bug1, false)
259 checkBugPresence(t, repoCache, bug2, true)
260 checkBugPresence(t, repoCache, bug3, true)
261
262 // Accessing bug should update position in lruCache and therefore it should not be evicted
263 repoCache.loadedBugs.Get(bug2.Id())
264 oldestId, _ := repoCache.loadedBugs.GetOldest()
265 require.Equal(t, bug3.Id(), oldestId)
266
267 checkBugPresence(t, repoCache, bug1, false)
268 checkBugPresence(t, repoCache, bug2, true)
269 checkBugPresence(t, repoCache, bug3, true)
270 require.Equal(t, 2, repoCache.loadedBugs.Len())
271 require.Equal(t, 2, len(repoCache.bugs))
272}
273
274func checkBugPresence(t *testing.T, cache *RepoCache, bug *BugCache, presence bool) {
275 id := bug.Id()
276 require.Equal(t, presence, cache.loadedBugs.Contains(id))
277 b, ok := cache.bugs[id]
278 require.Equal(t, presence, ok)
279 if ok {
280 require.Equal(t, bug, b)
281 }
282}
283
284func TestLongDescription(t *testing.T) {
285 // See https://github.com/MichaelMure/git-bug/issues/606
286
287 text := strings.Repeat("x", 65536)
288
289 repo := repository.CreateGoGitTestRepo(false)
290 defer repository.CleanupTestRepos(repo)
291
292 backend, err := NewRepoCache(repo)
293 require.NoError(t, err)
294
295 i, err := backend.NewIdentity("René Descartes", "rene@descartes.fr")
296 require.NoError(t, err)
297
298 _, _, err = backend.NewBugRaw(i, time.Now().Unix(), text, text, nil, nil)
299 require.NoError(t, err)
300}