Welcome to mirror list, hosted at ThFree Co, Russian Federation.

cache_test.go « cache « gitlab « source « internal - gitlab.com/gitlab-org/gitlab-pages.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: d0fbd4e11b351631d858a50f5ee76d8124956aa7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
package cache

import (
	"context"
	"errors"
	"sync"
	"sync/atomic"
	"testing"
	"time"

	"github.com/stretchr/testify/assert"
)

type client struct {
	resolutions uint64
	domain      chan string
	failure     error
	status      int
}

func (c *client) Resolve(ctx context.Context, _ string) Lookup {
	atomic.AddUint64(&c.resolutions, 1)

	if c.status == 0 {
		c.status = 200
	}

	if c.failure != nil {
		return Lookup{Domain: Domain{}, Status: c.status, Error: c.failure}
	}

	return Lookup{Domain: Domain{Name: <-c.domain}, Status: c.status, Error: nil}
}

func withTestCache(config resolverConfig, block func(*Cache, *client)) {
	var resolver *client

	if config.buffered {
		resolver = &client{domain: make(chan string, 1), failure: config.failure}
	} else {
		resolver = &client{domain: make(chan string), failure: config.failure}
	}

	cache := NewCache(resolver)

	block(cache, resolver)
}

func (cache *Cache) withTestEntry(config entryConfig, block func()) {
	domain := "my.gitlab.com"

	if len(config.domain) > 0 {
		domain = config.domain
	}

	entry := cache.store.ReplaceOrCreate(context.Background(), domain)

	if config.retrieved {
		newResponse := make(chan Lookup, 1)
		newResponse <- Lookup{Domain: Domain{Name: domain}, Status: 200}
		entry.setResponse(newResponse)
	}

	if config.expired {
		entry.created = time.Now().Add(-time.Hour)
	}

	block()
}

type resolverConfig struct {
	buffered bool
	failure  error
}

type entryConfig struct {
	domain    string
	expired   bool
	retrieved bool
}

func TestResolve(t *testing.T) {
	t.Run("when item is not cached", func(t *testing.T) {
		withTestCache(resolverConfig{buffered: true}, func(cache *Cache, resolver *client) {
			resolver.domain <- "my.gitlab.com"

			lookup := cache.Resolve(context.Background(), "my.gitlab.com")

			assert.NoError(t, lookup.Error)
			assert.Equal(t, 200, lookup.Status)
			assert.Equal(t, "my.gitlab.com", lookup.Domain.Name)
			assert.Equal(t, uint64(1), resolver.resolutions)
		})
	})

	t.Run("when item is not cached and accessed multiple times", func(t *testing.T) {
		withTestCache(resolverConfig{}, func(cache *Cache, resolver *client) {
			wg := &sync.WaitGroup{}
			ctx := context.Background()

			receiver := func() {
				defer wg.Done()
				cache.Resolve(ctx, "my.gitlab.com")
			}

			wg.Add(3)
			go receiver()
			go receiver()
			go receiver()

			assert.Equal(t, uint64(0), resolver.resolutions)

			resolver.domain <- "my.gitlab.com"
			wg.Wait()

			assert.Equal(t, uint64(1), resolver.resolutions)
		})
	})

	t.Run("when item is in short cache", func(t *testing.T) {
		withTestCache(resolverConfig{}, func(cache *Cache, resolver *client) {
			cache.withTestEntry(entryConfig{expired: false, retrieved: true}, func() {
				lookup := cache.Resolve(context.Background(), "my.gitlab.com")

				assert.Equal(t, "my.gitlab.com", lookup.Domain.Name)
				assert.Equal(t, uint64(0), resolver.resolutions)
			})
		})
	})

	t.Run("when item is in long cache only", func(t *testing.T) {
		withTestCache(resolverConfig{}, func(cache *Cache, resolver *client) {
			cache.withTestEntry(entryConfig{expired: true, retrieved: true}, func() {
				lookup := cache.Resolve(context.Background(), "my.gitlab.com")

				assert.Equal(t, "my.gitlab.com", lookup.Domain.Name)
				assert.Equal(t, uint64(0), resolver.resolutions)

				resolver.domain <- "my.gitlab.com"
				assert.Equal(t, uint64(1), resolver.resolutions)
			})
		})
	})

	t.Run("when item in long cache is requested multiple times", func(t *testing.T) {
		withTestCache(resolverConfig{}, func(cache *Cache, resolver *client) {
			cache.withTestEntry(entryConfig{expired: true, retrieved: true}, func() {
				cache.Resolve(context.Background(), "my.gitlab.com")
				cache.Resolve(context.Background(), "my.gitlab.com")
				cache.Resolve(context.Background(), "my.gitlab.com")

				assert.Equal(t, uint64(0), resolver.resolutions)

				resolver.domain <- "my.gitlab.com"
				assert.Equal(t, uint64(1), resolver.resolutions)
			})
		})
	})

	t.Run("when retrieval failed with an error", func(t *testing.T) {
		withTestCache(resolverConfig{failure: errors.New("500 err")}, func(cache *Cache, resolver *client) {
			maxRetrievalInterval = 0

			lookup := cache.Resolve(context.Background(), "my.gitlab.com")

			assert.Equal(t, uint64(3), resolver.resolutions)
			assert.EqualError(t, lookup.Error, "500 err")
		})
	})

	t.Run("when retrieval failed because of an external context timeout", func(t *testing.T) {
		ctx, cancel := context.WithDeadline(context.Background(), time.Now().Add(-time.Hour))
		defer cancel()

		withTestCache(resolverConfig{}, func(cache *Cache, resolver *client) {
			lookup := cache.Resolve(ctx, "my.gitlab.com")

			assert.Equal(t, uint64(0), resolver.resolutions)
			assert.EqualError(t, lookup.Error, "context timeout")
		})
	})

	t.Run("when retrieval failed because of an internal context timeout", func(t *testing.T) {
		retrievalTimeout = 0

		withTestCache(resolverConfig{}, func(cache *Cache, resolver *client) {
			lookup := cache.Resolve(context.Background(), "my.gitlab.com")

			assert.Equal(t, uint64(0), resolver.resolutions)
			assert.EqualError(t, lookup.Error, "context timeout")
		})
	})
}