data-modelling-core 2.4.0

Core SDK library for model operations across platforms
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
//! Model loading and saving tests
//!
//! These tests use the new flat file naming convention:
//! - `{workspace}_{domain}_{resource}.{type}.yaml` for ODCS tables
//! - `relationships.yaml` for relationship definitions
//! - Files are stored in the workspace root directory (no subdirectories)

#[cfg(feature = "native-fs")]
mod model_loader_tests {
    use data_modelling_core::model::loader::ModelLoader;
    use data_modelling_core::storage::{StorageBackend, filesystem::FileSystemStorageBackend};
    use tempfile::TempDir;
    use tokio::runtime::Runtime;
    use uuid::Uuid;

    fn runtime() -> Runtime {
        tokio::runtime::Builder::new_current_thread()
            .enable_all()
            .build()
            .unwrap()
    }

    #[test]
    fn test_load_model_empty_workspace() {
        let rt = runtime();
        rt.block_on(async {
            let temp = TempDir::new().unwrap();
            let backend = FileSystemStorageBackend::new(temp.path());
            let backend_setup = FileSystemStorageBackend::new(temp.path());
            let loader = ModelLoader::new(backend);

            // Create empty workspace directory
            backend_setup.create_dir("workspace").await.unwrap();

            let result = loader.load_model("workspace").await.unwrap();
            assert_eq!(result.tables.len(), 0);
            assert_eq!(result.relationships.len(), 0);
            assert_eq!(result.orphaned_relationships.len(), 0);
        });
    }

    #[test]
    fn test_load_model_with_tables() {
        let rt = runtime();
        rt.block_on(async {
            let temp = TempDir::new().unwrap();
            let backend = FileSystemStorageBackend::new(temp.path());
            let backend_setup = FileSystemStorageBackend::new(temp.path());
            let loader = ModelLoader::new(backend);

            // Create workspace directory
            backend_setup.create_dir("workspace").await.unwrap();

            // Create a table YAML file using flat naming convention
            // Format: {workspace}_{domain}_{resource}.odcs.yaml
            let table_yaml = r#"
name: users
id: 550e8400-e29b-41d4-a716-446655440000
columns:
  - name: id
    data_type: INT
    primary_key: true
    nullable: false
"#;
            backend_setup
                .write_file(
                    "workspace/myworkspace_default_users.odcs.yaml",
                    table_yaml.as_bytes(),
                )
                .await
                .unwrap();

            let result = loader.load_model("workspace").await.unwrap();
            assert_eq!(result.tables.len(), 1);
            assert_eq!(result.tables[0].name, "users");
            assert_eq!(
                result.tables[0].id,
                Uuid::parse_str("550e8400-e29b-41d4-a716-446655440000").unwrap()
            );
        });
    }

    #[test]
    fn test_load_model_with_relationships() {
        let rt = runtime();
        rt.block_on(async {
            let temp = TempDir::new().unwrap();
            let backend = FileSystemStorageBackend::new(temp.path());
            let backend_setup = FileSystemStorageBackend::new(temp.path());
            let loader = ModelLoader::new(backend);

            // Create workspace directory
            backend_setup.create_dir("workspace").await.unwrap();

            // Create tables using flat naming convention
            let users_table = r#"
name: users
id: 550e8400-e29b-41d4-a716-446655440000
columns:
  - name: id
    type: string
"#;
            backend_setup
                .write_file(
                    "workspace/myworkspace_default_users.odcs.yaml",
                    users_table.as_bytes(),
                )
                .await
                .unwrap();

            let orders_table = r#"
name: orders
id: 550e8400-e29b-41d4-a716-446655440001
columns:
  - name: id
    type: string
"#;
            backend_setup
                .write_file(
                    "workspace/myworkspace_default_orders.odcs.yaml",
                    orders_table.as_bytes(),
                )
                .await
                .unwrap();

            // Create relationships file
            let relationships_yaml = r#"
relationships:
  - id: 660e8400-e29b-41d4-a716-446655440000
    source_table_id: 550e8400-e29b-41d4-a716-446655440000
    target_table_id: 550e8400-e29b-41d4-a716-446655440001
"#;
            backend_setup
                .write_file(
                    "workspace/relationships.yaml",
                    relationships_yaml.as_bytes(),
                )
                .await
                .unwrap();

            let result = loader.load_model("workspace").await.unwrap();
            assert_eq!(result.tables.len(), 2);
            assert_eq!(result.relationships.len(), 1);
            assert_eq!(result.orphaned_relationships.len(), 0);
        });
    }

