Powershell Pester and Pode

[Nachtfeuer]

Question

I'm writing a small ticket system (for myself) using Powershell as CLI.
One option I'm finally about is to run it via -Serve using Pode providing
the list of tickets as json (http://localhost:8080/api/tickets).

That does work fine. However the Pester tests are configured
to check code coverage and my code coverage decreases since the
server is running in another process (see code block)

Could you please give help on this how to manage that correctly
that code coverage will work?
(I tried start-job and start-threadjob but that seems not to be an option)

Kind Regards,
Thomas

    BeforeEach {
        # provide test path
        $tempPath = [System.IO.Path]::GetTempPath()
        $tempFolder = (New-Guid).ToString("N")
        $testPath = Join-Path $tempPath $tempFolder
        New-Item -ItemType Directory -Path $testPath

        $processInfo = @{
            FilePath = 'pwsh'
            ArgumentList = @(
                "-File", "./Invoke-Ticket.ps1",
                "-Serve",
                "-Path", "`"$testPath`""
            )
            NoNewWindow = $true
            PassThru = $true
        }
        $serverProcess = Start-Process @processInfo
    }

    AfterEach {
        if (-not $serverProcess.HasExited) {
            $serverProcess.Kill()
            $serverProcess.WaitForExit()
        }

        # cleanup of test path
        Remove-Item -Path $testPath -Recurse -Force
    }

[Nachtfeuer]

One addition note: I have seen you provide a test capability but keep in mind I have none -Serve scenarios as well.

[Badgerati]

Hi @Nachtfeuer,

As far as I'm aware, and somebody feel free to correct me, Pester won't be able to do code coverage in code that's run out-of-process - as it's outside the scope of what Pester can see, like you're hitting and external system. Effectively you're running integration/system testing.

The only way to get code coverage would be to unit test the components of your server itself in isolation. Pode has similar tests setup where in the integration tests we do start Pode in a separate process, and like you're seeing we get no coverage from those either. To get any coverage we have to rely on unit tests that can run the server's code in-process.

If it is possible, I'm not fully aware; it might be one to ask over on Pester 😃

[mdaneri]

Try something like this

https://github.com/Badgerati/Pode/blob/develop/tests/integration/OpenApi.Tests.ps1

[Badgerati]

Would that not suffer the same issue as well, as it's also using Start-Process to run OpenApi-TuttiFrutti.ps1?