newton-regorus 0.2.0

A fast, lightweight Rego (OPA policy language) interpreter with Newton extensions
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
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT License.

#![allow(
    clippy::panic,
    clippy::unwrap_used,
    clippy::unreachable,
    clippy::indexing_slicing,
    clippy::assertions_on_result_states,
    clippy::pattern_type_mismatch
)] // registry effect tests unwrap/panic for invariant checks

use super::super::registry::*;
use crate::{
    registry::{instances::EFFECT_SCHEMA_REGISTRY, schemas::effect},
    schema::Schema,
    *,
};
use serde_json::json;

type String = Rc<str>;
type SchemaRegistryError = RegistryError;

// Helper function to create a schema for Azure Policy effects
fn create_effect_schema() -> Rc<Schema> {
    let schema_json = json!({
        "enum": ["audit", "deny", "disabled", "modify"],
        "description": "Azure Policy effect types"
    });

    let schema = Schema::from_serde_json_value(schema_json).unwrap();
    Rc::new(schema)
}

// Helper function to create a deny effect schema
fn create_deny_effect_schema() -> Rc<Schema> {
    let schema_json = json!({
        "type": "object",
        "properties": {
            "effect": {
                "const": "deny"
            },
            "description": {
                "type": "string",
                "description": "Explanation of what is being denied"
            }
        },
        "required": ["effect"],
        "description": "Schema for deny effect in Azure Policy"
    });

    let schema = Schema::from_serde_json_value(schema_json).unwrap();
    Rc::new(schema)
}

// Helper function to create an audit effect schema
fn create_audit_effect_schema() -> Rc<Schema> {
    let schema_json = json!({
        "type": "object",
        "properties": {
            "effect": {
                "const": "audit"
            },
            "description": {
                "type": "string",
                "description": "Explanation of what is being audited"
            },
            "auditDetails": {
                "type": "object",
                "properties": {
                    "category": {
                        "enum": ["security", "compliance", "cost", "operational"]
                    },
                    "severity": {
                        "enum": ["low", "medium", "high", "critical"]
                    }
                }
            }
        },
        "required": ["effect"],
        "description": "Schema for audit effect in Azure Policy"
    });

    let schema = Schema::from_serde_json_value(schema_json).unwrap();
    Rc::new(schema)
}

// Helper function to create a modify effect schema
fn create_modify_effect_schema() -> Rc<Schema> {
    let schema_json = json!({
        "type": "object",
        "properties": {
            "effect": {
                "const": "modify"
            },
            "description": {
                "type": "string",
                "description": "Explanation of what is being modified"
            },
            "modifyDetails": {
                "type": "object",
                "properties": {
                    "roleDefinitionIds": {
                        "type": "array",
                        "items": {
                            "type": "string"
                        },
                        "description": "List of role definition IDs required for modification"
                    },
                    "operations": {
                        "type": "array",
                        "items": {
                            "type": "object",
                            "properties": {
                                "operation": {
                                    "enum": ["add", "replace", "remove"]
                                },
                                "field": {
                                    "type": "string"
                                },
                                "value": {
                                    "type": "any",
                                    "description": "Value to add or replace"
                                }
                            },
                            "required": ["operation", "field"]
                        }
                    }
                },
                "required": ["roleDefinitionIds", "operations"]
            }
        },
        "required": ["effect", "modifyDetails"],
        "description": "Schema for modify effect in Azure Policy"
    });

    let schema = Schema::from_serde_json_value(schema_json).unwrap();
    Rc::new(schema)
}

#[test]
fn test_basic_effect_enum_schema() {
    let effect_schema = create_effect_schema();

    // Test registration of basic effect enum schema
    let result =
        EFFECT_SCHEMA_REGISTRY.register("azure.policy.effect.basic", effect_schema.clone());
    assert!(result.is_ok());
    assert!(EFFECT_SCHEMA_REGISTRY.contains("azure.policy.effect.basic"));

    // Verify schema can be retrieved
    let retrieved = EFFECT_SCHEMA_REGISTRY.get("azure.policy.effect.basic");
    assert!(retrieved.is_some());
    assert!(Rc::ptr_eq(&effect_schema, &retrieved.unwrap()));
}

#[test]
fn test_deny_effect_schema() {
    let deny_schema = create_deny_effect_schema();

    // Test registration of deny effect schema
    let result = EFFECT_SCHEMA_REGISTRY.register("azure.policy.deny.test", deny_schema.clone());
    assert!(result.is_ok());
    assert!(EFFECT_SCHEMA_REGISTRY.contains("azure.policy.deny.test"));

    // Verify basic functionality - we can't inspect internal structure due to private as_type()
    assert!(EFFECT_SCHEMA_REGISTRY.contains("azure.policy.deny.test"));

    // The schema should be retrievable
    let retrieved = EFFECT_SCHEMA_REGISTRY.get("azure.policy.deny.test");
    assert!(retrieved.is_some());
    assert!(Rc::ptr_eq(&deny_schema, &retrieved.unwrap()));
}

