flagrant 0.0.2

CLI powered feature-flagging
Documentation
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
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
use flagrant::models::{environment, feature, project, variant};
use flagrant_types::{Environment, Feature, FeatureValue, FeatureValueType, Project};
use rand::Rng;
use sqlx::SqlitePool;

const KEY_CHARSET: &[u8] = b"ABCDEFGHIJKLMNOPQRSTUVWXYZ\
                             abcdefghijklmnopqrstuvwxyz\
                             0123456789_";

pub fn random_string(len: u16) -> String {
    let mut rng = rand::thread_rng();
    (0..len)
        .map(|_| {
            let idx = rng.gen_range(0..KEY_CHARSET.len() - 1);
            KEY_CHARSET[idx] as char
        })
        .collect()
}

async fn create_environment(pool: &SqlitePool, project: &Project) -> Environment {
    environment::create(
        pool,
        project,
        format!("ENV_{}", random_string(32)),
        Some("Lorem ipsum".into()),
    )
    .await
    .unwrap()
}

async fn create_context(pool: &SqlitePool) -> (Project, Environment) {
    let project = project::create(pool, "fancy project".into()).await.unwrap();
    let environment = create_environment(pool, &project).await;

    (project, environment)
}

async fn create_feature(
    pool: &SqlitePool,
    environment: &Environment,
    value: Option<&str>,
) -> Feature {
    feature::create(
        pool,
        environment,
        format!("F_{}", random_string(10)),
        value.map(|v| FeatureValue(v.into(), FeatureValueType::Text)),
        true,
    )
    .await
    .unwrap()
}

#[flagrant::test]
async fn create_project(pool: SqlitePool) {
    let name = "Sample project";
    let project = project::create(&pool, name.into()).await.unwrap();

    assert_eq!(project.name, name);
}

#[flagrant::test]
async fn create_feature_with_no_value(pool: SqlitePool) {
    let (_, environment) = create_context(&pool).await;
    let feature = feature::create(&pool, &environment, "sample".into(), None, true)
        .await
        .unwrap();

    assert!(feature.is_enabled);
    assert!(feature.variants.is_empty());
}

#[flagrant::test]
async fn create_feature_with_default_value(pool: SqlitePool) {
    let (_, environment) = create_context(&pool).await;
    let value = FeatureValue("{\"foo\": 2}".into(), FeatureValueType::Json);
    let feature = feature::create(
        &pool,
        &environment,
        "featuriozzo".into(),
        Some(value.clone()),
        true,
    )
    .await
    .unwrap();

    assert_eq!(feature.variants.len(), 1);
    assert_eq!(feature.get_default_value().unwrap(), value);

    let default_variant = feature.get_default_variant().unwrap();

    assert_eq!(default_variant.weight, 100);
    assert!(default_variant.is_control());
}

#[flagrant::test]
async fn create_feature_with_missing_default_variant_in_other_env(pool: SqlitePool) {
    let (project, environment1) = create_context(&pool).await;
    let environment2 = create_environment(&pool, &project).await;

    let feature = create_feature(&pool, &environment1, Some("foo")).await;
    variant::create(&pool, &environment1, &feature, "bar".into(), 40)
        .await
        .unwrap();

    // no default variant in environment2, hence list of variants is empty even though
    // some have been created in environment1.
    let feature = feature::fetch(&pool, &environment2, feature.id)
        .await
        .unwrap();
    assert!(feature.variants.is_empty());

    // after adding default variant, a list consisting of default- and previously created
    // variant should be returned.
    let mut conn = pool.acquire().await.unwrap();
    variant::upsert_default(&mut conn, &environment2, &feature, "bazz".into())
        .await
        .unwrap();

    let feature = feature::fetch(&pool, &environment2, feature.id)
        .await
        .unwrap();
    assert_eq!(feature.variants.len(), 2);
}

#[flagrant::test]
async fn create_feature_with_different_values_in_envs(pool: SqlitePool) {
    let (project, environment1) = create_context(&pool).await;
    let environment2 = create_environment(&pool, &project).await;

    let mut conn = pool.acquire().await.unwrap();
    let feature = create_feature(&pool, &environment1, Some("foo")).await;

    variant::upsert_default(&mut conn, &environment2, &feature, "bazz".into())
        .await
        .unwrap();

    let fv1 = FeatureValue("foo".to_string(), FeatureValueType::Text);
    let fv2 = FeatureValue("bazz".to_string(), FeatureValueType::Text);

    let feature = feature::fetch(&pool, &environment1, feature.id)
        .await
        .unwrap();
    assert_eq!(feature.get_default_value(), Some(fv1));

    let feature = feature::fetch(&pool, &environment2, feature.id)
        .await
        .unwrap();
    assert_eq!(feature.get_default_value(), Some(fv2));
}

