BREAKING: WSManListener: Convert to a Class Resource (#106)

Author: dan-hughes

CHANGELOG.md

@@ -5,6 +5,31 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- `WSManReason`
+  - Used in Class Resources.
+- `WSManSubjectFormat` Enum.
+- `WSManTransport` Enum.
+- `RequiredModules`
+  - Added `DscResource.Base` class.
+
+### Changed
+
+- `DSC_WSManListener`
+  - Converted to Class Resource.
+  - Extracted private functions to individual files.
+  - BREAKING: Renamed parameter `DN` to `BaseDN` - fixes [Issue #89](https://github.com/dsccommunity/WSManDsc/issues/89).
+- `DSC_WSManConfig`
+  - Removed Export-ModuleMember.
+- `DSC_WSManServiceConfig`
+  - Removed Export-ModuleMember.
+
+### Removed
+
+- `CommonTestHelper`
+  - This is now provided by `DscResource.Test`
+
 ## [3.2.0] - 2025-01-19
 
 ### Added

RequiredModules.psd1

@@ -1,5 +1,5 @@
 @{
-    PSDependOptions             = @{
+    PSDependOptions                = @{
         AddToPath  = $true
         Target     = 'output\RequiredModules'
         Parameters = @{
@@ -21,12 +21,18 @@
 
     # Build dependencies needed for using the module
     'DscResource.Common'           = 'latest'
+    'DscResource.Base'             = 'latest'
 
     # Analyzer rules
     'DscResource.AnalyzerRules'    = 'latest'
     'Indented.ScriptAnalyzerRules' = 'latest'
 
     # Prerequisite modules for documentation.
-    'DscResource.DocGenerator'     = 'latest'
+    'DscResource.DocGenerator'     = @{
+        Version    = 'latest'
+        Parameters = @{
+            AllowPrerelease = $true
+        }
+    }
     PlatyPS                        = 'latest'
 }

azure-pipelines.yml

@@ -61,7 +61,7 @@ stages:
         displayName: 'HQRM'
         pool:
           vmImage: 'windows-latest'
-        timeoutInMinutes: 0
+        timeoutInMinutes: '0'
         steps:
           - task: DownloadPipelineArtifact@2
             displayName: 'Download Pipeline Artifact'
@@ -90,7 +90,7 @@ stages:
         displayName: 'Unit (Windows Server 2019)'
         pool:
           vmImage: 'windows-2019'
-        timeoutInMinutes: 0
+        timeoutInMinutes: '0'
         steps:
           - task: DownloadPipelineArtifact@2
             displayName: 'Download Pipeline Artifact'
@@ -127,7 +127,7 @@ stages:
         dependsOn: Test_Unit_2019
         pool:
           vmImage: 'ubuntu-latest'
-        timeoutInMinutes: 0
+        timeoutInMinutes: '0'
         steps:
           - task: DownloadPipelineArtifact@2
             displayName: 'Download Pipeline Artifact'
@@ -158,7 +158,7 @@ stages:
         displayName: 'Integration (Windows Server 2019)'
         pool:
           vmImage: 'windows-2019'
-        timeoutInMinutes: 0
+        timeoutInMinutes: '0'
         steps:
           - task: DownloadPipelineArtifact@2
             displayName: 'Download Pipeline Artifact'
@@ -195,7 +195,7 @@ stages:
         displayName: 'Unit (Windows Server 2022)'
         pool:
           vmImage: 'windows-2022'
-        timeoutInMinutes: 0
+        timeoutInMinutes: '0'
         steps:
           - task: DownloadPipelineArtifact@2
             displayName: 'Download Pipeline Artifact'
@@ -224,7 +224,7 @@ stages:
         displayName: 'Integration (Windows Server 2022)'
         pool:
           vmImage: 'windows-2022'
-        timeoutInMinutes: 0
+        timeoutInMinutes: '0'
         steps:
           - task: DownloadPipelineArtifact@2
             displayName: 'Download Pipeline Artifact'

build.yaml

@@ -45,7 +45,6 @@ CopyPaths:
   - en-US
   - DSCResources
 Prefix: prefix.ps1
-Suffix: suffix.ps1
 Encoding: UTF8
 VersionedOutputDirectory: true
 BuiltModuleSubdirectory: builtModule
@@ -80,11 +79,15 @@ NestedModule:
     Path: ./output/RequiredModules/DscResource.Common
     AddToManifest: false
     Exclude: PSGetModuleInfo.xml
+  DscResource.Base:
+    CopyOnly: true
+    Path: ./output/RequiredModules/DscResource.Base
+    AddToManifest: false
+    Exclude: PSGetModuleInfo.xml
 
 ####################################################
 #          Pester Configuration (Sampler)          #
 ####################################################
-
 Pester:
   Configuration:
     Run:
@@ -105,8 +108,6 @@ Pester:
   ExcludeFromCodeCoverage:
     - Modules/DscResource.Common
     - Modules/DscResource.Base
-    - prefix.ps1
-    - WSManDsc.psm1
 
 ####################################################
 #      Pester Configuration (DscResource.Test)     #
@@ -169,7 +170,7 @@ DscResource.DocGenerator:
       - '\*(.+?)\*' # Match Italic (asterisk)
   Publish_GitHub_Wiki_Content:
     Debug: false
-  Generate_Wiki_Content:
+  Generate_Markdown_For_DSC_Resources:
     MofResourceMetadata:
       Type: MofResource
       Category: Resources

source/Build.psd1

@@ -0,0 +1,21 @@
+<#
+    .SYNOPSIS
+        The reason a property of a DSC resource is not in desired state.
+
+    .DESCRIPTION
+        A DSC resource can have a read-only property `Reasons` that the compliance
+        part (audit via Azure Policy) of Azure AutoManage Machine Configuration
+        uses. The property Reasons holds an array of WSManReason. Each WSManReason
+        explains why a property of a DSC resource is not in desired state.
+#>
+
+class WSManReason
+{
+    [DscProperty()]
+    [System.String]
+    $Code
+
+    [DscProperty()]
+    [System.String]
+    $Phrase
+}