#[test]
fn test_audit_effect_schema() {
    let audit_schema = create_audit_effect_schema();

    // Test registration of audit effect schema
    let result = EFFECT_SCHEMA_REGISTRY.register("azure.policy.audit.test", audit_schema.clone());
    assert!(result.is_ok());
    assert!(EFFECT_SCHEMA_REGISTRY.contains("azure.policy.audit.test"));

    // Verify basic functionality - we can't inspect internal structure due to private as_type()
    assert!(EFFECT_SCHEMA_REGISTRY.contains("azure.policy.audit.test"));

    // The schema should be retrievable
    let retrieved = EFFECT_SCHEMA_REGISTRY.get("azure.policy.audit.test");
    assert!(retrieved.is_some());
    assert!(Rc::ptr_eq(&audit_schema, &retrieved.unwrap()));
}

#[test]
fn test_modify_effect_schema() {
    let modify_schema = create_modify_effect_schema();

    // Test registration of modify effect schema
    let result = EFFECT_SCHEMA_REGISTRY.register("azure.policy.modify.test", modify_schema.clone());
    assert!(result.is_ok());
    assert!(EFFECT_SCHEMA_REGISTRY.contains("azure.policy.modify.test"));

    // Verify basic functionality - we can't inspect internal structure due to private as_type()
    assert!(EFFECT_SCHEMA_REGISTRY.contains("azure.policy.modify.test"));

    // The schema should be retrievable
    let retrieved = EFFECT_SCHEMA_REGISTRY.get("azure.policy.modify.test");
    assert!(retrieved.is_some());
    assert!(Rc::ptr_eq(&modify_schema, &retrieved.unwrap()));
}

#[test]
fn test_multiple_effect_schemas() {
    // Register all effect schemas with unique names for this specific test
    let deny_schema = create_deny_effect_schema();
    let audit_schema = create_audit_effect_schema();
    let modify_schema = create_modify_effect_schema();

    // Use highly unique names to avoid conflicts with other tests
    let deny_name = "azure.policy.deny.multiple.test";
    let audit_name = "azure.policy.audit.multiple.test";
    let modify_name = "azure.policy.modify.multiple.test";

    assert!(EFFECT_SCHEMA_REGISTRY
        .register(deny_name, deny_schema)
        .is_ok());
    assert!(EFFECT_SCHEMA_REGISTRY
        .register(audit_name, audit_schema)
        .is_ok());
    assert!(EFFECT_SCHEMA_REGISTRY
        .register(modify_name, modify_schema)
        .is_ok());

    // Verify all are registered
    assert!(EFFECT_SCHEMA_REGISTRY.contains(deny_name));
    assert!(EFFECT_SCHEMA_REGISTRY.contains(audit_name));
    assert!(EFFECT_SCHEMA_REGISTRY.contains(modify_name));

    // Verify they can all be retrieved
    assert!(EFFECT_SCHEMA_REGISTRY.get(deny_name).is_some());
    assert!(EFFECT_SCHEMA_REGISTRY.get(audit_name).is_some());
    assert!(EFFECT_SCHEMA_REGISTRY.get(modify_name).is_some());
}

#[test]
fn test_global_effect_registry() {
    // Register Azure Policy effects with unique names
    let deny_schema = create_deny_effect_schema();
    let audit_schema = create_audit_effect_schema();
    let modify_schema = create_modify_effect_schema();

    // Use highly unique names to avoid conflicts
    let deny_name = "azure.policy.deny.global.test";
    let audit_name = "azure.policy.audit.global.test";
    let modify_name = "azure.policy.modify.global.test";

    assert!(effect::register(deny_name, deny_schema).is_ok());
    assert!(effect::register(audit_name, audit_schema).is_ok());
    assert!(effect::register(modify_name, modify_schema).is_ok());

    // Verify all are registered in global registry
    assert!(effect::contains(deny_name));
    assert!(effect::contains(audit_name));
    assert!(effect::contains(modify_name));

    // Test retrieval from global registry
    let retrieved_deny = effect::get(deny_name);
    let retrieved_audit = effect::get(audit_name);
    let retrieved_modify = effect::get(modify_name);

    assert!(retrieved_deny.is_some());
    assert!(retrieved_audit.is_some());
    assert!(retrieved_modify.is_some());
}

