2.0 KiB
Testing
This document covers details that are only relevant if you are developing IOx and running the tests.
Object storage
To run the tests or not run the tests
If you are testing integration with some or all of the object storage options, you'll have more setup to do.
By default, cargo test -p object_store does not run any tests that actually contact
any cloud services: tests that do contact the services will silently pass.
To ensure you've configured object storage integration testing correctly, you can run
TEST_INTEGRATION=1 cargo test -p object_store, which will run the tests that contact the cloud
services and fail them if the required environment variables aren't set.
If you don't specify the TEST_INTEGRATION environment variable but you do configure some or all
of the object stores, the relevant tests will run.
Configuration differences when running the tests
When running influxdb_iox run, you can pick one object store to use. When running the tests,
you can run them against all the possible object stores. There's still only one
INFLUXDB_IOX_BUCKET variable, though, so that will set the bucket name for all configured object
stores. Use the same bucket name when setting up the different services.
Other than possibly configuring multiple object stores, configuring the tests to use the object
store services is the same as configuring the server to use an object store service. See the output
of influxdb_iox run --help for instructions.
InfluxDB 2 Client
The influxdb2_client crate may be used by people using InfluxDB 2.0 OSS, and should be compatible
with both that and IOx. If you have influxd in your path, the integration tests for the
influxdb2_client crate will run integration tests against influxd. If you do not have
influxd, those tests will not be run and will silently pass.
To ensure you're running the influxdb2_client integration tests, you can run TEST_INTEGRATION=1 cargo test -p influxdb2_client, which will fail the tests if influxd is not available.