Run SDK tests

This document describes how to create a dev environment in order to run SDK tests or execute the various commands available in the toolbox.

Set up a virtual environment

If you don't already have it, install Python:
- Windows: Python website or from the Windows store
- Ubuntu/Debian sudo apt-get install python3
- RHEL/CentOS sudo yum install python3
Python is also available in Bash for Windows natively.

Clone the repository and go to the folder

git clone https://github.com/Azure/azure-sdk-for-python.git
cd azure-sdk-for-python

Create a virtual environment

You can initialize a virtual environment this way:

python -m venv env # Might be "python3" or "py -3.8" depending on your Python installation
source env/bin/activate      # Linux shell (Bash, ZSH, etc.) only
./env/scripts/activate       # PowerShell only
./env/scripts/activate.bat   # Windows CMD only

Setup your development environment

Install the development requirements for a specific library (located in the dev_requirements.txt file at the root of the library), Tox and an editable install of your library. For example, to install requirements for azure-ai-formrecognizer:

azure-sdk-for-python> cd sdk/formrecognizer/azure-ai-formrecognizer
azure-sdk-for-python/sdk/formrecognizer/azure-ai-formrecognizer> pip install -r dev_requirements.txt
azure-sdk-for-python/sdk/formrecognizer/azure-ai-formrecognizer> pip install "tox<5"
azure-sdk-for-python/sdk/formrecognizer/azure-ai-formrecognizer> pip install -e .

Create a .env file to store your secrets.

The recommended place to store your .env file is one directory higher than the azure-sdk-for-python location. This ensures the secrets will be loaded by the interpreter and most importantly not be committed to Git history.

Follow test-running guidance

After following the steps above, you'll be able to run recorded SDK tests with pytest. For more information about tests -- how to run live tests, write new tests, etc. -- refer to the documentation in tests.md.