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

entry_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: 2ba26fd2e32fea852a3db629634710242d3d0f18 (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
package cache

import (
	"context"
	"errors"
	"net/http"
	"testing"
	"time"

	"github.com/stretchr/testify/require"

	"gitlab.com/gitlab-org/gitlab-pages/internal/config"
	"gitlab.com/gitlab-org/gitlab-pages/internal/domain"
	"gitlab.com/gitlab-org/gitlab-pages/internal/source/gitlab/api"
)

func TestIsUpToDateAndNeedsRefresh(t *testing.T) {
	tests := []struct {
		name                string
		resolved            bool
		expired             bool
		expectedIsUpToDate  bool
		expectedNeedRefresh bool
	}{
		{
			name:                "resolved_and_not_expired",
			resolved:            true,
			expired:             false,
			expectedIsUpToDate:  true,
			expectedNeedRefresh: false,
		},
		{
			name:                "resolved_and_expired",
			resolved:            true,
			expired:             true,
			expectedIsUpToDate:  false,
			expectedNeedRefresh: true,
		},
		{
			name:                "not_resolved_and_not_expired",
			resolved:            false,
			expired:             false,
			expectedIsUpToDate:  false,
			expectedNeedRefresh: false,
		},
		{
			name:                "not_resolved_and_expired",
			resolved:            false,
			expired:             true,
			expectedIsUpToDate:  false,
			expectedNeedRefresh: false,
		},
	}

	for _, tt := range tests {
		t.Run(tt.name, func(t *testing.T) {
			entry := newCacheEntry("my.gitlab.com", testCacheConfig.EntryRefreshTimeout, testCacheConfig.CacheExpiry)
			if tt.resolved {
				entry.response = &api.Lookup{}
			}
			if tt.expired {
				entry.created = time.Now().Add(-time.Hour)
			}

			require.Equal(t, tt.expectedIsUpToDate, entry.IsUpToDate())
			require.Equal(t, tt.expectedNeedRefresh, entry.NeedsRefresh())
		})
	}
}

func TestEntryRefresh(t *testing.T) {
	client := &lookupMock{
		successCount: 1,
		responses: map[string]api.Lookup{
			"test.gitlab.io": api.Lookup{
				Name: "test.gitlab.io",
				Domain: &api.VirtualDomain{
					LookupPaths: nil,
				},
			},
			"error.gitlab.io": api.Lookup{
				Name:  "error.gitlab.io",
				Error: errors.New("something went wrong"),
			},
		},
	}

	cc := &config.Cache{
		CacheExpiry:          100 * time.Millisecond,
		EntryRefreshTimeout:  time.Millisecond,
		RetrievalTimeout:     50 * time.Millisecond,
		MaxRetrievalInterval: time.Millisecond,
		MaxRetrievalRetries:  1,
	}
	cache := NewCache(client, cc)

	t.Run("entry is the same after refreshed lookup has error", func(t *testing.T) {
		entry := newCacheEntry("test.gitlab.io", cc.EntryRefreshTimeout, cc.CacheExpiry)
		originalEntryCreated := entry.created

		ctx, cancel := context.WithTimeout(context.Background(), cc.RetrievalTimeout)
		defer cancel()

		lookup := cache.retrieve(ctx, entry)
		require.NoError(t, lookup.Error)

		require.Eventually(t, entry.NeedsRefresh, 100*time.Millisecond, time.Millisecond, "entry should need refresh")

		cache.refreshFunc(entry)

		require.True(t, client.failed, "refresh should have failed")

		storedEntry := loadEntry(t, "test.gitlab.io", cache.store)

		require.NoError(t, storedEntry.Lookup().Error, "resolving failed but lookup should still be valid")
		require.Equal(t, storedEntry.refreshedOriginalTimestamp.UnixNano(), originalEntryCreated.UnixNano(),
			"refreshed entry timestamp should be the same as the original entry created timestamp")
		require.Equal(t, storedEntry.Lookup(), entry.Lookup(), "lookup should be the same")
	})

	t.Run("entry is different after it expired and calling refresh on it", func(t *testing.T) {
		client.failed = false

		entry := newCacheEntry("error.gitlab.io", cc.EntryRefreshTimeout, cc.CacheExpiry)

		ctx, cancel := context.WithTimeout(context.Background(), cc.RetrievalTimeout)
		defer cancel()

		lookup := cache.retrieve(ctx, entry)
		require.Error(t, lookup.Error)
		require.Eventually(t, entry.NeedsRefresh, 100*time.Millisecond, time.Millisecond, "entry should need refresh")

		// wait for entry to expire
		time.Sleep(cc.CacheExpiry)
		// refreshing the entry after it has expired should create a completely new one
		cache.refreshFunc(entry)

		require.True(t, client.failed, "refresh should have failed")

		storedEntry := loadEntry(t, "error.gitlab.io", cache.store)
		require.NotEqual(t, storedEntry, entry, "stored entry should be different")
		require.Greater(t, storedEntry.created.UnixNano(), entry.created.UnixNano(), "")
	})
}

func loadEntry(t *testing.T, domain string, store Store) *Entry {
	t.Helper()

	i, exists := store.(*memstore).store.Get(domain)
	require.True(t, exists)

	return i.(*Entry)
}

type lookupMock struct {
	currentCount int
	successCount int
	failed       bool
	responses    map[string]api.Lookup
}

func (lm *lookupMock) GetLookup(ctx context.Context, domainName string) api.Lookup {
	lookup, ok := lm.responses[domainName]
	if !ok {
		lookup.Error = domain.ErrDomainDoesNotExist
		return lookup
	}

	// return error after lm.successCount
	lm.currentCount++
	if lm.currentCount > lm.successCount {
		lm.currentCount = 0
		lm.failed = true

		lookup.Error = http.ErrServerClosed
	}

	return lookup
}

func (lm *lookupMock) Status() error {
	return nil
}