Skip to content

Latest commit

 

History

History
115 lines (71 loc) · 3.62 KB

installing_buildtest.rst

File metadata and controls

115 lines (71 loc) · 3.62 KB
Raw

Installing buildtest

Requirements

You need the following packages to install buildtest.

Cloning buildtest

To get started, clone the buildtest repository in your local machine as follows

.. tab-set::

    .. tab-item:: HTTPS

        .. code-block:: console

            git clone https://github.com/buildtesters/buildtest.git

    .. tab-item:: SSH

      .. code-block:: console

            git clone git@github.com:buildtesters/buildtest.git

If you prefer the latest release, you can clone the master branch:

$ git clone -b master git@github.com:buildtesters/buildtest.git

Installing buildtest

buildtest requires a python 3.8 or higher, we recommend you setup a python environment in order to install buildtest. You can use venv, conda, or pipenv to manage your python environment depending on your preference. Assuming you have cloned buildtest in your HOME directory you will need to follow these instructions to install buildtest.

.. tab-set::

    .. tab-item:: Virtual Environment

       For bash shell

       .. code-block:: console

           python3 -m venv $HOME/.pyenv/buildtest
           source $HOME/.pyenv/buildtest/bin/activate
           source $HOME/buildtest/setup.sh

       For csh shell

       .. code-block:: console

           python3 -m venv $HOME/.pyenv/buildtest
           source $HOME/.pyenv/buildtest/bin/activate.csh
           source $HOME/buildtest/setup.csh

    .. tab-item:: Conda

       .. code-block:: console

           conda create -n buildtest python=3.8
           source activate buildtest
           source $HOME/buildtest/setup.sh

    .. tab-item:: pipenv

       .. code-block:: console

           pipenv --python 3.8
           pipenv shell
           source $HOME/buildtest/setup.sh

For csh users you will need to source setup.csh in order to install buildtest.

Upon installation, you should see buildtest in your $PATH and environment variable $BUILDTEST_ROOT will point to root of buildtest repo.

buildtest will provide tab completion for bash shell, this is managed by script bash_completion.sh, if you encounter any issues with tab completion please raise an issue at https://github.com/buildtesters/buildtest/issues/.

Specify Python Wrapper via BUILDTEST_PYTHON

The buildtest program will search for a python wrapper (python, python3) to run buildtest, however you can specify an alternate python wrapper by setting environment variable BUILDTEST_PYTHON wrapper. This variable will be set during execution of buildtest, please note the python wrapper must be 3.8 or higher in-order for buildtest to function properly.

Development Dependencies (Optional)

If you plan to contribute back to buildtest, you will need to install additional dependencies as follows:

$ pip install '.[dev]'

Usage (buildtest --help)

Once you are setup, you can run buildtest --help for more details on how to use buildtest. Shown below is the output

.. dropdown:: ``buildtest --help``

    .. command-output:: buildtest --help

If you have got this far, you can check out the :ref:`quick_start` or :ref:`getting_started`