Skip to content

README.md

Latest commit

 

History

History
105 lines (85 loc) · 5.85 KB

README.md

File metadata and controls

105 lines (85 loc) · 5.85 KB

Blob Performance Tests

In order to run the performance tests, the devtools_testutils package must be installed. This is done as part of the dev_requirements. Start be creating a new virtual environment for your perf tests. This will need to be a Python 3 environment, preferably >=3.7. Note that tests for T1 and T2 SDKs cannot be run from the same environment, and will need to be setup separately.

Setup for test resources

These tests will run against a pre-configured Storage account. The following environment variable will need to be set for the tests to access the live resources using the connection string for authentication:

AZURE_STORAGE_CONNECTION_STRING=<live storage account connection string>

The following environment variables will need to be set for the tests to access the live resources using Microsoft Entra ID for authentication:

AZURE-STORAGE-BLOB_TENANT_ID=<Microsoft Entra ID tenant ID>
AZURE-STORAGE-BLOB_CLIENT_ID=<Microsoft Entra ID client ID>
AZURE-STORAGE-BLOB_CLIENT_SECRET=<Microsoft Entra ID client secret>
AZURE_STORAGE_ACCOUNT_NAME=<live storage account name>

Setup for T2 perf test runs

(env) ~/azure-storage-blob> pip install -r dev_requirements.txt
(env) ~/azure-storage-blob> pip install -e .

Setup for T1 perf test runs

(env) ~/azure-storage-blob> pip install -r dev_requirements.txt
(env) ~/azure-storage-blob> pip install tests/perfstress_tests/T1_legacy_tests/t1_test_requirements.txt

Test commands

When devtools_testutils is installed, you will have access to the perfstress command line tool, which will scan the current module for runable perf tests. Only a specific test can be run at a time (i.e. there is no "run all" feature).

(env) ~/azure-storage-blob> cd tests
(env) ~/azure-storage-blob/tests> perfstress

Using the perfstress command alone will list the available perf tests found. Note that the available tests discovered will vary depending on whether your environment is configured for the T1 or T2 SDK.

Common perf command line options

These options are available for all perf tests:

  • -d --duration=10 Number of seconds to run as many operations (the "run" function) as possible. Default is 10.
  • -i --iterations=1 Number of test iterations to run. Default is 1.
  • -p --parallel=1 Number of tests to run in parallel. Default is 1.
  • --no-client-share Whether each parallel test instance should share a single client, or use their own. Default is False (sharing).
  • -w --warm-up=5 Number of seconds to spend warming up the connection before measuring begins. Default is 5.
  • --sync Whether to run the tests in sync or async. Default is False (async). This flag must be used for Storage legacy tests, which do not support async.
  • --no-cleanup Whether to keep newly created resources after test run. Default is False (resources will be deleted).
  • -x --test-proxies Whether to run the tests against the test proxy server. Specfiy the URL(s) for the proxy endpoint(s) (e.g. "https://localhost:5001"). WARNING: When using with Legacy tests - only HTTPS is supported.
  • --profile Whether to run the perftest with cProfile. If enabled (default is False), the output file of the last completed single iteration will be written to the current working directory in the format "cProfile-<TestClassName>-<TestID>-<sync/async>.pstats".
  • --use-entra-id - Flag to pass in to use Microsoft Entra ID as the authentication. By default, set to False.

Common Blob command line options

The options are available for all Blob perf tests:

  • --size=10240 Size in bytes of data to be transferred in upload or download tests. Default is 10240.
  • --max-concurrency=1 Number of threads to concurrently upload/download a single operation using the SDK API parameter. Default is 1.
  • --max-put-size Maximum size of data uploading in single HTTP PUT.
  • --max-block-size Maximum size of data in a block within a blob.
  • --max-get-size Initial chunk size of a Blob download.
  • --buffer-threshold Minimum block size to prevent full block buffering.
  • --data-block-size The chunk size used when reading from the network stream.
  • --client-encryption The version of client-side encryption to use. Leave out for no encryption.

List Blobs command line options

This option is only available to the List Blobs test (T1 and T2).

  • --num-blobs Number of blobs to list. Defaults to 100.

T2 Tests

The tests currently written for the T2 SDK:

  • UploadTest Uploads a stream of size bytes to a new Blob.
  • UploadFromFileTest Uploads a local file of size bytes to a new Blob.
  • UploadBlockTest Upload a single block of size bytes within a Blob.
  • DownloadTest Download a stream of size bytes.
  • DownloadToFileTest Downloads a blob of size bytes to a local file.
  • DownloadBasicTest Downloads using basic HTTP library primitives, ignoring content.
  • ListBlobsTest List a specified number of blobs.

T1 Tests

The tests currently written for the T1 SDK:

  • LegacyUploadTest Uploads a stream of size bytes to a new Blob.
  • LegacyUploadFromFileTest Uploads a local file of size bytes to a new Blob.
  • LegacyUploadBlockTest Upload a single block of size bytes within a Blob.
  • LegacyDownloadTest Download a stream of size bytes.
  • LegacyListBlobsTest List a specified number of blobs.

Example command

(env) ~/azure-storage-blob/tests> perfstress UploadTest --parallel=2 --size=10240

Running with the test proxy

Follow the instructions here to install and run the test proxy server: https://github.com/Azure/azure-sdk-tools/tree/main/tools/test-proxy/Azure.Sdk.Tools.TestProxy

Once running, in a separate process run the perf test in question, combined with the -x flag to specify the proxy endpoint. (Note, only the HTTPS endpoint is supported for the Legacy tests).

(env) ~/azure-storage-blob/tests> perfstress DownloadTest -x "https://localhost:5001"
⚡