Debugging a test does not work in Testing tab

[jzazo]

Environment data

• VS Code version: 1.60.0
• Extension version: v2021.9.1215971179
• OS and version: Ubuntu 20.04
• Python version: Python 3.8.5 (pyenv 1.2.21)
• Type of virtual environment used: pipenv, version 2018.11.26
• Relevant/affected Python packages and their versions: pytest 6.2.5
• Relevant/affected Python-related VS Code extensions and their versions: workspace configuration
• Value of the python.languageServer setting: Pylance

Expected behaviour

I hit the Testing tab to find tests and click on Debug Test button on any test. I expect the test to run.

Actual behaviour

The testing wheel keeps turning and the test is never ran / debugged, e.g., by placing a breakpoint.

Steps to reproduce:

I have a repo structure as follows:

somerepo/:
  example1/
    .vscode/
      settings.json
    src/python/example/
      __init__.py
      example.py
    test/python/test_example/
      __init__.py
      test_example.py
  somerepo.code-workspace
  .envrc
  Pipfile
  Pipfile.lock

The contents of somerepo.code-workspace are:

{
    "folders": [
        {"path": "."},
        {"path": "example1"}
    ],
    "settings": {
        "files.exclude":{
            "example1": true
        },
        "python.languageServer": "Pylance"
    }
}

The contents of example1/.vscode/settings.json are:

{
    "python.envFile": "${workspaceFolder}/.envrc",
    "python.analysis.extraPaths": ["./src/python"],
    "python.pythonPath": "/home/javier/.local/share/virtualenvs/example1-CvWCFCrt/bin/python",
    "python.testing.pytestArgs": ["test"],
    "python.testing.unittestEnabled": false,
    "python.testing.pytestEnabled": true,
}

The contents of .envrc are:

layout pipenv

The contents of Pipfile are:

[[source]]
name = "pypi"
url = "https://pypi.org/simple"
verify_ssl = true

[dev-packages]
pytest = "*"

[packages]

[requires]
python_version = "3.8.5"

The contents of Pipfile.lock are generated by running pipenv install --dev.
The contents of example1/src/python/example/example.py are:

def hello():
    print("hello")

The contents of example1/test/python/example_test/test_example.py are:

def test_example1():
    assert True  # breakpoint here

[karthiknadig]

I am not able to repro this.

I literally replicated what you have, and it seems to be working fine. Try enabling logs to see if something comes up. You can do this by setting logToFile true in the launch json.

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Test config",
            "type": "python",
            "request": "launch",
            "purpose": ["debug-test"],
            "logToFile": true,
        }
    ]
}

Then start debugging using test explorer. Logs should in the extension folder (~/.vscode/extensions/ms-python.python-2021.9.1230869389) with the name debugpy*.log. Please share them.

The above config can only be used with tests and cannot be used to debug files using the play button. If you want to debug files using the play button, you can either use the debug button at the top of the file, or add a python file debug configuration in addition to the test config. Like this:

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python: Current File",
            "type": "python",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal"
        },
        {
            "name": "Test config",
            "type": "python",
            "request": "launch",
            "purpose": ["debug-test"],
            "logToFile": true
        }
    ]
}

[jzazo]

Could the problem be that I am in a remote ssh session?
I activated the logs as you proposed, but the remote machine (Ubuntu 20.04) .vsode home folder only shows a settings.json file.
The local machine does not show any debugpy*.log files either in my home folder (Windows).
Can you try to repro in a remote machine? Otherwise, it seems that the debugging does not even start in my remote :S.

[karthiknadig]

I tested this on ssh remote, it seems to be working there too. So I suspect debugger is somehow failing. The logs for ssh scenario will be under ~/.vscode-server/extensions/ms-python.python-2021.9.1230869389 or if you open Output > Python you should see path to the extension when we run linter or formatter or internal scripts to discover tests there. Just follow that path to the extension directory.

[jzazo]

Apparently it seems to be working fine now, I don't know what has changed.
It is now working in the MWE and in my original repo too, so I cannot repro in either :S
Thanks a lot for your help, I will close this now, and reopen if it happens again.

[ericchansen]

For me, I had to include "version": "0.2.0" in my launch.json to get it working. That isn't included in the automatically generated launch.json.