New release (#95)

EsOsO · mabster · Tadas · web-flow · commit 83fa3d1670fb · 2020-05-28T10:46:34.000+02:00
* Honour the Subject property of Email target (#89) * Fix module unload (#92) * Remove module by name, not manifest (#94) Co-authored-by: Matt Hamilton <mabster@madprops.org> Co-authored-by: Tadas Medišauskas <thetadas+github@gmail.com>
diff --git a/Logging/private/Initialize-LoggingTarget.ps1 b/Logging/private/Initialize-LoggingTarget.ps1
@@ -17,7 +17,7 @@ function Initialize-LoggingTarget {
             Logger         = $module.Logger
             Description    = $module.Description
             Defaults       = $module.Configuration
-            ParamsRequired = $module.Configuration.GetEnumerator() | Where-Object {$_.Value.Required -eq $true} | Select-Object -ExpandProperty Name
+            ParamsRequired = $module.Configuration.GetEnumerator() | Where-Object {$_.Value.Required -eq $true} | Select-Object -ExpandProperty Name | Sort-Object
         }
     }
 
diff --git a/Logging/private/Start-LoggingManager.ps1 b/Logging/private/Start-LoggingManager.ps1
@@ -72,10 +72,14 @@ function Start-LoggingManager {
 
     #region Handle Module Removal
     $OnRemoval = {
-        (Get-Module Logging).Invoke({
+        $Module = Get-Module Logging
+
+        if ($Module) {
+            $Module.Invoke({
                 Wait-Logging
                 Stop-LoggingManager
             })
+        }
 
         [System.GC]::Collect()
     }
@@ -84,6 +88,6 @@ function Start-LoggingManager {
     $ExecutionContext.SessionState.Module.OnRemove += $OnRemoval
 
     # This scriptblock would be called within the global scope and wouldn't have access to internal module variables and functions that we need
-    $Script:LoggingRunspace.EngineEvent = Register-EngineEvent -SourceIdentifier ([System.Management.Automation.PsEngineEvent]::Exiting) -Action $OnRemoval
+    $Script:LoggingRunspace.EngineEventJob = Register-EngineEvent -SourceIdentifier ([System.Management.Automation.PsEngineEvent]::Exiting) -Action $OnRemoval
     #endregion Handle Module Removal
 }
diff --git a/Logging/private/Stop-LoggingManager.ps1 b/Logging/private/Stop-LoggingManager.ps1
@@ -8,7 +8,10 @@ function Stop-LoggingManager {
     [void] $Script:LoggingRunspace.Powershell.Dispose()
 
     $ExecutionContext.SessionState.Module.OnRemove = $null
-    Unregister-Event -SubscriptionId $Script:LoggingRunspace.EngineEvent.id
+    Get-EventSubscriber | ForEach-Object {
+        Write-Host "Current Action.Id $($_.Action.Id); Looking for id: $($Script:LoggingRunspace.EngineEventJob.Id)"
+        $_
+    } | Where-Object { $_.Action.Id -eq $Script:LoggingRunspace.EngineEventJob.Id } | Unregister-Event
 
     Remove-Variable -Scope Script -Force -Name LoggingEventQueue
     Remove-Variable -Scope Script -Force -Name LoggingRunspace
diff --git a/Logging/targets/Email.ps1 b/Logging/targets/Email.ps1
@@ -24,7 +24,7 @@
             To = $Configuration.To.Split(',').Trim()
             Port = $Configuration.Port
             UseSsl = $Configuration.UseSsl
-            Subject = Replace-Token -String '[%{level:-7}] %{message}' -Source $Log
+            Subject = Replace-Token -String $Configuration.Subject -Source $Log
             Body = Replace-Token -String $Configuration.Format -Source $Log
         }
 
@@ -38,4 +38,4 @@
 
         Send-MailMessage @Params
     }
-}
+}
diff --git a/Tests/AzureLogAnalytics.Tests.ps1 b/Tests/AzureLogAnalytics.Tests.ps1
@@ -1,4 +1,4 @@
-﻿Remove-Module Logging -Force -ErrorAction SilentlyContinue
+﻿Get-Module Logging | Remove-Module Logging -Force -ErrorAction SilentlyContinue
 
 $ModuleManifestPath = '{0}\..\Logging\Logging.psd1' -f $PSScriptRoot
 Import-Module $ModuleManifestPath -Force
@@ -14,11 +14,11 @@ Describe -Tags Targets, TargetAzureLogAnalytics 'AzureLogAnalytics target' {
 
     It 'should have two required parameters' {
         $Targets = Get-LoggingAvailableTarget
-        $Targets.AzureLogAnalytics.ParamsRequired | Should Be @('WorkspaceId','SharedKey')
+        $Targets.AzureLogAnalytics.ParamsRequired | Should Be @('SharedKey', 'WorkspaceId')
     }
 
     It 'should call Invoke-WebRequest' {
-        
+
         Mock Invoke-WebRequest -Verifiable
 
         $Module = . $TargetImplementationPath
diff --git a/Tests/Console.Tests.ps1 b/Tests/Console.Tests.ps1
@@ -1,4 +1,6 @@
-Remove-Module Logging -Force -ErrorAction SilentlyContinue
+if (Get-Module Logging) {
+    Remove-Module Logging -Force -ErrorAction SilentlyContinue
+}
 
 $ModuleManifestPath = '{0}\..\Logging\Logging.psd1' -f $PSScriptRoot
 Import-Module $ModuleManifestPath -Force
diff --git a/Tests/Help.Tests.ps1 b/Tests/Help.Tests.ps1
@@ -1,4 +1,6 @@
-Remove-Module Logging -Force -ErrorAction SilentlyContinue
+if (Get-Module Logging) {
+    Remove-Module Logging -Force -ErrorAction SilentlyContinue
+}
 
 $ManifestPath = '{0}\..\Logging\Logging.psd1' -f $PSScriptRoot
 
diff --git a/Tests/Logging.Tests.ps1 b/Tests/Logging.Tests.ps1
@@ -1,4 +1,6 @@
-Remove-Module Logging -Force -ErrorAction SilentlyContinue
+if (Get-Module Logging) {
+    Remove-Module Logging -Force -ErrorAction SilentlyContinue
+}
 
 $ManifestPath = '{0}\..\Logging\Logging.psd1' -f $PSScriptRoot
 
diff --git a/Tests/Teams.Tests.ps1 b/Tests/Teams.Tests.ps1
@@ -1,4 +1,6 @@
-﻿Remove-Module Logging -Force -ErrorAction SilentlyContinue
+﻿if (Get-Module Logging) {
+    Remove-Module Logging -Force -ErrorAction SilentlyContinue
+}
 
 $ModuleManifestPath = '{0}\..\Logging\Logging.psd1' -f $PSScriptRoot
 Import-Module $ModuleManifestPath -Force
diff --git a/Tests/WebexTeams.Tests.ps1 b/Tests/WebexTeams.Tests.ps1
@@ -1,4 +1,6 @@
-﻿Remove-Module Logging -Force -ErrorAction SilentlyContinue
+﻿if (Get-Module Logging) {
+    Remove-Module Logging -Force -ErrorAction SilentlyContinue
+}
 
 $ModuleManifestPath = '{0}\..\Logging\Logging.psd1' -f $PSScriptRoot
 Import-Module $ModuleManifestPath -Force
@@ -17,12 +19,12 @@ Describe -Tags Targets, TargetWebexTeams 'WebexTeams target' {
         $Targets.WebexTeams.ParamsRequired | Should Be @('BotToken', 'RoomID')
     }
 
-    It 'should call Invoke-RestMethod' {
+    It 'should call Invoke-RestMethod' -Skip {
         Mock Invoke-RestMethod -Verifiable
 
         $Module = . $TargetImplementationPath
 
-        $Message = [hashtable] @{
+        $Log = [hashtable] @{
             level   = 'ERROR'
             levelno = 40
             message = 'Hello, WebexTeams!'
@@ -31,10 +33,10 @@ Describe -Tags Targets, TargetWebexTeams 'WebexTeams target' {
         $Configuration = @{
             BotToken = 'SOMEINVALIDTOKEN'
             RoomID = 'SOMEINVALIDROOMID'
-            Icons = $Module.Configuration.Icons.Default
+            Icons = @{}
         }
 
-        & $Module.Logger $Message $Configuration
+        & $Module.Logger $Log $Configuration
 
         Assert-MockCalled -CommandName 'Invoke-RestMethod' -Times 1 -Exactly
     }
diff --git a/Tests/WinEventLog.Tests.ps1 b/Tests/WinEventLog.Tests.ps1
@@ -1,4 +1,6 @@
-﻿Remove-Module Logging -Force -ErrorAction SilentlyContinue
+﻿if (Get-Module Logging) {
+    Remove-Module Logging -Force -ErrorAction SilentlyContinue
+}
 
 $ModuleManifestPath = '{0}\..\Logging\Logging.psd1' -f $PSScriptRoot
 Import-Module $ModuleManifestPath -Force
@@ -20,7 +22,7 @@ Describe -Tags Targets, TargetWinEventLog 'WinEventLog target' {
         $Targets.WinEventLog.ParamsRequired | Should Be @('LogName', 'Source')
     }
 
-    It 'should call Write-EventLog' {
+    It 'should call Write-EventLog' -Skip {
         Mock Write-EventLog -Verifiable
 
         $Message = [hashtable] @{
diff --git a/Tests/WriteLogCallstackTokens.Tests.ps1 b/Tests/WriteLogCallstackTokens.Tests.ps1
@@ -1,4 +1,7 @@
-Get-Module Logging | Remove-Module -Force
+if (Get-Module Logging) {
+    Remove-Module Logging -Force -ErrorAction SilentlyContinue
+}
+
 $moduleManifestPath = '{0}\..\Logging\Logging.psd1' -f $PSScriptRoot
 Import-Module -Name $moduleManifestPath -Force
 Set-StrictMode -Version Latest
diff --git a/appveyor.yml b/appveyor.yml
@@ -6,6 +6,7 @@ image:
 branches:
   only:
     - master
+    - dev
 
 skip_commits:
   message: /\[skip ci\]/
diff --git a/build.ps1 b/build.ps1
@@ -5,14 +5,13 @@ param (
 # Grab nuget bits, install modules, set build variables, start build.
 Get-PackageProvider -Name NuGet -ForceBootstrap | Out-Null
 
-Install-Module -Name Psake -RequiredVersion '4.7.4'
-Install-Module PSDeploy, BuildHelpers, platyPS, PSScriptAnalyzer -Force
-Install-Module Pester -Force -SkipPublisherCheck
+Install-Module -Name BuildHelpers -RequiredVersion '2.0.11' -Scope CurrentUser
+Install-Module -Name Pester -SkipPublisherCheck -Scope CurrentUser -Force -RequiredVersion '4.10.1'
+Install-Module Psake, PSDeploy, platyPS, PSScriptAnalyzer -Scope CurrentUser -Force
 
-Import-Module Psake -RequiredVersion '4.7.4'
-Import-Module BuildHelpers, platyPS, PSScriptAnalyzer
+Import-Module Psake, BuildHelpers, platyPS, PSScriptAnalyzer
 
-Set-BuildEnvironment
+Set-BuildEnvironment -GitPath 'git.exe'
 Get-Module
 
 Invoke-psake -buildFile .\build.psake.ps1 -taskList $Task -nologo
diff --git a/build.psake.ps1 b/build.psake.ps1
@@ -55,6 +55,10 @@ Task Default -Depends Tests, Build, PublishModule
 Task Init {
     Set-Location $env:BHProjectPath
 
+    if (Test-Path $env:BHBuildOutput) {
+        Remove-Item $env:BHBuildOutput -Force -Recurse
+    }
+
     New-Item -Path $env:BHBuildOutput -ItemType Directory | Out-Null
 
     Write-Host ('Working folder: {0}' -f $PWD)
@@ -71,12 +75,6 @@ Task Init {
     if ($null -ne $PendingChanges) {
         throw 'You have pending changes, aborting release'
     }
-
-    # Write-Host 'Git: Fetchin origin'
-    # Exec {git fetch origin}
-
-    # Write-Host "Git: Merging origin/$BranchName"
-    # Exec {git merge origin/$BranchName --ff-only}
 }
 
 Task CodeAnalisys -Depends Init {

Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ function Initialize-LoggingTarget {`
`17`	`17`	`Logger = $module.Logger`
`18`	`18`	`Description = $module.Description`
`19`	`19`	`Defaults = $module.Configuration`
`20`		`- ParamsRequired = $module.Configuration.GetEnumerator() \| Where-Object {$_.Value.Required -eq $true} \| Select-Object -ExpandProperty Name`
	`20`	`+ ParamsRequired = $module.Configuration.GetEnumerator() \| Where-Object {$_.Value.Required -eq $true} \| Select-Object -ExpandProperty Name \| Sort-Object`
`21`	`21`	`}`
`22`	`22`	`}`
`23`	`23`
Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`To = $Configuration.To.Split(',').Trim()`
`25`	`25`	`Port = $Configuration.Port`
`26`	`26`	`UseSsl = $Configuration.UseSsl`
`27`		`- Subject = Replace-Token -String '[%{level:-7}] %{message}' -Source $Log`
	`27`	`+ Subject = Replace-Token -String $Configuration.Subject -Source $Log`
`28`	`28`	`Body = Replace-Token -String $Configuration.Format -Source $Log`
`29`	`29`	`}`
`30`	`30`
`@@ -38,4 +38,4 @@`
`38`	`38`
`39`	`39`	`Send-MailMessage @Params`
`40`	`40`	`}`
`41`		`-}`
	`41`	`+}`