Changes to xComputerManagement and xPowerPlan

Added helper module to handle localizaton with Get-LocalizedData in xComputerManagement
Added localication to xPowerPlan
Improved error handling in xPowerPlan
Added comment-based help to example

DSCResources/CommonResourceHelper.psm1

@@ -0,0 +1,46 @@
+<#
+    .SYNOPSIS
+        Retrieves the localized string data based on the machine's culture.
+        Falls back to en-US strings if the machine's culture is not supported.
+
+    .PARAMETER ResourceName
+        The name of the resource as it appears before '.strings.psd1' of the localized string file.
+        For example:
+            WindowsOptionalFeature: MSFT_WindowsOptionalFeature
+            Service: MSFT_ServiceResource
+            Registry: MSFT_RegistryResource
+#>
+function Get-LocalizedData
+{
+    [CmdletBinding()]
+    param
+    (
+        [Parameter(Mandatory = $true)]
+        [ValidateNotNullOrEmpty()]
+        [String]
+        $ResourceName
+    )
+
+    $resourceDirectory = Join-Path -Path $PSScriptRoot -ChildPath $ResourceName
+    $localizedStringFileLocation = Join-Path -Path $resourceDirectory -ChildPath $PSUICulture
+
+    if (-not (Test-Path -Path $localizedStringFileLocation))
+    {
+        # Fallback to en-US
+        $localizedStringFileLocation = Join-Path -Path $resourceDirectory -ChildPath 'en-US'
+    }
+
+    Import-LocalizedData `
+        -BindingVariable 'localizedData' `
+        -FileName "$ResourceName.strings.psd1" `
+        -BaseDirectory $localizedStringFileLocation
+
+    return $localizedData
+}
+
+Export-ModuleMember -Function @(
+    'Test-IsNanoServer',
+    'New-InvalidArgumentException',
+    'New-InvalidOperationException',
+    'Get-LocalizedData'
+    )

DSCResources/MSFT_xPowerPlan/MSFT_xPowerPlan.psm1

@@ -1,3 +1,7 @@
+Import-Module -Name (Join-Path -Path (Split-Path -Path $PSScriptRoot -Parent) `
+                               -ChildPath 'CommonResourceHelper.psm1')
+$script:localizedData = Get-LocalizedData -ResourceName 'MSFT_xPowerPlan'
+
 <#
     .SYNOPSIS
         Returns the current state of the power plan.
@@ -23,42 +27,43 @@ function Get-TargetResource
         [System.String]
         $IsSingleInstance,
 
-        [parameter(Mandatory = $true)]
+        [Parameter(Mandatory = $true)]
         [ValidateNotNullOrEmpty()]
         [System.String]
         $Name
     )
 
+    $arguments = @{
+        Name = 'root\cimv2\power'
+        Class = 'Win32_PowerPlan'
+        Filter = "ElementName = '$Name'"
+    }
+
     try
     {
-        $arguments = @{
-            Name = 'root\cimv2\power'
-            Class = 'Win32_PowerPlan'
-            Filter = "ElementName = '$Name'"
-        }
-
         $plan = Get-CimInstance @arguments
-        if ($plan)
+    }
+    catch
+    {
+        throw ($script:localizedData.PowerPlanCIMError -f $($arguments.Class) )
+    }
+
+    if ($plan)
+    {
+        if( $plan.IsActive )
         {
-            if( $plan.IsActive )
-            {
-                Write-Verbose "The power plan '$Name' is the active plan"
-                $activePlanName = $Name
-            }
-            else
-            {
-                Write-Verbose "The power plan '$Name' is not the active plan"
-                $activePlanName = $null
-            }
+            Write-Verbose -Message ($script:localizedData.PowerPlanIsActive -f $Name)
+            $activePlanName = $Name
         }
         else
         {
-            throw "Unable to find the power plan $Name." 
+            Write-Verbose -Message ($script:localizedData.PowerPlanIsNotActive -f $Name)
+            $activePlanName = $null
         }
     }
-    catch
+    else
     {
-        throw $_
+        throw ($script:localizedData.PowerPlanNotFound -f $Name)
     }
 
     return @{
@@ -91,28 +96,36 @@ function Set-TargetResource
         [System.String]
         $IsSingleInstance,
 
-        [parameter(Mandatory = $true)]
+        [Parameter(Mandatory = $true)]
         [ValidateNotNullOrEmpty()]
         [System.String]
         $Name
     )
 
+    Write-Verbose -Message ($script:localizedData.PowerPlanIsBeingActivated -f $Name)
+
+    $arguments = @{
+        Name = 'root\cimv2\power'
+        Class = 'Win32_PowerPlan'
+        Filter = "ElementName = '$Name'"
+    }
+
     try
     {
-        Write-Verbose -Message "Activating power plan $Name"
-
-        $arguments = @{
-            Name = 'root\cimv2\power'
-            Class = 'Win32_PowerPlan'
-            Filter = "ElementName = '$Name'"
-        }
+        $plan = Get-CimInstance @arguments
+    }
+    catch
+    {
+        throw ($script:localizedData.PowerPlanCIMError -f $($arguments.Class) )
+    }
 
-        $plan = Get-CimInstance @arguments 
+    try
+    {
         $plan | Invoke-CimMethod -MethodName Activate
     }
     catch
     {
-        Throw "Unable to set the power plan $Name to the active plan. Error message: $($_.Exception.Message)" 
+        throw ($script:localizedData.PowerPlanWasUnableToBeSet -f $Name, $($_.Exception.Message))
     }
 }
 
