Merge pull request #3 from gesbeckj/xDescription

Updates Based on Feedback including Naming Parameters, Expanding out MockWith, Changing Double Quotes to Single Quotes and adding descriptions to the schema

Author: gesbeckj

DSCResources/MSFT_xComputer/MSFT_xComputer.psm1

@@ -117,10 +117,10 @@ function Set-TargetResource
         $Name = $env:COMPUTERNAME
     }
 
-    Write-Verbose -message "Setting description to '$($Description)'."
-    $Win32_OperatingSystem = Get-CimInstance -ClassName Win32_OperatingSystem
-    $Win32_OperatingSystem.Description = $Description
-    Set-CimInstance -InputObject $Win32_OperatingSystem
+    Write-Verbose -Message "Setting computer description to '$($Description)'."
+    $win32OperatingSystemCimInstance = Get-CimInstance -ClassName Win32_OperatingSystem
+    $win32OperatingSystemCimInstance.Description = $Description
+    Set-CimInstance -InputObject $win32OperatingSystemCimInstance
 
     if ($Credential)
     {
@@ -304,6 +304,7 @@ function Test-TargetResource
     }
 
     Write-Verbose -Message 'Checking if description is corerect'
+
     if ($Description -ne (Get-CimInstance -Class 'Win32_OperatingSystem').Description)
     {
         return $false

DSCResources/MSFT_xComputer/MSFT_xComputer.schema.mof

@@ -1,12 +1,12 @@
 [ClassVersion("1.0.1.0"), FriendlyName("xComputer")]
 class MSFT_xComputer : OMI_BaseResource
 {
-    [key] string Name;
-    [write] string DomainName;
-    [write] string JoinOU;
-    [read] string CurrentOU;
-    [write,EmbeddedInstance("MSFT_Credential")] String Credential;
-    [write,EmbeddedInstance("MSFT_Credential")] String UnjoinCredential;
-    [write] string WorkGroupName;
-    [write] string Description;
+    [key, Description("The desired computer name")] string Name;
+    [write, Description("The name of the domain to join")] string DomainName;
+    [write, Description("The distinguished name of the organizational unit that the computer account will be created in")] string JoinOU;
+    [read, Description("A read-only property that specifies the organizational unit that the computer account is currently in")] string CurrentOU;
+    [write, EmbeddedInstance("MSFT_Credential"), Description("Credential to be used to join or leave domain")] String Credential;
+    [write, EmbeddedInstance("MSFT_Credential"), Description("Credential to be used to join or leave domain")] String UnjoinCredential;
+    [write, Description("The name of the workgroup")] string WorkGroupName;
+    [Write, Description("The value assigned here will be set as the local computer description")] String Description;
 };

README.md

@@ -53,7 +53,7 @@ xComputer resource has following properties:
 * Credential: Credential to be used to join or leave domain
 * CurrentOU: A read-only property that specifies the organizational unit that
   the computer account is currently in
-* Description: The value assigned here will be as the local computer description
+* Description: The value assigned here will be set as the local computer description
 
 ### xComputer Examples