cimoxide-cli 0.3.2

cimcli: command-line tool to decode, validate, convert and query ENTSO-E CGMES data
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
use std::path::PathBuf;
use std::process;

/// Unwrap a `Result`, or print `"{context}: {error}"` to stderr and exit(1).
fn or_die<T, E: std::fmt::Display>(result: Result<T, E>, context: &str) -> T {
    result.unwrap_or_else(|e| {
        eprintln!("{context}: {e}");
        process::exit(1);
    })
}

fn usage() -> ! {
    eprintln!("Usage:");
    eprintln!("  cimoxide-cli import [--json] <xml-files...>");
    eprintln!("  cimoxide-cli convert --to json <xml-files...> [--out <output.json>]");
    eprintln!("  cimoxide-cli convert --to xml  <input.json>   [--out <output.xml>]");
    eprintln!("  cimoxide-cli convert --to xml  <input.json>   --profile EQ,SSH [--out <dir/>]");
    eprintln!("  cimoxide-cli validate [--profiles EQ,SSH,...] [--solved] [--not-solved]");
    eprintln!("                        [--common] [--quality] [--silence rule1,rule2]");
    eprintln!("                        [--format json|text] <xml-files...>");
    #[cfg(feature = "sparql")]
    {
        eprintln!("  cimoxide-cli query  --query \"SELECT ...\" | --file <query.rq>");
        eprintln!("                      [--format text|json|csv|tsv] <xml-files...>");
    }
    process::exit(1);
}

fn main() {
    let args: Vec<String> = std::env::args().skip(1).collect();
    if args.is_empty() {
        usage();
    }
    if args[0] == "import" {
        cmd_import(&args[1..]);
        return;
    }
    if args[0] == "validate" {
        cmd_validate(&args[1..]);
        return;
    }
    if args[0] == "query" {
        #[cfg(feature = "sparql")]
        {
            cmd_query(&args[1..]);
            return;
        }
        #[cfg(not(feature = "sparql"))]
        {
            eprintln!("error: this build has no SPARQL support");
            eprintln!("hint: rebuild with `cargo build -p cimoxide-cli --features sparql`");
            process::exit(1);
        }
    }
    if args[0] != "convert" {
        usage();
    }

    let mut to_format: Option<String> = None;
    let mut out_path: Option<PathBuf> = None;
    let mut profile_str: Option<String> = None;
    let mut input_files: Vec<PathBuf> = Vec::new();

    let mut i = 1usize;
    while i < args.len() {
        match args[i].as_str() {
            "--to" => {
                i += 1;
                if i >= args.len() {
                    eprintln!("error: --to requires an argument");
                    usage();
                }
                to_format = Some(args[i].clone());
            }
            "--out" => {
                i += 1;
                if i >= args.len() {
                    eprintln!("error: --out requires an argument");
                    usage();
                }
                out_path = Some(PathBuf::from(&args[i]));
            }
            "--profile" => {
                i += 1;
                if i >= args.len() {
                    eprintln!("error: --profile requires an argument");
                    usage();
                }
                profile_str = Some(args[i].clone());
            }
            arg if !arg.starts_with('-') => {
                input_files.push(PathBuf::from(arg));
            }
            unknown => {
                eprintln!("error: unknown flag: {unknown}");
                usage();
            }
        }
        i += 1;
    }

    let format = to_format.as_deref().unwrap_or_else(|| {
        eprintln!("error: --to <json|xml> is required");
        usage();
    });

    if input_files.is_empty() {
        eprintln!("error: at least one input file is required");
        usage();
    }

    match format {
        "json" => cmd_to_json(&input_files, out_path.as_deref()),
        "xml" => {
            let profiles: Vec<&str> = profile_str
                .as_deref()
                .map(|s| s.split(',').collect())
                .unwrap_or_default();
            cmd_to_xml(&input_files[0], out_path.as_deref(), &profiles);
        }
        other => {
            eprintln!("error: unknown format '{other}', expected 'json' or 'xml'");
            usage();
        }
    }
}

fn cmd_to_json(xml_files: &[PathBuf], out: Option<&std::path::Path>) {
    let paths: Vec<&std::path::Path> = xml_files.iter().map(PathBuf::as_path).collect();
    let ds = or_die(cimdecoder::CimDataset::decode_files_parallel(&paths), "error decoding XML");
    let json = cimconvert::dataset_to_json(&ds);
    let text = or_die(serde_json::to_string_pretty(&json), "error serializing JSON");
    write_output(&text, out);
}