@@ -141,16 +154,18 @@ function Test-TargetResource
         [System.String]
         $IsSingleInstance,
 
-        [parameter(Mandatory = $true)]
+        [Parameter(Mandatory = $true)]
         [ValidateNotNullOrEmpty()]
         [System.String]
         $Name
     )
 
     $returnValue = $false
 
-    $result = Get-TargetResource -IsSingleInstance $IsSingleInstance -Name $Name
-    if ($result.Name -eq $Name)
+    Write-Verbose -Message ($script:localizedData.PowerPlanIsBeingValidate -f $Name)
+
+    $getTargetResourceResult = Get-TargetResource -IsSingleInstance $IsSingleInstance -Name $Name
+    if ($getTargetResourceResult.Name -eq $Name)
     {
         $returnValue = $true
     }

DSCResources/MSFT_xPowerPlan/en-US/MSFT_xPowerPlan.schema.mfl

@@ -0,0 +1,6 @@
+[Description("This resource is used to activate a power plan.") : Amended,AMENDMENT, LOCALE("MS_409")]
+class MSFT_xPowerPlan : OMI_BaseResource
+{
+    [Key, Description("Specifies the resource is a single instance, the value must be 'Yes'") : Amended] String IsSingleInstance;
+    [Required, Description("The name of the power plan to activate.") : Amended] String Name;
+};

DSCResources/MSFT_xPowerPlan/en-US/MSFT_xPowerPlan.strings.psd1

@@ -0,0 +1,11 @@
+# Localized resources for WindowsOptionalFeature
+
+ConvertFrom-StringData @'
+    PowerPlanIsActive = The power plan '{0}' is the active plan.
+    PowerPlanIsNotActive = The power plan '{0}' is not the active plan.
+    PowerPlanNotFound = Unable to find the power plan '{0}'.
+    PowerPlanIsBeingActivated = Activating power plan '{0}'
+    PowerPlanIsBeingValidate = Validating power plan '{0}'
+    PowerPlanWasUnableToBeSet = Unable to set the power plan '{0}' to the active plan. Error message: {1}
+    PowerPlanCIMError = Could not get the Common Information Model (CIM) instances of class {0}
+'@

Examples/Sample_xPowerPlan.ps1

@@ -1,8 +1,17 @@
-configuration Sample_xPowerPlan
+<#
+    .SYNOPSIS
+        Example to set a power plan. 
+
+    .DESCRIPTION
+        This examples sets the active power plan to the 'High performance' plan. 
+#>
+Configuration Sample_xPowerPlan
 {
     param
     (
-        [string[]] $NodeName = 'localhost'
+        [Parameter()]
+        [String[]]
+        $NodeName = 'localhost'
     )
 
     Import-DSCResource -ModuleName xComputerManagement

Tests/Unit/MSFT_xPowerPlan.Tests.ps1

@@ -20,19 +20,13 @@ $TestEnvironment = Initialize-TestEnvironment `
 
 #endregion HEADER
 
-function Invoke-TestSetup {
-}
-
 function Invoke-TestCleanup {
     Restore-TestEnvironment -TestEnvironment $TestEnvironment
 }
 
 # Begin Testing
 try
 {
-
-    Invoke-TestSetup
-
     Describe "$($script:DSCResourceName)\Get-TargetResource" {
         BeforeEach {
             $testParameters = @{
@@ -78,8 +72,8 @@ try
                 } -ModuleName $script:DSCResourceName -Verifiable
             }
 
-            It 'Should throw an error' {
-                { Get-TargetResource @testParameters } | Should Throw
+            It 'Should throw the correct error' {
+                { Get-TargetResource @testParameters } | Should Throw 'Could not get the Common Information Model (CIM) instances of class Win32_PowerPlan'
             }
         }
 
@@ -91,7 +85,7 @@ try
             }
 
             It 'Should throw saying it was not able to find the plan High performance' {
-                { Get-TargetResource @testParameters } | Should Throw 'Unable to find the power plan High performance.'
+                { Get-TargetResource @testParameters } | Should Throw "Unable to find the power plan 'High performance'."
             }
         }
 
@@ -120,15 +114,27 @@ try
             }
         }
 
+        Context 'When the Get-CimInstance cannot retrive information about power plans' {
+            BeforeEach {
+                Mock -CommandName Get-CimInstance -MockWith {
+                    throw
+                } -ModuleName $script:DSCResourceName -Verifiable
+            }
+
+            It 'Should throw the correct error' {
+                { Set-TargetResource @testParameters } | Should Throw 'Could not get the Common Information Model (CIM) instances of class Win32_PowerPlan'
+            }
+        }
+
         Context 'When the Invoke-CimMethod throws an error' {
             BeforeEach {
                 Mock -CommandName Invoke-CimMethod -MockWith {
-                    throw
+                    throw 'Failed to set value'
                 } -ModuleName $script:DSCResourceName -Verifiable
             }
 
-            It 'Should catch the error thrown by Invoke-CimMethod' {
-                { Set-TargetResource @testParameters } | Should Throw
+            It 'Should catch the correct error thrown by Invoke-CimMethod' {
+                { Set-TargetResource @testParameters } | Should Throw "Unable to set the power plan 'High performance' to the active plan. Error message: Failed to set value"
             }
         }