Merge pull request #1031 from SteveL-MSFT/not-parse-again

Fix no parsing expressions again when passed to an adapted resource

Author: SteveL-MSFT

dsc_lib/locales/en-us.toml

@@ -442,6 +442,7 @@ failedToParseEscapedStringLiteral = "Unable to parse escaped string literal"
 parsingEscapedStringLiteral = "Parsing escaped string literal: %{value}"
 parsingExpression = "Parsing expression"
 unknownExpressionType = "Unknown expression type: %{kind}"
+skippingExpressionProcessing = "Skipping expression processing"
 
 [dscerror]
 adapterNotFound = "Adapter not found"

dsc_lib/src/configure/context.rs

@@ -19,6 +19,7 @@ pub struct Context {
     pub variables: Map<String, Value>,
     pub start_datetime: DateTime<Local>,
     pub restart_required: Option<Vec<RestartRequired>>,
+    pub process_expressions: bool,
 }
 
 impl Context {
@@ -37,6 +38,7 @@ impl Context {
             variables: Map::new(),
             start_datetime: chrono::Local::now(),
             restart_required: None,
+            process_expressions: true,
         }
     }
 }

dsc_lib/src/dscresources/dscresource.rs

@@ -114,7 +114,9 @@ impl DscResource {
         };
         configuration.resources.push(adapter_resource);
         let config_json = serde_json::to_string(&configuration)?;
-        let configurator = Configurator::new(&config_json, crate::progress::ProgressFormat::None)?;
+        let mut configurator = Configurator::new(&config_json, crate::progress::ProgressFormat::None)?;
+        // don't process expressions again as they would have already been processed before being passed to the adapter
+        configurator.context.process_expressions = false;
         Ok(configurator)
     }
 }

dsc_lib/src/functions/equals.rs

