terraform-wrapper 0.4.0

A type-safe Terraform CLI wrapper for Rust
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

use std::collections::HashMap;

use serde::{Deserialize, Serialize};
use serde_json::Value;

use crate::types::output::OutputValue;

/// State representation from `terraform show -json` (current state).
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct StateRepresentation {
    /// Schema format version.
    pub format_version: String,
    /// Terraform version that wrote the state.
    pub terraform_version: String,
    /// The state values.
    pub values: StateValues,
}

/// Top-level state values.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct StateValues {
    /// Output values.
    #[serde(default)]
    pub outputs: HashMap<String, OutputValue>,
    /// The root module.
    pub root_module: Module,
}

/// A module in the state or plan. Contains resources and child modules.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct Module {
    /// Resources in this module.
    #[serde(default)]
    pub resources: Vec<Resource>,
    /// Child modules.
    #[serde(default)]
    pub child_modules: Vec<ChildModule>,
}

/// A child module reference.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct ChildModule {
    /// Module address (e.g., "module.vpc").
    pub address: String,
    /// Resources in this child module.
    #[serde(default)]
    pub resources: Vec<Resource>,
    /// Nested child modules.
    #[serde(default)]
    pub child_modules: Vec<ChildModule>,
}

/// A resource in the state or plan.
#[derive(Debug, Clone, Deserialize, Serialize)]
pub struct Resource {
    /// Full address (e.g., "null_resource.example").
    pub address: String,
    /// Mode: "managed" or "data".
    pub mode: String,
    /// Resource type (e.g., "null_resource").
    #[serde(rename = "type")]
    pub resource_type: String,
    /// Resource name (e.g., "example").
    pub name: String,
    /// Provider name (e.g., "registry.terraform.io/hashicorp/null").
    pub provider_name: String,
    /// Schema version.
    pub schema_version: u32,
    /// Resource attribute values.
    #[serde(default)]
    pub values: Value,
    /// Which values are sensitive.
    #[serde(default)]
    pub sensitive_values: Value,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn deserialize_state() {
        let json = r#"{
            "format_version": "1.0",
            "terraform_version": "1.14.6",
            "values": {
                "outputs": {
                    "id": {
                        "sensitive": false,
                        "value": "123456",
                        "type": "string"
                    }
                },
                "root_module": {
                    "resources": [
                        {
                            "address": "null_resource.example",
                            "mode": "managed",
                            "type": "null_resource",
                            "name": "example",
                            "provider_name": "registry.terraform.io/hashicorp/null",
                            "schema_version": 0,
                            "values": {"id": "123456", "triggers": {"value": "hello"}},
                            "sensitive_values": {"triggers": {}}
                        }
                    ]
                }
            }
        }"#;
        let state: StateRepresentation = serde_json::from_str(json).unwrap();
        assert_eq!(state.format_version, "1.0");
        assert_eq!(state.values.outputs.len(), 1);
        assert_eq!(state.values.root_module.resources.len(), 1);
        assert_eq!(
            state.values.root_module.resources[0].address,
            "null_resource.example"
        );
        assert_eq!(state.values.root_module.resources[0].mode, "managed");
    }

    #[test]
    fn deserialize_state_no_outputs() {
        let json = r#"{
            "format_version": "1.0",
            "terraform_version": "1.14.6",
            "values": {
                "root_module": {
                    "resources": []
                }
            }
        }"#;
        let state: StateRepresentation = serde_json::from_str(json).unwrap();
        assert!(state.values.outputs.is_empty());
        assert!(state.values.root_module.resources.is_empty());
    }
}