#[flagrant::test]
async fn create_feature_with_invalid_name(pool: SqlitePool) {
    let (_, environment) = create_context(&pool).await;
    for name in [" ble", "123", "💕333", "foo-bazz"] {
        let feature = feature::create(
            &pool,
            &environment,
            name.into(),
            Some(FeatureValue("foo".into(), FeatureValueType::Text)),
            false,
        )
        .await;
        assert!(feature.is_err())
    }

    // name too long
    let feature = feature::create(
        &pool,
        &environment,
        format!("F_{}", random_string(1024)),
        Some(FeatureValue("foo".into(), FeatureValueType::Text)),
        false,
    )
    .await;
    assert!(feature.is_err())
}

#[flagrant::test(should_fail = true)]
async fn create_feature_with_non_unique_name(pool: SqlitePool) {
    let (_, environment) = create_context(&pool).await;
    let name = "should_be_unique";

    feature::create(
        &pool,
        &environment,
        name.into(),
        Some(FeatureValue("foo".into(), FeatureValueType::Text)),
        false,
    )
    .await
    .unwrap();

    feature::create(
        &pool,
        &environment,
        name.into(),
        Some(FeatureValue("foo".into(), FeatureValueType::Text)),
        false,
    )
    .await
    .unwrap();
}

#[flagrant::test]
async fn delete_feature_with_default_value(pool: SqlitePool) {
    let (_, environment) = create_context(&pool).await;
    let feature = create_feature(&pool, &environment, Some("foo")).await;

    assert!(feature::delete(&pool, &environment, &feature).await.is_ok());
    assert!(feature::fetch(&pool, &environment, feature.id)
        .await
        .is_err());
}

#[flagrant::test]
async fn delete_feature_with_variants(pool: SqlitePool) {
    let (_, environment) = create_context(&pool).await;
    let feature = create_feature(&pool, &environment, Some("foo")).await;

    variant::create(&pool, &environment, &feature, "bar-1".into(), 10)
        .await
        .unwrap();
    variant::create(&pool, &environment, &feature, "bar-2".into(), 10)
        .await
        .unwrap();

    assert!(feature::delete(&pool, &environment, &feature).await.is_ok());
    assert!(feature::fetch(&pool, &environment, feature.id)
        .await
        .is_err());
}

#[flagrant::test]
async fn create_valid_variant(pool: SqlitePool) {
    let (_, environment) = create_context(&pool).await;
    let feature = create_feature(&pool, &environment, Some("foo")).await;
    let variant = variant::create(&pool, &environment, &feature, "bar".into(), 10).await;

    assert!(variant.is_ok());
}

#[flagrant::test]
async fn create_variant_for_feature_with_no_default_variant(pool: SqlitePool) {
    let (_, environment) = create_context(&pool).await;
    let feature = create_feature(&pool, &environment, None).await;
    let variant = variant::create(&pool, &environment, &feature, "bar".into(), 10).await;

    assert!(variant.is_err());
}

#[flagrant::test]
async fn create_variants_with_valid_weights(pool: SqlitePool) {
    let (_, environment) = create_context(&pool).await;
    let feature = create_feature(&pool, &environment, Some("bar")).await;

    variant::create(&pool, &environment, &feature, "bar-1".into(), 10)
        .await
        .unwrap();
    variant::create(&pool, &environment, &feature, "bar-2".into(), 30)
        .await
        .unwrap();
    variant::create(&pool, &environment, &feature, "bar-3".into(), 40)
        .await
        .unwrap();

    let feature = feature::fetch(&pool, &environment, feature.id)
        .await
        .unwrap();
    let default_variant = feature.get_default_variant().unwrap();

    assert_eq!(default_variant.weight, 20);
}

#[flagrant::test]
async fn create_variants_with_exceeding_weight(pool: SqlitePool) {
    let (_, environment) = create_context(&pool).await;
    let feature = create_feature(&pool, &environment, Some("bar")).await;

    variant::create(&pool, &environment, &feature, "bar-1".into(), 10)
        .await
        .unwrap();
    variant::create(&pool, &environment, &feature, "bar-1".into(), 30)
        .await
        .unwrap();

    let exceeding_variant = variant::create(&pool, &environment, &feature, "bar-3".into(), 90);

    assert!(exceeding_variant.await.is_err());
}