#[test]
fn test_effect_schema_validation_patterns() {
    // Test schema with various Azure Policy patterns
    let complex_effect_schema = json!({
        "type": "object",
        "properties": {
            "effect": {
                "enum": ["audit", "deny", "disabled", "modify", "auditIfNotExists", "deployIfNotExists"]
            },
            "parameters": {
                "type": "object",
                "description": "Parameters for the effect"
            },
            "existenceCondition": {
                "type": "object",
                "description": "Condition for existence-based effects"
            },
            "deployment": {
                "type": "object",
                "properties": {
                    "properties": {
                        "type": "object",
                        "properties": {
                            "mode": {
                                "enum": ["incremental", "complete"]
                            },
                            "template": {
                                "type": "object"
                            },
                            "parameters": {
                                "type": "object"
                            }
                        }
                    }
                }
            }
        },
        "required": ["effect"],
        "description": "Comprehensive Azure Policy effect schema"
    });

    let schema = Schema::from_serde_json_value(complex_effect_schema).unwrap();
    let schema_rc = Rc::new(schema);

    let result = EFFECT_SCHEMA_REGISTRY.register("azure.policy.complex.patterns", schema_rc);
    assert!(result.is_ok());
    assert!(EFFECT_SCHEMA_REGISTRY.contains("azure.policy.complex.patterns"));
}

#[test]
fn test_effect_schema_with_invalid_names() {
    let effect_schema = create_effect_schema();

    // Test invalid names
    assert!(EFFECT_SCHEMA_REGISTRY
        .register("", effect_schema.clone())
        .is_err());
    assert!(EFFECT_SCHEMA_REGISTRY
        .register("   ", effect_schema.clone())
        .is_err());
    assert!(EFFECT_SCHEMA_REGISTRY
        .register("\t", effect_schema.clone())
        .is_err());
    assert!(EFFECT_SCHEMA_REGISTRY
        .register("\n", effect_schema)
        .is_err());
}

#[test]
fn test_effect_schema_duplicate_registration() {
    let deny_schema = create_deny_effect_schema();

    // First registration should succeed
    assert!(EFFECT_SCHEMA_REGISTRY
        .register("azure.policy.deny.duplicate", deny_schema.clone())
        .is_ok());

    // Duplicate registration should fail
    let duplicate_result =
        EFFECT_SCHEMA_REGISTRY.register("azure.policy.deny.duplicate", deny_schema);
    assert!(duplicate_result.is_err());

    // Verify error type
    match duplicate_result.unwrap_err() {
        SchemaRegistryError::AlreadyExists { name, .. } => {
            assert_eq!(name.as_ref(), "azure.policy.deny.duplicate");
        }
        _ => panic!("Expected AlreadyExists error"),
    }
}

#[test]
fn test_azure_policy_effect_removal() {
    // Register multiple Azure Policy effects with unique names
    let effects = vec![
        ("azure.policy.deny.removal", create_deny_effect_schema()),
        ("azure.policy.audit.removal", create_audit_effect_schema()),
        ("azure.policy.modify.removal", create_modify_effect_schema()),
    ];

    for (name, schema) in &effects {
        assert!(EFFECT_SCHEMA_REGISTRY
            .register(*name, schema.clone())
            .is_ok());
    }

    // Remove one effect
    let removed = EFFECT_SCHEMA_REGISTRY.remove("azure.policy.audit.removal");
    assert!(removed.is_some());
    assert!(!EFFECT_SCHEMA_REGISTRY.contains("azure.policy.audit.removal"));

    // Verify the removed schema is correct
    let removed_schema = removed.unwrap();
    assert!(Rc::ptr_eq(&effects[1].1, &removed_schema));

    // Other effects should still be present
    assert!(EFFECT_SCHEMA_REGISTRY.contains("azure.policy.deny.removal"));
    assert!(EFFECT_SCHEMA_REGISTRY.contains("azure.policy.modify.removal"));
}

#[test]
#[cfg(feature = "std")]
fn test_concurrent_effect_schema_access() {
    use std::{sync::Barrier, thread};

    let barrier = Rc::new(Barrier::new(3));
    let mut handles = vec![];

    // Test concurrent registration of different Azure Policy effects
    let effects = [
        "concurrent_effect_schema_access.deny",
        "concurrent_effect_schema_access.audit",
        "concurrent_effect_schema_access.modify",
    ];

    for (i, effect_name) in effects.iter().enumerate() {
        let barrier = Rc::clone(&barrier);
        let name: String = (*effect_name).into();

        let handle: thread::JoinHandle<Result<(), SchemaRegistryError>> =
            thread::spawn(move || {
                let schema = match i {
                    0 => create_deny_effect_schema(),
                    1 => create_audit_effect_schema(),
                    2 => create_modify_effect_schema(),
                    _ => unreachable!(),
                };

                barrier.wait();
                EFFECT_SCHEMA_REGISTRY.register(name, schema)
            });

        handles.push(handle);
    }

    // Wait for all threads to complete
    let results: Vec<_> = handles.into_iter().map(|h| h.join().unwrap()).collect();

    // All registrations should succeed
    for result in results {
        assert!(result.is_ok());
    }

    // Should have effect schemas registered
    assert!(EFFECT_SCHEMA_REGISTRY.contains("concurrent_effect_schema_access.deny"));
    assert!(EFFECT_SCHEMA_REGISTRY.contains("concurrent_effect_schema_access.audit"));
    assert!(EFFECT_SCHEMA_REGISTRY.contains("concurrent_effect_schema_access.modify"));
}