fn cmd_to_xml(json_file: &std::path::Path, out: Option<&std::path::Path>, profiles: &[&str]) {
    let src = or_die(
        std::fs::read_to_string(json_file),
        &format!("error reading {}", json_file.display()),
    );
    let ds = or_die(cimconvert::dataset_from_json(&src), "error parsing JSON");

    if profiles.is_empty() {
        let xml = or_die(cimconvert::dataset_to_xml(&ds), "error generating XML");
        write_output(&xml, out);
        return;
    }

    if profiles.len() > 1 {
        let dir = out.unwrap_or_else(|| {
            eprintln!("error: --out <dir/> is required when multiple --profile codes are given");
            usage();
        });
        if !dir.is_dir() {
            or_die(
                std::fs::create_dir_all(dir),
                &format!("error creating directory {}", dir.display()),
            );
        }
        for &code in profiles {
            let xml = or_die(
                cimconvert::dataset_to_xml_for_profile(&ds, code),
                &format!("error generating XML for profile {code}"),
            );
            let path = dir.join(format!("{code}.xml"));
            or_die(std::fs::write(&path, &xml), &format!("error writing {}", path.display()));
        }
    } else {
        let code = profiles[0];
        let xml = or_die(
            cimconvert::dataset_to_xml_for_profile(&ds, code),
            &format!("error generating XML for profile {code}"),
        );
        write_output(&xml, out);
    }
}

fn write_output(text: &str, out: Option<&std::path::Path>) {
    match out {
        Some(path) => or_die(std::fs::write(path, text), &format!("error writing {}", path.display())),
        None => print!("{text}"),
    }
}

fn cmd_import(args: &[String]) {
    let mut input_files: Vec<PathBuf> = Vec::new();
    let mut output_json = false;

    let mut i = 0usize;
    while i < args.len() {
        match args[i].as_str() {
            "--json" => { output_json = true; }
            arg if !arg.starts_with('-') => {
                input_files.push(PathBuf::from(arg));
            }
            unknown => {
                eprintln!("error: unknown flag: {unknown}");
                usage();
            }
        }
        i += 1;
    }

    if input_files.is_empty() {
        eprintln!("error: at least one input file is required");
        usage();
    }

    struct FileResult { name: String, count: usize }

    // Decode all files in parallel, collecting per-file counts before merging.
    let paths: Vec<&std::path::Path> = input_files.iter().map(PathBuf::as_path).collect();
    let datasets = or_die(
        cimdecoder::CimDataset::decode_files_parallel_separate(&paths),
        "error decoding input",
    );

    let mut per_file: Vec<FileResult> = Vec::new();
    let mut combined = cimdecoder::CimDataset::new();
    for (path, ds) in input_files.iter().zip(datasets) {
        let name = path.file_name()
            .map(|n| n.to_string_lossy().into_owned())
            .unwrap_or_else(|| path.display().to_string());
        per_file.push(FileResult { name, count: ds.entries.len() });
        combined.merge(ds);
    }

    let total = combined.entries.len();
    let mut type_counts: Vec<(String, usize)> = combined.by_type
        .iter()
        .map(|(t, v)| (t.clone(), v.len()))
        .collect();
    type_counts.sort_by(|a, b| a.0.cmp(&b.0));

    if output_json {
        let files_json: Vec<serde_json::Value> = per_file.iter()
            .map(|f| serde_json::json!({ "file": f.name, "count": f.count }))
            .collect();
        let type_map: serde_json::Map<String, serde_json::Value> = type_counts.iter()
            .map(|(t, n)| (t.clone(), serde_json::Value::from(*n)))
            .collect();
        println!("{}", serde_json::to_string_pretty(&serde_json::json!({
            "total": total,
            "files": files_json,
            "type_counts": type_map,
        })).unwrap());
    } else {
        println!("Total elements: {} (from {} file(s))\n", total, per_file.len());
        for f in &per_file {
            println!("  {}: {} elements", f.name, f.count);
        }
        if !type_counts.is_empty() {
            println!("\nBy type:");
            for (t, n) in &type_counts {
                println!("  {:<50} {}", t, n);
            }
        }
    }
}

