Pester describe block "Run tests" and "Debug tests" do not run

[jchris1]

System Details

• Operating system name and version:
  Windows 10 Enterprise
  Version 1709 (OS Build 16299.611)

• VS Code version:
  Version: 1.26.1
  Commit: 493869ee8e8a846b0855873886fc79d480d342de
  Date: 2018-08-16T18:38:57.434Z
  Electron: 2.0.5
  Chrome: 61.0.3163.100
  Node.js: 8.9.3
  V8: 6.1.534.41
  Architecture: x64

• PowerShell extension version: 1.8.3

PS C:\Users\jachris1> code -v
1.26.1
493869ee8e8a846b0855873886fc79d480d342de
x64

PS C:\Users\jachris1> $pseditor.EditorServicesVersion

Major  Minor  Build  Revision
-----  -----  -----  --------
1      8      3      0

PS C:\Users\jachris1> code --list-extensions --show-versions
ms-vscode.Go@0.6.88
ms-vscode.PowerShell@1.8.3
ApplicationInsights:Sender [ { Error: connect ETIMEDOUT 64.4.54.254:443
    at Object._errnoException (util.js:1024:11)
    at _exceptionWithHostPort (util.js:1046:20)
    at TCPConnectWrap.afterConnect [as oncomplete] (net.js:1182:14)
    code: 'ETIMEDOUT',
    errno: 'ETIMEDOUT',
    syscall: 'connect',
    address: '64.4.54.254',
    port: 443 } ]

PS C:\Users\jachris1> $PSVersionTable

Name                           Value
----                           -----
PSVersion                      5.1.16299.611
PSEdition                      Desktop
PSCompatibleVersions           {1.0, 2.0, 3.0, 4.0...}
BuildVersion                   10.0.16299.611
CLRVersion                     4.0.30319.42000
WSManStackVersion              3.0
PSRemotingProtocolVersion      2.3
SerializationVersion           1.1.0.1

Issue Description

I am experiencing a problem with...
In Powershell Pester test scripts, both "Run tests" and "Debug tests" (above a Pester Describe block) give an error:
Running the contributed command:'PowerShell.RunPesterTests' failed.

Test script:

 Describe "test" {
    if (1)
    {
        it "test" {
            1 | Should Be 1
        }
    }
}

Attached Logs

Follow the instructions in the README
about capturing and sending logs.

EditorServices.log
vscode-powershell.log

[rjmholt]

Hi @jchris1, thanks for opening an issue. If you remove the if condition around the It clause, do the tests work?

[jchris1]

Hi,

Yes. I have the same error with this example test block:

Describe "test" {
    It {
        1 | Should Be 1
    }
}

[rjmholt]

Ah I've worked it out. This Pester test isn't valid because the It block needs a name. Try:

Describe "test" {
    It "my test" {
        1 | Should -Be 1
    }
}

The Pester CodeLens will only recognise valid Pester tests, since it can't run them otherwise.

Try that and let us know how it goes. I'd also be interested to know if re-instating the if block still works.

[jchris1]

I get the same behavior whether or not the It block has a name. In both cases, the clickable text ("Run tests" and "Debug tests") appears above the Describe block. And in both cases if I click "Run tests" or "Debug Tests", I get the error.

Describe "test" {
        it  {
            1 | Should Be 1
        }
}

Describe "test" {
    it "my test" {
        1 | Should Be 1
    }
}

Side note: If I remove the Describe name, then "Run tests" and "Debug Tests" disappear, so it does seem a Describe name is required to be recognized as a Pester test, but not an It test name. If I run these two tests using Invoke-Pester, I do get a Pester error for the top case without an It test name.

[TylerLeonhardt]

It looks like you're using the older style of Pester asserts. Can you do 3 things:

1. Can you invoke them manually with Invoke-Pester from the terminal?
2. If you update the Should to Should -Be 1
3. What version of Pester do you have?

[rjmholt]

@jchris1 Can you also paste any output (e.g. error output) you get from clicking on Run Tests?

[rjmholt]

I've tried this out on my machine now.

If I do:

Describe "tests" {
    It " test" {
        1 | Should Be 1
    }
}

or

Describe "tests" {
    if (1)
    {
        It " test" {
            1 | Should Be 1
        }
    }
}

I get an output like:

Executing all tests in '/home/rob/Documents/Dev/sandbox/脚本/file.tests.ps1' matching test name test

Executing script /home/rob/Documents/Dev/sandbox/脚本/file.tests.ps1

  Describing test
    [+] my test 100ms
Tests completed in 100ms
Tests Passed: 1, Failed: 0, Skipped: 0, Pending: 0, Inconclusive: 0

If I don't provide the name of the test like

Describe "test" {
    It {
        1 | Should Be 1
    }
}

gives

Executing all tests in '/home/rob/Documents/Dev/sandbox/脚本/file.tests.ps1' matching test name test

Executing script /home/rob/Documents/Dev/sandbox/脚本/file.tests.ps1

  Describing test
    [-] Error occurred in Describe block 92ms
      RuntimeException: No test script block is provided. (Have you put the open curly brace on the next line?)
      at ItImpl, /home/rob/.local/share/powershell/Modules/Pester/4.4.0/Functions/It.ps1: line 153
      at It, /home/rob/.local/share/powershell/Modules/Pester/4.4.0/Functions/It.ps1: line 121
      at <ScriptBlock>, /home/rob/Documents/Dev/sandbox/脚本/file.tests.ps1: line 2
      at DescribeImpl, /home/rob/.local/share/powershell/Modules/Pester/4.4.0/Functions/Describe.ps1: line 171
