cloud_terrastodon_hcl 0.34.0

Helpers for manipulating TerraStorodon HCL files for the Cloud Terrastodon project
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

use crate::reflow::HclReflower;
use cloud_terrastodon_azure::prelude::PrincipalCollection;
use cloud_terrastodon_azure::prelude::PrincipalId;
use hcl::edit::Decorate;
use hcl::edit::RawString;
use hcl::edit::expr::Expression;
use hcl::edit::structure::Body;
use hcl::edit::visit_mut::VisitMut;
use hcl::edit::visit_mut::visit_expr_mut;
use std::collections::HashMap;
use std::ops::Deref;
use std::path::PathBuf;
use std::str::FromStr;

/// Prefix any hardcoded principal IDs with comments indicating the principal type and name.
/// Prefix instead of suffix to enable sorting by principal name in editors.
pub struct ReflowPrincipalIdComments {
    principals: PrincipalCollection,
}
impl ReflowPrincipalIdComments {
    pub fn new(principals: PrincipalCollection) -> Self {
        Self { principals }
    }
}
#[async_trait::async_trait]
impl HclReflower for ReflowPrincipalIdComments {
    async fn reflow(
        &mut self,
        hcl: HashMap<PathBuf, Body>,
    ) -> eyre::Result<HashMap<PathBuf, Body>> {
        let mut reflowed = HashMap::new();
        for (path, mut body) in hcl {
            self.visit_body_mut(&mut body);
            reflowed.insert(path, body);
        }
        Ok(reflowed)
    }
}
impl VisitMut for ReflowPrincipalIdComments {
    fn visit_expr_mut(&mut self, node: &mut Expression) {
        // Must be a principal id
        let Some(Ok(principal_id)) = node.as_str().map(PrincipalId::from_str) else {
            return visit_expr_mut(self, node);
        };

        // Must have a matching principal
        let Some(principal) = self.principals.get(&principal_id) else {
            return visit_expr_mut(self, node);
        };

        // Update the comment, preserve existing leading whitespace while ensuring idempotent behaviour
        let mut new_prefix = format!("/* ({}) {} */", principal.kind(), principal.display_name(),);
        let decor = node.decor_mut();
        if let Some(existing_prefix) = decor.prefix().map(RawString::deref) {
            if existing_prefix.contains(&new_prefix) {
                // do nothing, already present
            } else {
                new_prefix = format!("{}{}", existing_prefix, new_prefix);
                decor.set_prefix(new_prefix);
            }
        } else {
            decor.set_prefix(new_prefix);
        }
    }
}

#[cfg(test)]
mod test {
    use crate::reflow::HclReflower;
    use arbitrary::Arbitrary;
    use arbitrary::Unstructured;
    use cloud_terrastodon_azure::prelude::EntraUser;
    use cloud_terrastodon_azure::prelude::Principal;
    use cloud_terrastodon_azure::prelude::PrincipalCollection;
    use hcl::edit::structure::Body;
    use indoc::formatdoc;
    use rand::Rng;
    use std::path::PathBuf;

