Fix QA test for ChangelogManagement v3.0.1 (#405)

- Now the QA test that verifies that the Unreleased section header is present
  in the CHANGELOG.md correctly supports ChangelogManagement v3.0.1.
- The QA tests can now be debugged by `Invoke-Pester` directly, before it
  had to be started by the build script `build.ps1`. This will also help
  the Pester Tests VS Code extension to be able to run the tests.

Author: johlju

CHANGELOG.md

@@ -14,6 +14,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `Get-MofSchemaName`
   - Permanently skipped a test that the build worker `ubuntu-latest` were
     unable to run due to missing shared library 'libmi'.
+- Now the QA test that verifies that the Unreleased section header is present
+  in the CHANGELOG.md correctly supports ChangelogManagement v3.0.1.
 - Task `Convert_Pester_Coverage`
   - No longer throws an exception when there was just one missed command
     for a test suite. Fixes [#407](https://github.com/gaelcolas/Sampler/issues/407).
@@ -23,6 +25,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Task `Build_ModuleOutput_ModuleBuilder`
   - Proper support for DSC composite resources (*.schema.psm1).
 
+### Changed
+
+- The QA tests can now be debugged by `Invoke-Pester` directly, before it
+  had to be started by the build script `build.ps1`. This will also help
+  the Pester Tests VS Code extension to be able to run the tests.
+
 ## [0.116.0] - 2022-11-08
 
 ### Removed

Sampler/Templates/Sampler/module.tests.ps1.template

@@ -1,4 +1,16 @@
 BeforeDiscovery {
+    $projectPath = "$($PSScriptRoot)\..\.." | Convert-Path
+
+    <#
+        If the QA tests are run outside of the build script (e.g with Invoke-Pester)
+        the parent scope has not set the variable $ProjectName.
+    #>
+    if (-not $ProjectName)
+    {
+        # Assuming project folder name is project name.
+        $ProjectName = Get-SamplerProjectName -BuildRoot $projectPath
+    }
+
     $script:moduleName = $ProjectName
 
     Remove-Module -Name $script:moduleName -Force -ErrorAction SilentlyContinue
@@ -9,11 +21,21 @@ BeforeDiscovery {
 }
 
 BeforeAll {
-    $script:moduleName = $ProjectName
-
     # Convert-Path required for PS7 or Join-Path fails
     $projectPath = "$($PSScriptRoot)\..\.." | Convert-Path
 
+    <#
+        If the QA tests are run outside of the build script (e.g with Invoke-Pester)
+        the parent scope has not set the variable $ProjectName.
+    #>
+    if (-not $ProjectName)
+    {
+        # Assuming project folder name is project name.
+        $ProjectName = Get-SamplerProjectName -BuildRoot $projectPath
+    }
+
+    $script:moduleName = $ProjectName
+
     $sourcePath = (
         Get-ChildItem -Path $projectPath\*\*.psd1 |
             Where-Object -FilterScript {
@@ -57,7 +79,7 @@ Describe 'Changelog Management' -Tag 'Changelog' {
     }
 
     It 'Changelog should have an Unreleased header' -Skip:$skipTest {
-            (Get-ChangelogData -Path (Join-Path -Path $ProjectPath -ChildPath 'CHANGELOG.md') -ErrorAction Stop).Unreleased.RawData | Should -Not -BeNullOrEmpty
+            (Get-ChangelogData -Path (Join-Path -Path $ProjectPath -ChildPath 'CHANGELOG.md') -ErrorAction Stop).Unreleased | Should -Not -BeNullOrEmpty
     }
 }
 

tests/QA/module.tests.ps1

@@ -1,4 +1,16 @@
 BeforeDiscovery {
+    $projectPath = "$($PSScriptRoot)\..\.." | Convert-Path
+
+    <#
+        If the QA tests are run outside of the build script (e.g with Invoke-Pester)
+        the parent scope has not set the variable $ProjectName.
+    #>
+    if (-not $ProjectName)
+    {
+        # Assuming project folder name is project name.
+        $ProjectName = Get-SamplerProjectName -BuildRoot $projectPath
+    }
+
     $script:moduleName = $ProjectName
 
     Remove-Module -Name $script:moduleName -Force -ErrorAction SilentlyContinue
@@ -9,11 +21,21 @@ BeforeDiscovery {
 }
 
 BeforeAll {
-    $script:moduleName = $ProjectName
-
     # Convert-Path required for PS7 or Join-Path fails
     $projectPath = "$($PSScriptRoot)\..\.." | Convert-Path
 
+    <#
+        If the QA tests are run outside of the build script (e.g with Invoke-Pester)
+        the parent scope has not set the variable $ProjectName.
+    #>
+    if (-not $ProjectName)
+    {
+        # Assuming project folder name is project name.
+        $ProjectName = Get-SamplerProjectName -BuildRoot $projectPath
+    }
+
+    $script:moduleName = $ProjectName
+
     $sourcePath = (
         Get-ChildItem -Path $projectPath\*\*.psd1 |
             Where-Object -FilterScript {
@@ -57,7 +79,7 @@ Describe 'Changelog Management' -Tag 'Changelog' {
     }
 
     It 'Changelog should have an Unreleased header' -Skip:$skipTest {
-            (Get-ChangelogData -Path (Join-Path -Path $ProjectPath -ChildPath 'CHANGELOG.md') -ErrorAction Stop).Unreleased.RawData | Should -Not -BeNullOrEmpty
+            (Get-ChangelogData -Path (Join-Path -Path $ProjectPath -ChildPath 'CHANGELOG.md') -ErrorAction Stop).Unreleased | Should -Not -BeNullOrEmpty
     }
 }