@@ -49,7 +49,7 @@ mod tests {
     #[test]
     fn int_notequal() {
         let mut parser = Statement::new().unwrap();
-        let result = parser.parse_and_execute("[equals(1,2]", &Context::new()).unwrap();
+        let result = parser.parse_and_execute("[equals(1,2)]", &Context::new()).unwrap();
         assert_eq!(result, Value::Bool(false));
     }
 

dsc_lib/src/functions/less.rs

@@ -82,7 +82,7 @@ mod tests {
     #[test]
     fn type_mismatch_string_number() {
         let mut parser = Statement::new().unwrap();
-        let result = parser.parse_and_execute("[lessOrEquals('5', 3)]", &Context::new());
+        let result = parser.parse_and_execute("[less('5', 3)]", &Context::new());
         assert!(result.is_err());
         assert!(result.unwrap_err().to_string().contains("Arguments must be of the same type"));
     }

dsc_lib/src/functions/max.rs

@@ -69,14 +69,14 @@ mod tests {
     #[test]
     fn array() {
         let mut parser = Statement::new().unwrap();
-        let result = parser.parse_and_execute("[max(createArray(0, 3, 2, 7, 4)]", &Context::new()).unwrap();
+        let result = parser.parse_and_execute("[max(createArray(0, 3, 2, 7, 4))]", &Context::new()).unwrap();
         assert_eq!(result, 7);
     }
 
     #[test]
     fn array_single_value() {
         let mut parser = Statement::new().unwrap();
-        let result = parser.parse_and_execute("[max(createArray(0)]", &Context::new()).unwrap();
+        let result = parser.parse_and_execute("[max(createArray(0))]", &Context::new()).unwrap();
         assert_eq!(result, 0);
     }
 

dsc_lib/src/functions/min.rs

@@ -69,14 +69,14 @@ mod tests {
     #[test]
     fn array() {
         let mut parser = Statement::new().unwrap();
-        let result = parser.parse_and_execute("[min(createArray(0, 3, 2, 5, 4)]", &Context::new()).unwrap();
+        let result = parser.parse_and_execute("[min(createArray(0, 3, 2, 5, 4))]", &Context::new()).unwrap();
         assert_eq!(result, 0);
     }
 
     #[test]
     fn array_single_value() {
         let mut parser = Statement::new().unwrap();
-        let result = parser.parse_and_execute("[min(createArray(0)]", &Context::new()).unwrap();
+        let result = parser.parse_and_execute("[min(createArray(0))]", &Context::new()).unwrap();
         assert_eq!(result, 0);
     }
 

dsc_lib/src/parser/mod.rs

@@ -46,6 +46,11 @@ impl Statement {
     /// This function will return an error if the statement fails to parse or execute.
     pub fn parse_and_execute(&mut self, statement: &str, context: &Context) -> Result<Value, DscError> {
         debug!("{}", t!("parser.parsingStatement", statement = statement));
+        if !context.process_expressions {
+            debug!("{}", t!("parser.skippingExpressionProcessing"));
+            return Ok(Value::String(statement.to_string()));
+        }
+
         let Some(tree) = &mut self.parser.parse(statement, None) else {
             return Err(DscError::Parser(t!("parser.failedToParse", statement = statement).to_string()));
         };

powershell-adapter/Tests/TestClassResource/0.0.1/TestClassResource.psm1

@@ -71,6 +71,10 @@ class TestClassResource : BaseTestClass
         {
             $this.Prop1 = "ValueForProp1"
         }
+        elseif ($this.Name -eq 'EchoBack')
+        {
+            # don't change the property, just echo it back
+        }
         else
         {
             $this.Prop1 = $env:DSC_CONFIG_ROOT
@@ -98,11 +102,11 @@ class TestClassResource : BaseTestClass
 
     static [TestClassResource[]] Export([bool]$UseExport)
     {
-        if ($UseExport) 
+        if ($UseExport)
         {
             return [TestClassResource]::Export()
         }
-        else 
+        else
         {
             $resultList = [List[TestClassResource]]::new()
             $resultCount = 5

powershell-adapter/Tests/powershellgroup.config.tests.ps1

@@ -34,7 +34,7 @@ Describe 'PowerShell adapter resource tests' {
   }
 
   It 'Get does not work on config when module does not exist' {
-        
+
     $yaml = @'
             $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
             resources:
@@ -195,7 +195,7 @@ Describe 'PowerShell adapter resource tests' {
                   type: TestClassResource/TestClassResource
                   properties:
                     Name: 'TestClassResource1'
-                    HashTableProp: 
+                    HashTableProp:
                       Name: 'DSCv3'
 "@
 
@@ -218,7 +218,7 @@ Describe 'PowerShell adapter resource tests' {
               type: TestClassResource/TestClassResource
               properties:
                 Name: 'TestClassResource1'
-                HashTableProp: 
+                HashTableProp:
                   Name: 'DSCv3'
 "@
 
@@ -269,7 +269,7 @@ Describe 'PowerShell adapter resource tests' {
             Credential:
               UserName: 'User'
               OtherProperty: 'Password'
-"@  
+"@
     $out = dsc config get -i $yaml 2>&1 | Out-String
     $LASTEXITCODE | Should -Be 2
     $out | Should -Not -BeNullOrEmpty
@@ -310,5 +310,23 @@ Describe 'PowerShell adapter resource tests' {
     $out.resources[0].properties.result[0].Name | Should -Be "Object1"
     $out.resources[0].properties.result[0].Prop1 | Should -Be "Property of object1"
   }
+
+  It 'Expressions get passed correctly to adapted resource' {
+    $yaml = @"
+        `$schema: https://aka.ms/dsc/schemas/v3/bundled/config/document.json
+        resources:
+        - name: Class-resource Info
+          type: TestClassResource/TestClassResource
+          properties:
+            Name: EchoBack
+            Prop1: "[[this is a string literal]"
+            EnumProp: 'Expected'
+"@
+    $out = dsc config get -i $yaml | ConvertFrom-Json
+    $LASTEXITCODE | Should -Be 0
+    $out.results.result.actualState.Name | Should -BeExactly 'EchoBack'
+    $out.results.result.actualState.Prop1 | Should -BeExactly '[this is a string literal]'
+    $out.results.result.actualState.EnumProp | Should -BeExactly 'Expected'
+  }
 }