BREAKING: SChannelProtocol Class-Based (#72)

* Merge main

* Delete protocol tests

* Add Reason

* Add protocolbase class

* Add protocol server and client resources

* Add strings files

* Update changelog

* Update examples

* Update changelog

* Fix tests

* Remove use of Where-Object

* Fix reasons assertions

* Protocol Client integration tests

* Update tests

* Config

* Formatting

* Update

* Make deploy depend on all tests

* Update

* Update

* Update

* Add import

* Update

* Update

* Update

* Update

* Test

* Test

* Add dir per config

* Use flags on enum

* Add helper method to convert a enum to the individual flag values

* Use enum with flags

* Int tests

* Fix

* Remove Type

* Fix HQRM

* Fix type

* Disable tests

* No need to convert

* Fix text

* Testing

* Only assign if there are values

* test for empty

* fix

* Set values

* fix

* Int tests

* assign var

* fix

* Revert "Use flags on enum"

This reverts commit 9843e2e.

* Reapply "Use flags on enum"

This reverts commit 13bde73.

* Use string array as enum array or enum with flags does not produce valid MOF.

* Add protocol server integration tests

* Add property assertion

* Add clear

* Fix assert

* Remove clear flag

* Set Next version

* Remove old codecov config

* Remove commented config

* Fill in missing issue descriptions

* Update synopsis'

* Use unique GUIDs

* CodeRabbit fixes

* Coderabbit fixes

* Update Description

* Fix message

* Only run Integration Test files.

* Add space

* Fix tests

* Revert "Set Next version"

This reverts commit 4a5fd64.

* Fix formatting

* Use real GUIDs

* Add comment based help

* Update exmaple formatting

* CodeRabbit suggestions

* ModuleFast fixes current issues with PSResourceGet

* Use latest GitHubTasks

* Fix convergence issue

* Modify update

* Fixes

* Fix logic

* Debug

* Fix default protocols

* Fix

* Remove debug

* Add test coverage

Author: dan-hughes

.codecov.yml

@@ -19,6 +19,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Test-TlsProtocol
 - Enum
   - SChannelSslProtocols
+- BREAKING: Converted Protocol to class-based resource [issue #50](https://github.com/dsccommunity/SChannelDsc/issues/50).
+  - This now consists of two resources
+    - SChannelProtocolClient
+    - SChannelProtocolServer
+  - Add DTLS support [issue #37](https://github.com/dsccommunity/SChannelDsc/issues/37).
 
 ### Changed
 
@@ -44,6 +49,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Convert-SCDscCIMInstanceToString
   - Convert-SCDscHashtableToString
   - Test-SCDscObjectHasProperty
+- Protocol Resource - Replaced by class resources
 
 ## [1.5.0] - 2026-01-27
 

CHANGELOG.md

@@ -25,15 +25,3 @@ branches:
 ignore:
   sha: []
 merge-message-formats: {}
-
-
-# feature:
-#   tag: useBranchName
-#   increment: Minor
-#   regex: f(eature(s)?)?[/-]
-#   source-branches: ['master']
-# hotfix:
-#   tag: fix
-#   increment: Patch
-#   regex: (hot)?fix(es)?[/-]
-#   source-branches: ['master']

GitVersion.yml

@@ -14,13 +14,19 @@
     ModuleBuilder                  = 'latest'
     ChangelogManagement            = 'latest'
     Sampler                        = 'latest'
-    'Sampler.GitHubTasks'          = 'latest'
+    'Sampler.GitHubTasks'          = @{
+        Version    = 'latest'
+        Parameters = @{
+            AllowPrerelease = $true
+        }
+    }
     MarkdownLinkCheck              = 'latest'
     'DscResource.Test'             = 'latest'
     xDscResourceDesigner           = 'latest'
 
     # Build dependencies needed for using the module
     'DscResource.Common'           = 'latest'
+    'DscResource.Base'             = 'latest'
 
     # Analyzer rules
     'DscResource.AnalyzerRules'    = 'latest'

RequiredModules.psd1

@@ -67,7 +67,7 @@
         set to $false then PowerShellGet will be used to resolve dependencies.
     #>
     UsePSResourceGet = $true
-    #PSResourceGetVersion = '1.0.1'
+    # PSResourceGetVersion = '1.0.1'
 
     # PowerShellGet compatibility module only works when using PSResourceGet or ModuleFast.
     UsePowerShellGetCompatibilityModule = $true

Resolve-Dependency.psd1

@@ -167,9 +167,57 @@ stages:
               bash <(curl -s https://codecov.io/bash) -f "./$(buildFolderName)/$(testResultFolderName)/JaCoCo_coverage.xml"
             displayName: 'Publish Code Coverage to Codecov.io'
 
+  - stage: Integration_Test
+    displayName: 'Integration Test'
+    dependsOn: Build
+    jobs:
+      - job: Test_Integration
+        displayName: 'Integration'
+        strategy:
+          matrix:
+            Windows Server 2022:
+              vmImage: 'windows-2022'
+            Windows Server 2025:
+              vmImage: 'windows-2025'
+        pool:
+          vmImage: $(vmImage)
+        timeoutInMinutes: '0'
+        steps:
+          - task: DownloadPipelineArtifact@2
+            displayName: 'Download Pipeline Artifact'
+            inputs:
+              buildType: 'current'
+              artifactName: $(buildArtifactName)
+              targetPath: '$(Build.SourcesDirectory)/$(buildArtifactName)'
+
+          - task: PowerShell@2
+            name: configureWinRM
+            displayName: 'Configure WinRM'
+            inputs:
+              targetType: 'inline'
+              script: 'winrm quickconfig -quiet'
+              pwsh: false
+
+          - task: PowerShell@2
+            name: test
+            displayName: 'Run Integration Test'
+            inputs:
+              filePath: './build.ps1'
+              arguments: "-Tasks test -PesterScript 'tests/Integration/Resources/DSC_*.Integration.Tests.ps1' -CodeCoverageThreshold 0"
+              pwsh: false
+
+          - task: PublishTestResults@2
+            displayName: 'Publish Test Results'
+            inputs:
+              testResultsFormat: 'NUnit'
+              testResultsFiles: '$(buildFolderName)/$(testResultFolderName)/NUnit*.xml'
+              testRunTitle: 'Integration $(vmImage)'
+            condition: succeededOrFailed()
+
   - stage: Deploy
     dependsOn:
       - Quality_Test_and_Unit_Test
+      - Integration_Test
     condition: |
       and(
         succeeded(),

azure-pipelines.yml

@@ -87,6 +87,11 @@ 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
   SChannelDsc.Common:
     Prefix: prefix.ps1
     VersionedOutputDirectory: false
@@ -115,6 +120,7 @@ Pester:
       OutputEncoding: ascii
   ExcludeFromCodeCoverage:
     - Modules/DscResource.Common
+    - Modules/DscResource.Base
 
 ####################################################
 #           Code Coverage Configuration            #
@@ -148,6 +154,7 @@ DscTest:
       - output
     ExcludeModuleFile:
       - Modules/DscResource.Common
+      - Modules/DscResource.Base
       # Must exclude built module file because it should not be tested like MOF-based resources
       - SChannelDsc.psm1
     MainGitBranch: main

build.yaml

@@ -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 SChannelReason. Each SChannelReason
+        explains why a property of a DSC resource is not in desired state.
+#>
+
+class SChannelReason
+{
+    [DscProperty()]
+    [System.String]
+    $Code
+
+    [DscProperty()]
+    [System.String]
+    $Phrase
+}