Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
86 lines (57 loc) · 3.16 KB

CONTRIBUTING.md

File metadata and controls

86 lines (57 loc) · 3.16 KB

Contributing to the Lumigo OpenTelemetry Distro for Python

Contributions to this project are welcome from all! Below are a couple pointers on how to prepare your machine, as well as some information on testing.

Setup

Getting your machine ready to develop against the package is a straightforward process:

With pyenv

Assuming that you have pyenv already installed:

  1. Clone this repository, and open a CLI in the cloned directory
  2. Run scripts/reset_venv.sh to create/re-create the virtual environment. To specify a different Python version, simply provide it as an argument eg. scripts/reset_venv.sh 3.11
  3. Activate the virtualenv: . venv/bin/activate

Without pyenv

  1. Clone this repository, and open a CLI in the cloned directory
  2. Create a virtual environment for the project virtualenv venv -p python3
  3. Activate the virtualenv: . venv/bin/activate
  4. Install dependencies: pip install -r requirements.txt
  5. Run the setup script: python setup.py develop.
  6. Run pre-commit install in your repository to install pre-commit hooks

MacOS Users

Psycopg cannot be installed without the libpq executable available, Psycopg2 cannot be installed without the pg_config executable available.

For these you'll need to install both postgres and libpq.

You can do this with brew update && brew install postgresql libpq.

It might be necessary to throw in a brew tap homebrew/core along the way.

PyCharm Users

If you are using PyCharm, ensure that you set it to use the virtualenv virtual environment manager. This is available in the menu under PyCharm -> Settings -> Project -> Interpreter.

Running the test suite

Run ./scripts/checks.sh in the root folder.

# Run all the tests
python3 -m nox
# List all the tests
python3 -m nox -l

To run specific tests and/or specify Python versions:

  • Use --python PYTHON_VERSION to specify a Python version eg.

    --python 3.9

  • Use -e to specify a dependency to test eg.

    python3 -m nox -e integration_tests_flask

  • Use --session to specify a dependency and version eg.

    --session "integration_tests_grpcio(python='3.9', grpcio_version='1.56.0')"

# Run a given test with the entire parameter matrix
python3 -m nox -e integration_tests_flask
# Run a given test for a given version of Python and all dependency versions
python -m nox -e integration_tests_grpcio --python 3.9
# Run a given test for a given version of Python and a given dependency version
python -m nox --session "integration_tests_grpcio(python='3.9', grpcio_version='1.56.0')"

To run version testing locally, prefix the test command with TEST_ONLY_UNTESTED_NEW_VERSIONS=true eg.

TEST_ONLY_UNTESTED_NEW_VERSIONS=true python3 -m nox -e integration_tests_flask`

Adding support for a new package

The tested_versions folder must be present and updated both under src/lumigo_opentelemetry/instrumentations and in the tested package's folder under src/test. For this to work, you'll need a symlink from the package's src/test folder. It's recommended to use the script below to initialize your tested_versions folders:

./scripts/init_tested_versions.sh