Update ReadMe documentation

Joel Bennett · Joel Bennett · commit 38bd1d4abe9d · 2019-07-04T11:04:09.000-04:00
diff --git a/.gitignore b/.gitignore
@@ -214,3 +214,5 @@ pip-log.txt
 
 #Mr Developer
 .mr.developer.cfg
+
+Output/
diff --git a/Build.ps1 b/Build.ps1
@@ -0,0 +1,12 @@
+[CmdletBinding()]
+param($OutputDirectory = $("$PSScriptRoot\Output"), [switch]$Force)
+
+
+Remove-Item $OutputDirectory -Recurse -Confirm:(!$Force)
+
+
+Copy-Item $PSScriptRoot\Module -Destination $OutputDirectory -recurse
+
+dotnet build -c Release
+Get-ChildItem bin/Release -recurse -filter *.dll |
+    Move-Item -Destination $OutputDirectory\PowerShellLogging\
diff --git a/README.md b/README.md
@@ -1,19 +1,51 @@
 PowerShellLoggingModule
 =======================
-Uses Reflection to intercept text output headed for the PowerShell
-console or ISE.  Lines of output are sent to any number of
-subscriber objects for the purpose of producing complete log files
-of script output (including date/timestamps) without the need for
-extra code by the script author.
+Uses Reflection to intercept text output headed for the PowerShell console.
+All lines of output are sent to any number of subscriber objects
+producing complete log files of script output (adding date/timestamps)
+without needing extra code by the script author.
 
-The source code is maintained on GitHub.  If you would like to use
-the module but can't compile it yourself, you can install it with
-PowerShellGet:
+The upside is that any text which would have shown up in the console is logged,
+and the downside is that only that text is logged.
+For example, verbose output is only logged if VerbosePreference is Continue...
+
+
+Supports PowerShell 2, 3, 4, 5, 6 and 7
+
+
+Install from the PowerShell Gallery
+==================================
 
 ```posh
 Install-Module PowerShellLogging
 ```
 
-Or download a zip file of the module from:
+Compile your own copy
+====================
+
+You can run `build.ps1` to assembly a copy in an `Output` folder,
+or you can just compile the assembly with:
+
+```posh
+dotnet build -c Release
+```
+
+Testing
+=======
+
+The test cases are very minimal (basically just covering the fact that it logs, and testing a couple of edge cases where it used to fail to log). Despite that, weand have some problems due to the way that WindowsPowerShell breaks when they fail.
+
+ As a result, _to be sure that the tests are actually working_ (reporting the correct results), you should run each test case in a new session. There is a wrapper script `test.ps1` which you can use to do that, it basically just runs each test case in `PowerShell` and `pwsh` to ensure everything is working in both WindowsPowerShell and PowerShell core. E.g.:
+
+```
+foreach ($testcase in Get-ChildItem Tests\*.Tests.ps1) {
+    powershell -NoProfile -Command Invoke-Pester $testcase.FullName
+}
+```
+
+Alternative Download
+===================
+
+Note, the original version is also available from:
 
 http://gallery.technet.microsoft.com/scriptcenter/Enhanced-Script-Logging-27615f85
diff --git a/Test.ps1 b/Test.ps1
@@ -0,0 +1,19 @@
+# The tests in here do not work properly in PowerShell 5.x
+# If you run them all at once, you will get a lot of FALSE PASSES using the old code
+# Running one test at a time in a new powershell session solves this problem:
+    if (Get-Command powershell.exe -ErrorAction SilentlyContinue) {
+        foreach ($testcase in ls $PSScriptRoot\Tests\*.Tests.ps1) {
+            powershell -NoProfile -Command Invoke-Pester $testcase.FullName
+        }
+    } else {
+        Write-Warning "Skipping Windows PowerShell tests"
+    }
+
+    if (Get-Command pwsh -ErrorAction SilentlyContinue) {
+        foreach ($testcase in ls $PSScriptRoot\Tests\*.Tests.ps1) {
+            pwsh -NoProfile -Command Invoke-Pester $testcase.FullName
+        }
+    } else {
+        Write-Warning "Skipping PowerShell Core tests"
+    }
+}
diff --git a/Tests/Simple.Tests.ps1 b/Tests/Simple.Tests.ps1
@@ -10,6 +10,8 @@ Describe "It should work when called from scripts run by PowerShell.Invoke" {
         Write-Host 'This is a host test'
         'Returned OK'
         Write-Verbose 'This is a verbose test' -Verbose
+        # Does not output, because Verbose is suppressed
+        Write-Verbose 'This is a another verbose test'
         Disable-LogFile $Logging
     }
 
@@ -54,5 +56,8 @@ Describe "It should work when called from scripts run by PowerShell.Invoke" {
         (Get-Content $Path) -match ".*This is a verbose test$" | Should -Not -BeNullOrEmpty
     }
 
+    It "Should not log verbose that's not output" -Skip:(!(Test-Path $Path)) {
+        (Get-Content $Path) -match ".*This is another verbose test$" | Should -BeNullOrEmpty
+    }
 
 }

Original file line number	Diff line number	Diff line change
`@@ -10,6 +10,8 @@ Describe "It should work when called from scripts run by PowerShell.Invoke" {`
`10`	`10`	`Write-Host 'This is a host test'`
`11`	`11`	`'Returned OK'`
`12`	`12`	`Write-Verbose 'This is a verbose test' -Verbose`
	`13`	`+ # Does not output, because Verbose is suppressed`
	`14`	`+ Write-Verbose 'This is a another verbose test'`
`13`	`15`	`Disable-LogFile $Logging`
`14`	`16`	`}`
`15`	`17`
`@@ -54,5 +56,8 @@ Describe "It should work when called from scripts run by PowerShell.Invoke" {`
`54`	`56`	`(Get-Content $Path) -match ".*This is a verbose test$" \| Should -Not -BeNullOrEmpty`
`55`	`57`	`}`
`56`	`58`
	`59`	`+ It "Should not log verbose that's not output" -Skip:(!(Test-Path $Path)) {`
	`60`	`+ (Get-Content $Path) -match ".*This is another verbose test$" \| Should -BeNullOrEmpty`
	`61`	`+ }`
`57`	`62`
`58`	`63`	`}`