Updated Tests

Author: lipkau

CHANGELOG.md

@@ -158,7 +158,6 @@ If you like drinking from the firehose, here's [everything we closed for 2.0], b
 
 No changelog available for version `1.0` of ConfluencePS. `1.0` was created in late 2015. Version `.69` was published to the PowerShell Gallery in Nov 2016, and it remained unchanged until `2.0`. If you're looking for things that changed prior to `2.0`...sorry, but these probably aren't the droids you're looking for. :)
 
-
 [everything we closed for 2.0]: https://github.com/AtlassianPS/ConfluencePS/issues?utf8=%E2%9C%93&q=closed%3A2017-04-01..2017-08-17
 [@alexsuslin]: https://github.com/alexsuslin
 [@axxelG]: https://github.com/axxelG

ConfluencePS.build.ps1

@@ -7,10 +7,7 @@ param(
     [String[]]$Tag,
     [String[]]$ExcludeTag,
     [String]$PSGalleryAPIKey,
-    [String]$GithubAccessToken,
-    [String]$WikiUri = $env:WikiURI,
-    [String]$WikiUser = $env:WikiUser,
-    [String]$WikiPassword = $env:WikiPass
+    [String]$GithubAccessToken
 )
 
 $WarningPreference = "Continue"
@@ -37,25 +34,14 @@ if ($BuildTask -notin @("SetUp", "InstallDependencies")) {
     Import-Module BuildHelpers -Force -ErrorAction Stop
     Invoke-Init
 }
-if ('AppVeyor' -eq $env:BHBuildSystem) {
-    $project = Get-AppVeyorProject
-}
-
-$env:WikiURI = $WikiUri
-$env:WikiUser = $WikiUser
-$env:WikiPass = $WikiPassword
 
 $shouldDeploy = (
     # only deploy master branch
     ('master' -eq $env:BHBranchName) -and
     # it cannot be a PR
-    # ( -not $env:APPVEYOR_PULL_REQUEST_NUMBER) -and
-    # only deploy from AppVeyor
+    ( -not $env:SYSTEM_PULLREQUEST_PULLREQUESTID) -and
+    # only deploy from VSTS
     ('VSTS' -eq $env:BHBuildSystem) -and
-    # must be last job of AppVeyor
-    # (Test-IsLastJob) -and
-    # Travis-CI must be finished (if used)
-    # TODO: ( -not Test-TravisProgress) -and
     # it cannot have a commit message that contains "skip-deploy"
     ($env:BHCommitMessage -notlike '*skip-deploy*')
 )
