GetDesiredState handle zeroed enum values using Get-DscProperty (#34)

Author: johlju

CHANGELOG.md

@@ -5,13 +5,25 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Removed
+
+- Removed `Clear-ZeroedEnumPropertyValue` as it was moved and implemented
+  the `Get-DscProperty` command in the _DscResource.Common_ module.
+
 ### Added
 
 - Wiki
   - How to use this base class. Fixes [#5](https://github.com/dsccommunity/DscResource.Base/issues/5)
   and [#19](https://github.com/dsccommunity/DscResource.Base/issues/19).
   - Add WikiContent to release assets.
 
+### Changed
+
+- `ResourceBase`
+  - Refactor `GetDesiredState` method to handle zeroed enum values using
+    `Get-DscProperty` when the property `FeatureOptionalEnums` is set to
+    `$true`.
+
 ### Fixed
 
 - build.yaml

source/Classes/010.ResourceBase.ps1

@@ -267,14 +267,23 @@ class ResourceBase
     # This is a private method and should normally not be overridden.
     hidden [System.Collections.Hashtable] GetDesiredState()
     {
-        # Get the properties that has a non-null value and is not of type Read.
-        $desiredState = $this | Get-DscProperty -Attribute @('Key', 'Mandatory', 'Optional') -HasValue
+        $getDscPropertyParameters = @{
+            Attribute = @(
+                'Key'
+                'Mandatory'
+                'Optional'
+            )
+            HasValue  = $true
+        }
 
         if ($this.FeatureOptionalEnums)
         {
-            $desiredState = $desiredState | Clear-ZeroedEnumPropertyValue
+            $getDscPropertyParameters.IgnoreZeroEnumValue = $true
         }
 
+        # Get the properties that has a non-null value and is not of type Read.
+        $desiredState = $this | Get-DscProperty @getDscPropertyParameters
+
         return $desiredState
     }
 

source/Private/Clear-ZeroedEnumPropertyValue.ps1

@@ -152,8 +152,6 @@ Describe 'ResourceBase\Assert()' -Tag 'Assert' {
                 }
             }
 
-            Mock -CommandName Clear-ZeroedEnumPropertyValue
-
             $inModuleScopeScriptBlock = @'
 using module DscResource.Base
 
@@ -223,7 +221,6 @@ $script:mockResourceBaseInstance = [MyMockResource]::new()
                 }
 
                 Should -Invoke -CommandName Get-DscProperty -Exactly -Times 1 -Scope It
-                Should -Invoke -CommandName Clear-ZeroedEnumPropertyValue -Exactly -Times 1 -Scope It
             }
         }
     }
@@ -243,8 +240,6 @@ Describe 'ResourceBase\Normalize()' -Tag 'Normalize' {
                 }
             }
 
-            Mock -CommandName Clear-ZeroedEnumPropertyValue
-
             $inModuleScopeScriptBlock = @'
 using module DscResource.Base
 
@@ -314,7 +309,6 @@ $script:mockResourceBaseInstance = [MyMockResource]::new()
                 }
 
                 Should -Invoke -CommandName Get-DscProperty -Exactly -Times 1 -Scope It
-                Should -Invoke -CommandName Clear-ZeroedEnumPropertyValue -Exactly -Times 1 -Scope It
             }
         }
     }
@@ -1751,3 +1745,142 @@ $script:mockResourceBaseInstance = [MyMockResource]::new()
         }
     }
 }
