Repository navigation
Expand file tree
/
Copy pathwrite_test.go
More file actions
314 lines (270 loc) · 10.9 KB
/
Copy pathwrite_test.go
File metadata and controls
314 lines (270 loc) · 10.9 KB
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
305
306
307
308
309
310
311
312
313
314
package experiments_test
import (
"context"
"encoding/json"
"sync"
"testing"
"github.com/google/uuid"
"github.com/stretchr/testify/require"
"golang.org/x/xerrors"
"cdr.dev/slog/v3/sloggers/slogtest"
"github.com/coder/coder/v2/coderd/database"
"github.com/coder/coder/v2/coderd/database/dbgen"
"github.com/coder/coder/v2/coderd/database/dbtestutil"
"github.com/coder/coder/v2/coderd/experiments"
"github.com/coder/coder/v2/codersdk"
"github.com/coder/coder/v2/testutil"
)
var (
ruleOn = experiments.Rule{Mode: experiments.ModeOn}
ruleOff = experiments.Rule{Mode: experiments.ModeOff}
// ruleInherit is what reset writes.
ruleInherit = experiments.Rule{Mode: experiments.ModeInherit}
)
// writeRule calls WriteRule and requires success.
func writeRule(ctx context.Context, t *testing.T, db database.Store, actor uuid.UUID, rule experiments.Rule, expected int64) (oldRule, newRule experiments.Rule, changed bool) {
t.Helper()
oldRule, newRule, changed, err := experiments.WriteRule(ctx, db, actor, scoped, rule, expected)
require.NoError(t, err)
return oldRule, newRule, changed
}
// storedValue returns the raw stored value for the scoped experiment.
func storedValue(ctx context.Context, t *testing.T, db database.Store) string {
t.Helper()
value, err := db.GetExperimentRule(ctx, string(scoped))
require.NoError(t, err)
return value
}
func requireConflict(t *testing.T, err error, expected, current int64) {
t.Helper()
var conflict *experiments.RevisionConflictError
require.ErrorAs(t, err, &conflict)
require.Equal(t, expected, conflict.Expected)
require.Equal(t, current, conflict.Current)
}
func TestWriteRule(t *testing.T) {
t.Parallel()
t.Run("RevisionsIncrease", func(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitMedium)
db, _ := dbtestutil.NewDB(t)
actor := uuid.New()
condition := experiments.Rule{Mode: experiments.ModeCondition, Condition: `user.username == "alice"`}
previous := experiments.Rule{}
for i, rule := range []experiments.Rule{ruleOn, ruleOff, condition, ruleInherit} {
oldRule, newRule, changed := writeRule(ctx, t, db, actor, rule, int64(i))
require.True(t, changed)
require.Equal(t, previous, oldRule)
require.Equal(t, rule.Mode, newRule.Mode)
require.Equal(t, rule.Condition, newRule.Condition)
require.Equal(t, int64(i+1), newRule.Revision)
require.Equal(t, actor, newRule.UpdatedBy)
require.False(t, newRule.UpdatedAt.IsZero())
previous = newRule
}
})
t.Run("IdenticalRuleIsNoOp", func(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitMedium)
db, _ := dbtestutil.NewDB(t)
// The first inherit creates the row, so it is a change.
oldRule, created, changed := writeRule(ctx, t, db, uuid.New(), ruleInherit, 0)
require.True(t, changed)
require.Equal(t, experiments.Rule{}, oldRule)
require.Equal(t, int64(1), created.Revision)
before := storedValue(ctx, t, db)
// Another actor writing the same rule changes nothing.
oldRule, newRule, changed := writeRule(ctx, t, db, uuid.New(), ruleInherit, 1)
require.False(t, changed)
require.Equal(t, created, oldRule)
require.Equal(t, created, newRule)
require.Equal(t, before, storedValue(ctx, t, db))
})
t.Run("StaleRevisionAfterResetAndRecreate", func(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitMedium)
db, _ := dbtestutil.NewDB(t)
actor := uuid.New()
writeRule(ctx, t, db, actor, ruleOn, 0)
writeRule(ctx, t, db, actor, ruleInherit, 1) // reset
writeRule(ctx, t, db, actor, ruleOn, 2) // recreate
before := storedValue(ctx, t, db)
// A client that read revision 1 sees the same content again but
// must still be rejected.
_, _, _, err := experiments.WriteRule(ctx, db, actor, scoped, ruleOff, 1)
requireConflict(t, err, 1, 3)
_, _, _, err = experiments.WriteRule(ctx, db, actor, scoped, ruleOn, 0)
requireConflict(t, err, 0, 3)
require.Equal(t, before, storedValue(ctx, t, db))
})
t.Run("ConcurrentWritersOneWins", func(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitMedium)
db, _, sqlDB := dbtestutil.NewDBWithSQLDB(t)
actor := uuid.New()
// Hold the write lock so that both writers are queued behind it
// before either reads the current revision.
holding := make(chan struct{})
release := make(chan struct{})
releaseLock := sync.OnceFunc(func() { close(release) })
t.Cleanup(releaseLock)
holderErr := make(chan error, 1)
go func() {
holderErr <- db.InTx(func(tx database.Store) error {
if err := tx.AcquireLock(ctx, database.GenLockID("experiment_rule:"+string(scoped))); err != nil {
return err
}
close(holding)
<-release
return nil
}, nil)
}()
testutil.TryReceive(ctx, t, holding)
results := make(chan error, 2)
for range 2 {
go func() {
_, _, _, err := experiments.WriteRule(ctx, db, actor, scoped, ruleOn, 0)
results <- err
}()
}
testutil.Eventually(ctx, t, func(ctx context.Context) bool {
var waiting int
err := sqlDB.QueryRowContext(ctx, `SELECT count(*) FROM pg_locks
WHERE locktype = 'advisory' AND NOT granted
AND database = (SELECT oid FROM pg_database WHERE datname = current_database())`).Scan(&waiting)
return err == nil && waiting == 2
}, testutil.IntervalFast, "both writers wait for the lock")
releaseLock()
require.NoError(t, testutil.TryReceive(ctx, t, holderErr))
var wins int
for range 2 {
err := testutil.TryReceive(ctx, t, results)
if err == nil {
wins++
continue
}
requireConflict(t, err, 0, 1)
}
require.Equal(t, 1, wins)
var stored experiments.Rule
require.NoError(t, json.Unmarshal([]byte(storedValue(ctx, t, db)), &stored))
require.Equal(t, int64(1), stored.Revision)
})
t.Run("ErrorAfterWriteRollsBack", func(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitMedium)
db, _ := dbtestutil.NewDB(t)
actor := uuid.New()
writeRule(ctx, t, db, actor, ruleOn, 0)
before := storedValue(ctx, t, db)
_, _, _, err := experiments.WriteRule(ctx, failAfterUpsert{db}, actor, scoped, ruleOff, 1)
require.ErrorIs(t, err, errInjected)
require.Equal(t, before, storedValue(ctx, t, db))
})
t.Run("InvalidRuleNotStored", func(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitMedium)
db, _ := dbtestutil.NewDB(t)
actor := uuid.New()
_, _, _, err := experiments.WriteRule(ctx, db, actor, unscoped, ruleOn, 0)
require.Error(t, err)
_, _, _, err = experiments.WriteRule(ctx, db, actor, scoped, experiments.Rule{Mode: experiments.ModeCondition, Condition: "user."}, 0)
require.Error(t, err)
rows, err := db.GetExperimentRules(ctx)
require.NoError(t, err)
require.Empty(t, rows)
})
// A stored value the Evaluator treats as malformed must stay
// replaceable through WriteRule as long as its revision is readable.
t.Run("MalformedRuleReplaceable", func(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitMedium)
db, _ := dbtestutil.NewDB(t)
actor := uuid.New()
for i, value := range []string{
`{"revision":2,"updated_by":7}`,
`{"revision":3,"mode":"percent"}`,
`{"revision":4,"mode":["on"],"condition":{}}`,
} {
require.NoError(t, db.UpsertExperimentRule(ctx, database.UpsertExperimentRuleParams{Experiment: string(scoped), Value: value}))
revision := int64(i + 2)
_, _, _, err := experiments.WriteRule(ctx, db, actor, scoped, ruleOn, revision-1)
requireConflict(t, err, revision-1, revision)
oldRule, newRule, changed := writeRule(ctx, t, db, actor, ruleOn, revision)
require.True(t, changed, value)
require.Equal(t, revision, oldRule.Revision, value)
require.Equal(t, revision+1, newRule.Revision, value)
require.Equal(t, experiments.ModeOn, newRule.Mode, value)
}
// A value without a readable positive revision is at revision 0:
// only expected revision 0 replaces it, and it restarts at 1.
for _, value := range []string{
`{not json`,
`{"mode":"on"}`,
`{"revision":0,"mode":"on"}`,
`{"revision":-3,"mode":"on"}`,
} {
require.NoError(t, db.UpsertExperimentRule(ctx, database.UpsertExperimentRuleParams{Experiment: string(scoped), Value: value}))
_, _, _, err := experiments.WriteRule(ctx, db, actor, scoped, ruleOff, 5)
requireConflict(t, err, 5, 0)
require.Equal(t, value, storedValue(ctx, t, db))
oldRule, newRule, changed := writeRule(ctx, t, db, actor, ruleOff, 0)
require.True(t, changed, value)
require.Equal(t, experiments.Rule{}, oldRule, value)
require.Equal(t, int64(1), newRule.Revision, value)
require.Equal(t, experiments.ModeOff, newRule.Mode, value)
}
})
// The Evaluator reads what WriteRule stores, through NewDBStore.
t.Run("EvaluatorReadsWrittenRule", func(t *testing.T) {
t.Parallel()
ctx := testutil.Context(t, testutil.WaitMedium)
db, _ := dbtestutil.NewDB(t)
alice := dbgen.User(t, db, database.User{Username: "alice"})
bob := dbgen.User(t, db, database.User{Username: "bob"})
evaluator, err := experiments.New(slogtest.Make(t, nil), experiments.NewDBStore(db), codersdk.Experiments{scoped})
require.NoError(t, err)
writeRule(ctx, t, db, alice.ID, experiments.Rule{Mode: experiments.ModeCondition, Condition: `user.username == "alice"`}, 0)
require.True(t, evaluator.Enabled(ctx, alice.ID, scoped))
require.False(t, evaluator.Enabled(ctx, bob.ID, scoped))
// A kill switch applies to the next decision.
writeRule(ctx, t, db, alice.ID, ruleOff, 1)
require.False(t, evaluator.Enabled(ctx, alice.ID, scoped))
})
}
var errInjected = xerrors.New("injected failure")
// failAfterUpsert fails every rule upsert after it runs on the transaction.
type failAfterUpsert struct {
database.Store
}
func (s failAfterUpsert) InTx(fn func(database.Store) error, opts *database.TxOptions) error {
return s.Store.InTx(func(tx database.Store) error {
return fn(failAfterUpsert{tx})
}, opts)
}
func (s failAfterUpsert) UpsertExperimentRule(ctx context.Context, arg database.UpsertExperimentRuleParams) error {
if err := s.Store.UpsertExperimentRule(ctx, arg); err != nil {
return err
}
return errInjected
}
func TestAuditRecord(t *testing.T) {
t.Parallel()
rule := experiments.Rule{Mode: experiments.ModeCondition, Condition: `"owner" in user.roles`, Revision: 4}
got := experiments.AuditRecord(codersdk.ExperimentExample, rule)
require.Equal(t, database.ExperimentRule{
ID: got.ID,
Experiment: string(codersdk.ExperimentExample),
Mode: "condition",
Condition: `"owner" in user.roles`,
Revision: 4,
}, got)
// The ID identifies the experiment, not the rule: audit history for one
// experiment groups under one ID, and experiments never share one.
require.NotEqual(t, uuid.Nil, got.ID)
require.Equal(t, got.ID, experiments.AuditRecord(codersdk.ExperimentExample, experiments.Rule{}).ID)
require.NotEqual(t, got.ID, experiments.AuditRecord(codersdk.ExperimentWorkspaceUsage, rule).ID)
// Pin the derivation so a namespace change, which would split existing
// audit history, fails here.
require.Equal(t, uuid.NewSHA1(uuid.MustParse("65b7b16d-c22d-4972-adca-014b0a4b77f0"), []byte("example")), got.ID)
}