Test `microvenv`

[karthiknadig]

Refs: #20905

• linux @roblourens
• linux @TylerLeonhardt
• wsl @cwebster-99

Complexity: 3

Create Issue

---

Requirements

You need a linux flavor derived from debian. Check the following before testing:

1. Your apt package list should not have venv (python3-venv) or pip (python3-pip). You can test this by running python3 -c "import venv" or python3 -c "import pip". Both should fail.
2. Make sure you have python 3.7 or greater

The intent of this TPI is to make sure we use microvenv (shipped with python extension) as fallback when venv is not present. It should create a simplified version of the environment and should also install pip into the environment. To verify this correctly, you must ensure that the OS you are using does not contain venv or pip pre-installed. For debian based OS these are often installed via apt, and they don't ship with them out of the box.

Verification

1. Ensure you have python extension pre-release installed.
2. Open a folder with python file.
3. With the python that you were going to use to create environment, run these (both should fail) <python-path> -c "import venv" and <python-path> -c "import pip".
4. Use the create environment command (Python: Create environment)
5. Select venv, and go through the flow.
6. Select the python binary which you used above.
7. After it is done, you should be able to install using pip, from the terminal in VS Code run: .venv/bin/python -m pip install pytest.

Notes

1. For this TPI, we only care to see if env is created and pip is installed in the env. If you got an error while installing using pip that may not be related. Do report them here and I will let you know.

[bpasero]

@karthiknadig it would have helped me to explain better how to setup my Linux VM as you want it for testing. While you make it very clear how it should be, I am not sure how to get there.

I am running Ubuntu 22 and when I run this:

python3 -c "import venv"

I see no error in the terminal:

When I try to uninstall python3-venv I see that it is not installed:

What steps need to be taken to be in an environment that can be used for testing? Would it be easier to share a docker container with testers that is setup exactly how you need it in the future? I think I am often hitting setup issues when I am assigned to Python test plan items, specifically because I never know how to install the correct environment.

[karthiknadig]

The intent of the TPI was to use OS images and containers that are available on the web. The reason is there are so many ways to install python and venv into an image that this would not serve the purpose of getting the variety. For example, this is the first time I have actually seen ubuntu image with venv pre-installed, let alone ubuntu without explicit venv installed (which means when the image was created python was built from full source).

I recommend using a plain debian image to test.

[karthiknadig]

Here is what you can do, to set up an image, where python3-venv is not installed but python3 -c "import venv" succeeds:

1. if venv is installed find it, python3 -c "import venv;print(venv.__file__)" ==> /usr/lib/python3.7/venv/__init__.py
2. Go to the location, and delete the venv folder: rm -rf /usr/lib/python3.7/venv
3. Now try the command python3 -c "import venv"

[karthiknadig]

If you use a base image with no python installed at all then you can try this:

1. apt update
2. apt install python3-minimal
3. if venv is installed find it, python3 -c "import venv;print(venv.__file__)" ==> /usr/lib/python3.7/venv/__init__.py
4. Go to the location, and delete the venv folder: rm -rf /usr/lib/python3.7/venv
5. Now try the command python3 -c "import venv"

[cwebster-99]

Tested with Ubuntu (where it had venv but not pip) successfully but ran into a bug with Debian

[karthiknadig]

If you see error like No module named distutils you will need to install python3-distutils.