summaryrefslogtreecommitdiffstats
path: root/models/quota/quota_rule_test.go
blob: 1e1daf4c4a69678b847ba3284d98ebe5244f2267 (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
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
// Copyright 2024 The Forgejo Authors. All rights reserved.
// SPDX-License-Identifier: MIT

package quota_test

import (
	"testing"

	quota_model "code.gitea.io/gitea/models/quota"

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

func makeFullyUsed() quota_model.Used {
	return quota_model.Used{
		Size: quota_model.UsedSize{
			Repos: quota_model.UsedSizeRepos{
				Public:  1024,
				Private: 1024,
			},
			Git: quota_model.UsedSizeGit{
				LFS: 1024,
			},
			Assets: quota_model.UsedSizeAssets{
				Attachments: quota_model.UsedSizeAssetsAttachments{
					Issues:   1024,
					Releases: 1024,
				},
				Artifacts: 1024,
				Packages: quota_model.UsedSizeAssetsPackages{
					All: 1024,
				},
			},
		},
	}
}

func makePartiallyUsed() quota_model.Used {
	return quota_model.Used{
		Size: quota_model.UsedSize{
			Repos: quota_model.UsedSizeRepos{
				Public: 1024,
			},
			Assets: quota_model.UsedSizeAssets{
				Attachments: quota_model.UsedSizeAssetsAttachments{
					Releases: 1024,
				},
			},
		},
	}
}

func setUsed(used quota_model.Used, subject quota_model.LimitSubject, value int64) *quota_model.Used {
	switch subject {
	case quota_model.LimitSubjectSizeReposPublic:
		used.Size.Repos.Public = value
		return &used
	case quota_model.LimitSubjectSizeReposPrivate:
		used.Size.Repos.Private = value
		return &used
	case quota_model.LimitSubjectSizeGitLFS:
		used.Size.Git.LFS = value
		return &used
	case quota_model.LimitSubjectSizeAssetsAttachmentsIssues:
		used.Size.Assets.Attachments.Issues = value
		return &used
	case quota_model.LimitSubjectSizeAssetsAttachmentsReleases:
		used.Size.Assets.Attachments.Releases = value
		return &used
	case quota_model.LimitSubjectSizeAssetsArtifacts:
		used.Size.Assets.Artifacts = value
		return &used
	case quota_model.LimitSubjectSizeAssetsPackagesAll:
		used.Size.Assets.Packages.All = value
		return &used
	case quota_model.LimitSubjectSizeWiki:
	}

	return nil
}

func assertEvaluation(t *testing.T, rule quota_model.Rule, used quota_model.Used, subject quota_model.LimitSubject, expected bool) {
	t.Helper()

	t.Run(subject.String(), func(t *testing.T) {
		ok, has := rule.Evaluate(used, subject)
		assert.True(t, has)
		assert.Equal(t, expected, ok)
	})
}

func TestQuotaRuleNoEvaluation(t *testing.T) {
	rule := quota_model.Rule{
		Limit: 1024,
		Subjects: quota_model.LimitSubjects{
			quota_model.LimitSubjectSizeAssetsAttachmentsAll,
		},
	}
	used := quota_model.Used{}
	used.Size.Repos.Public = 4096

	_, has := rule.Evaluate(used, quota_model.LimitSubjectSizeReposAll)

	// We have a rule for "size:assets:attachments:all", and query for
	// "size:repos:all". We don't cover that subject, so the evaluation returns
	// with no rules found.
	assert.False(t, has)
}

func TestQuotaRuleDirectEvaluation(t *testing.T) {
	// This function is meant to test direct rule evaluation: cases where we set
	// a rule for a subject, and we evaluate against the same subject.

	runTest := func(t *testing.T, subject quota_model.LimitSubject, limit, used int64, expected bool) {
		t.Helper()

		rule := quota_model.Rule{
			Limit: limit,
			Subjects: quota_model.LimitSubjects{
				subject,
			},
		}
		usedObj := setUsed(quota_model.Used{}, subject, used)
		if usedObj == nil {
			return
		}

		assertEvaluation(t, rule, *usedObj, subject, expected)
	}

	t.Run("limit:0", func(t *testing.T) {
		// With limit:0, nothing used is fine.
		t.Run("used:0", func(t *testing.T) {
			for subject := quota_model.LimitSubjectFirst; subject <= quota_model.LimitSubjectLast; subject++ {
				runTest(t, subject, 0, 0, true)
			}
		})
		// With limit:0, any usage will fail evaluation
		t.Run("used:512", func(t *testing.T) {
			for subject := quota_model.LimitSubjectFirst; subject <= quota_model.LimitSubjectLast; subject++ {
				runTest(t, subject, 0, 512, false)
			}
		})
	})

	t.Run("limit:unlimited", func(t *testing.T) {
		// With no limits, any usage will succeed evaluation
		t.Run("used:512", func(t *testing.T) {
			for subject := quota_model.LimitSubjectFirst; subject <= quota_model.LimitSubjectLast; subject++ {
				runTest(t, subject, -1, 512, true)
			}
		})
	})

	t.Run("limit:1024", func(t *testing.T) {
		// With a set limit, usage below the limit succeeds
		t.Run("used:512", func(t *testing.T) {
			for subject := quota_model.LimitSubjectFirst; subject <= quota_model.LimitSubjectLast; subject++ {
				runTest(t, subject, 1024, 512, true)
			}
		})

		// With a set limit, usage above the limit fails
		t.Run("used:2048", func(t *testing.T) {
			for subject := quota_model.LimitSubjectFirst; subject <= quota_model.LimitSubjectLast; subject++ {
				runTest(t, subject, 1024, 2048, false)
			}
		})
	})
}

func TestQuotaRuleCombined(t *testing.T) {
	rule := quota_model.Rule{
		Limit: 1024,
		Subjects: quota_model.LimitSubjects{
			quota_model.LimitSubjectSizeGitLFS,
			quota_model.LimitSubjectSizeAssetsAttachmentsReleases,
			quota_model.LimitSubjectSizeAssetsPackagesAll,
		},
	}
	used := quota_model.Used{
		Size: quota_model.UsedSize{
			Repos: quota_model.UsedSizeRepos{
				Public: 4096,
			},
			Git: quota_model.UsedSizeGit{
				LFS: 256,
			},
			Assets: quota_model.UsedSizeAssets{
				Attachments: quota_model.UsedSizeAssetsAttachments{
					Issues:   2048,
					Releases: 256,
				},
				Packages: quota_model.UsedSizeAssetsPackages{
					All: 2560,
				},
			},
		},
	}

	expectationMap := map[quota_model.LimitSubject]bool{
		quota_model.LimitSubjectSizeGitLFS:                    false,
		quota_model.LimitSubjectSizeAssetsAttachmentsReleases: false,
		quota_model.LimitSubjectSizeAssetsPackagesAll:         false,
	}

	for subject := quota_model.LimitSubjectFirst; subject <= quota_model.LimitSubjectLast; subject++ {
		t.Run(subject.String(), func(t *testing.T) {
			evalOk, evalHas := rule.Evaluate(used, subject)
			expected, expectedHas := expectationMap[subject]

			assert.Equal(t, expectedHas, evalHas)
			if expectedHas {
				assert.Equal(t, expected, evalOk)
			}
		})
	}
}

func TestQuotaRuleSizeAll(t *testing.T) {
	runTests := func(t *testing.T, rule quota_model.Rule, expected bool) {
		t.Helper()

		subject := quota_model.LimitSubjectSizeAll

		t.Run("used:0", func(t *testing.T) {
			used := quota_model.Used{}

			assertEvaluation(t, rule, used, subject, true)
		})

		t.Run("used:some-each", func(t *testing.T) {
			used := makeFullyUsed()

			assertEvaluation(t, rule, used, subject, expected)
		})

		t.Run("used:some", func(t *testing.T) {
			used := makePartiallyUsed()

			assertEvaluation(t, rule, used, subject, expected)
		})
	}

	// With all limits set to 0, evaluation always fails if usage > 0
	t.Run("rule:0", func(t *testing.T) {
		rule := quota_model.Rule{
			Limit: 0,
			Subjects: quota_model.LimitSubjects{
				quota_model.LimitSubjectSizeAll,
			},
		}

		runTests(t, rule, false)
	})

	// With no limits, evaluation always succeeds
	t.Run("rule:unlimited", func(t *testing.T) {
		rule := quota_model.Rule{
			Limit: -1,
			Subjects: quota_model.LimitSubjects{
				quota_model.LimitSubjectSizeAll,
			},
		}

		runTests(t, rule, true)
	})

	// With a specific, very generous limit, evaluation succeeds if the limit isn't exhausted
	t.Run("rule:generous", func(t *testing.T) {
		rule := quota_model.Rule{
			Limit: 102400,
			Subjects: quota_model.LimitSubjects{
				quota_model.LimitSubjectSizeAll,
			},
		}

		runTests(t, rule, true)

		t.Run("limit exhaustion", func(t *testing.T) {
			used := quota_model.Used{
				Size: quota_model.UsedSize{
					Repos: quota_model.UsedSizeRepos{
						Public: 204800,
					},
				},
			}

			assertEvaluation(t, rule, used, quota_model.LimitSubjectSizeAll, false)
		})
	})

	// With a specific, small limit, evaluation fails
	t.Run("rule:limited", func(t *testing.T) {
		rule := quota_model.Rule{
			Limit: 512,
			Subjects: quota_model.LimitSubjects{
				quota_model.LimitSubjectSizeAll,
			},
		}

		runTests(t, rule, false)
	})
}