#[flagrant::test]
async fn create_variants_with_different_weights_in_envs(pool: SqlitePool) {
    let (project, environment1) = create_context(&pool).await;
    let environment2 = create_environment(&pool, &project).await;

    let feature = create_feature(&pool, &environment1, Some("foo")).await;
    let variant = variant::create(&pool, &environment1, &feature, "bar".into(), 40)
        .await
        .unwrap();

    let mut conn = pool.acquire().await.unwrap();
    variant::upsert_default(&mut conn, &environment2, &feature, "bazz".into())
        .await
        .unwrap();
    variant::update(&pool, &environment2, &variant, "new-bar".into(), 99)
        .await
        .unwrap();

    let variant_env1 = variant::fetch(&pool, &environment1, variant.id)
        .await
        .unwrap();
    let variant_env2 = variant::fetch(&pool, &environment2, variant.id)
        .await
        .unwrap();

    // variant values are common across all environments
    assert_eq!(variant_env1.value, "new-bar");
    assert_eq!(variant_env2.value, "new-bar");

    // ...but weights are not
    assert_eq!(variant_env1.weight, 40);
    assert_eq!(variant_env2.weight, 99);
}

#[flagrant::test]
async fn recalculate_default_weight_for_variant_update(pool: SqlitePool) {
    let (_, environment) = create_context(&pool).await;
    let feature = create_feature(&pool, &environment, Some("bar")).await;

    variant::create(&pool, &environment, &feature, "bar-1".into(), 10)
        .await
        .unwrap();
    variant::create(&pool, &environment, &feature, "bar-2".into(), 30)
        .await
        .unwrap();

    let variant = variant::create(&pool, &environment, &feature, "bar-3".into(), 40)
        .await
        .unwrap();
    variant::update(&pool, &environment, &variant, "new-bar-3".into(), 50)
        .await
        .unwrap();

    let feature = feature::fetch(&pool, &environment, feature.id)
        .await
        .unwrap();
    let default_variant = feature.get_default_variant().unwrap();

    assert_eq!(default_variant.weight, 10);
}

#[flagrant::test]
async fn recalculate_default_weight_for_variant_delete(mut pool: SqlitePool) {
    let (_, environment) = create_context(&pool).await;
    let feature = create_feature(&pool, &environment, Some("bar")).await;

    variant::create(&pool, &environment, &feature, "bar-1".into(), 10)
        .await
        .unwrap();
    variant::create(&pool, &environment, &feature, "bar-2".into(), 30)
        .await
        .unwrap();

    let variant = variant::create(&pool, &environment, &feature, "bar-3".into(), 40)
        .await
        .unwrap();
    let mut conn = pool.acquire().await.unwrap();

    variant::delete(&mut conn, &environment, &variant)
        .await
        .unwrap();

    let feature = feature::fetch(&pool, &environment, feature.id)
        .await
        .unwrap();
    let default_variant = feature.get_default_variant().unwrap();

    assert_eq!(default_variant.weight, 60);
}

#[flagrant::test]
async fn ignore_default_weight_recalculation_for_exceeding_weight_update(pool: SqlitePool) {
    let (_, environment) = create_context(&pool).await;
    let feature = create_feature(&pool, &environment, Some("bar")).await;

    variant::create(&pool, &environment, &feature, "bar-1".into(), 10)
        .await
        .unwrap();
    variant::create(&pool, &environment, &feature, "bar-2".into(), 30)
        .await
        .unwrap();

    // update with exceeding weight should fail
    let variant = variant::create(&pool, &environment, &feature, "bar-3".into(), 40)
        .await
        .unwrap();

    assert!(
        variant::update(&pool, &environment, &variant, "new-bar-3".into(), 80)
            .await
            .is_err()
    );

    // default weight should retain old value
    let feature = feature::fetch(&pool, &environment, feature.id)
        .await
        .unwrap();
    let default_variant = feature.get_default_variant().unwrap();

    assert_eq!(default_variant.weight, 20);
}

#[flagrant::test]
async fn forbid_removing_default_variant_when_other_variants_exist(mut pool: SqlitePool) {
    let (_, environment) = create_context(&pool).await;
    let feature = create_feature(&pool, &environment, Some("bar")).await;

    variant::create(&pool, &environment, &feature, "bar-1".into(), 10)
        .await
        .unwrap();
    variant::create(&pool, &environment, &feature, "bar-2".into(), 30)
        .await
        .unwrap();

    let variant = feature.get_default_variant().unwrap();
    let mut conn = pool.acquire().await.unwrap();

    assert!(variant::delete(&mut conn, &environment, variant)
        .await
        .is_err());
    assert!(feature.get_default_variant().is_some())
}