datasynth-generators 2.3.0

50+ data generators covering GL, P2P, O2C, S2C, HR, manufacturing, audit, tax, treasury, and ESG
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
//! Combined integration tests for audit documentation generators:
//!
//! - Task 3.1: Engagement Letters (ISA 210) — `EngagementLetterGenerator`
//! - Task 3.2: Subsequent Events (ISA 560 / IAS 10) — `SubsequentEventGenerator`
//! - Task 3.3: Service Organization Controls (ISA 402) — `ServiceOrgGenerator`

use std::collections::HashSet;

use chrono::{Duration, NaiveDate};
use datasynth_core::models::audit::engagement_letter::{EngagementLetter, EngagementScope};
use datasynth_core::models::audit::service_organization::SocReportType;
use datasynth_core::models::audit::subsequent_events::EventClassification;
use datasynth_generators::audit::engagement_letter_generator::EngagementLetterGenerator;
use datasynth_generators::audit::service_org_generator::ServiceOrgGenerator;
use datasynth_generators::audit::subsequent_event_generator::SubsequentEventGenerator;

// =============================================================================
// Helpers
// =============================================================================

fn period_end() -> NaiveDate {
    NaiveDate::from_ymd_opt(2025, 12, 31).unwrap()
}

fn entity_codes(n: usize) -> Vec<String> {
    (1..=n).map(|i| format!("C{i:03}")).collect()
}

fn make_letter(gen: &mut EngagementLetterGenerator, entity_count: usize) -> EngagementLetter {
    gen.generate(
        "ENG-001",
        "Test Company Ltd.",
        entity_count,
        period_end(),
        "USD",
        "IFRS",
        period_end() - Duration::days(90),
    )
}

// =============================================================================
// Task 3.1: Engagement Letters (ISA 210)
// =============================================================================

#[test]
fn letter_single_entity_scope_is_statutory() {
    let mut gen = EngagementLetterGenerator::new(42);
    let letter = make_letter(&mut gen, 1);
    assert_eq!(
        letter.scope,
        EngagementScope::StatutoryAudit,
        "single entity should produce StatutoryAudit scope"
    );
}

#[test]
fn letter_multi_entity_scope_is_group() {
    let mut gen = EngagementLetterGenerator::new(42);
    let letter = make_letter(&mut gen, 3);
    assert_eq!(
        letter.scope,
        EngagementScope::GroupAudit,
        "3 entities should produce GroupAudit scope"
    );
}

#[test]
fn letter_one_per_engagement() {
    // Simulate 5 companies producing 5 engagements and 5 letters
    let mut gen = EngagementLetterGenerator::new(42);
    let period = period_end();

    let engagements: Vec<(String, String, NaiveDate, String)> = (1..=5)
        .map(|i| {
            (
                format!("ENG-{i:03}"),
                format!("Company {i}"),
                period,
                "USD".to_string(),
            )
        })
        .collect();

    let letters = gen.generate_batch(&engagements, 5, "IFRS");
    assert_eq!(letters.len(), 5, "should produce one letter per engagement");
}

#[test]
fn letter_fee_is_positive() {
    let mut gen = EngagementLetterGenerator::new(42);
    let letter = make_letter(&mut gen, 2);
    assert!(
        letter.fee_arrangement.amount > rust_decimal::Decimal::ZERO,
        "fee must be positive"
    );
}

#[test]
fn letter_fee_scales_with_entity_count() {
    let mut gen1 = EngagementLetterGenerator::new(42);
    let mut gen2 = EngagementLetterGenerator::new(42);
    let letter1 = make_letter(&mut gen1, 1);
    let letter5 = make_letter(&mut gen2, 5);
    assert!(
        letter5.fee_arrangement.amount > letter1.fee_arrangement.amount,
        "fee for 5 entities ({}) should exceed fee for 1 entity ({})",
        letter5.fee_arrangement.amount,
        letter1.fee_arrangement.amount
    );
}

#[test]
fn letter_reporting_deadline_is_after_period_end() {
    let mut gen = EngagementLetterGenerator::new(42);
    let letter = make_letter(&mut gen, 1);
    assert!(
        letter.reporting_deadline > period_end(),
        "reporting_deadline {} must be after period_end {}",
        letter.reporting_deadline,
        period_end()
    );
}

