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 AuthenticateRequest message

Parameters:
  • message (AuthenticateRequest) – The message to validate

  • expect_oneof (str) – Expected request field (apiKey or challengeResponse)

Raises:

FormatException – When the message is invalid

momotor.rpc.validate.request.validate_create_job_request(message)

Validate CreateJobRequest message

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 DownloadAssetRequest message

Parameters:
  • message (DownloadAssetRequest) – The message to validate

  • expect_oneof (str) – Expected request field (query or accepted)

Raises:
momotor.rpc.validate.request.validate_end_job_request(message)

Validate EndJobRequest message

Parameters:

message (EndJobRequest) – The message to validate

Raises:

FormatException – When the message is invalid

momotor.rpc.validate.request.validate_get_task_request(message)

Validate GetTaskRequest message

Parameters:

message (GetTaskRequest) – The message to validate

Raises:

FormatException – When the message is invalid

momotor.rpc.validate.request.validate_job_status_request(message)

Validate JobStatusRequest message

Parameters:

message (JobStatusRequest) – The message to validate

Raises:

FormatException – When the message is invalid

momotor.rpc.validate.request.validate_shared_lock_request(message)

Validate SharedLockRequest message

Parameters:

message (SharedLockRequest) – The message to validate

Raises:

FormatException – When the message is invalid

momotor.rpc.validate.request.validate_start_job_request(message)

Validate StartJobRequest message

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 UpdateTaskStatusRequest message

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 UploadAssetRequest message

Parameters:
  • message (UploadAssetRequest) – The message to validate

  • expect_oneof (str) – Expected request field (assetData or chunk)

Raises:

Responses

momotor.rpc.validate.response.validate_authenticate_response(message, *, expect_oneof)

Validate AuthenticateResponse message

Parameters:
  • message (AuthenticateResponse) – The message to validate

  • expect_oneof (str) – Expected request field (challenge or authToken)

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:
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, either TEST_RECIPE or VERIFY_PRODUCT from 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:

None

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:
  • message (Message) – Message to validate

  • oneof_group (str) – oneOf group to validate

  • expect_oneof (str) – expected field in the oneof_group

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:
  • message (Message) – Message to validate

  • fields (list[str]) – List of field required field names

Raises:

FormatException – When one of the fields is missing