csm-rs 0.89.1

A library for Shasta
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
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
use std::collections::HashMap;

use crate::{
  commands::apply_hw_cluster_pin::utils::{
    calculate_hsm_hw_component_summary, get_hsm_node_hw_component_counter,
    resolve_hw_description_to_xnames,
  },
  error::Error,
  hsm::{self, group::types::Group},
};

pub async fn exec(
  shasta_token: &str,
  shasta_base_url: &str,
  shasta_root_cert: &[u8],
  target_hsm_group_name: &str,
  parent_hsm_group_name: &str,
  pattern: &str,
  nodryrun: bool,
  create_target_hsm_group: bool,
  delete_empty_parent_hsm_group: bool,
) -> Result<(), Error> {
  // *********************************************************************************************************
  // PREPREQUISITES - FORMAT USER INPUT

  let pattern = format!("{}:{}", target_hsm_group_name, pattern);

  log::info!("pattern: {}", pattern);

  // lcm -> used to normalize and quantify memory capacity
  let mem_lcm = 16384; // 1024 * 16

  // Normalize text in lowercase and separate each HSM group hw inventory pattern
  let pattern_lowercase = pattern.to_lowercase();

  let (target_hsm_group_name, pattern_hw_component) =
    pattern_lowercase.split_once(':').unwrap();

  let pattern_element_vec: Vec<&str> =
    pattern_hw_component.split(':').collect();

  let mut user_defined_target_hsm_hw_component_count_hashmap: HashMap<
    String,
    usize,
  > = HashMap::new();

  // Check user input is correct
  for hw_component_counter in pattern_element_vec.chunks(2) {
    if hw_component_counter[0].parse::<String>().is_ok()
      && hw_component_counter[1].parse::<usize>().is_ok()
    {
      user_defined_target_hsm_hw_component_count_hashmap.insert(
        hw_component_counter[0].parse::<String>().unwrap(),
        hw_component_counter[1].parse::<usize>().unwrap(),
      );
    } else {
      return Err(Error::Message("Error in pattern. Please make sure to follow <hsm name>:<hw component>:<counter>:... eg tasna:a100:4:epyc:10:instinct:8".to_string()));
      /* log::error!("Error in pattern. Please make sure to follow <hsm name>:<hw component>:<counter>:... eg <tasna>:a100:4:epyc:10:instinct:8");
      std::process::exit(1); */
    }
  }

  log::info!(
    "User defined hw components with counters: {:?}",
    user_defined_target_hsm_hw_component_count_hashmap
  );

  let mut user_defined_target_hsm_hw_component_vec: Vec<String> =
    user_defined_target_hsm_hw_component_count_hashmap
      .keys()
      .cloned()
      .collect();

  user_defined_target_hsm_hw_component_vec.sort();

  // *********************************************************************************************************
  // PREPREQUISITES - GET DATA - TARGET HSM

  match hsm::group::http_client::get(
        shasta_token,
        shasta_base_url,
        shasta_root_cert,
        Some(&[target_hsm_group_name]),
        None
    ).await
    /* match hsm::group::http_client::get(
        shasta_token,
        shasta_base_url,
        shasta_root_cert,
        Some(&target_hsm_group_name.to_string()),
    )
    .await */
    {
        Ok(_) => log::debug!("Target HSM group {} exists, good.", target_hsm_group_name),
        Err(_) => {
            if create_target_hsm_group {
                log::info!("Target HSM group {} does not exist, but the option to create the group has been selected, creating it now.", target_hsm_group_name.to_string());
                if nodryrun {
                    let group = Group{
                        label: target_hsm_group_name.to_string(),
                        description: None,
                        tags: None,
                        members: None,
                        exclusive_group: Some("false".to_string())
                    };

                    let _ = hsm::group::http_client::post(
                        shasta_token,
                        shasta_base_url,
                        shasta_root_cert,
                        group,
                    )
                    .await?;
                    /* hsm::group::http_client::create_new_hsm_group(
                        shasta_token,
                        shasta_base_url,
                        shasta_root_cert,
                        target_hsm_group_name,
                        &[],
                        "false",
                        "",
                        &[],
                    )
                    .await
                    .expect("Unable to create new target HSM group"); */
                } else {
                    return Err(Error::Message("Dryrun selected, cannot create the new group and continue.".to_string()));
                    /* log::error!("Dryrun selected, cannot create the new group and continue.");
                    std::process::exit(1); */
                }
            } else {
                return Err(Error::Message(format!("Target HSM group {} does not exist, but the option to create the group was NOT specificied, cannot continue.", target_hsm_group_name.to_string())));
                /* log::error!("Target HSM group {} does not exist, but the option to create the group was NOT specificied, cannot continue.", target_hsm_group_name.to_string());
                std::process::exit(1); */
            }
        }
    };

  // Get target HSM group members
  let target_hsm_group_member_vec: Vec<String> =
    hsm::group::utils::get_member_vec_from_hsm_name_vec(
      shasta_token,
      shasta_base_url,
      shasta_root_cert,
      &[target_hsm_group_name],
    )
    .await?;
  /* hsm::group::utils::get_member_vec_from_hsm_group_name(
      shasta_token,
      shasta_base_url,
      shasta_root_cert,
      target_hsm_group_name,
  )
  .await; */

  // Get HSM hw component counters for target HSM
  let mut target_hsm_node_hw_component_count_vec: Vec<(
    String,
    HashMap<String, usize>,
  )> = get_hsm_node_hw_component_counter(
    shasta_token,
    shasta_base_url,
    shasta_root_cert,
    &user_defined_target_hsm_hw_component_vec,
    &target_hsm_group_member_vec,
    mem_lcm,
  )
  .await;

  // Sort nodes hw counters by node name
  target_hsm_node_hw_component_count_vec.sort_by_key(
    |target_hsm_group_hw_component| target_hsm_group_hw_component.0.clone(),
  );

  // Calculate hw component counters (summary) across all node within the HSM group
  let target_hsm_hw_component_summary_hashmap: HashMap<String, usize> =
    calculate_hsm_hw_component_summary(&target_hsm_node_hw_component_count_vec);

  log::info!(
    "HSM group '{}' hw component summary: {:?}",
    target_hsm_group_name,
    target_hsm_hw_component_summary_hashmap
  );

  // *********************************************************************************************************
  // PREPREQUISITES - GET DATA - PARENT HSM

  // Get target HSM group members
  let parent_hsm_group_member_vec: Vec<String> = /* get_member_vec_from_group_name_vec(shasta_token, vec![parent_hsm_group_name.to_string()])
        .await
        .unwrap(); */
    hsm::group::utils::get_member_vec_from_hsm_name_vec(
        shasta_token,
        shasta_base_url,
        shasta_root_cert,
            &[parent_hsm_group_name],
        )
        .await?;

  /* let parent_hsm_group_member_vec: Vec<String> =
  hsm::group::utils::get_member_vec_from_hsm_group_name(
      shasta_token,
      shasta_base_url,
      shasta_root_cert,
      parent_hsm_group_name,
  )
  .await; */

  // Get HSM hw component counters for parent HSM
  let mut parent_hsm_node_hw_component_count_vec: Vec<(
    String,
    HashMap<String, usize>,
  )> = get_hsm_node_hw_component_counter(
    shasta_token,
    shasta_base_url,
    shasta_root_cert,
    &user_defined_target_hsm_hw_component_vec,
    &parent_hsm_group_member_vec,
    mem_lcm,
  )
  .await;

  // Sort nodes hw counters by node name
  parent_hsm_node_hw_component_count_vec.sort_by_key(
    |parent_hsm_group_hw_component| parent_hsm_group_hw_component.0.clone(),
  );

  // *********************************************************************************************************
  // VALIDATE USER INPUT - CHECK HARDWARE REQUIREMENTS REQUESTED BY USER CAN BE FULFILLED
  // CHECK USER HAS ACCESS TO REQUESTED HW COMPONENTS
  // CHECK USER HAS ACCESS TO ENOUGH QUANTITY OF HW RESOURCES REQUESTED

  let mut combined_target_parent_hsm_node_hw_component_count_vec =
    parent_hsm_node_hw_component_count_vec.clone();

  for elem in &target_hsm_node_hw_component_count_vec {
    if !parent_hsm_node_hw_component_count_vec
      .iter()
      .any(|(xname, _)| xname.eq(&elem.0))
    {
      combined_target_parent_hsm_node_hw_component_count_vec.push(elem.clone());
    }
  }

  let combined_target_parent_hsm_hw_component_summary_hashmap =
    calculate_hsm_hw_component_summary(
      &combined_target_parent_hsm_node_hw_component_count_vec,
    );

  for (hw_component, qty) in &user_defined_target_hsm_hw_component_count_hashmap
  {
    if combined_target_parent_hsm_hw_component_summary_hashmap
      .get(hw_component)
      .is_some_and(|value| value >= qty)
    {
      // We are ok, user has access to enough resources to fullfill its request
    } else {
      // There are not enough resources to fulfill the user request
      return Err(Error::Message(
        "There are not enough resources to fulfill user request.".to_string(),
      ));
      /* eprintln!("ERROR - there are not enough resources to fulfill user request.");
      std::process::exit(1); */
    }
  }

  // *********************************************************************************************************
  // CONVERT THE HARDWARE DESCRIPTION INTO A SET OF NODES IN TARGET HSM

  let (
    target_hsm_node_hw_component_count_vec,
    parent_hsm_node_hw_component_count_vec,
  ) = resolve_hw_description_to_xnames(
    target_hsm_node_hw_component_count_vec,
    parent_hsm_node_hw_component_count_vec,
    user_defined_target_hsm_hw_component_count_hashmap,
  )?;

  // Calculate hw component counters (summary) across all node within the HSM group
  let target_hsm_hw_component_summary_hashmap =
    calculate_hsm_hw_component_summary(&target_hsm_node_hw_component_count_vec);

  // Calculate hw component counters (summary) across all node within the HSM group
  let parent_hsm_hw_component_summary_hashmap =
    calculate_hsm_hw_component_summary(&parent_hsm_node_hw_component_count_vec);

  let target_hsm_node_vec = target_hsm_node_hw_component_count_vec
    .into_iter()
    .map(|(xname, _)| xname)
    .collect::<Vec<String>>();

  let parent_hsm_node_vec = parent_hsm_node_hw_component_count_vec
    .into_iter()
    .map(|(xname, _)| xname)
    .collect::<Vec<String>>();

  // *********************************************************************************************************
  // UPDATE TARGET HSM GROUP IN CSM
  log::info!(
    "Updating target HSM group '{}' members",
    target_hsm_group_name
  );
  if !nodryrun {
    log::info!("Dry run enabled, not modifying the HSM groups on the system.");
  } else {
    // The target HSM group will never be empty, the way the pattern works it'll always
    // contain at least one node, so there is no need to add code to delete it if it's empty.
    /* let _ = backend
    .update_group_members(
        shasta_token,
        target_hsm_group_name,
        &target_hsm_group_member_vec,
        &target_hsm_node_vec,
    )
    .await; */
    let _ = hsm::group::utils::update_hsm_group_members(
      shasta_token,
      shasta_base_url,
      shasta_root_cert,
      target_hsm_group_name,
      &target_hsm_group_member_vec
        .iter()
        .map(String::as_str)
        .collect::<Vec<&str>>(),
      &target_hsm_node_vec
        .iter()
        .map(String::as_str)
        .collect::<Vec<&str>>(),
    )
    .await;
  }

  // *********************************************************************************************************
  // UPDATE PARENT GROUP IN CSM
  log::info!(
    "Updating parent HSM group '{}' members",
    parent_hsm_group_name
  );
  if !nodryrun {
    log::info!("Dry run enabled, not modifying the HSM groups on the system.");
  } else {
    // The parent group might be out of resources after applying this, so it's safe to check
    // if there are still nodes there and, delete it after moving out the resources.
    let parent_group_will_be_empty =
      &target_hsm_group_member_vec.len() == &parent_hsm_group_member_vec.len();
    /* let _ = backend
    .update_group_members(
        shasta_token,
        parent_hsm_group_name,
        &parent_hsm_group_member_vec,
        &parent_hsm_node_vec,
    )
    .await; */
    let _ = hsm::group::utils::update_hsm_group_members(
      shasta_token,
      shasta_base_url,
      shasta_root_cert,
      parent_hsm_group_name,
      &parent_hsm_group_member_vec
        .iter()
        .map(String::as_str)
        .collect::<Vec<&str>>(),
      &parent_hsm_node_vec
        .iter()
        .map(String::as_str)
        .collect::<Vec<&str>>(),
    )
    .await;
    if parent_group_will_be_empty {
      if delete_empty_parent_hsm_group {
        log::info!("Parent HSM group {} is now empty and the option to delete empty groups has been selected, removing it.",parent_hsm_group_name);
        // match backend.delete_group(shasta_token, parent_hsm_group_name).await {
        match hsm::group::http_client::delete_group(shasta_token,
                                                                      shasta_base_url,
                                                                      shasta_root_cert,
                                                                      &parent_hsm_group_name.to_string())
                    .await {
                    Ok(_) => log::info!("HSM group removed successfully."),
                    Err(e2) => log::debug!("Error removing the HSM group. This always fails, ignore please. Reported: {}", e2)
                };
      } else {
        log::debug!("Parent HSM group {} is now empty and the option to delete empty groups has NOT been selected, will not remove it.",parent_hsm_group_name)
      }
    }
  }
  // *********************************************************************************************************
  // RETURN VALUES

  // *********************************************************************************************************
  // PRINT SOLUTIONS

  // Print target HSM data
  log::info!(
    "HSM '{}' hw component summary: {:?}",
    target_hsm_group_name,
    target_hsm_hw_component_summary_hashmap
  );

  let target_hsm_group_value = serde_json::json!({
      "label": target_hsm_group_name,
      "decription": "",
      "members": target_hsm_node_vec,
      "tags": []
  });

  println!(
    "{}",
    serde_json::to_string_pretty(&target_hsm_group_value).unwrap()
  );

  // Print parent HSM data
  log::info!(
    "HSM '{}' hw component summary: {:?}",
    parent_hsm_group_name,
    parent_hsm_hw_component_summary_hashmap
  );

  let parent_hsm_group_value = serde_json::json!({
      "label": parent_hsm_group_name,
      "decription": "",
      "members": parent_hsm_node_vec,
      "tags": []
  });

  println!(
    "{}",
    serde_json::to_string_pretty(&parent_hsm_group_value).unwrap()
  );

  Ok(())
}