    #[test]
    fn test_load_model_orphaned_relationships() {
        let rt = runtime();
        rt.block_on(async {
            let temp = TempDir::new().unwrap();
            let backend = FileSystemStorageBackend::new(temp.path());
            let backend_setup = FileSystemStorageBackend::new(temp.path());
            let loader = ModelLoader::new(backend);

            // Create workspace directory
            backend_setup.create_dir("workspace").await.unwrap();

            // Create only one table using flat naming convention
            let users_table = r#"
name: users
id: 550e8400-e29b-41d4-a716-446655440000
columns:
  - name: id
    type: string
"#;
            backend_setup
                .write_file(
                    "workspace/myworkspace_default_users.odcs.yaml",
                    users_table.as_bytes(),
                )
                .await
                .unwrap();

            // Create relationships file with orphaned relationship
            let relationships_yaml = r#"
relationships:
  - id: 660e8400-e29b-41d4-a716-446655440000
    source_table_id: 550e8400-e29b-41d4-a716-446655440000
    target_table_id: 550e8400-e29b-41d4-a716-446655440001
"#;
            backend_setup
                .write_file(
                    "workspace/relationships.yaml",
                    relationships_yaml.as_bytes(),
                )
                .await
                .unwrap();

            let result = loader.load_model("workspace").await.unwrap();
            assert_eq!(result.tables.len(), 1);
            assert_eq!(result.relationships.len(), 0);
            assert_eq!(result.orphaned_relationships.len(), 1);
        });
    }

    #[test]
    fn test_load_model_invalid_yaml() {
        let rt = runtime();
        rt.block_on(async {
            let temp = TempDir::new().unwrap();
            let backend = FileSystemStorageBackend::new(temp.path());
            let backend_setup = FileSystemStorageBackend::new(temp.path());
            let loader = ModelLoader::new(backend);

            // Create workspace directory
            backend_setup.create_dir("workspace").await.unwrap();

            // Create invalid YAML file using flat naming convention
            let invalid_yaml = "invalid: yaml: content: [";
            backend_setup
                .write_file(
                    "workspace/myworkspace_default_invalid.odcs.yaml",
                    invalid_yaml.as_bytes(),
                )
                .await
                .unwrap();

            // Should not panic, but skip invalid files
            let result = loader.load_model("workspace").await.unwrap();
            assert_eq!(result.tables.len(), 0);
        });
    }

    #[test]
    fn test_load_model_missing_name_field() {
        let rt = runtime();
        rt.block_on(async {
            let temp = TempDir::new().unwrap();
            let backend = FileSystemStorageBackend::new(temp.path());
            let backend_setup = FileSystemStorageBackend::new(temp.path());
            let loader = ModelLoader::new(backend);

            // Create workspace directory
            backend_setup.create_dir("workspace").await.unwrap();

            // Create table YAML without name field using flat naming convention
            let table_yaml = r#"
id: 550e8400-e29b-41d4-a716-446655440000
columns: []
"#;
            backend_setup
                .write_file(
                    "workspace/myworkspace_default_table.odcs.yaml",
                    table_yaml.as_bytes(),
                )
                .await
                .unwrap();

            // Should skip files with missing required fields
            let result = loader.load_model("workspace").await.unwrap();
            assert_eq!(result.tables.len(), 0);
        });
    }
}

#[cfg(feature = "native-fs")]
mod model_saver_tests {
    use data_modelling_core::model::saver::{ModelSaver, RelationshipData, TableData};
    use data_modelling_core::storage::{StorageBackend, filesystem::FileSystemStorageBackend};
    use tempfile::TempDir;
    use tokio::runtime::Runtime;
    use uuid::Uuid;

    fn runtime() -> Runtime {
        tokio::runtime::Builder::new_current_thread()
            .enable_all()
            .build()
            .unwrap()
    }

    #[test]
    fn test_save_table() {
        let rt = runtime();
        rt.block_on(async {
            let temp = TempDir::new().unwrap();
            let backend = FileSystemStorageBackend::new(temp.path());
            let saver = ModelSaver::new(backend);

            let mut yaml_map = serde_yaml::Mapping::new();
            yaml_map.insert(
                serde_yaml::Value::String("name".to_string()),
                serde_yaml::Value::String("users".to_string()),
            );
            yaml_map.insert(
                serde_yaml::Value::String("id".to_string()),
                serde_yaml::Value::String("550e8400-e29b-41d4-a716-446655440000".to_string()),
            );
            yaml_map.insert(
                serde_yaml::Value::String("columns".to_string()),
                serde_yaml::Value::Sequence(vec![]),
            );
            let table = TableData {
                id: Uuid::new_v4(),
                name: "users".to_string(),
                yaml_file_path: None,
                yaml_value: serde_yaml::Value::Mapping(yaml_map),
            };

            let backend_clone = FileSystemStorageBackend::new(temp.path());
            saver.save_table("workspace", &table).await.unwrap();

            // Verify file was created
            assert!(
                backend_clone
                    .file_exists("workspace/tables/users.yaml")
                    .await
                    .unwrap()
            );
        });
    }

