Merge pull request #84 from PowerShell/dev

Release of version 3.3.0.0 of ActiveDirectoryCSDsc
dsccommunity · May 15, 2019 · ba0aecc · ba0aecc
2 parents 9614a48 + 02c0bb1
commit ba0aecc
Show file tree

Hide file tree

Showing 20 changed files with 1,183 additions and 373 deletions.
diff --git a/.MetaTestOptIn.json b/.MetaTestOptIn.json
@@ -9,5 +9,6 @@
         "Common Tests - Custom Script Analyzer Rules",
         "Common Tests - Validate Example Files To Be Published",
         "Common Tests - Validate Markdown Links",
-        "Common Tests - Relative Path Length"
+        "Common Tests - Relative Path Length",
+        "Common Tests - Validate Localization"
 ]
diff --git a/ActiveDirectoryCSDsc.psd1 b/ActiveDirectoryCSDsc.psd1
@@ -1,6 +1,6 @@
 @{
     # Version number of this module.
-    moduleVersion = '3.2.0.0'
+    moduleVersion = '3.3.0.0'
 
     # ID used to uniquely identify this module
     GUID              = 'f8ddd7fc-c6d6-469e-8a80-c96efabe2fcc'
@@ -62,26 +62,16 @@
             # IconUri = ''
 
             # ReleaseNotes of this module
-        ReleaseNotes = '- Added "DscResourcesToExport" to manifest to improve information in
-  PowerShell Gallery - fixes [Issue 68](https://github.com/PowerShell/ActiveDirectoryCSDsc/issues/68).
-- Removed unused CAType variables and references in AdcsOnlineResponder - fixes
-  [issue 52](https://github.com/PowerShell/ActiveDirectoryCSDsc/issues/52).
-- Updated Examples to enable publising to PowerShell Gallery - fixes
-  [issue 54](https://github.com/PowerShell/ActiveDirectoryCSDsc/issues/54).
-- Cleaned up property alignment in module manifest file.
-- Added new resource AdcsOcspExtension - see [Issue 70](https://github.com/PowerShell/ActiveDirectoryCSDsc/issues/70).
-  - Added new ActiveDirectoryCSDsc.CommonHelper.psm1 helper module and unit test.
-  - Added stub function to /Tests/TestHelpers (ADCSStub.psm1) so Pester tests
-    can run without having to install ADCSAdministration module.
-- Converted module to auto-documentation Wiki - fixes [Issue 53](https://github.com/PowerShell/ActiveDirectoryCSDsc/issues/53).
-- Enabled Example publishing to PSGallery.
-- Moved change log to CHANGELOG.MD.
-- Opted into Common Tests "Validate Example Files To Be Published",
-  "Validate Markdown Links" and "Relative Path Length".
-- Correct AppVeyor `Invoke-AppveyorAfterTestTask` - fixes [Issue 73](https://github.com/PowerShell/ActiveDirectoryCSDsc/issues/73).
+        ReleaseNotes = '- Remove reference to StorageDsc in README.md - fixes [Issue 76](https://github.com/PowerShell/ActiveDirectoryCSDsc/issues/76).
+- Combined all `ActiveDirectoryCSDsc.ResourceHelper` module functions into
+  `ActiveDirectoryCSDsc.Common` module and renamed to `ActiveDirectoryCSDsc.CommonHelper`
+  module.
+- Opted into Common Tests "Common Tests - Validate Localization" -
+  fixes [Issue 82](https://github.com/PowerShell/ActiveDirectoryCSDsc/issues/82).
 
 '
         } # End of PSData hashtable
     } # End of PrivateData hashtable
 }
 
+
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,15 @@
 
 ## Unreleased
 
+## 3.3.0.0
+
+- Remove reference to StorageDsc in README.md - fixes [Issue #76](https://github.com/PowerShell/ActiveDirectoryCSDsc/issues/76).
+- Combined all `ActiveDirectoryCSDsc.ResourceHelper` module functions into
+  `ActiveDirectoryCSDsc.Common` module and renamed to `ActiveDirectoryCSDsc.CommonHelper`
+  module.
+- Opted into Common Tests 'Common Tests - Validate Localization' -
+  fixes [Issue #82](https://github.com/PowerShell/ActiveDirectoryCSDsc/issues/82).
+
 ## 3.2.0.0
 
 - Added 'DscResourcesToExport' to manifest to improve information in

diff --git a/DSCResources/MSFT_AdcsCertificationAuthority/MSFT_AdcsCertificationAuthority.psm1 b/DSCResources/MSFT_AdcsCertificationAuthority/MSFT_AdcsCertificationAuthority.psm1
@@ -1,14 +1,12 @@
 $modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'
 
-# Import the ADCS Deployment Resource Helper Module.
+# Import the ADCS Deployment Resource Common Module.
 Import-Module -Name (Join-Path -Path $modulePath `
-        -ChildPath (Join-Path -Path 'ActiveDirectoryCSDsc.ResourceHelper' `
-            -ChildPath 'ActiveDirectoryCSDsc.ResourceHelper.psm1'))
+        -ChildPath (Join-Path -Path 'ActiveDirectoryCSDsc.Common' `
+            -ChildPath 'ActiveDirectoryCSDsc.Common.psm1'))
 
 # Import Localization Strings.
-$LocalizedData = Get-LocalizedData `
-    -ResourceName 'MSFT_AdcsCertificationAuthority' `
-    -ResourcePath (Split-Path -Parent $script:MyInvocation.MyCommand.Path)
+$script:localizedData = Get-LocalizedData -ResourceName 'MSFT_AdcsCertificationAuthority'
 
 <#
     .SYNOPSIS
@@ -203,7 +201,7 @@ Function Get-TargetResource
 
     Write-Verbose -Message ( @(
             "$($MyInvocation.MyCommand): "
-            $($LocalizedData.GettingAdcsCAStatusMessage -f $CAType)
+            $($script:localizedData.GettingAdcsCAStatusMessage -f $CAType)
         ) -join '' )
 
     $adcsParameters = @{} + $PSBoundParameters
@@ -431,7 +429,7 @@ Function Set-TargetResource
 
     Write-Verbose -Message ( @(
             "$($MyInvocation.MyCommand): "
-            $($LocalizedData.SettingAdcsCAStatusMessage -f $CAType)
+            $($script:localizedData.SettingAdcsCAStatusMessage -f $CAType)
         ) -join '' )
 
     $adcsParameters = @{} + $PSBoundParameters
@@ -453,7 +451,7 @@ Function Set-TargetResource
         {
             Write-Verbose -Message ( @(
                     "$($MyInvocation.MyCommand): "
-                    $($LocalizedData.InstallingAdcsCAMessage -f $CAType)
+                    $($script:localizedData.InstallingAdcsCAMessage -f $CAType)
                 ) -join '' )
 
             $resultObject = Install-AdcsCertificationAuthority @adcsParameters -Force
@@ -470,7 +468,7 @@ Function Set-TargetResource
         {
             Write-Verbose -Message ( @(
                     "$($MyInvocation.MyCommand): "
-                    $($LocalizedData.UninstallingAdcsCAMessage -f $CAType)
+                    $($script:localizedData.UninstallingAdcsCAMessage -f $CAType)
                 ) -join '' )
 
             $resultObject = Uninstall-AdcsCertificationAuthority -Force
@@ -676,7 +674,7 @@ Function Test-TargetResource
 
     Write-Verbose -Message ( @(
             "$($MyInvocation.MyCommand): "
-            $($LocalizedData.TestingAdcsCAStatusMessage -f $CAType)
+            $($script:localizedData.TestingAdcsCAStatusMessage -f $CAType)
         ) -join '' )
 
     $adcsParameters = @{} + $PSBoundParameters
@@ -701,7 +699,7 @@ Function Test-TargetResource
                 # CA is not installed but should be - change required
                 Write-Verbose -Message ( @(
                         "$($MyInvocation.MyCommand): "
-                        $($LocalizedData.AdcsCANotInstalledButShouldBeMessage -f $CAType)
+                        $($script:localizedData.AdcsCANotInstalledButShouldBeMessage -f $CAType)
                     ) -join '' )
 
                 return $false
@@ -712,7 +710,7 @@ Function Test-TargetResource
                 # CA is not installed and should not be - change not required
                 Write-Verbose -Message ( @(
                         "$($MyInvocation.MyCommand): "
-                        $($LocalizedData.AdcsCANotInstalledAndShouldNotBeMessage -f $CAType)
+                        $($script:localizedData.AdcsCANotInstalledAndShouldNotBeMessage -f $CAType)
                     ) -join '' )
 
                 return $true
@@ -729,7 +727,7 @@ Function Test-TargetResource
                 # CA is installed and should be - change not required
                 Write-Verbose -Message ( @(
                         "$($MyInvocation.MyCommand): "
-                        $($LocalizedData.AdcsCAInstalledAndShouldBeMessage -f $CAType)
+                        $($script:localizedData.AdcsCAInstalledAndShouldBeMessage -f $CAType)
                     ) -join '' )
 
                 return $true
@@ -740,7 +738,7 @@ Function Test-TargetResource
                 # CA is installed and should not be - change required
                 Write-Verbose -Message ( @(
                         "$($MyInvocation.MyCommand): "
-                        $($LocalizedData.AdcsCAInstalledButShouldNotBeMessage -f $CAType)
+                        $($script:localizedData.AdcsCAInstalledButShouldNotBeMessage -f $CAType)
                     ) -join '' )
 
                 return $false

diff --git a/...T_AdcsCertificationAuthority.strings.psd1 → ...T_AdcsCertificationAuthority.strings.psd1 b/...T_AdcsCertificationAuthority.strings.psd1 → ...T_AdcsCertificationAuthority.strings.psd1
diff --git a/DSCResources/MSFT_AdcsEnrollmentPolicyWebService/MSFT_AdcsEnrollmentPolicyWebService.psm1 b/DSCResources/MSFT_AdcsEnrollmentPolicyWebService/MSFT_AdcsEnrollmentPolicyWebService.psm1
@@ -1,14 +1,12 @@
 $modulePath = Join-Path -Path (Split-Path -Path (Split-Path -Path $PSScriptRoot -Parent) -Parent) -ChildPath 'Modules'
 
-# Import the ADCS Deployment Resource Helper Module.
+# Import the ADCS Deployment Resource Common Module.
 Import-Module -Name (Join-Path -Path $modulePath `
-        -ChildPath (Join-Path -Path 'ActiveDirectoryCSDsc.ResourceHelper' `
-            -ChildPath 'ActiveDirectoryCSDsc.ResourceHelper.psm1'))
+        -ChildPath (Join-Path -Path 'ActiveDirectoryCSDsc.Common' `
+            -ChildPath 'ActiveDirectoryCSDsc.Common.psm1'))
 
 # Import Localization Strings.
-$LocalizedData = Get-LocalizedData `
-    -ResourceName 'MSFT_AdcsEnrollmentPolicyWebService' `
-    -ResourcePath (Split-Path -Parent $script:MyInvocation.MyCommand.Path)
+$script:localizedData = Get-LocalizedData -ResourceName 'MSFT_AdcsEnrollmentPolicyWebService'
 
 <#
     .SYNOPSIS
@@ -69,7 +67,7 @@ Function Get-TargetResource
 
     Write-Verbose -Message ( @(
             "$($MyInvocation.MyCommand): "
-            $($LocalizedData.GettingAdcsEnrollmentPolicyWebServiceStatusMessage -f $AuthenticationType)
+            $($script:localizedData.GettingAdcsEnrollmentPolicyWebServiceStatusMessage -f $AuthenticationType)
         ) -join '' )
 
     $installed = Test-AdcsEnrollmentPolicyWebServiceInstallState `
@@ -151,7 +149,7 @@ Function Set-TargetResource
 
     Write-Verbose -Message ( @(
             "$($MyInvocation.MyCommand): "
-            $($LocalizedData.SettingAdcsEnrollmentPolicyWebServiceStatusMessage -f $AuthenticationType)
+            $($script:localizedData.SettingAdcsEnrollmentPolicyWebServiceStatusMessage -f $AuthenticationType)
         ) -join '' )
 
     $adcsEnrollmentPolicyWebServiceParameters = @{} + $PSBoundParameters
@@ -169,7 +167,7 @@ Function Set-TargetResource
             {
                 Write-Verbose -Message ( @(
                         "$($MyInvocation.MyCommand): "
-                        $($LocalizedData.InstallingAdcsEnrollmentPolicyWebServiceMessage -f $AuthenticationType)
+                        $($script:localizedData.InstallingAdcsEnrollmentPolicyWebServiceMessage -f $AuthenticationType)
                     ) -join '' )
 
                 $errorMessage = (Install-AdcsEnrollmentPolicyWebService @adcsEnrollmentPolicyWebServiceParameters -Force).ErrorString
@@ -182,7 +180,7 @@ Function Set-TargetResource
 
                 Write-Verbose -Message ( @(
                         "$($MyInvocation.MyCommand): "
-                        $($LocalizedData.UninstallingAdcsEnrollmentPolicyWebServiceMessage -f $AuthenticationType)
+                        $($script:localizedData.UninstallingAdcsEnrollmentPolicyWebServiceMessage -f $AuthenticationType)
                     ) -join '' )
 
                 $errorMessage = (Uninstall-AdcsEnrollmentPolicyWebService @adcsEnrollmentPolicyWebServiceParameters -Force).ErrorString
@@ -198,7 +196,7 @@ Function Set-TargetResource
     {
         Write-Verbose -Message ( @(
             "$($MyInvocation.MyCommand): "
-            $($LocalizedData.AdcsEnrollmentPolicyWebServiceErrorMessage -f $errorMessage)
+            $($script:localizedData.AdcsEnrollmentPolicyWebServiceErrorMessage -f $errorMessage)
         ) -join '' )
         New-InvalidOperationException -Message $errorMessage
     }
@@ -266,7 +264,7 @@ Function Test-TargetResource
 
     Write-Verbose -Message ( @(
             "$($MyInvocation.MyCommand): "
-            $($LocalizedData.TestingAdcsEnrollmentPolicyWebServiceStatusMessage -f $AuthenticationType)
+            $($script:localizedData.TestingAdcsEnrollmentPolicyWebServiceStatusMessage -f $AuthenticationType)
         ) -join '' )
 
     $installed = Test-AdcsEnrollmentPolicyWebServiceInstallState `
@@ -283,7 +281,7 @@ Function Test-TargetResource
                 # CA is installed and should be - change not required
                 Write-Verbose -Message ( @(
                         "$($MyInvocation.MyCommand): "
-                        $($LocalizedData.AdcsEnrollmentPolicyWebServiceInstalledAndShouldBeMessage -f $AuthenticationType)
+                        $($script:localizedData.AdcsEnrollmentPolicyWebServiceInstalledAndShouldBeMessage -f $AuthenticationType)
                     ) -join '' )
 
                 return $true
@@ -294,7 +292,7 @@ Function Test-TargetResource
                 # CA is installed and should not be - change required
                 Write-Verbose -Message ( @(
                         "$($MyInvocation.MyCommand): "
-                        $($LocalizedData.AdcsEnrollmentPolicyWebServiceInstalledButShouldNotBeMessage -f $AuthenticationType)
+                        $($script:localizedData.AdcsEnrollmentPolicyWebServiceInstalledButShouldNotBeMessage -f $AuthenticationType)
                     ) -join '' )
 
                 return $false
@@ -311,7 +309,7 @@ Function Test-TargetResource
                 # CA is not installed but should be - change required
                 Write-Verbose -Message ( @(
                         "$($MyInvocation.MyCommand): "
-                        $($LocalizedData.AdcsEnrollmentPolicyWebServiceNotInstalledButShouldBeMessage -f $AuthenticationType)
+                        $($script:localizedData.AdcsEnrollmentPolicyWebServiceNotInstalledButShouldBeMessage -f $AuthenticationType)
                     ) -join '' )
 
                 return $false
@@ -322,7 +320,7 @@ Function Test-TargetResource
                 # CA is not installed and should not be - change not required
                 Write-Verbose -Message ( @(
                         "$($MyInvocation.MyCommand): "
-                        $($LocalizedData.AdcsEnrollmentPolicyWebServiceNotInstalledAndShouldNotBeMessage -f $AuthenticationType)
+                        $($script:localizedData.AdcsEnrollmentPolicyWebServiceNotInstalledAndShouldNotBeMessage -f $AuthenticationType)
                     ) -join '' )
 
                 return $true
@@ -365,7 +363,7 @@ Function Test-AdcsEnrollmentPolicyWebServiceInstallState
 
     Write-Verbose -Message ( @(
             "$($MyInvocation.MyCommand): "
-            $($LocalizedData.TestingAdcsEnrollmentPolicyWebServiceInstallStateMessage -f $AuthenticationType, $KeyBasedRenewal)
+            $($script:localizedData.TestingAdcsEnrollmentPolicyWebServiceInstallStateMessage -f $AuthenticationType, $KeyBasedRenewal)
         ) -join '' )
 
     # Determine the expected name of the Web Application
@@ -398,7 +396,7 @@ Function Test-AdcsEnrollmentPolicyWebServiceInstallState
     {
         Write-Verbose -Message ( @(
             "$($MyInvocation.MyCommand): "
-            $($LocalizedData.AdcsEnrollmentPolicyWebServiceInstallIsNotInstalledMessage -f $AuthenticationType, $KeyBasedRenewal)
+            $($script:localizedData.AdcsEnrollmentPolicyWebServiceInstallIsNotInstalledMessage -f $AuthenticationType, $KeyBasedRenewal)
         ) -join '' )
 
         return $false
@@ -407,7 +405,7 @@ Function Test-AdcsEnrollmentPolicyWebServiceInstallState
     {
         Write-Verbose -Message ( @(
             "$($MyInvocation.MyCommand): "
-            $($LocalizedData.AdcsEnrollmentPolicyWebServiceInstallIsInstalledMessage -f $AuthenticationType, $KeyBasedRenewal)
+            $($script:localizedData.AdcsEnrollmentPolicyWebServiceInstallIsInstalledMessage -f $AuthenticationType, $KeyBasedRenewal)
         ) -join '' )
 
         return $true
@@ -518,7 +516,7 @@ function Test-Thumbprint
             else
             {
                 New-InvalidOperationException `
-                    -Message ($LocalizedData.InvalidHashError -f $hash)
+                    -Message ($script:localizedData.InvalidHashAlgorithmErrorMessage -f $hash)
             }
         }
     }

diff --git a/...csEnrollmentPolicyWebService.strings.psd1 → ...csEnrollmentPolicyWebService.strings.psd1 b/...csEnrollmentPolicyWebService.strings.psd1 → ...csEnrollmentPolicyWebService.strings.psd1
@@ -14,4 +14,5 @@ ConvertFrom-StringData @'
     AdcsEnrollmentPolicyWebServiceInstallIsInstalledMessage = ADCS Enrollment Policy Web Service with authentication mode '{0}' and key based renewal is '{1}' is installed.
     AdcsEnrollmentPolicyWebServiceInstallIsNotInstalledMessage = ADCS Enrollment Policy Web Service with authentication mode '{0}' and key based renewal is '{1}' is not installed.
     AdcsEnrollmentPolicyWebServiceErrorMessage = An installation/uninstallation error occured: {0}
+    InvalidHashAlgorithmErrorMessage = '{0}' is not a valid hash.
 '@