kaji 0.0.1

Steer your Keycloak configuration to a stable, declared state.
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
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
pub mod secrets;
pub mod ui;
pub mod yaml;
use anyhow::Context;
use serde::Serialize;
use std::path::Path;
use tokio::fs;

#[cfg(unix)]
use std::os::unix::fs::PermissionsExt;

pub async fn write_secure(path: &Path, content: &str) -> anyhow::Result<()> {
    #[cfg(unix)]
    {
        use tokio::io::AsyncWriteExt;

        // If file exists, ensure permissions are 0o600
        if fs::try_exists(path).await.unwrap_or(false) {
            fs::set_permissions(path, std::fs::Permissions::from_mode(0o600))
                .await
                .with_context(|| format!("Failed to set permissions for {:?}", path))?;
        }

        let mut options = fs::OpenOptions::new();
        options.write(true).create(true).truncate(true).mode(0o600);

        let mut file = options
            .open(path)
            .await
            .with_context(|| format!("Failed to open {:?}", path))?;
        file.write_all(content.as_bytes())
            .await
            .with_context(|| format!("Failed to write to {:?}", path))?;
        file.flush()
            .await
            .with_context(|| format!("Failed to flush {:?}", path))?;
    }
    #[cfg(not(unix))]
    {
        fs::write(path, content)
            .await
            .with_context(|| format!("Failed to write {:?}", path))?;
    }
    Ok(())
}

pub fn recursive_sort(value: &mut serde_json::Value) {
    match value {
        serde_json::Value::Object(map) => {
            for (_, v) in map.iter_mut() {
                recursive_sort(v);
            }
        }
        serde_json::Value::Array(arr) => {
            for v in arr.iter_mut() {
                recursive_sort(v);
            }
            if arr.is_empty() {
                return;
            }

            // Sort arrays of simple values (Strings, Numbers, Bools)
            if arr
                .iter()
                .all(|v| v.is_string() || v.is_number() || v.is_boolean())
            {
                arr.sort_by_cached_key(|a| a.to_string());
            } else if arr.iter().all(|v| v.is_object()) {
                // Try to find a common sorting key: id, clientId, username, alias, or name
                let keys = ["id", "clientId", "username", "alias", "name"];
                for key in keys {
                    if arr.iter().all(|v| v.get(key).is_some()) {
                        arr.sort_by_cached_key(|a| {
                            a.get(key).map_or(String::new(), |v| v.to_string())
                        });
                        break;
                    }
                }
            }
        }
        _ => {}
    }
}

pub fn to_sorted_yaml_with_secrets<T: Serialize>(
    value: &T,
    prefix: &str,
    secrets: &mut std::collections::BTreeMap<String, String>,
) -> anyhow::Result<String> {
    let mut json_value =
        serde_json::to_value(value).context("Failed to serialize to JSON value")?;
    crate::utils::secrets::extract_secrets(&mut json_value, prefix, secrets);
    recursive_sort(&mut json_value);
    serde_yaml::to_string(&json_value).context("Failed to serialize to sorted YAML")
}

pub fn to_sorted_yaml<T: Serialize>(value: &T) -> anyhow::Result<String> {
    let mut json_value =
        serde_json::to_value(value).context("Failed to serialize to JSON value")?;
    recursive_sort(&mut json_value);
    serde_yaml::to_string(&json_value).context("Failed to serialize to sorted YAML")
}

