cloudbridge/tox.ini

# Tox (http://tox.testrun.org/) is a tool for running tests
# in multiple virtualenvs. This configuration file will run the
# test suite on all supported python versions and providers.
# To use it, "pip install tox" and then run "tox" from this directory.
# You will have to set all required environment variables (below) before
# running the tests.

[tox]
envlist = py3{.10,.13}-{aws,azure,gcp,openstack,mock},lint,mypy

[testenv]
commands = # see pyproject.toml for coverage options; setup.cfg for flake8
           # --durations reports the slowest tests with their setup/teardown.
           # The cloud suites' wall time is set by one or two long tests, and
           # this is the authoritative record of which - the alternative is
           # inferring it from gaps between result lines in the CI log, which
           # cannot separate a slow test from a worker waiting for work.
           coverage run --source=cloudbridge -m pytest -v --durations=25 {posargs:-n 5 tests/}
           # Emit any CB_TEST_TRACE output (see tests/conftest.py). A no-op
           # when tracing is off, which is the default.
           python -c "import glob,sys;[sys.stdout.write(open(f).read()) for f in sorted(glob.glob('cb-trace-*.log'))]"
           # Combine parallel-mode data files and emit Cobertura XML for upload
           # by coverallsapp/github-action in CI. Locally this produces
           # coverage.xml in the project root, which IDEs can also consume.
           coverage combine
           coverage xml
setenv =
    # Fix for moto import issue: https://github.com/travis-ci/travis-ci/issues/7940
    BOTO_CONFIG=/dev/null
    aws: CB_TEST_PROVIDER=aws
    # DIAGNOSTIC - REMOVE BEFORE MERGING. Turns on the wait/retry tracing
    # described in tests/conftest.py for the AWS suite. It lives here rather
    # than in the workflow env because the cloud workflow triggers on
    # pull_request_target, so its definition comes from the base branch and a
    # PR cannot change it; tox.ini is checked out from the PR head and can.
    # Level 2 also logs each boto invocation. Level 1 already showed the AWS
    # image test spends 1184 of its 1400 seconds in one stretch with no
    # polling and no retries, so the remaining question is which call blocks.
    aws: CB_TEST_TRACE=2
    azure: CB_TEST_PROVIDER=azure
    gcp: CB_TEST_PROVIDER=gcp
    openstack: CB_TEST_PROVIDER=openstack
    mock: CB_TEST_PROVIDER=mock
    # https://github.com/nedbat/coveragepy/issues/883#issuecomment-650562896
    COVERAGE_FILE=.coverage.{envname}
passenv =
    PYTHONUNBUFFERED
    # Set to 1 to log every wait_for poll and every botocore retry, for
    # working out where a slow cloud suite is actually spending its time.
    # See tests/conftest.py; verbose by design, so opt-in.
    CB_TEST_TRACE
    aws: CB_IMAGE_AWS
    aws: CB_VM_TYPE_AWS
    aws: CB_PLACEMENT_AWS
    # Standard boto3 credential env vars — set by aws-actions/configure-aws-credentials
    # in CI (OIDC) and by `aws configure` locally. Required because tox does not
    # forward arbitrary env vars to the test process.
    aws: AWS_ACCESS_KEY_ID
    aws: AWS_SECRET_ACCESS_KEY
    aws: AWS_SESSION_TOKEN
    aws: AWS_REGION
    aws: AWS_DEFAULT_REGION
    # Cloudbridge-specific names, kept for backward compatibility with local dev
    # configs that set these.
    aws: AWS_ACCESS_KEY
    aws: AWS_SECRET_KEY
    azure: CB_IMAGE_AZURE
    azure: CB_VM_TYPE_AZURE
    azure: AZURE_SUBSCRIPTION_ID
    azure: AZURE_CLIENT_ID
    azure: AZURE_SECRET
    azure: AZURE_TENANT
    azure: AZURE_REGION_NAME
    azure: AZURE_RESOURCE_GROUP
    azure: AZURE_STORAGE_ACCOUNT
    azure: AZURE_VM_DEFAULT_USER_NAME
    azure: AZURE_PUBLIC_KEY_STORAGE_TABLE_NAME
    gcp: CB_IMAGE_GCP
    gcp: CB_VM_TYPE_GCP
    gcp: CB_PLACEMENT_GCP
    gcp: GCP_DEFAULT_REGION
    gcp: GCP_DEFAULT_ZONE
    gcp: GCP_PROJECT_NAME
    gcp: GCP_SERVICE_CREDS_FILE
    gcp: GCP_SERVICE_CREDS_DICT
    openstack: CB_IMAGE_OS
    openstack: CB_VM_TYPE_OS
    openstack: CB_PLACEMENT_OS
    openstack: OS_AUTH_URL
    openstack: OS_PASSWORD
    openstack: OS_PROJECT_NAME
    openstack: OS_TENANT_NAME
    openstack: OS_USERNAME
    openstack: OS_REGION_NAME
    openstack: OS_USER_DOMAIN_NAME
    openstack: OS_PROJECT_DOMAIN_NAME
    openstack: NOVA_SERVICE_NAME
    openstack: OS_APPLICATION_CREDENTIAL_ID
    openstack: OS_APPLICATION_CREDENTIAL_SECRET
    mock: CB_IMAGE_AWS
    mock: CB_VM_TYPE_AWS
    mock: CB_PLACEMENT_AWS
    mock: AWS_ACCESS_KEY
    mock: AWS_SECRET_KEY
deps =
    -rrequirements.txt
    coverage
    pytest-xdist

[testenv:lint]
commands = flake8 cloudbridge tests
deps =
    flake8
    flake8-import-order

[testenv:mypy]
# Type-check the codebase (see [tool.mypy] in pyproject.toml). The provider
# layer is typed against the cloud SDKs, so the env installs the full deps
# (via requirements.txt -> .[dev], which includes mypy) rather than running
# bare: without the SDKs installed, mypy infers SDK values as Any and reports
# spurious redundant-cast / unused-ignore errors that don't occur in a real
# dev environment.
deps = -rrequirements.txt
commands = mypy