fix resource manifests

SteveL-MSFT · SteveL-MSFT · commit fc3dc228e058 · 2024-04-05T15:14:47.000-07:00
diff --git a/dsc/assertion.dsc.resource.json b/dsc/assertion.dsc.resource.json
@@ -60,6 +60,7 @@
     "args": [
       "config",
       "validate"
-    ]
+    ],
+    "input": "stdin"
   }
 }
diff --git a/dsc/group.dsc.resource.json b/dsc/group.dsc.resource.json
@@ -48,6 +48,7 @@
     "args": [
       "config",
       "validate"
-    ]
+    ],
+    "input": "stdin"
   }
 }
diff --git a/dsc/parallel.dsc.resource.json b/dsc/parallel.dsc.resource.json
@@ -51,6 +51,7 @@
     "args": [
       "config",
       "validate"
-    ]
+    ],
+    "input": "stdin"
   }
 }
diff --git a/dsc/tests/dsc_args.tests.ps1 b/dsc/tests/dsc_args.tests.ps1
@@ -54,24 +54,20 @@ Describe 'config argument tests' {
         $env:DSC_RESOURCE_PATH = $oldPath
     }
 
-    It 'input is <type>' -Skip:(!$IsWindows) -TestCases @(
+    It 'input is <type>' -TestCases @(
         @{ type = 'yaml'; text = @'
-            keyPath: HKLM\Software\Microsoft\Windows NT\CurrentVersion
-            valueName: ProductName
+            output: Hello There
 '@ }
         @{ type = 'json'; text = @'
             {
-                "keyPath": "HKLM\\Software\\Microsoft\\Windows NT\\CurrentVersion",
-                "valueName": "ProductName"
+                "output": "Hello There"
             }
 '@ }
     ) {
         param($text)
-        $output = $text | dsc resource get -r Microsoft.Windows/Registry
+        $output = $text | dsc resource get -r Test/Echo
         $output = $output | ConvertFrom-Json
-        $output.actualState.keyPath | Should -BeExactly 'HKLM\Software\Microsoft\Windows NT\CurrentVersion'
-        $output.actualState.valueName | Should -BeExactly 'ProductName'
-        $output.actualState.valueData.String | Should -Match 'Windows .*'
+        $output.actualState.output | Should -BeExactly 'Hello There'
     }
 
     It '--format <format> is used even when redirected' -TestCases @(
diff --git a/dsc_lib/src/dscresources/command_resource.rs b/dsc_lib/src/dscresources/command_resource.rs
@@ -54,7 +54,7 @@ pub fn invoke_get(resource: &ResourceManifest, cwd: &str, filter: &str) -> Resul
 
     let mut env: Option<HashMap<String, String>> = None;
     let mut input_filter: Option<&str> = None;
-    let mut args: Option<Vec<String>> = None;
+    let args = process_args(&resource.get.args, filter);
     if !filter.is_empty() {
         verify_json(resource, cwd, filter)?;
 
@@ -65,9 +65,6 @@ pub fn invoke_get(resource: &ResourceManifest, cwd: &str, filter: &str) -> Resul
             InputKind::Stdin => {
                 input_filter = Some(filter);
             },
-            InputKind::Arg => {
-                args = process_args(&resource.get.args, filter);
-            },
         }
     }
 
@@ -146,17 +143,14 @@ pub fn invoke_set(resource: &ResourceManifest, cwd: &str, desired: &str, skip_te
 
     let mut get_env: Option<HashMap<String, String>> = None;
     let mut get_input: Option<&str> = None;
-    let mut args: Option<Vec<String>> = None;
+    let args = process_args(&resource.get.args, desired);
     match &resource.get.input {
         Some(InputKind::Env) => {
             get_env = Some(json_to_hashmap(desired)?);
         },
         Some(InputKind::Stdin) => {
             get_input = Some(desired);
         },
-        Some(InputKind::Arg) => {
-            args = process_args(&resource.get.args, desired);
-        },
         None => {
             // leave input as none
         },
@@ -183,16 +177,16 @@ pub fn invoke_set(resource: &ResourceManifest, cwd: &str, desired: &str, skip_te
 
     let mut env: Option<HashMap<String, String>> = None;
     let mut input_desired: Option<&str> = None;
-    let mut args: Option<Vec<String>> = None;
+    let args = process_args(&set.args, desired);
     match &set.input {
-        InputKind::Env => {
+        Some(InputKind::Env) => {
             env = Some(json_to_hashmap(desired)?);
         },
-        InputKind::Stdin => {
+        Some(InputKind::Stdin) => {
             input_desired = Some(desired);
         },
-        InputKind::Arg => {
-            args = process_args(&set.args, desired);
+        None => {
+            // leave input as none
         },
     }
 
@@ -289,16 +283,16 @@ pub fn invoke_test(resource: &ResourceManifest, cwd: &str, expected: &str) -> Re
 
     let mut env: Option<HashMap<String, String>> = None;
     let mut input_expected: Option<&str> = None;
-    let mut args: Option<Vec<String>> = None;
+    let args = process_args(&test.args, expected);
     match &test.input {
-        InputKind::Env => {
+        Some(InputKind::Env) => {
            env = Some(json_to_hashmap(expected)?);
         },
-        InputKind::Stdin => {
+        Some(InputKind::Stdin) => {
             input_expected = Some(expected);
         },
-        InputKind::Arg => {
-            args = process_args(&test.args, expected);
+        None => {
+            // leave input as none
         },
     }
 
@@ -391,19 +385,20 @@ pub fn invoke_delete(resource: &ResourceManifest, cwd: &str, filter: &str) -> Re
         return Err(DscError::NotImplemented("delete".to_string()));
     };
 
+    verify_json(resource, cwd, filter)?;
+
     let mut env: Option<HashMap<String, String>> = None;
     let mut input_filter: Option<&str> = None;
-    let mut args: Option<Vec<String>> = None;
-    verify_json(resource, cwd, filter)?;
+    let args = process_args(&delete.args, filter);
     match &delete.input {
-        InputKind::Env => {
+        Some(InputKind::Env) => {
             env = Some(json_to_hashmap(filter)?);
         },
-        InputKind::Stdin => {
+        Some(InputKind::Stdin) => {
             input_filter = Some(filter);
         },
-        InputKind::Arg => {
-            args = process_args(&delete.args, filter);
+        None => {
+            // leave input as none
         },
     }
 
@@ -441,16 +436,16 @@ pub fn invoke_validate(resource: &ResourceManifest, cwd: &str, config: &str) ->
 
     let mut env: Option<HashMap<String, String>> = None;
     let mut input_config: Option<&str> = None;
-    let mut args: Option<Vec<String>> = None;
+    let args = process_args(&validate.args, config);
     match &validate.input {
-        InputKind::Env => {
+        Some(InputKind::Env) => {
             env = Some(json_to_hashmap(config)?);
         },
-        InputKind::Stdin => {
+        Some(InputKind::Stdin) => {
             input_config = Some(config);
         },
-        InputKind::Arg => {
-            args = process_args(&validate.args, config);
+        None => {
+            // leave input as none
         },
     }
 
@@ -526,24 +521,29 @@ pub fn invoke_export(resource: &ResourceManifest, cwd: &str, input: Option<&str>
         return Err(DscError::Operation(format!("Export is not supported by resource {}", &resource.resource_type)))
     };
 
+
     let mut env: Option<HashMap<String, String>> = None;
     let mut export_input: Option<&str> = None;
-    let mut args: Option<Vec<String>> = None;
+    let args: Option<Vec<String>>;
     if let Some(input) = input {
-        match &export.input {
-            Some(InputKind::Env) => {
-                env = Some(json_to_hashmap(input)?);
-            },
-            Some(InputKind::Stdin) => {
-                export_input = Some(input);
-            },
-            Some(InputKind::Arg) => {
-                args = process_args(&export.args, input);
-            },
-            None => {
-                // leave input as none
-            },
+        if !input.is_empty() {
+            verify_json(resource, cwd, input)?;
+            match &export.input {
+                Some(InputKind::Env) => {
+                    env = Some(json_to_hashmap(input)?);
+                },
+                Some(InputKind::Stdin) => {
+                    export_input = Some(input);
+                },
+                None => {
+                    // leave input as none
+                },
+            }
         }
+
+        args = process_args(&export.args, input);
+    } else {
+        args = process_args(&export.args, "");
     }
 
     let (exit_code, stdout, stderr) = invoke_command(&export.executable, args, export_input, Some(cwd), env)?;
@@ -657,7 +657,7 @@ fn process_args(args: &Option<Vec<ArgKind>>, value: &str) -> Option<Vec<String>>
                 processed_args.push(s.clone());
             },
             ArgKind::Json { json_input_arg, mandatory } => {
-                if value.is_empty() && *mandatory == Some(true) {
+                if value.is_empty() && *mandatory != Some(true) {
                     continue;
                 }
 
diff --git a/dsc_lib/src/dscresources/resource_manifest.rs b/dsc_lib/src/dscresources/resource_manifest.rs
@@ -96,9 +96,6 @@ pub enum ArgKind {
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
 pub enum InputKind {
-    /// The input replaces arguments with this token in the command.
-    #[serde(rename = "arg")]
-    Arg,
     /// The input is accepted as environmental variables.
     #[serde(rename = "env")]
     Env,
@@ -156,7 +153,7 @@ pub struct SetMethod {
     /// The arguments to pass to the command to perform a Set.
     pub args: Option<Vec<ArgKind>>,
     /// How to pass required input for a Set.
-    pub input: InputKind,
+    pub input: Option<InputKind>,
     /// Whether to run the Test method before the Set method.  True means the resource will perform its own test before running the Set method.
     #[serde(rename = "implementsPretest", skip_serializing_if = "Option::is_none")]
     pub pre_test: Option<bool>,
@@ -175,7 +172,7 @@ pub struct TestMethod {
     /// The arguments to pass to the command to perform a Test.
     pub args: Option<Vec<ArgKind>>,
     /// How to pass required input for a Test.
-    pub input: InputKind,
+    pub input: Option<InputKind>,
     /// The type of return value expected from the Test method.
     #[serde(rename = "return", skip_serializing_if = "Option::is_none")]
     pub returns: Option<ReturnKind>,
@@ -188,7 +185,7 @@ pub struct DeleteMethod {
     /// The arguments to pass to the command to perform a Delete.
     pub args: Option<Vec<ArgKind>>,
     /// How to pass required input for a Delete.
-    pub input: InputKind,
+    pub input: Option<InputKind>,
 }
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
@@ -198,7 +195,7 @@ pub struct ValidateMethod { // TODO: enable validation via schema or command
     /// The arguments to pass to the command to perform a Validate.
     pub args: Option<Vec<ArgKind>>,
     /// How to pass required input for a Validate.
-    pub input: InputKind,
+    pub input: Option<InputKind>,
 }
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
diff --git a/powershell-adapter/powershell.dsc.resource.json b/powershell-adapter/powershell.dsc.resource.json
@@ -76,7 +76,8 @@
           "-NoProfile",
           "-Command",
           "$Input | ./powershell.resource.ps1 Validate"
-          ]
+          ],
+        "input": "stdin"
       },
     "exitCodes": {
       "0": "Success",
diff --git a/registry/registry.dsc.resource.json b/registry/registry.dsc.resource.json
@@ -11,36 +11,33 @@
         "args": [
             "config",
             "get",
-            "--input",
-            "{json}"
-        ],
-        "input": {
-            "arg": "{json}"
-        }
+            {
+                "jsonInputArg": "--input",
+                "mandatory": true
+            }
+        ]
     },
     "set": {
         "executable": "registry",
         "args": [
             "config",
             "set",
-            "--input",
-            "{json}"
-        ],
-        "input": {
-            "arg": "{json}"
-        }
+            {
+                "jsonInputArg": "--input",
+                "mandatory": true
+            }
+        ]
     },
     "delete": {
         "executable": "registry",
         "args": [
             "config",
             "remove",
-            "--input",
-            "{json}"
-        ],
-        "input": {
-            "arg": "{json}"
-        }
+            {
+                "jsonInputArg": "--input",
+                "mandatory": true
+            }
+        ]
     },
     "exitCodes": {
         "0": "Success",
diff --git a/tools/dsctest/dscexist.dsc.resource.json b/tools/dsctest/dscexist.dsc.resource.json
@@ -6,23 +6,21 @@
         "executable": "dsctest",
         "args": [
             "exist",
-            "--input",
-            "{json}"
-        ],
-        "input": {
-            "arg": "{json}"
-        }
+            {
+                "jsonInputArg": "--input",
+                "mandatory": true
+            }
+        ]
     },
     "set": {
         "executable": "dsctest",
         "args": [
             "exist",
-            "--input",
-            "{json}"
+            {
+                "jsonInputArg": "--input",
+                "mandatory": true
+            }
         ],
-        "input": {
-            "arg": "{json}"
-        },
         "handlesExist": true,
         "return": "state"
     },
diff --git a/tools/dsctest/dscsleep.dsc.resource.json b/tools/dsctest/dscsleep.dsc.resource.json

Original file line number	Diff line number	Diff line change
`@@ -60,6 +60,7 @@`
`60`	`60`	`"args": [`
`61`	`61`	`"config",`
`62`	`62`	`"validate"`
`63`		`- ]`
	`63`	`+ ],`
	`64`	`+ "input": "stdin"`
`64`	`65`	`}`
`65`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -48,6 +48,7 @@`
`48`	`48`	`"args": [`
`49`	`49`	`"config",`
`50`	`50`	`"validate"`
`51`		`- ]`
	`51`	`+ ],`
	`52`	`+ "input": "stdin"`
`52`	`53`	`}`
`53`	`54`	`}`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,7 @@`
`51`	`51`	`"args": [`
`52`	`52`	`"config",`
`53`	`53`	`"validate"`
`54`		`- ]`
	`54`	`+ ],`
	`55`	`+ "input": "stdin"`
`55`	`56`	`}`
`56`	`57`	`}`