The generated API clients are a work in progress, you can also find our stable clients on the Algolia documentation.

Skip to main content

Common Test Suite commands

info

Common Test Suite requires all clients to be built.

The Common Test Suite commands are used to generate and run tests.

Usage

language and client defaults to all

The client parameter is variadic, you can pass multiple client name

bash
yarn docker cts generate <language | all> <client... | all>
bash
yarn docker cts generate <language | all> <client... | all>

Available options

OptionCommandDescription
verbose-v, --verboseMake the process verbose, display logs from third party tools
interactive-i, --interactiveOpen prompt to query parameters

Generate

Generate CTS for all clients for all supported languages

bash
yarn docker cts generate
bash
yarn docker cts generate

Generate CTS for specific client for specific language

bash
yarn docker cts generate java search
bash
yarn docker cts generate java search

Generate CTS for many client for specific language

bash
yarn docker cts generate php insights recommend search
bash
yarn docker cts generate php insights recommend search

Run

Run CTS for all supported languages

bash
yarn docker cts run
bash
yarn docker cts run

Run CTS for a specific languages

bash
yarn docker cts run javascript
bash
yarn docker cts run javascript