pub async fn join_all_tasks<T: 'static>(
    mut set: tokio::task::JoinSet<anyhow::Result<T>>,
    context_msg: Option<&str>,
) -> anyhow::Result<Vec<T>> {
    let mut results = Vec::new();
    while let Some(res) = set.join_next().await {
        if let Some(msg) = context_msg {
            results.push(res.context(msg.to_string())??);
        } else {
            results.push(res??);
        }
    }
    Ok(results)
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_sorting_with_value() {
        let val = serde_json::json!({
            "z": "val_z",
            "a": "val_a",
            "m": ["item3", "item1", "item2"]
        });

        let yaml = to_sorted_yaml(&val).expect("Failed to serialize yaml");
        println!("Generated YAML:\n{}", yaml);

        let lines: Vec<&str> = yaml.lines().collect();
        assert_eq!(lines[0], "a: val_a");
        assert_eq!(lines[1], "m:");
        assert_eq!(lines[2], "- item1");
        assert_eq!(lines[3], "- item2");
        assert_eq!(lines[4], "- item3");
        assert_eq!(lines[5], "z: val_z");
    }

    #[test]
    fn test_sorting_arrays_of_objects() {
        let val = serde_json::json!({
            "list": [
                { "name": "c", "v": 3 },
                { "name": "a", "v": 1 },
                { "name": "b", "v": 2 }
            ],
            "aliases": [
                { "alias": "z" },
                { "alias": "x" }
            ],
            "ids": [
                { "id": "2" },
                { "id": "1" }
            ]
        });

        let yaml = to_sorted_yaml(&val).expect("Failed to serialize yaml");
        println!("Generated YAML:\n{}", yaml);

        let lines: Vec<&str> = yaml.lines().collect();
        // aliases sorted by alias
        assert_eq!(lines[0], "aliases:");
        assert_eq!(lines[1], "- alias: x");
        assert_eq!(lines[2], "- alias: z");
        // ids sorted by id
        assert_eq!(lines[3], "ids:");
        assert_eq!(lines[4], "- id: '1'");
        assert_eq!(lines[5], "- id: '2'");
        // list sorted by name
        assert_eq!(lines[6], "list:");
        assert_eq!(lines[7], "- name: a");
        assert_eq!(lines[8], "  v: 1");
        assert_eq!(lines[9], "- name: b");
        assert_eq!(lines[10], "  v: 2");
        assert_eq!(lines[11], "- name: c");
        assert_eq!(lines[12], "  v: 3");
    }

    #[test]
    fn test_recursive_sort_empty_array() {
        let mut val = serde_json::json!([]);
        recursive_sort(&mut val);
        assert_eq!(val, serde_json::json!([]));

        let mut val_obj = serde_json::json!({ "empty_arr": [] });
        recursive_sort(&mut val_obj);
        assert_eq!(val_obj, serde_json::json!({ "empty_arr": [] }));
    }

    #[test]
    fn test_recursive_sort_simple_arrays() {
        let mut val = serde_json::json!([3, 1, 2]);
        recursive_sort(&mut val);
        assert_eq!(val, serde_json::json!([1, 2, 3]));

        let mut val_bool = serde_json::json!([true, false, true]);
        recursive_sort(&mut val_bool);
        assert_eq!(val_bool, serde_json::json!([false, true, true]));

        let mut val_mixed = serde_json::json!(["b", 1, true, false, "a"]);
        recursive_sort(&mut val_mixed);
        // string representation: "b", "1", "true", "false", "a"
        // sorted by exact output of .to_string() for json Values:
        // "b" -> "\"b\"", 1 -> "1", true -> "true", false -> "false", "a" -> "\"a\""
        // sorted: "\"a\"", "\"b\"", "1", "false", "true"
        // meaning String("a"), String("b"), Number(1), Bool(false), Bool(true)
        // Note: Number strings ("1") come after String strings starting with double quotes ("\"a\"") in lexicographical order.
        assert_eq!(val_mixed, serde_json::json!(["a", "b", 1, false, true]));
    }

    #[test]
    fn test_recursive_sort_mixed_and_no_keys() {
        let mut val_mixed = serde_json::json!([{"a": 1}, 1, "string"]);
        recursive_sort(&mut val_mixed);
        assert_eq!(val_mixed, serde_json::json!([{"a": 1}, 1, "string"]));

        let mut val_no_keys = serde_json::json!([
            {"other": 2},
            {"other": 1}
        ]);
        recursive_sort(&mut val_no_keys);
        assert_eq!(
            val_no_keys,
            serde_json::json!([
                {"other": 2},
                {"other": 1}
            ])
        );
    }

    #[test]
    fn test_recursive_sort_nested_arrays() {
        let mut val = serde_json::json!({
            "nested": [[2, 1], [4, 3]]
        });
        recursive_sort(&mut val);
        // Elements in array might not be sortable (they are arrays), but inner should be
        assert_eq!(
            val,
            serde_json::json!({
                "nested": [[1, 2], [3, 4]]
            })
        );
    }

    #[test]
    fn test_recursive_sort_primitive() {
        let mut val_str = serde_json::json!("test");
        recursive_sort(&mut val_str);
        assert_eq!(val_str, serde_json::json!("test"));

        let mut val_num = serde_json::json!(42);
        recursive_sort(&mut val_num);
        assert_eq!(val_num, serde_json::json!(42));

        let mut val_null = serde_json::Value::Null;
        recursive_sort(&mut val_null);
        assert_eq!(val_null, serde_json::Value::Null);
    }

    #[test]
    fn test_recursive_sort_mixed_identify_keys() {
        // Scenario 1: Both "id" and "name" are present in all elements. Should sort by "id".
        let mut val1 = serde_json::json!([
            { "id": "2", "name": "a" },
            { "id": "1", "name": "b" }
        ]);
        recursive_sort(&mut val1);
        assert_eq!(
            val1,
            serde_json::json!([
                { "id": "1", "name": "b" },
                { "id": "2", "name": "a" }
            ])
        );

        // Scenario 2: "id" is only present in some elements, but "name" is present in all. Should sort by "name".
        let mut val2 = serde_json::json!([
            { "id": "1", "name": "b" },
            { "name": "a" }
        ]);
        recursive_sort(&mut val2);
        assert_eq!(
            val2,
            serde_json::json!([
                { "name": "a" },
                { "id": "1", "name": "b" }
            ])
        );

        // Scenario 3: "alias" is present in all, but "id" and "name" are missing or partially present. Should sort by "alias".
        let mut val3 = serde_json::json!([
            { "alias": "z", "name": "a" },
            { "alias": "x", "id": "1" }
        ]);
        recursive_sort(&mut val3);
        assert_eq!(
            val3,
            serde_json::json!([
                { "alias": "x", "id": "1" },
                { "alias": "z", "name": "a" }
            ])
        );
    }

    #[test]
    fn test_to_sorted_yaml_with_secrets() {
        let mut secrets = std::collections::BTreeMap::new();
        let val = serde_json::json!({
            "clientId": "myclient",
            "secret": "very-secret",
            "nested": {
                "password": "pass"
            }
        });

        let yaml = to_sorted_yaml_with_secrets(&val, "CLIENT", &mut secrets).unwrap();
        // current_prefix should be "CLIENT_myclient"
        // secret env var should be "KEYCLOAK_CLIENT_MYCLIENT_SECRET"
        // nested password env var should be "KEYCLOAK_CLIENT_MYCLIENT_NESTED_PASSWORD"
        assert!(yaml.contains("secret: ${KEYCLOAK_CLIENT_MYCLIENT_SECRET}"));
        assert!(yaml.contains("password: ${KEYCLOAK_CLIENT_MYCLIENT_NESTED_PASSWORD}"));
        assert_eq!(
            secrets.get("KEYCLOAK_CLIENT_MYCLIENT_SECRET"),
            Some(&"very-secret".to_string())
        );
        assert_eq!(
            secrets.get("KEYCLOAK_CLIENT_MYCLIENT_NESTED_PASSWORD"),
            Some(&"pass".to_string())
        );
    }

    #[test]
    fn test_to_sorted_yaml_with_secrets_struct() {
        #[derive(serde::Serialize)]
        struct TestConfig {
            #[serde(rename = "clientId")]
            client_id: String,
            name: String,
            password: Option<String>,
            value: i32,
        }

        let mut secrets = std::collections::BTreeMap::new();
        let val = TestConfig {
            client_id: "test-client".to_string(),
            name: "test-name".to_string(),
            password: Some("super-secret".to_string()),
            value: 42,
        };

        let yaml = to_sorted_yaml_with_secrets(&val, "APP", &mut secrets).unwrap();

        assert!(yaml.contains("password: ${KEYCLOAK_APP_TEST_CLIENT_PASSWORD}"));
        assert!(yaml.contains("clientId: test-client"));
        assert_eq!(
            secrets.get("KEYCLOAK_APP_TEST_CLIENT_PASSWORD"),
            Some(&"super-secret".to_string())
        );
    }

    #[test]
    fn test_to_sorted_yaml_with_secrets_error() {
        struct FailingStruct;
        impl serde::Serialize for FailingStruct {
            fn serialize<S: serde::Serializer>(&self, _serializer: S) -> Result<S::Ok, S::Error> {
                Err(serde::ser::Error::custom("Simulated serialization error"))
            }
        }
        let mut secrets = std::collections::BTreeMap::new();
        let result = to_sorted_yaml_with_secrets(&FailingStruct, "FAIL", &mut secrets);
        assert!(result.is_err());
    }

    #[test]
    fn test_to_sorted_yaml_simple() {
        let val = serde_json::json!({ "b": 2, "a": 1 });
        let yaml = to_sorted_yaml(&val).unwrap();
        assert_eq!(yaml.trim(), "a: 1\nb: 2");
    }

    #[tokio::test]
    async fn test_write_secure_permissions() {
        let temp_dir = tempfile::tempdir().unwrap();
        let file_path = temp_dir.path().join("secure.txt");
        let content = "sensitive data";

        // Test creating a new file
        write_secure(&file_path, content).await.unwrap();
        let read_content = std::fs::read_to_string(&file_path).unwrap();
        assert_eq!(read_content, content);

        #[cfg(unix)]
        {
            use std::os::unix::fs::PermissionsExt;
            let metadata = std::fs::metadata(&file_path).unwrap();
            let mode = metadata.permissions().mode();
            assert_eq!(mode & 0o777, 0o600);
        }

        // Test updating an existing file with insecure permissions
        let existing_path = temp_dir.path().join("existing.txt");
        std::fs::write(&existing_path, "old content").unwrap();

        #[cfg(unix)]
        {
            use std::os::unix::fs::PermissionsExt;
            std::fs::set_permissions(&existing_path, std::fs::Permissions::from_mode(0o644))
                .unwrap();
            let metadata = std::fs::metadata(&existing_path).unwrap();
            assert_eq!(metadata.permissions().mode() & 0o777, 0o644);
        }

        write_secure(&existing_path, "new content").await.unwrap();
        let read_content = std::fs::read_to_string(&existing_path).unwrap();
        assert_eq!(read_content, "new content");

        #[cfg(unix)]
        {
            use std::os::unix::fs::PermissionsExt;
            let metadata = std::fs::metadata(&existing_path).unwrap();
            let mode = metadata.permissions().mode();
            assert_eq!(mode & 0o777, 0o600);
        }
    }

    #[test]
    fn test_recursive_sort_keycloak_identifiers() {
        // Test clientId sorting
        let mut val_client = serde_json::json!([
            { "clientId": "z", "name": "app1" },
            { "clientId": "a", "name": "app2" }
        ]);
        recursive_sort(&mut val_client);
        assert_eq!(
            val_client,
            serde_json::json!([
                { "clientId": "a", "name": "app2" },
                { "clientId": "z", "name": "app1" }
            ])
        );

        // Test username sorting (with id omitted to ensure username is the sort key)
        let mut val_user = serde_json::json!([
            { "username": "user2" },
            { "username": "user1" }
        ]);
        recursive_sort(&mut val_user);
        assert_eq!(
            val_user,
            serde_json::json!([
                { "username": "user1" },
                { "username": "user2" }
            ])
        );

        // Test nested recursive sorting
        let mut val_nested = serde_json::json!({
            "users": [
                { "username": "user2" },
                { "username": "user1" }
            ],
            "config": {
                "clients": [
                    { "clientId": "z" },
                    { "clientId": "a" }
                ]
            }
        });
        recursive_sort(&mut val_nested);
        assert_eq!(
            val_nested,
            serde_json::json!({
                "users": [
                    { "username": "user1" },
                    { "username": "user2" }
                ],
                "config": {
                    "clients": [
                        { "clientId": "a" },
                        { "clientId": "z" }
                    ]
                }
            })
        );
    }

    #[test]
    fn test_recursive_sort_edge_cases() {
        // 1. Array of empty objects
        let mut val_empty_objs = serde_json::json!([{}, {}]);
        recursive_sort(&mut val_empty_objs);
        assert_eq!(val_empty_objs, serde_json::json!([{}, {}]));

        // 2. Array of arrays of arrays
        let mut val_deep_arrays = serde_json::json!([[[2, 1]], [[4, 3]]]);
        recursive_sort(&mut val_deep_arrays);
        assert_eq!(val_deep_arrays, serde_json::json!([[[1, 2]], [[3, 4]]]));

        // 3. Array with Null mixed with primitives
        let mut val_mixed_null = serde_json::json!([1, null, "a"]);
        recursive_sort(&mut val_mixed_null);
        // Does not sort because not all are string/number/boolean
        assert_eq!(val_mixed_null, serde_json::json!([1, null, "a"]));

        // 4. Integer sort keys
        let mut val_int_keys = serde_json::json!([
            { "id": 2, "val": "b" },
            { "id": 1, "val": "a" },
            { "id": 10, "val": "c" }
        ]);
        recursive_sort(&mut val_int_keys);
        // Sorted by exact string representation of the numbers: "1", "10", "2"
        assert_eq!(
            val_int_keys,
            serde_json::json!([
                { "id": 1, "val": "a" },
                { "id": 10, "val": "c" },
                { "id": 2, "val": "b" }
            ])
        );

        // 5. Null sort keys
        let mut val_null_keys = serde_json::json!([
            { "id": null, "val": "b" },
            { "id": 1, "val": "a" }
        ]);
        recursive_sort(&mut val_null_keys);
        // string representations: "null" vs "1"
        assert_eq!(
            val_null_keys,
            serde_json::json!([
                { "id": 1, "val": "a" },
                { "id": null, "val": "b" }
            ])
        );
    }
}