Files
scylladb/test/rest_api/task_manager_utils.py
Aleksandra Martyniuk e37d1bcb98 api: task_manager: add /task_manager/drain
In the following patches, get_status won't be unregistering finished
tasks. However, tests need a functionality to drop a task, so that
they could manipulate only with the tasks for operations that were
invoked by these tests.

Add /task_manager/drain/{module} to unregister all finished tasks
from the module. Add respective nodetool command.
2025-01-27 11:23:45 +01:00

81 lines
3.4 KiB
Python

import requests
# api calls
def list_modules(rest_api):
resp = rest_api.send("GET", "task_manager/list_modules")
resp.raise_for_status()
return resp.json()
def list_tasks(rest_api, module_name, internal=False, keyspace=None, table=None):
args = { "internal": internal }
if keyspace:
args["keyspace"] = keyspace
if table:
args["table"] = table
resp = rest_api.send("GET", f"task_manager/list_module_tasks/{module_name}", args)
resp.raise_for_status()
return resp.json()
def get_task_status(rest_api, task_id):
resp = rest_api.send("GET", f"task_manager/task_status/{task_id}")
resp.raise_for_status()
return resp.json()
def abort_task(rest_api, task_id):
resp = rest_api.send("POST", f"task_manager/abort_task/{task_id}")
resp.raise_for_status()
def wait_for_task(rest_api, task_id):
resp = rest_api.send("GET", f"task_manager/wait_task/{task_id}")
resp.raise_for_status()
return resp.json()
def get_task_status_recursively(rest_api, task_id):
resp = rest_api.send("GET", f"task_manager/task_status_recursive/{task_id}")
resp.raise_for_status()
return resp.json()
# helpers
def check_field_correctness(field_name, status, expected_status):
if field_name in expected_status:
assert status[field_name] == expected_status[field_name], f"Incorrect task {field_name}"
def check_status_correctness(status, expected_status):
check_field_correctness("id", status, expected_status)
check_field_correctness("state", status, expected_status)
check_field_correctness("sequence_number", status, expected_status)
check_field_correctness("keyspace", status, expected_status)
check_field_correctness("table", status, expected_status)
if "error" in expected_status:
assert expected_status["error"] in status["error"], "Incorrect error message"
else:
assert status["error"] == "", "Error message was set"
def assert_task_does_not_exist(rest_api, task_id):
resp = rest_api.send("GET", f"task_manager/task_status/{task_id}")
assert resp.status_code == requests.codes.bad_request, f"Task {task_id} is kept in memory"
def get_children(status_tree, parent_id):
return [s for s in status_tree if s["parent_id"] == parent_id]
def check_child_parent_relationship(rest_api, status_tree, parent, allow_no_children):
assert allow_no_children or parent.get("children_ids", []), f"Child tasks were not created for {parent}"
for child in get_children(status_tree, parent["id"]):
child_id = child["id"]
assert child["kind"] == "node", "Child task isn't marked as local"
assert parent["sequence_number"] == child["sequence_number"], f"Child task with id {child_id} did not inherit parent's sequence number"
assert child["parent_id"] == parent["id"], f"Parent id of task with id {child_id} is not set"
check_child_parent_relationship(rest_api, status_tree, child, True)
def drain_module_tasks(rest_api, module_name):
tasks = [task for task in list_tasks(rest_api, module_name, True)]
# Wait for all tasks.
for task in tasks:
resp = rest_api.send("GET", f"task_manager/wait_task/{task['task_id']}")
# The task may be already unregistered.
assert resp.status_code == requests.codes.ok or resp.status_code == requests.codes.bad_request, "Invalid status code"
resp = rest_api.send("POST", f"task_manager/drain/{module_name}")
resp.raise_for_status()