terraform_wrapper/commands/
validate.rs

1use crate::Terraform;
2use crate::command::TerraformCommand;
3use crate::error::Result;
4use crate::exec;
5
6#[cfg(feature = "json")]
7use crate::types::validation::ValidationResult;
8
9/// Command for validating Terraform configuration.
10///
11/// Checks that the configuration is syntactically valid and internally
12/// consistent. Does not access any remote services (state, providers).
13///
14/// ```no_run
15/// # async fn example() -> terraform_wrapper::error::Result<()> {
16/// use terraform_wrapper::{Terraform, TerraformCommand};
17/// use terraform_wrapper::commands::validate::ValidateCommand;
18///
19/// let tf = Terraform::builder().working_dir("/tmp/infra").build()?;
20/// let result = ValidateCommand::new().execute(&tf).await?;
21/// # Ok(())
22/// # }
23/// ```
24#[derive(Debug, Clone)]
25pub struct ValidateCommand {
26    json: bool,
27    raw_args: Vec<String>,
28}
29
30impl Default for ValidateCommand {
31    fn default() -> Self {
32        Self {
33            json: true,
34            raw_args: Vec::new(),
35        }
36    }
37}
38
39impl ValidateCommand {
40    /// Create a new validate command (JSON output enabled by default).
41    #[must_use]
42    pub fn new() -> Self {
43        Self::default()
44    }
45
46    /// Disable JSON output.
47    #[must_use]
48    pub fn no_json(mut self) -> Self {
49        self.json = false;
50        self
51    }
52
53    /// Add a raw argument (escape hatch for unsupported options).
54    #[must_use]
55    pub fn arg(mut self, arg: impl Into<String>) -> Self {
56        self.raw_args.push(arg.into());
57        self
58    }
59}
60
61#[cfg(feature = "json")]
62impl TerraformCommand for ValidateCommand {
63    type Output = ValidationResult;
64
65    fn args(&self) -> Vec<String> {
66        let mut args = vec!["validate".to_string()];
67        if self.json {
68            args.push("-json".to_string());
69        }
70        args.extend(self.raw_args.clone());
71        args
72    }
73
74    async fn execute(&self, tf: &Terraform) -> Result<ValidationResult> {
75        // validate returns exit code 1 for invalid config, but with -json
76        // it still writes valid JSON to stdout. Accept both exit codes.
77        let output = exec::run_terraform_allow_exit_codes(tf, self.args(), &[0, 1]).await?;
78        serde_json::from_str(&output.stdout).map_err(|e| crate::error::Error::ParseError {
79            message: format!("failed to parse validate json: {e}"),
80        })
81    }
82}
83
84#[cfg(not(feature = "json"))]
85impl TerraformCommand for ValidateCommand {
86    type Output = exec::CommandOutput;
87
88    fn args(&self) -> Vec<String> {
89        let mut args = vec!["validate".to_string()];
90        if self.json {
91            args.push("-json".to_string());
92        }
93        args.extend(self.raw_args.clone());
94        args
95    }
96
97    async fn execute(&self, tf: &Terraform) -> Result<exec::CommandOutput> {
98        exec::run_terraform(tf, self.args()).await
99    }
100}
101
102#[cfg(test)]
103mod tests {
104    use super::*;
105
106    #[test]
107    fn default_args_include_json() {
108        let cmd = ValidateCommand::new();
109        assert_eq!(cmd.args(), vec!["validate", "-json"]);
110    }
111
112    #[test]
113    fn no_json_args() {
114        let cmd = ValidateCommand::new().no_json();
115        assert_eq!(cmd.args(), vec!["validate"]);
116    }
117
118    #[test]
119    fn raw_arg_escape_hatch() {
120        let cmd = ValidateCommand::new().arg("-test-directory=tests");
121        let args = cmd.args();
122        assert!(args.contains(&"-test-directory=tests".to_string()));
123    }
124}
terraform_wrapper/commands/validate.rs

terraform_wrapper/commands/
validate.rs
