tobiko/doc/source/user/_install_venv.rst
Omer 8138c3ff9a Refactor Tobiko installation guide
So far the Tobiko docs were duplicated in some places, different
(although duplicated), and some fragments were not relevant (or
outdated).

This patch refactors the Tobiko installation guide by modularizing the
fragments ("spilling" fragments instead of coping them), correcting
typos, and deleting/updating irrelevant information.

Note: in order to see how the change will appear, download it with
`git review -d <change_url>`, run the `tox -e docs` command, and then
double click
(with the file explorer) tobiko/doc/build/html/<file-you-want>.

Change-Id: Ib5ce8a166bb036a5c49a396e568f8bd8b79f6a17
2022-01-24 09:58:13 +00:00

1.2 KiB

Install test cases within a virtualenv

The safest way to run test cases is to do it within a Virtualenv. Here we are goint to see how to setup an environment with all test case dependencies.

In RHEL, CentOS or Fedora install the following packages:

sudo dnf install -y gcc git python3 python3-devel python3-pip which findutils

In Debian or Ubuntu install following packages:

sudo apt update
sudo apt install -y gcc git python3 python3-dev python3-pip

Ensure Pip is up-to-date:

python3 -m pip install --upgrade --user pip

Ensure Tox is installed and up-to-date:

python3 -m pip install --upgrade --user setuptools virtualenv wheel tox

Get source code using Git and enter into Tobiko source folder:

git clone https://opendev.org/x/tobiko.git
cd tobiko

Install remaining binary packages:

tools/install-bindeps.sh

Crate the virtual environment with Tox:

python3 -m tox -e py3 --notest

In case you want to activate the virtual environment you can then type:

. .tox/py3/bin/activate

At this point the environment should have all dependencies installed for running test cases.