repo_cache_test.go

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