fn cmd_validate(args: &[String]) {
    let mut input_files: Vec<PathBuf> = Vec::new();
    let mut profiles_override: Option<Vec<String>> = None;
    let mut force_solved = false;
    let mut force_not_solved = false;
    let mut enable_common = false;
    let mut enable_quality = false;
    let mut silenced: Vec<String> = Vec::new();
    let mut output_json = false;

    let mut i = 0usize;
    while i < args.len() {
        match args[i].as_str() {
            "--profiles" => {
                i += 1;
                if i >= args.len() { eprintln!("error: --profiles requires an argument"); usage(); }
                profiles_override = Some(args[i].split(',').map(str::to_string).collect());
            }
            "--solved" => { force_solved = true; }
            "--not-solved" => { force_not_solved = true; }
            "--common" => { enable_common = true; }
            "--quality" => { enable_quality = true; }
            "--silence" => {
                i += 1;
                if i >= args.len() { eprintln!("error: --silence requires an argument"); usage(); }
                silenced.extend(args[i].split(',').map(str::to_string));
            }
            "--format" => {
                i += 1;
                if i >= args.len() { eprintln!("error: --format requires an argument"); usage(); }
                match args[i].as_str() {
                    "json" => output_json = true,
                    "text" => output_json = false,
                    other => { eprintln!("error: unknown format '{other}', expected 'json' or 'text'"); usage(); }
                }
            }
            arg if !arg.starts_with('-') => {
                input_files.push(PathBuf::from(arg));
            }
            unknown => {
                eprintln!("error: unknown flag: {unknown}");
                usage();
            }
        }
        i += 1;
    }

    if input_files.is_empty() {
        eprintln!("error: at least one input file is required");
        usage();
    }

    // Decode each file separately (in parallel) to enable per-profile pre-merge validation.
    let paths: Vec<&std::path::Path> = input_files.iter().map(PathBuf::as_path).collect();
    let datasets = or_die(
        cimdecoder::CimDataset::decode_files_parallel_separate(&paths),
        "error decoding input",
    );

    let solved_override = if force_solved {
        Some(true)
    } else if force_not_solved {
        Some(false)
    } else {
        None
    };
    let cfg = cimvalidation::combined_config(
        &datasets,
        profiles_override,
        solved_override,
        enable_common,
        enable_quality,
        silenced,
    );

    // Two-phase validation: per-file local checks in parallel, then crossprofile checks
    // on the merged dataset, with rule silencing applied.
    let violations = cimvalidation::validate_files(datasets, &cfg);

    if output_json {
        let arr: Vec<serde_json::Value> = violations.iter().map(|v| {
            serde_json::json!({
                "object_id": v.object_id,
                "rule_id":   v.rule_id,
                "name":      v.name,
                "class":     v.class,
                "property":  v.property,
                "message":   v.message,
                "severity":  v.severity,
            })
        }).collect();
        println!("{}", serde_json::to_string_pretty(&arr).unwrap());
    } else if violations.is_empty() {
        println!("No violations found.");
    } else {
        for v in &violations {
            println!("[{}] {} — {} ({})", v.severity, v.rule_id, v.message, v.object_id);
        }
        eprintln!("{} violation(s) found.", violations.len());
        process::exit(2);
    }
}

/// `cimoxide-cli query` — run a SPARQL query over the merged input files.
#[cfg(feature = "sparql")]
fn cmd_query(args: &[String]) {
    use cimsparql::format::Format;

    let mut query: Option<String> = None;
    let mut query_file: Option<PathBuf> = None;
    let mut format = Format::Text;
    let mut input_files: Vec<PathBuf> = Vec::new();

    let mut i = 0usize;
    while i < args.len() {
        match args[i].as_str() {
            "--query" | "-q" => {
                i += 1;
                if i >= args.len() {
                    eprintln!("error: --query requires an argument");
                    usage();
                }
                query = Some(args[i].clone());
            }
            "--file" | "-f" => {
                i += 1;
                if i >= args.len() {
                    eprintln!("error: --file requires an argument");
                    usage();
                }
                query_file = Some(PathBuf::from(&args[i]));
            }
            "--format" => {
                i += 1;
                if i >= args.len() {
                    eprintln!("error: --format requires an argument");
                    usage();
                }
                format = match Format::parse(&args[i]) {
                    Some(f) => f,
                    None => {
                        eprintln!("error: unknown format: {} (want text|json|csv|tsv)", args[i]);
                        process::exit(1);
                    }
                };
            }
            arg if !arg.starts_with('-') => input_files.push(PathBuf::from(arg)),
            unknown => {
                eprintln!("error: unknown flag: {unknown}");
                usage();
            }
        }
        i += 1;
    }

    let sparql = match (query, query_file) {
        (Some(_), Some(_)) => {
            eprintln!("error: pass either --query or --file, not both");
            process::exit(1);
        }
        (Some(q), None) => q,
        (None, Some(path)) => or_die(std::fs::read_to_string(&path), "error reading query file"),
        (None, None) => {
            eprintln!("error: a query is required (--query or --file)");
            usage();
        }
    };

    if input_files.is_empty() {
        eprintln!("error: at least one input file is required");
        usage();
    }

    let paths: Vec<&std::path::Path> = input_files.iter().map(PathBuf::as_path).collect();
    let dataset = or_die(
        cimdecoder::CimDataset::decode_files_parallel(&paths),
        "error decoding input",
    );
    let store = or_die(cimsparql::CimStore::from_dataset(&dataset), "error building RDF graph");
    let results = or_die(store.query(&sparql), "query failed");

    let stdout = std::io::stdout();
    let mut out = stdout.lock();
    or_die(cimsparql::format::write(results, format, &mut out), "error writing results");
}