+
+Describe 'ResourceBase\GetDesiredState()' -Tag 'GetDesiredState' {
+    BeforeAll {
+        Mock -CommandName Get-ClassName -MockWith {
+            # Only return localized strings for this class name.
+            @('ResourceBase')
+        }
+    }
+
+    Context 'When FeatureOptionalEnums is disabled' {
+        BeforeAll {
+            $inModuleScopeScriptBlock = @'
+using module DscResource.Base
+
+class MyMockResource : ResourceBase
+{
+    [DscProperty(Key)]
+    [System.String]
+    $MyResourceKeyProperty1
+
+    [DscProperty()]
+    [System.String]
+    $MyResourceProperty2
+
+    [DscProperty()]
+    [System.String]
+    $MyResourceProperty3
+
+    [DscProperty(NotConfigurable)]
+    [System.String]
+    $MyResourceReadProperty
+
+    MyMockResource () {
+        $this.FeatureOptionalEnums = $false
+    }
+}
+
+$script:mockResourceBaseInstance = [MyMockResource]::new()
+'@
+
+            InModuleScope -ScriptBlock ([Scriptblock]::Create($inModuleScopeScriptBlock))
+
+            Mock -CommandName Get-DscProperty -MockWith {
+                return @{
+                    MyResourceKeyProperty1 = 'KeyValue'
+                    MyResourceProperty2 = 'TestValue'
+                    MyResourceProperty3 = 'Value3'
+                }
+            }
+        }
+
+        It 'Should have correctly instantiated the resource class' {
+            InModuleScope -ScriptBlock {
+                $mockResourceBaseInstance | Should -Not -BeNullOrEmpty
+                $mockResourceBaseInstance.GetType().BaseType.Name | Should -Be 'ResourceBase'
+            }
+        }
+
+        It 'Should call Get-DscProperty with the correct parameters' {
+            InModuleScope -ScriptBlock {
+                $null = $mockResourceBaseInstance.GetDesiredState()
+            }
+
+            Should -Invoke -CommandName Get-DscProperty -ParameterFilter {
+                (-not $PesterBoundParameters.ContainsKey('IgnoreZeroEnumValue'))
+            } -Exactly -Times 1 -Scope It
+        }
+
+        It 'Should return the correct hashtable' {
+            InModuleScope -ScriptBlock {
+                $result = $mockResourceBaseInstance.GetDesiredState()
+                $result.Keys | Should -HaveCount 3
+                $result.MyResourceKeyProperty1 | Should -Be 'KeyValue'
+                $result.MyResourceProperty2 | Should -Be 'TestValue'
+                $result.MyResourceProperty3 | Should -Be 'Value3'
+            }
+        }
+    }
+
+    Context 'When FeatureOptionalEnums is enabled' {
+        BeforeAll {
+            $inModuleScopeScriptBlock = @'
+using module DscResource.Base
+
+enum MyMockEnum {
+    Value1 = 0
+    Value2 = 1
+    Value3 = 2
+}
+
+class MyMockResource : ResourceBase
+{
+    [DscProperty(Key)]
+    [System.String]
+    $MyResourceKeyProperty1
+
+    [DscProperty()]
+    [System.String]
+    $MyResourceProperty2
+
+    [DscProperty()]
+    [MyMockEnum]
+    $MyResourceEnumProperty = [MyMockEnum]::Value1
+
+    [DscProperty(NotConfigurable)]
+    [System.String]
+    $MyResourceReadProperty
+
+    MyMockResource () {
+        $this.FeatureOptionalEnums = $true
+    }
+}
+
+$script:mockResourceBaseInstance = [MyMockResource]::new()
+'@
+
+            InModuleScope -ScriptBlock ([Scriptblock]::Create($inModuleScopeScriptBlock))
+
+            Mock -CommandName Get-DscProperty
+        }
+
+        It 'Should have correctly instantiated the resource class' {
+            InModuleScope -ScriptBlock {
+                $mockResourceBaseInstance | Should -Not -BeNullOrEmpty
+                $mockResourceBaseInstance.GetType().BaseType.Name | Should -Be 'ResourceBase'
+            }
+        }
+
+        It 'Should call Get-DscProperty with the correct parameters including IgnoreZeroEnumValue' {
+            InModuleScope -ScriptBlock {
+                $null = $mockResourceBaseInstance.GetDesiredState()
+            }
+
+            Should -Invoke -CommandName Get-DscProperty -ParameterFilter {
+                $IgnoreZeroEnumValue -eq $true
+            } -Exactly -Times 1 -Scope It
+        }
+    }
+}