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
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
#![allow(missing_docs)]
use std::{
    fs::{create_dir_all, File},
    io::Write,
    path::{Path, PathBuf},
};

use clap::Parser;
use colored::*;
use indexmap::IndexMap;
use serde::Serialize;
use toml::{map::Map, Value};
use vector_lib::configurable::component::{
    SinkDescription, SourceDescription, TransformDescription,
};
use vector_lib::{buffers::BufferConfig, config::GlobalOptions, default_data_dir};

use crate::config::{format, Format, SinkHealthcheckOptions};

#[derive(Parser, Debug)]
#[command(rename_all = "kebab-case")]
pub struct Opts {
    /// Whether to skip the generation of global fields.
    #[arg(short, long)]
    pub(crate) fragment: bool,

    /// Generate expression, e.g. 'stdin/remap,filter/console'
    ///
    /// Three comma-separated lists of sources, transforms and sinks, divided by
    /// forward slashes. If subsequent component types are not needed then
    /// their dividers can be omitted from the expression.
    ///
    /// For example:
    ///
    /// `/filter` prints a `filter` transform.
    ///
    /// `//file,http` prints a `file` and `http` sink.
    ///
    /// `stdin//http` prints a `stdin` source and an `http` sink.
    ///
    /// Generated components are given incremental names (`source1`, `source2`,
    /// etc) which should be replaced in order to provide better context. You
    /// can optionally specify the names of components by prefixing them with
    /// `<name>:`, e.g.:
    ///
    /// `foo:stdin/bar:test_basic/baz:http` prints a `stdin` source called
    /// `foo`, a `test_basic` transform called `bar`, and an `http` sink
    /// called `baz`.
    ///
    /// Vector makes a best attempt at constructing a sensible topology. The
    /// first transform generated will consume from all sources and subsequent
    /// transforms will consume from their predecessor. All sinks will consume
    /// from the last transform or, if none are specified, from all sources. It
    /// is then up to you to restructure the `inputs` of each component to build
    /// the topology you need.
    pub(crate) expression: String,

    /// Generate config as a file
    #[arg(long)]
    pub(crate) file: Option<PathBuf>,

    #[arg(long, default_value = "yaml")]
    pub(crate) format: Format,
}

#[derive(Serialize)]
pub struct SinkOuter {
    pub inputs: Vec<String>,
    #[serde(flatten)]
    pub inner: Value,
    pub healthcheck: SinkHealthcheckOptions,
    pub buffer: BufferConfig,
}

#[derive(Serialize)]
pub struct TransformOuter {
    pub inputs: Vec<String>,
    #[serde(flatten)]
    pub inner: Value,
}

#[derive(Serialize, Default)]
pub struct Config {
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sources: Option<IndexMap<String, Value>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub transforms: Option<IndexMap<String, TransformOuter>>,
    #[serde(skip_serializing_if = "Option::is_none")]
    pub sinks: Option<IndexMap<String, SinkOuter>>,
}

/// Controls how the resulting transform topology is wired up. This is not
/// user-configurable.
pub(crate) enum TransformInputsStrategy {
    /// Default.
    ///
    /// The first transform generated will consume from all sources and
    /// subsequent transforms will consume from their predecessor.
    Auto,
    /// Used for property testing `vector config`.
    ///
    /// All transforms use a list of all sources as inputs.
    #[cfg(test)]
    #[allow(dead_code)]
    All,
}

#[derive(Serialize, Default)]
struct FullConfig {
    #[serde(flatten)]
    global_options: Option<GlobalOptions>,
    #[serde(flatten)]
    config: Config,
}