#[test]
fn letter_responsibilities_are_populated() {
    let mut gen = EngagementLetterGenerator::new(42);
    let letter = make_letter(&mut gen, 1);
    assert!(
        !letter.responsibilities_auditor.is_empty(),
        "auditor responsibilities must not be empty"
    );
    assert!(
        !letter.responsibilities_management.is_empty(),
        "management responsibilities must not be empty"
    );
}

#[test]
fn letter_ids_unique_across_batch() {
    let mut gen = EngagementLetterGenerator::new(42);
    let period = period_end();
    let engagements: Vec<(String, String, NaiveDate, String)> = (1..=10)
        .map(|i| {
            (
                format!("ENG-{i:03}"),
                format!("Company {i}"),
                period,
                "USD".to_string(),
            )
        })
        .collect();
    let letters = gen.generate_batch(&engagements, 10, "IFRS");
    let ids: HashSet<&str> = letters.iter().map(|l| l.id.as_str()).collect();
    assert_eq!(ids.len(), letters.len(), "all letter IDs must be unique");
}

// =============================================================================
// Task 3.2: Subsequent Events (ISA 560 / IAS 10)
// =============================================================================

#[test]
fn subsequent_events_count_within_bounds() {
    let mut gen = SubsequentEventGenerator::new(42);
    let events = gen.generate_for_entity("C001", period_end());
    assert!(
        events.len() <= 5,
        "count must be 0..=5, got {}",
        events.len()
    );
}

#[test]
fn subsequent_events_dates_after_period_end() {
    let pe = period_end();
    for seed in 0..20u64 {
        let mut gen = SubsequentEventGenerator::new(seed);
        let events = gen.generate_for_entity("C001", pe);
        for ev in &events {
            assert!(
                ev.event_date > pe,
                "event_date {} must be after period_end {}",
                ev.event_date,
                pe
            );
            assert!(
                ev.discovery_date >= ev.event_date,
                "discovery_date {} must be >= event_date {}",
                ev.discovery_date,
                ev.event_date
            );
        }
    }
}

#[test]
fn subsequent_events_adjusting_have_financial_impact() {
    // Every adjusting event must carry a financial_impact
    for seed in 0..50u64 {
        let mut gen = SubsequentEventGenerator::new(seed);
        let events = gen.generate_for_entity("C001", period_end());
        for ev in events
            .iter()
            .filter(|e| matches!(e.classification, EventClassification::Adjusting))
        {
            assert!(
                ev.financial_impact.is_some(),
                "adjusting event must have a financial_impact"
            );
        }
    }
}

#[test]
fn subsequent_events_approx_40_percent_adjusting() {
    let pe = period_end();
    let mut total = 0usize;
    let mut adjusting = 0usize;

    for seed in 0..300u64 {
        let mut gen = SubsequentEventGenerator::new(seed);
        let events = gen.generate_for_entity("C001", pe);
        total += events.len();
        adjusting += events
            .iter()
            .filter(|e| matches!(e.classification, EventClassification::Adjusting))
            .count();
    }

    if total > 0 {
        let ratio = adjusting as f64 / total as f64;
        // Allow wide tolerance: 20%–65%
        assert!(
            (0.20..=0.65).contains(&ratio),
            "adjusting ratio = {:.3}, expected ≈0.40 (20%-65% tolerance)",
            ratio
        );
    }
}

#[test]
fn subsequent_event_ids_unique() {
    let mut gen = SubsequentEventGenerator::new(7);
    let codes = entity_codes(5);
    let all_events = gen.generate_for_entities(&codes, period_end());
    let ids: HashSet<&str> = all_events.iter().map(|e| e.id.as_str()).collect();
    assert_eq!(
        ids.len(),
        all_events.len(),
        "all subsequent event IDs must be unique"
    );
}

#[test]
fn subsequent_events_discovery_within_window() {
    let pe = period_end();
    for seed in 0..30u64 {
        let mut gen = SubsequentEventGenerator::new(seed);
        let events = gen.generate_for_entity("C001", pe);
        let max_window = pe + Duration::days(90);
        for ev in &events {
            assert!(
                ev.discovery_date <= max_window,
                "discovery_date {} exceeds max window {}",
                ev.discovery_date,
                max_window
            );
        }
    }
}

// =============================================================================
// Task 3.3: Service Organization Controls (ISA 402)
// =============================================================================

