adding changelog checks (#51)

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Added a new test type, `All`, to the `Initialize-TestEnvironment` function
   that initializes the DSC LCM and imports the module for testing ([issue #48](https://github.com/dsccommunity/DscResource.Test/issues/48)).
+- Added check on changelog when invoking by project path.
 
 ## [0.9.0] - 2019-12-27
 

build.yaml

@@ -41,7 +41,7 @@ BuildWorkflow:
   DscTest: |
     {
       Import-Module -force DscResource.Test
-      Invoke-DscResourceTest
+      Invoke-DscResourceTest -ExcludeTag 'Common Tests - Validate Localization'
     }
   t:
     - build

source/Tests/QA/Changelog.common.Tests.ps1

@@ -0,0 +1,61 @@
+[Diagnostics.CodeAnalysis.SuppressMessageAttribute('DscResource.AnalyzerRules\Measure-ParameterBlockParameterAttribute', '', Scope='Function', Target='*')]
+param (
+    $ModuleName,
+    $ModuleBase,
+    $ModuleManifest,
+    $ProjectPath,
+    $SourcePath,
+    $SourceManifest,
+    $Tag,
+    $ExcludeTag,
+    $ExcludeModuleFile,
+    $ExcludeSourceFile
+)
+
+if (!$ProjectPath)
+{
+    # Invoke-DscResourceTest is only looking at a built module, skipping this test file.
+    Write-Verbose "No Project path set: $ProjectPath. Skipping changelog checks."
+    return
+}
+else
+{
+    Write-Verbose "Pushing location $ProjectPath on Stack ProjectTest"
+    Push-Location -StackName ProjectTest -Path $ProjectPath
+}
+
+try
+{
+    Describe 'Changelog Management' -Tag 'Changelog' {
+
+        It 'Changelog has been updated' -skip:(
+            !([bool](Get-Command git -EA SilentlyContinue) -and
+              [bool](&(Get-Process -id $PID).Path -NoProfile -Command 'git rev-parse --is-inside-work-tree 2>$null'))
+            ) {
+            # Get the list of changed files compared with master
+            $HeadCommit = &git rev-parse HEAD
+            $MasterCommit = &git rev-parse origin/master
+            $filesChanged = &git diff $MasterCommit...$HeadCommit --name-only
+
+            if ($HeadCommit -ne $MasterCommit)
+            {
+                 # if we're not testing same commit (i.e. master..master)
+                $filesChanged.Where{
+                    (Split-Path $_ -Leaf) -match '^changelog.md'
+                } | Should -Not -BeNullOrEmpty
+            }
+        }
+
+        It 'Changelog format compliant with keepachangelog format' -skip:(
+            ![bool](Get-Command git -EA SilentlyContinue) -or
+            !(Import-Module -Name ChangelogManagement -ErrorAction SilentlyContinue -PassThru)
+            ) {
+            { Get-ChangelogData (Join-Path $ProjectPath 'CHANGELOG.md') -ErrorAction Stop } | Should -Not -Throw
+        }
+    }
+}
+finally
+{
+    Write-Debug "Poping location on Stack ProjectTest"
+    Pop-Location -StackName ProjectTest
+}

source/Tests/QA/PSSAResource.common.Tests.ps1

@@ -67,11 +67,11 @@ $DscResourceAnalyzerRulesModule = Import-Module DscResource.AnalyzerRules -PassT
 
 Describe 'Common Tests - PS Script Analyzer on Resource Files' -Tag DscPSSA,'Common Tests - PS Script Analyzer on Resource Files' {
 
-    $dscResourcesPsm1Files = Get-ChildItem -Path $ModuleBase -Include *.psm1 -Recurse | WhereModuleFileNotExcluded
+    $dscResourcesPsm1Files = @(Get-ChildItem -Path $ModuleBase -Include *.psm1 -Recurse | WhereModuleFileNotExcluded)
 
     if ($SourcePath)
     {
-        $dscResourcesPsm1Files += Get-ChildItem -Path $SourcePath -Include *.psm1 -Recurse | WhereSourceFileNotExcluded
+        $dscResourcesPsm1Files += @(Get-ChildItem -Path $SourcePath -Include *.psm1 -Recurse | WhereSourceFileNotExcluded)
     }
 
     foreach ($dscResourcesPsm1File in $dscResourcesPsm1Files)