pub(crate) fn generate_example(
    opts: &Opts,
    transform_inputs_strategy: TransformInputsStrategy,
) -> Result<String, Vec<String>> {
    let components: Vec<Vec<_>> = opts
        .expression
        .split(|c| c == '|' || c == '/')
        .map(|s| {
            s.split(',')
                .map(|s| s.trim().to_string())
                .filter(|s| !s.is_empty())
                .collect()
        })
        .collect();

    let mut config = Config::default();

    let mut errs = Vec::new();

    let mut source_names = Vec::new();
    if let Some(source_types) = components.first() {
        let mut sources = IndexMap::new();

        for (i, source_expr) in source_types.iter().enumerate() {
            let (name, source_type) = if let Some(c_index) = source_expr.find(':') {
                if c_index == 0 {
                    errs.push(format!(
                        "failed to generate source '{}': empty name is not allowed",
                        source_expr
                    ));
                    continue;
                }
                let mut chopped_expr = source_expr.clone();
                (
                    chopped_expr.drain(..c_index).collect(),
                    chopped_expr.drain(1..).collect(),
                )
            } else {
                (format!("source{}", i), source_expr.clone())
            };
            source_names.push(name.clone());

            let mut example = match SourceDescription::example(&source_type) {
                Ok(example) => example,
                Err(err) => {
                    errs.push(format!(
                        "failed to generate source '{}': {}",
                        source_type, err
                    ));
                    Value::Table(Map::new())
                }
            };
            example
                .as_table_mut()
                .expect("examples are always tables")
                .insert("type".into(), source_type.to_owned().into());

            sources.insert(name, example);
        }

        if !sources.is_empty() {
            config.sources = Some(sources);
        }
    }

    let mut transform_names = Vec::new();
    if let Some(transform_types) = components.get(1) {
        let mut transforms = IndexMap::new();

        for (i, transform_expr) in transform_types.iter().enumerate() {
            let (name, transform_type) = if let Some(c_index) = transform_expr.find(':') {
                if c_index == 0 {
                    errs.push(format!(
                        "failed to generate transform '{}': empty name is not allowed",
                        transform_expr
                    ));
                    continue;
                }
                let mut chopped_expr = transform_expr.clone();
                (
                    chopped_expr.drain(..c_index).collect(),
                    chopped_expr.drain(1..).collect(),
                )
            } else {
                (format!("transform{}", i), transform_expr.clone())
            };
            transform_names.push(name.clone());

            let targets = match transform_inputs_strategy {
                TransformInputsStrategy::Auto => {
                    if i == 0 {
                        source_names.clone()
                    } else {
                        vec![transform_names
                            .get(i - 1)
                            .unwrap_or(&"component-id".to_owned())
                            .to_owned()]
                    }
                }
                #[cfg(test)]
                TransformInputsStrategy::All => source_names.clone(),
            };

            let mut example = match TransformDescription::example(&transform_type) {
                Ok(example) => example,
                Err(err) => {
                    errs.push(format!(
                        "failed to generate transform '{}': {}",
                        transform_type, err
                    ));
                    Value::Table(Map::new())
                }
            };
            example
                .as_table_mut()
                .expect("examples are always tables")
                .insert("type".into(), transform_type.to_owned().into());

            transforms.insert(
                name,
                TransformOuter {
                    inputs: targets,
                    inner: example,
                },
            );
        }

        if !transforms.is_empty() {
            config.transforms = Some(transforms);
        }
    }

    if let Some(sink_types) = components.get(2) {
        let mut sinks = IndexMap::new();

        for (i, sink_expr) in sink_types.iter().enumerate() {
            let (name, sink_type) = if let Some(c_index) = sink_expr.find(':') {
                if c_index == 0 {
                    errs.push(format!(
                        "failed to generate sink '{}': empty name is not allowed",
                        sink_expr
                    ));
                    continue;
                }
                let mut chopped_expr = sink_expr.clone();
                (
                    chopped_expr.drain(..c_index).collect(),
                    chopped_expr.drain(1..).collect(),
                )
            } else {
                (format!("sink{}", i), sink_expr.clone())
            };

            let mut example = match SinkDescription::example(&sink_type) {
                Ok(example) => example,
                Err(err) => {
                    errs.push(format!("failed to generate sink '{}': {}", sink_type, err));
                    Value::Table(Map::new())
                }
            };
            example
                .as_table_mut()
                .expect("examples are always tables")
                .insert("type".into(), sink_type.to_owned().into());

            sinks.insert(
                name,
                SinkOuter {
                    inputs: transform_names
                        .last()
                        .map(|s| vec![s.to_owned()])
                        .or_else(|| {
                            if !source_names.is_empty() {
                                Some(source_names.clone())
                            } else {
                                None
                            }
                        })
                        .unwrap_or_else(|| vec!["component-id".to_owned()]),
                    buffer: BufferConfig::default(),
                    healthcheck: SinkHealthcheckOptions::default(),
                    inner: example,
                },
            );
        }

        if !sinks.is_empty() {
            config.sinks = Some(sinks);
        }
    }

    if !errs.is_empty() {
        return Err(errs);
    }

    let full_config = FullConfig {
        global_options: if !opts.fragment {
            Some(GlobalOptions {
                data_dir: default_data_dir(),
                ..Default::default()
            })
        } else {
            None
        },
        config,
    };

    let builder = match format::serialize(&full_config, opts.format) {
        Ok(v) => v,
        Err(e) => {
            errs.push(format!("failed to marshal sources: {e}"));
            return Err(errs);
        }
    };

    let file = opts.file.as_ref();
    if file.is_some() {
        #[allow(clippy::print_stdout)]
        match write_config(file.as_ref().unwrap(), &builder) {
            Ok(_) => {
                println!(
                    "Config file written to {:?}",
                    &file.as_ref().unwrap().join("\n")
                )
            }
            Err(e) => errs.push(format!("failed to write to file: {e}")),
        };
    };

    if !errs.is_empty() {
        Err(errs)
    } else {
        Ok(builder)
    }
}

