Testing - Test View for Python with multi-root workspace

[karthiknadig]

Refs: #15750

• macOS @sandy081
• linux @roblourens
• windows @meganrogge

Complexity: 3

Create Issue

---

Requirements

1. Install python extension from here: https://pvsc.blob.core.windows.net/extension-builds/ms-python-insiders.vsix
2. Make sure you have "python.experiments.optInto": ["All"], in your user settings. If you did not have it, add it and reload.

Testing

1. Open either this project https://github.com/karthiknadig/multiroot_pytest_sample or create a project layout similar to that.
2. Create a virtual environment in the repo directory and install pytest.
   1. Navigate to the repo directory in the terminal.
   2. Then use following commands to create virtual envs
      1. For windows, you can use this command py -3 -m venv .venv
      2. For mac/linux you can use the command python3 -m venv .venv
         Note: For linux users you may not have venv available out of the box. Please install python3-venv via apt.
   3. Activate the virtual environment:
      1. For windows : run the activate binary .\.venv\Scripts\activate
      2. For linux/mac (bash): run source ./.venv/bin/activate .
         Note: If you use other terminal shells there are scripts under Scripts or bin directory that should work for your preferred shell.
   4. Once activated you should see the name of the env in the prompt. Run the following command to install pytest: python -m pip install pytest
3. Activate the python extension and select the virtual environment that you just created. Depending on where you create the virtual environment it may or may not show up in the quick pick. But you can always browse to it and select it.
4. If you created your own files, then configure each project root for testing using the python: configure test command. Otherwise you should see the tests in the test view.
5. Run the tests, add more files or test and see the Test UI update accordingly.

[sandy081]

It worked as expected when I opened the root project multiroot_pytest_sample directly.
But did not work when opening included folders as a multi-root workspace. I followed the steps as mentioned and the testing view could not discover the tests

Here is the output from Python channel

> /usr/bin/python3 ~/work/testing/extension-dir/ms-python.python-2021.9.1144093763-dev/pythonFiles/testing_tools/run_adapter.py discover pytest -- --rootdir ~/work/multiroot_pytest_sample/testfolder1 -s --cache-clear .
cwd: ~/work/multiroot_pytest_sample/testfolder1
> /usr/bin/python3 ~/work/testing/extension-dir/ms-python.python-2021.9.1144093763-dev/pythonFiles/testing_tools/run_adapter.py discover pytest -- --rootdir ~/work/multiroot_pytest_sample/testfolder1 -s --cache-clear .
cwd: ~/work/multiroot_pytest_sample/testfolder1
Error 2021-08-24 11:40:06: Error discovering pytest tests:
 [r [Error]: Traceback (most recent call last):
  File "/Users/sandy081/work/testing/extension-dir/ms-python.python-2021.9.1144093763-dev/pythonFiles/testing_tools/run_adapter.py", line 17, in <module>
    from testing_tools.adapter.__main__ import parse_args, main
  File "/Users/sandy081/work/testing/extension-dir/ms-python.python-2021.9.1144093763-dev/pythonFiles/testing_tools/adapter/__main__.py", line 9, in <module>
    from . import pytest, report
  File "/Users/sandy081/work/testing/extension-dir/ms-python.python-2021.9.1144093763-dev/pythonFiles/testing_tools/adapter/pytest/__init__.py", line 7, in <module>
    from ._discovery import discover
  File "/Users/sandy081/work/testing/extension-dir/ms-python.python-2021.9.1144093763-dev/pythonFiles/testing_tools/adapter/pytest/_discovery.py", line 8, in <module>
    import pytest
ModuleNotFoundError: No module named 'pytest'

	at ChildProcess.<anonymous> (/Users/sandy081/work/testing/extension-dir/ms-python.python-2021.9.1144093763-dev/out/client/extension.js:9:380127)
	at Object.onceWrapper (events.js:422:26)
	at ChildProcess.emit (events.js:315:20)
	at maybeClose (internal/child_process.js:1048:16)
	at Process.ChildProcess._handle.onexit (internal/child_process.js:288:5)]

Please let me know if this is to test only root project or multi-root workspace?

[karthiknadig]

When you open the multiroot_pytest.code-workspace you have to reselect the python. Here it may have picked the global python for you which if you followed the steps will not have (should not have) pytest installed. Hence the error.

[sandy081]

Ok. How can I reselect the python and which version shall I have to pick in this case? Also is this in the scope of this test plan item?

[karthiknadig]

@sandy081 That is not in the scope of this testing plan item. You can skip that.

You can re-select that python by running Python: Select interpreter command

[roblourens]

Had some issues with the interpreter, should it be able to discover my virtualenv automatically? I had to put in the path manually. Then it seemed like the status bar item still said "Select Python Interpreter" and I had to do it a second time. But everything worked find after that point.

[karthiknadig]

@roblourens that is a know issue #16170, #16613