Make the tests not depend on the source

Jaykul · Jaykul · commit 26bbb14e719f · 2021-07-30T00:08:20.000-04:00
diff --git a/Source/Public/ConvertFrom-SourceLineNumber.ps1 b/Source/Public/ConvertFrom-SourceLineNumber.ps1
@@ -1,7 +1,7 @@
 function ConvertFrom-SourceLineNumber {
     <#
         .SYNOPSIS
-            Convert the line number in a built module to a file and line number in source
+            Convert a source file path and line number to the line number in the built output
         .EXAMPLE
             ConvertFrom-SourceLineNumber -Module ~\2.0.0\ModuleBuilder.psm1 -SourceFile ~\Source\Public\Build-Module.ps1 -Line 27
     #>
diff --git a/Tests/Private/ResolveBuildManifest.Tests.ps1 b/Tests/Private/ResolveBuildManifest.Tests.ps1
@@ -1,15 +1,17 @@
 #requires -Module ModuleBuilder
 Describe "ResolveBuildManifest" {
-
-    [string]${Global:Test Root Path} = Resolve-Path $PSScriptRoot\..\..\Source
+    # use the integration test code
+    BeforeAll {
+        [string]${Global:Test Root Path} = Convert-Path "$PSScriptRoot/../Integration/Source1"
+    }
 
     It "Should return the build.psd1 path when passed the build.psd1 path" {
         $Expected = InModuleScope ModuleBuilder { ResolveBuildManifest (Join-Path ${Global:Test Root Path} "build.psd1") }
         $Expected | Should -Be (Join-Path ${Global:Test Root Path} "build.psd1")
     }
 
     It "Should return the build.psd1 path when passed the module manifest path" {
-        $Expected = InModuleScope ModuleBuilder { ResolveBuildManifest (Join-Path ${Global:Test Root Path} 'ModuleBuilder.psd1') }
+        $Expected = InModuleScope ModuleBuilder { ResolveBuildManifest (Join-Path ${Global:Test Root Path} 'Source1.psd1') }
         $Expected | Should -Be (Join-Path ${Global:Test Root Path} "build.psd1")
     }
 
@@ -19,10 +21,10 @@ Describe "ResolveBuildManifest" {
     }
 
     It "Should return the build.psd1 path when passed the relative path of the source folder" {
-        Push-Location $PSScriptRoot -StackName TestRelativePath
-        $Expected = InModuleScope ModuleBuilder { ResolveBuildManifest "..\..\Source" }
-        Pop-Location -StackName TestRelativePath
+        Push-Location $PSScriptRoot
+        $Expected = InModuleScope ModuleBuilder { ResolveBuildManifest "../Integration/Source1" }
         $Expected | Should -Be (Join-Path ${Global:Test Root Path} "build.psd1")
+        Pop-Location
     }
 
     It "Returns nothing when passed a wrong absolute module manifest" {
@@ -33,7 +35,7 @@ Describe "ResolveBuildManifest" {
 
     It "Returns nothing when passed the wrong folder path" {
         InModuleScope ModuleBuilder {
-            ResolveBuildManifest (Join-Path ${Global:Test Root Path} "..") | Should -BeNullOrEmpty
+            ResolveBuildManifest (Join-Path ${Global:Test Root Path} "../..") | Should -BeNullOrEmpty
         }
     }
 
@@ -42,5 +44,4 @@ Describe "ResolveBuildManifest" {
             ResolveBuildManifest (Join-Path . ..) | Should -BeNullOrEmpty
         }
     }
-
 }
diff --git a/Tests/Public/Convert-CodeCoverage.Tests.ps1 b/Tests/Public/Convert-CodeCoverage.Tests.ps1
@@ -1,32 +1,32 @@
 Describe "Convert-CodeCoverage" {
-
-    $ModulePath = Join-Path (Get-Module ModuleBuilder).ModuleBase ModuleBuilder.psm1
-    $ModuleContent = Get-Content $ModulePath
-
-    $ModuleSource = Resolve-Path "$PSScriptRoot\..\..\Source"
-
-    $lineNumber = Get-Random -min 3 -max $ModuleContent.Count
-    while($ModuleContent[$lineNumber] -match "^#(END)?REGION") {
-        $lineNumber += 5
+    # use the integration test code
+    BeforeAll {
+        Build-Module $PSScriptRoot\..\Integration\Source1\build.psd1 -Passthru
+        Push-Location $PSScriptRoot -StackName Convert-CodeCoverage
+    }
+    AfterAll {
+        Pop-Location -StackName Convert-CodeCoverage
     }
 
     It 'Should extract code coverage from Pester objects and add Source conversions' {
+        $ModulePath = Convert-Path ".\..\Integration\Result1\Source1\1.0.0\Source1.psm1"
+        $ModuleSource = Convert-Path ".\..\Integration\Source1"
 
         # Note: Pester does not currently apply custom types...
         $PesterResults = [PSCustomObject]@{
             CodeCoverage = [PSCustomObject]@{
                 MissedCommands = [PSCustomObject]@{
                     # these are pipeline bound
                     File = $ModulePath
-                    Line = 26 # 1 offset with the Using Statement introduced in MoveUsingStatements
+                    Line = 25 # [Alias("gs","gsou")]
                 }
             }
         }
 
         $SourceLocation = $PesterResults | Convert-CodeCoverage -SourceRoot $ModuleSource
 
         # Needs to match the actual module source (on line 25)
-        $SourceLocation.SourceFile | Should -Be ".\Private\ConvertToAst.ps1"
-        $SourceLocation.Line | Should -Be 25
+        $SourceLocation.SourceFile | Should -Be ".\Public\Get-Source.ps1"
+        $SourceLocation.Line | Should -Be 5
     }
 }
diff --git a/Tests/Public/Convert-LineNumber.Tests.ps1 b/Tests/Public/Convert-LineNumber.Tests.ps1
@@ -1,71 +1,80 @@
 #requires -Module ModuleBuilder
 Describe "Convert-LineNumber" {
+    # use the integration test code
+    BeforeAll {
+        Build-Module $PSScriptRoot\..\Integration\Source1\build.psd1 -Passthru
+        Push-Location $PSScriptRoot -StackName Convert-CodeCoverage
 
-    $ModulePath = Join-Path (Get-Module ModuleBuilder).ModuleBase ModuleBuilder.psm1
-    $ModuleContent = Get-Content $ModulePath
-    $ModuleSource = Resolve-Path (Join-Path $PSScriptRoot "\..\..\Source")
+        $global:Convert_LineNumber_ModulePath = Convert-Path ".\..\Integration\Result1\Source1\1.0.0\Source1.psm1"
+        $global:Convert_LineNumber_ModuleSource = Convert-Path ".\..\Integration\Source1"
+        $global:Convert_LineNumber_ModuleContent = Get-Content $global:Convert_LineNumber_ModulePath
+    }
+    AfterAll {
+        Pop-Location -StackName Convert-CodeCoverage
+    }
 
-    for ($i=0; $i -lt 5; $i++) {
+    $TestCases = @(
+        @{ outputLine = 6;  sourceFile = ".\Private\GetFinale.ps1";  sourceLine = 4 }
+        @{ outputLine = 18; sourceFile = ".\Private\GetPreview.ps1"; sourceLine = 7 }
+        @{ outputLine = 25; sourceFile = ".\Public\Get-Source.ps1";  sourceLine = 5 }
+    )
 
-        # I don't know why I keep trying to do this using random numbers
-        $lineNumber = Get-Random -min 3 -max $ModuleContent.Count
-        # but I have to keep avoiding the lines that don't make sense
-        while($ModuleContent[$lineNumber] -match "^\s*$|^#(END)?REGION|^\s*function\s") {
-            $lineNumber += 5
-        }
+    It "Should map line <outputLine> in the Module to line <sourceLine> in the source of <sourceFile>" -TestCases $TestCases {
+        param($outputLine, $sourceFile, $sourceLine)
 
-        It "Should map line number $lineNumber in the Module to the matching line the Source" {
-            $SourceLocation = Convert-LineNumber $ModulePath $lineNumber
+        $SourceLocation = Convert-LineNumber $Convert_LineNumber_ModulePath $outputLine
+        $SourceLocation.SourceFile | Should -Be $SourceFile
+        $SourceLocation.SourceLineNumber | Should -Be $SourceLine
 
-            $line = (Get-Content (Join-Path $ModuleSource $SourceLocation.SourceFile))[$SourceLocation.SourceLineNumber]
-            try {
-                $ModuleContent[$lineNumber] | Should -Be $line
-            } catch {
-                throw "Failed to match module line $lineNumber to $($SourceLocation.SourceFile) line $($SourceLocation.SourceLineNumber).`nExpected $Line`nBut got  $($ModuleContent[$lineNumber])"
-            }
+        $line = (Get-Content (Join-Path $Convert_LineNumber_ModuleSource $SourceLocation.SourceFile))[$SourceLocation.SourceLineNumber - 1]
+        try {
+            $Convert_LineNumber_ModuleContent[$outputLine -1] | Should -Be $line
+        } catch {
+            throw "Failed to match module line $outputLine to $($SourceLocation.SourceFile) line $($SourceLocation.SourceLineNumber).`nExpected $Line`nBut got  $($Convert_LineNumber_ModuleContent[$outputLine -1])"
         }
     }
 
     It "Should throw if the SourceFile doesn't exist" {
-        { Convert-LineNumber -SourceFile TestDrive:\NoSuchFile -SourceLineNumber 10 } | Should Throw "'TestDrive:\NoSuchFile' does not exist"
+        { Convert-LineNumber -SourceFile TestDrive:\NoSuchFile -SourceLineNumber 10 } |
+            Should -Throw "'TestDrive:\NoSuchFile' does not exist"
     }
 
     It 'Should work with an error PositionMessage' {
-        $line = Select-String -Path $ModulePath 'function ParseLineNumber {' | % LineNumber
+        $line = Select-String -Path $Convert_LineNumber_ModulePath 'function Set-Source {' | ForEach-Object LineNumber
 
-        $SourceLocation = "At ${ModulePath}:$line char:17" | Convert-LineNumber
+        $SourceLocation = "At ${Convert_LineNumber_ModulePath}:$line char:17" | Convert-LineNumber
         # This test is assuming you built the code on Windows. Should Convert-LineNumber convert the path?
-        $SourceLocation.SourceFile | Should -Be ".\Private\ParseLineNumber.ps1"
+        $SourceLocation.SourceFile | Should -Be ".\Public\Set-Source.ps1"
         $SourceLocation.SourceLineNumber | Should -Be 1
     }
 
     It 'Should work with ScriptStackTrace messages' {
 
-        $SourceFile = Join-Path $ModuleSource Private\CopyReadMe.ps1 | Convert-Path
+        $SourceFile = Join-Path $Convert_LineNumber_ModuleSource Public\Set-Source.ps1 | Convert-Path
 
-        $outputLine = Select-String -Path $ModulePath 'Write-Verbose "Copy ReadMe to: \$LanguagePath"' | % LineNumber
-        $sourceLine = Select-String -Path $SourceFile 'Write-Verbose "Copy ReadMe to: \$LanguagePath"' | % LineNumber
+        $outputLine = Select-String -Path $Convert_LineNumber_ModulePath "sto͞o′pĭd" | % LineNumber
+        $sourceLine = Select-String -Path $SourceFile "sto͞o′pĭd" | % LineNumber
 
-        $SourceLocation = "At CopyReadMe, ${ModulePath}: line $outputLine" | Convert-LineNumber
+        $SourceLocation = "At Set-Source, ${Convert_LineNumber_ModulePath}: line $outputLine" | Convert-LineNumber
 
         # This test is assuming you built the code on Windows. Should Convert-LineNumber convert the path?
-        $SourceLocation.SourceFile | Should -Be ".\Private\CopyReadMe.ps1"
+        $SourceLocation.SourceFile | Should -Be ".\Public\Set-Source.ps1"
         $SourceLocation.SourceLineNumber | Should -Be $sourceLine
     }
 
     It 'Should pass through InputObject for updating objects like CodeCoverage or ErrorRecord' {
         $PesterMiss = [PSCustomObject]@{
             # Note these don't really matter, but they're passed through
-            Function = 'TotalNonsense'
+            Function = 'Get-Source'
             # these are pipeline bound
-            File = $ModulePath
-            Line = 26 # 1 offset with the Using Statement introduced in MoveUsingStatements
+            File = $Convert_LineNumber_ModulePath
+            Line = 25 # 1 offset with the Using Statement introduced in MoveUsingStatements
         }
 
         $SourceLocation = $PesterMiss | Convert-LineNumber -Passthru
         # This test is assuming you built the code on Windows. Should Convert-LineNumber convert the path?
-        $SourceLocation.SourceFile | Should -Be ".\Private\ConvertToAst.ps1"
-        $SourceLocation.SourceLineNumber | Should -Be 25
-        $SourceLocation.Function | Should -Be 'TotalNonsense'
+        $SourceLocation.SourceFile | Should -Be ".\Public\Get-Source.ps1"
+        $SourceLocation.SourceLineNumber | Should -Be 5
+        $SourceLocation.Function | Should -Be 'Get-Source'
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -1,15 +1,17 @@`
`1`	`1`	`#requires -Module ModuleBuilder`
`2`	`2`	`Describe "ResolveBuildManifest" {`
`3`		`-`
`4`		`- [string]${Global:Test Root Path} = Resolve-Path $PSScriptRoot\..\..\Source`
	`3`	`+ # use the integration test code`
	`4`	`+ BeforeAll {`
	`5`	`+ [string]${Global:Test Root Path} = Convert-Path "$PSScriptRoot/../Integration/Source1"`
	`6`	`+ }`
`5`	`7`
`6`	`8`	`It "Should return the build.psd1 path when passed the build.psd1 path" {`
`7`	`9`	`$Expected = InModuleScope ModuleBuilder { ResolveBuildManifest (Join-Path ${Global:Test Root Path} "build.psd1") }`
`8`	`10`	`$Expected \| Should -Be (Join-Path ${Global:Test Root Path} "build.psd1")`
`9`	`11`	`}`
`10`	`12`
`11`	`13`	`It "Should return the build.psd1 path when passed the module manifest path" {`
`12`		`- $Expected = InModuleScope ModuleBuilder { ResolveBuildManifest (Join-Path ${Global:Test Root Path} 'ModuleBuilder.psd1') }`
	`14`	`+ $Expected = InModuleScope ModuleBuilder { ResolveBuildManifest (Join-Path ${Global:Test Root Path} 'Source1.psd1') }`
`13`	`15`	`$Expected \| Should -Be (Join-Path ${Global:Test Root Path} "build.psd1")`
`14`	`16`	`}`
`15`	`17`
`@@ -19,10 +21,10 @@ Describe "ResolveBuildManifest" {`
`19`	`21`	`}`
`20`	`22`
`21`	`23`	`It "Should return the build.psd1 path when passed the relative path of the source folder" {`
`22`		`- Push-Location $PSScriptRoot -StackName TestRelativePath`
`23`		`- $Expected = InModuleScope ModuleBuilder { ResolveBuildManifest "..\..\Source" }`
`24`		`- Pop-Location -StackName TestRelativePath`
	`24`	`+ Push-Location $PSScriptRoot`
	`25`	`+ $Expected = InModuleScope ModuleBuilder { ResolveBuildManifest "../Integration/Source1" }`
`25`	`26`	`$Expected \| Should -Be (Join-Path ${Global:Test Root Path} "build.psd1")`
	`27`	`+ Pop-Location`
`26`	`28`	`}`
`27`	`29`
`28`	`30`	`It "Returns nothing when passed a wrong absolute module manifest" {`
`@@ -33,7 +35,7 @@ Describe "ResolveBuildManifest" {`
`33`	`35`
`34`	`36`	`It "Returns nothing when passed the wrong folder path" {`
`35`	`37`	`InModuleScope ModuleBuilder {`
`36`		`- ResolveBuildManifest (Join-Path ${Global:Test Root Path} "..") \| Should -BeNullOrEmpty`
	`38`	`+ ResolveBuildManifest (Join-Path ${Global:Test Root Path} "../..") \| Should -BeNullOrEmpty`
`37`	`39`	`}`
`38`	`40`	`}`
`39`	`41`
`@@ -42,5 +44,4 @@ Describe "ResolveBuildManifest" {`
`42`	`44`	`ResolveBuildManifest (Join-Path . ..) \| Should -BeNullOrEmpty`
`43`	`45`	`}`
`44`	`46`	`}`
`45`		`-`
`46`	`47`	`}`