Files
scylladb/test/rest_api
Kefu Chai c1c96bbc16 api/storage_service: drop /storage_service/describe_ring/ API
per its description, "`/storage_service/describe_ring/`" returns the
token ranges of an arbitrary keyspace. actually, it returns the
first keyspace which is of non-local-vnode-based-strategy. this API
is not used by nodetool, neither is it exercised in dtest.
scylla-manager has a wrapper for this API though, but that wrapper
is not used anywhere.

in this change, this API is dropped.

Signed-off-by: Kefu Chai <kefu.chai@scylladb.com>

Closes scylladb/scylladb#17197
2024-02-09 12:49:21 +02:00
..
2023-12-02 22:37:22 +02:00
2023-08-30 15:34:25 +02:00

Tests for the Scylla REST API.

Tests use the requests library and the pytest frameworks (both are available from Linux distributions, or with "pip install").

To run all tests using test.py, just run ./test.py api/run.

To run all tests against an already-running local installation of Scylla, just run pytest. The "--host" and "--api-port" can be used to give a different location for the running Scylla.

More conveniently, we have a script - "run" - which does all the work necessary to start Scylla, and run the tests on it. The Scylla process is run in a temporary directory which is automatically deleted when the test ends.

"run" automatically picks the most recently compiled version of Scylla in build/*/scylla - but this choice of Scylla executable can be overridden with the SCYLLA environment variable.

Additional options can be passed to "pytest" or to "run" to control which tests to run:

  • To run all tests in a single file, do pytest test_system.py.
  • To run a single specific test, do pytest test_system.py::test_system_uptime_ms.
  • To run the same test or tests 100 times, add the --count=100 option. This is faster than running run 100 times, because Scylla is only run once, and also counts for you how many of the runs failed. For pytest to support the --count option, you need to install a pytest extension: pip install pytest-repeat

Additional useful pytest options, especially useful for debugging tests:

  • -v: show the names of each individual test running instead of just dots.
  • -s: show the full output of running tests (by default, pytest captures the test's output and only displays it if a test fails)