In order to capture code coverage on your backend server, you need to run it using our Python test listener agent. Below you’ll find several options depending on your server type.

uWSGI

When working with uWSGI, you need to run uWSGI it with the following flags either in the command line or in the uwsgi configuration file: --enable-threads  --single-interpreter --lazy-apps --import python_agent.init

...

If you need to pass the parameters via the CLI, the command line will be similar to this

uwsgi ... --enable-threads  --single-interpreter --import python_agent.init

...

If using the uWSGI config file option, the content should look like the sample below

[uwsgi]
...
enable-threads = true
single-interpreter = true
import = python_agent.init

...

When working with Gunicorn WSGI you need to run it with the following a configuration file which contains an import of the SeaLights Python agent in the post_fork section

Sample Gunicorn config file

...
def post_fork(server, worker):
    import python_agent.init
...

Uvicorn ASGI

Uvicorn does not support importing module to be run before the app is started (as in uwsgi).
in order to overcome this there is a code change need to be done at the source code in order to init Sealights when Uvicorn is loading

...
# Check for an environment variable and import accordingly
if os.getenv('ENABLE_SEALIGHTS', 'false') == 'true':
    import python_agent.init
...

Running the app:

export ENABLE_SEALIGHTS=true
uvicorn app:APP --host 0.0.0.0 --port 9092 --workers 1 --reload

#!/bin/bash

[[ $1 == *.py && -f $1 ]] || { echo "Error: Provide a valid Python file (.py)"; exit 1; }

# Lines to add as an environment variable
LINES_TO_ADD=$(cat <<'EOF'
# Check for an environment variable and import accordingly
if os.getenv('ENABLE_SEALIGHTS', 'false') == 'true':
    import python_agent.init
EOF
)

# Create a backup and modify the file
cp "$1" "$1.bak" && sed -i "/^import\|^from /a\\$LINES_TO_ADD" "$1" && echo "[Sealights] Lines inserted into $1, backup created at $1.bak."

Other servers (Generic solution)

For other servers, run with the SeaLights Python agent and the run flags

Sample Usage

sl-python run {--cov-report /path/to/report.xml --labid Lab1} python <your server and args...>