cf-performance-tests

Performance tests for the Cloud Foundry API (Cloud Controller).

Goals

These tests are intended to:

• Help debug slow endpoints
• Analyse performance impact of changes to Cloud Controller codebase
• Ensure that query times do not scale exponentially with database size

Anti-goals

These tests are not intended to:

• Test parallelism of a specific webserver
• Load test the Cloud Controller
• Assist with scaling decisions of CAPI deployments

Running tests

Tests in this repository are written using Ginkgo using the Measure spec definition to time API calls across multiple attempts, tracking the minimum, maximum durations as well as the standard deviation.

The test suite uses Viper for configuration of parameters such as API endpoint, credentials etc. Viper will look for a configuration file in both the $HOME directory and the working directory that tests are invoked from. See the Config struct for available configuration parameters.

To run the tests, create a configuration file that Viper can find, e.g. config.yml in the project's root folder:

api: "<test CF API>"
use_http: false
skip_ssl_validation: false
name_prefix: "perf"
samples: 10
basictimeout: 30
longtimeout: 120
users:
  admin:
    username: "<admin username>"
    password: "<admin password>"
  existing:
    username: "<non-admin username>"
    password: "<non-admin password>"

The name_prefix string must match the prefix of the test resources names. Note that some performance tests delete lists of resources. Using a name_prefix ensures that only test resources are deleted.

Then run:

ginkgo