    #[test]
    fn test_save_table_with_custom_path() {
        let rt = runtime();
        rt.block_on(async {
            let temp = TempDir::new().unwrap();
            let backend = FileSystemStorageBackend::new(temp.path());
            let saver = ModelSaver::new(backend);

            let mut yaml_map = serde_yaml::Mapping::new();
            yaml_map.insert(
                serde_yaml::Value::String("name".to_string()),
                serde_yaml::Value::String("users".to_string()),
            );
            yaml_map.insert(
                serde_yaml::Value::String("id".to_string()),
                serde_yaml::Value::String("550e8400-e29b-41d4-a716-446655440000".to_string()),
            );
            let table = TableData {
                id: Uuid::new_v4(),
                name: "users".to_string(),
                yaml_file_path: Some("tables/custom_users.yaml".to_string()),
                yaml_value: serde_yaml::Value::Mapping(yaml_map),
            };

            let backend_clone = FileSystemStorageBackend::new(temp.path());
            saver.save_table("workspace", &table).await.unwrap();

            // Verify file was created at custom path
            assert!(
                backend_clone
                    .file_exists("workspace/tables/custom_users.yaml")
                    .await
                    .unwrap()
            );
        });
    }

    #[test]
    fn test_save_relationships() {
        let rt = runtime();
        rt.block_on(async {
            let temp = TempDir::new().unwrap();
            let backend = FileSystemStorageBackend::new(temp.path());
            let saver = ModelSaver::new(backend);

            let mut rel_map = serde_yaml::Mapping::new();
            rel_map.insert(
                serde_yaml::Value::String("id".to_string()),
                serde_yaml::Value::String("660e8400-e29b-41d4-a716-446655440000".to_string()),
            );
            rel_map.insert(
                serde_yaml::Value::String("source_table_id".to_string()),
                serde_yaml::Value::String("550e8400-e29b-41d4-a716-446655440000".to_string()),
            );
            rel_map.insert(
                serde_yaml::Value::String("target_table_id".to_string()),
                serde_yaml::Value::String("550e8400-e29b-41d4-a716-446655440001".to_string()),
            );
            let relationships = vec![RelationshipData {
                id: Uuid::new_v4(),
                source_table_id: Uuid::new_v4(),
                target_table_id: Uuid::new_v4(),
                yaml_value: serde_yaml::Value::Mapping(rel_map),
            }];

            let backend_clone = FileSystemStorageBackend::new(temp.path());
            saver
                .save_relationships("workspace", &relationships)
                .await
                .unwrap();

            // Verify file was created
            assert!(
                backend_clone
                    .file_exists("workspace/relationships.yaml")
                    .await
                    .unwrap()
            );

            // Verify content
            let content = backend_clone
                .read_file("workspace/relationships.yaml")
                .await
                .unwrap();
            let yaml_str = String::from_utf8(content).unwrap();
            assert!(yaml_str.contains("relationships"));
            assert!(yaml_str.contains("source_table_id"));
        });
    }

    #[test]
    fn test_save_table_sanitizes_filename() {
        let rt = runtime();
        rt.block_on(async {
            let temp = TempDir::new().unwrap();
            let backend = FileSystemStorageBackend::new(temp.path());
            let saver = ModelSaver::new(backend);

            let mut yaml_map = serde_yaml::Mapping::new();
            yaml_map.insert(
                serde_yaml::Value::String("name".to_string()),
                serde_yaml::Value::String("users/table".to_string()),
            );
            yaml_map.insert(
                serde_yaml::Value::String("id".to_string()),
                serde_yaml::Value::String("550e8400-e29b-41d4-a716-446655440000".to_string()),
            );
            let table = TableData {
                id: Uuid::new_v4(),
                name: "users/table".to_string(), // Contains invalid filename character
                yaml_file_path: None,
                yaml_value: serde_yaml::Value::Mapping(yaml_map),
            };

            let backend_clone = FileSystemStorageBackend::new(temp.path());
            saver.save_table("workspace", &table).await.unwrap();

            // Verify file was created with sanitized name
            assert!(
                backend_clone
                    .file_exists("workspace/tables/users_table.yaml")
                    .await
                    .unwrap()
            );
        });
    }
}

#[cfg(feature = "api-backend")]
mod api_model_loader_tests {

    // Note: These tests would require a mock HTTP server
    // For now, we'll document what tests should be added:
    // - test_load_model_from_api_success
    // - test_load_model_from_api_orphaned_relationships
    // - test_load_model_from_api_invalid_json
    // - test_load_model_from_api_missing_fields
    // - test_load_model_from_api_network_error
}