rust-template-foundation 0.10.0

Shared infrastructure for projects spawned from rust-template.
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

//! Tests for `MergeConfig`'s `subcommand` field kind.
//!
//! These exercise the macro's generated `CliRaw` (clap parsing) and
//! `from_cli_and_file` (passthrough into the resolved `Config`).
//!
//! Each `MergeConfig` derive generates a `CliRaw`, `ConfigFileRaw`, and
//! `ConfigError` in its enclosing scope, so the two test fixtures live
//! in separate modules.

use clap::Parser;
use rust_template_foundation::logging::{LogFormat, LogLevel};
use rust_template_foundation::MergeConfig;

#[derive(Debug, Clone, clap::Args, PartialEq)]
struct PrintArgs {
  #[arg(long)]
  message: String,
}

#[derive(Debug, Clone, clap::Args, PartialEq)]
struct PlayArgs {
  #[arg(long)]
  track: String,
}

#[derive(Debug, Clone, clap::Subcommand, PartialEq)]
enum Commands {
  Print(PrintArgs),
  Play(PlayArgs),
  PlayContinuous(PlayArgs),
}

mod required_subcommand {
  use super::*;

  #[derive(Debug, Clone, MergeConfig)]
  #[merge_config(app_name = "subcommand-test")]
  pub struct Config {
    #[merge_config(common)]
    pub log_level: LogLevel,
    #[merge_config(common)]
    pub log_format: LogFormat,
    #[merge_config(default = "\"World\".to_string()")]
    pub name: String,
    #[merge_config(subcommand)]
    pub command: Commands,
  }

  #[test]
  fn parses_print_subcommand() {
    let cli =
      CliRaw::try_parse_from(["subcommand-test", "print", "--message", "hi"])
        .unwrap();
    let config = Config::from_cli_and_file(cli).unwrap();
    assert_eq!(
      config.command,
      Commands::Print(PrintArgs {
        message: "hi".to_string()
      }),
    );
    assert_eq!(config.name, "World");
  }

  #[test]
  fn parses_play_subcommand_with_top_level_flag() {
    let cli = CliRaw::try_parse_from([
      "subcommand-test",
      "--name",
      "Alice",
      "play",
      "--track",
      "song.mp3",
    ])
    .unwrap();
    let config = Config::from_cli_and_file(cli).unwrap();
    assert_eq!(config.name, "Alice");
    assert_eq!(
      config.command,
      Commands::Play(PlayArgs {
        track: "song.mp3".to_string()
      }),
    );
  }

  #[test]
  fn missing_subcommand_is_error() {
    // `command: Commands` (not `Option<Commands>`) makes the
    // subcommand required.
    let result = CliRaw::try_parse_from(["subcommand-test"]);
    assert!(result.is_err());
  }
}

mod optional_subcommand {
  use super::*;

  #[derive(Debug, Clone, MergeConfig)]
  #[merge_config(app_name = "subcommand-test-opt")]
  pub struct Config {
    #[merge_config(common)]
    pub log_level: LogLevel,
    #[merge_config(common)]
    pub log_format: LogFormat,
    #[merge_config(subcommand)]
    pub command: Option<Commands>,
  }

  #[test]
  fn absent() {
    let cli = CliRaw::try_parse_from(["subcommand-test-opt"]).unwrap();
    let config = Config::from_cli_and_file(cli).unwrap();
    assert_eq!(config.command, None);
  }

  #[test]
  fn present() {
    let cli = CliRaw::try_parse_from([
      "subcommand-test-opt",
      "print",
      "--message",
      "hello",
    ])
    .unwrap();
    let config = Config::from_cli_and_file(cli).unwrap();
    assert_eq!(
      config.command,
      Some(Commands::Print(PrintArgs {
        message: "hello".to_string()
      })),
    );
  }
}