Tests completed in 92ms
Tests Passed: 0, Failed: 1, Skipped: 0, Pending: 0, Inconclusive: 0

The it doesn't seem to be case-sensitive, but the Describe is -- which is likely a bug.

Also, the Pester lens only appears in files that end with .tests.ps1.

But so far I've been unable to reproduce the behaviour you're seeing @jchris1.

[jchris1]

Installed Pester version is 4.4.0

Using this test block saved as file.tests.ps1

Describe "tests" {
    It "test" {
        1 | Should Be 1
    }
}

I can manually run the test in the terminal:

PS C:\Users\jachris1\documents\Pestertest> invoke-pester ./file.tests.ps1   -TestName "tests"

Describing tests
 [+] test 41ms
Tests completed in 41ms
Passed: 1 Failed: 0 Skipped: 0 Pending: 0 Inconclusive: 0
PS C:\Users\jachris1\documents\Pestertest>

And like before, when I click "Run tests" or "Debug tests" I get the error:
Running the contributed command:'PowerShell.RunPesterTests' failed.

[TylerLeonhardt]

Thanks for all your effort so far! With this new version, can you please attach the logs?

Before you do that can you set the log level to "Diagnostic":

"powershell.developer.editorServicesLogLevel": "Diagnostic"

[jchris1]

I clicked "Run Tests" and "Debug Tests" and got the same error. Here are the logs:

EditorServices.log
Start-EditorServices-EditorServices.log
vscode-powershell.log

[rjmholt]

Relevant section from the logs:

2018-09-20 11:25:43.021 [VERBOSE] C:\PowerShellEditorServices\src\PowerShellEditorServices\Components\FeatureComponentBase.cs: In method 'InvokeProviders', line 71:
    Invocation of provider 'Microsoft.PowerShell.EditorServices.CodeLenses.PesterCodeLensProvider' completed in 2ms.

2018-09-20 11:25:43.032 [VERBOSE] C:\PowerShellEditorServices\src\PowerShellEditorServices.Protocol\MessageProtocol\MessageWriter.cs: In method 'WriteMessage', line 61:
    Writing Response 'textDocument/codeLens' with id 3

2018-09-20 11:25:43.033 [DIAGNOSTIC] C:\PowerShellEditorServices\src\PowerShellEditorServices.Protocol\MessageProtocol\MessageWriter.cs: In method 'WriteMessage', line 67:
    WRITE MESSAGE:
    
    {
      "jsonrpc": "2.0",
      "id": "3",
      "result": [
        {
          "range": {
            "start": {
              "line": 2,
              "character": 0
            },
            "end": {
              "line": 9,
              "character": 1
            }
          },
          "command": {
            "title": "Run tests",
            "command": "PowerShell.RunPesterTests",
            "arguments": [
              "file:///c%3A/temp/Untitled-1.Tests.ps1",
              false,
              "tests"
            ]
          },
          "data": {
            "uri": "file:///c%3A/temp/Untitled-1.Tests.ps1",
            "providerId": "Microsoft.PowerShell.EditorServices.CodeLenses.PesterCodeLensProvider"
          }
        },
        {
          "range": {
            "start": {
              "line": 2,
              "character": 0
            },
            "end": {
              "line": 9,
              "character": 1
            }
          },
          "command": {
            "title": "Debug tests",
            "command": "PowerShell.RunPesterTests",
            "arguments": [
              "file:///c%3A/temp/Untitled-1.Tests.ps1",
              true,
              "tests"
            ]
          },
          "data": {
            "uri": "file:///c%3A/temp/Untitled-1.Tests.ps1",
            "providerId": "Microsoft.PowerShell.EditorServices.CodeLenses.PesterCodeLensProvider"
          }
        }
      ]
    }

2018-09-20 11:25:43.223 [VERBOSE] C:\PowerShellEditorServices\src\PowerShellEditorServices.Protocol\Server\LanguageServer.cs: In method 'DelayThenInvokeDiagnostics', line 1526:
    Analyzing script file: c:\temp\Untitled-1.Tests.ps1

2018-09-20 11:25:45.238 [DIAGNOSTIC] C:\PowerShellEditorServices\src\PowerShellEditorServices.Protocol\MessageProtocol\MessageReader.cs: In method 'ReadMessage', line 114:
    READ MESSAGE:
    
    {
      "jsonrpc": "2.0",
      "id": 4,
      "method": "textDocument/hover",
      "params": {
        "textDocument": {
          "uri": "file:///c%3A/temp/Untitled-1.Tests.ps1"
        },
        "position": {
          "line": 2,
          "character": 5
        }
      }
    }

2018-09-20 11:25:45.238 [VERBOSE] C:\PowerShellEditorServices\src\PowerShellEditorServices.Protocol\MessageProtocol\MessageReader.cs: In method 'ReadMessage', line 123:
    Received Request 'textDocument/hover' with id 4

The logs don't reveal much other than it looks like not a whole lot is happening. I'll see if I can look into this this week.