@@ -148,10 +134,10 @@ task ShowInfo Init, GetNextVersion, {
 
 #region BuildRelease
 # Synopsis: Build a shippable release
-task Build Init, GenerateRelease, UpdateManifest, CompileModule
+task Build Init, GenerateExternalHelp, CopyModuleFiles, UpdateManifest, CompileModule, PrepareTests
 
 # Synopsis: Generate ./Release structure
-task GenerateRelease GenerateExternalHelp, {
+task CopyModuleFiles {
     # Setup
     if (-not (Test-Path "$env:BHBuildOutput/$env:BHProjectName")) {
         $null = New-Item -Path "$env:BHBuildOutput/$env:BHProjectName" -ItemType Directory
@@ -165,16 +151,17 @@ task GenerateRelease GenerateExternalHelp, {
         "$env:BHProjectPath/LICENSE"
         "$env:BHProjectPath/README.md"
     ) -Destination "$env:BHBuildOutput/$env:BHProjectName" -Force
-    # Copy Tests
-    Copy-Item -Path "$env:BHProjectPath/PSScriptAnalyzerSettings.psd1" -Destination $env:BHBuildOutput -Force
+}
+
+# Synopsis: Prepare tests for ./Release
+task PrepareTests Init, {
     $null = New-Item -Path "$env:BHBuildOutput/Tests" -ItemType Directory -ErrorAction SilentlyContinue
     Copy-Item -Path "$env:BHProjectPath/Tests" -Destination $env:BHBuildOutput -Recurse -Force
-    # Remove all execptions from PSScriptAnalyzer
-    BuildHelpers\Update-Metadata -Path "$env:BHBuildOutput/PSScriptAnalyzerSettings.psd1" -PropertyName ExcludeRules -Value ''
+    Copy-Item -Path "$env:BHProjectPath/PSScriptAnalyzerSettings.psd1" -Destination $env:BHBuildOutput -Force
 }
 
 # Synopsis: Compile all functions into the .psm1 file
-task CompileModule {
+task CompileModule Init, {
     $regionsToKeep = @('Dependencies', 'ModuleConfig')
 
     $targetFile = "$env:BHBuildOutput/$env:BHProjectName/$env:BHProjectName.psm1"
@@ -210,7 +197,7 @@ task CompileModule {
 }
 
 # Synopsis: Use PlatyPS to generate External-Help
-task GenerateExternalHelp {
+task GenerateExternalHelp Init, {
     Import-Module platyPS -Force
     foreach ($locale in (Get-ChildItem "$env:BHProjectPath/docs" -Attribute Directory)) {
         New-ExternalHelp -Path "$($locale.FullName)" -OutputPath "$env:BHModulePath/$($locale.Basename)" -Force
@@ -250,13 +237,13 @@ task Test Init, {
 
     Remove-Module $env:BHProjectName -ErrorAction SilentlyContinue
 
-    $params = @{
+    <# $params = @{
         Path    = "$env:BHBuildOutput/$env:BHProjectName"
         Include = '*.ps1', '*.psm1'
         Recurse = $True
-        # Exclude = $CodeCoverageExclude
+        Exclude = $CodeCoverageExclude
     }
-    $codeCoverageFiles = Get-ChildItem @params
+    $codeCoverageFiles = Get-ChildItem @params #>
 
     try {
         $parameter = @{
@@ -271,10 +258,6 @@ task Test Init, {
         }
         $testResults = Invoke-Pester @parameter
 
-        if ('AppVeyor' -eq $env:BHBuildSystem) {
-            BuildHelpers\Add-TestResultToAppveyor -TestFile $parameter["OutputFile"]
-        }
-
         Assert-True ($testResults.FailedCount -eq 0) "$($testResults.FailedCount) Pester test(s) failed."
     }
     catch {

PSScriptAnalyzerSettings.psd1

@@ -1,7 +1,5 @@
 @{
     Severity=@('Error','Warning')
     # IncludeRules = @()
-    ExcludeRules = @(
-        'PSAvoidAlias'
-    )
+    # ExcludeRules = @()
 }

Tests/Build.Tests.ps1

@@ -0,0 +1,66 @@
+#requires -modules BuildHelpers
+#requires -modules Configuration
+#requires -modules Pester
+
+Describe "Validation of build environment" {
+
+    BeforeAll {
+        Remove-Item -Path Env:\BH*
+        $projectRoot = (Resolve-Path "$PSScriptRoot/..").Path
+        if ($projectRoot -like "*Release") {
+            $projectRoot = (Resolve-Path "$projectRoot/..").Path
+        }
+
+        Import-Module BuildHelpers
+        Set-BuildEnvironment -BuildOutput '$ProjectPath/Release' -Path $projectRoot -ErrorAction SilentlyContinue
+
+        $env:BHManifestToTest = $env:BHPSModuleManifest
+        $script:isBuild = $PSScriptRoot -like "$env:BHBuildOutput*"
+        if ($script:isBuild) {
+            $Pattern = [regex]::Escape($env:BHProjectPath)
+
+            $env:BHBuildModuleManifest = $env:BHPSModuleManifest -replace $Pattern, $env:BHBuildOutput
+            $env:BHManifestToTest = $env:BHBuildModuleManifest
+        }
+
+        Import-Module "$env:BHProjectPath/Tools/BuildTools.psm1"
+
+        Remove-Module $env:BHProjectName -ErrorAction SilentlyContinue
+        # Import-Module $env:BHManifestToTest
+    }
+    AfterAll {
+        Remove-Module $env:BHProjectName -ErrorAction SilentlyContinue
+        Remove-Module BuildHelpers -ErrorAction SilentlyContinue
+        Remove-Item -Path Env:\BH*
+    }
+
+    $changelogFile = if ($script:isBuild) {
+        "$env:BHBuildOutput/$env:BHProjectName/CHANGELOG.md"
+    }
+    else {
+        "$env:BHProjectPath/CHANGELOG.md"
+    }
+
+    Context "CHANGELOG" {
+
+        foreach ($line in (Get-Content $changelogFile)) {
+            if ($line -match "(?:##|\<h2.*?\>)\s*\[(?<Version>(\d+\.?){1,2})\]") {
+                $changelogVersion = $matches.Version
+                break
+            }
+        }
+
+        It "has a changelog file" {
+            $changelogFile | Should -Exist
+        }
+
+        It "has a valid version in the changelog" {
+            $changelogVersion            | Should -Not -BeNullOrEmpty
+            [Version]($changelogVersion)  | Should -BeOfType [Version]
+        }
+
+        It "has a version changelog that matches the manifest version" {
+            Configuration\Get-Metadata -Path $env:BHManifestToTest -PropertyName ModuleVersion | Should -BeLike "$changelogVersion*"
+        }
+    }
+}