(GH-642) Ensure camelCase for items in dsc_lib

michaeltlombardi · SteveL-MSFT · commit 2046ea716ee1 · 2025-02-26T11:11:25.000-08:00
Prior to this change, the structs and enums in `dsc_lib` didn't consistently
use camelCase - most property names and enum values use camelCase, but not
all - and this inconsistency isn't predictable for end users, who need to
consult the JSON Schemas to be sure.

This change updates the definitions to rename the fields and values when
serializing and deserializing, which also updates their JSON Schema.

A future change is required to update the canonical schemas in the
repository to match these updates.
diff --git a/configurations/windows/windows_baseline.dsc.yaml b/configurations/windows/windows_baseline.dsc.yaml
@@ -2,7 +2,7 @@
 $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
 metadata:
   Microsoft.DSC:
-    securityContext: Elevated
+    securityContext: elevated
 resources:
 - name: Validate the OS is Windows
   type: Microsoft.DSC/Assertion
diff --git a/dsc/assertion.dsc.resource.json b/dsc/assertion.dsc.resource.json
@@ -3,7 +3,7 @@
   "type": "Microsoft.DSC/Assertion",
   "version": "0.1.0",
   "description": "`test` will be invoked for all resources in the supplied configuration.",
-  "kind": "Group",
+  "kind": "group",
   "get": {
     "executable": "dsc",
     "args": [
diff --git a/dsc/examples/groups.dsc.yaml b/dsc/examples/groups.dsc.yaml
@@ -2,7 +2,7 @@
 $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
 metadata:
   Microsoft.DSC:
-    requiredSecurityContext: Current # this is the default and just used as an example indicating this config works for admins and non-admins
+    requiredSecurityContext: current # this is the default and just used as an example indicating this config works for admins and non-admins
 resources:
 - name: Last Group
   type: Microsoft.DSC/Group
diff --git a/dsc/examples/require_admin.yaml b/dsc/examples/require_admin.yaml
@@ -4,7 +4,7 @@
 $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
 metadata:
   Microsoft.DSC:
-    securityContext: Elevated
+    securityContext: elevated
 resources:
 - name: os
   type: Microsoft/OSInfo
diff --git a/dsc/examples/require_nonadmin.yaml b/dsc/examples/require_nonadmin.yaml
@@ -3,7 +3,7 @@
 $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
 metadata:
   Microsoft.DSC:
-    securityContext: Restricted
+    securityContext: restricted
 resources:
 - name: os
   type: Microsoft/OSInfo
diff --git a/dsc/examples/winps_script.dsc.yaml b/dsc/examples/winps_script.dsc.yaml
@@ -1,7 +1,7 @@
 $schema: https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json
 metadata:
   Microsoft.DSC:
-    securityContext: Elevated
+    securityContext: elevated
 resources:
   - type: Microsoft.Windows/WindowsPowerShell
     name: Run WinPS script
diff --git a/dsc/group.dsc.resource.json b/dsc/group.dsc.resource.json
@@ -3,7 +3,7 @@
   "type": "Microsoft.DSC/Group",
   "version": "0.1.0",
   "description": "All resources in the supplied configuration is treated as a group.",
-  "kind": "Group",
+  "kind": "group",
   "get": {
     "executable": "dsc",
     "args": [
diff --git a/dsc/include.dsc.resource.json b/dsc/include.dsc.resource.json
@@ -3,7 +3,7 @@
   "type": "Microsoft.DSC/Include",
   "version": "0.1.0",
   "description": "Allows including a configuration file with optional parameter file.",
-  "kind": "Importer",
+  "kind": "importer",
   "get": {
     "executable": "dsc",
     "args": [
diff --git a/dsc/tests/dsc_args.tests.ps1 b/dsc/tests/dsc_args.tests.ps1
@@ -91,6 +91,16 @@ actualState:
         $out.Trim() | Should -BeExactly $expected
     }
 
+    It 'YAML output includes object separator' {
+        $out = dsc resource list -o yaml | Out-String
+        foreach ($obj in $out.Split('---')) {
+            $resource = $obj | y2j | ConvertFrom-Json
+            $resource | Should -Not -BeNullOrEmpty
+            $resource.Type | Should -BeLike '*/*'
+            $resource.Kind | Should -BeIn ('resource', 'group', 'importer', 'adapter')
+        }
+    }
+
     It 'can generate PowerShell completer' {
         $out = dsc completer powershell | Out-String
         Invoke-Expression $out
@@ -232,7 +242,7 @@ resources:
         $a = dsc resource list '*' -a Test* -o json | ConvertFrom-Json
         foreach ($r in $a) {
             $r.requireAdapter.StartsWith("Test") | Should -Be $true
-            $r.kind | Should -Be "Resource"
+            $r.kind | Should -Be "resource"
         }
     }
 
@@ -243,7 +253,7 @@ resources:
         $r = $a[0]
         $r.requireAdapter | Should -Not -BeNullOrEmpty
         $r.requireAdapter.StartsWith("Test") | Should -Be $true
-        $r.kind | Should -Be "Resource"
+        $r.kind | Should -Be "resource"
     }
 
     It 'passing filepath to document arg should error' {
diff --git a/dsc/tests/dsc_config_get.tests.ps1 b/dsc/tests/dsc_config_get.tests.ps1
@@ -47,8 +47,8 @@ Describe 'dsc config get tests' {
         $result.results[0].type | Should -BeExactly 'Microsoft.DSC.Debug/Echo'
         $result.results[0].result.actualState.output | Should -Be 'hello'
         $result.metadata.'Microsoft.DSC'.version | Should -BeLike '3.*'
-        $result.metadata.'Microsoft.DSC'.operation | Should -BeExactly 'Get'
-        $result.metadata.'Microsoft.DSC'.executionType | Should -BeExactly 'Actual'
+        $result.metadata.'Microsoft.DSC'.operation | Should -BeExactly 'get'
+        $result.metadata.'Microsoft.DSC'.executionType | Should -BeExactly 'actual'
         $result.metadata.'Microsoft.DSC'.startDatetime | Should -Not -BeNullOrEmpty
         $result.metadata.'Microsoft.DSC'.endDatetime | Should -Not -BeNullOrEmpty
         $result.metadata.'Microsoft.DSC'.duration | Should -Not -BeNullOrEmpty
diff --git a/dsc/tests/dsc_config_set.tests.ps1 b/dsc/tests/dsc_config_set.tests.ps1
@@ -29,8 +29,8 @@ Describe 'dsc config set tests' {
         $out.results[1].result.afterState.deleteCalled | Should -BeTrue
         $out.results[1].result.afterState._exist | Should -BeFalse
         $out.metadata.'Microsoft.DSC'.version | Should -BeLike '3.*'
-        $out.metadata.'Microsoft.DSC'.operation | Should -BeExactly 'Set'
-        $out.metadata.'Microsoft.DSC'.executionType | Should -BeExactly 'Actual'
+        $out.metadata.'Microsoft.DSC'.operation | Should -BeExactly 'set'
+        $out.metadata.'Microsoft.DSC'.executionType | Should -BeExactly 'actual'
         $out.metadata.'Microsoft.DSC'.startDatetime | Should -Not -BeNullOrEmpty
         $out.metadata.'Microsoft.DSC'.endDatetime | Should -Not -BeNullOrEmpty
         $out.metadata.'Microsoft.DSC'.duration | Should -Not -BeNullOrEmpty
diff --git a/dsc/tests/dsc_export.tests.ps1 b/dsc/tests/dsc_export.tests.ps1
@@ -39,7 +39,7 @@ Describe 'resource export tests' {
         $config_with_process_list.'$schema' | Should -BeExactly 'https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/config/document.json'
         $config_with_process_list.'resources' | Should -Not -BeNullOrEmpty
         $config_with_process_list.resources.count | Should -BeGreaterThan 1
-        $config_with_process_list.metadata.'Microsoft.DSC'.operation | Should -BeExactly 'Export'
+        $config_with_process_list.metadata.'Microsoft.DSC'.operation | Should -BeExactly 'export'
         # contentVersion on export is always 1.0.0
         $config_with_process_list.contentVersion | Should -BeExactly '1.0.0'
     }
diff --git a/dsc/tests/dsc_resource_list.tests.ps1 b/dsc/tests/dsc_resource_list.tests.ps1
@@ -10,9 +10,9 @@ Describe 'Tests for listing resources' {
         $resources.type | Should -Contain 'Microsoft.DSC/Assertion'
         $resources.type | Should -Contain 'Microsoft.DSC/Group'
         $resources.type | Should -Contain 'Microsoft/OSInfo'
-        ($resources | Where-Object { $_.type -eq 'Microsoft.DSC/Group' }).Kind | Should -BeExactly 'Group'
-        ($resources | Where-Object { $_.type -eq 'Microsoft/OSInfo' }).Kind | Should -BeExactly 'Resource'
-        ($resources | Where-Object { $_.type -eq 'Microsoft.DSC/PowerShell' }).Kind | Should -BeExactly 'Adapter'
+        ($resources | Where-Object { $_.type -eq 'Microsoft.DSC/Group' }).Kind | Should -BeExactly 'group'
+        ($resources | Where-Object { $_.type -eq 'Microsoft/OSInfo' }).Kind | Should -BeExactly 'resource'
+        ($resources | Where-Object { $_.type -eq 'Microsoft.DSC/PowerShell' }).Kind | Should -BeExactly 'adapter'
     }
 
     It 'dsc resource list --tags "<tags>" and --description "<description> work' -TestCases @(
@@ -79,8 +79,8 @@ Describe 'Tests for listing resources' {
         $resource = dsc resource list Microsoft/OSInfo | ConvertFrom-Json
         $LASTEXITCODE | Should -Be 0
         $resource.capabilities.Count | Should -Be 2
-        $resource.capabilities | Should -Contain 'Get'
-        $resource.capabilities | Should -Contain 'Export'
+        $resource.capabilities | Should -Contain 'get'
+        $resource.capabilities | Should -Contain 'export'
     }
 
     It 'Invalid adapter returns an error' {
diff --git a/dsc/tests/dsc_whatif.tests.ps1 b/dsc/tests/dsc_whatif.tests.ps1
@@ -16,7 +16,7 @@ Describe 'whatif tests' {
 "@
         $what_if_result = $config_yaml | dsc config set -w -f - | ConvertFrom-Json
         $set_result = $config_yaml | dsc config set -f - | ConvertFrom-Json
-        $what_if_result.metadata.'Microsoft.DSC'.executionType | Should -BeExactly 'WhatIf'
+        $what_if_result.metadata.'Microsoft.DSC'.executionType | Should -BeExactly 'whatIf'
         $what_if_result.results.result.beforeState.output | Should -Be $set_result.results.result.beforeState.output
         $what_if_result.results.result.afterState.output | Should -Be $set_result.results.result.afterState.output
         $what_if_result.results.result.changedProperties | Should -Be $set_result.results.result.changedProperties
@@ -37,7 +37,7 @@ Describe 'whatif tests' {
 "@
         $what_if_result = dsc config set -w -i $config_yaml | ConvertFrom-Json
         $set_result = dsc config set -i $config_yaml | ConvertFrom-Json
-        $what_if_result.metadata.'Microsoft.DSC'.executionType | Should -BeExactly 'WhatIf'
+        $what_if_result.metadata.'Microsoft.DSC'.executionType | Should -BeExactly 'whatIf'
         $what_if_result.results.result.beforeState._exist | Should -Be $set_result.results.result.beforeState._exist
         $what_if_result.results.result.beforeState.keyPath | Should -Be $set_result.results.result.beforeState.keyPath
         $what_if_result.results.result.afterState.KeyPath | Should -Be $set_result.results.result.afterState.keyPath
@@ -80,7 +80,7 @@ Describe 'whatif tests' {
             executionType: Actual
 "@
         $result = $config_yaml | dsc config set -f - | ConvertFrom-Json
-        $result.metadata.'Microsoft.DSC'.executionType | Should -BeExactly 'Actual'
+        $result.metadata.'Microsoft.DSC'.executionType | Should -BeExactly 'actual'
         $result.results.result.afterState.executionType | Should -BeExactly 'Actual'
         $result.results.result.changedProperties | Should -Be $null
         $result.hadErrors | Should -BeFalse
@@ -98,7 +98,7 @@ Describe 'whatif tests' {
             executionType: Actual
 "@
         $result = $config_yaml | dsc config set -w -f - | ConvertFrom-Json
-        $result.metadata.'Microsoft.DSC'.executionType | Should -BeExactly 'WhatIf'
+        $result.metadata.'Microsoft.DSC'.executionType | Should -BeExactly 'whatIf'
         $result.results.result.afterState.executionType | Should -BeExactly 'WhatIf'
         $result.results.result.changedProperties | Should -BeExactly 'executionType'
         $result.hadErrors | Should -BeFalse
diff --git a/dsc_lib/src/configure/config_doc.rs b/dsc_lib/src/configure/config_doc.rs
@@ -7,19 +7,22 @@ use serde_json::{Map, Value};
 use std::{collections::HashMap, hash::Hash};
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
+#[serde(rename_all = "camelCase")]
 pub enum ContextKind {
     Configuration,
     Resource,
 }
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
+#[serde(rename_all = "camelCase")]
 pub enum SecurityContextKind {
     Current,
     Elevated,
     Restricted,
 }
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
+#[serde(rename_all = "camelCase")]
 pub enum Operation {
     Get,
     Set,
@@ -28,6 +31,7 @@ pub enum Operation {
 }
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
+#[serde(rename_all = "camelCase")]
 pub enum ExecutionKind {
     Actual,
     WhatIf,
diff --git a/dsc_lib/src/configure/config_progress.rs b/dsc_lib/src/configure/config_progress.rs
@@ -12,6 +12,7 @@ pub struct ConfigurationResourceStartedEvent {
 }
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
+#[serde(rename_all = "camelCase")]
 pub enum ConfigurationResourceCompletionStatus {
     Success,
     Failure,
diff --git a/dsc_lib/src/configure/config_result.rs b/dsc_lib/src/configure/config_result.rs
@@ -7,6 +7,7 @@ use crate::dscresources::invoke_result::{GetResult, SetResult, TestResult};
 use crate::configure::config_doc::{Configuration, Metadata};
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
+#[serde(rename_all = "camelCase")]
 pub enum MessageLevel {
     Error,
     Warning,
diff --git a/dsc_lib/src/dscresources/dscresource.rs b/dsc_lib/src/dscresources/dscresource.rs
@@ -45,6 +45,7 @@ pub struct DscResource {
 }
 
 #[derive(Clone, Debug, PartialEq, Deserialize, Serialize, JsonSchema)]
+#[serde(rename_all = "camelCase")]
 pub enum Capability {
     /// The resource supports retriving configuration.
     Get,
diff --git a/dsc_lib/src/dscresources/resource_manifest.rs b/dsc_lib/src/dscresources/resource_manifest.rs
@@ -10,6 +10,7 @@ use std::collections::HashMap;
 use crate::dscerror::DscError;
 
 #[derive(Debug, Clone, PartialEq, Deserialize, Serialize, JsonSchema)]
+#[serde(rename_all = "camelCase")]
 pub enum Kind {
     Adapter,
     Group,
diff --git a/powershell-adapter/Tests/PSTestModule/1.0.0/PSTestModule.psd1 b/powershell-adapter/Tests/PSTestModule/1.0.0/PSTestModule.psd1
@@ -21,7 +21,7 @@
                 'PSEdition_Core',
                 'Linux',
                 'Mac')
-            DscCapabilities = @('Get', 'Test')
+            DscCapabilities = @('get', 'test')
         }
     }
 }
diff --git a/powershell-adapter/Tests/TestAdapter/testadapter.dsc.resource.json b/powershell-adapter/Tests/TestAdapter/testadapter.dsc.resource.json
@@ -2,7 +2,7 @@
     "$schema": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/bundled/resource/manifest.json",
     "type": "Test/TestAdapter",
     "version": "0.1.0",
-    "kind": "Adapter",
+    "kind": "adapter",
     "description": "Resource adapter for testing.",
     "tags": [
       "PowerShell"
diff --git a/powershell-adapter/Tests/TestAdapter/testadapter.resource.ps1 b/powershell-adapter/Tests/TestAdapter/testadapter.resource.ps1
@@ -36,12 +36,12 @@ switch ($Operation) {
     'List' {
             @{
                 type           = "Test/TestCase"
-                kind           = 'Resource'
+                kind           = 'resource'
                 version        = '1'
-                capabilities   = @('Get', 'Set', 'Test', 'Export')
+                capabilities   = @('get', 'set', 'test', 'export')
                 path           = $PSScriptRoot
                 directory      = Split-Path $PSScriptRoot
-                implementedAs  = 'Adapter'
+                implementedAs  = 'adapter'
                 author         = 'Test'
                 properties     = @('TestCaseId', 'Input', 'Result')
                 requireAdapter = 'Test/TestAdapter'
diff --git a/powershell-adapter/Tests/TestClassResource/0.0.1/TestClassResource.psd1 b/powershell-adapter/Tests/TestClassResource/0.0.1/TestClassResource.psd1
@@ -40,8 +40,8 @@ DscResourcesToExport = @('TestClassResource', 'NoExport')
 PrivateData = @{
     PSData = @{
         DscCapabilities = @(
-            'Get'
-            'Test'
+            'get'
+            'test'
         )
     }
 }
diff --git a/powershell-adapter/powershell.dsc.resource.json b/powershell-adapter/powershell.dsc.resource.json
@@ -2,7 +2,7 @@
     "$schema": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2024/04/bundled/resource/manifest.json",
     "type": "Microsoft.DSC/PowerShell",
     "version": "0.1.0",
-    "kind": "Adapter",
+    "kind": "adapter",
     "description": "Resource adapter to classic DSC Powershell resources.",
     "tags": [
       "PowerShell"
diff --git a/powershell-adapter/psDscAdapter/powershell.resource.ps1 b/powershell-adapter/psDscAdapter/powershell.resource.ps1
@@ -18,7 +18,7 @@ function Write-DscTrace {
         [string]$Message
     )
 
-    $trace = @{$Operation = $Message } | ConvertTo-Json -Compress
+    $trace = @{$Operation.ToLower() = $Message } | ConvertTo-Json -Compress
     $host.ui.WriteErrorLine($trace)
 }
 
@@ -47,7 +47,7 @@ if ($Operation -eq 'ClearCache') {
 
 if ('Validate' -ne $Operation) {
     # write $jsonInput to STDERR for debugging
-    $trace = @{'Debug' = 'jsonInput=' + $jsonInput } | ConvertTo-Json -Compress
+    $trace = @{'debug' = 'jsonInput=' + $jsonInput } | ConvertTo-Json -Compress
     $host.ui.WriteErrorLine($trace)
 
     # load private functions of psDscAdapter stub module
@@ -92,7 +92,7 @@ switch ($Operation) {
                     $capabilities = $module.PrivateData.PSData.DscCapabilities
                 }
                 else {
-                    $capabilities = @('Get', 'Set', 'Test')
+                    $capabilities = @('get', 'set', 'test')
                 }
             }
 
@@ -119,7 +119,7 @@ switch ($Operation) {
             # OUTPUT dsc is expecting the following properties
             [resourceOutput]@{
                 type           = $dscResource.Type
-                kind           = 'Resource'
+                kind           = 'resource'
                 version        = [string]$DscResourceInfo.version
                 capabilities   = $capabilities
                 path           = $DscResourceInfo.Path
@@ -135,15 +135,15 @@ switch ($Operation) {
     { @('Get','Set','Test','Export') -contains $_ } {
         $desiredState = $psDscAdapter.invoke(   { param($jsonInput) Get-DscResourceObject -jsonInput $jsonInput }, $jsonInput )
         if ($null -eq $desiredState) {
-            $trace = @{'Debug' = 'ERROR: Failed to create configuration object from provided input JSON.' } | ConvertTo-Json -Compress
+            $trace = @{'debug' = 'ERROR: Failed to create configuration object from provided input JSON.' } | ConvertTo-Json -Compress
             $host.ui.WriteErrorLine($trace)
             exit 1
         }
 
         # only need to cache the resources that are used
         $dscResourceModules = $desiredState | ForEach-Object { $_.Type.Split('/')[0] }
         if ($null -eq $dscResourceModules) {
-            $trace = @{'Debug' = 'ERROR: Could not get list of DSC resource types from provided JSON.' } | ConvertTo-Json -Compress
+            $trace = @{'debug' = 'ERROR: Could not get list of DSC resource types from provided JSON.' } | ConvertTo-Json -Compress
             $host.ui.WriteErrorLine($trace)
             exit 1
         }
@@ -166,7 +166,7 @@ switch ($Operation) {
             # process the INPUT (desiredState) for each resource as dscresourceInfo and return the OUTPUT as actualState
             $actualState = $psDscAdapter.invoke( { param($op, $ds, $dscResourceCache) Invoke-DscOperation -Operation $op -DesiredState $ds -dscResourceCache $dscResourceCache }, $Operation, $ds, $dscResourceCache)
             if ($null -eq $actualState) {
-                $trace = @{'Debug' = 'ERROR: Incomplete GET for resource ' + $ds.Name } | ConvertTo-Json -Compress
+                $trace = @{'debug' = 'ERROR: Incomplete GET for resource ' + $ds.Name } | ConvertTo-Json -Compress
                 $host.ui.WriteErrorLine($trace)
                 exit 1
             }
@@ -175,7 +175,7 @@ switch ($Operation) {
     
         # OUTPUT json to stderr for debug, and to stdout
         $result = @{ result = $result } | ConvertTo-Json -Depth 10 -Compress
-        $trace = @{'Debug' = 'jsonOutput=' + $result } | ConvertTo-Json -Compress
+        $trace = @{'debug' = 'jsonOutput=' + $result } | ConvertTo-Json -Compress
         $host.ui.WriteErrorLine($trace)
         return $result
     }
diff --git a/powershell-adapter/windowspowershell.dsc.resource.json b/powershell-adapter/windowspowershell.dsc.resource.json
@@ -2,7 +2,7 @@
     "$schema": "https://raw.githubusercontent.com/PowerShell/DSC/main/schemas/2023/08/bundled/resource/manifest.json",
     "type": "Microsoft.Windows/WindowsPowerShell",
     "version": "0.1.0",
-    "kind": "Adapter",
+    "kind": "adapter",
     "description": "Resource adapter to classic DSC Powershell resources in Windows PowerShell.",
     "tags": [
       "PowerShell"
diff --git a/tools/test_group_resource/testGroup.dsc.resource.json b/tools/test_group_resource/testGroup.dsc.resource.json
diff --git a/tools/test_group_resource/tests/provider.tests.ps1 b/tools/test_group_resource/tests/provider.tests.ps1
diff --git a/wmi-adapter/wmi.dsc.resource.json b/wmi-adapter/wmi.dsc.resource.json
diff --git a/wmi-adapter/wmi.resource.ps1 b/wmi-adapter/wmi.resource.ps1