pub fn cmd(opts: &Opts) -> exitcode::ExitCode {
    match generate_example(opts, TransformInputsStrategy::Auto) {
        Ok(s) => {
            #[allow(clippy::print_stdout)]
            {
                println!("{}", s);
            }
            exitcode::OK
        }
        Err(errs) => {
            #[allow(clippy::print_stderr)]
            {
                errs.iter().for_each(|e| eprintln!("{}", e.red()));
            }
            exitcode::SOFTWARE
        }
    }
}

fn write_config(filepath: &Path, body: &str) -> Result<(), crate::Error> {
    if filepath.exists() {
        // If the file exists, we don't want to overwrite, that's just rude.
        Err(format!("{:?} already exists", &filepath).into())
    } else {
        if let Some(directory) = filepath.parent() {
            create_dir_all(directory)?;
        }
        File::create(filepath)
            .and_then(|mut file| file.write_all(body.as_bytes()))
            .map_err(Into::into)
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::config::ConfigBuilder;
    use rstest::rstest;

    fn generate_and_deserialize(expression: String, format: Format) {
        let opts = Opts {
            fragment: false,
            expression,
            file: None,
            format,
        };
        let cfg_string = generate_example(&opts, TransformInputsStrategy::Auto).unwrap();
        if let Err(error) = format::deserialize::<ConfigBuilder>(&cfg_string, opts.format) {
            panic!(
                "Failed to generate example for {} with error: {error:?})",
                opts.expression
            );
        }
    }

    #[rstest]
    #[case(Format::Toml)]
    #[case(Format::Json)]
    #[case(Format::Yaml)]
    #[test]
    fn generate_all(#[case] format: Format) {
        for name in SourceDescription::types() {
            generate_and_deserialize(format!("{}//", name), format);
        }

        for name in TransformDescription::types() {
            generate_and_deserialize(format!("/{}/", name), format);
        }

        for name in SinkDescription::types() {
            generate_and_deserialize(format!("//{}", name), format);
        }
    }

    #[cfg(all(feature = "sources-stdin", feature = "sinks-console"))]
    #[test]
    fn generate_configfile() {
        use std::fs;

        use tempfile::tempdir;

        let tempdir = tempdir().expect("Unable to create tempdir for config");
        let filepath = tempdir.path().join("./config.example.toml");
        let opts = Opts {
            fragment: false,
            expression: "stdin/test_basic/console".to_string(),
            file: Some(filepath.clone()),
            format: Format::Toml,
        };

        let cfg = generate_example(&opts, TransformInputsStrategy::Auto);
        let filecontents = fs::read_to_string(
            fs::canonicalize(&filepath).expect("Could not return canonicalized filepath"),
        )
        .expect("Could not read config file");
        fs::remove_file(filepath).expect("Could not cleanup config file!");
        assert_eq!(cfg.unwrap(), filecontents)
    }

    #[cfg(all(feature = "sources-stdin", feature = "sinks-console"))]
    #[test]
    fn generate_basic_toml() {
        let mut opts = Opts {
            fragment: false,
            expression: "stdin/test_basic/console".to_string(),
            file: None,
            format: Format::Toml,
        };

        assert_eq!(
            generate_example(&opts, TransformInputsStrategy::Auto),
            Ok(indoc::indoc! {r#"data_dir = "/var/lib/vector/"

                [sources.source0]
                max_length = 102400
                type = "stdin"

                [sources.source0.decoding]
                codec = "bytes"

                [transforms.transform0]
                inputs = ["source0"]
                increase = 0.0
                suffix = ""
                type = "test_basic"

                [sinks.sink0]
                inputs = ["transform0"]
                target = "stdout"
                type = "console"

                [sinks.sink0.encoding]
                codec = "json"

                [sinks.sink0.encoding.json]
                pretty = false

                [sinks.sink0.healthcheck]
                enabled = true

                [sinks.sink0.buffer]
                type = "memory"
                max_events = 500
                when_full = "block"
            "#}
            .to_string())
        );

        opts.expression = "stdin|test_basic|console".to_string();
        assert_eq!(
            generate_example(&opts, TransformInputsStrategy::Auto),
            Ok(indoc::indoc! {r#"data_dir = "/var/lib/vector/"

                [sources.source0]
                max_length = 102400
                type = "stdin"

                [sources.source0.decoding]
                codec = "bytes"

                [transforms.transform0]
                inputs = ["source0"]
                increase = 0.0
                suffix = ""
                type = "test_basic"

                [sinks.sink0]
                inputs = ["transform0"]
                target = "stdout"
                type = "console"

                [sinks.sink0.encoding]
                codec = "json"

                [sinks.sink0.encoding.json]
                pretty = false

                [sinks.sink0.healthcheck]
                enabled = true

                [sinks.sink0.buffer]
                type = "memory"
                max_events = 500
                when_full = "block"
            "#}
            .to_string())
        );

        opts.expression = "stdin//console".to_string();
        assert_eq!(
            generate_example(&opts, TransformInputsStrategy::Auto),
            Ok(indoc::indoc! {r#"data_dir = "/var/lib/vector/"

                [sources.source0]
                max_length = 102400
                type = "stdin"

                [sources.source0.decoding]
                codec = "bytes"

                [sinks.sink0]
                inputs = ["source0"]
                target = "stdout"
                type = "console"

                [sinks.sink0.encoding]
                codec = "json"

                [sinks.sink0.encoding.json]
                pretty = false

                [sinks.sink0.healthcheck]
                enabled = true

                [sinks.sink0.buffer]
                type = "memory"
                max_events = 500
                when_full = "block"
            "#}
            .to_string())
        );

        opts.expression = "//console".to_string();
        assert_eq!(
            generate_example(&opts, TransformInputsStrategy::Auto),
            Ok(indoc::indoc! {r#"data_dir = "/var/lib/vector/"

                [sinks.sink0]
                inputs = ["component-id"]
                target = "stdout"
                type = "console"

                [sinks.sink0.encoding]
                codec = "json"

                [sinks.sink0.encoding.json]
                pretty = false

                [sinks.sink0.healthcheck]
                enabled = true

                [sinks.sink0.buffer]
                type = "memory"
                max_events = 500
                when_full = "block"
            "#}
            .to_string())
        );

        opts.expression = "/test_basic,test_basic,test_basic".to_string();
        assert_eq!(
            generate_example(&opts, TransformInputsStrategy::Auto),
            Ok(indoc::indoc! {r#"data_dir = "/var/lib/vector/"

                [transforms.transform0]
                inputs = []
                increase = 0.0
                suffix = ""
                type = "test_basic"

                [transforms.transform1]
                inputs = ["transform0"]
                increase = 0.0
                suffix = ""
                type = "test_basic"

                [transforms.transform2]
                inputs = ["transform1"]
                increase = 0.0
                suffix = ""
                type = "test_basic"
            "#}
            .to_string())
        );

        opts.fragment = true;
        opts.expression = "/test_basic,test_basic,test_basic".to_string();
        assert_eq!(
            generate_example(&opts, TransformInputsStrategy::Auto),
            Ok(indoc::indoc! {r#"
                [transforms.transform0]
                inputs = []
                increase = 0.0
                suffix = ""
                type = "test_basic"

                [transforms.transform1]
                inputs = ["transform0"]
                increase = 0.0
                suffix = ""
                type = "test_basic"

                [transforms.transform2]
                inputs = ["transform1"]
                increase = 0.0
                suffix = ""
                type = "test_basic"
            "#}
            .to_string())
        );
    }

    #[cfg(all(
        feature = "sources-demo_logs",
        feature = "transforms-remap",
        feature = "sinks-console"
    ))]
    #[test]
    fn generate_basic_yaml() {
        let opts = Opts {
            fragment: false,
            expression: "demo_logs/remap/console".to_string(),
            file: None,
            format: Format::Yaml,
        };

        assert_eq!(
            generate_example(&opts, TransformInputsStrategy::Auto).unwrap(),
            indoc::indoc! {r#"
            data_dir: /var/lib/vector/
            sources:
              source0:
                count: 9223372036854775807
                format: json
                interval: 1.0
                type: demo_logs
                decoding:
                  codec: bytes
                framing:
                  method: bytes
            transforms:
              transform0:
                inputs:
                - source0
                drop_on_abort: false
                drop_on_error: false
                metric_tag_values: single
                reroute_dropped: false
                runtime: ast
                type: remap
            sinks:
              sink0:
                inputs:
                - transform0
                target: stdout
                type: console
                encoding:
                  codec: json
                  json:
                    pretty: false
                healthcheck:
                  enabled: true
                  uri: null
                buffer:
                  type: memory
                  max_events: 500
                  when_full: block
            "#}
        );
    }

    #[cfg(all(
        feature = "sources-demo_logs",
        feature = "transforms-remap",
        feature = "sinks-console"
    ))]
    #[test]
    fn generate_basic_json() {
        let opts = Opts {
            fragment: false,
            expression: "demo_logs/remap/console".to_string(),
            file: None,
            format: Format::Json,
        };

        assert_eq!(
            generate_example(&opts, TransformInputsStrategy::Auto).unwrap(),
            indoc::indoc! {r#"
            {
              "data_dir": "/var/lib/vector/",
              "sources": {
                "source0": {
                  "count": 9223372036854775807,
                  "format": "json",
                  "interval": 1.0,
                  "type": "demo_logs",
                  "decoding": {
                    "codec": "bytes"
                  },
                  "framing": {
                    "method": "bytes"
                  }
                }
              },
              "transforms": {
                "transform0": {
                  "inputs": [
                    "source0"
                  ],
                  "drop_on_abort": false,
                  "drop_on_error": false,
                  "metric_tag_values": "single",
                  "reroute_dropped": false,
                  "runtime": "ast",
                  "type": "remap"
                }
              },
              "sinks": {
                "sink0": {
                  "inputs": [
                    "transform0"
                  ],
                  "target": "stdout",
                  "type": "console",
                  "encoding": {
                    "codec": "json",
                    "json": {
                      "pretty": false
                    }
                  },
                  "healthcheck": {
                    "enabled": true,
                    "uri": null
                  },
                  "buffer": {
                    "type": "memory",
                    "max_events": 500,
                    "when_full": "block"
                  }
                }
              }
            }"#}
        );
    }
}