    #[tokio::test]
    pub async fn it_works() -> eyre::Result<()> {
        // Create random user principal
        let mut raw = [0u8; 128];
        rand::rng().fill(&mut raw);
        let mut noise = Unstructured::new(&raw);
        let mut user = EntraUser::arbitrary(&mut noise)?;
        user.user_principal_name = "first.last@agr.gc.ca".to_string();
        let user_id = user.id;

        // Create principal collection
        let principal_collection = PrincipalCollection::new(vec![Principal::User(Box::new(user))]);

        // Create reflower
        let mut reflower = super::ReflowPrincipalIdComments::new(principal_collection);

        // Create body
        let body = formatdoc! {
        r#"
            resource "role_assignment" "bruh" {{
                principal_id = "{user_id}"
            }}
        "#}
        .parse::<Body>()?;

        let hcl = [(PathBuf::from("a.tf"), body)].into();

        // Reflow body
        let mut hcl = reflower.reflow(hcl).await?;
        assert!(hcl.len() == 1);
        let body = hcl
            .remove(&PathBuf::from("a.tf"))
            .ok_or_else(|| eyre::eyre!("Missing body"))?;

        let expected = formatdoc! {
        r#"
            resource "role_assignment" "bruh" {{
                principal_id = /* (User) first.last@agr.gc.ca */"{user_id}"
            }}
        "#
        };

        // println!("reflowed body:\n{}", body.to_string());
        assert_eq!(body.to_string(), expected);

        Ok(())
    }

    #[tokio::test]
    pub async fn it_works_array1() -> eyre::Result<()> {
        // Create random user principal
        let mut raw = [0u8; 128];
        rand::rng().fill(&mut raw);
        let mut noise = Unstructured::new(&raw);
        let mut user1 = EntraUser::arbitrary(&mut noise)?;
        user1.user_principal_name = "first.last@agr.gc.ca".to_string();
        let user_id1 = user1.id;

        let mut user2 = EntraUser::arbitrary(&mut noise)?;
        user2.user_principal_name = "hot.rod@agr.gc.ca".to_string();
        let user_id2 = user2.id;

        // Create principal collection
        let principal_collection = PrincipalCollection::new(vec![
            Principal::User(Box::new(user1)),
            Principal::User(Box::new(user2)),
        ]);

        // Create reflower
        let mut reflower = super::ReflowPrincipalIdComments::new(principal_collection);

        // Create body
        let body = formatdoc! {
        r#"
            resource "azuread_group" "bruh" {{
                members = ["{user_id1}", "{user_id2}"]
            }}
        "#}
        .parse::<Body>()?;

        let hcl = [(PathBuf::from("a.tf"), body)].into();

        // Reflow body
        let mut hcl = reflower.reflow(hcl).await?;
        assert!(hcl.len() == 1);
        let body = hcl
            .remove(&PathBuf::from("a.tf"))
            .ok_or_else(|| eyre::eyre!("Missing body"))?;

        let expected = formatdoc! {
        r#"
            resource "azuread_group" "bruh" {{
                members = [/* (User) first.last@agr.gc.ca */"{user_id1}", /* (User) hot.rod@agr.gc.ca */"{user_id2}"]
            }}
        "#
        };

        // println!("reflowed body:\n{}", body.to_string());
        assert_eq!(body.to_string(), expected);

        Ok(())
    }

    #[tokio::test]
    pub async fn it_works_array2() -> eyre::Result<()> {
        // Create random user principal
        let mut raw = [0u8; 128];
        rand::rng().fill(&mut raw);
        let mut noise = Unstructured::new(&raw);
        let mut user1 = EntraUser::arbitrary(&mut noise)?;
        user1.user_principal_name = "first.last@agr.gc.ca".to_string();
        let user_id1 = user1.id;

        let mut user2 = EntraUser::arbitrary(&mut noise)?;
        user2.user_principal_name = "hot.rod@agr.gc.ca".to_string();
        let user_id2 = user2.id;

        // Create principal collection
        let principal_collection = PrincipalCollection::new(vec![
            Principal::User(Box::new(user1)),
            Principal::User(Box::new(user2)),
        ]);

        // Create reflower
        let mut reflower = super::ReflowPrincipalIdComments::new(principal_collection);

        // Create body
        let body = formatdoc! {
        r#"
            resource "azuread_group" "bruh" {{
                members = [
                    "{user_id1}",
                    "{user_id2}",
                ]
            }}
        "#}
        .parse::<Body>()?;

        let hcl = [(PathBuf::from("a.tf"), body)].into();

        // Reflow body
        let mut hcl = reflower.reflow(hcl).await?;
        assert!(hcl.len() == 1);
        let body = hcl
            .remove(&PathBuf::from("a.tf"))
            .ok_or_else(|| eyre::eyre!("Missing body"))?;

        let expected = formatdoc! {
        r#"
            resource "azuread_group" "bruh" {{
                members = [
                    /* (User) first.last@agr.gc.ca */"{user_id1}",
                    /* (User) hot.rod@agr.gc.ca */"{user_id2}",
                ]
            }}
        "#
        };

        // println!("reflowed body:\n{}", body.to_string());
        assert_eq!(body.to_string(), expected);

        Ok(())
    }

    #[tokio::test]
    pub async fn it_works_idempotent() -> eyre::Result<()> {
        // Create random user principal
        let mut raw = [0u8; 128];
        rand::rng().fill(&mut raw);
        let mut noise = Unstructured::new(&raw);
        let mut user = EntraUser::arbitrary(&mut noise)?;
        user.user_principal_name = "first.last@agr.gc.ca".to_string();
        let user_id = user.id;

        // Create principal collection
        let principal_collection = PrincipalCollection::new(vec![Principal::User(Box::new(user))]);

        // Create reflower
        let mut reflower = super::ReflowPrincipalIdComments::new(principal_collection);

        // Create body
        let body = formatdoc! {
        r#"
            resource "role_assignment" "bruh" {{
                principal_id = /* (User) first.last@agr.gc.ca */ "{user_id}"
            }}
        "#}
        .parse::<Body>()?;

        let hcl = [(PathBuf::from("a.tf"), body)].into();

        // Reflow body
        let mut hcl = reflower.reflow(hcl).await?;
        assert!(hcl.len() == 1);
        let body = hcl
            .remove(&PathBuf::from("a.tf"))
            .ok_or_else(|| eyre::eyre!("Missing body"))?;

        let expected = formatdoc! {
        r#"
            resource "role_assignment" "bruh" {{
                principal_id = /* (User) first.last@agr.gc.ca */ "{user_id}"
            }}
        "#
        };

        // println!("reflowed body:\n{}", body.to_string());
        assert_eq!(body.to_string(), expected);

        Ok(())
    }

    #[tokio::test]
    pub async fn it_works_idempotent2() -> eyre::Result<()> {
        // Create random user principal
        let mut raw = [0u8; 128];
        rand::rng().fill(&mut raw);
        let mut noise = Unstructured::new(&raw);
        let mut user1 = EntraUser::arbitrary(&mut noise)?;
        user1.user_principal_name = "first.last@agr.gc.ca".to_string();
        let user_id1 = user1.id;

        let mut user2 = EntraUser::arbitrary(&mut noise)?;
        user2.user_principal_name = "hot.rod@agr.gc.ca".to_string();
        let user_id2 = user2.id;

        // Create principal collection
        let principal_collection = PrincipalCollection::new(vec![
            Principal::User(Box::new(user1)),
            Principal::User(Box::new(user2)),
        ]);

        // Create reflower
        let mut reflower = super::ReflowPrincipalIdComments::new(principal_collection);

        // Create body
        let body = formatdoc! {
        r#"
            resource "azuread_group" "bruh" {{
                members = [
                    /* (User) first.last@agr.gc.ca */
                    "{user_id1}",
                    /* (User) hot.rod@agr.gc.ca */
                    "{user_id2}",
                ]
            }}
        "#}
        .parse::<Body>()?;

        let hcl = [(PathBuf::from("a.tf"), body)].into();

        // Reflow body
        let mut hcl = reflower.reflow(hcl).await?;
        assert!(hcl.len() == 1);
        let body = hcl
            .remove(&PathBuf::from("a.tf"))
            .ok_or_else(|| eyre::eyre!("Missing body"))?;

        let expected = formatdoc! {
        r#"
            resource "azuread_group" "bruh" {{
                members = [
                    /* (User) first.last@agr.gc.ca */
                    "{user_id1}",
                    /* (User) hot.rod@agr.gc.ca */
                    "{user_id2}",
                ]
            }}
        "#
        };

        // println!("reflowed body:\n{}", body.to_string());
        assert_eq!(body.to_string(), expected);

        Ok(())
    }
}