combine metadata to single struct

Author: Steve Lee (POWERSHELL HE/HIM) (from Dev Box)

dsc_lib/src/configure/config_doc.rs

@@ -6,8 +6,6 @@ use serde::{Deserialize, Serialize};
 use serde_json::{Map, Value};
 use std::collections::HashMap;
 
-use super::config_result::ResultMetadata;
-
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
 pub enum ContextKind {
     Configuration,
@@ -22,18 +20,45 @@ pub enum SecurityContextKind {
 }
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
-pub struct MicrosoftDscMetadata {
-    #[serde(skip_serializing_if = "Option::is_none")]
-    pub context: Option<ContextKind>,
-    #[serde(rename = "requiredSecurityContext", skip_serializing_if = "Option::is_none")]
-    pub required_security_context: Option<SecurityContextKind>,
+pub enum Operation {
+    Get,
+    Set,
+    Test,
+    Export,
+}
+
+#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
+pub enum ExecutionKind {
+    Actual,
+    WhatIf,
 }
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
-#[serde(untagged)]
-pub enum MicrosoftMetadata {
-    DscInput(Metadata),
-    DscResult(ResultMetadata),
+pub struct MicrosoftDscMetadata {
+    /// Version of DSC
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub version: Option<String>,
+    /// The operation being performed
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub operation: Option<Operation>,
+    /// The type of execution
+    #[serde(rename = "executionType", skip_serializing_if = "Option::is_none")]
+    pub execution_type: Option<ExecutionKind>,
+    /// The start time of the configuration operation
+    #[serde(rename = "startDatetime", skip_serializing_if = "Option::is_none")]
+    pub start_datetime: Option<String>,
+    /// The end time of the configuration operation
+    #[serde(rename = "endDatetime", skip_serializing_if = "Option::is_none")]
+    pub end_datetime: Option<String>,
+    /// The duration of the configuration operation
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub duration: Option<String>,
+    /// The security context of the configuration operation, can be specified to be required
+    #[serde(rename = "securityContext", skip_serializing_if = "Option::is_none")]
+    pub security_context: Option<SecurityContextKind>,
+    /// Identifies if the operation is part of a configuration
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub context: Option<ContextKind>,
 }
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
@@ -54,7 +79,7 @@ pub struct Configuration {
     pub variables: Option<HashMap<String, Value>>,
     pub resources: Vec<Resource>,
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub metadata: Option<MicrosoftMetadata>,
+    pub metadata: Option<Metadata>,
 }
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]

dsc_lib/src/configure/config_result.rs

@@ -4,9 +4,7 @@
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 use crate::dscresources::invoke_result::{GetResult, SetResult, TestResult};
-use crate::configure::config_doc::Configuration;
-
-use super::config_doc::SecurityContextKind;
+use crate::configure::config_doc::{Configuration, Metadata};
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
 pub enum MessageLevel {
@@ -25,41 +23,6 @@ pub struct ResourceMessage {
     pub level: MessageLevel,
 }
 
-#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
-pub enum Operation {
-    Get,
-    Set,
-    Test,
-    Export,
-}
-
-#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
-pub enum ExecutionKind {
-    Actual,
-    WhatIf,
-}
-
-#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
-pub struct ResultMetadata {
-    #[serde(rename = "Microsoft.DSC")]
-    pub microsoft: MicrosoftDscResultMetadata,
-}
-
-#[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
-pub struct MicrosoftDscResultMetadata {
-    pub version: String,
-    pub operation: Operation,
-    #[serde(rename = "executionType")]
-    pub execution_type: ExecutionKind,
-    #[serde(rename = "startDatetime")]
-    pub start_datetime: String,
-    #[serde(rename = "endDatetime")]
-    pub end_datetime: String,
-    pub duration: String,
-    #[serde(rename = "securityContext")]
-    pub security_context: SecurityContextKind,
-}
-
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
 #[serde(deny_unknown_fields)]
 pub struct ResourceGetResult {
@@ -82,7 +45,7 @@ impl From<ResourceTestResult> for ResourceGetResult {
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
 #[serde(deny_unknown_fields)]
 pub struct ConfigurationGetResult {
-    pub metadata: Option<ResultMetadata>,
+    pub metadata: Option<Metadata>,
     pub results: Vec<ResourceGetResult>,
     pub messages: Vec<ResourceMessage>,
     #[serde(rename = "hadErrors")]
@@ -155,7 +118,7 @@ impl Default for GroupResourceSetResult {
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
 #[serde(deny_unknown_fields)]
 pub struct ConfigurationSetResult {
-    pub metadata: Option<ResultMetadata>,
+    pub metadata: Option<Metadata>,
     pub results: Vec<ResourceSetResult>,
     pub messages: Vec<ResourceMessage>,
     #[serde(rename = "hadErrors")]
@@ -213,7 +176,7 @@ impl Default for GroupResourceTestResult {
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
 #[serde(deny_unknown_fields)]
 pub struct ConfigurationTestResult {
-    pub metadata: Option<ResultMetadata>,
+    pub metadata: Option<Metadata>,
     pub results: Vec<ResourceTestResult>,
     pub messages: Vec<ResourceMessage>,
     #[serde(rename = "hadErrors")]
@@ -241,7 +204,7 @@ impl Default for ConfigurationTestResult {
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
 #[serde(deny_unknown_fields)]
 pub struct ConfigurationExportResult {
-    pub metadata: Option<ResultMetadata>,
+    pub metadata: Option<Metadata>,
     pub result: Option<Configuration>,
     pub messages: Vec<ResourceMessage>,
     #[serde(rename = "hadErrors")]

dsc_lib/src/configure/context.rs

@@ -2,7 +2,7 @@
 // Licensed under the MIT License.
 
 use chrono::{DateTime, Local};
-use crate::configure::ExecutionKind;
+use crate::configure::config_doc::ExecutionKind;
 use security_context_lib::{get_security_context, SecurityContext};
 use serde_json::Value;
 use std::collections::HashMap;

dsc_lib/src/configure/mod.rs

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-use crate::configure::config_doc::{MicrosoftMetadata, MicrosoftMetadata::DscInput};
+use crate::configure::config_doc::Metadata;
 use crate::configure::parameters::Input;
 use crate::dscerror::DscError;
 use crate::dscresources::dscresource::get_diff;
@@ -12,9 +12,9 @@ use crate::DscResource;
 use crate::discovery::Discovery;
 use crate::parser::Statement;
 use self::context::Context;
-use self::config_doc::{Configuration, DataType, SecurityContextKind};
+use self::config_doc::{Configuration, DataType, MicrosoftDscMetadata, Operation, SecurityContextKind};
 use self::depends_on::get_resource_invocation_order;
-use self::config_result::{ConfigurationExportResult, ConfigurationGetResult, ConfigurationSetResult, ConfigurationTestResult, ExecutionKind, MicrosoftDscResultMetadata, Operation, ResultMetadata};
+use self::config_result::{ConfigurationExportResult, ConfigurationGetResult, ConfigurationSetResult, ConfigurationTestResult};
 use self::contraints::{check_length, check_number_limits, check_allowed_values};
 use indicatif::ProgressStyle;
 use security_context_lib::{SecurityContext, get_security_context};
@@ -165,14 +165,14 @@ fn add_metadata(kind: &Kind, mut properties: Option<Map<String, Value>> ) -> Res
     Ok(serde_json::to_string(&properties)?)
 }
 
-fn check_security_context(metadata: &Option<MicrosoftMetadata>) -> Result<(), DscError> {
+fn check_security_context(metadata: &Option<Metadata>) -> Result<(), DscError> {
     if metadata.is_none() {
         return Ok(());
     }
 
-    if let Some(DscInput(metadata)) = &metadata {
+    if let Some(metadata) = &metadata {
         if let Some(microsoft_dsc) = &metadata.microsoft {
-            if let Some(required_security_context) = &microsoft_dsc.required_security_context {
+            if let Some(required_security_context) = &microsoft_dsc.security_context {
                 match required_security_context {
                     SecurityContextKind::Current => {
                         // no check needed
@@ -432,11 +432,7 @@ impl Configurator {
             add_resource_export_results_to_configuration(dsc_resource, Some(dsc_resource), &mut conf, input.as_str())?;
         }
 
-        conf.metadata = Some(
-            MicrosoftMetadata::DscResult(
-                self.get_result_metadata(Operation::Export)
-            )
-        );
+        conf.metadata = Some(self.get_result_metadata(Operation::Export));
         result.result = Some(conf);
         std::mem::drop(pb_span_enter);
         std::mem::drop(pb_span);
@@ -511,18 +507,21 @@ impl Configurator {
         Ok(())
     }
 
-    fn get_result_metadata(&self, operation: Operation) -> ResultMetadata {
+    fn get_result_metadata(&self, operation: Operation) -> Metadata {
         let end_datetime = chrono::Local::now();
-        ResultMetadata {
-            microsoft: MicrosoftDscResultMetadata {
-                version: env!("CARGO_PKG_VERSION").to_string(),
-                operation,
-                execution_type: self.context.execution_type.clone(),
-                start_datetime: self.context.start_datetime.to_rfc3339(),
-                end_datetime: end_datetime.to_rfc3339(),
-                duration: end_datetime.signed_duration_since(self.context.start_datetime).to_string(),
-                security_context: self.context.security_context.clone(),
-            }
+        Metadata {
+            microsoft: Some(
+                MicrosoftDscMetadata {
+                    context: None,
+                    version: Some(env!("CARGO_PKG_VERSION").to_string()),
+                    operation: Some(operation),
+                    execution_type: Some(self.context.execution_type.clone()),
+                    start_datetime: Some(self.context.start_datetime.to_rfc3339()),
+                    end_datetime: Some(end_datetime.to_rfc3339()),
+                    duration: Some(end_datetime.signed_duration_since(self.context.start_datetime).to_string()),
+                    security_context: Some(self.context.security_context.clone()),
+                }
+            )
         }
     }