Message validation¶
This appendix is for server code. A protocol message can parse correctly and still be unusable: a required field is empty, or the wrong branch of a one-of group is set. The validators in this package check such rules and raise the matching exception from Exception on the first problem.
Request and response validators follow one pattern. Each message type has a function that takes the message and returns nothing. Call it before acting on the message:
from momotor.rpc.validate.request import validate_create_job_request
validate_create_job_request(request)
# The request now has every field the handler needs.
Asset queries have two levels of checks.
validate_query() checks the query on
its own: a valid category, and step and task fields only where the
category allows them.
validate_query_scope() also checks
the query against the job type and the caller: whether a worker or a
client is asking, whether the call uploads or downloads, and whether a
worker stays within its assigned task. Self-test protocol explains the scoping
rules for self-test jobs.
Added in version 7.0.0: validate_query_scope().
The base module holds the two building blocks the other validators share: required-field checks and one-of checks.
API reference¶
Requests¶
- momotor.rpc.validate.request.validate_authenticate_request(message, *, expect_oneof)¶
Validate
AuthenticateRequestmessage- Parameters:
message (
AuthenticateRequest) – The message to validateexpect_oneof (
str) – Expected request field (apiKeyorchallengeResponse)
- Raises:
FormatException – When the message is invalid
- momotor.rpc.validate.request.validate_create_job_request(message)¶
Validate
CreateJobRequestmessage- Parameters:
message (
CreateJobRequest) – The message to validate- Raises:
FormatException – When the message is invalid
- momotor.rpc.validate.request.validate_download_asset_request(message, *, expect_oneof)¶
Validate
DownloadAssetRequestmessage- Parameters:
message (
DownloadAssetRequest) – The message to validateexpect_oneof (
str) – Expected request field (queryoraccepted)
- Raises:
FormatException – When the message is invalid
AssetException – When the query is invalid
- momotor.rpc.validate.request.validate_end_job_request(message)¶
Validate
EndJobRequestmessage- Parameters:
message (
EndJobRequest) – The message to validate- Raises:
FormatException – When the message is invalid
- momotor.rpc.validate.request.validate_get_task_request(message)¶
Validate
GetTaskRequestmessage- Parameters:
message (
GetTaskRequest) – The message to validate- Raises:
FormatException – When the message is invalid
- momotor.rpc.validate.request.validate_job_status_request(message)¶
Validate
JobStatusRequestmessage- Parameters:
message (
JobStatusRequest) – The message to validate- Raises:
FormatException – When the message is invalid
Validate
SharedLockRequestmessage- Parameters:
message (
SharedLockRequest) – The message to validate- Raises:
FormatException – When the message is invalid
- momotor.rpc.validate.request.validate_start_job_request(message)¶
Validate
StartJobRequestmessage- Parameters:
message (
StartJobRequest) – The message to validate- Raises:
FormatException – When the message is invalid
- momotor.rpc.validate.request.validate_update_resource_request(message)¶
Validate
UpdateResourceRequest- Parameters:
message (
UpdateResourceRequest) – The message to validate- Raises:
FormatException – When the message is invalid
- momotor.rpc.validate.request.validate_update_status_request(message)¶
Validate
UpdateTaskStatusRequestmessage- Parameters:
message (
UpdateTaskStatusRequest) – The message to validate- Raises:
FormatException – When the message is invalid
- momotor.rpc.validate.request.validate_upload_asset_request(message, *, expect_oneof)¶
Validate
UploadAssetRequestmessage- Parameters:
message (
UploadAssetRequest) – The message to validateexpect_oneof (
str) – Expected request field (assetDataorchunk)
- Raises:
FormatException – When the message is invalid
AssetException – When the query is invalid
Responses¶
- momotor.rpc.validate.response.validate_authenticate_response(message, *, expect_oneof)¶
Validate
AuthenticateResponsemessage- Parameters:
message (
AuthenticateResponse) – The message to validateexpect_oneof (
str) – Expected request field (challengeorauthToken)
- Raises:
FormatException – When the message is invalid
Query¶
- momotor.rpc.validate.query.validate_query(query)¶
Validate an
AssetQuery- Parameters:
query (
AssetQuery) – The query to validate- Raises:
AssetException – When the query is invalid
- momotor.rpc.validate.query.validate_query_field(message)¶
Validate the query field
- Parameters:
message (
AssetData|DownloadAssetRequest) – A message with a query field- Raises:
FormatException – When the query field is missing
AssetException – When the query is invalid
- momotor.rpc.validate.query.validate_query_scope(query, *, job_type, worker=False, upload=False, task_id=None)¶
Validate asset scope and role before resolving assets.
The broker must additionally check job ownership, known case IDs, and the dependency graph for worker result downloads.
- Parameters:
query (
AssetQuery) – Requested asset scope.job_type (
int) – Type of the owning job, eitherTEST_RECIPEorVERIFY_PRODUCTfrom Job.worker (
bool) – Whether the authenticated caller is a worker.upload (
bool) – Whether the caller is uploading an asset.task_id (
TaskId|None) – Current worker assignment, required for worker requests.
- Raises:
AssetException – When the scope or ownership is invalid.
- Return type:
Added in version 7.0.0.
Base¶
- momotor.rpc.validate.base.validate_oneof(message, oneof_group, expect_oneof)¶
Generic validator used by the specific validators to check the expected oneOf group field
- Parameters:
- Raises:
FormatException – When the oneof group has the wrong field
- momotor.rpc.validate.base.validate_required(message, fields)¶
Generic validator used by the specific validators to check that one or more required fields are included
- Parameters:
- Raises:
FormatException – When one of the fields is missing