#[test]
fn service_orgs_count_in_range_per_entity() {
    let mut gen = ServiceOrgGenerator::new(42);
    // Use 1 entity; should produce 1-3 service orgs
    let snapshot = gen.generate(&entity_codes(1), period_end());
    assert!(
        (1..=3).contains(&snapshot.service_organizations.len()),
        "expected 1-3 service orgs for 1 entity, got {}",
        snapshot.service_organizations.len()
    );
}

#[test]
fn soc_reports_have_objectives_in_range() {
    let mut gen = ServiceOrgGenerator::new(42);
    let snapshot = gen.generate(&entity_codes(2), period_end());
    for report in &snapshot.soc_reports {
        assert!(
            (3..=8).contains(&report.control_objectives.len()),
            "control_objectives count must be 3-8, got {}",
            report.control_objectives.len()
        );
    }
}

#[test]
fn soc_reports_exceptions_max_2() {
    let mut gen = ServiceOrgGenerator::new(42);
    let snapshot = gen.generate(&entity_codes(3), period_end());
    for report in &snapshot.soc_reports {
        assert!(
            report.exceptions_noted.len() <= 2,
            "exceptions_noted must be 0-2, got {}",
            report.exceptions_noted.len()
        );
    }
}

#[test]
fn soc_reports_are_type2() {
    let mut gen = ServiceOrgGenerator::new(42);
    let snapshot = gen.generate(&entity_codes(2), period_end());
    for report in &snapshot.soc_reports {
        assert_eq!(
            report.report_type,
            SocReportType::Soc1Type2,
            "all SOC reports should be Type II"
        );
    }
}

#[test]
fn user_entity_controls_reference_valid_soc_reports() {
    let mut gen = ServiceOrgGenerator::new(42);
    let snapshot = gen.generate(&entity_codes(3), period_end());

    let report_ids: HashSet<&str> = snapshot.soc_reports.iter().map(|r| r.id.as_str()).collect();
    for ctrl in &snapshot.user_entity_controls {
        assert!(
            report_ids.contains(ctrl.soc_report_id.as_str()),
            "UserEntityControl references unknown soc_report_id '{}'",
            ctrl.soc_report_id
        );
    }
}

#[test]
fn service_org_ids_unique() {
    let mut gen = ServiceOrgGenerator::new(42);
    let snapshot = gen.generate(&entity_codes(3), period_end());
    let ids: HashSet<&str> = snapshot
        .service_organizations
        .iter()
        .map(|o| o.id.as_str())
        .collect();
    assert_eq!(
        ids.len(),
        snapshot.service_organizations.len(),
        "service org IDs must be unique"
    );
}

#[test]
fn soc_report_ids_unique() {
    let mut gen = ServiceOrgGenerator::new(42);
    let snapshot = gen.generate(&entity_codes(3), period_end());
    let ids: HashSet<&str> = snapshot.soc_reports.iter().map(|r| r.id.as_str()).collect();
    assert_eq!(
        ids.len(),
        snapshot.soc_reports.len(),
        "SOC report IDs must be unique"
    );
}

#[test]
fn user_entity_control_ids_unique() {
    let mut gen = ServiceOrgGenerator::new(42);
    let snapshot = gen.generate(&entity_codes(3), period_end());
    let ids: HashSet<&str> = snapshot
        .user_entity_controls
        .iter()
        .map(|c| c.id.as_str())
        .collect();
    assert_eq!(
        ids.len(),
        snapshot.user_entity_controls.len(),
        "user entity control IDs must be unique"
    );
}

#[test]
fn empty_entities_produces_empty_service_org_snapshot() {
    let mut gen = ServiceOrgGenerator::new(42);
    let snapshot = gen.generate(&[], period_end());
    assert!(snapshot.service_organizations.is_empty());
    assert!(snapshot.soc_reports.is_empty());
    assert!(snapshot.user_entity_controls.is_empty());
}

#[test]
fn exceptions_reference_valid_control_objectives() {
    let mut gen = ServiceOrgGenerator::new(42);
    let snapshot = gen.generate(&entity_codes(3), period_end());
    for report in &snapshot.soc_reports {
        let obj_ids: HashSet<&str> = report
            .control_objectives
            .iter()
            .map(|o| o.id.as_str())
            .collect();
        for exc in &report.exceptions_noted {
            assert!(
                obj_ids.contains(exc.control_objective_id.as_str()),
                "exception references unknown control_objective_id '{}'",
                exc.control_objective_id
            );
        }
    }
}